-                      LaTeX Installation Guide    &                           11 June 1995    SUMMARY  =======    ? This file contains the installation instructions for the latest 1 version of the LaTeX document preparation system.    $ The rest of this document describes:   B  * How to find out about installing LaTeX for your version of TeX.     * How the installation works.   %  * What to do if anything goes wrong.    C TeX experts who want to know more about how the LaTeX installation  @ works and how it can be customized may like to read texpert.txt.      
 DOCUMENTATION 
 =============   F Brief introductions to various aspects of the new LaTeX release can beC found in the distributed files with names <xxx>guide.tex.  You will C need to install the new version before you can typeset these files.   A A full description of the new LaTeX release (and of more than 100 6 packages that can be used with LaTeX) can be found in:   H  * The LaTeX Companion, Goossens, Mittelbach and Samarin, Addison-Wesley    ISBN 0-201-54199-8.   ; The new release is also described in the second edition of:    F  * LaTeX A Document Preparation System, Leslie Lamport, Addison-Wesley       REQUIREMENTS ============  C In addition to the LaTeX distribution files, you will also need the 
 following:  E  * a TeX system, including iniTeX (see `Your Version of TeX', below);   H  * the file `hyphen.tex', or some other hyphenation files (see `Creating    the LaTeX Format', below);   F  * the font files (normally .tfm files) for the Computer Modern fonts,@    including some non-standard ones (see `Fonts needed', below).     YOUR VERSION OF TEX  ===================    D LaTeX is based upon Donald Knuth's TeX typesetting system.  This is @ available for almost every make of computer, from microcomputers, through workstations to large main-frames.    F Further details about how to install LaTeX for your version of TeX mayE be available in a file called <system>.txt.  At present the following  such files exist (at least):   .  * decustex.txt for TeX from DECUS on VAX/VMS.  /  * directex.txt for DirectTeX on the Macintosh.    -  * emtex.txt for emTeX on IBM PC compatibles.    ;  * microtex.txt for MicroTeX (uTeX) on IBM PC compatibles.    (  * oztex.txt for OzTeX on the Macintosh.  &  * pastex.txt for PasTeX on the Amiga.  -  * pctex.txt for PCTeX on IBM PC compatibles.    .  * textures.txt for Textures on the Macintosh.  0  * web2ctex.txt for web2c TeX on Unix platforms.   2  * yandytex.txt for Y&YTeX on IBM PC compatibles.    C You should finish reading this file before reading the <system>.txt H file for your version.  If there is no such file then this file alone is your installation guide.  D If you have bought a commercial version of TeX/LaTeX and there is noD file for your system then you could ask the company which sells your version of TeX to supply one.   # Note to TeX implementors/suppliers: " ----------------------------------E If you can supply us with a <system>.txt file for your implementation B we shall be very grateful and we shall add it to our distribution.         HOW THE INSTALLATION WORKS ==========================   ) The LaTeX installation is in five stages:    #  * Saving any old version of LaTeX.    :  * Unpacking the distribution (this may not be necessary).     * Creating the LaTeX format.    /  * Putting the files where LaTeX can read them.     * Checking the installation.       SAVING YOUR OLD VERSION OF LaTeX  ================================  D If you are currently using the old LaTeX version, 2.09, you may wish6 to save it before installing the new version of LaTeX.  E If it exists, the <system>.txt file will describe in detail how to do ? this; in some of these files, the new version is referred to as @ LaTeX2e in order to clearly distinguish it from the old version.  D The details of how to do everything in this section will depend to a- very large extent on your TeX implementation.    : First you should find the LaTeX format file on your system= (usually called `latex.fmt' or `lplain.fmt') and rename it to  `latex209.fmt'.    F You should then save a copy of the current  LaTeX system files.  TheseA may be kept in a TeX inputs directory or folder, which is usually # called something like one of these:   '    tex\texinput  tex/inputs  TeX-inputs   C or they may be kept in a separate LaTeX inputs location, possibly a E subdirectory or subfolder of the TeX inputs location, called `latex'.      @ There are thus two possibilities, depending on whether the LaTeX@ inputs have been kept separate from the other TeX inputs or not.  D  * If the LaTeX inputs are separated from the other TeX inputs, thenE    you should make a new directory that is a copy of the whole of the 2    LaTeX inputs directory, and call it `latex209'.     D  * If the LaTeX inputs are kept with the other TeX inputs, then you F    should create a new directory called `latex209' and then copy to it=    any file ending with .sty from the LaTeX inputs directory.      > It may be possible to run both the new LaTeX and LaTeX 2.09 in> parallel.  To do this, you should create a `latex209' command,6 or menu entry, that is similar to `latex' except that:   5  * The `latex209' format is used rather than `latex'.    ?  * The `latex209' directory is searched before the LaTeX inputs 
    directory.   B The details of how to do this vary according to your system so you1 may find more information in a <system>.txt file.      ! BEFORE UNPACKING THE DISTRIBUTION ! =================================   ? Latex needs a number of files to run, for example `article.cls' D contains the `article' document class.  However, these files are NOTD themselves the source files produced by the LaTeX3 Project Team.  WeA write documented sources in `docstrip archive files' which can be < unpacked to produce the files that LaTeX needs. For example,= classes.dtx contains the documented sources for all the LaTeX ( document classes, including article.cls.  B The FIRST thing to do is to check whether you need to unpack these archive files, as follows.  E Before reading any further, you should check to see whether the LaTeX F distribution you have contains the unpacked files.  You can do this byC looking to see if you have got the file latex.ltx.  If you do, then D you should have all the unpacked files and so you can move on to the- section entitled `Creating the LaTeX format'.    ? The unpacking will create and write files only into the current C directory (or current folder, or default directory).  This helps to C prevent it overwriting existing files or causing problems with your E system files.  It is therefore sensible to carry out the installation D in a directory reserved for this purpose; on a multi-user system youC should ensure that you have read and write permissions for files in  this directory.      UNPACKING THE DISTRIBUTION ==========================  = The archive files are unpacked by running iniTeX on the file   unpack.ins.   B NOTE: On relatively slow computers, this unpacking can take a long@ time.  On a Macintosh SE it takes about 3 hours.  On a MacintoshG Duo 230 or a 12MHz 80286 PC it takes about 30 minutes.  On a moderately A busy SparcStation 10 or a fast 80486 PC it takes about 5 minutes.        CREATING THE LATEX FORMAT  =========================    = To create the LaTeX format, you should run iniTeX on the file  `latex.ltx'.    A A hyphenation file such as `hyphen.tex' is read by this run so it E should be accessible by iniTeX.  It also needs to be able to read the < `.tfm' font files for the basic fonts.  These font files and6 hyphenation file(s) should be part of your TeX system.  @ You should save the resulting format file `latex.fmt' in the TeX@ formats directory.  You may also have to create and/or install aD program called `latex', a `LaTeX' option to your TeX implementation,@ or a batch file or shell script.  The details of this stage willC depend on your TeX implementation; note that the name of the format 3 file differs from that normally used in LaTeX 2.09.    E Note: TeX experts may wish to customize LaTeX (for example, to allow  E non-American hyphenation).  They should read texpert.txt to find out   how to do this.      + PUTTING THE FILES WHERE LaTeX CAN READ THEM + ===========================================   F The next step in the installation of LaTeX is to move the files needed< to run the system into the correct directories (or folders).
 These are:  -  * the directory containing the format files.    A  * the LaTeX inputs directory, which contains LaTeX system files.    B  * the MakeIndex inputs directory, which contains MakeIndex files.   ) You should move to the formats directory:    
  * latex.fmt.   7 You should move to the LaTeX input directory the files:    A  * latexbug.tex, testpage.tex, lablst.tex, idx.tex, nfssfont.tex  .    small2e.tex, sample2e.tex and docstrip.tex.   # and any files whose name ends with:      * .cls,  document class files.    '  * .clo,  document class options files.      * .sty,  package files.      * .fd,   font definition files.   ?  * .def,  files of definitions which may be read by LaTeX while            processing documents.    )  * .cfg,  TeX expert configuration files.    : You should move to the MakeIndex input directory all files whose name ends with:       * .ist,  MakeIndex style files.    You have now installed LaTeX!      GETTING A WORKING LaTeX  =======================   @ You may now need to set up your system to use the new version ofF LaTeX; e.g. by configuring the environment, adding menu items, writingE batch files or shell scripts.  Details may be found in a <system>.txt  file for your system.     % CHECKING THAT THE INSTALLATION WORKED % =====================================    F To make sure that the installation has worked, you should run the new ' LaTeX on the document `ltxcheck.tex'.     B How this is done varies according to your system; you may find the7 necessary detailed instructions in a <system>.txt file.   E This will produce a number of messages, each of which should be `OK'. A If any of them are `BAD', then read the `PROBLEMS' section below.    3 If all the messages are `OK' then you are finished!    Fonts needed ------------  E One thing that is checked by running ltxcheck.tex is the existence of  certain fonts on your system.     C The new LaTeX format assumes that you have on your system more font C files from the Computer Modern families than did previous versions.   E It is not essential to get all these fonts immediately but, if you do @ not have the .tfm files for some of them fonts then you will get9 several error messages when you try to typeset any of the , documentation files, such as `usrguide.tex'. Here are some examples:   5   ! Font OML/cmm/b/it/8=cmmib8 at 8.0pt not loadable: C                                         Metric (TFM) file not found   5   ! Font OMS/cmsy/b/n/8=cmbsy8 at 8.0pt not loadable: C                                         Metric (TFM) file not found   C You can, in fact, ignore all these messages (however awful they may @ sound) as far as typesetting the file is concerned: the results,B whilst not perfect, will be little different to what was intended.  E However, you should install these fonts as soon as possible (they are C in the sub-directory `fonts/tfm' of the LaTeX directory on CTAN).   	 They are:   ,    cmmib5   cmmib6   cmmib7   cmmib8  cmmib9,    cmbsy5   cmbsy6   cmbsy7   cmbsy8  cmbsy9        PROBLEMS ========   G On most systems the installation should proceed smoothly.  However, you  may get some errors.    E `texsys.cfg':  While running iniTeX on latex.ltx you may get an error 4    message that reports a problem with texsys.cfg.     D    If this happens then you have obtained (or produced) a texsys.cfg/    file that is not suitable for your system.        E    First, if it exists read the <system>.txt file.  This may tell you (    how to customize the file texsys.cfg.     H    If the <system>.txt file does not mention texsys.cfg then you should H    not need a texsys.cfg file.  Try deleting texsys.cfg and building the    LaTeX format again.     H    If you still get errors, try using LaTeX to typeset ltdirchk.dtx and     then read this document.    C  The details of how to do this vary according to your system so you - may find more details in a <system>.txt file.     A `File missing': Some of the files from the LaTeX distribution are =    missing.  There are a number of possible reasons for this:    "    * The files really are missing.E      You should get the missing files from the same place you got the E      rest of the distribution.  If you cannot do this then you should 4      complain to whoever gave you this distribution.   7    * The files are present, but in the wrong directory. C      You should move the files to a directory that iniTeX can read.    7    * The files are present, and in the right directory. F      Your iniTeX may have been set up incorrectly.  You may be able toA      correct this, depending on your TeX implementation.  See the ?      documentation of your TeX implementation for more details.       D `Font missing': Some of the fonts (.tfm files) required by LaTeX areE    missing.  As above, either you have not got the required files, or G    iniTeX is not able to find them.  So you may need to move them or to ;    configure iniTeX to look in the correct places.  See the =    documentation of your TeX implementation for more details.      B `Out of memory': On TeX implementations with small memory, you may3    exhaust iniTeX's memory whilst installing LaTeX.    #    You may be able to correct this:    B    * Some TeX implementations allow the amount of memory allocated?      to TeX to be increased.  See the documentation of your TeX %      implementation for more details.    B    * Some iniTeX implementations allow more memory than others; soD      you may be able to run iniTeX on a larger machine and then move-      the files across to the smaller machine.    B    * If the error happens during the unpacking of the distributionC      (i.e. when you run iniTeX on unpack.ins) then try running this B      file with normal TeX, for example plain TeX or an old version      of LaTeX.      6 If you have any problems installing LaTeX, you should:   -  * read the <system>.txt file, if one exists;    2  * if this does not help, ask your local TeX guru;   6  * if this fails, try asking a local TeX mailing list;   B  * if this fails, run iniTeX on the file latexbug.tex, fill in theC    resulting bug report form, and send to the address given in that     file.     CLEARING UP  ===========   @ You may now be wondering what to do with all the remaining filesB that are not needed to run LaTeX.  This is, of course, a matter of> personal taste and availability of disk space but here is some	 guidance.    =  * The files with extension .dtx, together with source2e.tex, E    can be used to typeset the documented source code (see texpert.txt     for further information).  C  * The files with extension .fdd contain the documented sources for     the font definition files.   F  * The files ltnews<xx>.tex and ltnews<xx>.ps both contain the latest     LaTeX newsletter.  F  * The file ltx3info.tex contains information about the LaTeX3 project    and how you can support it.   C  * The files with extension .txt contain information about (amongst F    other things) copyright, installation, patches and bug-reports; and=    those with extension .err contain errata lists for various 7    publications: see 00readme.txt for further details.    E  * The files with names of the form <xxx>guide.tex contain reference  B    information covering only those features new to this version of>    LaTeX: they are not intended to be either a user guide or a(    complete reference for the system.     A  * The files with extension .ltx, together with ltxcheck.tex, are F    used to create and test the format; therefore you should keep theseB    if you expect to remake the format before getting the next full    distribution.  E  * The files with extension .ins are used to unpack the code from the     .dtx and .fdd files.   <  * We recommend that you keep, in the formats directory, theA    transcript file that was produced whilst creating the format;  .    this file is called latex.log or latex.lis.         FINALLYi =======o  D Once you have installed LaTeX for your TeX implementation, you mightD like to write a <system>.txt file explaining how you did it.  If you7 want to do this, you should edit the file template.txt.   F If you would like your <system>.txt file to be included with the LaTeX2 distribution, please mail it to the above address.    ? --- Copyright 1994 the LaTeX3 project.  All rights reserved --- 