1 #LyX 1.1 created this file. For more info see http://www.lyx.org/
14 \paperorientation portrait
17 \paragraph_separation indent
19 \quotes_language english
27 Inventory of your LaTeX and system configuration
30 Automatically generated by LyX (do not edit).
36 This file describes both the different LaTeX add-ons that LyX can handle
37 and different external programs that LyX can interact with.
38 Below you'll find the following sections:
41 Some basic details about your LaTeX installation.
42 In particular, you should make sure that your version of LaTeX is recent
46 Some common fonts that LyX knows about.
47 This is rather sparse at the moment.
50 The document classes that should be standard on any LaTeX implementation.
51 This section is only here for completeness.
54 Some optional document classes that LyX knows about.
55 If one of these is marked as missing (the
56 \begin_inset Quotes eld
60 \begin_inset Quotes erd
63 item is no) and you need its functionality, you can grab it at your nearest
68 The participating hosts in the Comprehensive TeX Archive Network are:
71 ftp://ftp.dante.de/tex-archive
74 ftp://ctan.tug.org/tex-archive
77 ftp://ftp.tex.ac.uk/tex-archive
80 There are also a zillion mirror sites which are listed at the three primary
83 at the location indicated in the
84 \begin_inset Quotes eld
88 \begin_inset Quotes erd
92 Note that only detected document classes can be selected as document layouts
96 Some packages that LyX use when you try to change the margins of your document.
97 The detection of these items does not yet affect the options available
101 Some common LaTeX packages that you might need with LyX, and you might also
102 want to add to your LaTeX installation.
103 The detection of these items does not yet affect the options available
107 Different required external programs that LyX relies on.
108 LyX to a large extent relies on other programs to do it's work, and some
109 programs are required for LyX to be useful.
112 Different optional external programs that LyX can interact with.
113 All of these are optional, and some you would want more than others.
116 Note that most of these packages will be available if you use a modern TeX
117 distribution such as teTeX.
118 If you decide to install one of the missing items, you should tell LyX
120 After the installation, please use the menu entry
125 ptions\SpecialChar \menuseparator
131 \begin_float footnote
134 or, if you want to change the system-wide settings, issue the command
138 from the LyX system directory (by default
144 and reload this file to see if the new package was recognized.
146 \begin_inset Quotes eld
150 \begin_inset Quotes erd
154 \begin_inset Quotes eld
158 \begin_inset Quotes erd
161 , it means that LyX could not do the inventory of your LaTeX configuration
163 If you are using teTeX, it might be that the new package you installed
165 This is because you forgot to run the command
169 , which tells teTeX to update its own configuration.
172 LaTeX version currently in use
175 The LaTeX version that LyX will use is:
180 Note that, for best results, you should be using at least LaTeX release
184 \begin_float footnote
187 In case it is not clear to you, this number is the date at which the version
191 In fact, earlier versions may work for many things, but will certainly
193 We feel that it is better to stick to a minimal version than try to work
194 around all the quirks of older ones.
211 Notes: LaTeX does not require the use of
215 fonts, however they are strongly recommended.
220 fonts are available in a more natural range of sizes and allow better hyphenati
221 on and kerning than the old fonts such as
226 If you already have the so-called
230 fonts installed, please upgrade to the
234 fonts, which replace them.
235 They are used automatically if LyX determines that you have them installed.
246 macros/latex/packages/psnfss/
253 allows you to change the fonts used by LyX to one of the 35 classical fonts
254 available on PostScript® printers.
255 Currently, the support for
259 is limited in LyX: you can only chose a few combinations of PostScript®
269 Standard LaTeX document classes
272 The document classes presented in this section are the basic document classes
274 In particular, they are all present on your system as long as LaTeX2e is
276 When the text indicates that a particular class has not been found, this
277 means the layout file supporting this particular class has not been found.
289 Notes: The standard document class
293 is used to type articles or short texts.
294 It is the basic LaTeX document class.
306 Notes: The standard document class
314 but is slightly more structured (support for different parts).
326 Notes: The standard document class
330 is, as its name suggests, intended to produce books.
331 It supports in particular sectioning by chapters.
343 Notes: The standard document class
347 is the basic class for writing letters, mostly in English.
359 Notes: The standard document class
363 is intended to produce transparencies.
367 Additional document classes
376 CTAN: N/A (available from Springer's ftp site
387 Notes: The document class
391 can be used to write articles for submission to the scientific journal
394 Astronomy and Astrophysics
400 published by Springer -Verlag.
409 CTAN: N/A (available from the American Astronomical Society's ftp site
420 Notes: The document class
424 can be used to write articles for submission to the American journals
426 Astrophysical Journal, Astronomical Journal
430 Publications of the Astronomical Society of the Pacific
443 fonts/ams/amslatex/inputs/
446 Notes: The document class
450 is an alternative to the class
455 It is part of the AMS-LaTeX package and is used for typesetting of mathematics
456 with a look the American Mathematical Society has developed.
457 They recommend it for the preparation of manuscripts intended for publication
458 both in the Society's books and journals, and also in other mathematical
460 The Society requests that published documents prepared with AMS-LaTeX include
461 an acknowledgment of its use.
462 LyX support is still limited.
468 Found: @chk_broadway@
471 CTAN: N/A (must be installed from the
475 subdirectory of LyX source distribution)
478 Notes: The document class
482 is for writing plays.
483 It is not an existing LaTeX document class, but a new one which is distributed
490 Found: @chk_dinbrief@
495 macros/latex/contrib/supported/dinbrief/
498 Notes: The document class
502 can be used to type letters according to German conventions.
515 \begin_inset LatexCommand \url{http://www.sgmltools.org}
522 Notes: The class docbook is not a LaTeX document class.
523 It is designed to produce Docbook SGML documents, which, in turn, can be
524 exported as HTML, RTF, text, or dvi (through
529 You need the sgmltools v2.0 package installed to use this.
535 Found: @chk_g-brief-en@
540 macros/latex/contrib/supported/g-brief/
543 Notes: The document class
547 can be used to type commercial letters with a nice outfit.
553 Found: @chk_g-brief-de@
558 macros/latex/contrib/supported/g-brief/
561 Notes: The document class
565 is the same as the above g-brief-en only with german labels.
568 Springer 2-columns Journals (ejour2)
574 CTAN: N/A (must be installed from the
578 subdirectory of LyX source distribution)
581 Notes: The document class
585 is for the two-column journal format used by Springer Verlag.
586 It is reasonably well tested only for the Journal of Geodesy.
587 It is not an existing LaTeX document class, but a new one which is distributed
599 macros/latex/contrib/supported/foiltex/
602 Notes: The document class
606 (aka FoilTeX) provides an alternative to the standard
610 class to make transparencies.
611 It allows cross references, uses a less ugly font, and is in general much
617 It does not however have some of the advanced features found in the
621 class, which is not currently supported by LyX.
628 Found: @chk_hollywood@
631 CTAN: N/A (must be installed from the
635 subdirectory of LyX source distribution)
638 Notes: The document class
642 can be used to type spec scripts for the U.S.
644 It is not an existing LaTeX document class, but a new one which is distributed
654 CTAN: N/A (must be installed from the
658 subdirectory of LyX source distribution)
661 Notes: The document class
665 can be used to type letters according to Italian conventions.
666 It is not an existing LaTeX document class, but a new one which is distributed
673 Found: @chk_IEEEtran@
679 FTP: Currently, the IEEE ftp site only has an old version at:
684 \begin_inset LatexCommand \url{ftp://ftp.ieee.org/info/publish/latex/ieeetran.cls}
696 A newer version is available from:
701 \begin_inset LatexCommand \url{ftp://ftp.isi.edu/pub/graham/infocom99/latest/IEEEtran.cls}
712 produces documents suitable for submission to most of the IEEE Transactions.
713 You should consult the IEEE Author Information pages at
717 if you intend to use this class.
718 Note that there are both
734 file for use with LyX as the
738 file is for LaTeX 2.09 only.
739 Also note that if your
743 is in lowercase like this example LyX will not find it and you should upgrade
744 to a newer version which has IEEE in capitals.
760 is actually a LaTeX style file that adds some extra features to the
765 It produces documents suitable for submission to IEEE Conferences.
766 The LaTeX files (including BibTeX style file) are distributed with the
767 Author Kit for IEEE sponsored conferences.
773 Found: @chk_linuxdoc@
783 is not a LaTeX document class.
784 It is designed to produce LinuxDoc-SGML documents, which, in turn, can
785 be exported as HTML, RTF, text or...
795 ) set of programs installed to use this.
808 Notes: The document class
812 can be used to write articles for submission to the Springer journal
813 \begin_inset Quotes eld
816 Lecture Notes in Computer Science
817 \begin_inset Quotes erd
821 LaTeX documents are available from Springer's ftp site on the following
825 \begin_inset LatexCommand \url{ftp://trick.ntp.springer.de/pub/tex/latex/llncs/latex2e}
834 The LyX layout file for this document class is still insufficiently tested.
846 macros/latex/contrib/supported/paper/
849 Notes: The document class
853 provides an alternative to the standard
858 It provides similar functionality, but you might prefer this layout with
859 sans serif sections, headings, and more.
862 Koma-Script (scrartcl, scrreprt, scrbook)
865 Found: @chk_scrartcl@
870 macros/latex/contrib/supported/koma-script/
873 Notes: These document classes provide different versions of the base LaTeX
887 They have been changed to look somewhat better and be more adapted to european
888 typesetting standards.
899 macros/latex209/contrib/revtex/
902 Notes: The document class
906 is used to write articles for the publications of the American Physical
907 Society (APS), American Institute of Physics (AIP), and Optical Society
909 For better results, you should use the file
917 subdirectory of LyX source distribution.
928 macros/latex/contrib/supported/revtex4-beta/
931 Notes: RevTeX 4 is a class used for submitting manuscripts to journals including
932 APS (Physical Review A-E and Letters, Reviews in Modern Physics, Special
933 Topics---Accelerators and Beams), the American Institute of Physics, the
934 Optical Society of America, and the Society for Exploration Geophysicists.
935 [It is in BETA release as of September, 1999.]
938 Springer Journal of Geodesy
948 \begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
959 is for the journal formats used by Springer Verlag, in particular that
960 of Journal of Geodesy.
961 It is not very well tested yet.
962 The corresponding documentclass files and associated material can be found
963 on the Springer site.
964 The layout consists of two parts:
968 (which is generic for all Springer journals) and
976 and is specific for Journal of Geodesy.
977 You can write your own
981 to support any other Springer journals (hint, hint!)
984 Paper layout packages
987 Changing the margins of a document is one thing people like to do.
988 While LaTeX offers built-in options to set the margins of the documents,
989 some people feel that these margins are too large and want to set them
991 You can use the package
995 for this purpose, but note that for the sake of readability, your lines
996 should not contain more than 60-70 characters.
1007 macros/latex/contrib/supported/ntgclass/
1014 changes the margins of your document to suit the European A4 page dimensions
1015 with smaller margins that the default A4 format.
1026 macros/latex/contrib/other/misc/
1033 is another package that allows setting of the margins of your document
1035 With this package, the margins are very wide, but do not follow typographical
1042 Found: @chk_geometry@
1047 macros/latex/contrib/supported/geometry
1054 allows to change the paper size and margins of your document in an arbitrary
1056 It does not provide a typographically correct page layout like
1060 or the standard options, though.
1072 Found: @chk_algorithm@
1077 macros/latex/contrib/supported/algorithms/
1084 is needed by LyX to be able to output
1085 \begin_inset Quotes eld
1089 \begin_inset Quotes erd
1093 These are useful in placing short algorithms across pagebreaks and support
1095 \begin_inset Quotes eld
1099 \begin_inset Quotes erd
1113 macros/latex/packages/babel/
1120 allows you to customize your document for your favorite language (see the
1128 In particular, it handles hyphenation and automatic translation of all
1130 \begin_inset Quotes eld
1134 \begin_inset Quotes erd
1138 \begin_inset Quotes eld
1142 \begin_inset Quotes erd
1146 This package is not needed if you only plan to write in English, except
1147 if you want to use non-English quotes.
1158 macros/latex/packages/graphics/
1165 is needed by LyX to handled colored text.
1166 These colors will not show in the DVI preview window, but will be correct
1167 on the printed output or with a PostScript® previewer.
1168 This package is bundled with the
1173 \begin_inset LatexCommand \ref{ssec:graphics}
1183 Found: @chk_fancyhdr@
1188 macros/latex/contrib/supported/fancyhdr/
1195 (previously known as
1199 ) is used when you select the
1200 \begin_inset Quotes eld
1204 \begin_inset Quotes erd
1207 page style in the document layout popup.
1208 It provides alternate headers and footers to your pages.
1214 Found: @chk_floatflt@
1219 macros/latex/contrib/other/floatflt/
1230 ) is used by LyX if you select the ``floatflt'' type in
1232 Layout->Paragraph->ExtraOpt
1234 in the paragraph of a figure float.
1235 It allows you to create a figure float which is narrower than the full
1236 page and wrap the text around it.
1240 \begin_inset LatexCommand \label{ssec:graphics}
1247 Found: @chk_graphics@
1252 macros/latex/packages/graphics/
1259 is needed by LyX to insert PostScript® figures.
1260 You will also need the program
1266 to see them on screen.
1267 The configuration script has determined that the graphics driver used by
1268 the package should be
1271 \begin_inset Quotes eld
1274 @chk_graphicsdriver@
1275 \begin_inset Quotes erd
1279 \begin_float footnote
1285 \begin_inset Quotes eld
1293 \begin_inset Quotes erd
1298 means that your LaTeX installation provides a sensible value for this parameter.
1306 Found: @chk_rotating@
1311 macros/latex/contrib/supported/rotating
1318 is needed by LyX to change the orientation of some parts of your documents.
1319 Note that it only really works with a PostScript® compatible printer.
1325 Found: @chk_subfigure@
1330 macros/latex/contrib/supported/subfigure
1337 is used by LyX when you select ``subfigure'' in the EPS figure popup.
1338 Several figures marked in this way can be packed into a single float with
1339 individual subcaptions.
1345 Found: @chk_setspace@
1350 macros/latex/contrib/supported/setspace/
1357 is needed by LyX to change the line spacing of your document.
1363 Found: @chk_longtable@
1368 macros/latex/packages/tools/longtable.dtx
1375 is needed by LyX to be able to output correctly multipage tables.
1386 macros/latex/contrib/other/misc/url.sty
1393 is needed by LyX to be able to output url's corrently.
1399 Found: @chk_prettyref@
1404 macros/latex/contrib/supported/prettyref/
1411 package provides improved reference formatting for LaTeX and allows the
1413 \begin_inset Quotes eld
1417 \begin_inset Quotes erd
1420 all types of labels.
1426 Found: @chk_varioref@
1431 macros/latex/required/tools/varioref.dtx
1438 pacakage provides commands that work like the normal references in LaTeX
1439 except that it adds textual references, like 'on the facing page' or 'on
1440 page 27' when the corresponding label is not on the same page.
1446 Found: @chk_chess@ and @chk_lyxchess@
1461 subdirectory of LyX source distribution
1468 is needed in order to typeset chess diagrams with the external chess diagram
1470 You also need to install the fonts from the
1474 package, but leave out the
1478 style itself since it's meant for older versions of LaTeX only.
1481 Required external programs
1484 LyX is eager to invoke external programs to do some work.
1485 In line with the Unix tradition, LyX tries to exploit existing programs
1486 before implementing the same thing itself.
1487 Over time, LyX is able to interact with an increasing number of both command
1488 line and interactive applications, and this to a large degree explains
1489 why LyX is succesful.
1492 Note: if you use a Linux distribution, such as RedHat or Debian, most of
1493 these packages should be available as custom packages for the relevant
1494 system, and you might have most of it installed already.
1495 And most Unix systems will at least have LaTeX, although it may be a braindead
1497 Please check what you have before you go download the lot.
1507 \begin_inset LatexCommand \url[The XForms home page]{http://world.std.com/~xforms/}
1514 Notes: XForms is the underlying GUI toolkit.
1516 \begin_inset LatexCommand \url[get a version]{http://world.std.com/~xforms/ftp/ftp.html}
1520 for your architechture, if you want to compile your own version of LyX.
1530 \begin_inset LatexCommand \url[libXpm]{http://www.inria.fr/koala/lehors/xpm.html}
1537 Notes: libXpm is a library used to display pixmaps.
1538 If you want to compile LyX yourself, you'll also need libXpm.
1539 You'll have to get version 4.7 or newer.
1540 Older versions are incompatible with the current XForms library.
1550 \begin_inset LatexCommand \url[The teTeX Homepage]{http://www.tug.org/tetex/}
1557 Notes: teTex is a LaTeX distribution.
1558 In order to properly use LyX to create documents, you'll need to have a
1560 teTeX is pretty complete.
1570 \begin_inset LatexCommand \url[The NTeX homepage]{http://web.mathematik.uni-stuttgart.de/ntex/WWW/}
1577 Notes: NTeX is an alternative LaTeX distribution.
1578 This one is not as extensive as teTeX, so you might have to pick up a few
1579 more packages by hand compared to teTeX.
1582 Optional external programs
1592 \begin_inset LatexCommand \url[ChkTeX Homepage]{http://www.ifi.uio.no/~jensthi/chktex/}
1599 Notes: ChkTeX performs typographical checking.
1600 LyX can use ChkTeX as an aid to find common typograhical errors in your
1608 \begin_inset LatexCommand \url[CTAN]{http://tug.ctan.org/}
1615 Notes: The Comprehensive TeX Archive Network.
1616 Since LyX is based on LaTeX, practically any tool made for use with LaTeX
1617 can be used with LyX.
1618 The CTAN is an archive of packages, tools, documentation and much more
1619 about LaTeX, and therefore an invaluable resource if you want to become
1620 a power user of LaTeX (and LyX).
1621 (If you don't know anything about LaTeX yet, you may want to wait before
1622 exploring CTAN, because it is big and confusing at first.)
1632 \begin_inset LatexCommand \url[gBib]{http://www.mx.lyx.org/gbib}
1639 Notes: gBib is an interactive BibTeX database manager.
1640 This GNOME program allows you to manage a BibTeX bibliography database,
1641 and then interface it with LyX in a seamless fashion.
1647 Found: @chk_ghostview@
1651 \begin_inset LatexCommand \url[Ghostview]{http://www.cs.wisc.edu/~ghost/ghostview/index.html}
1658 Notes: Ghostview is used to preview PostScript files.
1660 \begin_inset LatexCommand \url[Ghostscript]{http://www.cs.wisc.edu/~ghost/aladdin/index.html}
1664 to be able to use Ghostview.
1670 Found: @chk_gifscii@
1674 \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}
1681 Notes: Gifscii is a program that can convert an raster image to an ascii
1683 This is utilized by the external raster image inset when you export a document
1694 \begin_inset LatexCommand \url[The Gimp Homepage]{http://www.gimp.org}
1701 Notes: The GIMP is the GNU Image Manipulation Program.
1702 It is a freely distributed piece of software suitable for such tasks as
1703 photo retouching, image composition and image authoring.
1704 The GIMP is used by LyX as the editor for the external raster image inset.
1714 \begin_inset LatexCommand \url[The XForms home page]{http://world.std.com/~xforms/}
1725 \begin_inset LatexCommand \url[gv]{http://wwwthep.physik.uni-mainz.de/~plass/gv/}
1729 - an alternative PostScript viewer.
1732 gv is a more modern PostScript viewer.
1733 It also requires Ghostscript to work.
1739 Found: @chk_imagemagick@
1743 \begin_inset LatexCommand \url[ImageMagick homepage]{http://www.imagemagick.org}
1750 Notes: ImageMagick is a robust collection of tools to read, write, and manipulat
1751 e an image in many image formats including popular formats like TIFF, JPEG,
1753 With ImageMagick you can resize, rotate, sharpen, color reduce, or add
1754 special effects to an image and save the result in a different image format.
1755 LyX uses ImageMagick to both display and convert raster format images in
1756 the external raster image inset.
1766 \begin_inset LatexCommand \url[International Ispell]{http://ficus-www.cs.ucla.edu/ficus-members/geoff/ispell.html}
1773 Notes: Ispell is a spellchecker for many languages.
1774 LyX can use Ispell as a backend to do spellchecking.
1776 \begin_inset LatexCommand \url[dictionaries for many languages]{http://ficus-www.cs.ucla.edu/ficus-members/geoff/ispell-dictionaries.html}
1780 and be able to spellcheck documents in your own language.
1790 \begin_inset LatexCommand \url[NoWeb]{http://www.cs.virginia.edu/~nr/noweb/}
1797 Notes: NoWeb is used for literate programming.
1798 Use LyX to write programs whose documentation and manuals are included
1809 \begin_inset LatexCommand \url[Perl]{http://www.perl.com}
1816 Notes: Perl is an interpreted, text-manipulation programming language.
1817 If you want to import LaTeX documents into LyX, you'll need to have Perl
1818 installed, because the reLyX script that does the conversion is written
1820 Note that reLyX is bundled with LyX, but is only installed if Perl is found.
1827 Found: @chk_pybliographer@
1831 \begin_inset LatexCommand \url[Pybliographer]{http://www.gnome.org/pybliographer/}
1838 Notes: Pybliographer is another GNOME BibTeX database manager.
1839 This is said to have good support for 8 bit characters, avoid choking on
1840 extra field definitions, produce very clean bibtex code and handle other
1841 bibliographic formats than BibTeX.
1842 And of course, it can interact with LyX.
1852 \begin_inset LatexCommand \url[Python]{http://www.python.org}
1859 Notes: Python is an interpreted, text-manipulation programming language.
1860 The Python interpreter is used for many of the gluing scripts that are
1861 used by the external material inset.
1862 For instance, it is required to use the ascii approximation of external
1863 raster images or to include chess diagrams with the external chess diagram
1870 Found: @chk_sgmltools@
1874 \begin_inset LatexCommand \url[The SGMLtools homepage]{http://www.sgmltools.org}
1881 Notes: SGMLtools is needed to use the LinuxDoc DTD.
1882 If you want to create documents using the LinuxDOC DTD that is used for
1884 \begin_inset LatexCommand \url[Linux Documentation Project]{http://sunsite.unc.edu/LDP/}
1888 to create documents in a variety of different formats, you'll need to get
1895 Found: @chk_tkbibtex@
1899 \begin_inset LatexCommand \url[tkbibtex]{http://www.cat.csiro.au/dmt/programs/autom/pic/tkbibtex.html}
1906 Notes: tkbibtex - a portable Tcl/Tk browser/editor for BibTeX files.
1907 tkbibtex is a portable editor and browser for BibTeX format file.
1908 It provides an interface to LyX - insert a citation with a single keypress.
1918 \begin_inset LatexCommand \url[The XBoard homepage]{http://www.research.digital.com/SRC/personal/Tim_Mann/chess.html}
1925 Notes: XBoard is a graphical chessboard that can serve as a user interface
1926 for GNU Chess, for the Internet Chess Server, or for electronic mail correspond
1928 XBoard can also be used by itself, and it's in this capacity LyX can exploit
1929 to as the editor for external chess diagrams.
1934 feature in XBoard to save your chess position as a
1939 Be sure you specify a relative path compared to your LyX document.
1940 You might also want to investigate the
1946 Options->Test Legality
1948 commands, and remember to use the right mouse to insert new material on