[tex-live] minor doc fixes
Karl Berry
karl at freefriends.org
Tue Aug 12 23:48:39 CEST 2003
FYI, I just made the following changes to the English documentation and
regenerated the html and pdf. Thanks to Christer for the proofreading
and many good suggestions.
==== //depot/Build/cdbuild/tldocsource/english/live.tex#63 - /home/karl/src/Build/cdbuild/tldocsource/english/live.tex ====
@@ -1,5 +1,6 @@
% $Id: //depot/Build/cdbuild/tldocsource/english/live.tex#63 $ $Author: karl $ $Date: 2003/08/05 $
% change history (started May 13th 2002)
+% 2003/08/12: fixes from Christer Gustafsson <gustaf at powertech.no>.
% 2003/07/07: substantial revisions by karl.
% 2002/05/25: remove mention of sizes, and bsr-interpolated; add Gutenberg
% 2002/05/18: win32 updates, by Fabrice
@@ -15,7 +16,7 @@
\author{Sebastian Rahtz, editor \\
\email{tex-live at tug.org}\\
\url{http://tug.org/texlive/}}
-\title{The \protect\TeXLive{} Guide, for 2003}
+\title{The \protect\TeXLive{} Guide, 2003}
\date{July 2003}
% comes out too close to the toc, and we know it's page one anyway.
@@ -135,7 +136,7 @@
\label{sec:struct-tl}
The main two installation scripts for Unix and \MacOSX{} are
-\texttt{install-tl.sh} and \texttt{install-pkg.sh}. We discuss them on
+\texttt{install-tl.sh} and \texttt{install-pkg.sh}. We discuss them
in section \ref{sec:unix-install} on p.~\pageref{sec:unix-install}.
Here, we describe the structure and contents of \TeXLive{}.
@@ -172,35 +173,35 @@
\subsection{Top level directories}
-Here is a brief description of the top level directories in the
-\TeXLive{} distribution.
+Here is a brief listing and description of the top level directories in
+the \TeXLive{} distribution.
-\begin{ttdescription}
-\item[Books] Examples from some of the books about \TeX\ (see
- \filename{Books/README}).
-\item[FAQ] Current versions of major FAQ collections.
-\item[\MacOSX] Supporting software for \MacOSX (see
- section~\ref{sec:mac-install} on p.~\pageref{sec:mac-install}).
-\item[bin] The \TeX{} system programs, arranged by platform.
-\item[info] A few manuals in \acro{GNU} Info format, where available.
-\item[man] Unix man pages.
-\item[setupw32] information for Windows users (see
- section~\ref{sec:win-install} on p.~\pageref{sec:win-install}).
-\item[source] The source of all programs, including the main \Webc{}
+\smallskip
+\begin{tabular}{>{\ttfamily}lp{.8\hsize}}
+Books & Examples from some of the books about \TeX\ (see
+ \filename{Books/README}). \\
+FAQ & Current versions of major FAQ collections. \\
+\MacOSX & Supporting software for \MacOSX (see
+ section~\ref{sec:mac-install} on p.~\pageref{sec:mac-install}). \\
+bin & The \TeX{} system programs, arranged by platform. \\
+info & A few manuals in \acro{GNU} Info format, where available. \\
+man & Unix man pages. \\
+setupw32 & information for Windows users (see
+ section~\ref{sec:win-install} on p.~\pageref{sec:win-install}). \\
+source & The source of all programs, including the main \Webc{}
\TeX{} and \MF{} distributions. These are stored in a
- \cmdname{bzip2}-compressed tar archive.
-\item[support] assorted auxiliary packages and programs. These are
+ \cmdname{bzip2}-compressed tar archive. \\
+support & assorted auxiliary packages and programs. These are
\emph{not} installed by default. This includes
\cmdname{Ghostscript}, \cmdname{netpbm}, and assorted editors and
- \TeX\ shells.
-\item[texmf] root of installed packages, fonts, config files, etc.
-\item[usergrps] Material about a few of the \TeX\ user groups. (Visit
- \url{http://tug.org/usergroups.html} for a current list.)
-\item[xemtex] The XEmacs editor and other support programs for Windows.
+ \TeX\ shells. \\
+texmf & root of installed packages, fonts, config files, etc. \\
+usergrps & Material about a few of the \TeX\ user groups. (Visit
+ \url{http://tug.org/usergroups.html} for a current list.) \\
+xemtex & The XEmacs editor and other support programs for Windows.
(These programs generally come pre-installed on Unix systems, or are
- at least easy to compile.)
-
-\end{ttdescription}
+ at least easy to compile.) \\
+\end{tabular}
\subsection{Extensions to \TeX}
@@ -228,7 +229,7 @@
supports working with almost all the world's scripts simultaneously. It
also supports so-called `\OMEGA{} Translation Processes' (\acro{OTP}s),
for performing complex transformations on arbitrary input. See
-\OnCD{texmf/doc/omega/base/doc-1.8.tex} (not completely up to date).
+\OnCD{texmf/doc/omega/base/doc-1.8.tex} (not completely up-to-date).
\end{description}
@@ -476,8 +477,7 @@
for an explanation of the different distributions.)
\startinst
-
-\noindent Run the installation script \filename{install-tl.sh}:
+Run the installation script \filename{install-tl.sh}:
\begin{alltt}
> \Ucom{sh install-tl.sh}
Welcome to TeX Live...
@@ -699,8 +699,7 @@
p.~\pageref{sec:multiple-dist}.)
\startinst
-
-\noindent Run the installation script \filename{install-pkg.sh} (not
+Run the installation script \filename{install-pkg.sh} (not
\filename{install-tl.sh}, which is intended for complete installations
only):
\begin{alltt}
@@ -813,8 +812,9 @@
\section{Post-installation}
\label{sec:postinstall}
-After the main installation is done, the remaining steps are to
-configure the system for your local needs, and perform some basic tests.
+After the main installation is done, for any operating system, the
+remaining steps are to configure the system for your local needs, and
+perform some basic tests.
Another sort of post-installation is to acquire packages, fonts, or
programs that were not included in \TeXLive{}. The basic idea is to
@@ -945,6 +945,8 @@
\item Other standard test files you may find useful:
\begin{ttdescription}
+\item [docstrip.tex] Produce \TeX{} source or documentation from a
+\samp{.dtx} file.
\item [small2e.tex] A simpler document than \filename{sample2e}, to
reduce the input size if you're having troubles.
\item [testpage.tex] Test if your printer introduces any offsets.
@@ -1016,7 +1018,7 @@
\subsection{\protect\cmdname{install*.sh}: \protect\TeXLive{} installation}
In order to run the installation scripts under \MacOSX, you need to have
-the \cmdname{bash} shell installed. If you are running \MacOSX\~10.2
+the \cmdname{bash} shell installed. If you are running \MacOSX~10.2
or later, you have \cmdname{bash}, and can proceed. If you're running
an earlier \MacOSX{} version, however, the default shell is
\cmdname{zsh}, which won't work; please see the
@@ -1106,7 +1108,7 @@
\section{Windows installation}
\label{sec:win-install}
-This section applies to systems running Windows 9x, \acro{ME},
+\TeXLive{} can be installed on systems running Windows 9x, \acro{ME},
\acro{NT}, \acro{2K} or \acro{XP}. Older versions of Windows (3.1,
\acro{MS-DOS}) are not supported.
@@ -1115,7 +1117,8 @@
in Explorer and see whether it shows long, mixed-case, file names. If it
does not, you must install the Joliet extensions.
-This Win32 \TeX{} systems includes a \texttt{dvi} previewer,
+The Windows \TeX{} system included in \TeXLive{} is no more and no less
+than the \fpTeX{} distribution. It includes a \texttt{dvi} previewer,
\textsf{Windvi}, which is similar in usage to the established Unix
\textsf{xdvi}. The documentation can be found in
\OnCD{texmf/doc/html/windvi/windvi.html}.
@@ -1215,13 +1218,13 @@
The editor is run inside a modified environment. A temporary TDS
compliant texmf tree is build in the temporary area of your computer.
-It is needed to store files that may be build on the fly like pk font
-files or format files. Configuration files are copied from the \CD{}
-to this texmf tree, so that you can edit them if needed. The \path|ls-R|
-database is computed for this texmf tree.
-Then the \texttt{PATH} and \texttt{TEXMFCNF} environment
-variables are set locally, and the editor is run in
-this local environment. From within your editor\footnote{Actually, you can
+It is needed to store files that may be built on the fly, such as
+\path|pk| bitmap fonts, or format files. Configuration files are copied
+from the \CD{} to this texmf tree, so that you can edit them if needed.
+The \path|ls-R| database is computed for this texmf tree. Then the
+\texttt{PATH} and \texttt{TEXMFCNF} environment variables are set
+locally, and the editor is run in this local environment. From within
+your editor\footnote{Actually, you can
specify any program, not just a text editor: your command
processor, for example. You will then get a console with the right
settings to use \TeX{} from the \CD{}.}, you have access to a full
@@ -1243,10 +1246,10 @@
\subsection{Installing editors or support packages}
\label{sec:texlive-install}
-You can already use the \path|TeXSetup.exe| program to install a
-single, not \TeX{} dependent package. This might be either an editor
-like \cmdname{WinShell} or \cmdname{NTEmacs},
-or also a support package like \cmdname{NetPBM}
+You can use the \path|TeXSetup.exe| program to install a
+single (not \TeX{}-dependent) package. This might be an editor
+such as \cmdname{WinShell} or \cmdname{NTEmacs},
+or a support package like \cmdname{NetPBM}
(graphics formats conversion) or \cmdname{Ghostscript}.
Some of the packages are not free, or not with the same meaning as for
@@ -1598,7 +1601,7 @@
Please be aware that the choice of cluster size on DOS disk
partitions can radically affect the size of your \TeX\
installation. The support tree has hundreds of small files, and it is
-not unusual for a complete installation to take up to 4 times the
+not unusual for a complete installation to take up to four times the
amount of space used on the \CD.
@@ -1622,13 +1625,13 @@
accessed very often!). What is useful in a log trace of the shared
memory access is still to be defined, so the situation might evolve
in the future.
-\item[\cmdname{kpsecheck}] This command provides some option that did
+\item[\cmdname{kpsecheck}] This command provides some options that did
not fit well into \cmdname{kpsewhich}. It will allow you to list all
the files that occur multiple times across your texmf trees. This
could be handy, but most of the time you will also get unwanted
output (like dozens of \path|README| files)\footnote{It is noticeable
that all these files result in clashes inside the \KPS{}-hashing
- mechanism, fortunately, \KPS{} never looks for these files.}. For
+ mechanism; fortunately, \KPS{} never looks for these files.}. For
this reason, you can combine the \path|-multiple-occurences| with 2
other options for including or excluding any filename that match
some pattern (you can request for several patterns).
@@ -1679,8 +1682,8 @@
You will find an option in the \guiseq{TeXLive} menu (or go to
\guiseq{Start\arw Programs \arw TeXLive \arw Add TeX package} menu) to
-run again \file{TeXSetup.exe}, but in maintenance mode this time. The
-steps are almost the same as in the initial installation.
+run \file{TeXSetup.exe} in maintenance mode. The steps are almost the
+same as in the initial installation.
We'll discuss differences below, but first, whatever changes you make,
\textbf{do not forget to rebuild the ls-R database files}. Otherwise,
@@ -1692,7 +1695,7 @@
mode, the list of installed packages is compared to the list of packages
available from your source directories. Packages that are not installed
will be displayed in green, out of date packages will be displayed in
-red and up to date, installed packages are displayed in black.
+red and up-to-date, installed packages are displayed in black.
This way, you can choose to add or upgrade components, either from
\TeXLive{} or from the Internet, where you are likely to find some more
@@ -1816,7 +1819,7 @@
\begin{itemize}\itemsep 0pt
\item In the DVIWin tab, if the filename is \filename{yap}, replace it
with \filename{windvi.exe}.
-\item In Ghostview tab, make sure it gives the correct path for
+\item In the Ghostview tab, make sure it gives the correct path for
gsview32.exe:\\
\hspace*{1em} \verb+C:\ghostgum\gsview\gsview32.exe+ (for 3.6, the
current version)\\
@@ -1961,9 +1964,9 @@
\subsection{Testing}
-For generic testing procedures, section~\ref{sec:test-install} on
-p.~\pageref{sec:test-install}. This section describes Windows-specific
-tests.
+For generic verification procedures, see section~\ref{sec:test-install}
+on p.~\pageref{sec:test-install}. This section describes
+Windows-specific tests.
You can test \cmdname{WinShell} by opening the file \verb+sample2e.tex+,
@@ -2338,7 +2341,7 @@
its calling name.
Under Unix, this feature is implemented through \emph{symbolic
- links}. It saves up a bit of disk space, because some engines are
+links}. It saves up a bit of disk space, because some engines are
used with many different format files.
The Win32 API does not know about file links. So to save up almost
@@ -2434,10 +2437,9 @@
\item Are there any relevant bug fixes at \url{http://tug.org/texlive/}?
(Unlikely, but it doesn't hurt to check.)
-\item The Windows distribution in \TeXLive{} is no more and no less than
-the \fpTeX{} distribution, so please also check the web pages at
+\item Check the web pages at
\url{http://www.fptex.org}, or consider subscribing to the \fpTeX{}
-mailing list by consulting \url{http://tug.org/mailman/listinfo/fptex}.
+mailing list, via \url{http://tug.org/mailman/listinfo/fptex}.
\end{enumerate}
@@ -2848,7 +2850,7 @@
\end{alltt}
presuming your system's \code{ls} produces the right output format
(\acro{GNU}'s \code{ls} is all right). To ensure that the database is always
-up to date, it is easiest to rebuild it regularly via \code{cron}, so
+up-to-date, it is easiest to rebuild it regularly via \code{cron}, so
that for changes in the installed files\Dash perhaps after installing or
updating a \LaTeX{} package\Dash the file \file{ls-R} is automatically
updated.
More information about the tex-live
mailing list