summaryrefslogtreecommitdiff
path: root/Master/texmf/doc/man/man1/install-tl.1
blob: f9a6fc5b29eb88da14e23aa37383983e3b35ac29 (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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "INSTALL-TL 1"
.TH INSTALL-TL 1 "2009-08-14" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
install\-tl \- TeX Live cross\-platform installer
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
install-tl [\s-1OPTION\s0]...
.PP
install\-tl.bat [\s-1OPTION\s0]...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The TeX Live installer works across all supported platforms and allows
to install TeX Live from various media, including the network.
.PP
Post-installation configuration, packages updates, and more, are now
available through \fBtlmgr\fR(1), the TeX Live Manager
(<http://tug.org/texlive/tlmgr.html>).
.PP
The most up-to-date version of this documentation is on the Internet at
<http://tug.org/texlive/doc/install\-tl.html>.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-gui\fR [[=]\fImodule\fR]" 4
.IX Item "-gui [[=]module]"
If no \fImodule\fR is given starts the default \s-1GUI\s0 installer (default on
Windows).
.Sp
If \fImodule\fR is given loads the given installer module. Currently the
following modules are supported:
.RS 4
.ie n .IP """text""" 8
.el .IP "\f(CWtext\fR" 8
.IX Item "text"
The text mode user interface which is the default on Unix systems, and
can be forced with by giving \f(CW\*(C`text\*(C'\fR as \fImodule\fR, or with the \f(CW\*(C`\-no\-gui\*(C'\fR
switch.
.ie n .IP """wizard""" 8
.el .IP "\f(CWwizard\fR" 8
.IX Item "wizard"
The wizard mode user interface asking only a few questions before installing
all of TeX Live. This is the default on Windows systems.
.ie n .IP """perltk""" 8
.el .IP "\f(CWperltk\fR" 8
.IX Item "perltk"
The all-in-one \s-1GUI\s0 installer.
It can also be selected by giving the \f(CW\*(C`\-gui\*(C'\fR option without any \fImodule\fR.
.RE
.RS 4
.Sp
The \f(CW\*(C`perltk\*(C'\fR and \f(CW\*(C`wizard\*(C'\fR modules, and thus also when calling with a
simple \f(CW\*(C`\-gui\*(C'\fR (without \fImodule\fR) requires
the Perl/Tk module (<http://tug.org/texlive/distro.html#perltk>; if
Perl/Tk is not available, installation continues in text mode.
.RE
.IP "\fB\-no\-gui\fR" 4
.IX Item "-no-gui"
Use the text mode installer (default except on Windows).
.IP "\fB\-lang\fR \fI2\-letter lang code\fR" 4
.IX Item "-lang 2-letter lang code"
(only for \s-1GUI\s0 installer) If possible, start the installer translated into
the language specified by the 2\-letter language code. Currently supported
languages: English (en, default), German (de), French (fr), Dutch (nl),
Polish (pl) and Slovenian (sl).
.IP "\fB\-location\fR \fIurl|path\fR" 4
.IX Item "-location url|path"
Provide an installation source, either a local directory via
\&\f(CW\*(C`/path/to/directory\*(C'\fR or a \f(CW\*(C`file:/\*(C'\fR url, or a network location via
a \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`ftp://\*(C'\fR url.
.Sp
If the location is local, the installation type (compressed or live) is
automatically determined, by checking for the presence of a
\&\f(CW\*(C`archive\*(C'\fR directory relative to the root.  Compressed is
preferred if both are available, since it is faster.  Here's an example
of using a local directory:
.Sp
.Vb 1
\&  -location /local/TL/repository/copy
.Ve
.Sp
If the location is on the network, trailing \f(CW\*(C`/\*(C'\fR characters and/or
trailing \f(CW\*(C`/tlpkg\*(C'\fR and \f(CW\*(C`/archive\*(C'\fR components are ignored.  For example,
you could choose a particular \s-1CTAN\s0 mirror with something like this:
.Sp
.Vb 1
\&  -location http://mirror.example.org/its/path/to/ctan/texlive/tlnet
.Ve
.Sp
Of course a proper hostname and its particular top-level \s-1CTAN\s0 path
have to be specified.  The list of \s-1CTAN\s0 mirrors is available at
<http://ctan.org/mirrors>.
.Sp
The default is to pick a mirror automatically, using
<http://mirror.ctan.org/systems/texlive/tlnet>; the chosen mirror is
used for the entire download.  You can use the special location name
\&\f(CW\*(C`ctan\*(C'\fR as an abbreviation for this.  See <http://ctan.org> for more
about \s-1CTAN\s0 and its mirrors.
.Sp
After installation is complete, you can use that installation as the
location for another installation.  If you chose to install less than
the full scheme containing all packages, the list of available schemes
will be adjusted accordingly.
.IP "\fB\-no\-cls\fR" 4
.IX Item "-no-cls"
(only for text mode installer) do not clear the screen when entering
a new menu (for debugging purposes).
.IP "\fB\-non\-admin\fR" 4
.IX Item "-non-admin"
For Windows only: configure for the current user, not for all users.
.IP "\fB\-all\-options\fR" 4
.IX Item "-all-options"
Normally options not regarding the current architecture are not shown.
Giving this cmd line option allows to configure settings in the
final tlpdb that do not have any immediate effect.
.IP "\fB\-portable\fR" 4
.IX Item "-portable"
Start the installer for portable use\-\-\-but use the \f(CW\*(C`tl\-portable\*(C'\fR
scripts instead of this option.  See below for details.
.IP "\fB\-print\-arch\fR" 4
.IX Item "-print-arch"
Print the detected arch-os combination and exit.
.IP "\fB\-force\-arch\fR \fIarch-os\fR" 4
.IX Item "-force-arch arch-os"
Instead of auto-detecting the current platform use the one given on the
cmd line. Make sure that there are binaries for this platform and they
can actually be run.
.IP "\fB\-profile\fR \fIprofile\fR" 4
.IX Item "-profile profile"
Load the \fIprofile\fR file for repeated installations on different systems.
A \fIprofile\fR contains the values of all necessary variable for the
installation. After normal installation has finished a profile for that
exact installation is written into DEST/tlpkg/texlive.profile. That file
can be used to do the exact same installation on a different computer.
.Sp
You can also hand-craft such a profile starting from a generated one
by changing some values. Normally a profile has to contain the value 1 for
each collection that should be installed, even if the scheme is specified.
That follows from the logic of the installer that you first select a scheme
and then can change the actual collections being installed.
.Sp
There is one exception to this: If the profile contains a variable for
\&\fBselected_scheme\fR and \fIno\fR collection variable is defined in the
profile, then the collections which the specified scheme requires are
installed.  Thus, a simple line \f(CW\*(C`selected_scheme scheme\-medium\*(C'\fR
together with the definitions of the paths (\f(CW\*(C`TEXDIR\*(C'\fR, \f(CW\*(C`TEXDIRW\*(C'\fR,
\&\f(CW\*(C`TEXMFHOME\*(C'\fR, \f(CW\*(C`TEXMFLOCAL\*(C'\fR, \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR, \f(CW\*(C`TEXMFSYSVAR\*(C'\fR) suffices
to install the medium scheme with all default options.
.IP "\fB\-scheme\fR \fIscheme\fR" 4
.IX Item "-scheme scheme"
Schemes are the highest level of package grouping in TeX Live; the
default is to use the \f(CW\*(C`full\*(C'\fR scheme, which includes everything.  This
option overrides that default.  You can change the scheme again before
the actual installation with the usual menu.  The \fIscheme\fR argument may
optionally have a prefix \f(CW\*(C`scheme\-\*(C'\fR.  The list of supported scheme names
depends on what your installation location provides; see the interactive
menu list.
.IP "\fB\-custom\-bin\fR \fIpath\fR" 4
.IX Item "-custom-bin path"
In case your architecture is not supported by TeX Live out of the box
and you have built your own binaries for your system, this option allows
to give the \fIpath\fR to a directory where ready made binaries for your
system are present. The installation will continue as normally, but at
the end all files from \fIpath\fR are copied over to \f(CW\*(C`bin/custom\*(C'\fR in your
installation folder and this directory will be added to the path for
the postinstall actions.
.IP "\fB\-debug\-translation\fR" 4
.IX Item "-debug-translation"
This switch will make install-tl report any missing or probably
untranslated messages in the \s-1GUI\s0 installers to \s-1STDERR\s0.
.IP "\fB\-q\fR" 4
.IX Item "-q"
Omit normal informational messages.
.IP "\fB\-v\fR" 4
.IX Item "-v"
Include debugging messages; repeat for maximum debugging, as in \f(CW\*(C`\-v
\&\-v\*(C'\fR.  (Further repeats are accepted but ignored.)
.IP "\fB\-logfile\fR \fIfile\fR" 4
.IX Item "-logfile file"
Write both all messages (informational, debugging, warnings) to \fIfile\fR,
in addition to standard output or standard error.
.Sp
If this option is not given, the installer will create a log file
in the root of the writable installation tree,
for example, \f(CW\*(C`/usr/local/texlive/YYYY/install\-tl.log\*(C'\fR for the \fI\s-1YYYY\s0\fR
release.
.IP "\fB\-\-help\fR, \fB\-help\fR, \fB\-?\fR" 4
.IX Item "--help, -help, -?"
Display this help and exit.
.IP "\fB\-\-version\fR, \fB\-version\fR" 4
.IX Item "--version, -version"
Output version information and exit.
.PP
As usual, all options can be specified with either \f(CW\*(C`\-\*(C'\fR or \f(CW\*(C`\-\-\*(C'\fR, and
arguments can be be separated from their options by either a space or \f(CW\*(C`=\*(C'\fR.
.SH "PORTABLE USE"
.IX Header "PORTABLE USE"
The TeX Live root directory contains a shell script \f(CW\*(C`tl\-portable.sh\*(C'\fR
and a \s-1DOS\s0 batch file \f(CW\*(C`tl\-portable.bat\*(C'\fR which start up a new shell and
command prompt in which TeX Live can be run with minimal impact on the
host system. These files start up \f(CW\*(C`install\-tl\*(C'\fR with the
\&\f(CW\*(C`\-portable\*(C'\fR option for some minimal preparation. Don't use this option
directly; it makes very specific assumptions about its environment.
.SH "AUTHORS AND COPYRIGHT"
.IX Header "AUTHORS AND COPYRIGHT"
This script and its documentation were written for the TeX Live
distribution (<http://tug.org/texlive>) and both are licensed under the
\&\s-1GNU\s0 General Public License Version 2 or later.