head	1.1;
access;
symbols;
locks; strict;
comment	@% @;


1.1
date	92.01.23.17.34.55;	author doc;	state Exp;
branches;
next	;


desc
@A guide for Latex users
@


1.1
log
@Initial revision
@
text
@
%THIS IS AN EXAMPLE OF THE CURRENT FORMAT FOR THE PRODUCTION OF
%TECHNICAL NOTES WITH LATEX.

%CONSTRUCT A FILE CALLED include.tex AS FOLLOWS:

%$\Id$%THE $Id$ SYMBOL ALLOWS THE LIBRARY TO RECOGNIZE THE FILE.

%NOTE: IF YOU WANT TO INSERT ANY FILE(S) INTO THE MAIN FILE BY USING
%THE \include{filename} OR \input{filename} COMMANDS, THE FILE(S) TO
%BE INSERTED MUST BE IN THE SAME DIRECTORY AS THE MAIN FILE.

\documentstyle[12pt,times,twoside,bezier,epic,a4]{article}
\setlength{\topmargin}{-0.5in}

\begin{document}

\include{docinfo}%THE FILE docinfo.tex IS ALREADY STORED IN THE LATEX
		 %INPUT DIRECTORY. IT CONTAINS DEFINITIONS OF THE
		 %FOLLOWING MACROS WHICH MUST BE INCLUDED, AS SET OUT
		 %BELOW, IN EVERY LIBRARY-STORED DOCUMENT TO BE
		 %PUBLISHED, TO FACILITATE EASY CATALOGUING. THE
		 %ARGUMENTS OF THESE MACROS MUST BE IN PLAIN ENGLISH TEXT.
	

\docinfotitle{Documentation aids for Latex users}
\docinfosubject{}%(OPTIONAL.)
\docinfoauthor{Judith Wildman}
\docinfoproject{DOC}%PUT THE PROJECT CODE BETWEEN THE {} BRACKETS.
\docinfoauthinit{JMW}%PUT THE AUTHOR'S INITIALS BETWEEN THE {}BRACKETS.
\docinfoyear{92}
\docinfomonth{January}%(OPTIONAL.)
\docinfoday{10}%(OPTIONAL.)
\docinfodocno{003}
\docinforev{2}%PUT THE REVISION NUMBER BETWEEN THE {} BRACKETS.
\docinfokeywords{}%(OPTIONAL.)
\docinfooperator{}%(OPTIONAL.)%PUT YOUR INITIALS BETWEEN THE BRACKETS
%IF YOU HAVE MADE CHANGES TO THE DOCUMENT.
\docinfocomments{}%(OPTIONAL.)
\docinfoabstract{}%(OPTIONAL.)
\docinfostate{DRAFT}%PUT THE STATUS OF THE DOCUMENT BETWEEN THE {} BRACKETS.
\docinfosecurity{PSL Confidential}%SECURITY CODE.
\docinforeader{PSL General}%PUT THE INTENDED READERSHIP BETWEEN THE {} BRACKETS.
\pagestyle{empty}
\vspace{10cm}

\begin{center}
{\Huge {\fbox {\it d}} {\bf o} \copyright\ {\tt s}}
\end{center}

\begin{center}
{{\Huge\bf \thetitle}}
\end{center}
\vspace{1.5cm}

\begin{center}
\theauthor
\end{center}

\vspace{12cm}

\begin{center}
\theday-\themonth-\theyear\\
\thestate\\
\thesecurity\\
\thereader
\end{center}
\small
\begin{center}
PSL-\theproject-\theauthinit-\theyear-\thedocno.\theversion
\end{center}
\normalsize
\newpage

\pagestyle{plain}
\pagenumbering{roman}
%\include{COPYRIGHT}
%\include{ACKNO}
%\tableofcontents
\vfill
\newpage

\pagenumbering{arabic}
%\include{FILE1}
%\include{FILE2}
%\include{FILE3}
%\appendix
%\include{FILE4}

\section*{Introduction}

