lyx_mirror/lib/doc/LyXConfig.lyx.in
Jean-Marc Lasgouttes f27810979c get rid of ejour2; formgraphics tweaks from Juergen S
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@3702 a592a061-630c-0410-9148-cb99ea01b6c8
2002-03-08 13:53:30 +00:00

1934 lines
38 KiB
Plaintext
Raw Blame History

#LyX 1.2 created this file. For more info see http://www.lyx.org/
\lyxformat 220
\textclass article
\language english
\inputencoding default
\fontscheme default
\graphics dvips
\paperfontsize default
\spacing single
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
\use_natbib 0
\use_numerical_citations 0
\paperorientation portrait
\secnumdepth 2
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle plain
\layout Title
Inventory of your LaTeX and system configuration
\layout Author
Automatically generated by LyX (do not edit).
\layout Date
@chk_date@
\layout Standard
This file describes both the different LaTeX add-ons that LyX can handle
and different external programs that LyX can interact with.
Below you'll find the following sections:
\layout Enumerate
Some basic details about your LaTeX installation.
In particular, you should make sure that your version of LaTeX is recent
enough.
\layout Enumerate
Some common fonts that LyX knows about.
This is rather sparse at the moment.
\layout Enumerate
The document classes that should be standard on any LaTeX implementation.
This section is only here for completeness.
\layout Enumerate
Some optional document classes that LyX knows about.
If one of these is marked as missing (the
\begin_inset Quotes eld
\end_inset
Found
\begin_inset Quotes erd
\end_inset
item is no) and you need its functionality, you can grab it at your nearest
CTAN ftp site
\begin_inset Foot
collapsed true
\layout Standard
The participating hosts in the Comprehensive TeX Archive Network are:
\layout LyX-Code
ftp://ftp.dante.de/tex-archive
\layout LyX-Code
ftp://ctan.tug.org/tex-archive
\layout LyX-Code
ftp://ftp.tex.ac.uk/tex-archive
\layout Standard
There are also a zillion mirror sites which are listed at the three primary
sites.
\end_inset
at the location indicated in the
\begin_inset Quotes eld
\end_inset
CTAN
\begin_inset Quotes erd
\end_inset
item.
Note that only detected document classes can be selected as document layouts
in LyX.
\layout Enumerate
Some packages that LyX use when you try to change the margins of your document.
The detection of these items does not yet affect the options available
inside LyX.
\layout Enumerate
Some common LaTeX packages that you might need with LyX, and you might also
want to add to your LaTeX installation.
The detection of these items does not yet affect the options available
inside LyX.
\layout Enumerate
Different required external programs that LyX relies on.
LyX to a large extent relies on other programs to do it's work, and some
programs are required for LyX to be useful.
\layout Enumerate
Different optional external programs that LyX can interact with.
All of these are optional, and some you would want more than others.
\layout Standard
Note that most of these packages will be available if you use a modern TeX
distribution such as teTeX.
If you decide to install one of the missing items, you should tell LyX
about it.
After the installation, please use the menu entry
\family sans
\bar under
O
\bar default
ptions\SpecialChar \menuseparator
\bar under
R
\bar default
econfigure
\begin_inset Foot
collapsed true
\layout Standard
or, if you want to change the system-wide settings, issue the command
\family typewriter
./configure
\family default
from the LyX system directory (by default
\family typewriter
/usr/local/lib/lyx/
\family default
)
\end_inset
and reload this file to see if the new package was recognized.
If the
\begin_inset Quotes eld
\end_inset
Found
\begin_inset Quotes erd
\end_inset
items read
\begin_inset Quotes eld
\end_inset
???
\begin_inset Quotes erd
\end_inset
, it means that LyX could not do the inventory of your LaTeX configuration
for some reason.
If you are using teTeX, it might be that the new package you installed
is not found.
This is because you forgot to run the command
\family typewriter
texhash
\family default
, which tells teTeX to update its own configuration.
\layout Section
LaTeX version currently in use
\layout Standard
The LaTeX version that LyX will use is:
\family typewriter
@chk_fmtversion@
\family default
.
Note that, for best results, you should be using at least LaTeX release
\family typewriter
1995/12/01
\begin_inset Foot
collapsed true
\layout Standard
In case it is not clear to you, this number is the date at which the version
has been released.
\end_inset
.
In fact, earlier versions may work for many things, but will certainly
fail in some cases.
We feel that it is better to stick to a minimal version than try to work
around all the quirks of older ones.
\layout Section
Fonts
\layout Subsection
EC fonts
\layout Description
Found: @chk_ec@
\layout Description
CTAN:
\family typewriter
fonts/ec
\layout Description
Notes: LaTeX does not require the use of
\family sans
ec
\family default
fonts, however they are strongly recommended.
The
\family sans
ec
\family default
fonts are available in a more natural range of sizes and allow better hyphenati
on and kerning than the old fonts such as
\family sans
cmr10
\family default
.
If you already have the so-called
\family sans
dc
\family default
fonts installed, please upgrade to the
\family sans
ec
\family default
fonts, which replace them.
They are used automatically if LyX determines that you have them installed.
\layout Subsection
psnfss
\layout Description
Found: @chk_psnfss@
\layout Description
CTAN:
\family typewriter
macros/latex/packages/psnfss/
\layout Description
Notes: The package
\family sans
psnfss
\family default
allows you to change the fonts used by LyX to one of the 35 classical fonts
available on PostScript<70> printers.
Currently, the support for
\family sans
psnfss
\family default
is limited in LyX: you can only chose a few combinations of PostScript<70>
fonts in
\family sans
\size normal
Layout->Document
\family default
\size default
.
\layout Section
Standard LaTeX document classes
\layout Standard
The document classes presented in this section are the basic document classes
provided by LaTeX.
In particular, they are all present on your system as long as LaTeX2e is
installed.
When the text indicates that a particular class has not been found, this
means the layout file supporting this particular class has not been found.
\layout Subsection
article
\layout Description
Found: @chk_article@
\layout Description
CTAN: N/A
\layout Description
Notes: The standard document class
\family sans
article
\family default
is used to type articles or short texts.
It is the basic LaTeX document class.
\layout Subsection
report
\layout Description
Found: @chk_report@
\layout Description
CTAN: N/A
\layout Description
Notes: The standard document class
\family sans
report
\family default
is similar to
\family sans
article
\family default
but is slightly more structured (support for different parts).
\layout Subsection
book
\layout Description
Found: @chk_book@
\layout Description
CTAN: N/A
\layout Description
Notes: The standard document class
\family sans
book
\family default
is, as its name suggests, intended to produce books.
It supports in particular sectioning by chapters.
\layout Subsection
letter
\layout Description
Found: @chk_letter@
\layout Description
CTAN: N/A
\layout Description
Notes: The standard document class
\family sans
letter
\family default
is the basic class for writing letters, mostly in English.
\layout Subsection
slides
\layout Description
Found: @chk_slides@
\layout Description
CTAN: N/A
\layout Description
Notes: The standard document class
\family sans
slides
\family default
is intended to produce transparencies.
\layout Section
Additional document classes
\layout Subsection
aa
\layout Description
Found: @chk_aapaper@
\layout Description
CTAN: N/A (available from Springer's ftp site
\family typewriter
ftp.springer.de
\family default
in directory
\family typewriter
/pub/tex/latex/aa
\family default
)
\layout Description
Notes: The document class
\family sans
aa
\family default
can be used to write articles for submission to the scientific journal
\emph on
Astronomy and Astrophysics
\emph default
and the accompanying
\emph on
Supplement Series
\emph default
published by Springer -Verlag.
\layout Subsection
aastex
\layout Description
Found: @chk_aastex@
\layout Description
CTAN: N/A (available from the American Astronomical Society's ftp site
\family typewriter
ftp.aas.
\family default
org in directory
\family typewriter
/pub
\family default
s)
\layout Description
Notes: The document class
\family sans
aastex
\family default
can be used to write articles for submission to the American journals
\emph on
Astrophysical Journal, Astronomical Journal
\emph default
and
\emph on
Publications of the Astronomical Society of the Pacific
\emph default
.
\layout Subsection
amsart
\layout Description
Found: @chk_amsart@
\layout Description
CTAN:
\family typewriter
fonts/ams/amslatex/inputs/
\layout Description
Notes: The document class
\family sans
amsart
\family default
is an alternative to the class
\family sans
article
\family default
.
It is part of the AMS-LaTeX package and is used for typesetting of mathematics
with a look the American Mathematical Society has developed.
They recommend it for the preparation of manuscripts intended for publication
both in the Society's books and journals, and also in other mathematical
literature.
The Society requests that published documents prepared with AMS-LaTeX include
an acknowledgment of its use.
LyX support is still limited.
\layout Subsection
broadway
\layout Description
Found: @chk_broadway@
\layout Description
CTAN: N/A (must be installed from the
\family typewriter
tex/
\family default
subdirectory of LyX source distribution)
\layout Description
Notes: The document class
\family sans
broadway
\family default
is for writing plays.
It is not an existing LaTeX document class, but a new one which is distributed
with LyX.
\layout Subsection
dinbrief
\layout Description
Found: @chk_dinbrief@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/dinbrief/
\layout Description
Notes: The document class
\family sans
dinbrief
\family default
can be used to type letters according to German conventions.
\layout Subsection
docbook
\layout Description
Found: @chk_docbook@
\layout Description
CTAN: N/A
\layout Description
WWW:
\begin_inset LatexCommand \url{http://www.sgmltools.org}
\end_inset
\layout Description
Notes: The class docbook is not a LaTeX document class.
It is designed to produce Docbook SGML documents, which, in turn, can be
exported as HTML, RTF, text, or dvi (through
\family typewriter
jadetex
\family default
).
You need the sgmltools v2.0 package installed to use this.
\layout Subsection
g-brief-en
\layout Description
Found: @chk_g-brief-en@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/g-brief/
\layout Description
Notes: The document class
\family sans
g-brief
\family default
can be used to type commercial letters with a nice outfit.
\layout Subsection
g-brief-de
\layout Description
Found: @chk_g-brief-de@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/g-brief/
\layout Description
Notes: The document class
\family sans
g-brief-de
\family default
is the same as the above g-brief-en only with german labels.
\layout Subsection
foils
\layout Description
Found: @chk_foils@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/foiltex/
\layout Description
Notes: The document class
\family sans
foils
\family default
(aka FoilTeX) provides an alternative to the standard
\family sans
slides
\family default
class to make transparencies.
It allows cross references, uses a less ugly font, and is in general much
better to use than
\family sans
slides
\family default
.
It does not however have some of the advanced features found in the
\family sans
seminar
\family default
class, which is not currently supported by LyX.
\layout Subsection
hollywood
\layout Description
Found: @chk_hollywood@
\layout Description
CTAN: N/A (must be installed from the
\family typewriter
tex/
\family default
subdirectory of LyX source distribution)
\layout Description
Notes: The document class
\family sans
hollywood
\family default
can be used to type spec scripts for the U.S.
film industry.
It is not an existing LaTeX document class, but a new one which is distributed
with LyX.
\layout Subsection
iletter
\layout Description
Found: @chk_iletter@
\layout Description
CTAN: N/A (must be installed from the
\family typewriter
tex/
\family default
subdirectory of LyX source distribution)
\layout Description
Notes: The document class
\family sans
iletter
\family default
can be used to type letters according to Italian conventions.
It is not an existing LaTeX document class, but a new one which is distributed
with LyX.
\layout Subsection
IEEEtran
\layout Description
Found: @chk_IEEEtran@
\layout Description
CTAN: N/A
\layout Description
FTP: Currently, the IEEE ftp site only has an old version at:
\newline
\family sans
\begin_inset LatexCommand \url{ftp://ftp.ieee.org/info/publish/latex/ieeetran.cls}
\end_inset
\family default
\family sans
\newline
\family default
A newer version is available from:
\newline
\family sans
\begin_inset LatexCommand \url{ftp://ftp.isi.edu/pub/graham/infocom99/latest/IEEEtran.cls}
\end_inset
\layout Description
Notes: The class
\family sans
IEEEtran
\family default
produces documents suitable for submission to most of the IEEE Transactions.
You should consult the IEEE Author Information pages at
\family sans
www.ieee.org
\family default
if you intend to use this class.
Note that there are both
\family sans
IEEEtran.cls
\family default
and
\family sans
IEEEtran.sty
\family default
files you
\emph on
must
\emph default
get the
\family sans
.cls
\family default
file for use with LyX as the
\family sans
.sty
\family default
file is for LaTeX 2.09 only.
Also note that if your
\family sans
ieeetran.cls
\family default
is in lowercase like this example LyX will not find it and you should upgrade
to a newer version which has IEEE in capitals.
\layout Subsection
latex8
\layout Description
Found: @chk_latex8@
\layout Description
CTAN: N/A
\layout Description
Notes: The class
\family sans
latex8
\family default
is actually a LaTeX style file that adds some extra features to the
\family sans
article
\family default
document class.
It produces documents suitable for submission to IEEE Conferences.
The LaTeX files (including BibTeX style file) are distributed with the
Author Kit for IEEE sponsored conferences.
\layout Subsection
linuxdoc
\layout Description
Found: @chk_linuxdoc@
\layout Description
CTAN: N/A
\layout Description
Notes: The class
\family sans
linuxdoc
\family default
is not a LaTeX document class.
It is designed to produce LinuxDoc-SGML documents, which, in turn, can
be exported as HTML, RTF, text or...
LaTeX.
You need to have the
\family sans
sgml-tools
\family default
(previously known as
\family sans
LinuxDoc
\family default
) set of programs installed to use this.
\layout Subsection
llncs
\layout Description
Found: @chk_llncs@
\layout Description
CTAN: N/A
\layout Description
Notes: The document class
\family sans
llncs
\family default
can be used to write articles for submission to the Springer journal
\begin_inset Quotes eld
\end_inset
Lecture Notes in Computer Science
\begin_inset Quotes erd
\end_inset
.
LaTeX documents are available from Springer's ftp site on the following
URL:
\newline
\begin_inset LatexCommand \url{ftp://trick.ntp.springer.de/pub/tex/latex/llncs/latex2e}
\end_inset
.
\begin_deeper
\layout Standard
The LyX layout file for this document class is still insufficiently tested.
\end_deeper
\layout Subsection
paper
\layout Description
Found: @chk_paper@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/paper/
\layout Description
Notes: The document class
\family sans
paper
\family default
provides an alternative to the standard
\family sans
article
\family default
class.
It provides similar functionality, but you might prefer this layout with
sans serif sections, headings, and more.
\layout Subsection
Koma-Script (scrartcl, scrreprt, scrbook)
\layout Description
Found: @chk_scrartcl@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/koma-script/
\layout Description
Notes: These document classes provide different versions of the base LaTeX
document classes
\family sans
article
\family default
,
\family sans
report
\family default
and
\family sans
book
\family default
.
They have been changed to look somewhat better and be more adapted to european
typesetting standards.
\layout Subsection
REVTeX
\layout Description
Found: @chk_revtex@
\layout Description
CTAN:
\family typewriter
macros/latex209/contrib/revtex/
\layout Description
Notes: The document class
\family sans
revtex
\family default
is used to write articles for the publications of the American Physical
Society (APS), American Institute of Physics (AIP), and Optical Society
of America (OSA).
For better results, you should use the file
\family typewriter
revtex.cls
\family default
from the
\family typewriter
tex/
\family default
subdirectory of LyX source distribution.
\layout Subsection
REVTeX 4
\layout Description
Found: @chk_revtex4@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/revtex4-beta/
\layout Description
Notes: RevTeX 4 is a class used for submitting manuscripts to journals including
APS (Physical Review A-E and Letters, Reviews in Modern Physics, Special
Topics---Accelerators and Beams), the American Institute of Physics, the
Optical Society of America, and the Society for Exploration Geophysicists.
[It is in BETA release as of September, 1999.]
\layout Subsection
Springer Journal of Geodesy
\layout Description
Found: @chk_svjog@
\layout Description
CTAN: N/A
\layout Description
WWW:
\begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
\end_inset
\layout Description
Notes:
\family sans
Svjog
\family default
is for the journal formats used by Springer Verlag, in particular that
of Journal of Geodesy.
It is not very well tested yet.
The corresponding documentclass files and associated material can be found
on the Springer site.
The layout consists of two parts:
\family typewriter
svjour.inc
\family default
(which is generic for all Springer journals) and
\family typewriter
svjog.layout
\family default
, which includes
\family typewriter
svjour.inc
\family default
and is specific for Journal of Geodesy.
You can write your own
\family typewriter
sv<journal>.layout
\family default
to support any other Springer journals (hint, hint!)
\layout Section
Paper layout packages
\layout Standard
Changing the margins of a document is one thing people like to do.
While LaTeX offers built-in options to set the margins of the documents,
some people feel that these margins are too large and want to set them
up differently.
You can use the package
\family sans
geometry
\family default
for this purpose, but note that for the sake of readability, your lines
should not contain more than 60-70 characters.
\layout Subsection
a4
\layout Description
Found: @chk_a4@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/ntgclass/
\layout Description
Notes: The package
\family sans
a4
\family default
changes the margins of your document to suit the European A4 page dimensions
with smaller margins that the default A4 format.
\layout Subsection
a4wide
\layout Description
Found: @chk_a4wide@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/other/misc/
\layout Description
Notes: The package
\family sans
a4wide
\family default
is another package that allows setting of the margins of your document
to A4 paper.
With this package, the margins are very wide, but do not follow typographical
conventions.
\layout Subsection
geometry
\layout Description
Found: @chk_geometry@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/geometry
\layout Description
Notes: The package
\family sans
geometry
\family default
allows to change the paper size and margins of your document in an arbitrary
way.
It does not provide a typographically correct page layout like
\family sans
a4
\family default
or the standard options, though.
\layout Section
\series bold
\size large
Other packages
\layout Subsection
algorithm
\layout Description
Found: @chk_algorithm@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/algorithms/
\layout Description
Notes: The package
\family sans
algorithm
\family default
is needed by LyX to be able to output
\begin_inset Quotes eld
\end_inset
algorithm-floats
\begin_inset Quotes erd
\end_inset
.
These are useful in placing short algorithms across pagebreaks and support
an
\begin_inset Quotes eld
\end_inset
index of algorithms
\begin_inset Quotes erd
\end_inset
too.
\layout Subsection
babel
\layout Description
Found: @chk_babel@
\layout Description
CTAN:
\family typewriter
macros/latex/packages/babel/
\layout Description
Notes: The package
\family sans
babel
\family default
allows you to customize your document for your favorite language (see the
\family sans
\size normal
Layout->Document
\family default
\size default
popup).
In particular, it handles hyphenation and automatic translation of all
labels like
\begin_inset Quotes eld
\end_inset
Chapter
\begin_inset Quotes erd
\end_inset
and
\begin_inset Quotes eld
\end_inset
Table of contents
\begin_inset Quotes erd
\end_inset
.
This package is not needed if you only plan to write in English, except
if you want to use non-English quotes.
\layout Subsection
color
\layout Description
Found: @chk_color@
\layout Description
CTAN:
\family typewriter
macros/latex/packages/graphics/
\layout Description
Notes: The package
\family sans
color
\family default
is needed by LyX to handled colored text.
These colors will not show in the DVI preview window, but will be correct
on the printed output or with a PostScript<70> previewer.
This package is bundled with the
\family sans
graphics
\family default
package (see
\begin_inset LatexCommand \ref{ssec:graphics}
\end_inset
).
\layout Subsection
fancyhdr
\layout Description
Found: @chk_fancyhdr@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/fancyhdr/
\layout Description
Notes: The package
\family sans
fancyhdr
\family default
(previously known as
\family sans
fancyheadings
\family default
) is used when you select the
\begin_inset Quotes eld
\end_inset
fancy
\begin_inset Quotes erd
\end_inset
page style in the document layout popup.
It provides alternate headers and footers to your pages.
\layout Subsection
floatflt
\layout Description
Found: @chk_floatflt@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/other/floatflt/
\layout Description
Notes: The package
\family sans
floatflt
\family default
(an extension of
\family sans
floatfig
\family default
) is used by LyX if you select the ``floatflt'' type in
\family sans
Layout->Paragraph->ExtraOpt
\family default
in the paragraph of a figure float.
It allows you to create a figure float which is narrower than the full
page and wrap the text around it.
\layout Subsection
\begin_inset LatexCommand \label{ssec:graphics}
\end_inset
graphics
\layout Description
Found: @chk_graphics@
\layout Description
CTAN:
\family typewriter
macros/latex/packages/graphics/
\layout Description
Notes: The package
\family sans
graphics
\family default
is needed by LyX to insert PostScript<70> figures.
You will also need the program
\family typewriter
\size normal
ghostview
\family default
\size default
to see them on screen.
The configuration script has determined that the graphics driver used by
the package should be
\family sans
\begin_inset Quotes eld
\end_inset
@chk_graphicsdriver@
\begin_inset Quotes erd
\end_inset
\begin_inset Foot
collapsed true
\layout Standard
Here, a value of
\begin_inset Quotes eld
\end_inset
default
\begin_inset Quotes erd
\end_inset
means that your LaTeX installation provides a sensible value for this parameter.
\end_inset
.
\layout Subsection
rotating
\layout Description
Found: @chk_rotating@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/rotating
\layout Description
Notes: The package
\family sans
rotating
\family default
is needed by LyX to change the orientation of some parts of your documents.
Note that it only really works with a PostScript<70> compatible printer.
\layout Subsection
subfigure
\layout Description
Found: @chk_subfigure@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/subfigure
\layout Description
Notes: The package
\family sans
subfigure
\family default
is used by LyX when you select ``subfigure'' in the EPS figure popup.
Several figures marked in this way can be packed into a single float with
individual subcaptions.
\layout Subsection
setspace
\layout Description
Found: @chk_setspace@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/setspace/
\layout Description
Notes: The package
\family sans
setspace
\family default
is needed by LyX to change the line spacing of your document.
\layout Subsection
longtable
\layout Description
Found: @chk_longtable@
\layout Description
CTAN:
\family typewriter
macros/latex/packages/tools/longtable.dtx
\layout Description
Notes: The package
\family sans
longtable
\family default
is needed by LyX to be able to output correctly multipage tables.
\layout Subsection
url
\layout Description
Found: @chk_url@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/other/misc/url.sty
\layout Description
Notes: The package
\family sans
url
\family default
is needed by LyX to be able to output url's corrently.
\layout Subsection
prettyref
\layout Description
Found: @chk_prettyref@
\layout Description
CTAN:
\family typewriter
macros/latex/contrib/supported/prettyref/
\layout Description
Notes: The
\family sans
prettyref
\family default
package provides improved reference formatting for LaTeX and allows the
author to
\begin_inset Quotes eld
\end_inset
preformat
\begin_inset Quotes erd
\end_inset
all types of labels.
\layout Subsection
varioref
\layout Description
Found: @chk_varioref@
\layout Description
CTAN:
\family typewriter
macros/latex/required/tools/varioref.dtx
\layout Description
Notes: The
\family sans
varioref
\family default
pacakage provides commands that work like the normal references in LaTeX
except that it adds textual references, like 'on the facing page' or 'on
page 27' when the corresponding label is not on the same page.
\layout Subsection
chess and lyxchess
\layout Standard
Found: @chk_chess@ and @chk_lyxchess@
\layout Description
CTAN:
\family typewriter
fonts/chess/
\family default
, and the
\family typewriter
lyxchess.sty
\family default
file from the
\family typewriter
tex/
\family default
subdirectory of LyX source distribution
\layout Description
Notes: The package
\family sans
lyxchess.sty
\family default
is needed in order to typeset chess diagrams with the external chess diagram
inset.
You also need to install the fonts from the
\family sans
chess.sty
\family default
package, but leave out the
\family sans
chess.sty
\family default
style itself since it's meant for older versions of LaTeX only.
\layout Section
Required external programs
\layout Standard
LyX is eager to invoke external programs to do some work.
In line with the Unix tradition, LyX tries to exploit existing programs
before implementing the same thing itself.
Over time, LyX is able to interact with an increasing number of both command
line and interactive applications, and this to a large degree explains
why LyX is succesful.
\layout Standard
Note: if you use a Linux distribution, such as RedHat or Debian, most of
these packages should be available as custom packages for the relevant
system, and you might have most of it installed already.
And most Unix systems will at least have LaTeX, although it may be a braindead
version.
Please check what you have before you go download the lot.
\layout Subsection
XForms
\layout Description
Found: @chk_xforms@
\layout Description
URL:
\begin_inset LatexCommand \url[The XForms home page]{http://world.std.com/~xforms/}
\end_inset
\layout Description
Notes: XForms is the underlying GUI toolkit.
You'll need to
\begin_inset LatexCommand \url[get a version]{http://world.std.com/~xforms/ftp/ftp.html}
\end_inset
for your architechture, if you want to compile your own version of LyX.
\layout Subsection
libXpm
\layout Description
Found: @chk_libxpm@
\layout Description
URL:
\begin_inset LatexCommand \url[libXpm]{http://www.inria.fr/koala/lehors/xpm.html}
\end_inset
\layout Description
Notes: libXpm is a library used to display pixmaps.
If you want to compile LyX yourself, you'll also need libXpm.
You'll have to get version 4.7 or newer.
Older versions are incompatible with the current XForms library.
\layout Subsection
teTeX
\layout Description
Found: @chk_tetex@
\layout Description
URL:
\begin_inset LatexCommand \url[The teTeX Homepage]{http://www.tug.org/tetex/}
\end_inset
\layout Description
Notes: teTex is a LaTeX distribution.
In order to properly use LyX to create documents, you'll need to have a
LaTeX installation.
teTeX is pretty complete.
\layout Subsection
NTeX
\layout Description
Found: @chk_ntex@
\layout Description
URL:
\begin_inset LatexCommand \url[The NTeX homepage]{http://web.mathematik.uni-stuttgart.de/ntex/WWW/}
\end_inset
\layout Description
Notes: NTeX is an alternative LaTeX distribution.
This one is not as extensive as teTeX, so you might have to pick up a few
more packages by hand compared to teTeX.
\layout Section
Optional external programs
\layout Subsection
ChkTeX
\layout Description
Found: @chk_chktex@
\layout Description
URL:
\begin_inset LatexCommand \url[ChkTeX Homepage]{http://www.ifi.uio.no/~jensthi/chktex/}
\end_inset
\layout Description
Notes: ChkTeX performs typographical checking.
LyX can use ChkTeX as an aid to find common typograhical errors in your
document.
\layout Subsection
CTAN
\layout Description
URL:
\begin_inset LatexCommand \url[CTAN]{http://tug.ctan.org/}
\end_inset
\layout Description
Notes: The Comprehensive TeX Archive Network.
Since LyX is based on LaTeX, practically any tool made for use with LaTeX
can be used with LyX.
The CTAN is an archive of packages, tools, documentation and much more
about LaTeX, and therefore an invaluable resource if you want to become
a power user of LaTeX (and LyX).
(If you don't know anything about LaTeX yet, you may want to wait before
exploring CTAN, because it is big and confusing at first.)
\layout Subsection
gBib
\layout Description
Found: @chk_gbib@
\layout Description
URL:
\begin_inset LatexCommand \url[gBib]{http://www.mx.lyx.org/gbib}
\end_inset
\layout Description
Notes: gBib is an interactive BibTeX database manager.
This GNOME program allows you to manage a BibTeX bibliography database,
and then interface it with LyX in a seamless fashion.
\layout Subsection
Ghostview
\layout Description
Found: @chk_ghostview@
\layout Description
URL:
\begin_inset LatexCommand \url[Ghostview]{http://www.cs.wisc.edu/~ghost/ghostview/index.html}
\end_inset
\layout Description
Notes: Ghostview is used to preview PostScript files.
You'll also need
\begin_inset LatexCommand \url[Ghostscript]{http://www.cs.wisc.edu/~ghost/aladdin/index.html}
\end_inset
to be able to use Ghostview.
\layout Subsection
Gifscii
\layout Description
Found: @chk_gifscii@
\layout Description
URL:
\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}
\end_inset
\layout Description
Notes: Gifscii is a program that can convert an raster image to an ascii
approximation.
This is utilized by the external raster image inset when you export a document
to Ascii.
\layout Subsection
GIMP
\layout Description
Found: @chk_gimp@
\layout Description
URL:
\begin_inset LatexCommand \url[The Gimp Homepage]{http://www.gimp.org}
\end_inset
\layout Description
Notes: The GIMP is the GNU Image Manipulation Program.
It is a freely distributed piece of software suitable for such tasks as
photo retouching, image composition and image authoring.
The GIMP is used by LyX as the editor for the external raster image inset.
\layout Subsection
gv
\layout Description
Found: @chk_gv@
\layout Description
URL:
\begin_inset LatexCommand \url[The XForms home page]{http://world.std.com/~xforms/}
\end_inset
\layout Description
Notes:
\layout Standard
\begin_inset LatexCommand \url[gv]{http://wwwthep.physik.uni-mainz.de/~plass/gv/}
\end_inset
- an alternative PostScript viewer.
\layout Standard
gv is a more modern PostScript viewer.
It also requires Ghostscript to work.
\layout Subsection
ImageMagick
\layout Description
Found: @chk_imagemagick@
\layout Description
URL:
\begin_inset LatexCommand \url[ImageMagick homepage]{http://www.imagemagick.org}
\end_inset
\layout Description
Notes: ImageMagick is a robust collection of tools to read, write, and manipulat
e an image in many image formats including popular formats like TIFF, JPEG,
PNG, PDF, and GIF.
With ImageMagick you can resize, rotate, sharpen, color reduce, or add
special effects to an image and save the result in a different image format.
LyX uses ImageMagick to both display and convert raster format images in
the external raster image inset.
\layout Subsection
Ispell
\layout Description
Found: @chk_ispell@
\layout Description
URL:
\begin_inset LatexCommand \url[International Ispell]{http://ficus-www.cs.ucla.edu/ficus-members/geoff/ispell.html}
\end_inset
\layout Description
Notes: Ispell is a spellchecker for many languages.
LyX can use Ispell as a backend to do spellchecking.
You can find
\begin_inset LatexCommand \url[dictionaries for many languages]{http://ficus-www.cs.ucla.edu/ficus-members/geoff/ispell-dictionaries.html}
\end_inset
and be able to spellcheck documents in your own language.
\layout Subsection
NoWeb
\layout Description
Found: @chk_noweb@
\layout Description
URL:
\begin_inset LatexCommand \url[NoWeb]{http://www.cs.virginia.edu/~nr/noweb/}
\end_inset
\layout Description
Notes: NoWeb is used for literate programming.
Use LyX to write programs whose documentation and manuals are included
in the program.
\layout Subsection
Perl
\layout Description
Found: @chk_perl@
\layout Description
URL:
\begin_inset LatexCommand \url[Perl]{http://www.perl.com}
\end_inset
\layout Description
Notes: Perl is an interpreted, text-manipulation programming language.
If you want to import LaTeX documents into LyX, you'll need to have Perl
installed, because the reLyX script that does the conversion is written
in Perl.
Note that reLyX is bundled with LyX, but is only installed if Perl is found.
\layout Subsection
Pybliographer
\layout Description
Found: @chk_pybliographer@
\layout Description
URL:
\begin_inset LatexCommand \url[Pybliographer]{http://www.gnome.org/pybliographer/}
\end_inset
\layout Description
Notes: Pybliographer is another GNOME BibTeX database manager.
This is said to have good support for 8 bit characters, avoid choking on
extra field definitions, produce very clean bibtex code and handle other
bibliographic formats than BibTeX.
And of course, it can interact with LyX.
\layout Subsection
Python
\layout Standard
Found: @chk_python@
\layout Description
URL:
\begin_inset LatexCommand \url[Python]{http://www.python.org}
\end_inset
\layout Description
Notes: Python is an interpreted, text-manipulation programming language.
The Python interpreter is used for many of the gluing scripts that are
used by the external material inset.
For instance, it is required to use the ascii approximation of external
raster images or to include chess diagrams with the external chess diagram
inset.
\layout Subsection
SGMLtools
\layout Description
Found: @chk_sgmltools@
\layout Description
URL:
\begin_inset LatexCommand \url[The SGMLtools homepage]{http://www.sgmltools.org}
\end_inset
\layout Description
Notes: SGMLtools is needed to use the LinuxDoc DTD.
If you want to create documents using the LinuxDOC DTD that is used for
the
\begin_inset LatexCommand \url[Linux Documentation Project]{http://sunsite.unc.edu/LDP/}
\end_inset
to create documents in a variety of different formats, you'll need to get
the SGMLtools.
\layout Subsection
tkbibtex
\layout Description
Found: @chk_tkbibtex@
\layout Description
URL:
\begin_inset LatexCommand \url[tkbibtex]{http://www.cat.csiro.au/dmt/programs/autom/pic/tkbibtex.html}
\end_inset
\layout Description
Notes: tkbibtex - a portable Tcl/Tk browser/editor for BibTeX files.
tkbibtex is a portable editor and browser for BibTeX format file.
It provides an interface to LyX - insert a citation with a single keypress.
\layout Subsection
XBoard
\layout Description
Found: @chk_xboard@
\layout Description
URL:
\begin_inset LatexCommand \url[The XBoard homepage]{http://www.research.digital.com/SRC/personal/Tim_Mann/chess.html}
\end_inset
\layout Description
Notes: XBoard is a graphical chessboard that can serve as a user interface
for GNU Chess, for the Internet Chess Server, or for electronic mail correspond
ence chess.
XBoard can also be used by itself, and it's in this capacity LyX can exploit
to as the editor for external chess diagrams.
Use the
\family sans
File->Save Position
\family default
feature in XBoard to save your chess position as a
\family typewriter
.fen
\family default
file.
Be sure you specify a relative path compared to your LyX document.
You might also want to investigate the
\family sans
Edit->Edit Position
\family default
and
\family sans
Options->Test Legality
\family default
commands, and remember to use the right mouse to insert new material on
the board.
\the_end