home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / mac / tex / inputs.sit / TeX-inputs / local.tex < prev    next >
Encoding:
Text File  |  1989-09-19  |  34.2 KB  |  867 lines  |  [TEXT/????]

  1. % local.tex -- released 27 October 1988
  2. % Copyright(c) 1988 by Leslie Lamport
  3. %   for LaTeX version 2.09
  4. %
  5. % This file is used to produce a Local Guide for LaTeX users containing
  6. % information specific to a site plus errors and omissions from the LaTeX
  7. % manual (published by Addison-Wesley).
  8. %
  9. % The installer of LaTeX at a site is responsible for customizing this
  10. % document and providing copies for users.  He will have to read the
  11. % text of this file CAREFULLY to see what must be added, removed, and
  12. % changed.  
  13.  
  14. % The \contact command is defined to generate the name of the person to
  15. % whom questions should be sent.  This should be someone at the site.
  16. % Most users' questions are easily answered by anyone slightly familiar
  17. % with LaTeX or TeX. Don't bother anyone at another site with questions
  18. % that can be answered locally.
  19.  
  20. \documentstyle[titlepage]{article}
  21.  
  22. \newcommand{\contact}{Leslie Lamport}
  23.  
  24. \newcommand{\BibTeX}{{\rm B\kern-.05em{\sc i\kern-.025em b}\kern-.08em
  25.     T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX}}
  26.  
  27. \newcommand{\SLiTeX}{{\rm S\kern-.06em{\sc l\kern-.035emi}\kern-.06em T\kern
  28.    -.1667em\lower.7ex\hbox{E}\kern-.125emX}}
  29.  
  30.  
  31. \newcommand\bs{\char '134 }   % A backslash character for \tt font
  32. \newcommand{\lb}{\char '173 } % A left brace character for \tt font
  33. \newcommand{\rb}{\char '175 } % A right brace character for \tt font
  34.  
  35. \title{Using \LaTeX\ at SRC}
  36.  
  37. \author{Leslie Lamport}
  38.  
  39. \date{27 October 1988\\              % Keep this date current
  40. For \LaTeX\ Version 2.09} 
  41.  
  42. \begin{document}
  43.  
  44. \maketitle
  45.  
  46. \tableofcontents
  47.  
  48. \newpage
  49.  
  50. \LaTeX\ runs on a variety of computers at many different sites.  This
  51. document tells you how to use \LaTeX\ on the Magic, Lewis, and Clark
  52. computers at SRC. It is not about \LaTeX\ itself, which is described by
  53. the manual---{\em \LaTeX: A Document Preparation System}, published by
  54. Addison-Wesley, available at fine book stores everywhere.
  55.  
  56. If you have a question that you can't answer by reading the manual and
  57. this document, ask \contact.  He should also be informed of any
  58. possible \LaTeX\ bugs or undocumented anomalies.
  59.  
  60.  
  61. \section{Getting Started}
  62.  
  63. \subsection{Running a Sample File} \label{sec:sample}
  64.  
  65. Before preparing your own documents, you may want to get acquainted
  66. with \LaTeX\ by running it on a sample input file.  First make your own
  67. copy of the file \mbox{\tt sample.tex} by typing the following
  68. Ultrix command:
  69. \begin{verbatim}
  70.      cp /usr/local/lib/tex82/sample.tex .
  71. \end{verbatim}
  72. (You must type the space followed by the period at the end.  This
  73. and all other Ultrix commands are ended by typing {\em return}.)
  74. A copy of the file \mbox{\tt sample.tex} is now in your current
  75. directory; you can edit it just like any other file.  If you destroy or
  76. mess up your copy, typing the above command again gets you a fresh
  77. one.
  78.  
  79. Next, run \LaTeX\ on the file \mbox{\tt sample.tex} by typing:
  80. \begin{verbatim}
  81.      latex sample
  82. \end{verbatim}
  83. When \LaTeX\ has finished, it will have produced the file \mbox{\tt
  84. sample.dvi} in your directory.  You can print this file by typing the
  85. command
  86. \begin{verbatim}
  87.      iptex sample.dvi
  88. \end{verbatim}
  89. The output will be produced on the Imagen printer, located next to the
  90. third floor receptionist's desk.  If you want to print \LaTeX\ output
  91. on an Apple LaserWriter, see Section~\ref{sec:apple}.
  92.  
  93. After your output has been printed, you can delete \mbox{\tt
  94. sample.dvi} by typing
  95. \begin{verbatim}
  96.      rm sample.dvi
  97. \end{verbatim}
  98.  
  99. \subsection{Preparing and Running \LaTeX\ on Your Own Files}
  100.  
  101. You must use a text editor to prepare an input file for \LaTeX. The
  102. document {\em Welcome to SRC\/} describes the text editors available
  103. at SRC.  The easiest way to start learning about \LaTeX\ is by 
  104. examining the file \mbox{\tt small.tex} with your text editor.
  105. You can obtain your own copy of this file, in your directory,
  106. by typing the command
  107. \begin{verbatim}
  108.      cp /usr/local/lib/tex82/small.tex .
  109. \end{verbatim}
  110.  
  111. After you have prepared your file, whose name should have the extension
  112. {\tt tex}, you must run it through \LaTeX\ and print the output.
  113. Follow the instructions in Section~\ref{sec:sample}, except substitute
  114. the first name of your file for ``\mbox{\tt sample}''.  Remember to
  115. save disk space by deleting the {\tt dvi} file after printing the
  116. output.
  117.  
  118.  
  119. %List the text editors, available, and any special features they have
  120. %for producing \LaTeX\ input.  Explain how the various text editors
  121. %could cause bad characters to appear in the input file that would
  122. %generate the
  123. %\begin{verbatim}
  124. %! Text line contains an invalid character.
  125. %\end{verbatim}
  126. %error.
  127.  
  128. If you want to stop \LaTeX\ in the middle of its execution, perhaps
  129. because it is printing a seemingly unending string of uninformative
  130. error messages, type {\em Control-C\/} (press $C$ while holding down
  131. the key labeled {\em CTRL\/}).  This will make \LaTeX\ stop as if it
  132. had encountered an ordinary error, and you can return to Ultrix command
  133. level by typing {\tt X}, as described in the manual.  If typing {\em
  134. Control-C\/} doesn't work, typing {\em Control-Z\/} will get you
  135. immediately to Ultrix command level, but this will leave a stopped job
  136. hanging around.  A stopped job won't hurt anything and will disappear
  137. when you log out, but it forces you to type two successive \mbox{\tt
  138. logout} commands to log out.
  139.  
  140. To use the {\em spell\/} program for finding spelling errors in a
  141. \LaTeX\ input file named \mbox{\tt myfile.tex}, type the following
  142. command:
  143. \begin{verbatim}
  144.      delatex myfile.tex | spell
  145. \end{verbatim}
  146. This will type a list of possibly misspelled words on your terminal.
  147. If you'd rather have the output written to a file named \mbox{\tt
  148. foo.bar}, type
  149. \begin{verbatim}
  150.      delatex myfile.tex | spell >foo.bar
  151. \end{verbatim}
  152.  
  153.  
  154. \section{Carrying On}
  155.  
  156. \subsection{\LaTeX\ on Ultrix} \label{sec:op-system}
  157.  
  158. The only special problems in using \LaTeX\ caused by the Ultrix
  159. operating system involve the way Ultrix handles files.  The first
  160. problem arises because, when a program starts to write a file, Ultrix
  161. destroys the previous version of that file.  Thus, if an error forces
  162. you to stop \LaTeX\ prematurely (by typing {\em Control-C\/} or {\em
  163. Control-Z\/}), then the files that \LaTeX\ was writing are incomplete,
  164. and the previous complete versions have been destroyed.  You probably
  165. don't care about the output on the {\tt dvi} file, but, if you are
  166. making a table of contents or using cross-referencing commands, then
  167. \LaTeX\ also writes one or more {\em auxiliary files\/} that it reads
  168. the next time it processes the same input file.  If the auxiliary files
  169. are incomplete because \LaTeX\ was stopped before reaching the end of
  170. its input file, then the table of contents and cross-references will be
  171. incorrect the next time \LaTeX\ is run on the same input file.  You
  172. will have to run \LaTeX\ a second time to get them right.  If you want
  173. to avoid having to run \LaTeX\ twice after making an error---for
  174. example, if your input is very long---then you should save copies of
  175. these auxiliary files before running \LaTeX. An input file named
  176. \mbox{\tt myfile.tex} and all the auxiliary files produced by \LaTeX\
  177. from it are included in the Ultrix file specifier \mbox{\tt myfile.*}.
  178. Use the Ultrix {\tt cp} command to save copies of these files.
  179.  
  180. The second problem in using \LaTeX\ on Ultrix involves the files that
  181. \LaTeX\ reads.  The file whose name you type with Ultrix's {\tt latex}
  182. command is called the {\em root file}.  In addition to reading the root
  183. file, \LaTeX\ also reads the files specified by \hbox{\verb|\input|}
  184. and \hbox{\verb|\include|} commands.  With the Ultrix directory system,
  185. \LaTeX\ must know not only the names of these file but also on what
  186. directories they are.  It will have no problem finding the correct
  187. files if you follow two simple rules:
  188. \begin{enumerate}
  189.  \item Run \LaTeX\ from the directory containing the root file.
  190.  \item Keep all files specified by \hbox{\verb|\input|} and 
  191.       \hbox{\verb|\include|} commands in the same directory as the root
  192.        file.
  193. \end{enumerate}
  194. If you follow these rules, you never have to type an Ultrix path
  195. specifier when using \LaTeX.
  196.  
  197. You should never break the first rule, otherwise \LaTeX\ will have
  198. trouble finding auxiliary files.  (To run \LaTeX\ on someone else's
  199. file, copy the file to your directory.) If you break the second
  200. rule, specifying a file from another directory in an
  201. \hbox{\verb|\input|} or \hbox{\verb|\include|} command, you must use a
  202. complete path name.  For example, to include the file \mbox{\tt hisfile.tex} 
  203. from Jones' directory \hbox{\verb|/foo/bar|}, you can type
  204. \begin{verbatim}
  205.      \include{/udir/jones/foo/bar/hisfile}
  206. \end{verbatim}
  207. A \verb|~| character may not appear in the argument of an
  208. \hbox{\verb|\input|} or \hbox{\verb|\include|} command, so you {\em
  209. can't\/} use a file name such as \hbox{\verb|~jones/foo/bar/hisfile|}.
  210.  
  211. For people who don't like to obey rules, 
  212. here is exactly how \LaTeX\ finds its
  213. files.  The root file is found by Ultrix according to its usual rules.
  214. \LaTeX's auxiliary files are read and written in the directory from
  215. which it is run.  All file names specified in the \LaTeX\ input,
  216. including the names of document-style ({\tt sty}) files specified by
  217. the \hbox{\verb|\documentstyle|} command, are interpreted relative to
  218. the directory from which \LaTeX\ is run.  If \LaTeX\ does not find a
  219. file starting in this directory, it looks in the system directory
  220. \hbox{\verb|/usr/local/lib/tex82|}.  You can change the directories in
  221. which \LaTeX\ looks for its input files by setting the environment
  222. variable \mbox{\tt TEXINPUTS}.  Putting the command
  223. \begin{verbatim}
  224.      setenv TEXINPUTS :.:/udir/jones/myown:/usr/local/lib/tex82:
  225. \end{verbatim}
  226. in your \mbox{\tt .login} file causes \LaTeX\ to look for files first
  227. in the current directory, then in Jones' {\tt /myown} directory, and
  228. then in the system directory.  You might want to do this if your name
  229. is Jones and you have your own personal document-style files in your
  230. {\tt /myown} directory. 
  231.  
  232. \subsection{Document Styles}
  233.  
  234.  
  235. There are nine document styles and style options available at SRC that
  236. are not described in the manual: 
  237. \begin{itemize}
  238. \item the \mbox{\tt proc} style option for making camera-ready copy for
  239. conference proceedings,
  240.  
  241. \item The {\tt bezier} option for drawing curves.
  242.  
  243. \item The {\tt ifthen} option for implementing {\bf if-then-else} and
  244. {\bf while-do} control structures.
  245.  
  246. \item The \mbox{\tt srcletter} style for making letters.
  247.  
  248. \item The {\tt showidx} option for printing index entries in the
  249. margin.  
  250.  
  251. \item The {\tt makeidx} option for use with the {\it MakeIndex\/}
  252. program. (Section~\ref{sec:makeindex} for information about this
  253. program).
  254.  
  255. \item The {\tt ps} style option that uses Times Roman fonts.  
  256.  
  257. \item The {\tt preview} option for use with the {\em Proof\/}
  258.  
  259. \item The {{\tt ps-slides}} style for use with \SLiTeX\ to produce
  260. color slides on the QMS color printer.
  261. \end{itemize} 
  262. The {\tt ps} option is described in Section~\ref{sec:apple}; the
  263. remaining stye options are described below.
  264.  
  265.  
  266. \subsubsection{The {\tt proc} Style Option}
  267.  
  268. The {\tt proc} option is used with the \mbox{\tt article} document
  269. style.  It produces two-column output for ACM and IEEE conference
  270. proceedings.  The command \hbox{\verb|\copyrightspace|} makes the blank
  271. space at the bottom of the first column of the first page, where the
  272. proceedings editor will insert a copyright notice.  This command works
  273. by producing a blank footnote, so it is placed in the text of the first
  274. column.  It must go after any \hbox{\verb|\footnote|} command that
  275. generates a footnote in that column.
  276.  
  277. \LaTeX\ automatically numbers the output pages.  It's a good idea 
  278. to identify the paper on each page of output.  Placing the command
  279. \begin{verbatim}
  280.      \markright{Jones---Foo}
  281. \end{verbatim}
  282. in the preamble (before the \hbox{\verb|\begin{document}|} command)
  283. prints ``Jones---Foo'' at the bottom of each page.  
  284.  
  285. \subsubsection{The {\tt bezier} Style Option}
  286.  
  287. This option defines a single command, \hbox{\verb|\bezier|}, that draws
  288. a curved line in a {\tt picture} environment.  Let $P_{i}$ be the point
  289. with coordinates $(x_{i},y_{i})$, for $i=1$, 2, and 3.  The command
  290. \begin{itemize} \tt
  291. \item[]
  292. \verb|\bezier{|$n$\verb|}(|$x_{1}$,$y_{1}$)($x_{2}$,$y_{2}$)($x_{3}$,$y_{3}$)
  293. \end{itemize}
  294. draws $n$ points on the quadratic Bezier spline determined by the three
  295. points $P_{1}$, $P_{2}$, and $P_{3}$.  The locus of points on this
  296. spline is a parabolic arc from $P_{1}$ to $P_{3}$ having the line
  297. $P_{1}P_{2}$ tangent to it at $P_{1}$ and the line $P_{2}P_{3}$ tangent
  298. to it at $P_{3}$.  Note that $P_{2}$ is {\em not\/} on this arc unless
  299. $P_{1}$, $P_{2}$, and $P_{3}$ are colinear, in which case the arc is a
  300. straight line.  Bezier splines are useful because it's easy to join two
  301. of them together smoothly by giving them the same tangent line where
  302. they meet.
  303.  
  304. It takes roughly 75 points per inch to form a solid line, depending
  305. upon the line thickness.  See Section~C.13.3 of the manual for commands
  306. to specify line thickness in a {\tt picture} environment.  This command
  307. is {\em very\/} slow, and \TeX\ has enough memory to hold only about
  308. 1000 points plus a page of text.  (Remember that \TeX\ keeps the
  309. current page plus all as yet unprinted figures in memory.) So, the
  310. \verb|bezier| command should be used for only a small number of small
  311. curves.
  312.  
  313.  
  314. \subsubsection{The {\tt ifthen} Style Option}
  315.  
  316. This option provides two programming language features that are useful
  317. only for people who already know how to program.  It defines the
  318. two commands
  319. \begin{itemize} 
  320. \item[]
  321. \verb|\ifthenelse{|{\em test\/}\verb|}{|{\em then clause\/}\verb|}{|%
  322. {\em else clause\/}\verb|}|\\
  323. \verb|\whiledo{|{\em test\/}\verb|}{|{\em do clause\/}\verb|}|
  324. \end{itemize}
  325. that implement the following two Pascal language structures
  326. \begin{itemize}
  327. \item[]
  328. \begin{tabbing}
  329. {\bf if} {\em test\/} \= {\bf then} \= {\em then clause\/} \\
  330.  \> {\bf else} \> {\em else clause\/} \\[2pt]
  331. {\bf while} {\em test\/} {\bf do} {\em do clause\/}
  332. \end{tabbing}
  333. \end{itemize}
  334. The {\em then\/}, {\em else\/}, and {\em do\/} clauses
  335. are ordinary \LaTeX\ input; {\em test\/} is one of the following:
  336. \begin{itemize}
  337.  \item A relation between two numbers formed with {\tt <}, {\tt >},
  338. or {\tt =}; for example, \hbox{\verb|\value{page}>3|}.
  339.  \item \verb|\equal{|{\em string1\/}\verb|}{|%
  340. {\em string2\/}\verb|}|, which evaluates to {\em true\/} if {\em
  341. string1\/} and {\em string2\/} are the same strings of characters after
  342. all commands have been replaced by their definitions.  (Upper- and
  343. lowercase letters are unequal.)
  344.  \item A logical combination of the above two kinds of tests
  345.     using the operators \hbox{\verb|\or|}, \hbox{\verb|\and|},
  346.     and \hbox{\verb|\not|} and the parentheses \hbox{\verb|\(|}
  347.     and \hbox{\verb|\)|}---for example:
  348. \begin{verbatim}
  349. \not \( \value{section} = 1  \and  \equal{Jones}{\myname} \)
  350. \end{verbatim}
  351. \end{itemize}
  352. The {\em test\/} argument is a violently moving argument, which means
  353. that not only fragile commands but even some commands that are not
  354. normally fragile will break, causing \TeX\ to enter an infinite loop.
  355. The \verb|\protect| command works in these situations.
  356.  
  357. These commands, together with \hbox{\verb|\renewcommand|} and the
  358. commands of Section~C.7.4 for manipulating counters, open up a whole
  359. new world of hacking.
  360.  
  361.  
  362. \subsubsection{Letters} \label{sec:letters}
  363.  
  364. The \mbox{\tt letter} document style, described in the manual, should
  365. be used for generating personal letters.  For generating letters to be
  366. copied onto SRC letterhead, use the \mbox{\tt srcletter} style.  This
  367. style works for the old letterhead (the one with the Digital logo
  368. printed in blue).  Mailing labels are formatted in two columns of five
  369. $2''\times\mbox{4-1/4}''$ labels each, suitable for copying onto Avery
  370. brand, number 5352 address labels.
  371.  
  372. There are no features for making letters other than those described in
  373. the manual.  However, suggestions will be accepted for such options as
  374. the ability to print ones net address as part of the letterhead.
  375.  
  376. \subsubsection{The {\tt showidx} Style Option}
  377.  
  378. This style option, for use with the {\tt report} or {\tt book} document
  379. styles, causes index entries to be printed in the outer margin.  It
  380. does not change the effect of \verb|\makeindex|, which controls
  381. whether or not an {\tt .idx} file is written.  No attempt is made to
  382. avoid overprinting marginal notes.  This option issues a 
  383. \verb|\flushbottom| declaration.
  384.  
  385.  
  386. \subsubsection{The {\tt preview} Style Option}
  387.  
  388. This option formats the output so it will appear as a continuous scroll
  389. when viewed with the {\em Proof\/} preview program.  (See the {\em man\/}
  390. page for for a description of {\em Proof}.)
  391.  
  392. \subsection{The {\tt ps-slides} Style} \label{sec:ps-slides}
  393.  
  394. This style causes \SLiTeX\ to produce output that can be printed on the
  395. QMS color printer with {\tt aptex} to produce color transparencies.
  396. When the output is printed on a black-and-white PostScript printer,
  397. colors are printed as different shades of gray.
  398.  
  399. The {\tt ps-slides} style has the following differences from the
  400. ordinary {\tt slides} style.
  401. \begin{itemize}
  402. \item The \verb+\colors+
  403.  command is made a no-op. Colors that are not predefined
  404.     must be defined with the \verb+\newpscolor+ command (see below).
  405.  
  406. \item The \verb+\colorslides+ and \verb+\blackandwhite+ commands are
  407. the same, except that
  408. \verb+\colorslides+ prints only slides and overlays, not notes.
  409.  
  410. \item The meaning of the \verb+\invisible+ declaration has been
  411. changed, as described below.  The old \verb+\visible+ command is the
  412. same as the new \verb+\white+ command.
  413.  
  414. \item The default page style is {\tt plain}.  (The alignment marks are
  415. no longer of any use.)
  416.  
  417. \item The positioning of the body of the slide and the slide number have
  418.    been changed to accomodate the QMS printer's small effective page 
  419.    size.
  420. \end{itemize}
  421. Except for these differences, a \SLiTeX\ input file prepared for the
  422. ordinary {\tt slides} style {\em should\/} work with the {\tt
  423. ps-slides} style.  There are probably some \SLiTeX\ commands that will
  424. interact incorrectly with color-changing commands.  These problems will
  425. be corrected when reported.  The most likely bug is a color declaration
  426. ``escaping from its scope'', having a more global effect than it should.
  427. Such a problem can be worked around by adding redundant color-changing
  428. commands.
  429.  
  430. The new commands defined by the {\tt ps-slides} style are listed below.
  431. \begin{description}
  432. \item[{\tt 
  433.   \begin{tabular}[b]{@{}l@{}}
  434.       \bs newpscolor\lb{\em cmd\/}\rb
  435.           \lb{\em red\/}\rb\lb{\em green\/}\rb\lb{\em blue\/}\rb \\
  436.       \bs renewpscolor\lb{\em cmd\/}\rb\lb{\em red\/}\rb
  437.           \lb{\em green\/}\rb\lb{\em blue\/}\rb
  438.   \end{tabular}}] \mbox{}\\*
  439. Define the command {\em cmd\/} to produce a new color with the
  440. indicated RGB values, where {\em red\/}, {\em green\/}, and {\em
  441. blue\/} are decimal numbers between 0 and 1 (inclusive).  For example:
  442. \begin{quote}
  443. \begin{tabular}{@{}l@{ $=$ [{\em red\/}: }l@{, {\em green\/}: }l@{, {\em 
  444.   blue\/}:}l@{]}}
  445.            Black         &  0  & 0  & 0\\
  446.            White         &  1  & 1  & 1\\
  447.            Red           &  1  & 0  & 0\\
  448.            Light yellow  &  .5 & .5 & 0
  449. \end{tabular}
  450. \end{quote}
  451. For \verb+\newpscolor+, {\em cmd\/} must not already be defined; for
  452. \verb+\renewpscolor+, it must already be defined (but not necessarily
  453. as a color).  
  454.  
  455. The following colors are predefined: 
  456. \begin{quote}
  457.      \verb+\black+, \verb+\red+, \verb+\green+, \verb+\blue+,
  458.       \verb+\yellow+,  \verb+\magenta+, \verb+\cyan+, 
  459.       \verb+\white+~\hspace*{-30pt}\mbox{}
  460. \end{quote}
  461. For ordinary printers, which assume white paper, \verb+\white+ text is
  462. invisible.  Unlike in ordinary \SLiTeX, color-changing commands can be
  463. used in math mode.
  464.  
  465. \item[{\tt
  466. \begin{tabular}[b]{@{}l@{}}
  467.  \bs invisible\\ 
  468.  \bs visible   
  469. \end{tabular}}] \mbox{}\\*
  470. Ordinary declarations of visibility of the text.  Invisible text
  471. is not printed.  (\TeX\ prints it in a font that whose letters are all
  472. print as spaces.)
  473. Visibility is independent of color, so you can have invisible red text,
  474. visible green text, and even visible white text.  (Visible white text
  475. can be seen only when printed by a weird printer that prints on
  476. nonwhite paper.)
  477.  
  478. \item[{\tt
  479. \begin{tabular}[b]{@{}l@{}}
  480.  \bs norestore\\ 
  481.  \bs restore
  482. \end{tabular}}] \mbox{}\\*
  483. The \verb+\norestore+ declaration inhibits the proper scoping of color
  484. declarations, causing color declarations to act as if they were global.
  485. The \verb+\restore+ declaration causes the current and future colors to
  486. become the ones they would have been had there been no \verb+\norestore+
  487. command.  Both \verb+\norestore+ and \verb+\restore+ are global declarations.
  488. Example:
  489. \begin{verbatim}
  490.     \black black {\green green 
  491.                          \norestore {\red red} red
  492.                          \restore 
  493.                          green} 
  494.            black
  495. \end{verbatim}     
  496. The \verb+\norestore+ declaration is handy for color commands inside a
  497. tabbing or tabular environment.  However, there are some anomalies:
  498.  
  499. \begin{itemize}
  500. \item A \verb+\restore+ command inside a tabbing environment may not
  501. work exactly as it should.  Try putting the command immediately after a
  502. \verb+\=+, \verb+\\+, or \verb+\>+. 
  503.  
  504. \item An \verb+\fbox+, \verb+\framebox+, or \verb+\frame+ command may
  505. do weird things in the scope of a \verb+\norestore+ if there's a color
  506. declaration in its argument.
  507.      
  508. \item A \verb+\background + may behave strangely inside the scope of a
  509.  \linebreak %%%%%%
  510. \verb+\norestore+.
  511. \end{itemize}     
  512.  
  513. \item[{\tt \bs background\lb{\em color\/}\rb\lb{\em text\/}\rb }]
  514. \mbox{}\\*
  515. Typesets {\em text} in an \mbox with a box behind it whose color is
  516. determined by the {\em color\/} color-changing command.  The yellow box
  517. is the width of {\em text\/} plus a border of width \verb+\bgborder+
  518. around it.  
  519.  
  520. \item[{\tt
  521. \begin{tabular}[b]{@{}l@{}}
  522.  \bs hollowbackground \\
  523.  \bs filledbackground
  524. \end{tabular}}] \mbox{}\\*
  525. A \verb+\hollowbackground+ declaration causes any 
  526. \verb+\background+
  527. command in its scope to produce an outline, much like \verb+\fbox+,
  528. instead of a filled box.  This is useful for checking the slides with
  529. Proof or on a black-and-white printer.  A \verb+\filledbackground+
  530. declaration has the opposite effect.  
  531.  
  532. \item[{\tt \bs nogray}] \mbox{}\\*
  533. A declaration that makes every color other than
  534. \verb+\white+ be equivalent to \verb+\black+, and issues a
  535. \verb+\hollowbackground+ declaration.  Used to print the slides on a
  536. black-and-white printer so colors come out black instead of various
  537. shades of gray.
  538. \end{description}
  539.  
  540. \subsection{Where the Files Are}
  541.  
  542. % must explain where the following files are:
  543. %   small.tex, sample.tex, *.sty, *.doc, lablst.tex, idx.tex
  544. %
  545.  
  546. All \LaTeX\ files mentioned in the manual, including the {\tt sty} and
  547. {\tt doc} files, are in the directory \mbox{\tt /usr/local/lib/tex82}.
  548. Fonts are stored in two directories: the {\tt tfm} files used by \TeX\
  549. are on \mbox{\tt /usr/local/fonts/tfm}, and the pixel files used by
  550. {\em iptex\/} and other device drivers are in \mbox{\tt
  551. /usr/local/fonts/pixel}.
  552.  
  553. \subsection{Running {\tt lablst.tex} and {\tt idx.tex}}
  554.  
  555. A list of labels and citations in an input file is printed
  556. by running \LaTeX\ on the input file \mbox{\tt lablst.tex},
  557. which is done by typing
  558. \begin{verbatim}
  559.      latex /usr/local/lib/tex82/lablst
  560. \end{verbatim}
  561. \LaTeX\ will then ask for the name of the input file, which should be
  562. typed without an extension, and for the name of the main document style
  563. (e.g., \mbox{\tt article}), used by that file.
  564.  
  565. The index entries on an {\tt idx} file are printed by running \LaTeX\
  566. on the file \mbox{\tt idx.tex}, which is done by typing
  567. \begin{verbatim}
  568.      latex /usr/local/lib/tex82/idx
  569. \end{verbatim}
  570. \LaTeX\ will ask for the name of the {\tt idx} file, which is typed
  571. without an extension.
  572.  
  573.  
  574.  
  575. \subsection{Differences from the Manual}
  576.  
  577. All \LaTeX\ features described in the manual are provided by 
  578. the implementation at SRC.
  579.  
  580. %Explain here any characters that can appear in input files other than
  581. %the ones listed in Section 2.1.
  582.  
  583. %Tell if the \mbox{\tt log} file has an extension other than
  584. %\mbox{\tt .log}.  Note: on TOPS-20, its extension is \mbox{\tt .lst}.
  585.  
  586. %Describe the sizes of disks and circles the are available.
  587.  
  588. %Don't forget to mention if the invisible fonts needed for \SLiTeX\
  589. %color slides are unavailable.
  590.  
  591. \subsection{Using \BibTeX}
  592.  
  593. \BibTeX\ is a program for compiling a reference list for a document
  594. from a bibliographic database.  It is run by typing
  595. \begin{verbatim}
  596.      bibtex myfile
  597. \end{verbatim}
  598. where \mbox{\tt myfile.tex} is the name of your \LaTeX\ input file.
  599. This reads the file \mbox{\tt myfile.aux}, which was generated when you
  600. ran \LaTeX\ on \mbox{\tt myfile.tex}, and produces the file \mbox{\tt
  601. myfile.bbl}.  \BibTeX\ should be run from the directory containing
  602. \mbox{\tt myfile.tex} (which should be the same directory from which
  603. \LaTeX\ was run on that file).
  604.  
  605. If the {\tt bib} file is not in the same directory as the \LaTeX\ input
  606. file---for example, if you're using someone else's {\tt bib}
  607. file---then you must include a path as part of the file name specified
  608. by the \hbox{\verb|\bibliography|} command.  A \verb|~| cannot appear
  609. in the argument of a \hbox{\verb|\bibliography|} command, so you should
  610. use a complete path name.  For example, the \LaTeX\ command
  611. \begin{verbatim}
  612.      \bibliography{/udir/jones/bibfiles/gnus}
  613. \end{verbatim}
  614. specifies the file \mbox{\tt gnus.bib} kept by Jones in his 
  615. \mbox{\tt /bibfiles} directory.
  616.  
  617.  
  618. There is now no formal provision for sharing bibliographic database
  619. information, nor are there programs to assist in making your own {\tt
  620. bib} files.  Suggestions for forming one or more common {\tt bib} files
  621. are welcome.
  622.  
  623. In addition to the bibliography styles described in the manual, there
  624. is a {\tt ieeetr} style that formats entries in the style of the IEEE
  625. transactions.
  626.  
  627. In addition to the usual three-letter abbreviations for the months, the
  628. following abbreviations are defined by the bibliography styles:
  629. \begin{list}{}{\labelwidth 0pt \itemindent-.5\leftmargin
  630.        \itemsep=2pt plus 1pt
  631.        \let\makelabel\descriptionlabel}\it
  632. \item[\tt acmcs] ACM Computing Surveys
  633. \item[\tt acta] Acta Informatica
  634. \item[\tt cacm] Communications of the ACM
  635. \item[\tt ibmjrd] IBM Journal of Research and Development
  636. \item[\tt ibmsj] IBM Systems Journal
  637. \item[\tt ieeese] IEEE Transactions on Software Engineering
  638. \item[\tt ieeetc] IEEE Transactions on Computers
  639. \item[\tt ieeetcad]
  640.  IEEE Transactions on Computer-Aided Design of Integrated Circuits
  641. \item[\tt ipl] Information Processing Letters
  642. \item[\tt jacm] Journal of the ACM
  643. \item[\tt jcss] Journal of Computer and System Sciences
  644. \item[\tt scp] Science of Computer Programming
  645. \item[\tt sicomp] SIAM Journal on Computing
  646. \item[\tt tocs] ACM Transactions on Computer Systems
  647. \item[\tt tods] ACM Transactions on Database Systems
  648. \item[\tt tog] ACM Transactions on Graphics
  649. \item[\tt toms] ACM Transactions on Mathematical Software
  650. \item[\tt toois] ACM Transactions on Office Information Systems
  651. \item[\tt toplas] ACM Transactions on Programming Languages and Systems
  652. \item[\tt tcs] Theoretical Computer Science
  653. \end{list}
  654.  
  655. % Note: All styles should share the same set of abbreviations.
  656.  
  657. \subsection{Using \SLiTeX}
  658.  
  659. \SLiTeX\ is a version of \LaTeX\ for making slides.
  660. To run \SLiTeX\  with a root file \mbox{\tt myroot.tex}, you type
  661. \begin{verbatim}
  662.      slitex myroot
  663. \end{verbatim}
  664. (You should be connected to the directory containing \mbox{\tt
  665. myroot.tex}.) Refer to Section~\ref{sec:op-system} if you want slide
  666. files or \hbox{\verb|\input|} files to be in a different directory from
  667. your root file.
  668.  
  669. Color slides can be made by copying the color layers produced by \SLiTeX\
  670. onto color transparencies using the Thermofax machine on the second
  671. floor.  However, it is easier to make them with the QMS color printer 
  672. on the 3rd floor.  To use it, you must use the {\tt ps-slides} 
  673. document style described in Section~\ref{sec:ps-slides}.  The output
  674. of \SLiTeX\ is then printed by the command
  675. \begin{quote} \tt
  676.      aptex -Pcolor {\em file-name}.dvi
  677. \end{quote}
  678. Before executing this command, check that the printer has
  679. transparencies in the paper tray and perform the appropriate protocol
  680. to synchronize with other users of the printer.
  681.  
  682. \subsection{Using {\em MakeIndex\/}} \label{sec:makeindex}
  683.  
  684. The {\em MakeIndex\/} program helps in making an index.  It is 
  685. described in a separate document, available through the
  686. {\tt printdoc} command.
  687.  
  688.  
  689. \subsection{Fonts}
  690.  
  691. Almost all the symbols available on our fonts can be generated by
  692. ordinary \LaTeX\ commands.  However, there are type sizes not
  693. obtainable by \LaTeX's size-changing commands with the ordinary
  694. document styles.  Consult a local \TeX\ expert to find the
  695. \TeX\ name for such a font.
  696.  
  697. Tables~\ref{tab:styles} and \ref{tab:fonts} allow you
  698. to determine if the font for a type style at a particular
  699. size is preloaded, loaded on demand, or unavailable.
  700. \begin{table}
  701. \centering
  702. \begin{tabular}{l|r|r|r|}
  703. \multicolumn{1}{l}{size} & 
  704. \multicolumn{1}{c}{default (10pt)} &
  705.         \multicolumn{1}{c}{11pt option}  &
  706.         \multicolumn{1}{c}{12pt option}\\
  707. \cline{2-4}
  708. \verb|\tiny|       & 5pt  & 6pt & 6pt\\
  709. \cline{2-4}
  710. \verb|\scriptsize| & 7pt  & 8pt & 8pt\\
  711. \cline{2-4}
  712. \verb|\footnotesize| & 8pt & 9pt & 10pt \\
  713. \cline{2-4}
  714. \verb|\small|        & 9pt & 10pt & 11pt \\
  715. \cline{2-4}
  716. \verb|\normalsize| & 10pt & 11pt & 12pt \\
  717. \cline{2-4}
  718. \verb|\large|      & 12pt & 12pt & 14pt \\
  719. \cline{2-4}
  720. \verb|\Large|      & 14pt & 14pt & 17pt \\
  721. \cline{2-4}
  722. \verb|\LARGE|      & 17pt & 17pt & 20pt\\
  723. \cline{2-4}
  724. \verb|\huge|       & 20pt & 20pt & 25pt\\
  725. \cline{2-4}
  726. \verb|\Huge|       & 25pt & 25pt & 25pt\\
  727. \cline{2-4}
  728. \end{tabular}
  729. \caption{Type sizes for \LaTeX\ size-changing commands.}\label{tab:styles}
  730. \end{table}
  731. \begin{table}
  732. \centering
  733. \begin{tabular}{l|c|c|c|c|c|c|}
  734. \multicolumn{1}{l}{}& 
  735. \multicolumn{1}{c}{\tt \bs it} &
  736. \multicolumn{1}{c}{\tt \bs bf} &
  737. \multicolumn{1}{c}{\tt \bs sl} &
  738. \multicolumn{1}{c}{\tt \bs sf} &
  739. \multicolumn{1}{c}{\tt \bs sc} &
  740. \multicolumn{1}{c}{\tt \bs tt} \\
  741. \cline{2-7}
  742. 5pt  & D & D & X & X & X & X \\
  743. \cline{2-7}
  744. 6pt  & X & D & X & X & X & X \\
  745. \cline{2-7}
  746. 7pt  & P & D & X & X & X & X \\
  747. \cline{2-7}
  748. 8pt  & P & D & D & D & D & D \\
  749. \cline{2-7}
  750. 9pt  & P & P & D & D & D & P \\
  751. \cline{2-7}
  752. 10pt & P & P & P & P & D & P \\
  753. \cline{2-7}
  754. 11pt & P & P & P & P & D & P \\
  755. \cline{2-7}
  756. 12pt & P & P & P & P & D & P \\
  757. \cline{2-7}
  758. 14pt & D & P & D & D & D & D \\
  759. \cline{2-7}
  760. 17pt & D & P & D & D & D & D \\
  761. \cline{2-7}
  762. 20pt & D & D & D & D & D & D \\
  763. \cline{2-7}
  764. 25pt & X & D & X & X & X & X \\
  765. \cline{2-7}
  766. \end{tabular}
  767. \caption{Font classes: P = preloaded, D = loaded on demand, 
  768.          X = unavailable.}\label{tab:fonts}
  769. \end{table}
  770. Table~\ref{tab:styles} tells you what size of type is used for each
  771. \LaTeX\ type-size command in the various document-style options.  For
  772. example, with the {\tt 12pt} option, the \hbox{\verb|\large|}
  773. declaration causes \LaTeX\ to use 14pt type.  Table~\ref{tab:fonts}
  774. tells, for every type size, to which class of fonts each type style
  775. belongs.  For example, in 14pt type, \verb|\bf| uses a preloaded
  776. font and the other five type-style commands use load-on-demand fonts.
  777. Roman (\verb|\rm|) and math italic (\verb|\mit|) fonts are all
  778. preloaded; the \hbox{\verb|\em|} declaration uses either italic
  779. (\verb|\it|) or roman.
  780.  
  781. %Describe any special fonts available here.
  782.  
  783. %Tell where to find a font manual, listing the character numbers of
  784. %the symbols on different fonts.
  785.  
  786. %Include a table telling which fonts are preloaded, loaded on demand,
  787. %and unavailable.  
  788.  
  789. \subsection{Using Times Roman Fonts} \label{sec:apple}
  790.  
  791. The fonts normally used by \LaTeX\ are from the Computer Modern Roman
  792. font family designed by Donald Knuth.  Some people prefer the Times
  793. Roman family of fonts, which are available on the Apple LaserWriter
  794. printers.  They are obtained with the {\tt ps} document-style option.
  795. Currently, this option does not work with the {\tt 12pt} style option.
  796. Also, fonts from the Times Roman family are available only for the
  797. default \verb|\rm| style and for the \verb|\it|, \verb|\bf|, and
  798. \verb|\sf| styles.  Other styles use the ordinary CMR fonts.
  799.  
  800. \TeX\ can use only the CMR fonts in math mode, so \verb|${\rm foo}=3$|
  801. produces ``foo'' in CMR font, which is probably not what you want.
  802. Instead, use \verb|$\mbox{\rm foo}=3$|, which typesets ``foo'' in Times
  803. Roman because \TeX\ is not in math mode inside the \verb|\mbox|.  No
  804. one will notice that ordinary math symbols like $\alpha$ or $x$ are
  805. typeset in a CMR font rather than a Times Roman font.
  806.  
  807. A {\tt dvi} file produced with the {\tt ps} option can be printed only
  808. on the Apple LaserWriter using the {\tt aptex\/} program.  Type the
  809. Ultrix command {\tt man~aptex} to find out how to run this program.
  810. You can print any {\tt dvi} file with {\tt aptex}, but it is slower
  811. than {\tt iptex} and doesn't do a very good job printing the
  812. standard CMR fonts.  So, use {\tt aptex} to print only {dvi} files
  813. created with the {\tt ps} option.
  814.  
  815. The {\tt ps} option causes \LaTeX\ to use more fonts than usual,
  816. so there's a good chance that you'll run \TeX\ out of font
  817. space if you use lots of different fonts.
  818.   
  819. \subsection{Special Versions}
  820.  
  821. No foreign-language or other special versions of \LaTeX\
  822. are currently available at SRC.
  823.  
  824.  
  825. \section{Bugs}
  826.  
  827. There are a few known bugs in \LaTeX\ that occur very seldom and
  828. cause the user little trouble, but would be very difficult to fix.
  829. Moreover, given the nature of complex systems, it is not unlikely that
  830. the corrections would lead to even worse problems.  Therefore, these
  831. bugs will probably not be fixed.  
  832.  
  833. The bugs and ways to get around them are listed below.  Do not worry
  834. about any of them until you are preparing the final draft, since
  835. changes to the text are very likely to cause the problem to disappear.
  836. \begin{itemize}
  837. \item In rare instances, a figure or table will be printed on the page
  838. preceding the text where the {\tt figure} or {\tt table} environment
  839. appears.  This can be fixed by either moving the environment further
  840. towards the end of the document. 
  841.  
  842. \item A marginal note at the top of a page may appear in the wrong
  843. margin.  This can be fixed by inserting a redundant \verb|\pagebreak|
  844. command to force a page break exactly where \LaTeX\ started the new
  845. page anyway.
  846.  
  847. \item A footnote can be broken across two pages when it should fit on a
  848. single page.  This happens when there is one or more figures or tables
  849. on the page.  The problem is corrected by moving, towards the end of the
  850. file, the last {\tt figure} or {\tt table} environment that produces a
  851. figure or table on the page where the footnote starts.
  852. \end{itemize}
  853.  
  854.  
  855. \section{Errata and Additions to the Manual}
  856.  
  857. \input{addendum}
  858. \end{document}
  859.  
  860. %&c&@i*\hbox{* 2@s\|\ @i|}|#&
  861. %&i&\index{#}&
  862. %&m&\mbox#&
  863. %&t&{\tt #}&
  864. %&v&\hbox{\verb|#|}&
  865. %&b&\verb|#|&
  866. %&h&\hbox#&
  867.