summaryrefslogtreecommitdiff
path: root/Master/texmf-doc/source/english/texlive-en/maintenance.tex
blob: 0d48dba7b0eb4f37cc919de1f4fd39dc3bacdca9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
\section{Post-installation}
\label{sec:postinstall}

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 \TL{}.  The basic idea is to
install such additions in the \envname{TEXMFLOCAL} tree (if you
installed to disk), or \envname{TEXMFSYSVAR} (if you are running live).
See the ``Installation directories'' option on \p.\pageref{text:instdir}.

Unfortunately, the details can and do vary widely, and so we do not attempt to
address them here.  Here are some external links to descriptions:
\begin{itemize*}
\item
\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instpackages}
\item
\url{http://www.ctan.org/installationadvice}
\item
\url{http://www.ctan.org/tex-archive/info/beginlatex/html/chapter5.html#pkginst}
\item
\url{http://www.ctan.org/tex-archive/info/Type1fonts} for
installation information for fonts in particular.
\end{itemize*}


% 
\subsection{Installing individual packages to disk}

You can add individual packages or collections from the current
distribution to an existing non-\TL{} setup, or an earlier
\TL{} installation.

\startinst

Run the installation script \filename{install-pkg.sh} (not
\filename{install-tl.sh}, which is intended for complete installations
only):
\begin{alltt}
> \Ucom{sh install-pkg.sh \var{options}}
\end{alltt}

The first set of options controls what gets read:

\begin{ttdescription}
\item [-{}-package=\var{pkgname}] The individual package to work on.

\item [-{}-collection=\var{colname}] The individual collection to work on.

\item [-{}-nodoc] Exclude documentation files from the operation.

\item [-{}-nosrc] Exclude source files from the operation.

\item [-{}-cddir=\var{dir}] Source directory to read from; defaults
to the current directory.  If you followed the instructions above, that
will be the distribution directory, and won't need to be changed.

\item [-{}-listdir=\var{dir}] The so-called `lists' directory within
\var{cddir} from which to read the package information.  The only
reason to change the default is if you're making changes to \TL{}
yourself.

\end{ttdescription}

What actually happens is controlled by the following options.  If
neither of these are specified, the default action is to install the
selected files.  The main destination tree is found by expanding
\envname{\$TEXMFMAIN} with \cmdname{kpsewhich}.  You can override it by
setting either the environment variable \envname{TEXMFMAIN} or
\envname{TEXMF}.

\begin{ttdescription}
\item [-{}-listonly] List the files that would be installed, but don't
actually install anything.

\item [-{}-archive=\var{tarfile}] Instead of installing the files into
the \TeX{} system, make a \cmdname{tar} archive.

\end{ttdescription}

Additional options:

\begin{ttdescription}

\item [-{}-config] After installation, run \code{texconfig init}.

\item [-{}-nohash] After installation, don't run \cmdname{mktexlsr} to
rebuild the filename database.

\item [-{}-verbose] Give more information as the script runs.

\end{ttdescription}

Here are some usage examples:

\begin{enumerate}

\item To see the files in the package \pkgname{fancyhdr} without
installing it:

\begin{alltt}
\ifSingleColumn> \Ucom{sh install-pkg.sh --package=fancyhdr --listonly}
\else> \Ucom{sh install-pkg.sh --package=fancyhdr \bs}
>                           \Ucom{--listonly}
\fi{}
texmf/doc/latex/fancyhdr/README
texmf/doc/latex/fancyhdr/fancyhdr.pdf
...
\end{alltt}

\item Install the \LaTeX{} package \pkgname{natbib}:
\begin{alltt}
> \Ucom{sh install-pkg.sh --package=natbib}
\end{alltt}

\item Install the \LaTeX{} package \pkgname{alg} without source files or
documentation:
\begin{alltt}
\ifSingleColumn> \Ucom{sh install-pkg.sh  --package=alg --nosrc --nodoc}
\else> \Ucom{sh install-pkg.sh  -{}-package=alg \bs}
>                  \Ucom{-{}-nosrc -{}-nodoc}
\fi\end{alltt}

\item Install all the packages in the collection of additional
plain \TeX\ macros:
\begin{alltt}
> \Ucom{sh install-pkg.sh --collection=tex-plainextra}
\end{alltt}

\item Write all files in the \pkgname{pstricks} package to a
\cmdname{tar} file in \path|/tmp|:
\begin{alltt}
\ifSingleColumn> \Ucom{sh install-pkg.sh --package=pstricks --archive=/tmp/pstricks.tar}
\else
> \Ucom{sh install-pkg.sh -{}-package=pstricks \bs}
>          \Ucom{-{}-archive=/tmp/pstricks.tar}
\fi\end{alltt}

\end{enumerate}

\textifindoubt


\subsection{The \protect\cmdname{texconfig} program}
\label{sec:texconfig}

At any time after installation, you can and should use the program
\cmdname{texconfig} to configure the system to fit your local needs.  It
is installed in the architecture-specific subdirectory
\texttt{TEXDIR/bin/\var{arch}} along with everything else.

If you run it without arguments, it will enter full-screen mode and
allow you to view and change options interactively.

You can also run it with various command-line options.  Here are some of
the most common (\TL{} is configured for the A4 paper size by default):

\begin{ttdescription}

\item [texconfig paper letter] Set default paper size for
various programs and drivers (\cmdname{pdftex}, \cmdname{dvips},
\cmdname{dvipdfm}, \cmdname{xdvi}) to be \acro{US} letter.  The other
allowable size is \optname{a4}, which is the default.

\item [texconfig rehash] Update all the \TeX{} ``filename databases'',
after adding or removing files.

\item [texconfig faq] Show the \teTeX{} \acro{FAQ}.
(See also the main \TeX{} \acro{FAQ} in \OnCD{texmf-doc/doc/english/FAQ-en}.)

\item [texconfig help] Output help information for \cmdname{texconfig}.

\end{ttdescription}

Of course, \cmdname{texconfig} can only support changing a few of the
many options and configuration parameters in a \TeX{} system.  The main
configuration file for the base \Webc{} programs is named
\filename{texmf.cnf}.  You can find its location by running
\samp{kpsewhich texmf.cnf}; it contains many comments explaining the
default settings and useful alternatives.

\cmdname{texconfig} alters files in a user-specific directory, as in
\dirname{\$HOME/.texlive2007}.  If you install \TeX\ just for yourself,
that is unlikely to make a difference.  But if you install \TeX\ on a
multi-user system, you will want to change the configuration for the
whole system.  In this case, run \cmdname{texconfig-sys} instead of
\cmdname{texconfig}.

Likewise, the \cmdname{updmap} and \cmdname{fmtutil} scripts were
changed, to work under \dirname{\$HOME/.texliveYYYY}.  To alter system
directories, use \cmdname{updmap-sys} and \cmdname{fmtutil-sys}.

In particular, for multi-user systems, you will probably want to
pregenerate the standard formats with \texttt{fmtutil-sys --missing}.
Otherwise, each user will end up with their own formats.

Also, if you have a personally-modified copy of \filename{fmtutil.cnf}
or \filename{updmap.cfg}, instead of using the ones generated by
installation, they must be installed in the tree referenced by the
variable \envname{TEXMFSYSCONFIG}.

The variables specifying the directories altered by these commands are
listed in section~\ref{sec:texmftrees}, \p.\pageref{sec:texmftrees}.
You can see the actual directories by running \texttt{texconfig conf},
and you can change them by editing \filename{texmf.cnf}.