From 6aaec1abaa886a4b4247b05347b6febd8f738233 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 17 Aug 2009 01:05:00 +0000 Subject: more 2009 updates, still unfinished git-svn-id: svn://tug.org/texlive/trunk@14718 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf/doc/texlive/texlive-en/texlive-en.tex | 290 +++++++++++---------- 1 file changed, 156 insertions(+), 134 deletions(-) (limited to 'Master/texmf/doc') diff --git a/Master/texmf/doc/texlive/texlive-en/texlive-en.tex b/Master/texmf/doc/texlive/texlive-en/texlive-en.tex index b1472d3c23d..74b9cc152bf 100644 --- a/Master/texmf/doc/texlive/texlive-en/texlive-en.tex +++ b/Master/texmf/doc/texlive/texlive-en/texlive-en.tex @@ -225,9 +225,6 @@ in various languages, in both \HTML{} and plain text. % \item[texmf-dist] See \dirname{TEXMFDIST} below. % -\item[texmf-doc] Tree for self-contained pure documentation, arranged by - language. -% \item[tlpkg] Scripts, programs and data for managing the installation, and some special support for Windows. \end{ttdescription} @@ -237,14 +234,11 @@ In addition to the directories above, the installation scripts and the distribution. For documentation, the comprehensive links in the top-level file -\OnCD{doc.html} may also be helpful. In general, the -\dirname{texmf-doc} directory contains documentation which does not -belong to any particular package or program. The documentation for the -programs (manuals, man pages, Info files) is in \dirname{texmf/doc}. -The documentation for \TeX\ packages and formats is in -\dirname{texmf-dist/doc}. You can use the \cmdname{texdoc} or -\cmdname{texdoctk} programs to find any documentation wherever it is -located. +\OnCD{doc.html} may be helpful. The documentation for the programs +(manuals, man pages, Info files) is in \dirname{texmf/doc}. The +documentation for \TeX\ packages and formats is in +\dirname{texmf-dist/doc}. You can use the \cmdname{texdoc} program to +find any documentation wherever it is located. This \TL\ documentation itself is in \dirname{texmf/doc/texlive}, available in several languages: @@ -393,7 +387,7 @@ Here are a few other commonly-used programs included in \TL{}: \item [bibtex] bibliography support. -\item [makeindex] index support. +\item [makeindex, xindy] index support. \item [dvips] convert \dvi{} to \PS{}. @@ -408,10 +402,7 @@ from \dvi{} files. to pdf\TeX\ (mentioned above). See the \pkgname{ps4pdf} and \pkgname{pdftricks} packages for still more alternatives. -\item [psselect, psnup, \ldots] \PS{} -utilities. - -\item [lacheck] \LaTeX{} syntax checker. +\item [psselect, psnup, \ldots] \PS{} utilities. \item [texexec, texmfstart] Con\TeX{}t and \acro{PDF} processor. @@ -425,8 +416,7 @@ utilities. \TL{} comes with many high-quality scalable fonts. See \url{http://tug.org/fonts} and -\OnCD{texmf-doc/doc/english/free-math-font-survey}. - +\OnCD{texmf-dist/doc/fonts/free-math-font-survey}. \section{Installation} @@ -435,7 +425,7 @@ utilities. \subsection{Starting the installer} \label{sec:inst-start} -To start with, get the \TK{} \DVD{} or download the \TL{} net installer, +To begin, 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. @@ -444,8 +434,8 @@ and locate the installer script: \filename{install-tl} for Unix, \dirname{systems/texlive/tlnet}; the url \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, for Unix +\filename{install-tl.zip} which can be used under Unix and Windows, or +the considerably smaller \filename{install-unx.tar.gz} for Unix only. After unpacking, \filename{install-tl} and \filename{install-tl.bat} will be in the \dirname{install-tl} subdirectory. @@ -456,68 +446,16 @@ when you insert the \DVD. You can get the \DVD\ by becoming a member of a \TeX\ user group (highly recommended, \url{http://tug.org/usergroups.html}), or purchasing it separately (\url{http://tug.org/store}), or burning your own from the \ISO\ -image (\url{http://tug.org/texlive/acquire.html}). +image. \end{description} -The following sections explain in more detail. - -\subsubsection{Unix} - -\begin{figure}[tb] -\begin{boxedverbatim} -======================> TeX Live installation procedure <===================== - -=======> Note: Letters/digits in indicate menu items <======= -=======> for commands or configurable options <======= - - - Detected platform: Intel x86 with GNU/Linux - binary systems: 1 out of 16 +See \url{http://tug.org/texlive/acquire.html} for more information and +other methods of getting the software. - Installation scheme (scheme-full) +The following sections explain installer start-up in more detail. - Customizing installation scheme: - standard collections - language collections - 83 collections out of 84, disk space required: 1666 MB - - directories: - TEXDIR (the main TeX directory): - !! default location: /usr/local/texlive/2009 - !! is not writable, please select a different one! - TEXMFLOCAL (directory for site-wide local files): - /usr/local/texlive/texmf-local - TEXMFSYSVAR (directory for variable and automatically generated data): - /usr/local/texlive/2009/texmf-var - TEXMFSYSCONFIG (directory for local config): - /usr/local/texlive/2009/texmf-config - TEXMFHOME (directory for user-specific files): - ~/texmf - - options: - [ ] use letter size instead of A4 by default - [X] create all format files - [X] install macro/font doc tree - [X] install macro/font source tree - [ ] create symlinks in standard directories - - Install for running from DVD - -Other actions: - start installation to HD - help - quit - -Enter command: -\end{boxedverbatim} -\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} -\end{figure} +\subsubsection{Unix} \noindent Below, \texttt{>} denotes the shell prompt; user input is @@ -555,7 +493,7 @@ documentation. As mentioned in section~\ref{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 +installer on \MacOSX, because the native installer makes 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). @@ -593,10 +531,67 @@ For a complete listing of the various options: > \Ucom{install-tl -help} \end{alltt} +\begin{figure}[tb] +\begin{boxedverbatim} +Installing TeX Live 2009 from: ... +Platform: i386-linux => 'Intel x86 with GNU/Linux' +Distribution: live (uncompressed) +... +======================> TeX Live installation procedure <===================== + +=======> Note: Letters/digits in indicate menu items <======= +=======> for commands or configurable options <======= + + Detected platform: Intel x86 with GNU/Linux + + binary systems: 1 out of 14 + + Installation scheme (scheme-full) + 83 collections out of 84, disk space required: 1882 MB + + Customizing installation scheme: + standard collections + language collections + + directories: + TEXDIR (the main TeX directory): + /usr/local/texlive/2009 + TEXMFLOCAL (directory for site-wide local files): + /usr/local/texlive/texmf-local + TEXMFSYSVAR (directory for variable and automatically generated data): + /usr/local/texlive/2009/texmf-var + TEXMFSYSCONFIG (directory for local config): + /usr/local/texlive/2009/texmf-config + TEXMFHOME (directory for user-specific files): + ~/texmf + + options: + [ ] use letter size instead of A4 by default + [X] create all format files + [X] allow execution of restricted list of programs via \write18 + [X] install macro/font doc tree + [X] install macro/font source tree + [ ] create symlinks to standard directories + + set up for running from DVD + +Other actions: + start installation to hard disk + help + quit +\end{boxedverbatim} +\caption{Main text installer screen (\GNU/Linux)}\label{fig:text-main} +\end{figure} + +\begin{figure}[tb] +\tlpng{install-w32-main}{\linewidth} +\caption{Expert \GUI{} installer screen (Windows)}\label{fig:gui-main} +\end{figure} + \subsubsection{The text installer} Figure~\ref{fig:text-main} displays the main text mode screen under -Unix. +Unix. The text installer is the default on 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. @@ -606,20 +601,39 @@ 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 -very barebones Perl (for Windows, a Perl subset is included). +very barebones Perl. -\subsubsection{The graphical installer} +\subsubsection{The expert graphical installer} -Figure~\ref{fig:gui-main} displays the graphical installer under +Figure~\ref{fig:gui-main} displays the expert 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. +This mode can be invoked explicitly with +\begin{alltt} +> \Ucom{install-tl -gui=perltk} +\end{alltt} + + +\subsubsection{The simplistic wizard installer} + +Under Windows, the default is to run the simplest installation method we +could devise, named the ``wizard'' installer. It installs everything +and asks almost no questions. If you want to customize your setup, you +should run one of the other installers. + +This mode can be invoked explicitly with +\begin{alltt} +> \Ucom{install-tl -gui=wizard} +\end{alltt} + + \subsection{Running the installer} \label{sec:runinstall} -The installer is intended to be mostly self-explanatory. Still, a few -quick notes about the various options and submenus: +The installer is intended to be mostly self-explanatory, but here are a +few notes about the various options and submenus: \subsubsection{Binary systems menu (Unix only)} \label{sec:binary} @@ -662,17 +676,17 @@ system. \begin{boxedverbatim} Select a scheme: =============================================================================== - - a [ ] TeX Live basic scheme - b [ ] TeX Live scheme for ConTeXt - c [X] TeX Live full scheme + a [ ] basic scheme (plain and LaTeX) + b [ ] ConTeXt scheme + c [X] full scheme (everything) d [ ] GUST TeX Live scheme e [ ] GUTenberg TeX Live scheme - f [ ] TeX Live medium scheme - g [ ] TeX Live minimal scheme - h [ ] TeX Live for Omega users - i [ ] teTeX scheme - j [ ] XML typesetting scheme + f [ ] medium scheme (plain, latex, recommended packages, some languages) + g [ ] minimal scheme (plain only) + h [ ] Omega scheme + i [ ] teTeX scheme (more than medium, but nowhere near full) + j [ ] XML scheme + k [ ] custom selection of collections \end{boxedverbatim} \caption{Scheme menu}\label{fig:scheme-text} \end{figure} @@ -687,7 +701,7 @@ specialized and country-specific schemes. \begin{figure}[tbh] \tlpng{stdcoll}{.7\linewidth} -\caption{Collections menu (Linux)}\label{fig:collections-gui} +\caption{Collections menu}\label{fig:collections-gui} \end{figure} You can refine your scheme selection with the `standard collections' and @@ -717,7 +731,7 @@ 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, +A reasonable alternative choice is a directory under your home directory, especially if you will be the sole user. Use `|~|' to indicate this, as in `|~/texlive/2009|'. @@ -734,7 +748,7 @@ Changing \dirname{TEXDIR} in the installer will also change macro files or packages. The default value is |~/texmf|. In contrast to \dirname{TEXDIR}, here a |~| is preserved in the newly-written configuration files, since it usefully refers to the home -directory of each individual running \TeX. It expands to +directory of any individual running \TeX. It expands to \dirname{$HOME} on Unix and \verb|%USERPROFILE%| on Windows. \subsubsection{Options} @@ -742,14 +756,15 @@ directory of each individual running \TeX. It expands to \begin{figure}[tbh] \begin{boxedverbatim} -