This document is an alphabetical summary of some of the more popular
programs and macros available to {\bf \LaTeX} users. If you would like
to see a comprehensive list, please refer to the \verb+\+{\bf
usr}\verb+\+{\bf local}\verb+\+{\bf bin} directory on any Unix
machine. A number of guides relating to the various topics described
in this document are available from the Documentation Department.

  
\begin{itemize}

\item {\large\bf AMS-\TeX} 

This is a macro package for \TeX, designed to simplify the input of
mathematical material and format the output according to preset style
specifications. The Documentation Department has a guide available on
AMS-\TeX.

\item {\large\bf bibliography} 

In {\bf \LaTeX}, bibliographies may be generated either by the user,
or by the {\bf bib\TeX} program. To create the source list yourself,
use the {\bf thebibliography} environment.  Within this environment
the sources are listed using the {\bf \verb+\+bibitem} command.  To
refer to an item listed, use the {\bf \verb+\+cite} command.
Alternatively, the {\bf bib\TeX} command as described below can be
used.

\item {\large\bf bib\TeX}

{\bf bib\TeX} is a program that produces the source list for a document by 
obtaining the information from a bibliographic database. To reference an item
in the database the {\bf \verb+\+cite} command is used, as above.  To include a
bibliography type {\bf \verb+\+bibliography} command whose arguments specify
 one or more files containing the bibliographic database.  These files should 
have the extension {\bf .bib}.  To create the database files refer to the 
{\bf \LaTeX} book.

\item {\large\bf dviconcat}

Available on {\bf betty}, this program concatenates {\bf .dvi}
files. Use {\bf man dviconcat} on {\bf betty} for further information.

\item {\large\bf dviselect}

The {\bf dviselect} program selects pages from a {\bf .dvi} file and
places that selection into another {\bf .dvi} file. This program is
available on {\bf betty}. For further information, use {\bf man
dviselect} on {\bf betty}.

\item {\large\bf dvitops}

This program converts {\bf .dvi} files into postscript files, and it is
available on {\bf betty}, {\bf dolly}, {\bf jabber} and {\bf sparky}.
Use {\bf man dvitops} on {\bf betty} for further information. A user manual
on dvitops is available.

\item {\large\bf dvitype}

Available on {\bf betty}, {\bf dolly} and {\bf sparky}, {\bf dvitype}
converts {\bf .dvi} files into user-readable form. For further
information, use {\bf man dvitype} on {\bf betty}, {\bf dolly} and 
{\bf sparky}.

\item {\large\bf dvi2tty}

The {\bf dvi2tty} program is available on {\bf betty} and {\bf sparky}.
It sends a {\bf .dvi} file to standard output (where standard output is
a normal terminal). Use {\bf man dvi2tty} on {\bf sparky} for further
information. 

\item {\large\bf eps}

Many drawing packages can save figures to files in encapsulated postscript
format.  These files have the extension {\bf .eps} and can be
included in \LaTeX documents as in the example below:

\small
\begin{verbatim}
\begin{figure*} [htb]
\input{psfig}
\centerline{\psfig{figure=picture.eps}}
\caption{A supercomputer. \label{fig:supercomputer}}
\end{figure*}
\end{verbatim}
\vspace{0.25cm}
\normalsize

\item {\large\bf Errors of \TeX}

For those who are interested in the history and the evolution of {\bf \TeX}, 
paper is available that covers all the changes that were made to the
original {\bf \TeX} program first debugged in 1978.

\item {\large\bf gnu emacs}

This is a text editor, recommended for writing {\bf \LaTeX} or {\bf \TeX}
files. It is available on {\bf betty} as {\bf xemacs}, on {\bf jabber}
as {\bf xemacs}, and on {\bf snake} as {\bf emacs}.

\item {\large\bf ispell}

