path: root/Master/texmf/doc/man/man1/tlmgr.1

.\" 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 "TLMGR 1"
.TH TLMGR 1 "2009-08-13" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
tlmgr \- the TeX Live Manager
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
tlmgr [\fIoption\fR]... \fIaction\fR [\fIoption\fR]... [\fIoperand\fR]...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBtlmgr\fR manages an existing TeX Live installation, both packages and
configuration options.  It performs many of the same actions as
\&\fBtexconfig\fR(1), and more besides.  (\f(CW\*(C`texconfig\*(C'\fR continues to be
included and supported, but \f(CW\*(C`tlmgr\*(C'\fR is now preferred.)
.PP
The most up-to-date version of this documentation is available at
<http://tug.org/texlive/tlmgr.html>, along with procedures for updating
tlmgr itself, disaster recovery when it's broken, and test versions.
.SH "OPTIONS"
.IX Header "OPTIONS"
The following options to \f(CW\*(C`tlmgr\*(C'\fR are global options not specific to
any action. Although we present \f(CW\*(C`tlmgr\*(C'\fR invocation in the above order,
all options can be given at any place and in arbitrary order. The first
non-option argument will be the main action.
In all cases, \f(CW\*(C`\-\-\*(C'\fR\fIoption\fR and
\&\f(CW\*(C`\-\*(C'\fR\fIoption\fR are equivalent, and an \f(CW\*(C`=\*(C'\fR is optional between an option
name and its value.
.IP "\fB\-\-location\fR \fIlocation\fR" 4
.IX Item "--location location"
Specifies the location from which packages should be installed or
updated, overriding the location found in the installation's TeX Live
Package Database (\s-1TLPDB\s0).  The documentation for \f(CW\*(C`install\-tl\*(C'\fR has more
details about this.
.IP "\fB\-\-gui\fR [\fIaction\fR]" 4
.IX Item "--gui [action]"
You can give this option together with an action to be brought directly
into the respective screen of the \s-1GUI\s0.  For example, running
.Sp
.Vb 1
\&  tlmgr --gui update
.Ve
.Sp
starts you directly at the update screen.
.IP "\fB\-\-gui\-lang\fR \fIllcode\fR" 4
.IX Item "--gui-lang llcode"
Normally the \s-1GUI\s0 tries to deduce your language from the environment (on
Windows via the registry, on Unix via \f(CW\*(C`LC_MESSAGES\*(C'\fR). If that fails you
can select a different language by giving this option a two-letter
language code.
.IP "\fB\-\-machine\-readable\fR" 4
.IX Item "--machine-readable"
In lieu of the normal output intended for human consumption, write to
standard output in a fixed format more suitable for machine parsing.
See the \*(L"\s-1MACHINE\-READABLE\s0 \s-1OUTPUT\s0\*(R" section below for details.
.IP "\fB\-\-package\-logfile\fR \fIfile\fR" 4
.IX Item "--package-logfile file"
\&\fBtlmgr\fR logs all package actions (install, remove, update, failed
updates, failed restores) to a separate log file, by default
\&\f(CW\*(C`TEXMFSYSVAR/web2c/tlmgr.log\*(C'\fR. This option allows you to select a
different file for that.  This is separate from normal logging; for
that, see the option \f(CW\*(C`\-v\*(C'\fR below, and TeXLive::TLUtils.
.IP "\fB\-\-pause\fR" 4
.IX Item "--pause"
This option make \fBtlmgr\fR wait for user input before exiting.  Useful on
Windows to avoid command windows disappearing.
.IP "\fB\-debug\-translation\fR" 4
.IX Item "-debug-translation"
This switch will make tlmgr report any missing or probably 
untranslated messages in \s-1GUI\s0 mode to \s-1STDERR\s0.
.PP
The standard options for TeX Live programs are also accepted:
\&\f(CW\*(C`\-\-help/\-h/\-?\*(C'\fR, \f(CW\*(C`\-\-version\*(C'\fR, \f(CW\*(C`\-q\*(C'\fR (no informational messages), \f(CW\*(C`\-v\*(C'\fR
(debugging messages, can be repeated).  For the details about these, see
the TeXLive::TLUtils documentation.
.PP
The \f(CW\*(C`\-\-version\*(C'\fR option shows version information about the TeX Live
release as well as the \f(CW\*(C`tlmgr\*(C'\fR script itself. If paired with \f(CW\*(C`\-v\*(C'\fR,
revision number for the used TeX Live Perl modules are shown, too.
.SH "ACTIONS"
.IX Header "ACTIONS"
.Sh "help"
.IX Subsection "help"
Gives this help information (same as \f(CW\*(C`\-\-help\*(C'\fR).
.Sh "version"
.IX Subsection "version"
Gives version information (same as \f(CW\*(C`\-\-version\*(C'\fR).
.PP
If \fB\-v\fR has been given the revisions of the used modules are reported, too.
.Sh "gui"
.IX Subsection "gui"
Start the graphical user interface.
.Sh "install [\fIoption\fP]... \fIpkg\fP..."
.IX Subsection "install [option]... pkg..."
Install each \fIpkg\fR given on the command line. By default this installs
all packages on which the given \fIpkg\fRs are dependent, also.  Options:
.IP "\fB\-\-reinstall\fR" 4
.IX Item "--reinstall"
Reinstall a package (including dependencies for collections) even if it
seems to be already installed (i.e, is present in the \s-1TLPDB\s0).  This is
useful to recover from accidental removal of files in the hierarchy.
.Sp
When re\-installing, only dependencies on normal packages are followed
(not those of category Scheme or Collection).
.IP "\fB\-\-no\-depends\fR" 4
.IX Item "--no-depends"
Do not install dependencies.  (By default, installing a package ensures
that all dependencies of this package are fulfilled.)
.IP "\fB\-\-no\-depends\-at\-all\fR" 4
.IX Item "--no-depends-at-all"
When you install a package which ships binary files the respective binary
package will also be installed. (So for package bin-foobar also the package
bin\-foobar.i386\-linux will be installed on an i386\-linux system.)
This switch supresses this behaviour, and also implies \f(CW\*(C`\-\-no\-depends\*(C'\fR.
Don't use it unless you are sure of what you are doing.
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
written to the terminal.
.IP "\fB\-\-force\fR" 4
.IX Item "--force"
If updates to the tlmgr itself (and the underlying infrastructure) are
present tlmgr will bail out and not perform the installation unless this option
is given.
.Sh "update [\fIoption\fP]... [\fIpkg\fP]..."
.IX Subsection "update [option]... [pkg]..."
Updates the packages given as arguments to the latest version available
at the installation source.  Either \f(CW\*(C`\-\-all\*(C'\fR or at least one \fIpkg\fR name
must be specified.  Options:
.IP "\fB\-\-all\fR" 4
.IX Item "--all"
Update all installed packages except for tlmgr itself.
.Sp
In case that updates to tlmgr itself are present this will not work
unless also the option \fB\-\-force\fR or \fB\-\-self\fR is given.
.Sp
Besides updating the installed packages, during the update of a
collection the contained packages are syncronized to the status
of the new version of the collection. That means that if a package
has been removed on the server (and thus has also been removed from 
the respective collection), tlmgr will remove the package also on
the local installation. This is called \fBauto-remove\fR and is announced
as such when using the option \fB\-\-list\fR. The auto-removal can be 
suppressed using the option \fB\-\-no\-auto\-remove\fR.
.Sp
On the other hand, if a package has been added to an installed
collection, it will be added to the local installation. This is called
\&\fBauto-install\fR and is announced as such when using the option
\&\fB\-\-list\fR. The auto-installation can be suppressed using the option
\&\fB\-\-no\-auto\-install\fR.
.Sp
An exception to the collection dependency checks (including
auto-installation of packages as mentionned above) are those that have
been forcibly removed (see the action \fBremove\fR for details). To
include, or better reinstall, those forcibly removed package use
\&\fB\-\-reinstall\-forcibly\-removed\fR.
.IP "\fB\-\-self\fR" 4
.IX Item "--self"
Update tlmgr itself (that is, the infrastructure packages) if updates 
are present. On Windows this includes updates to the perl interpreter 
shipped by TeX Live.
.Sp
If this option is given together with \fB\-\-all\fR or a list of packages
then tlmgr will be updated first and, if this update succeeds, it will
be restarted to complete the rest of the updates.
.IP "\fB\-\-list\fR" 4
.IX Item "--list"
Concisely list the packages which would be updated, newly installed, or
removed, without actually changing anything.
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
written to the terminal.  This is a more detailed report than \f(CW\*(C`\-\-list\*(C'\fR.
.IP "\fB\-\-force\fR" 4
.IX Item "--force"
Force update of packages even if updates to tlmgr itself are present.
Updates to tlmgr are not performed unless \fB\-\-self\fR option is also given.
(\f(CW\*(C`\-\-list\*(C'\fR is still performed regardless of this option.)
.IP "\fB\-\-no\-auto\-remove\fR" 4
.IX Item "--no-auto-remove"
Under normal circumstances tlmgr tries to remove packages which have
disappeared on the server when called with \f(CW\*(C`\-\-all\*(C'\fR, as described
above. This prevents any such removals.
.IP "\fB\-\-no\-auto\-install\fR" 4
.IX Item "--no-auto-install"
Under normal circumstances tlmgr will install packages which are
new on the server when called with \f(CW\*(C`\-\-all\*(C'\fR. This prevents any such
automatic installation. Note that after this the packages that
would have been auto-installed will be considered as
forcibly removed. Actually, if `foobar' is the only new package on
server, then
.Sp
.Vb 1
\&  tlmgr update --all --no-auto-install
.Ve
.Sp
is equivalent to
.Sp
.Vb 2
\&  tlmgr update --all
\&  tlmgr remove --force foobar
.Ve
.IP "\fB\-\-reinstall\-forcibly\-removed\fR" 4
.IX Item "--reinstall-forcibly-removed"
Under normal circumstances tlmgr will not install packages that it
considers forcibly removed (that is, removed with `remove \-\-force' or
whose installation was prohibited by \-\-no\-auto\-install during an
earlier update). This option makes tlmgr consider all these packages
as new and re-install them. This can be used to syncronize an
installation with the server's idea of what is available by calling
.Sp
.Vb 1
\&  tlmgr update --reinstall-forcibly-removed --all
.Ve
.IP "\fB\-\-backup\fR and \fB\-\-backupdir\fR \fIdirectory\fR" 4
.IX Item "--backup and --backupdir directory"
These two options control the creation of backups of packages before an
update is started; that is, the backup is of the package as it's
installed.  If neither of the two are given, no backup package will be
saved. If \fB\-\-backupdir\fR is given and specifies a writable directory
then a backup will be made in that location. If only \fB\-\-backup\fR is
given, then a backup will be made to the directory previously set via
the \f(CW\*(C`option\*(C'\fR action (see below). If both are given then a backup will
be made to the specified \fIdirectory\fR.
.Sp
You can set options via the \f(CW\*(C`option\*(C'\fR action to automatically create
backups for all packages, and/or keep only a certain number of
backups. Please see the \f(CW\*(C`option\*(C'\fR action for details.
.Sp
\&\f(CW\*(C`tlmgr\*(C'\fR always makes a temporary backup when updating packages, in case
of download or other failure during an update.  The purpose of this
\&\fB\-\-backup\fR option is to allow you to save a persistent backup in case
the actual \fIcontent\fR of the update causes problems, e.g., introduces an
incompatibility.
.Sp
The \f(CW\*(C`restore\*(C'\fR action explains how to restore from a backup.
.IP "\fB\-\-no\-depends\fR" 4
.IX Item "--no-depends"
If you call for updating a package normally all depending packages
will also be checked for updates and updated if necessary. This switch
supresses this behaviour.
.IP "\fB\-\-no\-depends\-at\-all\fR" 4
.IX Item "--no-depends-at-all"
By default, when you update a package which ships binary files the
respective binary package will also be updated.  That is, for an update
of a package \f(CW\*(C`foo\*(C'\fR, the package \f(CW\*(C`foobar.i386\-linux\*(C'\fR will also be
updated if the i386\-linux platform is installed.  This option suppresses
this behaviour, and implies \f(CW\*(C`\-\-no\-depends\*(C'\fR.  Don't use it unless you
are sure of what you are doing.
.PP
If the package on the server is older than the package already installed
(e.g., if the selected mirror is out of date), \f(CW\*(C`tlmgr\*(C'\fR does not
downgrade.  Also, packages for uninstalled platforms are not installed.
.Sh "backup [\-\-clean[=\fIN\fP]] [\-\-backupdir \fIdir\fP] [\-\-all] [\fIpkg\fP]..."
.IX Subsection "backup [--clean[=N]] [--backupdir dir] [--all] [pkg]..."
If the \fB\-\-clean\fR option is not specified, this action makes a backup of
the given packages, or all packages given \f(CW\*(C`\-\-all\*(C'\fR. These backups are
saved to the value of \fB\-\-backupdir\fR option if that is an existing and
writable directory; if \fB\-\-backupdir\fR is not given, the \f(CW\*(C`backupdir\*(C'\fR
option setting in the \s-1TLPDB\s0 is used, if present.  If both are missing,
no backups are made.
.PP
If the \fB\-\-clean\fR option is specified, backups are cleaned (pruned)
instead of made.  If the value for the \fB\-\-clean\fR switch is not given,
the value of the \f(CW\*(C`autobackup\*(C'\fR option is used. If both are missing,
an error is issued.  For the details of backup cleaning, see the
\&\f(CW\*(C`option\*(C'\fR action below.
.PP
Options:
.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4
.IX Item "--backupdir directory"
The \fIdirectory\fR argument is required and must specify an existing
directory where backups are to be placed.
.IP "\fB\-\-all\fR" 4
.IX Item "--all"
Make a backup of all packages in the TeX Live installation.  This will
take quite a lot of space and time.
.IP "\fB\-\-clean\fR[=\fIN\fR]" 4
.IX Item "--clean[=N]"
Instead of making backups, prune the backup directory of old backups.
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
Nothing is actually backed up or removed; instead, the actions to be
performed are written to the terminal.
.Sh "restore \-\-backupdir \fIdir\fP [\fIpkg\fP [\fIrev\fP]"
.IX Subsection "restore --backupdir dir [pkg [rev]"
Restore a package from a previously-made backup.
.PP
If neither \fIpkg\fR nor \fIrev\fR are given, list the available backup
revisions for all packages.
.PP
With \fIpkg\fR given but no \fIrev\fR, list all available backup revisions of
\&\fIpkg\fR.
.PP
With both \fIpkg\fR and \fIrev\fR, tries to restore the package from the
specified backup.
.PP
Options:
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
Nothing is actually restored; instead, the actions to be performed are
written to the terminal.
.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4
.IX Item "--backupdir directory"
Specify the directory where the backups are to be found.
.Sh "remove [\fIoption\fP]... \fIpkg\fP..."
.IX Subsection "remove [option]... pkg..."
Remove each \fIpkg\fR specified.  Removing a collection removes all package
dependencies, but not collection dependencies, in that collection
(unless \f(CW\*(C`\-\-no\-depends\*(C'\fR is specified).  However, when removing a
package, dependencies are never removed.  Options:
.IP "\fB\-\-no\-depends\fR" 4
.IX Item "--no-depends"
Do not remove dependent packages.
.IP "\fB\-\-no\-depends\-at\-all\fR" 4
.IX Item "--no-depends-at-all"
See above under \fBaction\fR (and beware).
.IP "\fB\-\-force\fR" 4
.IX Item "--force"
By default, removal of a package or collection that is a dependency of
another collection or scheme is not allowed.  With this option, the
package will be removed unconditionally.  Use with care.
.Sp
A package that has been removed using the \fB\-\-force\fR switch because
it is still listed in an installed collection or scheme will not be
update and mentioned as \fBforcibly removed\fR in the output of
\&\fBtlmgr update \-\-list\fR.
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
Nothing is actually removed; instead, the actions to be performed are
written to the terminal.
.Sh "option"
.IX Subsection "option"
.IP "\fBoption [show]\fR" 4
.IX Item "option [show]"
.PD 0
.IP "\fBoption showall\fR" 4
.IX Item "option showall"
.IP "\fBoption \f(BIkey\fB [\f(BIvalue\fB]\fR" 4
.IX Item "option key [value]"
.PD
.PP
The first form shows the global TeX Live settings currently saved in the
\&\s-1TLPDB\s0 with a short description and the \f(CW\*(C`key\*(C'\fR used for changing it in
paranthesis.
.PP
The second form acts like the first, but also shows options which can
be defined but are not currently set to any value.
.PP
In the third form, if \fIvalue\fR is not given, the setting for \fIkey\fR is
displayed.  If \fIvalue\fR is present, \fIkey\fR is set to \fIvalue\fR.
.PP
Possible values for \fIkey\fR are (but see \fBtlmgr option showall\fR for
the definitive list):
.PP
.Vb 9
\& location (default installation location),
\& formats (create formats at installation time),
\& docfiles (install documentation files),
\& srcfiles (install source files),
\& backupdir (default directory for backups),
\& autobackup (number of backups to keep).
\& sys_bin (location where binaries are linked to by action path)
\& sys_man (location where man pages are linked to by action path)
\& sys_info (location where info pages are linked to by action path)
.Ve
.PP
One common use of \f(CW\*(C`option\*(C'\fR is if you originally installed from \s-1DVD\s0, and
want to permanently change the installation to get further updates from
the Internet.  To do this, you can run
.PP
.Vb 1
\& tlmgr option location http://mirror.ctan.org/systems/texlive/tlnet
.Ve
.PP
The \f(CW\*(C`install\-tl\*(C'\fR documentation has more information about these
locations.
.PP
The two options \f(CW\*(C`autobackup\*(C'\fR and \f(CW\*(C`backupdir\*(C'\fR determine defaults for
the \f(CW\*(C`update\*(C'\fR, \f(CW\*(C`backup\*(C'\fR and \f(CW\*(C`restore\*(C'\fR actions.  These three actions
need a directory to write to or read from the backups.  If
\&\f(CW\*(C`\-\-backupdir\*(C'\fR is not specified on the command line, the \f(CW\*(C`backupdir\*(C'\fR
option value is used (if set).
.PP
The \f(CW\*(C`autobackup\*(C'\fR option (de)activates automatic generation of backups.
Its value is an integer.  If the \f(CW\*(C`autobackup\*(C'\fR value is \f(CW\*(C`\-1\*(C'\fR, no
backups are removed.  If \f(CW\*(C`autobackup\*(C'\fR is 0 or more, it specifies the
number of backups to keep.  Thus, backups are disabled if the value is
0.  In the \f(CW\*(C`\-\-clean\*(C'\fR mode of the \f(CW\*(C`backup\*(C'\fR action this option also
specifies the number to be kept.
.PP
To setup \f(CW\*(C`autobackup\*(C'\fR to \f(CW\*(C`\-1\*(C'\fR on the command line, use
.PP
.Vb 1
\&  tlmgr option autobackup infty
.Ve
.PP
Or you can use:
.PP
.Vb 1
\&  tlmgr option -- autobackup -1
.Ve
.PP
The \f(CW\*(C`\-\-\*(C'\fR avoids having the \f(CW\*(C`\-1\*(C'\fR treated as an option.  (In general,
\&\f(CW\*(C`\-\-\*(C'\fR stops parsing for arguments at the point where it appears; this is
a general feature of option parsing.)
.Sh "conf"
.IX Subsection "conf"
This option to tlmgr mimicks the \fBtexconfig conf\fR call, but works on
all supported platforms.
.Sh "path [\-\-w32mode=user|admin] [add|remove]"
.IX Subsection "path [--w32mode=user|admin] [add|remove]"
On unix adds or removes symlinks for binaries, man pages, and info pages
in the directories specified by the respective options (see above).
.PP
On W32 based systems the registry part where the binary directory is
added or removed is determined in the following way:
.PP
If the user has admin rights, and the option \fB\-\-w32mode\fR is not given,
the setting \fIw32_multi_user\fR determines the location (i.e., if it is
on then the system path, otherwise the user path is changed).
.PP
If the user has admin rights, and the option \fB\-\-w32mode\fR is given, this
option determines the path to be adjusted.
.PP
If the user does not have admin rights, and the option \fB\-\-w32mode\fR
is not given, and the setting \fIw32_multi_user\fR is off, the user path
is changed, while if the setting \fIw32_multi_user\fR is on, a warning is
issued that the caller does not have enough privileges.
.PP
If the user does not have admin rights, and the option \fB\-\-w32mode\fR
is given, it must be \fBuser\fR and the user path will be adjusted. If a
user without admin rights uses the option \fB\-\-w32mode admin\fR a warning
is issued that the caller does not have enough provileges.
.Sh "postaction [\-\-w32mode=user|admin] [\-\-fileassocmode=1|2] [\-all] [install|remove] [shortcut|fileassoc|script] [<package> <package> ...]"
.IX Subsection "postaction [--w32mode=user|admin] [--fileassocmode=1|2] [-all] [install|remove] [shortcut|fileassoc|script] [<package> <package> ...]"
Carry out the postaction \f(CW\*(C`shortcut\*(C'\fR, \f(CW\*(C`fileassoc\*(C'\fR, or \f(CW\*(C`script\*(C'\fR as
given as second obligatory argument in install or remove mode (first
obligatory argument), for either the packages given on the command line,
or for all if \f(CW\*(C`\-all\*(C'\fR is given.
.PP
The option \f(CW\*(C`\-\-w32mode\*(C'\fR is \f(CW\*(C`user\*(C'\fR all actions will only carried out in
the user accessible parts of the registry/filesystem, while the \f(CW\*(C`admin\*(C'\fR
mode selects the system wide parts of the registry for the file associations.
Note that if you do not have enough permissions using \f(CW\*(C`\-\-w32mode=admin\*(C'\fR
will not succeed.
.PP
For the postaction \f(CW\*(C`fileassoc\*(C'\fR the mode can be set with <\-\-fileassocmode>.
If it is set to 1, only new assocations are added, if it is set to 2,
all associations are set to the TeX Live programs.
.Sh "paper"
.IX Subsection "paper"
.IP "\fBpaper [a4|letter]\fR" 4
.IX Item "paper [a4|letter]"
.PD 0
.IP "\fBxdvi|pdftex|dvips|dvipdfmx|dvipdfm|context\ paper\ [\f(BIpapersize\fB|\-\-list]\fR" 4
.IX Item "xdvi|pdftex|dvips|dvipdfmx|dvipdfm|contextpaper[papersize|--list]"
.PD
.PP
With no arguments (\f(CW\*(C`tlmgr paper\*(C'\fR), shows the default paper size setting
for all known programs.
.PP
With one argument (e.g., \f(CW\*(C`tlmgr paper a4\*(C'\fR), sets the default for all
known programs to that paper size.
.PP
With a program given as the first argument and no paper size specified
(e.g., \f(CW\*(C`tlmgr dvips paper\*(C'\fR), shows the default paper size for that
program.
.PP
With a program given as the first argument and a paper size as the last
argument (e.g., \f(CW\*(C`tlmgr dvips paper a4\*(C'\fR), set the default for that
program to that paper size.
.PP
With a program given as the first argument and \f(CW\*(C`\-\-list\*(C'\fR given as the
last argument (e.g., \f(CW\*(C`tlmgr dvips paper \-\-list\*(C'\fR), shows all valid paper
sizes for that program.  The first size shown is the default.
.PP
Incidentally, this syntax of having a specific program name before the
\&\f(CW\*(C`paper\*(C'\fR keyword may seem strange.  It is inherited from the
longstanding \f(CW\*(C`texconfig\*(C'\fR script, which supports other configuration
settings for some programs, notably \f(CW\*(C`dvips\*(C'\fR.  \f(CW\*(C`tlmgr\*(C'\fR does not support
those extra settings at present.
.Sh "arch list|add|remove \fIarch\fP..."
.IX Subsection "arch list|add|remove arch..."
\&\f(CW\*(C`arch list\*(C'\fR lists the TeX Live names of all the architectures
(\f(CW\*(C`i386\-linux\*(C'\fR, ...) available at the default install location.
.PP
\&\f(CW\*(C`arch add\*(C'\fR \fIarch\fR... adds the executables for each given architecture
\&\fIarch\fR to the installation. 
.PP
\&\f(CW\*(C`arch remove\*(C'\fR \fIarch\fR... removes the executables for each given 
architecture \fIarch\fR from the installation, but keeps the currently 
running architecture in any case.
.PP
Options:
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
written to the terminal.
.Sh "search [\fIoption\fP]... \fIwhat\fP"
.IX Subsection "search [option]... what"
By default searches the names, short and long descriptions of all
locally installed packages for the given argument (interpreted as
regexp).  Options:
.IP "\fB\-\-file\fR" 4
.IX Item "--file"
List all filenames containing \fIwhat\fR.
.IP "\fB\-\-global\fR" 4
.IX Item "--global"
Search the TeX Live Database of the installation medium, instead of the
local installation.
.Sh "show [\-\-list] \fIpkg\fP..."
.IX Subsection "show [--list] pkg..."
Shows information about \fIpkg\fR: the name, category, installation status,
short and long description.  Searches in the remote installation source
for the package if it is not locally installed.
.PP
If the option \fB\-\-list\fR is given with a package, the list of contained
files is also shown, including those for architecture specific
dependencies.  When given with schemes and collections, \fB\-\-list\fR
outputs their dependencies in a similar way.
.Sh "list [collections|schemes|\fIpkg\fP...]"
.IX Subsection "list [collections|schemes|pkg...]"
With no argument, lists all packages available at the default install
location, prefixing those already installed with \f(CW\*(C`i\*(C'\fR.
.PP
With the single word \f(CW\*(C`collections\*(C'\fR or \f(CW\*(C`schemes\*(C'\fR as the argument, lists
the request type.
.PP
With anything else as arguments, operates as the \f(CW\*(C`show\*(C'\fR action.
.Sh "check [\fIoption\fP]... [files|depends|executes|runfiles|all]"
.IX Subsection "check [option]... [files|depends|executes|runfiles|all]"
Executes one (or all) check(s) on the consistency of the installation.
.IP "\fBfiles\fR" 4
.IX Item "files"
Checks that all files listed in the TeX Live Database (\f(CW\*(C`texlive.tlpdb\*(C'\fR)
are actually present, and lists those missing.
.IP "\fBdepends\fR" 4
.IX Item "depends"
Lists those packages which occur as dependencies in an installed collections,
but are themselves not installed, and those packages that are not
contained in any collection.
.Sp
If you call \f(CW\*(C`tlmgr check collections\*(C'\fR this test will be carried out
instead since former versions for \f(CW\*(C`tlmgr\*(C'\fR called it that way.
.IP "\fBexecutes\fR" 4
.IX Item "executes"
Check that the files referred to by \f(CW\*(C`execute\*(C'\fR directives in the TeX
Live Database are present.
.IP "\fBrunfiles\fR" 4
.IX Item "runfiles"
List those filenames that are occurring more than one time in the runfiles.
.PP
Options:
.IP "\fB\-\-use\-svn\fR" 4
.IX Item "--use-svn"
Use svn status instead of listing the files, for checking the
development repository.
.Sh "uninstall"
.IX Subsection "uninstall"
Uninstalls the entire TeX Live installation.  Options:
.IP "\fB\-\-force\fR" 4
.IX Item "--force"
Do not ask for confirmation, remove immediately.
.Sh "generate [\fIoption\fP]... \fIwhat\fP"
.IX Subsection "generate [option]... what"
.IP "\fBgenerate language\fR" 4
.IX Item "generate language"
.PD 0
.IP "\fBgenerate language.dat\fR" 4
.IX Item "generate language.dat"
.IP "\fBgenerate language.def\fR" 4
.IX Item "generate language.def"
.IP "\fBgenerate fmtutil\fR" 4
.IX Item "generate fmtutil"
.IP "\fBgenerate updmap\fR" 4
.IX Item "generate updmap"
.PD
.PP
The \f(CW\*(C`generate\*(C'\fR action overwrites any manual changes made in the
respective files: it recreates them from scratch.
.PP
For \f(CW\*(C`fmtutil\*(C'\fR and the language files, this is normal, and both the TeX
Live installer and \f(CW\*(C`tlmgr\*(C'\fR routinely call \fIgenerate\fR for them.
.PP
For \f(CW\*(C`updmap\*(C'\fR, however, neither the installer nor \f(CW\*(C`tlmgr\*(C'\fR use
\&\f(CW\*(C`generate\*(C'\fR, because the result would be to disable all maps which have
been manually installed via \f(CW\*(C`updmap\-sys\ \-\-enable\*(C'\fR, e.g., for
proprietary or local fonts.  Only the changes in the \f(CW\*(C`\-\-localcfg\*(C'\fR file
mentioned below are incorporated by \fIgenerate\fR.  Furthermore, \f(CW\*(C`tlmgr\*(C'\fR
updates and maintains the final \f(CW\*(C`updmap.cfg\*(C'\fR in \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR (the
others use \f(CW\*(C`TEXMFSYSVAR\*(C'\fR) because that is the location that
\&\f(CW\*(C`updmap\-sys\*(C'\fR (via \f(CW\*(C`tcfmgr\*(C'\fR) uses.
.PP
Notwithstanding the above, if you only use the fonts and font packages
within TeX Live, and maintain your local fonts (if any) with the local
config file, there is nothing wrong with using \f(CW\*(C`generate updmap\*(C'\fR.
Indeed, we use it ourselves to generate the \f(CW\*(C`updmap.cfg\*(C'\fR file that is
maintained in the live source repository.
.PP
In more detail: \f(CW\*(C`generate\*(C'\fR remakes any of the four config files
\&\f(CW\*(C`language.dat\*(C'\fR, \f(CW\*(C`language.def\*(C'\fR, \f(CW\*(C`fmtutil.cnf\*(C'\fR, and \f(CW\*(C`updmap.cfg\*(C'\fR from
the information present in the local \s-1TLPDB\s0. If the files
\&\f(CW\*(C`language\-local.dat\*(C'\fR, \f(CW\*(C`language\-local.def\*(C'\fR, \f(CW\*(C`fmtutil\-local.cnf\*(C'\fR, or
\&\f(CW\*(C`updmap\-local.cfg\*(C'\fR are present under \f(CW\*(C`TEXMFLOCAL\*(C'\fR in the respective
directories, their contents will be simply merged into the final files,
with no error checking of any kind.
.PP
The form \f(CW\*(C`generate language\*(C'\fR recreates both the \f(CW\*(C`language.dat\*(C'\fR and the
\&\f(CW\*(C`language.def\*(C'\fR files, while the forms with extension only recreates
the given file.
.PP
Options:
.IP "\fB\-\-dest\fR \fIoutput file\fR" 4
.IX Item "--dest output file"
specifies the output file (defaults to the respective location in
\&\f(CW\*(C`TEXMFSYSVAR\*(C'\fR for \f(CW\*(C`language*\*(C'\fR and \f(CW\*(C`fmtutil\*(C'\fR, and \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR
for \f(CW\*(C`updmap\*(C'\fR).  If \fB\-\-dest\fR is given to \f(CW\*(C`generate language\*(C'\fR, its
value will be used for the \f(CW\*(C`language.dat\*(C'\fR output, and \f(CW\*(C`.def\*(C'\fR will be
appended to the value for the name of the \f(CW\*(C`language.def\*(C'\fR output file.
(This is just to avoid overwriting; if you want a specific name for each
output file, we recommend invoking \f(CW\*(C`tlmgr\*(C'\fR twice.)
.IP "\fB\-\-localcfg\fR \fIlocal conf file\fR" 4
.IX Item "--localcfg local conf file"
specifies the (optional) local additions (defaults to the respective
location in \f(CW\*(C`TEXMFLOCAL\*(C'\fR).
.PP
The respective locations are as follows:
.PP
.Vb 4
\&  tex/generic/config/language.dat (and language-local.dat);
\&  tex/generic/config/language.def (and language-local.def);
\&  web2c/fmtutil.cnf (and fmtutil-local.cnf);
\&  web2c/updmap.cfg (and updmap-local.cfg).
.Ve
.Sh "print-arch"
.IX Subsection "print-arch"
Prints out the currently detected architecture.
.SH "MACHINE-READABLE OUTPUT"
.IX Header "MACHINE-READABLE OUTPUT"
Given the \f(CW\*(C`\-\-machine\-readable\*(C'\fR option, \f(CW\*(C`tlmgr\*(C'\fR writes to stdout in the
fixed line-oriented format described here, and the usual informational
messages for human consumption are written to stderr (normally they are
written to stdout).  The idea is that a program can get all the
information it needs by reading stdout.
.PP
Currently this option only applies to the update action.  The output format is as follows:
.PP
.Vb 7
\&  fieldname "\et" value
\&  ...
\&  "end-of-header"
\&  pkgname status localrev serverrev size
\&  ...
\&  "end-of-updates"
\&  other output from post actions, not in machine readable form
.Ve
.PP
Currently the header section contains two fields.  The field name and
value are separated by a tab.  Line endings may be \s-1LF\s0 or \s-1CRLF\s0 depending
on the current platform.
.ie n .IP """location\-url""\fR \fIlocation" 4
.el .IP "\f(CWlocation\-url\fR \fIlocation\fR" 4
.IX Item "location-url location"
The \fIlocation\fR may be a url (including \f(CW\*(C`file:///foo/bar/...\*(C'\fR), or a
directory name (\f(CW\*(C`/foo/bar\*(C'\fR).  It is the server repository from which
the new package information was drawn.
.ie n .IP """total\-bytes""\fR \fIcount" 4
.el .IP "\f(CWtotal\-bytes\fR \fIcount\fR" 4
.IX Item "total-bytes count"
The \fIcount\fR is simply a decimal number, the sum of the sizes of all the
packages that need updating or installing (which are listed subseqently).
.PP
Then comes a line with only the literal string \f(CW\*(C`end\-of\-header\*(C'\fR.
.PP
Each following line until a line with literal string \f(CW\*(C`end\-of\-updates\*(C'\fR
reports on one package.  The fields on
each line are separated by a tab.  Here are the fields.
.IP "\fIpkgname\fR" 4
.IX Item "pkgname"
The TeX Live package identifier, with a possible architecture suffix for
executables.   For instance, \f(CW\*(C`pdftex\*(C'\fR and \f(CW\*(C`pdftex.i386\-linux\*(C'\fR are
given as two separate packages, one on each line.
.IP "\fIstatus\fR" 4
.IX Item "status"
The status of the package update.  One character, as follows:
.RS 4
.ie n .IP """d""" 8
.el .IP "\f(CWd\fR" 8
.IX Item "d"
The package was removed on the server.
.ie n .IP """f""" 8
.el .IP "\f(CWf\fR" 8
.IX Item "f"
The package was removed in the local installation, even though a
collection depended on it.  (E.g., the user ran \f(CW\*(C`tlmgr remove
\&\-\-force\*(C'\fR.)
.ie n .IP """u""" 8
.el .IP "\f(CWu\fR" 8
.IX Item "u"
Normal update is needed.
.ie n .IP """r""" 8
.el .IP "\f(CWr\fR" 8
.IX Item "r"
Reversed non\-update: the locally-installed version is newer than the
version on the server.
.ie n .IP """a""" 8
.el .IP "\f(CWa\fR" 8
.IX Item "a"
Automatically-determined need for installation, the package is new on
the server and is (most probably) part of an installed collection.
.RE
.RS 4
.RE
.IP "\fIlocalrev\fR" 4
.IX Item "localrev"
The revision number of the installed package, or \f(CW\*(C`\-\*(C'\fR if it is not
present locally.
.IP "\fIserverrev\fR" 4
.IX Item "serverrev"
The revision number of the package on the server, or \f(CW\*(C`\-\*(C'\fR if it is not
present on the server.
.IP "\fIsize\fR" 4
.IX Item "size"
The size in bytes of the package on the server.  The sum of all the
package sizes is given in the \f(CW\*(C`total\-bytes\*(C'\fR header field mentioned above.
.PP
If you are developing a program that uses this output, and find that
changes would be helpful, do not hesitate to write the mailing list.
.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.