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 "2008-12-14" "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 have to be given \fIbefore\fR you specify
the main action to perform.  In all cases, \f(CW\*(C`\-\-\*(C'\fR\fIoption\fR and
\&\f(CW\*(C`\-\*(C'\fR\fIoption\fR are equivalent.
.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).
.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\-\-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.
.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.
.SH "ACTIONS"
.IX Header "ACTIONS"
.IP "\fBhelp\fR" 4
.IX Item "help"
Gives this help information (same as \f(CW\*(C`\-\-help\*(C'\fR).
.IP "\fBversion\fR" 4
.IX Item "version"
Gives version information (same as \f(CW\*(C`\-\-version\*(C'\fR).
.IP "\fBgui\fR" 4
.IX Item "gui"
Start the graphical user interface.
.IP "\fBinstall\fR [\fIoption\fR]... \fIpkg\fR..." 4
.IX Item "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:
.RS 4
.IP "\fB\-\-reinstall\fR" 8
.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" 8
.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" 8
.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" 8
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
written to the terminal.
.IP "\fB\-\-force\fR" 8
.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.
.RE
.RS 4
.RE
.IP "\fBupdate\fR [\fIoption\fR] [\fIpkg\fR]..." 4
.IX Item "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:
.RS 4
.IP "\fB\-\-all\fR" 8
.IX Item "--all"
Update all installed packages.  For packages contained in an installed
collection, also install new packages and remove deleted packages in
those collections.  Packages not contained in an installed collection
are not considered for addition or removal.
.Sp
More precisely, if both the server and the local installation have a
collection C, and C on the server contains a package A that is not
present locally, A will be added.  Conversely, if the local collection C
contains a package B, but B is no longer in the server's C, then B will
be deleted.
.IP "\fB\-\-list\fR" 8
.IX Item "--list"
Concisely list the packages which would be updated, newly installed, or
removed, without actually changing anything.
.IP "\fB\-\-dry\-run\fR" 8
.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" 8
.IX Item "--force"
If updates to the tlmgr itself (and the underlying infrastructure) are 
present tlmgr will bail out and not perform the update unless this option
is given (or \fB\-\-list\fR is given).
.IP "\fB\-\-no\-remove\fR" 8
.IX Item "--no-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\-\-backup\fR and \fB\-\-backupdir\fR \fIdirectory\fR" 8
.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" 8
.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" 8
.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.
.RE
.RS 4
.Sp
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.
.RE
.IP "\fBbackup\fR [\-\-clean[=\fIN\fR]] [\-\-backupdir \fIdir\fR] [\fB\-\-all\fR] [\fIpkg\fR]..." 4
.IX Item "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.
.Sp
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 \fBautobackup\fR option from 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.
.Sp
Options:
.RS 4
.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 8
.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" 8
.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]" 8
.IX Item "--clean[=N]"
Instead of making backups, prune the backup directory of old backups.
.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
Nothing is actually backed up or removed; instead, the actions to be 
performed are written to the terminal. 
.RE
.RS 4
.RE
.IP "\fBrestore \-\-backupdir\fR \fIdir\fR [\fIpkg\fR [\fIrev\fR]]" 4
.IX Item "restore --backupdir dir [pkg [rev]]"
Restore a package from a previously-made backup.
.Sp
If neither \fIpkg\fR nor \fIrev\fR are given, list the available backup
revisions for all packages.
.Sp
With \fIpkg\fR given but no \fIrev\fR, list all available backup revisions of
\&\fIpkg\fR.
.Sp
With both \fIpkg\fR and \fIrev\fR, tries to restore the package from the
specified backup.
.Sp
Options:
.RS 4
.IP "\fB\-\-dry\-run\fR" 8
.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" 8
.IX Item "--backupdir directory"
Specify the directory where the backups are to be found.
.RE
.RS 4
.RE
.IP "\fBremove\fR [\fIoption\fR]... \fIpkg\fR..." 4
.IX Item "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:
.RS 4
.IP "\fB\-\-no\-depends\fR" 8
.IX Item "--no-depends"
Do not remove dependent packages.
.IP "\fB\-\-no\-depends\-at\-all\fR" 8
.IX Item "--no-depends-at-all"
See above under \fBaction\fR (and beware).
.IP "\fB\-\-force\fR" 8
.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.
.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
Nothing is actually removed; instead, the actions to be performed are
written to the terminal.
.RE
.RS 4
.RE
.IP "\fBoption [show]\fR" 4
.IX Item "option [show]"
.PD 0
.IP "\fBoption \f(BIkey\fB [\f(BIvalue\fB]\fR" 4
.IX Item "option key [value]"
.PD
The first form shows the global TeX Live settings currently saved in the
\&\s-1TLPDB\s0.
.Sp
In the second 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.
.Sp
Possible values for \fIkey\fR are:
 \f(CW\*(C`location\*(C'\fR (default installation location),
 \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),
 \f(CW\*(C`backupdir\*(C'\fR (default directory for backups),
 \f(CW\*(C`autobackup\*(C'\fR (number of backups to keep).
.Sp
Perhaps the most 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
.Sp
.Vb 1
\& tlmgr option location http://mirror.ctan.org/systems/texlive/tlnet/YYYY
.Ve
.Sp
where \s-1YYYY\s0 is the TeX Live release year.
.Sp
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).
.Sp
The \f(CW\*(C`autobackup\*(C'\fR option (de)activates the automatic generation of
backups. Its value is an integer.  If \f(CW\*(C`autobackup\*(C'\fR is \f(CW\*(C`\-1\*(C'\fR, backups
will not be removed by default.  If \f(CW\*(C`autobackup\*(C'\fR is 0 or positive, it
specifies the number of backups to be kept.  Thus, backups are disabled
with 0 as the values.
.Sp
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.
.IP "\fBpaper a4\fR" 4
.IX Item "paper a4"
.PD 0
.IP "\fBpaper letter\fR" 4
.IX Item "paper letter"
.IP "\fB[xdvi|dvips|pdftex|dvipdfm|dvipdfmx|context] paper [help|\f(BIpapersize\fB|\-\-list]\fR" 4
.IX Item "[xdvi|dvips|pdftex|dvipdfm|dvipdfmx|context] paper [help|papersize|--list]"
.PD
Configures the system wide paper settings, either for all programs at
once (first two forms), or just for the specified program (third
form). The third form with \f(CW\*(C`\-\-list\*(C'\fR outputs all known papersizes for the
specified program.
.IP "\fBarch list|add\fR \fIarch\fR..." 4
.IX Item "arch list|add 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.
.Sp
\&\f(CW\*(C`arch add\*(C'\fR \fIarch\fR adds the executables for each given architecture
\&\fIarch\fR to the installation.  Options:
.RS 4
.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
written to the terminal.
.RE
.RS 4
.RE
.IP "\fBsearch [\f(BIoption\fB]... \f(BIwhat\fB\fR" 4
.IX Item "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:
.RS 4
.IP "\fB\-\-file\fR" 8
.IX Item "--file"
List all filenames containing \fIwhat\fR.
.IP "\fB\-\-global\fR" 8
.IX Item "--global"
Search the TeX Live Database of the installation medium, instead of the
local installation.
.RE
.RS 4
.RE
.IP "\fBshow [\-\-list] \f(BIpkg\fB...\fR" 4
.IX Item "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.
.Sp
If the option \fB\-\-list\fR is given the list of contained files is also
shown, including those for architecture specific dependencies.
.IP "\fBlist [collections|schemes|\f(BIpkg\fB...]\fR" 4
.IX Item "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.
.Sp
With the single word \f(CW\*(C`collections\*(C'\fR or \f(CW\*(C`schemes\*(C'\fR as the argument, lists
the request type.
.Sp
With anything else as arguments, operates as the \f(CW\*(C`show\*(C'\fR action.
.IP "\fBcheck [\f(BIoption\fB]... [files|collections|all]\fR" 4
.IX Item "check [option]... [files|collections|all]"
Executes one (or all) check(s) on the consistency of the installation.
.RS 4
.IP "\fBfiles\fR" 8
.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 "\fBcollections\fR" 8
.IX Item "collections"
Lists those packages which occur as dependencies in an installed collections,
but are themselves not installed.
.RE
.RS 4
.Sp
Available options are:
.IP "\fB\-\-use\-svn\fR" 8
.IX Item "--use-svn"
Use svn status instead of listing the files, for checking the
development repository.
.RE
.RS 4
.RE
.IP "\fBuninstall\fR" 4
.IX Item "uninstall"
Uninstalls the entire TeX Live installation.  Options:
.RS 4
.IP "\fB\-\-force\fR" 8
.IX Item "--force"
Do not ask for confirmation, remove immediately.
.RE
.RS 4
.RE
.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
The \fIgenerate\fR action overwrites any manual changes made in the
respective files: it recreates them from scratch.
.Sp
For fmtutil 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.
.Sp
For updmap, however, neither the installer nor \f(CW\*(C`tlmgr\*(C'\fR use \fIgenerate\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.
.Sp
On the other hand, if you only use the fonts and font packages within
TeX Live, there is nothing wrong with using \fIgenerate updmap\fR.  Indeed,
we use it to generate the \f(CW\*(C`updmap.cfg\*(C'\fR file that is maintained in the
live source repository.
.Sp
In more detail: \fIgenerate\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.
.Sp
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.
.Sp
Options:
.RS 4
.IP "\fB\-\-dest\fR \fIoutput file\fR" 8
.IX Item "--dest output file"
specifies the output file (defaults to the respective location in
\&\f(CW\*(C`TEXMFSYSVAR\*(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" 8
.IX Item "--localcfg local conf file"
specifies the (optional) local additions (defaults to the respective
location in \f(CW\*(C`TEXMFSYSVAR\*(C'\fR).
.RE
.RS 4
.Sp
The respective locations are as follows:
  \f(CW\*(C`tex/generic/config/language.dat\*(C'\fR (and \f(CW\*(C`language\-local.dat\*(C'\fR)
  \f(CW\*(C`tex/generic/config/language.def\*(C'\fR (and \f(CW\*(C`language\-local.def\*(C'\fR)
  \f(CW\*(C`web2c/fmtutil.cnf\*(C'\fR (and \f(CW\*(C`fmtutil\-local.cnf\*(C'\fR)
  \f(CW\*(C`web2c/updmap.cfg\*(C'\fR (and \f(CW\*(C`updmap\-local.cfg\*(C'\fR)
.RE
.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.