The {\bf ispell} program is a `spellchecker' for {\bf \LaTeX} files. It is 
available on {\bf betty}, {\bf dolly}, {\bf snake} and {\bf sparky}.

\item {\large\bf \LaTeX}

A simplified version of {\bf \TeX}, this is a complete system for 
constructing and typesetting documents,
making the format of a document easier to design so that the author can
devote more time to the content. It is available on {\bf betty}, {\bf
dolly}, {\bf jabber} and {\bf sparky}. For further information, use {\bf
man latex} on {\bf betty}, {\bf dolly} and {\bf sparky}.

\item {\large\bf lptex}

Available on {\bf betty}, {\bf dolly}, {\bf jabber} and {\bf sparky},
this program sends {\bf .dvi} files to a laserjet printer. (There is no
manual page for {\bf lptex}.)

\item {\large\bf macros}

A set of useful {\bf \TeX} macros is stored in a directory on each of our
computers, as follows:

\begin{itemize}
\item {\bf betty} {\tt /usr/local/lib/tex}
\item {\bf dolly} {\tt /usr/local/lib/Tex}
\item {\bf jabber} {\tt /usr/local/lib/Tex}
\item {\bf sparky} {\tt /giga/lib/Tex}
\end{itemize}
\vspace{0.25cm}

\item {\large\bf makeindex}

This is an index-building program for {\bf \TeX} and {\bf \LaTeX} files.
It is available on {\bf betty} and {\bf dolly}. There is no manual page
for {\bf makeindex}, but there is a Perihelion instruction leaflet
(produced by Chris Selwyn).

\item {\large\bf metafont}

It may be possible to generate fonts which are currently unavailable.
For example, any computer Roman font can be generated at any {\bf dpi}. 
(Discuss any special font requirements with Chris Selwyn.)

\item {\large\bf micro emacs}

A text editor recommended for writing {\bf \TeX} and {\bf \LaTeX} files,
{\bf micro emacs} is available on {\bf betty} as {\bf emacs} or {\bf
me}, on {\bf dolly} as {\bf me}, or on {\bf sparky} as {\bf emacs}.

\item {\large\bf PLtoTF}

This is a utility program that converts property-lists (PL) files to 
equivalent {\bf \TeX} font metric (TFM) files.  A guide is available from the
Documentation Department.
 
\item {\large\bf psfig}

{\bf psfig} is a macro package for {\bf \TeX} that facilitates the inclusion
of arbitrary postscript figures into {\bf \TeX} documents.  Figures are
automatically scaled and positioned on the page, and the correct amount
of space is reserved.  A {\bf psfig} guide is available.

\item {\large\bf pstex}

This program sends {\bf .dvi} files to a postscript printer. It is
available on {\bf betty}, {\bf dolly}, {\bf jabber} and {\bf sparky}.
For further information, use {\bf man pstex} on {\bf betty}.  If you want
to print files in landscape format, type {\bf pstex -olandscape} filename.

\item {\large\bf slitex}

The {\bf slitex} program is a variant of {\bf \LaTeX}, designed for
generating slides. It is available on {\bf betty}, {\bf dolly}, {\bf
jabber} and {\bf sparky}. Use {\bf man slitex} on {\bf betty}, {\bf
dolly} and {\bf sparky} for further information.

\item {\large\bf \TeX}

This is a complete system for document production. Users should start by
using the simpler {\bf \LaTeX} version, in which options are largely
predefined. The {\bf \TeX} program offers greater control and a wider
choice of style options to advanced users. It is available on {\bf
betty}, {\bf dolly}, {\bf jabber} and {\bf sparky}. For further
information, use {\bf man latex} on {\bf betty}, {\bf dolly} or {\bf
sparky}.

\item {\large\bf \TeX\space archive}

To find out what is available for {\bf \TeX} users, it is possible to
examine a {\bf \TeX} archive by using the {\bf \TeX} archive mail
server.  The Documentation Department has a guide on how to use the
mail server.

\item {\large\bf \TeX cad}

A drawing program for {\bf \LaTeX}, {\bf \TeX cad} runs on all IBM
PC/XT/AT machines and compatibles with a graphics adapter. Diagrams
created in the rather limited {\bf \LaTeX} picture environment can be
improved with this program. Its output is a series of {\bf \LaTeX}
picture commands which can be inserted into a document file at a chosen
point. There is a document on \TeX cad available.

\item {\large\bf tgif}

This is a drawing program, and it runs under the X window system. When the
{\bf \LaTeX} icon is displayed on a terminal screen in the {\bf choice window}, 
the output is stored in a file with the {\bf .eps} extension and the file is
put into the encapsulated postscript format. Such files can be inserted into a
{\bf \LaTeX} document file by using the {\bf psfig} or {\bf epsf} constructs.

\begin{itemize}
\item {\bf choice window}

This is located to the right of the {\bf message window} on a terminal
screen. It displays the user's current choice of drawing mode, and the
remaining options. If the {\bf \LaTeX} output mode is not set by
default, click the left button of the mouse over the output mode box on
the screen until the mode switches to {\bf \LaTeX}.

\item {\bf \LaTeX\space figure formats}

When the {\bf \LaTeX} icon is displayed in the {\bf choice window}, the
user can print (not save) a {\bf tgif} file which is to be inserted into a {\bf
\LaTeX} document file. Once the {\bf tgif} file has been printed, the user
should type {\bf CTRL-P} to generate an encapsulated postscript file. If
for example, the file name is {\bf picture.obj}, the encapsulated
postscript file will be {\bf picture.eps}. This file can be inserted
into a {\bf \LaTeX} document file by using commands similar to those
illustrated in the following example, at the
point in the document file where the picture should appear:
\vfill

\small
\begin{verbatim}
\begin{figure*} [htb]
\input{psfig}
\centerline{\psfig{figure=picture.eps}}
\caption{A supercomputer. \label{fig:supercomputer}}
\end{figure*}
\end{verbatim}
\vspace{0.25cm}
\normalsize

Alternatively, use the {\bf epsf} construct, as follows:

\small
\begin{verbatim}
\begin{figure*} [htb]
\input{epsf}
\centerline{\epsffile{figure=picture.eps}}
\caption{A supercomputer. \label{fig:supercomputer}}
\end{figure*}
\end{verbatim}
\normalsize
\vspace{0.25cm}
\end{itemize}

The {\bf tgif} program is available on {\bf snake} in the directory {\bf
/usr/local/bin/x11}. The encapsulated postcript files can only be sent
to a postcript printer from {\bf betty} or {\bf jabber}. For further 
information, use {\bf man tgif} on {\bf snake}.

\item {\large\bf tr2tex}

This program converts {\bf troff} files into {\bf \TeX} files, and it is
available on {\bf betty}. Use {\bf man tr2tex} on {\bf betty} for
further information.

\item {\large\bf TransFig}

This package integrates figures into {\bf \LaTeX} documents.  It
standardizes the integration so that {\bf \LaTeX} documents can be
ported across printers and operating environments.  This is achieved
by translating between {\bf Fig\space code} and other graphics
languages.  A TransFig guide can be obtained from the Documentation
Department.

\item {\large\bf xdvi}

Available on {\bf betty}, {\bf dolly} and {\bf sparky}, this program
runs under the X window system and previews {\bf .dvi} files, like those
produced by {\bf \LaTeX}. The {\bf xdvi} program can only be used with
files containing {\bf \TeX} fonts: it will not work with postscript fonts.
For further information, use {\bf man xdvi} on {\bf betty}, {\bf dolly}
and {\bf sparky}.

\end{itemize}

\end{document}

%COPYRIGHT AND ACKNO WOULD BE THE FILES COPYRIGHT.tex AND ACKNO.tex,
%CONTAINING YOUR COPYRIGHT AND ACKNOWLEDGEMENTS PAGES. FILE1 ETC WOULD
%BE .tex FILES CONTAINING THE DIFFERENT SECTIONS OF YOUR DOCUMENT. TO
%RUN LATEX ON THE FILE include.tex, TYPE latex include. TO PRINT THE
%WHOLE DOCUMENT, TYPE pstex include (AFTER RUNNING LATEX ON THE FILE).
%TECHNICAL NOTES DO NOT GENERALLY HAVE AN INDEX, BUT ONE CAN BE ADDED
%IF REQUIRED. (OBTAIN A COPY OF THE LEAFLET ON HOW TO USE THE
%makeindex COMMAND IF YOU ARE NOT SURE HOW TO CONSTRUCT AN INDEX WITH
%THE LATEX SYSTEM.)

%NOTE THAT THIS FILE IS SIMPLY AN EXAMPLE, FOR USE AS A GUIDE. IT IS
%OPEN TO IMPROVEMENT AND ADAPTATION.
@
