.\" 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-09-18" "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. (texconfig continues to be included and supported, but tlmgr is now preferred.) .PP The most up-to-date version of this documentation is on the Internet at . .SH "OPTIONS" .IX Header "OPTIONS" The following options have to be given \fIbefore\fR you specify the action. .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 \s-1LC_MESSAGES\s0). If that fails you can select a different language by giving this option a two-letter language code. .PP The standard options are also accepted: \fB\-\-help/\-h/\-?\fR, \fB\-\-version\fR, \&\fB\-q\fR (no informational messages), \fB\-v\fR (debugging messages, can be repeated). For the details about the latter, see the TeXLive::TLUtils documentation. .PP The \fB\-\-version\fR option shows version information about the TeX Live release as well as the \fBtlmgr\fR script itself. .SH "ACTIONS" .IX Header "ACTIONS" .IP "\fBhelp\fR" 4 .IX Item "help" Gives this help information (same as \fB\-\-help\fR). .IP "\fBversion\fR" 4 .IX Item "version" Gives version information (same as \fB\-\-version\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 all \fIpkg\fRs given on the command line. By default this installs all packages that the given \fIpkg\fRs are dependent on, also. Options: .RS 4 .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\-\-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 "\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. Options: .RS 4 .IP "\fB\-\-list\fR" 4 .IX Item "--list" List the packages which would be updated or newly installed. .IP "\fB\-\-all\fR" 4 .IX Item "--all" Update all packages. .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. (A more verbose report than \f(CW\*(C`\-\-list\*(C'\fR.) .IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4 .IX Item "--backupdir directory" If this option is given it must specify an existing directory where a snapshot of the current package as installed will be saved before the packages is updated. This way one can go back in case an update turned out as not working. See the action \fBrestore\fR for details. .RE .RS 4 .RE .IP "\fBbackup\fR \-\-backupdir \fIdir\fR [\fB\-\-all\fR] [\fIpkg\fR...]" 4 .IX Item "backup --backupdir dir [--all] [pkg...]" Makes a backup of the given packages (or all packages with \fB\-\-all\fR) to the directory specified with \fB\-\-backupdir\fR (must exist and be a writable). .Sp Warning: Making a backup of \fIall\fR packages will need quite some space and time. .Sp Options: .RS 4 .IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4 .IX Item "--backupdir directory" The \fIdirectory\fR is an obligatory argument and has to specify a directory where backups are to be found. .IP "\fB\-\-all\fR" 4 .IX Item "--all" Make a backup of all packages in the TeX Live installation. .RE .RS 4 .RE .IP "\fBrestore \-\-backupdir\fR \fIdir\fR [\fIpkg\fR [\fIrev\fR]]" 4 .IX Item "restore --backupdir dir [pkg [rev]]" If no \fIpkg\fR and \fIrev\fR is 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 The option \fB\-\-backupdir\fR \fIdir\fR is obligatory and has to specify a directory with backups. .Sp Options: .RS 4 .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 directory\fR" 4 .IX Item "--backupdir directory" This is an obligatory argument and has to specify a directory where backups are to be found. .RE .RS 4 .RE .IP "\fBremove [\f(BIoption\fB]... \f(BIpkg\fB...\fR" 4 .IX Item "remove [option]... pkg..." Remove all \fIpkg\fRs given on the command line. Removing a collection will remove 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. .Sp Removing a package which is referenced as a dependency in another collection or scheme is disallowed, unless \f(CW\*(C`\-\-force\*(C'\fR is specified. .Sp Options: .RS 4 .IP "\fB\-\-no\-depends\fR" 4 .IX Item "--no-depends" Do not remove dependent packages. .IP "\fB\-\-force\fR" 4 .IX Item "--force" By default, 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 option, the package will be removed unconditionally. Use with care. .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. .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 settings currently saved in the \s-1TLPDB\s0. .Sp In the second form, if \fIvalue\fR is missing 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). .Sp Perhaps the most common use for this 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. .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|papersize|\-\-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 in one go, or just for the specified program. The last form with \fB\-\-list\fR outputs all known papersizes for the specified program. .IP "\fBarch list\fR" 4 .IX Item "arch list" Prints the names of the architectures (\f(CW\*(C`i386\-linux\*(C'\fR, ...) available at the default install location. .IP "\fBarch add \f(BIarch\fB...\fR" 4 .IX Item "arch add arch..." Add executables for each given architecture \fIarch\fR to the installation. Options: .RS 4 .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. .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" 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. .RE .RS 4 .RE .IP "\fBshow \f(BIpkg\fB...\fR" 4 .IX Item "show 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. .IP "\fBlist [collections|schemes]\fR" 4 .IX Item "list [collections|schemes]" 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 an argument lists only collections or schemes, as requested. .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" 4 .IX Item "files" Checks that all files listed in the TeX Live Database (texlive.tlpdb) are actually present, and lists those missing. .Sp Note that on Windows that will not work currently, since Windows does not ship find. Also MacOS seems to ship a strange find implementation that does not support \-wholename, so that will break, too. .IP "\fBcollections\fR" 4 .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" 4 .IX Item "-use-svn" Use svn status instead of listing the files. .RE .RS 4 .RE .IP "\fBuninstall\fR" 4 .IX Item "uninstall" Uninstalls the entire TeX Live installation. Options: .RS 4 .IP "\fB\-\-force\fR" 4 .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" 4 .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 really 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`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.cnf\*(C'\fR) .RE .SH "AUTHORS AND COPYRIGHT" .IX Header "AUTHORS AND COPYRIGHT" This script and its documentation were written for the TeX Live distribution () and both are licensed under the \&\s-1GNU\s0 General Public License Version 2 or later.