home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fonts 1 / freshfonts1.bin / programs / amiga / pastex / macros / latex2e / base / install.txt < prev    next >
Text File  |  1994-06-12  |  13KB  |  368 lines
  1.                            LaTeX Installation Guide
  2.  
  3.                                 12 June 1994
  4.  
  5. SUMMARY
  6. =======
  7.  
  8. This file contains the installation instructions for the latest
  9. version of the LaTeX document preparation system.
  10.  
  11. The rest of this document describes:
  12.  
  13.  * How to find out about installing LaTeX for your version of TeX.
  14.  
  15.  * How the installation works.
  16.  
  17.  * What to do if anything goes wrong.
  18.  
  19. TeX experts who want to know more about how the LaTeX installation 
  20. works and how it can be customized may like to read texpert.txt.
  21.  
  22.  
  23. DOCUMENTATION
  24. =============
  25.  
  26. Brief introductions to various aspects of the new LaTeX release can be
  27. found in the distributed files with names <*>guide.tex.  You will need
  28. to install the new version before you can typeset these files.
  29.  
  30. A full description of the new LaTeX release (and of more than 100
  31. packages that can be used with LaTeX) can be found in:
  32.  
  33.  * The LaTeX Companion, Goossens, Mittelbach and Samarin, Addison-Wesley
  34.    ISBN 0-201-54199-8.
  35.  
  36. The new release is also described in the second edition of:
  37.  
  38.  * LaTeX A Document Preparation System, Leslie Lamport, Addison-Wesley
  39.  
  40.  
  41. YOUR VERSION OF TEX
  42. ===================
  43.  
  44. LaTeX is based upon Donald Knuth's TeX typesetting system.  This is 
  45. available for almost every make of computer, from microcomputers
  46. through workstations to large mainframes.  
  47.  
  48. Further details about how to install LaTeX for your version of TeX may
  49. be available in a file called <system>.txt.  At present the following
  50. such files exist (at least):
  51.  
  52.  * directex.txt for DirectTeX on the MAC.
  53.  
  54.  * emtex.txt for emTeX on the PC.
  55.  
  56.  * oztex.txt for OzTeX on the Macintosh.
  57.  
  58.  * web2ctex.txt for web2c TeX on Unix platforms.
  59.  
  60.  * yandytex.txt for Y&YTeX on IBM PC compatibles. 
  61.  
  62. You should finish reading this file before reading the <system>.txt
  63. file for your system.  If there is no such file then this file alone is
  64. your installation guide.
  65.  
  66. If you have bought a commercial version of TeX/LaTeX and there is no
  67. file for your system then you could ask the company which sells your
  68. version of TeX to supply one.
  69.  
  70. Note to TeX implementors/suppliers:
  71. ----------------------------------
  72. If you can supply us with a <system>.txt file for your implementation
  73. we shall be very grateful and we shall add it to our distribution.
  74.  
  75.  
  76.  
  77. HOW THE INSTALLATION WORKS
  78. ==========================
  79.  
  80. The LaTeX installation is in four stages:
  81.  
  82.  * Saving any old version of LaTeX.
  83.  
  84.  * Unpacking the distribution (this may not be necessary).
  85.  
  86.  * Creating the LaTeX format.
  87.  
  88.  * Putting the files where LaTeX can read them.
  89.  
  90.  * Checking the installation.
  91.  
  92.  
  93. SAVING ANY OLD VERSION OF LaTeX
  94. ===============================
  95.  
  96. If you are currently using the old LaTeX version, 2.09, you may wish
  97. to save it before installing the new version of LaTeX.
  98.  
  99. If it exists, the <system>.txt file will describe in detail how to do
  100. this; in some of these files, the new version is referred to as
  101. LaTeX2e in order to clearly distinguish it from the old version.
  102.  
  103. The details of how to do everything in this section will depend to a
  104. very large extent on your TeX implementation.
  105.  
  106. First you should find the LaTeX format file on your system
  107. (usually called `latex.fmt' or `lplain.fmt') and rename it to
  108. `latex209.fmt'.
  109.  
  110. You should then save a copy of the LaTeX system files.  These may be
  111. kept in a TeX inputs directory or folder, which is usually called
  112. something like one of these:
  113.  
  114.    tex\texinput  tex/inputs  TeX-inputs
  115.  
  116. or they may be kept in a separate LaTeX inputs location, possibly a
  117. subdirectory or subfolder of the TeX inputs location, called `latex'.
  118.    
  119. There are thus two possibilities, depending on whether the LaTeX
  120. inputs have been kept separate from the other TeX inputs or not.
  121.  
  122.  * If the LaTeX inputs are separated from the other TeX inputs, then
  123.    you should make a new directory that is a copy of the whole of the
  124.    LaTeX inputs directory, and call it `latex209'.
  125.    
  126.  * If the LaTeX inputs are kept with the other TeX inputs, then you 
  127.    should create a new directory called `latex209' and then copy to it
  128.    any file ending with .sty from the LaTeX inputs directory.
  129.    
  130. It may be possible to run both the new LaTeX and LaTeX 2.09 in
  131. parallel.  To do this, you should create a `latex209' command,
  132. or menu entry, that is similar to `latex' except that:
  133.  
  134.  * The `latex209' format is used rather than `latex'.
  135.  
  136.  * The `latex209' directory is searched before the LaTeX inputs
  137.    directory.
  138.  
  139.  
  140. UNPACKING THE DISTRIBUTION
  141. ==========================
  142.  
  143. Latex needs a number of files to run, for example `article.cls'
  144. contains the `article' document class.  However, these files are NOT
  145. themselves the source files produced by the LaTeX3 Project Team.  We
  146. write documented sources in `docstrip archive files' which can be
  147. unpacked to produce the files that LaTeX needs. For example,
  148. classes.dtx contains the documented sources for all the LaTeX
  149. document classes, including article.cls.
  150.  
  151. The FIRST thing to do is to check whether you need to unpack these
  152. archive files, as follows.
  153.  
  154. Before reading any further, you should check to see whether the LaTeX
  155. distribution you have contains the unpacked files.  You can do this by
  156. looking to see if you have got the file latex.ltx.  If you do, then
  157. you should have all the unpacked files and so you can move on to the
  158. section entitled `Creating the LaTeX format'.
  159.  
  160. The unpacking will create and write files only into the current
  161. directory (or current folder, or default directory).  This helps to
  162. prevent it overwriting existing files or causing problems with your
  163. system files.  It is therefore sensible to carry out the installation
  164. in a directory reserved for this purpose; on a multi-user system you
  165. should ensure that you have read and write permissions for files in
  166. this directory.
  167.  
  168. The archive files are unpacked by running iniTeX on the file 
  169. unpack.ins.
  170.  
  171. NOTE: On relatively slow computers, this unpacking can take a long
  172. time.  On a Macintosh IIfx it takes about 3 hours.  On a Macintosh
  173. Duo 230 or a 12MHz 80286 PC it takes about 30 minutes.  On a moderately
  174. busy SparcStation 10 or a fast 80486 PC it takes about 5 minutes.
  175.  
  176.  
  177. CREATING THE LATEX FORMAT
  178. =========================
  179.  
  180. To create the LaTeX format, you should run iniTeX on the file
  181. `latex.ltx'.  The file `hyphen.tex' is normally read by this run so it
  182. should be accessible by iniTeX.  It also needs to be able to read the
  183. `.tfm' font files for the basic fonts.
  184.  
  185. You should save the resulting format file as `latex.fmt' in the
  186. TeX formats directory.  You may also have to install a program called
  187. `latex', or a `LaTeX' option to your TeX implementation.  The details
  188. of this stage will depend on your TeX implementation.
  189.  
  190. Note: TeX experts may wish to customize LaTeX (for example, to allow 
  191. non-American hyphenation).  They should read texpert.txt to find out 
  192. how to do this.
  193.  
  194.  
  195. PUTTING THE FILES WHERE LaTeX CAN READ THEM
  196. ===========================================
  197.  
  198. The next step in the installation of LaTeX is to move the files needed
  199. to run the system into the correct directories (or folders).
  200. These are:
  201.  
  202.  * the directory containing the format files.
  203.  
  204.  * the LaTeX inputs directory, which contains LaTeX system files.
  205.  
  206.  * the MakeIndex inputs directory, which contains MakeIndex files.
  207.  
  208. You should move to the formats directory:
  209.  
  210.  * latex.fmt.
  211.  
  212. You should move to the LaTeX input directory the files:
  213.  
  214.  * latexbug.tex, testpage.tex and docstrip.tex.
  215.  
  216. and any files whose name ends with:
  217.  
  218.  * .cls,  document class files.
  219.  
  220.  * .clo,  document class options files.
  221.  
  222.  * .sty,  package files.
  223.  
  224.  * .fd,   font definition files.
  225.  
  226.  * .def,  files of definitions which may be read by LaTeX while
  227.           processing documents.
  228.  
  229.  * .cfg,  TeX expert configuration files.
  230.  
  231. You should move to the MakeIndex input directory all files
  232. whose name ends with:
  233.  
  234.  * .ist,  MakeIndex style files.
  235.  
  236. You have now installed LaTeX!
  237.  
  238.  
  239. CHECKING THAT THE INSTALLATION WORKED
  240. =====================================
  241.  
  242. To make sure that the installation has worked, you should run the new 
  243. LaTeX on the document `ltxcheck.tex'.  
  244.  
  245. This will produce a number of messages, each of which should be `OK'.
  246. If