summaryrefslogtreecommitdiff
path: root/Master/texmf-doc/source
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2008-07-18 01:06:43 +0000
committerKarl Berry <karl@freefriends.org>2008-07-18 01:06:43 +0000
commit6e03db9f64032b271cfd8b27304d5db2c9b91378 (patch)
treee2477d89e112128227fc90f1b428bde423d016e7 /Master/texmf-doc/source
parent5ad6efc265ddbdac7f9787ee34b8b66dcbd6457f (diff)
up to managing
git-svn-id: svn://tug.org/texlive/trunk@9651 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-doc/source')
-rw-r--r--Master/texmf-doc/source/texlive/texlive-en/tex-live.sty5
-rw-r--r--Master/texmf-doc/source/texlive/texlive-en/texlive-en.tex469
2 files changed, 239 insertions, 235 deletions
diff --git a/Master/texmf-doc/source/texlive/texlive-en/tex-live.sty b/Master/texmf-doc/source/texlive/texlive-en/tex-live.sty
index 74b23879e92..ea30054ccc4 100644
--- a/Master/texmf-doc/source/texlive/texlive-en/tex-live.sty
+++ b/Master/texmf-doc/source/texlive/texlive-en/tex-live.sty
@@ -196,11 +196,10 @@
\def\tlpng#1#2{%
\ifnum \Status=2 % html, want relative path in output
- \includegraphics[bb=0 0 1 1]{#1.png}
+ \includegraphics[bb=0 0 1 1]{#1.png}%
\else % not html, handled by TEXINPUTS in Makefile
- \includegraphics[width=#2]{#1.png}
+ \includegraphics[width=#2]{#1.png}%
\fi
- \\[5mm]
}
%
% description-like environment that uses tt instead of bf, and doesn't
diff --git a/Master/texmf-doc/source/texlive/texlive-en/texlive-en.tex b/Master/texmf-doc/source/texlive/texlive-en/texlive-en.tex
index 23eb509e709..8e4ec5e1664 100644
--- a/Master/texmf-doc/source/texlive/texlive-en/texlive-en.tex
+++ b/Master/texmf-doc/source/texlive/texlive-en/texlive-en.tex
@@ -9,8 +9,8 @@
\begin{document}
\title{%
- {\huge \textit{The \protect\TL{} Guide}\\[1ex]}
- {\LARGE \textsf{\TL{} 2008}}
+ {\huge \textit{The \protect\TL{} Guide}\\[1ex]}%
+ {\LARGE \textsf{\TL{} 2008}}%
}
\author{Karl Berry, editor \\[3mm]
@@ -54,7 +54,7 @@ see the end of the document, section~\ref{sec:history}
(\p.\pageref{sec:history}).
\subsection{Operating system support}
-\label{sec:os_support}
+\label{sec:os-support}
\TL{} contains binaries for many Unix-based architectures,
including \MacOSX. The included sources should enable installation
@@ -160,8 +160,7 @@ will provide a bug reporting address.
The other side of the coin is helping others who have questions. Both
\dirname{comp.text.tex} and \code{texhax} are open to anyone, so feel
-free to join, start reading, and help out where you can. Welcome to
-\TeX{}!
+free to join, start reading, and help out where you can.
% don't use \TL so the \uppercase in the headline works. Also so
@@ -184,7 +183,7 @@ The \TK{} \DVD{} comprises the following:
\item [Mac\TeX] for \MacOSX, this adds a native \MacOSX\ installer and other
Mac applications to \TL{}. Its home page is
-\url{http://www.tug.org/mactex/}.
+\url{http://www.tug.org/mactex/}.
\item [pro\TeX{}t] An enhancement of the \MIKTEX\ distribution for Windows,
\ProTeXt\ adds a few extra tools to \MIKTEX, and simplifies
@@ -198,7 +197,7 @@ installation instructions. The \ProTeXt\ home page is
\end{description}
-\CTAN{}, \pkgname{protext}, Mac\TeX, and \dirname{texmf-extra} do not
+\CTAN{}, \pkgname{protext}, and \dirname{texmf-extra} do not
necessarily follow the same copying conditions as \TL{}, so be careful
when redistributing or modifying.
@@ -253,7 +252,7 @@ the top-level file \OnCD{doc.html} may also be helpful.
This \TL\ documentation itself is in \dirname{texmf-doc} and is
available in several languages:
-\begin{itemize}
+\begin{itemize*}
\item{Chinese:} \OnCD{texmf-doc/doc/chinese/texlive-zh-cn}
\item{Czech/Slovak:} \OnCD{texmf-doc/doc/czechslovak/texlive-cz}
\item{English:} \OnCD{texmf-doc/doc/english/texlive-en}
@@ -261,7 +260,7 @@ available in several languages:
\item{German:} \OnCD{texmf-doc/doc/german/texlive-de}
\item{Polish:} \OnCD{texmf-doc/doc/polish/texlive-pl}
\item{Russian:} \OnCD{texmf-doc/doc/russian/texlive-ru}
-\end{itemize}
+\end{itemize*}
\subsection{Overview of the predefined texmf trees}
\label{sec:texmftrees}
@@ -331,9 +330,6 @@ The default layout is:
\begin{ttdescription}
\item[.texlive2007] Privately generated and configuration data
for a previous release.
- \begin{ttdescription}
- \item [...]
- \end{ttdescription}
\item[.texlive2008] Privately generated and configuration data
for the current release.
\begin{ttdescription}
@@ -436,8 +432,9 @@ utilities.
\label{sec:tl-fonts}
\TL{} comes with many high-quality scalable fonts. See
-\OnCD{texmf-doc/english/free-math-fonts-survey} for some, and
-\url{http://tug.org/fonts} for more.
+\url{http://tug.org/fonts} and
+\OnCD{texmf-doc/english/free-math-fonts-survey}.
+
\section{Installation}
@@ -446,8 +443,8 @@ utilities.
\subsection{Starting the installer}
\label{sec:inst_start}
-First, get the \TK{} \DVD{} or download the \TL{} net installer, and
-locate the installer script: \filename{install-tl} for Unix,
+To start with, get the \TK{} \DVD{} or download the \TL{} net installer,
+and locate the installer script: \filename{install-tl} for Unix,
\filename{install-tl.bat} for Windows.
\begin{description}
@@ -456,9 +453,9 @@ locate the installer script: \filename{install-tl} for Unix,
\url{http://mirror.ctan.org/systems/texlive/tlnet} will automatically
redirect to a nearby, up-to-date, mirror. You can retrieve either
\filename{install-tl.zip} which can be used under Unix and Windows and
-\filename{install-unx.tar.gz} which is considerably smaller, but
-Unix-only (including \MacOSX). After unpacking, \filename{install-tl}
-and \filename{install-tl.bat} will be in the \dirname{install-tl}
+\filename{install-unx.tar.gz} which is considerably smaller, for Unix
+only. After unpacking, \filename{install-tl} and
+\filename{install-tl.bat} will be in the \dirname{install-tl}
subdirectory.
\item [\TeX{} Collection \DVD:] go to its \dirname{texlive}
@@ -470,6 +467,7 @@ a \TeX\ user group (highly recommended,
image (\url{http://tug.org/texlive/acquire.html}).
\end{description}
+The following sections explain in more detail.
\subsubsection{Unix}
@@ -521,12 +519,12 @@ Other actions:
Enter command:
\end{boxedverbatim}
-\caption{Main text installer screen (\GNU/Linux)}\label{fig:text_main}
+\caption{Main text installer screen (\GNU/Linux)}\label{fig:text-main}
\end{figure}
\begin{figure}[tb]
\tlpng{install-w32-main}{\linewidth}
-\caption{Main \GUI{} installer screen (Windows)}\label{fig:gui_main}
+\caption{Main \GUI{} installer screen (Windows)}\label{fig:gui-main}
\end{figure}
\noindent
@@ -538,7 +536,6 @@ way:
> \Ucom{cd /path/to/installer}
> \Ucom{perl install-tl}
\end{alltt}
-
(Or you can invoke \Ucom{perl /path/to/installer/install-tl}, or
\Ucom{./install-tl} if it stayed executable, etc.; we won't repeat all
these variations.)
@@ -561,6 +558,21 @@ sure your setting is sufficiently permissive, for instance, \code{umask
documentation.
+\subsubsection{Mac\,OS\,X}
+
+As mentioned in \label{sec:tl-coll-dists}, a separate distribution is
+prepared for \MacOSX, named Mac\TeX\ (\url{http://tug.org/mactex}). We
+recommend using the native Mac\TeX\ installer instead of the \TL\
+installer on \MacOSX, because the native installer can make a few
+Mac-specific adjustments, in particular to allow easily switching
+between the various \TeX\ distributions for \MacOSX\ (Mac\TeX, gw\TeX,
+Fink, MacPorts, \ldots).
+
+Mac\TeX\ is firmly based on \TL, and the main \TeX\ trees are precisely
+the same. It does add a few extra folders with Mac-specific
+documentation and applications.
+
+
\subsubsection{Windows}
If you are using the net installer, or the \DVD\ installer failed to
@@ -591,14 +603,14 @@ For a complete listing of the various options:
\subsubsection{The text installer}
-Figure~\ref{fig:text_main} displays the main text mode screen under
+Figure~\ref{fig:text-main} displays the main text mode screen under
Unix.
This is only a command-line installer; there is no cursor support at
all. For instance, you cannot tab around checkboxes or input fields.
-You just have to type something (case-sensitive) at the prompt and press
-the Enter key, and then the entire terminal screen will be rewritten,
-with adjusted content.
+You just type something (case-sensitive) at the prompt and press the
+Enter key, and then the entire terminal screen will be rewritten, with
+adjusted content.
The text installer interface is this primitive for a reason: it
is designed to run on as many platforms as possible, even with a
@@ -606,7 +618,7 @@ very barebones Perl (for Windows, a Perl subset is included).
\subsubsection{The graphical installer}
-Figure~\ref{fig:gui_main} displays the graphical installer under
+Figure~\ref{fig:gui-main} displays the graphical installer under
Windows. Most differences in available options are due to this
screenshot being from Windows, and the previous text screen being
from \GNU/Linux.
@@ -641,10 +653,10 @@ Available sets of binaries:
o [ ] win32 Windows
p [ ] x86_64-linux x86_64 with GNU/Linux
\end{boxedverbatim}
-\caption{Binaries menu}\label{fig:bin_text}
+\caption{Binaries menu}\label{fig:bin-text}
\end{figure}
-Figure~\ref{fig:bin_text} displays the text mode binaries menu. By
+Figure~\ref{fig:bin-text} displays the text mode binaries menu. By
default, only the binaries for your current platform will be installed.
From this menu, you can select installation of binaries for other
architectures as well. This can be useful if you are sharing a \TeX\
@@ -670,68 +682,61 @@ Select a scheme:
i [ ] teTeX scheme
j [ ] XML typesetting scheme
\end{boxedverbatim}
-\caption{Scheme menu}\label{fig:text_scheme}
+\caption{Scheme menu}\label{fig:scheme-text}
\end{figure}
-Figure~\ref{fig:text_scheme} display the \TL\ scheme menu; from here,
-you choose an overall set of package collections. The default
-\optname{full} scheme installs everything available, but you can also
-choose the \optname{basic} scheme for a small system, \optname{minimal}
-for testing purposes, and \optname{medium} or \optname{teTeX} to get
-something in between. There are also various specialized and
-country-specific schemes.
+Figure~\ref{fig:scheme-text} displays the \TL\ scheme menu; from here,
+you choose a ``scheme'', which is an overall set of package collections.
+The default \optname{full} scheme installs everything available, but you
+can also choose the \optname{basic} scheme for a small system,
+\optname{minimal} for testing purposes, and \optname{medium} or
+\optname{teTeX} to get something in between. There are also various
+specialized and country-specific schemes.
\begin{figure}[tbh]
\tlpng{stdcoll}{.7\linewidth}
-\caption{Collections menu (Linux)}\label{fig:gui_collections}
+\caption{Collections menu (Linux)}\label{fig:collections-gui}
\end{figure}
You can refine your scheme selection with the `standard collections' and
-`language collections' menus (figure~\ref{fig:gui_collections, in \GUI\
-mode for a change)}.
+`language collections' menus (figure~\ref{fig:collections-gui}, shown in
+\GUI\ mode for a change).
Collections are one level more detailed than schemes\Dash in essence, a
scheme consists of several collections, a collection consists of one or
more packages, and a package (the lowest level grouping in \TL) contains
the actual \TeX\ macro files, font files, and so on.
-If you want more control than the collections menus provide, you need to
-run the \prog{tlmgr} program afterwards (see section~\ref{sec:tlmgr});
-there you can control the installation at the package level. The
-installer will take care of appropriate configuration of format
-generation, hyphenation patterns and font-related matters.
+If you want more control than the collection menus provide, you can use
+the \prog{tlmgr} program after installation (see
+section~\ref{sec:tlmgr}); using that, you can control the installation
+at the package level.
\subsubsection{Directories}
\label{sec:directories}
The default layout is described in section~\ref{sec:texmftrees},
\p.\pageref{sec:texmftrees}. The default location of
-\dirname{TEXDIR} is different for Windows
-(|%PROGRAMFILES%\texlive\2008|) and for Unix
-(\dirname{/usr/local/texlive/2008})\footnote{It is possible to
- override these defaults beforehand with environment variables;
- search the file \filename{install-tl} for
- \texttt{TEXLIVE\_INSTALL\_}. However, if you want to automate
- installations then a far better option is to use profiles; see
- section~\ref{sec:cmdline} under \optname{-profile}.}.
-
-The main reason for changing the proposed directory structure is
-lack of write permissions for the default location. You don't have
-to be root or adminstrator to install \TL, but you do need write
-access to the target directory.
+\dirname{TEXDIR} is different between Windows
+(|%PROGRAMFILES%\texlive\2008|) and Unix
+(\dirname{/usr/local/texlive/2008}).
+
+The main reason to change this default is if you lack write permission
+for the default location. You don't have to be root or adminstrator to
+install \TL, but you do need write access to the target directory.
A logical alternate choice is a directory under your home directory,
-especially if you will be the sole user. Type
-`|~|' to indicate this, \emph{e.g.}: `|~/texlive/2008|'.
+especially if you will be the sole user. Use
+`|~|' to indicate this, as in `|~/texlive/2008|'.
-We recommend including the year in the name, to enable keeping
-different releases of \TL{} side by side. (You may wish to make a
-version-independent name such \dirname{/usr/local/texlive-cur} via a
-symbolic link, which you can then update after testing the new
-release.)
+We recommend including the year in the name, to enable keeping different
+releases of \TL{} side by side. (You may wish to make a
+version-independent name such as \dirname{/usr/local/texlive-cur} via a
+symbolic link, which you can then update after testing the new release.)
-Changing \dirname{TEXDIR} will also change \dirname{TEXMFLOCAL},
-\dirname{TEXMFSYSVAR} and \dirname{TEXMFSYSCONFIG}.
+Changing \dirname{TEXDIR} in the installer will also change
+\dirname{TEXMFLOCAL}, \dirname{TEXMFSYSVAR} and
+\dirname{TEXMFSYSCONFIG}.
\dirname{TEXMFHOME} is the recommended location for personal
macro files or packages. The default value is |~/texmf|. In
@@ -754,24 +759,27 @@ directory of each individual running \TeX. It expands to
manpages to:
info to:
\end{boxedverbatim}
-\caption{Options menu (Linux)}\label{fig:text_options}
+\caption{Options menu (Unix)}\label{fig:options-text}
\end{figure}
-Figure~\ref{fig:text_options} displays the text mode options menu.
-Three options require some explanation:
+Figure~\ref{fig:options-text} displays the text mode options menu.
+Three of the options here need mentioning:
+
\begin{description}
+\item[use letter size instead of A4 by default:] The usual default paper
+ size selection. Of course, individual documents can specify a specific
+ paper size, if desired.
+
\item[create all format files:] Although unnecessary format files
- take time to generate and disk space to store, it is still
- recommended to check this option: if you don't, then format files
- will be generated in people's private \dirname{TEXMFVAR} tree, and
- won't be updated automatically if binaries or hyphenation patterns
- etc. are updated, and they may end up with incompatible format
- files.
-\item[install font/macro source tree:] These are mostly
- \LaTeX{} \filename{.dtx} files, from which both \filename{.sty} files
- and documentation are generated. It is ok to uncheck this.
+ take time to generate and disk space to store, it is still recommended
+ to leave this option checked: if you don't, then format files will be
+ generated in people's private \dirname{TEXMFVAR} tree as they are
+ needed. In that location, they will not be updated automatically if
+ (say) binaries or hyphenation patterns are updated in the
+ installation, and thus could end up with incompatible format files.
+
\item[create symlinks in standard directories] (Unix only):
- this option bypasses the need to change environment
+ This option bypasses the need to change environment
variables. Without this option, \TL{} directories have to be added
to \envname{PATH}, \envname{MANPATH} and \envname{INFOPATH}. You will
need write permissions to the target directories. It is not
@@ -790,8 +798,8 @@ anything.
\subsubsection{Set up for running from DVD{} (text mode only)}
\label{sec:fromdvd}
-Typing `V' to select this option. This changes the main menu into something
-like figure~\ref{fig:main_fromdvd}.
+Type `|V|' to select this option. This changes the main menu into something
+like figure~\ref{fig:main-fromdvd}.
\begin{figure}[tbh]
\begin{boxedverbatim}
======================> TeX Live installation procedure <=====================
@@ -824,7 +832,7 @@ Other actions:
<Q> quit
\end{boxedverbatim}
\caption{The main menu with \optname{from DVD}
- set}\label{fig:main_fromdvd}
+ set}\label{fig:main-fromdvd}
\end{figure}
Note the changes: all options about what to install have
@@ -834,11 +842,11 @@ disappeared.
The installer will still create various directories and
configuration files, but won't copy \dirname{texmf},
-\dirname{texmf-dist} or \dirname{texmf-doc} to harddisk.
+\dirname{texmf-dist} or \dirname{texmf-doc} to hard disk.
-Post-install configuration for Unix will be slightly more
-complicated, see section~\ref{sec:postinstall}, because now the
-directory layout deviates from the default.
+Post-install configuration for Unix will be slightly more complicated,
+because now the directory layout deviates from the default; see
+section~\ref{sec:postinstall}.
Due to time constraints, this option didn't make it into the \GUI{}
installer, but it is available both for Unix and for
@@ -856,7 +864,8 @@ Type
\begin{alltt}
> \Ucom{install-tl -help}
\end{alltt}
-for a listing of command-line options. These are the more
+for a listing of command-line options. Either |-| or |--| can be used
+to introduce option names. These are the more
interesting ones:
\begin{ttdescription}
@@ -864,67 +873,62 @@ interesting ones:
Perl/Tk module (\url{http://tug.org/texlive/distro.html#perltk});
if Perl/Tk is not available, installation continues in text mode.
\item[-no-gui] Force using the text mode installer, even under
- Windows, \emph{e.g.} because you want a `from \DVD' installation,
- which is not available in \GUI{} mode.
-\item[-lang \textit{2-letter code}] Specify the installer interface
- language. Currently supported languages: English (\texttt{en},
- default), German (\texttt{de}), French (\texttt{fr}), Dutch
- (\texttt{nl}), Polish (\texttt{pl}), Slovenian (\texttt{sl})
- and Vietnamese (\texttt{vi}). The installer tries to determine the
- right language itself but if it fails, or if the right language is
- not available, then it uses English as a fallback.
-\item[-profile \textit{profile}] The installer writes a file
+ Windows; you'll need this if you want a `from \DVD' installation,
+ since that is not available in \GUI{} mode.
+\item[-lang {\sl LL}] Specify the installer interface
+ language as its standard two-letter code \textsl{LL}. Currently
+ supported languages: English (\texttt{en}, default), German
+ (\texttt{de}), French (\texttt{fr}), Dutch (\texttt{nl}), Polish
+ (\texttt{pl}), Slovenian (\texttt{sl}) and Vietnamese
+ (\texttt{vi}). The installer tries to determine the right language
+ itself but if it fails, or if the right language is not available,
+ then it uses English as a fallback.
+\item[-profile {\sl profile}] The installer always writes a file
\filename{texlive.profile} to the \dirname{2008/tlpkg}- or
- \dirname{tlpkg} subdirectory of your installation. An
- example profile:
+ \dirname{tlpkg} subdirectory of your installation. This option tells
+ the installer to re-use such a profile file. Here's an excerpt:
\begin{fverbatim}
# texlive.profile written on Wed Jul 9 16:13:44 2008 UTC
-# it will NOT be overwritten and reflects only the
-# installation profile at installation time
+# It will NOT be updated and reflects only the
+# installation profile at installation time.
selected_scheme scheme-basic
TEXDIR /usr/local/texlive/2008
TEXDIRW /usr/local/texlive/2008
-TEXDIRW /usr/local/texlive/2008
-TEXMFHOME ~/texmf
-TEXMFLOCAL /usr/local/texlive/texmf-local
-TEXMFSYSCONFIG /usr/local/texlive/2008/texmf-config
+...
TEXMFSYSVAR /usr/local/texlive/2008/texmf-var
collection-basic 1
-collection-latex 1
-option_doc 0
-option_fmt 0
-option_letter 0
-option_src 0
+...
option_symlinks 0
\end{fverbatim}
- With a copy of this file, you can install in batchmode on
+ Thus, using this option you can install in batch mode on
subsequent systems, reproducing the choices you made for the
original installation.
-\item [-location \textit{url/path}] Specify a non-default source for
+\item [-location {\sl url/path}] Specify a non-default source for
packages; see below.
\end{ttdescription}
\subsubsection{The \optname{location} parameter}
\label{sec:location}
-The argument can be an \texttt{ftp:} or \texttt{http:} url, but also
-a local \texttt{file:/} url, and even a plain path. If the given
-argument is on a local drive (either a path or a \texttt{file:/}
-url), the installation type (compressed or live) is automatically
-determined: if an \dirname{archive} subdirectory with
-\filename{.tar.lzma} files is found then it will be used, even if
-uncompressed files are available as well.
-
-When giving an \texttt{http:} or \texttt{ftp:} location,
-trailing `\texttt{/}' characters and/or a trailing `\texttt{/tlpkg}'
-component are ignored. For example, you could choose a particular
-CTAN mirror with something like:
+The location value can be a url starting with \texttt{ftp:},
+\texttt{http:}, or \texttt{file:/} url, or a plain path. If the given
+argument is on a local drive (either a path or a \texttt{file:/} url),
+the installation type (compressed or live) is automatically determined:
+if an \dirname{archive} subdirectory with \filename{.tar.lzma} files is
+found then it will be used, even if uncompressed files are available as
+well.
+
+When giving an \texttt{http:} or \texttt{ftp:} location, trailing
+`\texttt{/}' characters and/or a trailing `\texttt{/tlpkg}' component
+are ignored. For example, you could choose a particular \CTAN\ mirror
+with something like:
\url{http://ctan.example.org/tex-archive/texlive/tlnet/2008},
substituting of course a proper hostname and its particular top-level
-CTAN path (the list of CTAN mirrors is maintained at
-\url{http://ctan.org/mirrors}). The default is to pick a mirror
-automatically, using \url{http://mirror.ctan.org}; one mirror is
-used for the entire download.
+\CTAN\ path (the list of \CTAN\ mirrors is maintained at
+\url{http://ctan.org/mirrors}) for |ctan.example.org/tex-archive|. The
+default is to pick a mirror automatically, using
+\url{http://mirror.ctan.org}; in any case, the chosen host is used for
+the entire download.
\subsection{Post-install actions}
@@ -934,56 +938,57 @@ Some post-install may be required.
\subsubsection{Windows}
-For Windows, the installer takes care of everything.
+But on Windows, the installer takes care of everything.
\subsubsection{If symlinks were created}
-If you elected to create symlinks in standard directories then there
-is no need to edit environment variables.
+If you elected to create symlinks in standard directories (mentioned in
+section~\ref{sec:options}), then there is no need to edit environment
+variables.
\subsubsection{Environment variables for Unix}
\label{sec:env}
-The directory of the binaries for your platform should be added to
-the searchpath. Each supported platform has its own subdirectory
-under \dirname{TEXDIR/bin}. See figure~\ref{fig:bin_text} for the
+The directory of the binaries for your platform must be added to
+the search path. Each supported platform has its own subdirectory
+under \dirname{TEXDIR/bin}. See figure~\ref{fig:bin-text} for the
list of subdirectories and corresponding platforms.
-You might as well also add the \TeX{} info- and manpage directories
-to their respective searchpaths. A couple of examples:
+You can also add the documentation man and Info directories to their
+respective search paths, if you want the system tools to find them.
-For Bash or another Bourne-compatible shell and Intel x86
-GNU/Linux and a default directory setup, the file to edit might be
-\filename{$HOME/.profile} or \filename{$HOME/.bash_profile}, and the lines
-to add might look like
+For Bourne-compatible shells such as \prog{bash}, and using Intel x86
+GNU/Linux and a default directory setup as an example, the file to edit
+might be \filename{$HOME/.profile} (or another file sourced by
+\filename{.profile}, and the lines to add would look like this:
\begin{sverbatim}
-PATH=/usr/local/texlive/2008/bin/i386-linux:$PATH
-export PATH
-MANPATH=/usr/local/texlive/2008/texmf/doc/man:$MANPATH
-export MANPATH
-INFOPATH=/usr/local/texlive/2008/texmf/doc/info:$INFOPATH
-export INFOPATH
+PATH=/usr/local/texlive/2008/bin/i386-linux:$PATH; export PATH
+MANPATH=/usr/local/texlive/2008/texmf/doc/man:$MANPATH; export MANPATH
+INFOPATH=/usr/local/texlive/2008/texmf/doc/info:$INFOPATH; export INFOPATH
\end{sverbatim}
-For csh or tcsh, the file to edit might be \filename{$HOME/.cshrc} and
+For csh or tcsh, the file to edit is typically \filename{$HOME/.cshrc}, and
the lines to add might look like:
\begin{sverbatim}
-setenv PATH /usr/local/texlive/2008/bin/i386-freebsd:$PATH
+setenv PATH /usr/local/texlive/2008/bin/i386-linux:$PATH
setenv MANPATH /usr/local/texlive/2008/texmf/doc/man:$MANPATH
setenv INFOPATH /usr/local/texlive/2008/texmf/doc/info:$INFOPATH
\end{sverbatim}
+Of course, you may well already have settings somewhere in your ``dot''
+files, and so then the \TL\ directories should simply be merged in as
+appropriate.
+
\subsubsection{Environment variables: global configuration}
\label{sec:envglobal}
-If you want to make these changes globally, or at least for a
-default new user, then you are on your own; there is just too much
-variation between systems in how and where these things are
-configured.
+If you want to make these changes globally, or for a user newly added to
+the system, then you are on your own; there is just too much variation
+between systems in how and where these things are configured.
-You may want to check for a file
+Our two hints are: 1)~you may want to check for a file
\filename{/etc/manpath.config} and, if present, add lines such as
\begin{sverbatim}
@@ -991,31 +996,30 @@ MANPATH_MAP /usr/local/texlive/2008/bin/i386-linux \
/usr/local/texlive/2008/texmf/doc/man
\end{sverbatim}
-Check also for a file \filename{/etc/environment} which may define
-the searchpath and some other default environment variables.
+And 2)~check for a file \filename{/etc/environment} which may define the
+search path and other default environment variables.
+
\subsubsection{When running from DVD}
-Normally, a \TL{} program consults a file \filename{texmf.cnf} for
-the location of the various trees. It looks for this file in a
-series of locations relative to its own location. However, this
-scheme breaks down when the program file is on the \DVD{}: the
-\DVD{} is read-only. Some of the paths to be recorded in
-\filename{texmf.cnf} are only known at installation time, so this
-file cannot be on the \DVD{} and must be placed somewhere else. This
-makes it necessary to define an environment \envname{TEXMFCNF}
-variable which tells \TL{} programs in what directory to find this
-\filename{texmf.cnf}. Of course it is still necessary to modify the
-\envname{PATH} environment variable, as described before.
+Normally, a \TL{} program consults a file \filename{texmf.cnf} for the
+location of the various trees. It looks for this file in a series of
+locations relative to its own location. However, this scheme breaks down
+when a program is run from \DVD{}: the \DVD{} is read-only. Some of the
+paths to be recorded in \filename{texmf.cnf} are only known at
+installation time, so this file cannot be on the \DVD{} and must be
+placed somewhere else. This makes it necessary to define an environment
+\envname{TEXMFCNF} variable which tells \TL{} programs in what directory
+to find this \filename{texmf.cnf}. It is also still necessary to modify
+the \envname{PATH} environment variable, as described before.
At the end of the installation, the installer should have printed a
-message to what value \envname{TEXMFCNF} should be set. In case you
-missed it: this value is \dirname{$TEXMFSYSVAR/web2c}. For the
-default, \dirname{/usr/local/texlive/2008/texmf-var/web2c}, you need
-the lines
+message giving the value to which \envname{TEXMFCNF} should be set. In
+case you missed it: this value is \dirname{$TEXMFSYSVAR/web2c}. For the
+default, \dirname{/usr/local/texlive/2008/texmf-var/web2c}, you need the
+lines
\begin{sverbatim}
-TEXMFCNF=/usr/local/texlive/2008/texmf-var/web2c
-export TEXMFCNF
+TEXMFCNF=/usr/local/texlive/2008/texmf-var/web2c; export TEXMFCNF
\end{sverbatim}
or, for [t]csh:
\begin{sverbatim}
@@ -1026,19 +1030,19 @@ setenv TEXMFCNF /usr/local/texlive/2008/texmf-var/web2c
The `old' \ConTeXt{} should run out of the box. The new `Mark IV'
\ConTeXt{} will require manual setup; see
-\url{http://wiki.contextgarden.net/Running_Mark_IV}
+\url{http://wiki.contextgarden.net/Running_Mark_IV}.
\subsubsection{Integrating local and personal macros}
-This is already mentioned implicitly in
-section~\ref{sec:texmftrees}: \dirname{TEXMFLOCAL}, \emph{e.g.}
-\dirname{/usr/local/texlive/texmf-local} or
-\verb|C:\Program Files\texlive\texmf-local| is intended for local
-fonts and macros; \dirname{TEXMFHOME}, usually \dirname{$HOME/texmf}
-or \verb|%USERPROFILE%\texmf|, are for
-personal fonts and macros. These directories should stick around
-from release to release. Their content will be seen automatically by
-a new \TL{} release.
+This is already mentioned implicitly in section~\ref{sec:texmftrees}:
+\dirname{TEXMFLOCAL} (by default,
+\dirname{/usr/local/texlive/texmf-local} or
+\verb|C:\Program Files\texlive\texmf-local|)
+is intended for system-wide local fonts and macros; and
+\dirname{TEXMFHOME} (by default, \dirname{$HOME/texmf} or
+\verb|%USERPROFILE%\texmf|), is for personal fonts and macros. These
+directories should stick around from release to release. Their content
+will be seen automatically by a new \TL{} release.
\subsubsection{Integrating third-party fonts}
@@ -1047,9 +1051,9 @@ about it unless you really know your way around blindfolded in a
\TeX{} installation. Don't forget to check first what you get for
free: see section~\ref{sec:tl-fonts}.
-An alternative is using \XeTeX,
-see section~\ref{sec:tex-extensions}, which lets you use operating
-system fonts without installation in \TeX.
+A possible alternative is to use \XeTeX (see
+section~\ref{sec:tex-extensions}), which lets you use operating system
+fonts without any installation in \TeX.
\subsection{Testing the installation}
@@ -1059,7 +1063,7 @@ After installing \TL{} as best you can, you naturally want to test
it out, so you can start creating beautiful documents and\slash or fonts.
This section gives some basic procedures for testing that the new system
-is functional. We give Unix commands; under \MacOSX{} and Windows,
+is functional. We give Unix commands here; under \MacOSX{} and Windows,
you're more likely to run the tests through a graphical interface, but
the principles are the same.
@@ -1070,28 +1074,29 @@ place:
\begin{alltt}
> \Ucom{tex -{}-version}
-TeX 3.141592 (Web2C 7.5.5)
-kpathsea version 3.5.5
+TeX 3.1415926 (Web2C 7.5.7)
+kpathsea version 3.5.7
...
\end{alltt}
If this comes back with `command not found' instead of version and
-copyright information, most likely you don't have the correct
-\dirname{bin} subdirectory in your \envname{PATH}. See
+copyright information, or with an older version, most likely you don't
+have the correct \dirname{bin} subdirectory in your \envname{PATH}. See
the environment-setting information on \p.\pageref{sec:env}.
\item Process a basic \LaTeX{} file:
\begin{alltt}
> \Ucom{latex sample2e.tex}
-This is pdfeTeXk, Version 3.141592...
+This is pdfeTeXk, Version 3.1415926...
...
-Output written on sample2e.dvi (3 pages, 7496 bytes).
+Output written on sample2e.dvi (3 pages, 7484 bytes).
Transcript written on sample2e.log.
\end{alltt}
-If this fails to find \filename{sample2e.tex} or other files, perhaps
-you have interference from old environment variables or configuration
-files. For a deep analysis, you can always ask \TeX{} to report on
-exactly what it is searching for, and finding; see ``Debugging actions''
-on page~\pageref{Debugging}.
+If this fails to find \filename{sample2e.tex} or other files, most
+likely you have interference from old environment variables or
+configuration files; we recommend unsetting all \TeX-related environment
+variables for a start. (For a deep analysis, you can ask \TeX{} to
+report on exactly what it is searching for, and finding; see ``Debugging
+actions'' on page~\pageref{Debugging}.)
\item Preview the result online:
\begin{alltt}
@@ -1124,9 +1129,11 @@ you'll get an error \samp{Can't open display}.
Unfortunately neither \cmdname{gv} nor \cmdname{xpdf} are currently
included in \TL{}, so you must install them separately. See
\url{http://www.gnu.org/software/gv} and
-\url{http://www.foolabs.com/xpdf}, respectively.
+\url{http://www.foolabs.com/xpdf}, respectively. (There are plenty of
+other \acro{PDF} viewers, too.)
-\item Other standard test files you may find useful:
+\item Standard test files you may find useful in addition to
+\filename{sample2e.tex}:
\begin{ttdescription}
\item [small2e.tex] A simpler document than \filename{sample2e}, to
@@ -1138,15 +1145,14 @@ reduce the input size if you're having troubles.
You must type \samp{\bs bye} to the \code{*} prompt after \samp{tex
story.tex}.
\end{ttdescription}
-You can process these in the same way as we did with
-\filename{sample2e.tex}.
\end{enumerate}
-If you are new to \TeX{}, or otherwise need help with actually
-constructing \TeX{} or \LaTeX{} documents, please visit
+If you are new to \TeX{}, or otherwise need help with actually writing
+\TeX{} or \LaTeX{} documents, please visit
\url{http://tug.org/begin.html} for some introductory resources.
+
\section{Network installations}
\label{sec:netinstall}
@@ -1161,47 +1167,45 @@ this at work in the configuration file
\begin{sverbatim}
TEXMFMAIN = $SELFAUTOPARENT/texmf
...
-TEXMFLOCAL = $SELFAUTOPARENT../texmf-local
+TEXMFLOCAL = $SELFAUTOPARENT/../texmf-local
\end{sverbatim}
This means that other systems or other users merely need to add the
-directory for \TL{} binaries for their platform to their searchpath.
+directory for \TL{} binaries for their platform to their search path.
By the same token, you can also install \TL{} locally and then move
the entire hierarchy afterwards to a network location.
-Of course, Windows users have different
-expectations. The directory
-\dirname{texmf-doc/source/texlive/texlive-common/w32client} contains
-a sample script \filename{install-w32client}
-which creates settings and menu shortcuts for using an
-existing \TL{} installation on a LAN. It is to be invoked through a
-batchfile wrapper \filename{install-w32client.bat} in the same
-directory.
+Of course, Windows users have different expectations. The directory
+\dirname{texmf-doc/source/texlive/texlive-common/w32client} contains a
+sample script \filename{install-w32client} which creates settings and
+menu shortcuts for using an existing \TL{} installation on a
+\acro{LAN}. It is to be invoked through a batch file
+\filename{install-w32client.bat} in the same directory.
You can read more about \TL{} configuration and path searching in
section~\ref{sec:kpathsea}.
-\section{Really portable \protect\TL{} on DVD and USB}
+\section{Maximally portable \protect\TL{} on DVD and USB}
\label{sec:portable-unix}
The `running from \DVD{}' option described in
section~\ref{sec:fromdvd} is fine for your own system, but if you
-are a guest on somebody else's system then you might prefer
-something with minimal side-effects.
+are a guest on somebody else's system then you would probably like
+something with minimal side effects.
-In the root of the \TL{} \DVD, or the \dirname{texlive} subdirectory
-of the \TK{} \DVD, are a \filename{tl-portable} script (Unix)
-and a \filename{tl-portable.bat} batchfile (Windows) which start up
-a secondary shell/command prompt with environment settings suitable
-for accessing the \TL{} on the \DVD.
+In the root of the \TL{} \DVD, or the \dirname{texlive} subdirectory of
+the \TK{} \DVD, are a \filename{tl-portable} script (Unix) and a
+\filename{tl-portable.bat} batchfile (Windows) which start up a
+secondary shell\slash command prompt with environment settings suitable
+for directly accessing the \TL{} on the \DVD.
When it runs for the first time, some files will be generated in a
-directory \dirname{~/.tlportable2008}. On subsequent runs, though, it
-will start almost instantaneously.
+directory \dirname{~/.tlportable2008}, which will take a little time.
+On subsequent runs, though, it will start almost instantaneously.
-The rest of the system will be unaware of \TL. If you want your
-editor to be aware of this \TL, then you can start it from
-a second, parallel such \TL{} session.
+The rest of the system will be unaware of \TL. If you want your editor
+to be aware of this \TL, then you can start it from a second, parallel,
+such \filename{tl-portable} session.
You can also use \filename{tl-portable} to run \TL{} on a
\acro{USB} stick. In this case, copy all the top-level files and
@@ -1212,11 +1216,12 @@ the stick. This may take quite a while! If you are copying to a
symbolic links (\code{cp -L}). A \dirname{texmf-local} directory on
the stick will also be found and used.
-Then run \filename{tl-portable} from the root of the stick, as
-above. In this case, the script will notice that the stick is
-writable and use it for generated files. You could probably burn
-the resulting contents of the stick back to \DVD{} if that is more
-convenient to (for example) give to others.
+Then run \filename{tl-portable} from the root of the stick, as above.
+In this case, the script will notice that the stick is writable and use
+it for generated files. You could burn the resulting contents of the
+stick back to \DVD{} if that is more convenient to (for example) give to
+others.
+
\section{Managing your installation}
\label{sec:tlmgr}