summaryrefslogtreecommitdiff
path: root/Master/texmf/doc/man/man1/tlmgr.1
blob: 747fed1eeade9eddd5f0b342904146fa05a1d216 (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
337
338
339
340
341
342
343
344
345
346
.\" 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.  \*(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-
.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 "TLMGR 1"
.TH TLMGR 1 "2008-05-05" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
tlmgr \- the TeX Live Manager
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
tlmgr [\s-1OPTIONS\s0] \s-1ACTION\s0 ...
.SH "ACTION"
.IX Header "ACTION"
.IP "\fBhelp\fR" 8
.IX Item "help"
Gives this help page.
.IP "\fBgui\fR" 8
.IX Item "gui"
Starts the \s-1GUI\s0. Currently not all options of the cmd line version are
supported in the \s-1GUI\s0.
.IP "\fBinstall [options] pkg1 [pkg2 [pkg3 ...]]\fR" 8
.IX Item "install [options] pkg1 [pkg2 [pkg3 ...]]"
Install all packages given on the cmdline. By default this installs all
dependencies, too. See below for the option \fB\-\-no\-depends\fR.
.Sp
\&\fBSupported options\fR
.RS 8
.IP "\fB\-\-no\-depends\fR" 16
.IX Item "--no-depends"
Do not install dependencies. If this option is not given installing
a package will check that all dependencies of this package are fulfilled.
.IP "\fB\-\-dry\-run\fR" 16
.IX Item "--dry-run"
Enables the chicken
mode, i.e., nothing is actually installed but the actions to be performed
are written to the terminal.
.RE
.RS 8
.RE
.IP "\fBupdate [options]\fR" 8
.IX Item "update [options]"
Update all packages if newer ones are available
.Sp
\&\fBSupported options\fR
.RS 8
.IP "\fB\-\-dry\-run\fR" 16
.IX Item "--dry-run"
Enables the chicken
mode, i.e., nothing is actually installed but the actions to be performed
are written to the terminal.
.RE
.RS 8
.RE
.IP "\fBremove [options] pkg1 [pkg2 [pkg3 ...]]\fR" 8
.IX Item "remove [options] pkg1 [pkg2 [pkg3 ...]]"
Remove all packages given on the cmdline. Removing a collection will
remove all dependencies, too, unless with option \fB\-\-no\-depends\fR.
.Sp
Removing a package which is referenced as a dependency in another
collection or scheme will not succeed unless the \fB\-\-force\fR option is given.
.Sp
\&\fBSupported options\fR
.RS 8
.IP "\fB\-\-no\-depends\fR" 16
.IX Item "--no-depends"
Do not remove depending packages.
.IP "\fB\-\-force\fR" 16
.IX Item "--force"
When removing a package or collection would invalidate a dependency
of another collection/scheme, the package will not be removed and
a warning issued. With this options the package will be removed
unconditionally. Use with care.
.IP "\fB\-\-dry\-run\fR" 16
.IX Item "--dry-run"
Enables the chicken
mode, i.e., nothing is actually removed but the actions to be performed
are written to the terminal.
.RE
.RS 8
.RE
.IP "\fBdefault show\fR" 8
.IX Item "default show"
.PD 0
.ie n .IP "\fBdefault \fB""key""\fB [\f(BI""value""\fB]\fR" 8
.el .IP "\fBdefault \f(CBkey\fB [\f(CBvalue\fB]\fR" 8
.IX Item "default key [value]"
.PD
The first form shows the default settings as saved in the TeX Live Database.
.Sp
In the second form if the \f(CW\*(C`value\*(C'\fR is missing the setting is showed, while
with \f(CW\*(C`value\*(C'\fR present the setting is set to \f(CW\*(C`value\*(C'\fR.
.Sp
Possible values for \f(CW\*(C`key\*(C'\fR are: \f(CW\*(C`location\*(C'\fR (default installation source),
\&\f(CW\*(C`formats\*(C'\fR (create formats at installation time),
\&\f(CW\*(C`docfiles\*(C'\fR (install documentation files),
\&\f(CW\*(C`srcfiles\*(C'\fR (install source files).
.IP "\fBpaper a4\fR" 8
.IX Item "paper a4"
.PD 0
.IP "\fBpaper letter\fR" 8
.IX Item "paper letter"
.IP "\fB[xdvi|dvips|pdftex|dvipdfm|dvipdfmx] paper [help|papersize]\fR" 8
.IX Item "[xdvi|dvips|pdftex|dvipdfm|dvipdfmx] paper [help|papersize]"
.PD
Configures the system wide paper settings, either for all programs in
one go, or for the given program on the command line.
.IP "\fBarch list\fR" 8
.IX Item "arch list"
Prints the list of arch-os available at the default install location.
.IP "\fBarch add [arch [arch [...]]]\fR" 8
.IX Item "arch add [arch [arch [...]]]"
Adds binaries for the given architectures to the installtion.
.Sp
\&\fBSupported options\fR
.RS 8
.IP "\fB\-\-dry\-run\fR" 16
.IX Item "--dry-run"
For installation and removal of packages, this options enables the chicken
mode, i.e., nothing is actually installed but the actions to be performed
are written to the terminal.
.Sp
Note that for all other type of options but package installation and removal
this options does \fB\s-1NOT\s0\fR work!
.RE
.RS 8
.RE
.IP "\fBsearch [\-\-file] what\fR" 8
.IX Item "search [--file] what"
Search the names, short and long descriptions of all locally installed packages
for the given argument (interpreted as regexp).
.Sp
With the \fB\-\-file\fR argument searches for files containing \f(CW\*(C`what\*(C'\fR somewhere
in the path, and returning each package with the respective hit.
.IP "\fBglobalsearch [\-\-file] what\fR" 8
.IX Item "globalsearch [--file] what"
Search the names, short and long descriptions of all packages available on
the install media.
.Sp
With the \fB\-\-file\fR argument searches for files containing \f(CW\*(C`what\*(C'\fR somewhere
in the path, and returning each package with the respective hit.
.IP "\fBshow [pkg [pkg [...]]]\fR" 8
.IX Item "show [pkg [pkg [...]]]"
Shows for each given package the name, category, installation status,
short and long description. Does search in the remote installation
source for finding the package if it is not installed.
.IP "\fBlist [collections|schemes]\fR" 8
.IX Item "list [collections|schemes]"
Without argument lists all packages available at the default install
location, prefixing those already installed with \*(L"i \*(R".
.Sp
With arguments lists only collections or schemes.
.IP "\fBuninstall\fR" 8
.IX Item "uninstall"
Uninstalls the TeX Live installation.
.Sp
\&\fBSupported options\fR
.RS 8
.IP "\fB\-\-force\fR" 16
.IX Item "--force"
Do not ask for confirmation, remove immediately.
.RE
.RS 8
.RE
.IP "\fBgenerate language\fR" 8
.IX Item "generate language"
.PD 0
.IP "\fBgenerate fmtutil\fR" 8
.IX Item "generate fmtutil"
.IP "\fBgenerate updmap\fR" 8
.IX Item "generate updmap"
.PD
\&\fB\s-1WARNING\s0\fR Using these option will overwrite any user changes done in
the respective files. Please think twice before using it.
.Sp
These function regenerate the three config files language.dat, fmtutil.cnf,
and updmap.cfg from the information present in the local \s-1TLPDB\s0. If files
language\-local.dat, fmtutil\-local.cnf, or updmap\-local.cfg are present
under \s-1TEMXFLOCAL\s0 in the respective directories stuff there will be 
simply merged into the final files. So be careful what to put there.
.Sp
Especially with updmap.cfg this function is dangerous because it will
remove all maps which have been manually enabled (via updmap-sys \-\-enable),
so be careful.
.Sp
\&\fBSupported options\fR
.RS 8
.ie n .IP """\-\-dest""\fR \fIoutput file" 16
.el .IP "\f(CW\-\-dest\fR \fIoutput file\fR" 16
.IX Item "--dest output file"
specifies the output file (defaults to the respective location in \s-1TEXMFSYSVAR\s0).
.ie n .IP """\-\-localcfg""\fR \fIlocal conf file" 16
.el .IP "\f(CW\-\-localcfg\fR \fIlocal conf file\fR" 16
.IX Item "--localcfg local conf file"
specifies the (optional) local additions (defaults to the respective location
in \s-1TEXMFSYSVAR\s0).
.RE
.RS 8
.RE
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-location\fR \fIlocation\fR" 8
.IX Item "--location location"
Overrides the location as found in the tlpdb of the installation. Specifies
the location from which packages should be installed or updated.
.IP "\fB\-\-netarchive\fR \fIdir\fR" 8
.IX Item "--netarchive dir"
Overrides the default settings for netarchive. Should be used with care.
.IP "\fB\-\-diskarchive\fR \fIdir\fR" 8
.IX Item "--diskarchive dir"
Overrides the default settings for diskarchive. Should be used with care.
.PP
The standard options \f(CW\*(C`\-\-help/\-h/\-?\*(C'\fR and \f(CW\*(C`\-\-debug\*(C'\fR are also accepted.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBtlmgr\fR manages an existing TeX Live installation.
.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.