trunk/base/texpert.txt

   1               LaTeX installation TeX expert information
   2
   3                         1 June 1997
   4
   5
   6 SUMMARY
   7 =======
   8
   9 This document contains information about the LaTeX installation for
  10 TeX experts.  In particular it describes:
  11
  12  * The checks performed by ltxcheck.tex
  13
  14  * How to print the LaTeX source.
  15
  16 For more general information, see install.txt.
  17
  18 For information on configuring LaTeX see cfgguide.tex.
  19
  20
  21 THE LTXCHECK.TEX CHECKS
  22 =======================
  23
  24 Here is a description of the checks run by ltxcheck.
  25
  26 1) The \@currdir check.
  27
  28    It is useful for LaTeX to know the syntax for the `current directory
  29    (or folder)', or `default directory', if  the operating system has
  30    such a concept.
  31
  32    For example, file abc.tex in this directory, or folder, is specified
  33    by:
  34      ./abc.tex   on Unix and most DOS/OS2 TeX's,
  35      []abc.tex   on VMS
  36       :abc.tex   on a Macintosh.
  37    The above possibilities will be found automatically during the
  38    installation.  However, if none of these syntaxes works on your
  39    system then the internal macro \@currdir will be set to be empty
  40    and ltxcheck will report this.
  41
  42    If your system does have a notion of a current directory, you can
  43    define \@currdir in the file texsys.cfg.
  44
  45    You could also report this to the latex-bug address, so that
  46    later releases can automatically cope with your system.
  47
  48 2) The file name parser check.
  49    \filename@parse may be defined in texsys.cfg if the default
  50    installation does not define a suitable parser. (In fact no widely
  51    used TeX system should need such a re-definition as the standard
  52    installation should correctly define this command for unix, dos,
  53    atari, VMS, and Macintosh, at least.)
  54    Because of differences in directory syntax, most features of this
  55    command can not be checked in a portable way, however ltxcheck does
  56    check that at least {article.cls} is correctly parsed as base name
  57    article and extension cls.
  58
  59 3) The \input@path check.
  60
  61    On some systems TeX cannot check whether a file exists before
  62    trying to input it, unless the filename is expressed as a full path
  63    name, including the directory.  On these systems LaTeX needs to be
  64    given a list of directories in which to look for files; the
  65    internal macro \input@path holds this information.
  66
  67    When run, ltxcheck will try to locate the file article.cls.
  68    If it fails to find this file (and you have placed it in the
  69    `standard input directory') then you must define \input@path in
  70    the file texsys.cfg.
  71
  72    The files texsys.cfg and ltdirchk.dtx contain examples of how to do
  73    this but only you know the directories and syntax that should be used
  74    for your installation.
  75
  76    We hope to build up a better collection of examples in future
  77    releases of LaTeX, as it is tested on more TeX systems.
  78
  79 4) TeX version check.
  80
  81    The next check tests that you are running a recent version of TeX.
  82    If ltxcheck reports that you have TeX2, then you should try to
  83    upgrade TeX (and rebuild LaTeX) as soon as possible.  LaTeX may be
  84    used with TeX2, but certain features will be missing and you will
  85    not be able to use the new (8-bit) font families that are now
  86    available. If you must stick with TeX2, please read the extra
  87    information in the file tex2.txt.
  88
  89    If ltxcheck reports that your TeX version is older than 3.141, you
  90    will see some strange messages during the installation.  This is
  91    because earlier versions of TeX printed certain line-breaks in
  92    messages on the terminal as `^^J' rather than starting a new line.
  93
  94    LaTeX will work round this bug and thus avoid `^^J' appearing in
  95    error messages, but you should upgrade your TeX as soon as
  96    possible, as other bugs have been fixed, not just line breaks in
  97    messages.
  98
  99    At the present time (2005) the current TeX version is 3.141592.
 100
 101 5) Fonts check.
 102
 103    Finally ltxcheck.tex tests to see if it can find a `representative
 104    sample' of the fonts used by LaTeX.
 105
 106    Fonts that may cause problems are:
 107    a) The circle fonts. These were renamed some years ago from circle*
 108       to lcircle*, although some sites still have them under the old
 109       name. Also the names are longer than 8 letters which may cause
 110       some problems.
 111    b) The `extra Computer Modern' fonts.  The American Mathematical
 112       Society has extended the range of sizes available in the
 113       Computer Modern fonts.  LaTeX now assumes that these extra cm
 114       fonts are available.
 115       The fonts are available from a CTAN archive, in the directory
 116       ctan:macros/latex/fonts  or alternatively as part of the
 117       AMS fonts collection, which also includes many useful
 118       mathematical fonts.
 119    c) The `T1 encoded Computer Modern' fonts.  This is the ec or dc font
 120       collection. The new (1995) release 1.2 of the dc fonts changed
 121       most of the file names.  For this reason the fd files such as
 122       t1cmr.fd cannot be written to work with the dc fonts of different
 123       releases.  LaTeX by default unpacks the fd files for the ec
 124       dc fonts.
 125       If you have an older release of the dc fonts and do not wish to
 126       upgrade then you should unpack the necessary fd files by running
 127       LaTeX on the file  olddc.ins (dc older than version 1.2) or
 128       newdc.ins (version 1.2 and 1.3).
 129       As the T1 fd files will have been used when making the format,
 130       you must re-run  initex latex.ltx  to remake the format if you
 131       update the fd files in this way.
 132       Running ltxcheck will produce a ! BAD LaTeX2e system!! error
 133       message if it detects that the `new' fd files are loaded into
 134       the format, but only the old dc fonts are available, and vice
 135       versa.
 136       If the old fonts are detected, and the `old' fd files are loaded
 137       then no error is generated, but a message suggesting that you
 138       upgrade is produced.
 139       The ec fonts are available from a CTAN archive, in the directory
 140       ctan:fonts/ec .
 141
 142
 143 6) Files check.
 144
 145       Finally ltxcheck checks that the main TeX input files that LaTeX
 146       will use when running documents (such as the article class file,
 147       fd files, and main packages such as fontenc) are all available.
 148
 149
 150 DOCUMENTATION OF THE CODE
 151 =========================
 152
 153 Most of the documentation is nowadays available as precomplied PDF
 154 files. This section describes how to produce typeset code
 155 documentation yourself from the source.
 156
 157 To typeset a documented code file (a .dtx file) you simply run LaTeX
 158 on it. The file source2e.tex is a master file which produces the
 159 documented code for the whole LaTeX kernel (but not the standard
 160 packages, classes, or compatibility mode).  You need to have LaTeX2e
 161 installed before doing this.
 162
 163 To configure the appearance of this documentation, you can use a
 164 ltxdoc.cfg file.  For example, putting the following line into this
 165 file will format the documentation for A4 paper:
 166
 167    \PassOptionsToClass{a4paper}{article}
 168
 169 The doc package, which is used by the documentation files, writes
 170 index files and change-history files that can be processed by the
 171 program MakeIndex.  If this program is part of your TeX installation,
 172 you can get an index and history listing for a documentation file
 173 by running the .idx and .glo files through this program.
 174
 175 For example, in Unix MakeIndex, you should say:
 176
 177    makeindex -s gind.ist FILENAME
 178    makeindex -s gglo.ist -o FILENAME.gls FILENAME.glo
 179
 180 source2e.tex needs a special source2e.ist file (in place of gind.ist).
 181 Running makeindex will produce some warning messages about ignored
 182 style specifiers; these can be safely ignored.
 183
 184 See the comments at the end of source2e.tex for more information.
 185
 186
 187 CONFIGURING LaTeX
 188 =================
 189
 190 In addition to the system-dependent customisation in texsys.cfg,
 191 various other parts of LaTeX can be configured to suit local needs.
 192 Further details can be found in the document cfgguide.tex.  We
 193 recommend that you install the standard system before attempting any
 194 further customisation.
 195
 196 If you are thinking of making other changes to LaTeX, please read the
 197 document modguide.tex as it describes the precautions you need to take
 198 when making modifications in order to ensure that standard LaTeX
 199 remains a stable, maintainable system.
 200
 201
 202 FURTHER INFORMATION
 203 ===================
 204
 205 You will find further information about various aspects of LaTeX in
 206 the distributed files with names <*>guide.tex.  You will need
 207 to install the new version before you can typeset these files.
 208
 209
 210 --- Copyright 1995-2015 the LaTeX3 project.  All rights reserved ---