use letter size instead of A4 by default: [ ] - create all format files: [X] - install font/macro doc tree: [X] - install font/macro source tree: [X] - create symlinks in standard directories: [ ] - binaries to: - manpages to: - info to: +

use letter size instead of A4 by default: [ ] + create format files: [X] + execution of restricted list of programs: [X] + install font/macro doc tree: [X] + install font/macro source tree: [X] + create symlinks in standard directories: [ ] + binaries to: + manpages to: + info to: \end{boxedverbatim} \caption{Options menu (Unix)}\label{fig:options-text} \end{figure} @@ -758,9 +773,9 @@ 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[use letter size instead of A4 by default:] The default paper + size selection. Of course, individual documents can and should + 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 @@ -782,8 +797,8 @@ Three of the options here need mentioning: \TeX\ files. \end{description} -Now when all these settings are to your liking, you can type `I' to -start the installation process. When it is done, skip to +When all the settings are to your liking, you can type `I' to start the +installation process. When it is done, skip to section~\ref{sec:postinstall} to read what else needs to be done, if anything. @@ -816,6 +831,7 @@ like figure~\ref{fig:main-fromdvd}. options: [ ] use letter size instead of A4 by default [X] create all format files + [X] allow execution of restricted list of programs via \write18 set up for installing to hard disk @@ -833,9 +849,9 @@ disappeared, and the directories section now talks about \dirname{TEXDIRW} or writable root. The symlinks option has also 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 hard disk. +The installer will still create various directories and configuration +files, but won't copy \dirname{texmf} or \dirname{texmf-dist} to hard +disk. Post-install configuration for Unix will be slightly more complicated, because now the directory layout deviates from the default; see @@ -847,7 +863,7 @@ Windows. Windows users have to start the installer from a command prompt, see section~\ref{sec:cmdline}. Section \ref{sec:portable-unix} describes a more strictly portable -way to run \TL, which doesn't make or require changes in the +way to run \TL, which doesn't make or require any changes in the system's configuration, but doesn't allow any configuration either. \subsection{Command-line install options} @@ -904,23 +920,23 @@ option_symlinks 0 \label{sec:location} The location value can be a url starting with \texttt{ftp:}, -\texttt{http:}, or \texttt{file:/} url, or a plain path. If the given +\texttt{http:}, or \texttt{file:/}, 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 +if an \dirname{archive} subdirectory with \filename{.tar.xz} 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 +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/2009}, +\url{http://ctan.example.org/tex-archive/texlive/tlnet/}, 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}) 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 +\url{http://mirror.ctan.org}. In any event, the chosen host is used for the entire download. @@ -992,6 +1008,10 @@ MANPATH_MAP /usr/local/texlive/2009/bin/i386-linux \ And 2)~check for a file \filename{/etc/environment} which may define the search path and other default environment variables. +We also create a symbolic link named \code{man} in each (Unix) binary +directory. Some \code{man} programs, such as the standard \MacOSX\ man, +will automatically find that, obviating the need for any man page setup. + \subsubsection{When running from DVD} @@ -1034,7 +1054,6 @@ 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 @@ -1057,15 +1076,17 @@ configuration tab of \prog{tlmgr} in \GUI\ mode. \subsubsection{Integrating third-party fonts} -This is unfortunately a very complicated and messy topic. Forget -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}. +This is unfortunately a messy topic. Forget about it unless you want to +delve into many details of the \TeX{} installation. Don't forget to +check first what you get for free: see section~\ref{sec:tl-fonts}. 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. +If you do need to do this, see +\url{http://tug.org/fonts/fontinstall.html} for our best effort at +describing the procedure. \subsection{Testing the installation} \label{sec:test-install} @@ -1085,8 +1106,9 @@ place: \begin{alltt} > \Ucom{tex -{}-version} -TeX 3.1415926 (Web2C 7.5.7) -kpathsea version 3.5.7 +TeX 3.1415926 (TeX Live 2009) +kpathsea version 5.0.0 +Copyright 2009 D.E. Knuth. ... \end{alltt} If this comes back with `command not found' instead of version and @@ -1097,7 +1119,7 @@ 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.1415926... +This is pdfTeX, Version 3.1415926-1.40.10 (TeX Live 2009) ... Output written on sample2e.dvi (3 pages, 7484 bytes). Transcript written on sample2e.log. @@ -1113,9 +1135,9 @@ actions'' on page~\pageref{sec:debugging}.) \begin{alltt} > \Ucom{xdvi sample2e.dvi} \end{alltt} -(Under Windows, the analogous command is \cmdname{dviout}.) You should +Under Windows, the analogous command is \cmdname{dviout}. You should see a new window with a nice document explaining some of the basics of -\LaTeX{}. (Well worth reading, by the way if you're new to the system.) +\LaTeX{}. (Well worth reading, by the way, if you're new to \TeX.) You do have to be running under X for \cmdname{xdvi} to work; if you're not, or your \envname{DISPLAY} environment variable is set incorrectly, you'll get an error \samp{Can't open display}. @@ -1137,11 +1159,11 @@ you'll get an error \samp{Can't open display}. \textrm{or:} > \Ucom{xpdf sample2e.pdf} \end{alltt} -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. (There are plenty of -other \acro{PDF} viewers, too.) +Neither \cmdname{gv} nor \cmdname{xpdf} are 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. There are plenty +of other \acro{PDF} viewers, too. For Windows, we recommend trying out +Sumatra PDF (\url{http://blog.kowalczyk.info/software/sumatrapdf}). \item Standard test files you may find useful in addition to \filename{sample2e.tex}: -- cgit v1.2.3