1 #LyX 1.2 created this file. For more info see http://www.lyx.org/
15 \use_numerical_citations 0
16 \paperorientation portrait
19 \paragraph_separation indent
21 \quotes_language english
29 Inventory of your LaTeX and system configuration
32 Automatically generated by LyX (do not edit).
38 This file describes both the different LaTeX add-ons that LyX can handle
39 and different external programs that LyX can interact with.
40 Below you'll find the following sections:
43 Some basic details about your LaTeX installation.
44 In particular, you should make sure that your version of LaTeX is recent
48 Some common fonts that LyX knows about.
49 This is rather sparse at the moment.
52 The document classes that should be standard on any LaTeX implementation.
53 This section is only here for completeness.
56 Some optional document classes that LyX knows about.
57 If one of these is marked as missing (the
58 \begin_inset Quotes eld
62 \begin_inset Quotes erd
65 item is no) and you need its functionality, you can grab it at your nearest
72 The participating hosts in the Comprehensive TeX Archive Network are:
75 ftp://ftp.dante.de/tex-archive
78 ftp://ctan.tug.org/tex-archive
81 ftp://ftp.tex.ac.uk/tex-archive
84 There are also a zillion mirror sites which are listed at the three primary
88 at the location indicated in the
89 \begin_inset Quotes eld
93 \begin_inset Quotes erd
97 Note that only detected document classes can be selected as document layouts
101 Some packages that LyX use when you try to change the margins of your document.
102 The detection of these items does not yet affect the options available
106 Some common LaTeX packages that you might need with LyX, and you might also
107 want to add to your LaTeX installation.
108 The detection of these items does not yet affect the options available
112 Different required external programs that LyX relies on.
113 LyX to a large extent relies on other programs to do it's work, and some
114 programs are required for LyX to be useful.
117 Different optional external programs that LyX can interact with.
118 All of these are optional, and some you would want more than others.
121 Note that most of these packages will be available if you use a modern TeX
122 distribution such as teTeX.
123 If you decide to install one of the missing items, you should tell LyX
125 After the installation, please use the menu entry
130 ptions\SpecialChar \menuseparator
141 or, if you want to change the system-wide settings, issue the command
145 from the LyX system directory (by default
152 and reload this file to see if the new package was recognized.
154 \begin_inset Quotes eld
158 \begin_inset Quotes erd
162 \begin_inset Quotes eld
166 \begin_inset Quotes erd
169 , it means that LyX could not do the inventory of your LaTeX configuration
171 If you are using teTeX, it might be that the new package you installed
173 This is because you forgot to run the command
177 , which tells teTeX to update its own configuration.
180 LaTeX version currently in use
183 The LaTeX version that LyX will use is:
188 Note that, for best results, you should be using at least LaTeX release
197 In case it is not clear to you, this number is the date at which the version
202 In fact, earlier versions may work for many things, but will certainly
204 We feel that it is better to stick to a minimal version than try to work
205 around all the quirks of older ones.
222 Notes: LaTeX does not require the use of
226 fonts, however they are strongly recommended.
231 fonts are available in a more natural range of sizes and allow better hyphenati
232 on and kerning than the old fonts such as
237 If you already have the so-called
241 fonts installed, please upgrade to the
245 fonts, which replace them.
246 They are used automatically if LyX determines that you have them installed.
257 macros/latex/packages/psnfss/
264 allows you to change the fonts used by LyX to one of the 35 classical fonts
265 available on PostScript® printers.
266 Currently, the support for
270 is limited in LyX: you can only chose a few combinations of PostScript®
280 Standard LaTeX document classes
283 The document classes presented in this section are the basic document classes
285 In particular, they are all present on your system as long as LaTeX2e is
287 When the text indicates that a particular class has not been found, this
288 means the layout file supporting this particular class has not been found.
300 Notes: The standard document class
304 is used to type articles or short texts.
305 It is the basic LaTeX document class.
317 Notes: The standard document class
325 but is slightly more structured (support for different parts).
337 Notes: The standard document class
341 is, as its name suggests, intended to produce books.
342 It supports in particular sectioning by chapters.
354 Notes: The standard document class
358 is the basic class for writing letters, mostly in English.
370 Notes: The standard document class
374 is intended to produce transparencies.
378 Additional document classes
387 CTAN: N/A (available from Springer's ftp site
398 Notes: The document class
402 can be used to write articles for submission to the scientific journal
405 Astronomy and Astrophysics
411 published by Springer -Verlag.
420 CTAN: N/A (available from the American Astronomical Society's ftp site
431 Notes: The document class
435 can be used to write articles for submission to the American journals
437 Astrophysical Journal, Astronomical Journal
441 Publications of the Astronomical Society of the Pacific
454 fonts/ams/amslatex/inputs/
457 Notes: The document class
461 is an alternative to the class
466 It is part of the AMS-LaTeX package and is used for typesetting of mathematics
467 with a look the American Mathematical Society has developed.
468 They recommend it for the preparation of manuscripts intended for publication
469 both in the Society's books and journals, and also in other mathematical
471 The Society requests that published documents prepared with AMS-LaTeX include
472 an acknowledgment of its use.
473 LyX support is still limited.
479 Found: @chk_broadway@
482 CTAN: N/A (must be installed from the
486 subdirectory of LyX source distribution)
489 Notes: The document class
493 is for writing plays.
494 It is not an existing LaTeX document class, but a new one which is distributed
501 Found: @chk_dinbrief@
506 macros/latex/contrib/supported/dinbrief/
509 Notes: The document class
513 can be used to type letters according to German conventions.
526 \begin_inset LatexCommand \url{http://www.sgmltools.org}
533 Notes: The class docbook is not a LaTeX document class.
534 It is designed to produce Docbook SGML documents, which, in turn, can be
535 exported as HTML, RTF, text, or dvi (through
540 You need the sgmltools v2.0 package installed to use this.
546 Found: @chk_g-brief-en@
551 macros/latex/contrib/supported/g-brief/
554 Notes: The document class
558 can be used to type commercial letters with a nice outfit.
564 Found: @chk_g-brief-de@
569 macros/latex/contrib/supported/g-brief/
572 Notes: The document class
576 is the same as the above g-brief-en only with german labels.
587 macros/latex/contrib/supported/foiltex/
590 Notes: The document class
594 (aka FoilTeX) provides an alternative to the standard
598 class to make transparencies.
599 It allows cross references, uses a less ugly font, and is in general much
605 It does not however have some of the advanced features found in the
609 class, which is not currently supported by LyX.
616 Found: @chk_hollywood@
619 CTAN: N/A (must be installed from the
623 subdirectory of LyX source distribution)
626 Notes: The document class
630 can be used to type spec scripts for the U.S.
632 It is not an existing LaTeX document class, but a new one which is distributed
642 CTAN: N/A (must be installed from the
646 subdirectory of LyX source distribution)
649 Notes: The document class
653 can be used to type letters according to Italian conventions.
654 It is not an existing LaTeX document class, but a new one which is distributed
661 Found: @chk_IEEEtran@
667 FTP: Currently, the IEEE ftp site only has an old version at:
672 \begin_inset LatexCommand \url{ftp://ftp.ieee.org/info/publish/latex/ieeetran.cls}
684 A newer version is available from:
689 \begin_inset LatexCommand \url{ftp://ftp.isi.edu/pub/graham/infocom99/latest/IEEEtran.cls}
700 produces documents suitable for submission to most of the IEEE Transactions.
701 You should consult the IEEE Author Information pages at
705 if you intend to use this class.
706 Note that there are both
722 file for use with LyX as the
726 file is for LaTeX 2.09 only.
727 Also note that if your
731 is in lowercase like this example LyX will not find it and you should upgrade
732 to a newer version which has IEEE in capitals.
748 is actually a LaTeX style file that adds some extra features to the
753 It produces documents suitable for submission to IEEE Conferences.
754 The LaTeX files (including BibTeX style file) are distributed with the
755 Author Kit for IEEE sponsored conferences.
761 Found: @chk_linuxdoc@
771 is not a LaTeX document class.
772 It is designed to produce LinuxDoc-SGML documents, which, in turn, can
773 be exported as HTML, RTF, text or...
783 ) set of programs installed to use this.
796 Notes: The document class
800 can be used to write articles for submission to the Springer journal
801 \begin_inset Quotes eld
804 Lecture Notes in Computer Science
805 \begin_inset Quotes erd
809 LaTeX documents are available from Springer's ftp site on the following
813 \begin_inset LatexCommand \url{ftp://trick.ntp.springer.de/pub/tex/latex/llncs/latex2e}
822 The LyX layout file for this document class is still insufficiently tested.
834 macros/latex/contrib/supported/paper/
837 Notes: The document class
841 provides an alternative to the standard
846 It provides similar functionality, but you might prefer this layout with
847 sans serif sections, headings, and more.
850 Koma-Script (scrartcl, scrreprt, scrbook)
853 Found: @chk_scrartcl@
858 macros/latex/contrib/supported/koma-script/
861 Notes: These document classes provide different versions of the base LaTeX
875 They have been changed to look somewhat better and be more adapted to european
876 typesetting standards.
887 macros/latex209/contrib/revtex/
890 Notes: The document class
894 is used to write articles for the publications of the American Physical
895 Society (APS), American Institute of Physics (AIP), and Optical Society
897 For better results, you should use the file
905 subdirectory of LyX source distribution.
916 macros/latex/contrib/supported/revtex4-beta/
919 Notes: RevTeX 4 is a class used for submitting manuscripts to journals including
920 APS (Physical Review A-E and Letters, Reviews in Modern Physics, Special
921 Topics---Accelerators and Beams), the American Institute of Physics, the
922 Optical Society of America, and the Society for Exploration Geophysicists.
923 [It is in BETA release as of September, 1999.]
926 Springer Journal of Geodesy
936 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
947 is for the journal formats used by Springer Verlag, in particular that
948 of Journal of Geodesy.
949 It is not very well tested yet.
950 The corresponding documentclass files and associated material can be found
951 on the Springer site.
952 The layout consists of two parts:
956 (which is generic for all Springer journals) and
964 and is specific for Journal of Geodesy.
965 You can write your own
969 to support any other Springer journals (hint, hint!)
972 Paper layout packages
975 Changing the margins of a document is one thing people like to do.
976 While LaTeX offers built-in options to set the margins of the documents,
977 some people feel that these margins are too large and want to set them
979 You can use the package
983 for this purpose, but note that for the sake of readability, your lines
984 should not contain more than 60-70 characters.
995 macros/latex/contrib/supported/ntgclass/
1002 changes the margins of your document to suit the European A4 page dimensions
1003 with smaller margins that the default A4 format.
1014 macros/latex/contrib/other/misc/
1021 is another package that allows setting of the margins of your document
1023 With this package, the margins are very wide, but do not follow typographical
1030 Found: @chk_geometry@
1035 macros/latex/contrib/supported/geometry
1042 allows to change the paper size and margins of your document in an arbitrary
1044 It does not provide a typographically correct page layout like
1048 or the standard options, though.
1060 Found: @chk_algorithm@
1065 macros/latex/contrib/supported/algorithms/
1072 is needed by LyX to be able to output
1073 \begin_inset Quotes eld
1077 \begin_inset Quotes erd
1081 These are useful in placing short algorithms across pagebreaks and support
1083 \begin_inset Quotes eld
1087 \begin_inset Quotes erd
1101 macros/latex/packages/babel/
1108 allows you to customize your document for your favorite language (see the
1116 In particular, it handles hyphenation and automatic translation of all
1118 \begin_inset Quotes eld
1122 \begin_inset Quotes erd
1126 \begin_inset Quotes eld
1130 \begin_inset Quotes erd
1134 This package is not needed if you only plan to write in English, except
1135 if you want to use non-English quotes.
1146 macros/latex/packages/graphics/
1153 is needed by LyX to handled colored text.
1154 These colors will not show in the DVI preview window, but will be correct
1155 on the printed output or with a PostScript® previewer.
1156 This package is bundled with the
1161 \begin_inset LatexCommand \ref{ssec:graphics}
1171 Found: @chk_fancyhdr@
1176 macros/latex/contrib/supported/fancyhdr/
1183 (previously known as
1187 ) is used when you select the
1188 \begin_inset Quotes eld
1192 \begin_inset Quotes erd
1195 page style in the document layout popup.
1196 It provides alternate headers and footers to your pages.
1202 Found: @chk_floatflt@
1207 macros/latex/contrib/other/floatflt/
1218 ) is used by LyX if you select the ``floatflt'' type in
1220 Layout->Paragraph->ExtraOpt
1222 in the paragraph of a figure float.
1223 It allows you to create a figure float which is narrower than the full
1224 page and wrap the text around it.
1228 \begin_inset LatexCommand \label{ssec:graphics}
1235 Found: @chk_graphics@
1240 macros/latex/packages/graphics/
1247 is needed by LyX to insert PostScript® figures.
1248 You will also need the program
1254 to see them on screen.
1255 The configuration script has determined that the graphics driver used by
1256 the package should be
1259 \begin_inset Quotes eld
1262 @chk_graphicsdriver@
1263 \begin_inset Quotes erd
1273 \begin_inset Quotes eld
1277 \begin_inset Quotes erd
1280 means that your LaTeX installation provides a sensible value for this parameter.
1289 Found: @chk_rotating@
1294 macros/latex/contrib/supported/rotating
1301 is needed by LyX to change the orientation of some parts of your documents.
1302 Note that it only really works with a PostScript® compatible printer.
1308 Found: @chk_subfigure@
1313 macros/latex/contrib/supported/subfigure
1320 is used by LyX when you select ``subfigure'' in the EPS figure popup.
1321 Several figures marked in this way can be packed into a single float with
1322 individual subcaptions.
1328 Found: @chk_setspace@
1333 macros/latex/contrib/supported/setspace/
1340 is needed by LyX to change the line spacing of your document.
1346 Found: @chk_longtable@
1351 macros/latex/packages/tools/longtable.dtx
1358 is needed by LyX to be able to output correctly multipage tables.
1369 macros/latex/contrib/other/misc/url.sty
1376 is needed by LyX to be able to output url's corrently.
1382 Found: @chk_prettyref@
1387 macros/latex/contrib/supported/prettyref/
1394 package provides improved reference formatting for LaTeX and allows the
1396 \begin_inset Quotes eld
1400 \begin_inset Quotes erd
1403 all types of labels.
1409 Found: @chk_varioref@
1414 macros/latex/required/tools/varioref.dtx
1421 pacakage provides commands that work like the normal references in LaTeX
1422 except that it adds textual references, like 'on the facing page' or 'on
1423 page 27' when the corresponding label is not on the same page.
1429 Found: @chk_chess@ and @chk_lyxchess@
1444 subdirectory of LyX source distribution
1451 is needed in order to typeset chess diagrams with the external chess diagram
1453 You also need to install the fonts from the
1457 package, but leave out the
1461 style itself since it's meant for older versions of LaTeX only.
1464 Required external programs
1467 LyX is eager to invoke external programs to do some work.
1468 In line with the Unix tradition, LyX tries to exploit existing programs
1469 before implementing the same thing itself.
1470 Over time, LyX is able to interact with an increasing number of both command
1471 line and interactive applications, and this to a large degree explains
1472 why LyX is succesful.
1475 Note: if you use a Linux distribution, such as RedHat or Debian, most of
1476 these packages should be available as custom packages for the relevant
1477 system, and you might have most of it installed already.
1478 And most Unix systems will at least have LaTeX, although it may be a braindead
1480 Please check what you have before you go download the lot.
1490 \begin_inset LatexCommand \url[The XForms home page]{http://world.std.com/~xforms/}
1497 Notes: XForms is the underlying GUI toolkit.
1499 \begin_inset LatexCommand \url[get a version]{http://world.std.com/~xforms/ftp/ftp.html}
1503 for your architechture, if you want to compile your own version of LyX.
1513 \begin_inset LatexCommand \url[libXpm]{http://www.inria.fr/koala/lehors/xpm.html}
1520 Notes: libXpm is a library used to display pixmaps.
1521 If you want to compile LyX yourself, you'll also need libXpm.
1522 You'll have to get version 4.7 or newer.
1523 Older versions are incompatible with the current XForms library.
1533 \begin_inset LatexCommand \url[The teTeX Homepage]{http://www.tug.org/tetex/}
1540 Notes: teTex is a LaTeX distribution.
1541 In order to properly use LyX to create documents, you'll need to have a
1543 teTeX is pretty complete.
1553 \begin_inset LatexCommand \url[The NTeX homepage]{http://web.mathematik.uni-stuttgart.de/ntex/WWW/}
1560 Notes: NTeX is an alternative LaTeX distribution.
1561 This one is not as extensive as teTeX, so you might have to pick up a few
1562 more packages by hand compared to teTeX.
1565 Optional external programs
1575 \begin_inset LatexCommand \url[ChkTeX Homepage]{http://www.ifi.uio.no/~jensthi/chktex/}
1582 Notes: ChkTeX performs typographical checking.
1583 LyX can use ChkTeX as an aid to find common typograhical errors in your
1591 \begin_inset LatexCommand \url[CTAN]{http://tug.ctan.org/}
1598 Notes: The Comprehensive TeX Archive Network.
1599 Since LyX is based on LaTeX, practically any tool made for use with LaTeX
1600 can be used with LyX.
1601 The CTAN is an archive of packages, tools, documentation and much more
1602 about LaTeX, and therefore an invaluable resource if you want to become
1603 a power user of LaTeX (and LyX).
1604 (If you don't know anything about LaTeX yet, you may want to wait before
1605 exploring CTAN, because it is big and confusing at first.)
1615 \begin_inset LatexCommand \url[gBib]{http://www.mx.lyx.org/gbib}
1622 Notes: gBib is an interactive BibTeX database manager.
1623 This GNOME program allows you to manage a BibTeX bibliography database,
1624 and then interface it with LyX in a seamless fashion.
1630 Found: @chk_ghostview@
1634 \begin_inset LatexCommand \url[Ghostview]{http://www.cs.wisc.edu/~ghost/ghostview/index.html}
1641 Notes: Ghostview is used to preview PostScript files.
1643 \begin_inset LatexCommand \url[Ghostscript]{http://www.cs.wisc.edu/~ghost/aladdin/index.html}
1647 to be able to use Ghostview.
1653 Found: @chk_gifscii@
1657 \begin_inset LatexCommand \url[gifscii-2.2.tar.gz]{ftp://ftp.uni-passau.de/mount/common.lib.archive.unix/Text/gifscii-2.2.tar.gz}
1664 Notes: Gifscii is a program that can convert an raster image to an ascii
1666 This is utilized by the external raster image inset when you export a document
1677 \begin_inset LatexCommand \url[The Gimp Homepage]{http://www.gimp.org}
1684 Notes: The GIMP is the GNU Image Manipulation Program.
1685 It is a freely distributed piece of software suitable for such tasks as
1686 photo retouching, image composition and image authoring.
1687 The GIMP is used by LyX as the editor for the external raster image inset.
1697 \begin_inset LatexCommand \url[The XForms home page]{http://world.std.com/~xforms/}
1708 \begin_inset LatexCommand \url[gv]{http://wwwthep.physik.uni-mainz.de/~plass/gv/}
1712 - an alternative PostScript viewer.
1715 gv is a more modern PostScript viewer.
1716 It also requires Ghostscript to work.
1722 Found: @chk_imagemagick@
1726 \begin_inset LatexCommand \url[ImageMagick homepage]{http://www.imagemagick.org}
1733 Notes: ImageMagick is a robust collection of tools to read, write, and manipulat
1734 e an image in many image formats including popular formats like TIFF, JPEG,
1736 With ImageMagick you can resize, rotate, sharpen, color reduce, or add
1737 special effects to an image and save the result in a different image format.
1738 LyX uses ImageMagick to both display and convert raster format images in
1739 the external raster image inset.
1749 \begin_inset LatexCommand \url[International Ispell]{http://ficus-www.cs.ucla.edu/ficus-members/geoff/ispell.html}
1756 Notes: Ispell is a spellchecker for many languages.
1757 LyX can use Ispell as a backend to do spellchecking.
1759 \begin_inset LatexCommand \url[dictionaries for many languages]{http://ficus-www.cs.ucla.edu/ficus-members/geoff/ispell-dictionaries.html}
1763 and be able to spellcheck documents in your own language.
1773 \begin_inset LatexCommand \url[NoWeb]{http://www.cs.virginia.edu/~nr/noweb/}
1780 Notes: NoWeb is used for literate programming.
1781 Use LyX to write programs whose documentation and manuals are included
1792 \begin_inset LatexCommand \url[Perl]{http://www.perl.com}
1799 Notes: Perl is an interpreted, text-manipulation programming language.
1800 If you want to import LaTeX documents into LyX, you'll need to have Perl
1801 installed, because the reLyX script that does the conversion is written
1803 Note that reLyX is bundled with LyX, but is only installed if Perl is found.
1810 Found: @chk_pybliographer@
1814 \begin_inset LatexCommand \url[Pybliographer]{http://www.gnome.org/pybliographer/}
1821 Notes: Pybliographer is another GNOME BibTeX database manager.
1822 This is said to have good support for 8 bit characters, avoid choking on
1823 extra field definitions, produce very clean bibtex code and handle other
1824 bibliographic formats than BibTeX.
1825 And of course, it can interact with LyX.
1835 \begin_inset LatexCommand \url[Python]{http://www.python.org}
1842 Notes: Python is an interpreted, text-manipulation programming language.
1843 The Python interpreter is used for many of the gluing scripts that are
1844 used by the external material inset.
1845 For instance, it is required to use the ascii approximation of external
1846 raster images or to include chess diagrams with the external chess diagram
1853 Found: @chk_sgmltools@
1857 \begin_inset LatexCommand \url[The SGMLtools homepage]{http://www.sgmltools.org}
1864 Notes: SGMLtools is needed to use the LinuxDoc DTD.
1865 If you want to create documents using the LinuxDOC DTD that is used for
1867 \begin_inset LatexCommand \url[Linux Documentation Project]{http://sunsite.unc.edu/LDP/}
1871 to create documents in a variety of different formats, you'll need to get
1878 Found: @chk_tkbibtex@
1882 \begin_inset LatexCommand \url[tkbibtex]{http://www.cat.csiro.au/dmt/programs/autom/pic/tkbibtex.html}
1889 Notes: tkbibtex - a portable Tcl/Tk browser/editor for BibTeX files.
1890 tkbibtex is a portable editor and browser for BibTeX format file.
1891 It provides an interface to LyX - insert a citation with a single keypress.
1901 \begin_inset LatexCommand \url[The XBoard homepage]{http://www.research.digital.com/SRC/personal/Tim_Mann/chess.html}
1908 Notes: XBoard is a graphical chessboard that can serve as a user interface
1909 for GNU Chess, for the Internet Chess Server, or for electronic mail correspond
1911 XBoard can also be used by itself, and it's in this capacity LyX can exploit
1912 to as the editor for external chess diagrams.
1917 feature in XBoard to save your chess position as a
1922 Be sure you specify a relative path compared to your LyX document.
1923 You might also want to investigate the
1929 Options->Test Legality
1931 commands, and remember to use the right mouse to insert new material on