diff options
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/tlmgr.1')
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/tlmgr.1 | 670 |
1 files changed, 296 insertions, 374 deletions
diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.1 b/Master/texmf-dist/doc/man/man1/tlmgr.1 index e7b5c91c6bb..b2be8f016b9 100644 --- a/Master/texmf-dist/doc/man/man1/tlmgr.1 +++ b/Master/texmf-dist/doc/man/man1/tlmgr.1 @@ -1,4 +1,5 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -15,29 +16,12 @@ .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' +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .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" '' . ds C` . ds C' 'br\} @@ -68,82 +52,20 @@ . \} .\} .rr rF -.\" -.\" 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 "2023-04-08" "perl v5.36.1" "User Contributed Perl Documentation" +.TH TLMGR 1 2023-09-15 "perl v5.38.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh -.SH "NAME" +.SH NAME tlmgr \- the native TeX Live Manager -.SH "SYNOPSIS" +.SH SYNOPSIS .IX Header "SYNOPSIS" tlmgr [\fIoption\fR...] \fIaction\fR [\fIoption\fR...] [\fIoperand\fR...] -.SH "DESCRIPTION" +.SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBtlmgr\fR manages an existing TeX Live installation, both packages and configuration options. For information on initially downloading and @@ -163,7 +85,7 @@ A TeX Live installation can be customized and managed at any level. .PP See <https://tug.org/texlive/doc> for all the TeX Live documentation available. -.SH "EXAMPLES" +.SH EXAMPLES .IX Header "EXAMPLES" After successfully installing TeX Live, here are a few common operations with \f(CW\*(C`tlmgr\*(C'\fR: @@ -175,15 +97,15 @@ with \f(CW\*(C`tlmgr\*(C'\fR: .el .IP "\f(CWtlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet\fR" 4 .IX Item "tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet" .PD -Tell \f(CW\*(C`tlmgr\*(C'\fR to use a nearby \s-1CTAN\s0 mirror for future updates; useful if -you installed TeX Live from the \s-1DVD\s0 image and want to have continuing +Tell \f(CW\*(C`tlmgr\*(C'\fR to use a nearby CTAN mirror for future updates; useful if +you installed TeX Live from the DVD image and want to have continuing updates. The two commands are equivalent; \f(CW\*(C`ctan\*(C'\fR is just an alias for the given url. .Sp Caveat: \f(CW\*(C`mirror.ctan.org\*(C'\fR resolves to many different hosts, and they are not perfectly synchronized; we recommend updating only daily (at most), and not more often. You can choose a particular mirror if -problems; the list of all \s-1CTAN\s0 mirrors with the status of each is at +problems; the list of all CTAN mirrors with the status of each is at <https://ctan.org/mirrors/mirmon>. .ie n .IP """tlmgr update \-\-list""" 4 .el .IP "\f(CWtlmgr update \-\-list\fR" 4 @@ -193,7 +115,7 @@ Report what would be updated without actually updating anything. .el .IP "\f(CWtlmgr update \-\-all\fR" 4 .IX Item "tlmgr update --all" Make your local TeX installation correspond to what is in the package -repository (typically useful when updating from \s-1CTAN\s0). +repository (typically useful when updating from CTAN). .ie n .IP """tlmgr info"" \fIwhat\fR" 4 .el .IP "\f(CWtlmgr info\fR \fIwhat\fR" 4 .IX Item "tlmgr info what" @@ -202,7 +124,7 @@ status and description, of searches for \fIwhat\fR in all packages. .PP For all the capabilities and details of \f(CW\*(C`tlmgr\*(C'\fR, please read the following voluminous information. -.SH "OPTIONS" +.SH OPTIONS .IX Header "OPTIONS" The following options to \f(CW\*(C`tlmgr\*(C'\fR are global options, not specific to any action. All options, whether global or action-specific, can be @@ -215,22 +137,22 @@ between an option name and its value. Specify the package repository from which packages should be installed or updated, either a local directory or network location, as below. This overridesthe default package repository found in the installation's TeX -Live Package Database (a.k.a. the \s-1TLPDB,\s0 which is given entirely in the +Live Package Database (a.k.a. the TLPDB, which is given entirely in the file \f(CW\*(C`tlpkg/texlive.tlpdb\*(C'\fR). .Sp This \f(CW\*(C`\-\-repository\*(C'\fR option changes the location only for the current run; to make a permanent change, use \f(CW\*(C`option repository\*(C'\fR (see the -\&\*(L"option\*(R" action). +"option" action). .Sp -As an example, you can choose a particular \s-1CTAN\s0 mirror with something +As an example, you can choose a particular CTAN mirror with something like this: .Sp .Vb 1 \& \-repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet .Ve .Sp -Of course a real hostname and its particular top-level \s-1CTAN\s0 directory -have to be specified. The list of \s-1CTAN\s0 mirrors is available at +Of course a real hostname and its particular top-level CTAN directory +have to be specified. The list of CTAN mirrors is available at <https://ctan.org/mirrors/mirmon>. .Sp Here's an example of using a local directory: @@ -245,57 +167,57 @@ are accepted as aliases for this option. Locations can be specified as any of the following: .RS 4 .ie n .IP """/some/local/dir""" 4 -.el .IP "\f(CW/some/local/dir\fR" 4 +.el .IP \f(CW/some/local/dir\fR 4 .IX Item "/some/local/dir" .PD 0 .ie n .IP """file:/some/local/dir""" 4 -.el .IP "\f(CWfile:/some/local/dir\fR" 4 +.el .IP \f(CWfile:/some/local/dir\fR 4 .IX Item "file:/some/local/dir" .PD Equivalent ways of specifying a local directory. .ie n .IP """ctan""" 4 -.el .IP "\f(CWctan\fR" 4 +.el .IP \f(CWctan\fR 4 .IX Item "ctan" .PD 0 .ie n .IP """https://mirror.ctan.org/systems/texlive/tlnet""" 4 -.el .IP "\f(CWhttps://mirror.ctan.org/systems/texlive/tlnet\fR" 4 +.el .IP \f(CWhttps://mirror.ctan.org/systems/texlive/tlnet\fR 4 .IX Item "https://mirror.ctan.org/systems/texlive/tlnet" .PD -Pick a \s-1CTAN\s0 mirror automatically, trying for one that is both nearby and +Pick a CTAN mirror automatically, trying for one that is both nearby and up-to-date. The chosen mirror is used for the entire download. The bare \&\f(CW\*(C`ctan\*(C'\fR is merely an alias for the full url. (See <https://ctan.org> for -more about \s-1CTAN\s0 and its mirrors.) +more about CTAN and its mirrors.) .ie n .IP """http://server/path/to/tlnet""" 4 -.el .IP "\f(CWhttp://server/path/to/tlnet\fR" 4 +.el .IP \f(CWhttp://server/path/to/tlnet\fR 4 .IX Item "http://server/path/to/tlnet" -Standard \s-1HTTP.\s0 If the (default) \s-1LWP\s0 method is used, persistent -connections are supported. \s-1TL\s0 can also use \f(CW\*(C`curl\*(C'\fR or \f(CW\*(C`wget\*(C'\fR to do the +Standard HTTP. If the (default) LWP method is used, persistent +connections are supported. TL can also use \f(CW\*(C`curl\*(C'\fR or \f(CW\*(C`wget\*(C'\fR to do the downloads, or an arbitrary user-specified program, as described in the \&\f(CW\*(C`tlmgr\*(C'\fR documentation (<https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT\-VARIABLES>). .ie n .IP """https://server/path/to/tlnet""" 4 -.el .IP "\f(CWhttps://server/path/to/tlnet\fR" 4 +.el .IP \f(CWhttps://server/path/to/tlnet\fR 4 .IX Item "https://server/path/to/tlnet" -Again, if the (default) \s-1LWP\s0 method is used, this supports persistent +Again, if the (default) LWP method is used, this supports persistent connections. Unfortunately, some versions of \f(CW\*(C`wget\*(C'\fR and \f(CW\*(C`curl\*(C'\fR do not support https, and even when \f(CW\*(C`wget\*(C'\fR supports https, certificates may be rejected even when the certificate is fine, due to a lack of local certificate roots. The simplest workaround for this problem is to use http or ftp. .ie n .IP """ftp://server/path/to/tlnet""" 4 -.el .IP "\f(CWftp://server/path/to/tlnet\fR" 4 +.el .IP \f(CWftp://server/path/to/tlnet\fR 4 .IX Item "ftp://server/path/to/tlnet" -If the (default) \s-1LWP\s0 method is used, persistent connections are +If the (default) LWP method is used, persistent connections are supported. .ie n .IP """user@machine:/path/to/tlnet""" 4 -.el .IP "\f(CWuser@machine:/path/to/tlnet\fR" 4 +.el .IP \f(CWuser@machine:/path/to/tlnet\fR 4 .IX Item "user@machine:/path/to/tlnet" .PD 0 .ie n .IP """scp://user@machine/path/to/tlnet""" 4 -.el .IP "\f(CWscp://user@machine/path/to/tlnet\fR" 4 +.el .IP \f(CWscp://user@machine/path/to/tlnet\fR 4 .IX Item "scp://user@machine/path/to/tlnet" .ie n .IP """ssh://user@machine/path/to/tlnet""" 4 -.el .IP "\f(CWssh://user@machine/path/to/tlnet\fR" 4 +.el .IP \f(CWssh://user@machine/path/to/tlnet\fR 4 .IX Item "ssh://user@machine/path/to/tlnet" .PD These forms are equivalent; they all use \f(CW\*(C`scp\*(C'\fR to transfer files. Using @@ -310,12 +232,12 @@ trailing \f(CW\*(C`/tlpkg\*(C'\fR and/or \f(CW\*(C`/archive\*(C'\fR components a .RE .IP "\fB\-\-gui\fR [\fIaction\fR]" 4 .IX Item "--gui [action]" -Two notable \s-1GUI\s0 front-ends for \f(CW\*(C`tlmgr\*(C'\fR, \f(CW\*(C`tlshell\*(C'\fR and \f(CW\*(C`tlcockpit\*(C'\fR, +Two notable GUI front-ends for \f(CW\*(C`tlmgr\*(C'\fR, \f(CW\*(C`tlshell\*(C'\fR and \f(CW\*(C`tlcockpit\*(C'\fR, are started up as separate programs; see their own documentation. .Sp \&\f(CW\*(C`tlmgr\*(C'\fR itself has a graphical interface as well as the command line interface. You can give the option to invoke it, \f(CW\*(C`\-\-gui\*(C'\fR, together with -an action to be brought directly into the respective screen of the \s-1GUI.\s0 +an action to be brought directly into the respective screen of the GUI. For example, running .Sp .Vb 1 @@ -323,17 +245,17 @@ For example, running .Ve .Sp starts you directly at the update screen. If no action is given, the -\&\s-1GUI\s0 will be started at the main screen. See \*(L"\s-1GUI FOR TLMGR\*(R"\s0. +GUI will be started at the main screen. See "GUI FOR TLMGR". .Sp -However, the native \s-1GUI\s0 requires Perl/TK, which is no longer included in +However, the native GUI requires Perl/TK, which is no longer included in TeX Live's Perl distribution for Windows. You may find \f(CW\*(C`tlshell\*(C'\fR or \&\f(CW\*(C`tlcockpit\*(C'\fR easier to work with. .IP "\fB\-\-gui\-lang\fR \fIllcode\fR" 4 .IX Item "--gui-lang llcode" -By default, the \s-1GUI\s0 tries to deduce your language from the environment +By default, the GUI 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 with a -language code (based on \s-1ISO 639\-1\s0). Currently supported (but not +language code (based on ISO 639\-1). Currently supported (but not necessarily completely translated) are: English\ (en,\ default), Czech\ (cs), German\ (de), French\ (fr), Italian\ (it), Japanese\ (ja), Dutch\ (nl), Polish\ (pl), Brazilian\ Portuguese\ (pt_BR), Russian\ (ru), Slovak\ (sk), Slovenian\ (sl), Serbian\ (sr), Ukrainian\ (uk), Vietnamese\ (vi), simplified\ Chinese\ (zh_CN), and traditional\ Chinese\ (zh_TW). @@ -345,17 +267,17 @@ tlshell shares its message catalog with tlmgr. updmap) to a separate log file, by default \&\f(CW\*(C`TEXMFSYSVAR/web2c/tlmgr\-commands.log\*(C'\fR. This option allows you to specify a different file for the log. -.IP "\fB\-\-debug\-translation\fR" 4 +.IP \fB\-\-debug\-translation\fR 4 .IX Item "--debug-translation" -In \s-1GUI\s0 mode, this switch tells \f(CW\*(C`tlmgr\*(C'\fR to report any untranslated (or +In GUI mode, this switch tells \f(CW\*(C`tlmgr\*(C'\fR to report any untranslated (or missing) messages to standard error. This can help translators to see what remains to be done. -.IP "\fB\-\-machine\-readable\fR" 4 +.IP \fB\-\-machine\-readable\fR 4 .IX Item "--machine-readable" Instead of the normal output intended for human consumption, write (to standard output) a fixed format more suitable for machine parsing. See -the \*(L"MACHINE-READABLE \s-1OUTPUT\*(R"\s0 section below. -.IP "\fB\-\-no\-execute\-actions\fR" 4 +the "MACHINE-READABLE OUTPUT" section below. +.IP \fB\-\-no\-execute\-actions\fR 4 .IX Item "--no-execute-actions" Suppress the execution of the execute actions as defined in the tlpsrc files. Documented only for completeness, as this is only useful in @@ -366,14 +288,14 @@ debugging. updates, failed restores) to a separate log file, by default \&\f(CW\*(C`TEXMFSYSVAR/web2c/tlmgr.log\*(C'\fR. This option allows you to specify a different file for the log. -.IP "\fB\-\-pause\fR" 4 +.IP \fB\-\-pause\fR 4 .IX Item "--pause" This option makes \f(CW\*(C`tlmgr\*(C'\fR wait for user input before exiting. Useful on Windows to avoid disappearing command windows. -.IP "\fB\-\-persistent\-downloads\fR" 4 +.IP \fB\-\-persistent\-downloads\fR 4 .IX Item "--persistent-downloads" .PD 0 -.IP "\fB\-\-no\-persistent\-downloads\fR" 4 +.IP \fB\-\-no\-persistent\-downloads\fR 4 .IX Item "--no-persistent-downloads" .PD For network-based installations, this option (on by default) makes @@ -384,24 +306,24 @@ download for each package. .Sp If this is not possible, \f(CW\*(C`tlmgr\*(C'\fR will fall back to using \f(CW\*(C`wget\*(C'\fR. To disable these persistent connections, use \f(CW\*(C`\-\-no\-persistent\-downloads\*(C'\fR. -.IP "\fB\-\-pin\-file\fR" 4 +.IP \fB\-\-pin\-file\fR 4 .IX Item "--pin-file" Change the pinning file location from \f(CW\*(C`TEXMFLOCAL/tlpkg/pinning.txt\*(C'\fR -(see \*(L"Pinning\*(R" below). Documented only for completeness, as this is +(see "Pinning" below). Documented only for completeness, as this is only useful in debugging. -.IP "\fB\-\-usermode\fR" 4 +.IP \fB\-\-usermode\fR 4 .IX Item "--usermode" -Activates user mode for this run of \f(CW\*(C`tlmgr\*(C'\fR; see \*(L"\s-1USER MODE\*(R"\s0 below. +Activates user mode for this run of \f(CW\*(C`tlmgr\*(C'\fR; see "USER MODE" below. .IP "\fB\-\-usertree\fR \fIdir\fR" 4 .IX Item "--usertree dir" -Uses \fIdir\fR for the tree in user mode; see \*(L"\s-1USER MODE\*(R"\s0 below. -.IP "\fB\-\-verify\-repo=[none|main|all]\fR" 4 +Uses \fIdir\fR for the tree in user mode; see "USER MODE" below. +.IP \fB\-\-verify\-repo=[none|main|all]\fR 4 .IX Item "--verify-repo=[none|main|all]" Defines the level of verification done: If \f(CW\*(C`none\*(C'\fR is specified, no verification whatsoever is done. If \f(CW\*(C`main\*(C'\fR is given and a working GnuPG (\f(CW\*(C`gpg\*(C'\fR) binary is available, all repositories are checked, but only the main repository is required to be signed. If \f(CW\*(C`all\*(C'\fR is given, then all -repositories need to be signed. See \*(L"\s-1CRYPTOGRAPHIC VERIFICATION\*(R"\s0 below +repositories need to be signed. See "CRYPTOGRAPHIC VERIFICATION" below for details. .PP The standard options for TeX Live programs are also accepted: @@ -412,9 +334,9 @@ the \f(CW\*(C`TeXLive::TLUtils\*(C'\fR documentation. The \f(CW\*(C`\-\-version\*(C'\fR option shows version information about the TeX Live release and about the \f(CW\*(C`tlmgr\*(C'\fR script itself. If \f(CW\*(C`\-v\*(C'\fR is also given, revision number for the loaded TeX Live Perl modules are shown, too. -.SH "ACTIONS" +.SH ACTIONS .IX Header "ACTIONS" -.SS "help" +.SS help .IX Subsection "help" Display this help information and exit (same as \f(CW\*(C`\-\-help\*(C'\fR, and on the web at <https://tug.org/texlive/doc/tlmgr.html>). Sometimes the @@ -422,27 +344,27 @@ web at <https://tug.org/texlive/doc/tlmgr.html>). Sometimes the resulting in control characters being literally output. This can't always be detected, but you can set the \f(CW\*(C`NOPERLDOC\*(C'\fR environment variable and \f(CW\*(C`perldoc\*(C'\fR will not be used. -.SS "version" +.SS version .IX Subsection "version" Gives version information (same as \f(CW\*(C`\-\-version\*(C'\fR). .PP If \f(CW\*(C`\-v\*(C'\fR has been given the revisions of the used modules are reported, too. -.SS "backup" +.SS backup .IX Subsection "backup" -.IP "\fBbackup [\f(BIoption\fB...] \-\-all\fR" 4 +.IP "\fBbackup [\fR\f(BIoption\fR\fB...] \-\-all\fR" 4 .IX Item "backup [option...] --all" .PD 0 -.IP "\fBbackup [\f(BIoption\fB...] \f(BIpkg\fB...\fR" 4 +.IP "\fBbackup [\fR\f(BIoption\fR\fB...] \fR\f(BIpkg\fR\fB...\fR" 4 .IX Item "backup [option...] pkg..." .PD If the \f(CW\*(C`\-\-clean\*(C'\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 the \f(CW\*(C`\-\-backupdir\*(C'\fR option, if that is an existing and writable directory. If \f(CW\*(C`\-\-backupdir\*(C'\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 +option setting in the TLPDB is used, if present. If both are missing, no backups are made. (The installer sets \f(CW\*(C`backupdir\*(C'\fR to -\&\f(CW\*(C`.../tlpkg/backups\*(C'\fR, under the \s-1TL\s0 root installation directory, so it is -usually defined; see the \*(L"option\*(R" description for more information.) +\&\f(CW\*(C`.../tlpkg/backups\*(C'\fR, under the TL root installation directory, so it is +usually defined; see the "option" description for more information.) .Sp If the \f(CW\*(C`\-\-clean\*(C'\fR option is specified, backups are pruned (removed) instead of saved. The optional integer value \fIN\fR may be specified to @@ -455,21 +377,21 @@ Options: .RS 4 .IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4 .IX Item "--backupdir directory" -Overrides the \f(CW\*(C`backupdir\*(C'\fR option setting in the \s-1TLPDB.\s0 +Overrides the \f(CW\*(C`backupdir\*(C'\fR option setting in the TLPDB. The \fIdirectory\fR argument is required and must specify an existing, writable directory where backups are to be placed. -.IP "\fB\-\-all\fR" 4 +.IP \fB\-\-all\fR 4 .IX Item "--all" If \f(CW\*(C`\-\-clean\*(C'\fR is not specified, make a backup of all packages in the TeX Live installation; this will take quite a lot of space and time. If \&\f(CW\*(C`\-\-clean\*(C'\fR is specified, all packages are pruned. -.IP "\fB\-\-clean\fR[=\fIN\fR]" 4 +.IP \fB\-\-clean\fR[=\fIN\fR] 4 .IX Item "--clean[=N]" Instead of making backups, prune the backup directory of old backups, as explained above. The optional integer argument \fIN\fR overrides the -\&\f(CW\*(C`autobackup\*(C'\fR option set in the \s-1TLPDB.\s0 You must use \f(CW\*(C`\-\-all\*(C'\fR or a list +\&\f(CW\*(C`autobackup\*(C'\fR option set in the TLPDB. You must use \f(CW\*(C`\-\-all\*(C'\fR or a list of packages together with this option, as desired. -.IP "\fB\-\-dry\-run\fR" 4 +.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. @@ -479,13 +401,13 @@ performed are written to the terminal. .SS "candidates \fIpkg\fP" .IX Subsection "candidates pkg" Shows the available candidate repositories for package \fIpkg\fR. -See \*(L"\s-1MULTIPLE REPOSITORIES\*(R"\s0 below. +See "MULTIPLE REPOSITORIES" below. .SS "check [\fIoption\fP...] [depends|executes|files|runfiles|texmfdbs|all]" .IX Subsection "check [option...] [depends|executes|files|runfiles|texmfdbs|all]" Execute one (or all) check(s) of the consistency of the installation. If no problems are found, there will be no output. (To get a view of what is being done, run \f(CW\*(C`tlmgr \-v check\*(C'\fR.) -.IP "\fBdepends\fR" 4 +.IP \fBdepends\fR 4 .IX Item "depends" Lists those packages which occur as dependencies in an installed collection, but are themselves not installed, and those packages which are not @@ -493,19 +415,19 @@ 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 +.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 "\fBfiles\fR" 4 +.IP \fBfiles\fR 4 .IX Item "files" -Checks that all files listed in the local \s-1TLPDB\s0 (\f(CW\*(C`texlive.tlpdb\*(C'\fR) are +Checks that all files listed in the local TLPDB (\f(CW\*(C`texlive.tlpdb\*(C'\fR) are actually present, and lists those missing. -.IP "\fBrunfiles\fR" 4 +.IP \fBrunfiles\fR 4 .IX Item "runfiles" List those filenames that are occurring more than one time in the runfiles sections, except for known duplicates. -.IP "\fBtexmfdbs\fR" 4 +.IP \fBtexmfdbs\fR 4 .IX Item "texmfdbs" Checks related to the \f(CW\*(C`ls\-R\*(C'\fR files. If you have defined new trees, or changed the \f(CW\*(C`TEXMF\*(C'\fR or \f(CW\*(C`TEXMFDBS\*(C'\fR variables, it can't hurt to run @@ -530,16 +452,16 @@ this. It checks that: .PD .PP Options: -.IP "\fB\-\-use\-svn\fR" 4 +.IP \fB\-\-use\-svn\fR 4 .IX Item "--use-svn" Use the output of \f(CW\*(C`svn status\*(C'\fR instead of listing the files; for -checking the \s-1TL\s0 development repository. (This is run nightly.) -.SS "conf" +checking the TL development repository. (This is run nightly.) +.SS conf .IX Subsection "conf" -.IP "\fBconf [texmf|tlmgr|updmap [\-\-conffile \f(BIfile\fB] [\-\-delete] [\f(BIkey\fB [\f(BIvalue\fB]]]\fR" 4 +.IP "\fBconf [texmf|tlmgr|updmap [\-\-conffile \fR\f(BIfile\fR\fB] [\-\-delete] [\fR\f(BIkey\fR\fB [\fR\f(BIvalue\fR\fB]]]\fR" 4 .IX Item "conf [texmf|tlmgr|updmap [--conffile file] [--delete] [key [value]]]" .PD 0 -.IP "\fBconf auxtrees [\-\-conffile \f(BIfile\fB] [show|add|remove] [\f(BIvalue\fB]\fR" 4 +.IP "\fBconf auxtrees [\-\-conffile \fR\f(BIfile\fR\fB] [show|add|remove] [\fR\f(BIvalue\fR\fB]\fR" 4 .IX Item "conf auxtrees [--conffile file] [show|add|remove] [value]" .PD With only \f(CW\*(C`conf\*(C'\fR, show general configuration information for TeX Live, @@ -561,7 +483,7 @@ respective file. \fINo error checking is done!\fR .Sp The \f(CW\*(C`PATH\*(C'\fR value shown by \f(CW\*(C`conf\*(C'\fR is as used by \f(CW\*(C`tlmgr\*(C'\fR. The directory in which the \f(CW\*(C`tlmgr\*(C'\fR executable is found is automatically -prepended to the \s-1PATH\s0 value inherited from the environment. +prepended to the PATH value inherited from the environment. .Sp Here is a practical example of changing configuration values. If the execution of (some or all) system commands via \f(CW\*(C`\ewrite18\*(C'\fR was left @@ -595,21 +517,21 @@ no error checking on either keys or values is done, so any sort of breakage is possible. .SS "dump-tlpdb [\fIoption\fP...] [\-\-json]" .IX Subsection "dump-tlpdb [option...] [--json]" -Dump complete local or remote \s-1TLPDB\s0 to standard output, as-is. The +Dump complete local or remote TLPDB to standard output, as-is. The output is analogous to the \f(CW\*(C`\-\-machine\-readable\*(C'\fR output; see -\&\*(L"MACHINE-READABLE \s-1OUTPUT\*(R"\s0 section. +"MACHINE-READABLE OUTPUT" section. .PP Options: -.IP "\fB\-\-local\fR" 4 +.IP \fB\-\-local\fR 4 .IX Item "--local" -Dump the local \s-1TLPDB.\s0 -.IP "\fB\-\-remote\fR" 4 +Dump the local TLPDB. +.IP \fB\-\-remote\fR 4 .IX Item "--remote" -Dump the remote \s-1TLPDB.\s0 -.IP "\fB\-\-json\fR" 4 +Dump the remote TLPDB. +.IP \fB\-\-json\fR 4 .IX Item "--json" Instead of dumping the actual content, the database is dumped as -\&\s-1JSON.\s0 For the format of \s-1JSON\s0 output see \f(CW\*(C`tlpkg/doc/JSON\-formats.txt\*(C'\fR, +JSON. For the format of JSON output see \f(CW\*(C`tlpkg/doc/JSON\-formats.txt\*(C'\fR, format definition \f(CW\*(C`TLPDB\*(C'\fR. .PP Exactly one of \f(CW\*(C`\-\-local\*(C'\fR and \f(CW\*(C`\-\-remote\*(C'\fR must be given. @@ -624,17 +546,17 @@ location, in this format: where \f(CW\*(C`location\-url\*(C'\fR is the literal field name, followed by a tab, and \&\fIlocation\fR is the file or url to the repository. .PP -Line endings may be either \s-1LF\s0 or \s-1CRLF\s0 depending on the current platform. -.SS "generate" +Line endings may be either LF or CRLF depending on the current platform. +.SS generate .IX Subsection "generate" -.IP "\fBgenerate [\f(BIoption\fB...] language\fR" 4 +.IP "\fBgenerate [\fR\f(BIoption\fR\fB...] language\fR" 4 .IX Item "generate [option...] language" .PD 0 -.IP "\fBgenerate [\f(BIoption\fB...] language.dat\fR" 4 +.IP "\fBgenerate [\fR\f(BIoption\fR\fB...] language.dat\fR" 4 .IX Item "generate [option...] language.dat" -.IP "\fBgenerate [\f(BIoption\fB...] language.def\fR" 4 +.IP "\fBgenerate [\fR\f(BIoption\fR\fB...] language.def\fR" 4 .IX Item "generate [option...] language.def" -.IP "\fBgenerate [\f(BIoption\fB...] language.dat.lua\fR" 4 +.IP "\fBgenerate [\fR\f(BIoption\fR\fB...] language.dat.lua\fR" 4 .IX Item "generate [option...] language.dat.lua" .PD .PP @@ -652,7 +574,7 @@ information. .PP In more detail: \f(CW\*(C`generate\*(C'\fR remakes any of the configuration files \&\f(CW\*(C`language.dat\*(C'\fR, \f(CW\*(C`language.def\*(C'\fR, and \f(CW\*(C`language.dat.lua\*(C'\fR -from the information present in the local \s-1TLPDB,\s0 plus +from the information present in the local TLPDB, plus locally-maintained files. .PP The locally-maintained files are \f(CW\*(C`language\-local.dat\*(C'\fR, @@ -714,7 +636,7 @@ recommend invoking \f(CW\*(C`tlmgr\*(C'\fR twice.) .IX Item "--localcfg local_conf_file" specifies the (optional) local additions (defaults to the respective location in \f(CW\*(C`TEXMFLOCAL\*(C'\fR). -.IP "\fB\-\-rebuild\-sys\fR" 4 +.IP \fB\-\-rebuild\-sys\fR 4 .IX Item "--rebuild-sys" tells \f(CW\*(C`tlmgr\*(C'\fR to run necessary programs after config files have been regenerated. These are: @@ -735,17 +657,17 @@ The respective locations are as follows: \& tex/generic/config/language.def (and language\-local.def) \& tex/generic/config/language.dat.lua (and language\-local.dat.lua) .Ve -.SS "gui" +.SS gui .IX Subsection "gui" -Start the graphical user interface. See \fB\s-1GUI\s0\fR below. -.SS "info" +Start the graphical user interface. See \fBGUI\fR below. +.SS info .IX Subsection "info" -.IP "\fBinfo [\f(BIoption\fB...] \f(BIpkg\fB...\fR" 4 +.IP "\fBinfo [\fR\f(BIoption\fR\fB...] \fR\f(BIpkg\fR\fB...\fR" 4 .IX Item "info [option...] pkg..." .PD 0 -.IP "\fBinfo [\f(BIoption\fB...] collections\fR" 4 +.IP "\fBinfo [\fR\f(BIoption\fR\fB...] collections\fR" 4 .IX Item "info [option...] collections" -.IP "\fBinfo [\f(BIoption\fB...] schemes\fR" 4 +.IP "\fBinfo [\fR\f(BIoption\fR\fB...] schemes\fR" 4 .IX Item "info [option...] schemes" .PD With no argument, lists all packages available at the package @@ -773,31 +695,31 @@ It also displays information taken from the TeX Catalogue, namely the package version, date, and license. Consider these, especially the package version, as approximations only, due to timing skew of the updates of the different pieces. By contrast, the \f(CW\*(C`revision\*(C'\fR value -comes directly from \s-1TL\s0 and is reliable. +comes directly from TL and is reliable. .Sp The former actions \f(CW\*(C`show\*(C'\fR and \f(CW\*(C`list\*(C'\fR are merged into this action, but are still supported for backward compatibility. .Sp Options: .RS 4 -.IP "\fB\-\-list\fR" 4 +.IP \fB\-\-list\fR 4 .IX Item "--list" If the option \f(CW\*(C`\-\-list\*(C'\fR is given with a package, the list of contained files is also shown, including those for platform-specific dependencies. When given with schemes and collections, \f(CW\*(C`\-\-list\*(C'\fR outputs their dependencies in a similar way. -.IP "\fB\-\-only\-installed\fR" 4 +.IP \fB\-\-only\-installed\fR 4 .IX Item "--only-installed" If this option is given, the installation source will not be used; only locally installed packages, collections, or schemes are listed. -.IP "\fB\-\-only\-remote\fR" 4 +.IP \fB\-\-only\-remote\fR 4 .IX Item "--only-remote" Only list packages from the remote repository. Useful when checking what is available in a remote repository using \&\f(CW\*(C`tlmgr \-\-repo ... \-\-only\-remote info\*(C'\fR. Note that \&\f(CW\*(C`\-\-only\-installed\*(C'\fR and \f(CW\*(C`\-\-only\-remote\*(C'\fR cannot both be specified. -.ie n .IP "\fB\-\-data \f(CB""item1,item2,...""\fB\fR" 4 -.el .IP "\fB\-\-data \f(CBitem1,item2,...\fB\fR" 4 +.ie n .IP "\fB\-\-data \fR\fB""item1,item2,...""\fR" 4 +.el .IP "\fB\-\-data \fR\f(CBitem1,item2,...\fR" 4 .IX Item "--data item1,item2,..." If the option \f(CW\*(C`\-\-data\*(C'\fR is given, its argument must be a comma or colon separated list of field names from: \f(CW\*(C`name\*(C'\fR, \f(CW\*(C`category\*(C'\fR, \f(CW\*(C`localrev\*(C'\fR, @@ -812,30 +734,30 @@ variants with prefix \f(CW\*(C`l\*(C'\fR and \f(CW\*(C`r\*(C'\fR, e.g., \f(CW\*( respectively. The variants without \f(CW\*(C`l\*(C'\fR and \f(CW\*(C`r\*(C'\fR show the most current one, which is normally the remote value. .Sp -The requested packages' information is listed in \s-1CSV\s0 format, one package +The requested packages' information is listed in CSV format, one package per line, and the column information is given by the \f(CW\*(C`itemN\*(C'\fR. The \&\f(CW\*(C`depends\*(C'\fR column contains the names of all the dependencies separated by \f(CW\*(C`:\*(C'\fR characters. .Sp At this writing, the \f(CW\*(C`cat\-contact\-*\*(C'\fR fields include: \f(CW\*(C`home\*(C'\fR, \&\f(CW\*(C`repository\*(C'\fR, \f(CW\*(C`support\*(C'\fR, \f(CW\*(C`bugs\*(C'\fR, \f(CW\*(C`announce\*(C'\fR, \f(CW\*(C`development\*(C'\fR. Each -may be empty or a url value. A brief description is on the \s-1CTAN\s0 upload +may be empty or a url value. A brief description is on the CTAN upload page for new packages: <https://ctan.org/upload>. -.IP "\fB\-\-json\fR" 4 +.IP \fB\-\-json\fR 4 .IX Item "--json" -In case \f(CW\*(C`\-\-json\*(C'\fR is specified, the output is a \s-1JSON\s0 encoded array where -each array element is the \s-1JSON\s0 representation of a single \f(CW\*(C`TLPOBJ\*(C'\fR but +In case \f(CW\*(C`\-\-json\*(C'\fR is specified, the output is a JSON encoded array where +each array element is the JSON representation of a single \f(CW\*(C`TLPOBJ\*(C'\fR but with additional information. For details see \&\f(CW\*(C`tlpkg/doc/JSON\-formats.txt\*(C'\fR, format definition: \f(CW\*(C`TLPOBJINFO\*(C'\fR. If both \&\f(CW\*(C`\-\-json\*(C'\fR and \f(CW\*(C`\-\-data\*(C'\fR are given, \f(CW\*(C`\-\-json\*(C'\fR takes precedence. .RE .RS 4 .RE -.SS "init-usertree" +.SS init-usertree .IX Subsection "init-usertree" Sets up a texmf tree for so-called user mode management, either the default user tree (\f(CW\*(C`TEXMFHOME\*(C'\fR), or one specified on the command line -with \f(CW\*(C`\-\-usertree\*(C'\fR. See \*(L"\s-1USER MODE\*(R"\s0 below. +with \f(CW\*(C`\-\-usertree\*(C'\fR. See "USER MODE" below. .SS "install [\fIoption\fP...] \fIpkg\fP..." .IX Subsection "install [option...] pkg..." Install each \fIpkg\fR given on the command line, if it is not already @@ -844,25 +766,25 @@ action for how to get the latest version of a package. .PP By default this also installs all packages on which the given \fIpkg\fRs are dependent. Options: -.IP "\fB\-\-dry\-run\fR" 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. -.IP "\fB\-\-file\fR" 4 +.IP \fB\-\-file\fR 4 .IX Item "--file" Instead of fetching a package from the installation repository, use the package files given on the command line. These files must be standard TeX Live package files (with contained tlpobj file). -.IP "\fB\-\-force\fR" 4 +.IP \fB\-\-force\fR 4 .IX Item "--force" If updates to \f(CW\*(C`tlmgr\*(C'\fR itself (or other parts of the basic infrastructure) are present, \f(CW\*(C`tlmgr\*(C'\fR will bail out and not perform the installation unless this option is given. Not recommended. -.IP "\fB\-\-no\-depends\fR" 4 +.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 +.IP \fB\-\-no\-depends\-at\-all\fR 4 .IX Item "--no-depends-at-all" Normally, when you install a package which ships binary files the respective binary package will also be installed. That is, for a @@ -870,18 +792,18 @@ package \f(CW\*(C`foo\*(C'\fR, the package \f(CW\*(C`foo.i386\-linux\*(C'\fR wil an \f(CW\*(C`i386\-linux\*(C'\fR system. This option suppresses this behavior, 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\-\-reinstall\fR" 4 +.IP \fB\-\-reinstall\fR 4 .IX Item "--reinstall" Reinstall a package (including dependencies for collections) even if it -already seems to be installed (i.e, is present in the \s-1TLPDB\s0). This is +already seems to be installed (i.e, is present in the TLPDB). This is useful to recover from accidental removal of files in the hierarchy. .Sp When re-installing, only dependencies on normal packages are followed (i.e., not those of category Scheme or Collection). -.IP "\fB\-\-with\-doc\fR" 4 +.IP \fB\-\-with\-doc\fR 4 .IX Item "--with-doc" .PD 0 -.IP "\fB\-\-with\-src\fR" 4 +.IP \fB\-\-with\-src\fR 4 .IX Item "--with-src" .PD While not recommended, the \f(CW\*(C`install\-tl\*(C'\fR program provides an option to @@ -896,19 +818,19 @@ after all. You can get them by using these options in conjunction with .Ve .PP This action does not automatically add new symlinks in system -directories; you need to run \f(CW\*(C`tlmgr path add\*(C'\fR (\*(L"path\*(R") yourself if +directories; you need to run \f(CW\*(C`tlmgr path add\*(C'\fR ("path") yourself if you are using this feature and want new symlinks added. -.SS "key" +.SS key .IX Subsection "key" .IP "\fBkey list\fR" 4 .IX Item "key list" .PD 0 -.IP "\fBkey add \f(BIfile\fB\fR" 4 +.IP "\fBkey add \fR\f(BIfile\fR" 4 .IX Item "key add file" -.IP "\fBkey remove \f(BIkeyid\fB\fR" 4 +.IP "\fBkey remove \fR\f(BIkeyid\fR" 4 .IX Item "key remove keyid" .PD -The action \f(CW\*(C`key\*(C'\fR allows listing, adding and removing additional \s-1GPG\s0 +The action \f(CW\*(C`key\*(C'\fR allows listing, adding and removing additional GPG keys to the set of trusted keys, that is, those that are used to verify the TeX Live databases. .Sp @@ -921,22 +843,22 @@ local keyring \f(CW\*(C`GNUPGHOME/repository\-keys.gpg\*(C'\fR, which is normall .Sp The \f(CW\*(C`remove\*(C'\fR argument requires a key id and removes the requested id from the local keyring. -.SS "list" +.SS list .IX Subsection "list" -Synonym for \*(L"info\*(R". -.SS "option" +Synonym for "info". +.SS option .IX Subsection "option" .IP "\fBoption [\-\-json] [show]\fR" 4 .IX Item "option [--json] [show]" .PD 0 .IP "\fBoption [\-\-json] showall|help\fR" 4 .IX Item "option [--json] showall|help" -.IP "\fBoption \f(BIkey\fB [\f(BIvalue\fB]\fR" 4 +.IP "\fBoption \fR\f(BIkey\fR\fB [\fR\f(BIvalue\fR\fB]\fR" 4 .IX Item "option key [value]" .PD .PP The first form, \f(CW\*(C`show\*(C'\fR, 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 +saved in the TLPDB with a short description and the \f(CW\*(C`key\*(C'\fR used for changing it in parentheses. .PP The second form, \f(CW\*(C`showall\*(C'\fR, is similar, but also shows options which @@ -944,8 +866,8 @@ can be defined but are not currently set to any value (\f(CW\*(C`help\*(C'\fR is synonym). .PP Both \f(CW\*(C`show...\*(C'\fR forms take an option \f(CW\*(C`\-\-json\*(C'\fR, which dumps the option -information in \s-1JSON\s0 format. In this case, both forms dump the same -data. For the format of the \s-1JSON\s0 output see +information in JSON format. In this case, both forms dump the same +data. For the format of the JSON output see \&\f(CW\*(C`tlpkg/doc/JSON\-formats.txt\*(C'\fR, format definition \f(CW\*(C`TLOPTION\*(C'\fR. .PP In the third form, with \fIkey\fR, if \fIvalue\fR is not given, the setting @@ -973,7 +895,7 @@ the definitive list): .PP One common use of \f(CW\*(C`option\*(C'\fR is to permanently change the installation to get further updates from the Internet, after originally installing from -\&\s-1DVD.\s0 To do this, you can run +DVD. To do this, you can run .PP .Vb 1 \& tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet @@ -1003,24 +925,24 @@ The options \f(CW\*(C`autobackup\*(C'\fR and \f(CW\*(C`backupdir\*(C'\fR determi the actions \f(CW\*(C`update\*(C'\fR, \f(CW\*(C`backup\*(C'\fR and \f(CW\*(C`restore\*(C'\fR. These three actions need a directory in which to read or write 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). The \s-1TL\s0 installer sets \f(CW\*(C`backupdir\*(C'\fR to -\&\f(CW\*(C`.../tlpkg/backups\*(C'\fR, under the \s-1TL\s0 root installation directory. +option value is used (if set). The TL installer sets \f(CW\*(C`backupdir\*(C'\fR to +\&\f(CW\*(C`.../tlpkg/backups\*(C'\fR, under the TL root installation directory. .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 +Its value is an integer. If the \f(CW\*(C`autobackup\*(C'\fR value is \f(CW\-1\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. The default value is 1, so that backups are made, but only one backup is kept. .PP -To setup \f(CW\*(C`autobackup\*(C'\fR to \f(CW\*(C`\-1\*(C'\fR on the command line, use: +To setup \f(CW\*(C`autobackup\*(C'\fR to \f(CW\-1\fR on the command line, 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. (The \f(CW\*(C`\-\-\*(C'\fR +The \f(CW\*(C`\-\-\*(C'\fR avoids having the \f(CW\-1\fR treated as an option. (The \f(CW\*(C`\-\-\*(C'\fR stops parsing for options at the point where it appears; this is a general feature across most Unix programs.) .PP @@ -1035,12 +957,12 @@ a sub-folder of the Start menu for \f(CW\*(C`tlmgr gui\*(C'\fR, documentation, e \&\f(CW\*(C`postaction\*(C'\fR action). Finally, if \f(CW\*(C`multiuser\*(C'\fR is set, then adaptions to the registry and the menus are done for all users on the system instead of only the current user. All three options are on by default. -.SS "paper" +.SS paper .IX Subsection "paper" .IP "\fBpaper [a4|letter]\fR" 4 .IX Item "paper [a4|letter]" .PD 0 -.IP "\fB<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [\f(BIpapersize\fB|\-\-list]\fR>" 4 +.IP "\fB<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [\fR\f(BIpapersize\fR\fB|\-\-list]\fR>" 4 .IX Item "<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [papersize|--list]>" .IP "\fBpaper \-\-json\fR" 4 .IX Item "paper --json" @@ -1065,7 +987,7 @@ last argument (e.g., \f(CW\*(C`tlmgr dvips paper \-\-list\*(C'\fR), shows all va sizes for that program. The first size shown is the default. .PP If \f(CW\*(C`\-\-json\*(C'\fR is specified without other options, the paper setup is -dumped in \s-1JSON\s0 format. For the format of \s-1JSON\s0 output see +dumped in JSON format. For the format of JSON output see \&\f(CW\*(C`tlpkg/doc/JSON\-formats.txt\*(C'\fR, format definition \f(CW\*(C`TLPAPER\*(C'\fR. .PP Incidentally, this syntax of having a specific program name before the @@ -1073,7 +995,7 @@ Incidentally, this syntax of having a specific program name before the \&\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. -.SS "path" +.SS path .IX Subsection "path" .IP "\fBpath [\-\-windowsmode=user|admin] add\fR" 4 .IX Item "path [--windowsmode=user|admin] add" @@ -1083,7 +1005,7 @@ settings. .PD On Unix, adds or removes symlinks for executables, man pages, and info pages in the system directories specified by the respective options (see -the \*(L"option\*(R" description above). Does not change any initialization +the "option" description above). Does not change any initialization files, either system or personal. Furthermore, any executables added or removed by future updates are not taken care of automatically; this command must be rerun as needed. @@ -1107,9 +1029,9 @@ If the user does not have admin rights, and the option \f(CW\*(C`\-\-windowsmode is given, it must be \f(CW\*(C`user\*(C'\fR and the user path will be adjusted. If a user without admin rights uses the option \f(CW\*(C`\-\-windowsmode admin\*(C'\fR a warning is issued that the caller does not have enough privileges. -.SS "pinning" +.SS pinning .IX Subsection "pinning" -The \f(CW\*(C`pinning\*(C'\fR action manages the pinning file, see \*(L"Pinning\*(R" below. +The \f(CW\*(C`pinning\*(C'\fR action manages the pinning file, see "Pinning" below. .ie n .IP """pinning show""" 4 .el .IP "\f(CWpinning show\fR" 4 .IX Item "pinning show" @@ -1124,16 +1046,16 @@ Pins the packages matching the \fIpkgglob\fR(s) to the repository .IX Item "pinning remove repo pkgglob..." Any packages recorded in the pinning file matching the <pkgglob>s for the given repository \fIrepo\fR are removed. -.ie n .IP """pinning remove \fIrepo\fP \-\-all""" 4 -.el .IP "\f(CWpinning remove \f(CIrepo\f(CW \-\-all\fR" 4 +.ie n .IP """pinning remove \fIrepo\fR \-\-all""" 4 +.el .IP "\f(CWpinning remove \fR\f(CIrepo\fR\f(CW \-\-all\fR" 4 .IX Item "pinning remove repo --all" Remove all pinning data for repository \fIrepo\fR. -.SS "platform" +.SS platform .IX Subsection "platform" -.IP "\fBplatform list|add|remove \f(BIplatform\fB...\fR" 4 +.IP "\fBplatform list|add|remove \fR\f(BIplatform\fR\fB...\fR" 4 .IX Item "platform list|add|remove platform..." .PD 0 -.IP "\fBplatform set \f(BIplatform\fB\fR" 4 +.IP "\fBplatform set \fR\f(BIplatform\fR" 4 .IX Item "platform set platform" .IP "\fBplatform set auto\fR" 4 .IX Item "platform set auto" @@ -1161,19 +1083,19 @@ Platform detection is needed to select the proper \f(CW\*(C`xz\*(C'\fR and .Sp Options: .RS 4 -.IP "\fB\-\-dry\-run\fR" 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 -.SS "postaction" +.SS postaction .IX Subsection "postaction" -.IP "\fBpostaction [\f(BIoption\fB...] install [shortcut|fileassoc|script] [\f(BIpkg\fB...]\fR" 4 +.IP "\fBpostaction [\fR\f(BIoption\fR\fB...] install [shortcut|fileassoc|script] [\fR\f(BIpkg\fR\fB...]\fR" 4 .IX Item "postaction [option...] install [shortcut|fileassoc|script] [pkg...]" .PD 0 -.IP "\fBpostaction [\f(BIoption\fB...] remove [shortcut|fileassoc|script] [\f(BIpkg\fB...]\fR" 4 +.IP "\fBpostaction [\fR\f(BIoption\fR\fB...] remove [shortcut|fileassoc|script] [\fR\f(BIpkg\fR\fB...]\fR" 4 .IX Item "postaction [option...] remove [shortcut|fileassoc|script] [pkg...]" .PD Carry out the postaction \f(CW\*(C`shortcut\*(C'\fR, \f(CW\*(C`fileassoc\*(C'\fR, or \f(CW\*(C`script\*(C'\fR given @@ -1183,33 +1105,33 @@ line, or for all if \f(CW\*(C`\-\-all\*(C'\fR is given. .Sp Options: .RS 4 -.IP "\fB\-\-windowsmode=[user|admin]\fR" 4 +.IP \fB\-\-windowsmode=[user|admin]\fR 4 .IX Item "--windowsmode=[user|admin]" If the option \f(CW\*(C`\-\-windowsmode\*(C'\fR is given the value \f(CW\*(C`user\*(C'\fR, all actions will only be carried out in the user-accessible parts of the registry/filesystem, while the value \f(CW\*(C`admin\*(C'\fR selects the system-wide parts of the registry for the file associations. If you do not have enough permissions, using \f(CW\*(C`\-\-windowsmode=admin\*(C'\fR will not succeed. -.IP "\fB\-\-fileassocmode=[1|2]\fR" 4 +.IP \fB\-\-fileassocmode=[1|2]\fR 4 .IX Item "--fileassocmode=[1|2]" \&\f(CW\*(C`\-\-fileassocmode\*(C'\fR specifies the action for file associations. If it is set to 1 (the default), only new associations are added; if it is set to 2, all associations are set to the TeX Live programs. (See also \&\f(CW\*(C`option fileassocs\*(C'\fR.) -.IP "\fB\-\-all\fR" 4 +.IP \fB\-\-all\fR 4 .IX Item "--all" Carry out the postactions for all packages .RE .RS 4 .RE -.SS "print-platform" +.SS print-platform .IX Subsection "print-platform" Print the TeX Live identifier for the detected platform (hardware/operating system) combination to standard output, and exit. \&\f(CW\*(C`\-\-print\-arch\*(C'\fR is a synonym. -.SS "print-platform-info" +.SS print-platform-info .IX Subsection "print-platform-info" -Print the TeX Live platform identifier, \s-1TL\s0 platform long name, and +Print the TeX Live platform identifier, TL platform long name, and original output from guess. .SS "remove [\fIoption\fP...] \fIpkg\fP..." .IX Subsection "remove [option...] pkg..." @@ -1217,11 +1139,11 @@ Remove each \fIpkg\fR specified. Removing a collection removes all package dependencies (unless \f(CW\*(C`\-\-no\-depends\*(C'\fR is specified), but not any collection dependencies of that collection. However, when removing a package, dependencies are never removed. Options: -.IP "\fB\-\-all\fR" 4 +.IP \fB\-\-all\fR 4 .IX Item "--all" Uninstalls all of TeX Live, asking for confirmation unless \f(CW\*(C`\-\-force\*(C'\fR is also specified. -.IP "\fB\-\-backup\fR" 4 +.IP \fB\-\-backup\fR 4 .IX Item "--backup" .PD 0 .IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4 @@ -1231,14 +1153,14 @@ These options behave just as with the update action (q.v.), except they apply to backups of packages before they are removed. The default is to make such a backup, that is, to save a copy of packages before removal. .Sp -The \*(L"restore\*(R" action explains how to restore from a backup. -.IP "\fB\-\-no\-depends\fR" 4 +The "restore" action explains how to restore from a backup. +.IP \fB\-\-no\-depends\fR 4 .IX Item "--no-depends" Do not remove dependent packages. -.IP "\fB\-\-no\-depends\-at\-all\fR" 4 +.IP \fB\-\-no\-depends\-at\-all\fR 4 .IX Item "--no-depends-at-all" See above under install (and beware). -.IP "\fB\-\-force\fR" 4 +.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 @@ -1248,38 +1170,38 @@ A package that has been removed using the \f(CW\*(C`\-\-force\*(C'\fR option bec is still listed in an installed collection or scheme will not be updated, and will be mentioned as \f(CW\*(C`forcibly removed\*(C'\fR in the output of \&\f(CW\*(C`tlmgr update \-\-list\*(C'\fR. -.IP "\fB\-\-dry\-run\fR" 4 +.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. .PP Except with \f(CW\*(C`\-\-all\*(C'\fR, this \f(CW\*(C`remove\*(C'\fR action does not automatically remove symlinks to executables from system directories; you need to run -\&\f(CW\*(C`tlmgr path remove\*(C'\fR (\*(L"path\*(R") yourself if you remove an individual +\&\f(CW\*(C`tlmgr path remove\*(C'\fR ("path") yourself if you remove an individual package with a symlink in a system directory. -.SS "repository" +.SS repository .IX Subsection "repository" .IP "\fBrepository list\fR" 4 .IX Item "repository list" .PD 0 -.IP "\fBrepository list \f(BIpath|url|tag\fB\fR" 4 +.IP "\fBrepository list \fR\f(BIpath|url|tag\fR" 4 .IX Item "repository list path|url|tag" -.IP "\fBrepository add \f(BIpath\fB [\f(BItag\fB]\fR" 4 +.IP "\fBrepository add \fR\f(BIpath\fR\fB [\fR\f(BItag\fR\fB]\fR" 4 .IX Item "repository add path [tag]" -.IP "\fBrepository remove \f(BIpath|tag\fB\fR" 4 +.IP "\fBrepository remove \fR\f(BIpath|tag\fR" 4 .IX Item "repository remove path|tag" -.IP "\fBrepository set \f(BIpath\fB[#\f(BItag\fB] [\f(BIpath\fB[#\f(BItag\fB] ...]\fR" 4 +.IP "\fBrepository set \fR\f(BIpath\fR\fB[#\fR\f(BItag\fR\fB] [\fR\f(BIpath\fR\fB[#\fR\f(BItag\fR\fB] ...]\fR" 4 .IX Item "repository set path[#tag] [path[#tag] ...]" .IP "\fBrepository status\fR" 4 .IX Item "repository status" .PD -This action manages the list of repositories. See \s-1MULTIPLE -REPOSITORIES\s0 below for detailed explanations. +This action manages the list of repositories. See MULTIPLE +REPOSITORIES below for detailed explanations. .Sp The first form, \f(CW\*(C`repository list\*(C'\fR, lists all configured repositories and the respective tags if set. If a path, url, or tag is given after the \f(CW\*(C`list\*(C'\fR keyword, it is interpreted as the source from which to -initialize a \s-1TL\s0 database and lists the contained packages. This can also +initialize a TL database and lists the contained packages. This can also be an otherwise-unused repository, either local or remote. If the option \&\f(CW\*(C`\-\-with\-platforms\*(C'\fR is specified in addition, for each package the available platforms (if any) are also listed. @@ -1313,12 +1235,12 @@ That is, in normal (not machine-readable) output, the third field In all cases, one of the repositories must be tagged as \f(CW\*(C`main\*(C'\fR; otherwise, all operations will fail! .RE -.SS "restore" +.SS restore .IX Subsection "restore" -.IP "\fBrestore [\f(BIoption\fB...] \f(BIpkg\fB [\f(BIrev\fB]\fR" 4 +.IP "\fBrestore [\fR\f(BIoption\fR\fB...] \fR\f(BIpkg\fR\fB [\fR\f(BIrev\fR\fB]\fR" 4 .IX Item "restore [option...] pkg [rev]" .PD 0 -.IP "\fBrestore [\f(BIoption\fB...] \-\-all\fR" 4 +.IP "\fBrestore [\fR\f(BIoption\fR\fB...] \-\-all\fR" 4 .IX Item "restore [option...] --all" .PD Restore a package from a previously-made backup. @@ -1338,7 +1260,7 @@ specified, try to restore the package from the specified backup. .Sp Options: .RS 4 -.IP "\fB\-\-all\fR" 4 +.IP \fB\-\-all\fR 4 .IX Item "--all" Try to restore the latest revision of all package backups found in the backup directory. Additional non-option arguments (like \fIpkg\fR) are not @@ -1346,31 +1268,31 @@ allowed. .IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4 .IX Item "--backupdir directory" Specify the directory where the backups are to be found. If not given it -will be taken from the configuration setting in the \s-1TLPDB.\s0 -.IP "\fB\-\-dry\-run\fR" 4 +will be taken from the configuration setting in the TLPDB. +.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\-\-force\fR" 4 +.IP \fB\-\-force\fR 4 .IX Item "--force" Don't ask questions. -.IP "\fB\-\-json\fR" 4 +.IP \fB\-\-json\fR 4 .IX Item "--json" -When listing backups, the option \f(CW\*(C`\-\-json\*(C'\fR turn on \s-1JSON\s0 output. -The format is an array of \s-1JSON\s0 objects (\f(CW\*(C`name\*(C'\fR, \f(CW\*(C`rev\*(C'\fR, \f(CW\*(C`date\*(C'\fR). +When listing backups, the option \f(CW\*(C`\-\-json\*(C'\fR turn on JSON output. +The format is an array of JSON objects (\f(CW\*(C`name\*(C'\fR, \f(CW\*(C`rev\*(C'\fR, \f(CW\*(C`date\*(C'\fR). For details see \f(CW\*(C`tlpkg/doc/JSON\-formats.txt\*(C'\fR, format definition: \f(CW\*(C`TLBACKUPS\*(C'\fR. If both \f(CW\*(C`\-\-json\*(C'\fR and \f(CW\*(C`\-\-data\*(C'\fR are given, \f(CW\*(C`\-\-json\*(C'\fR takes precedence. .RE .RS 4 .RE -.SS "search" +.SS search .IX Subsection "search" -.IP "\fBsearch [\f(BIoption\fB...] \f(BIwhat\fB\fR" 4 +.IP "\fBsearch [\fR\f(BIoption\fR\fB...] \fR\f(BIwhat\fR" 4 .IX Item "search [option...] what" .PD 0 -.IP "\fBsearch [\f(BIoption\fB...] \-\-file \f(BIwhat\fB\fR" 4 +.IP "\fBsearch [\fR\f(BIoption\fR\fB...] \-\-file \fR\f(BIwhat\fR" 4 .IX Item "search [option...] --file what" -.IP "\fBsearch [\f(BIoption\fB...] \-\-all \f(BIwhat\fB\fR" 4 +.IP "\fBsearch [\fR\f(BIoption\fR\fB...] \-\-all \fR\f(BIwhat\fR" 4 .IX Item "search [option...] --all what" .PD By default, search the names, short descriptions, and long descriptions @@ -1379,17 +1301,17 @@ as a (Perl) regular expression. .Sp Options: .RS 4 -.IP "\fB\-\-file\fR" 4 +.IP \fB\-\-file\fR 4 .IX Item "--file" List all filenames containing \fIwhat\fR. -.IP "\fB\-\-all\fR" 4 +.IP \fB\-\-all\fR 4 .IX Item "--all" Search everything: package names, descriptions and filenames. -.IP "\fB\-\-global\fR" 4 +.IP \fB\-\-global\fR 4 .IX Item "--global" Search the TeX Live Database of the installation medium, instead of the local installation. -.IP "\fB\-\-word\fR" 4 +.IP \fB\-\-word\fR 4 .IX Item "--word" Restrict the search of package names and descriptions (but not filenames) to match only full words. For example, searching for @@ -1398,7 +1320,7 @@ filenames) to match only full words. For example, searching for .RE .RS 4 .RE -.SS "shell" +.SS shell .IX Subsection "shell" Starts an interactive mode, where tlmgr prompts for commands. This can be used directly, or for scripting. The first line of output is @@ -1407,33 +1329,33 @@ protocol version (currently 1). .PP In general, tlmgr actions that can be given on the command line translate to commands in this shell mode. For example, you can say -\&\f(CW\*(C`update \-\-list\*(C'\fR to see what would be updated. The \s-1TLPDB\s0 is loaded the +\&\f(CW\*(C`update \-\-list\*(C'\fR to see what would be updated. The TLPDB is loaded the first time it is needed (not at the beginning), and used for the rest of the session. .PP Besides these actions, a few commands are specific to shell mode: -.IP "protocol" 4 +.IP protocol 4 .IX Item "protocol" -Print \f(CW\*(C`protocol \f(CIn\f(CW\*(C'\fR, the current protocol version. -.IP "help" 4 +Print \f(CW\*(C`protocol \fR\f(CIn\fR\f(CW\*(C'\fR, the current protocol version. +.IP help 4 .IX Item "help" Print pointers to this documentation. -.IP "version" 4 +.IP version 4 .IX Item "version" Print tlmgr version information. -.IP "quit, end, bye, byebye, \s-1EOF\s0" 4 +.IP "quit, end, bye, byebye, EOF" 4 .IX Item "quit, end, bye, byebye, EOF" Exit. -.IP "restart" 4 +.IP restart 4 .IX Item "restart" Restart \f(CW\*(C`tlmgr shell\*(C'\fR with the original command line; most useful when developing \f(CW\*(C`tlmgr\*(C'\fR. .IP "load [local|remote]" 4 .IX Item "load [local|remote]" -Explicitly load the local or remote, respectively, \s-1TLPDB.\s0 -.IP "save" 4 +Explicitly load the local or remote, respectively, TLPDB. +.IP save 4 .IX Item "save" -Save the local \s-1TLPDB,\s0 presumably after other operations have changed it. +Save the local TLPDB, presumably after other operations have changed it. .IP "get [\fIvar\fR] =item set [\fIvar\fR [\fIval\fR]]" 4 .IX Item "get [var] =item set [var [val]]" Get the value of \fIvar\fR, or set it to \fIval\fR. Possible \fIvar\fR names: @@ -1446,10 +1368,10 @@ repository location. The \f(CW\*(C`prompt\*(C'\fR variable takes a string, and s current default prompt. .Sp If \fIvar\fR or then \fIval\fR is not specified, it is prompted for. -.SS "show" +.SS show .IX Subsection "show" -Synonym for \*(L"info\*(R". -.SS "uninstall" +Synonym for "info". +.SS uninstall .IX Subsection "uninstall" Synonym for remove. .SS "update [\fIoption\fP...] [\fIpkg\fP...]" @@ -1457,7 +1379,7 @@ Synonym for remove. 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 +.IP \fB\-\-all\fR 4 .IX Item "--all" Update all installed packages except for \f(CW\*(C`tlmgr\*(C'\fR itself. If updates to \&\f(CW\*(C`tlmgr\*(C'\fR itself are present, this gives an error, unless also the option @@ -1495,7 +1417,7 @@ record the repository from which packages come from.) .Sp If you want to exclude some packages from the current update run (e.g., due to a slow link), see the \f(CW\*(C`\-\-exclude\*(C'\fR option below. -.IP "\fB\-\-self\fR" 4 +.IP \fB\-\-self\fR 4 .IX Item "--self" Update \f(CW\*(C`tlmgr\*(C'\fR itself (that is, the infrastructure packages) if updates to it are present. On Windows this includes updates to the private Perl @@ -1514,7 +1436,7 @@ In short: \& tlmgr update \-\-force \-\-all # update all packages but *not* infrastructure \& # ... this last at your own risk, not recommended! .Ve -.IP "\fB\-\-dry\-run\fR" 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. This is a more detailed report than \f(CW\*(C`\-\-list\*(C'\fR. @@ -1544,7 +1466,7 @@ its related platform-specific packages \fIpkg.ARCH\fR. For example, .Ve .Sp will not update \f(CW\*(C`a2ping\*(C'\fR, \f(CW\*(C`a2ping.i386\-linux\*(C'\fR, or -any other \f(CW\*(C`a2ping.\*(C'\fR\fI\s-1ARCH\s0\fR package. +any other \f(CW\*(C`a2ping.\*(C'\fR\fIARCH\fR package. .Sp If this option specifies a package that would otherwise be a candidate for auto-installation, auto-removal, or reinstallation of a forcibly @@ -1586,7 +1508,7 @@ is equivalent to .Sp Again, since packages are sometimes renamed or replaced, using this option is not recommended. -.IP "\fB\-\-reinstall\-forcibly\-removed\fR" 4 +.IP \fB\-\-reinstall\-forcibly\-removed\fR 4 .IX Item "--reinstall-forcibly-removed" Under normal circumstances \f(CW\*(C`tlmgr\*(C'\fR will not install packages that have been forcibly removed by the user; that is, removed with \f(CW\*(C`remove @@ -1600,7 +1522,7 @@ installation with the server's idea of what is available: .Vb 1 \& tlmgr update \-\-reinstall\-forcibly\-removed \-\-all .Ve -.IP "\fB\-\-backup\fR" 4 +.IP \fB\-\-backup\fR 4 .IX Item "--backup" .PD 0 .IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4 @@ -1611,11 +1533,11 @@ updating; that is, backing up packages as currently installed. If neither option is given, no backup will made. If \f(CW\*(C`\-\-backupdir\*(C'\fR is given and specifies a writable directory then a backup will be made in that location. If only \f(CW\*(C`\-\-backup\*(C'\fR is given, then a backup will be made -to the directory previously set via the \*(L"option\*(R" action (see +to the directory previously set via the "option" action (see below). If both are given then a backup will be made to the specified \&\fIdirectory\fR. .Sp -You can also set options via the \*(L"option\*(R" action to automatically make +You can also set options via the "option" action to automatically make backups for all packages, and/or keep only a certain number of backups. .Sp \&\f(CW\*(C`tlmgr\*(C'\fR always makes a temporary backup when updating packages, in case @@ -1624,16 +1546,16 @@ of this \f(CW\*(C`\-\-backup\*(C'\fR option is to save a persistent backup in ca actual \fIcontent\fR of the update causes problems, e.g., introduces an TeX incompatibility. .Sp -The \*(L"restore\*(R" action explains how to restore from a backup. -.IP "\fB\-\-no\-depends\fR" 4 +The "restore" 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 suppresses this behavior. -.IP "\fB\-\-no\-depends\-at\-all\fR" 4 +.IP \fB\-\-no\-depends\-at\-all\fR 4 .IX Item "--no-depends-at-all" See above under install (and beware). -.IP "\fB\-\-force\fR" 4 +.IP \fB\-\-force\fR 4 .IX Item "--force" Force update of normal packages, without updating \f(CW\*(C`tlmgr\*(C'\fR itself (unless the \f(CW\*(C`\-\-self\*(C'\fR option is also given). Not recommended. @@ -1652,7 +1574,7 @@ repositories, which do not generally have (m)any mirrors, no pruning of backups is done. .PP This action does not automatically add or remove new symlinks in system -directories; you need to run \f(CW\*(C`tlmgr\*(C'\fR \*(L"path\*(R" yourself if you are using +directories; you need to run \f(CW\*(C`tlmgr\*(C'\fR "path" yourself if you are using this feature and want new symlinks added. .SH "CONFIGURATION FILE FOR TLMGR" .IX Header "CONFIGURATION FILE FOR TLMGR" @@ -1681,8 +1603,8 @@ The allowed keys are: .el .IP "\f(CWauto\-remove =\fR 0 or 1 (default 1), same as command-line option." 4 .IX Item "auto-remove = 0 or 1 (default 1), same as command-line option." .PD 0 -.ie n .IP """gui\-expertmode ="" 0 or 1 (default 1). This switches between the full \s-1GUI\s0 and a simplified \s-1GUI\s0 with only the most common settings." 4 -.el .IP "\f(CWgui\-expertmode =\fR 0 or 1 (default 1). This switches between the full \s-1GUI\s0 and a simplified \s-1GUI\s0 with only the most common settings." 4 +.ie n .IP """gui\-expertmode ="" 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings." 4 +.el .IP "\f(CWgui\-expertmode =\fR 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings." 4 .IX Item "gui-expertmode = 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings." .ie n .IP """gui\-lang ="" \fIllcode\fR, with a language code value as with the command-line option." 4 .el .IP "\f(CWgui\-lang =\fR \fIllcode\fR, with a language code value as with the command-line option." 4 @@ -1713,23 +1635,23 @@ The system-wide config file can contain one additional key: .IX Item "allowed-actions = action1[,action2,...] The value is a comma-separated list (no spaces) of tlmgr actions which are allowed to be executed when tlmgr is invoked in system mode (that is, without --usermode). This allows distributors to include tlmgr in their packaging, but allow only a restricted set of actions that do not interfere with their distro package manager. For native TeX Live installations, it doesn't make sense to set this." .PP Finally, the \f(CW\*(C`no\-checksums\*(C'\fR key needs more explanation. By default, -package checksums computed and stored on the server (in the \s-1TLPDB\s0) are +package checksums computed and stored on the server (in the TLPDB) are compared to checksums computed locally after downloading. \&\f(CW\*(C`no\-checksums\*(C'\fR disables this process. The checksum algorithm is -\&\s-1SHA\-512.\s0 Your system must have one of (looked for in this order) the +SHA\-512. Your system must have one of (looked for in this order) the Perl \f(CW\*(C`Digest::SHA\*(C'\fR module, the \f(CW\*(C`openssl\*(C'\fR program -(<https://openssl.org>), the \f(CW\*(C`sha512sum\*(C'\fR program (from \s-1GNU\s0 Coreutils, +(<https://openssl.org>), the \f(CW\*(C`sha512sum\*(C'\fR program (from GNU Coreutils, <https://www.gnu.org/software/coreutils>), or finally the \f(CW\*(C`shasum\*(C'\fR program (just to support old Macs). If none of these are available, a warning is issued and \f(CW\*(C`tlmgr\*(C'\fR proceeds without checking checksums. -\&\f(CW\*(C`no\-checksums\*(C'\fR avoids the warning. (Incidentally, other \s-1SHA\s0 +\&\f(CW\*(C`no\-checksums\*(C'\fR avoids the warning. (Incidentally, other SHA implementations, such as the pure Perl and pure Lua modules, are much too slow to be usable in our context.) .SH "CRYPTOGRAPHIC VERIFICATION" .IX Header "CRYPTOGRAPHIC VERIFICATION" \&\f(CW\*(C`tlmgr\*(C'\fR and \f(CW\*(C`install\-tl\*(C'\fR perform cryptographic verification if possible. If verification is performed and successful, the programs -report \f(CW\*(C`(verified)\*(C'\fR after loading the \s-1TLPDB\s0; otherwise, they report +report \f(CW\*(C`(verified)\*(C'\fR after loading the TLPDB; otherwise, they report \&\f(CW\*(C`(not verified)\*(C'\fR. But either way, by default the installation and/or updates proceed normally. .PP @@ -1756,7 +1678,7 @@ above) to succeed, and a working GnuPG (\f(CW\*(C`gpg\*(C'\fR) program (see belo search method). Then, unless cryptographic verification has been disabled, a signature file (\f(CW\*(C`texlive.tlpdb.*.asc\*(C'\fR) of the checksum file is downloaded and the signature verified. The signature is created by -the TeX Live Distribution \s-1GPG\s0 key 0x0D5E5D9106BAB6BC, which in turn is +the TeX Live Distribution GPG key 0x0D5E5D9106BAB6BC, which in turn is signed by Karl Berry's key 0x0716748A30D155AD and Norbert Preining's key 0x6CACA448860CDC13. All of these keys are obtainable from the standard key servers. @@ -1887,7 +1809,7 @@ adding a second repository does not actually enable installation of anything from there. You also have to specify which packages should be taken from the new repository, by specifying so-called ``pinning'' rules, described next. -.SS "Pinning" +.SS Pinning .IX Subsection "Pinning" When a package \f(CW\*(C`foo\*(C'\fR is pinned to a repository, a package \f(CW\*(C`foo\*(C'\fR in any other repository, even if it has a higher revision number, will not be @@ -1965,17 +1887,17 @@ A summary of \f(CW\*(C`tlmgr pinning\*(C'\fR actions is given above. The graphical user interface for \f(CW\*(C`tlmgr\*(C'\fR requires Perl/Tk <https://search.cpan.org/search?query=perl%2Ftk>. For Unix-based systems Perl/Tk (as well as Perl of course) has to be installed -outside of \s-1TL.\s0 <https://tug.org/texlive/distro.html#perltk> has a +outside of TL. <https://tug.org/texlive/distro.html#perltk> has a list of invocations for some distros. For Windows the necessary modules are no longer shipped within TeX Live, so you'll have to have an external Perl available that includes them. .PP -We are talking here about the \s-1GUI\s0 built into tlmgr itself, not about the +We are talking here about the GUI built into tlmgr itself, not about the other tlmgr GUIs, which are: tlshell (Tcl/Tk\-based), tlcockpit (Java-based) and, only on Macs, TeX Live Utility. These are invoked as separate programs. .PP -The \s-1GUI\s0 mode of tlmgr is started with the invocation \f(CW\*(C`tlmgr gui\*(C'\fR; +The GUI mode of tlmgr is started with the invocation \f(CW\*(C`tlmgr gui\*(C'\fR; assuming Tk is loadable, the graphical user interface will be shown. The main window contains a menu bar, the main display, and a status area where messages normally shown on the console are displayed. @@ -1997,21 +1919,21 @@ information about what is going on. The first part of the main display allows you to specify (filter) which packages are shown. By default, all are shown. Changes here are reflected right away. -.IP "Status" 4 +.IP Status 4 .IX Item "Status" Select whether to show all packages (the default), only those installed, only those \fInot\fR installed, or only those with update available. -.IP "Category" 4 +.IP Category 4 .IX Item "Category" Select which categories are shown: packages, collections, and/or -schemes. These are briefly explained in the \*(L"\s-1DESCRIPTION\*(R"\s0 section +schemes. These are briefly explained in the "DESCRIPTION" section above. -.IP "Match" 4 +.IP Match 4 .IX Item "Match" Select packages matching for a specific pattern. By default, this searches both descriptions and filenames. You can also select a subset for searching. -.IP "Selection" 4 +.IP Selection 4 .IX Item "Selection" Select packages to those selected, those not selected, or all. Here, ``selected'' means that the checkbox in the beginning of the line of a @@ -2045,7 +1967,7 @@ The name (identifier) of the package as given in the database. If the package is installed the TeX Live revision number for the installed package will be shown. If there is a catalogue version given in the database for this package, it will be shown in parentheses. -However, the catalogue version, unlike the \s-1TL\s0 revision, is not +However, the catalogue version, unlike the TL revision, is not guaranteed to reflect what is actually installed. .IP "remote revision (and version)" 4 .IX Item "remote revision (and version)" @@ -2069,20 +1991,20 @@ previously removed packages as part of this action. .Sp The other four buttons only work on the selected packages, i.e., those where the checkbox at the beginning of the package line is ticked. -.IP "Update" 4 +.IP Update 4 .IX Item "Update" Update only the selected packages. -.IP "Install" 4 +.IP Install 4 .IX Item "Install" Install the selected packages; acts like \f(CW\*(C`tlmgr install\*(C'\fR, i.e., also installs dependencies. Thus, installing a collection installs all its constituent packages. -.IP "Remove" 4 +.IP Remove 4 .IX Item "Remove" Removes the selected packages; acts like \f(CW\*(C`tlmgr remove\*(C'\fR, i.e., it will also remove dependencies of collections (but not dependencies of normal packages). -.IP "Backup" 4 +.IP Backup 4 .IX Item "Backup" Makes a backup of the selected packages; acts like \f(CW\*(C`tlmgr backup\*(C'\fR. This action needs the option \f(CW\*(C`backupdir\*(C'\fR set (see \f(CW\*(C`Options \-\*(C'\fR General>). @@ -2102,13 +2024,13 @@ manually-entered one. Also has the so-necessary \f(CW\*(C`quit\*(C'\fR operatio Provides access to several groups of options: \f(CW\*(C`Paper\*(C'\fR (configuration of default paper sizes), \f(CW\*(C`Platforms\*(C'\fR (only on Unix, configuration of the supported/installed platforms), \f(CW\*(C`GUI Language\*(C'\fR (select language used in -the \s-1GUI\s0 interface), and \f(CW\*(C`General\*(C'\fR (everything else). +the GUI interface), and \f(CW\*(C`General\*(C'\fR (everything else). .Sp Several toggles are also here. The first is \f(CW\*(C`Expert options\*(C'\fR, which is -set by default. If you turn this off, the next time you start the \s-1GUI\s0 a +set by default. If you turn this off, the next time you start the GUI a simplified screen will be shown that display only the most important functionality. This setting is saved in the configuration file of -\&\f(CW\*(C`tlmgr\*(C'\fR; see \*(L"\s-1CONFIGURATION FILE FOR TLMGR\*(R"\s0 for details. +\&\f(CW\*(C`tlmgr\*(C'\fR; see "CONFIGURATION FILE FOR TLMGR" for details. .Sp The other toggles are all off by default: for debugging output, to disable the automatic installation of new packages, and to disable the @@ -2131,7 +2053,7 @@ on Windows). .IX Item "Help menu" Provides access to the TeX Live manual (also on the web at <https://tug.org/texlive/doc.html>) and the usual ``About'' box. -.SS "\s-1GUI\s0 options" +.SS "GUI options" .IX Subsection "GUI options" Some generic Perl/Tk options can be specified with \f(CW\*(C`tlmgr gui\*(C'\fR to control the display: @@ -2140,7 +2062,7 @@ control the display: .IX Item "-background color" Set background color. .ie n .IP """\-font """" \fIfontname\fR \fIfontsize\fR """"""" 4 -.el .IP "\f(CW\-font ``\fR \fIfontname\fR \fIfontsize\fR \f(CW''\fR" 4 +.el .IP "\f(CW\-font ""\fR \fIfontname\fR \fIfontsize\fR \f(CW""\fR" 4 .IX Item "-font "" fontname fontsize """ Set font, e.g., \f(CW\*(C`tlmgr gui \-font "helvetica 18"\*(C'\fR. The argument to \&\f(CW\*(C`\-font\*(C'\fR must be quoted, i.e., passed as a single string. @@ -2173,7 +2095,7 @@ information it needs by reading stdout. Currently this option only applies to the update, install, and -\&\*(L"option\*(R" actions. +"option" actions. .ie n .SS "Machine-readable ""update"" and ""install"" output" .el .SS "Machine-readable \f(CWupdate\fP and \f(CWinstall\fP output" .IX Subsection "Machine-readable update and install output" @@ -2202,7 +2124,7 @@ are only present for updated and auto-install packages, and contain the currently passed time since start of installation/updates and the estimated total time. .PP -Line endings may be either \s-1LF\s0 or \s-1CRLF\s0 depending on the current platform. +Line endings may be either LF or CRLF depending on the current platform. .ie n .IP """location\-url"" \fIlocation\fR" 4 .el .IP "\f(CWlocation\-url\fR \fIlocation\fR" 4 .IX Item "location-url location" @@ -2220,67 +2142,67 @@ Then comes a line with only the literal string \f(CW\*(C`end\-of\-header\*(C'\fR 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 +.IP \fIpkgname\fR 4 .IX Item "pkgname" The TeX Live package identifier, with a possible platform 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 +.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 +.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 +.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 +.el .IP \f(CWu\fR 8 .IX Item "u" Normal update is needed. .ie n .IP """r""" 8 -.el .IP "\f(CWr\fR" 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 +.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. .ie n .IP """i""" 8 -.el .IP "\f(CWi\fR" 8 +.el .IP \f(CWi\fR 8 .IX Item "i" Package will be installed and isn't present in the local installation (action install). .ie n .IP """I""" 8 -.el .IP "\f(CWI\fR" 8 +.el .IP \f(CWI\fR 8 .IX Item "I" Package is already present but will be reinstalled (action install). .RE .RS 4 .RE -.IP "\fIlocalrev\fR" 4 +.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 +.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 +.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. -.IP "\fIruntime\fR" 4 +.IP \fIruntime\fR 4 .IX Item "runtime" The run time since start of installations or updates. -.IP "\fIesttot\fR" 4 +.IP \fIesttot\fR 4 .IX Item "esttot" The estimated total time. .ie n .SS "Machine-readable ""option"" output" @@ -2299,27 +2221,27 @@ changes would be helpful, do not hesitate to write the mailing list. .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" \&\f(CW\*(C`tlmgr\*(C'\fR uses many of the standard TeX environment variables, as -reported by, e.g., \f(CW\*(C`tlmgr conf\*(C'\fR (\*(L"conf\*(R"). +reported by, e.g., \f(CW\*(C`tlmgr conf\*(C'\fR ("conf"). .PP In addition, for ease in scripting and debugging, \f(CW\*(C`tlmgr\*(C'\fR looks for the following environment variables. These are not of interest for normal user installations. .ie n .IP """TEXLIVE_COMPRESSOR""" 4 -.el .IP "\f(CWTEXLIVE_COMPRESSOR\fR" 4 +.el .IP \f(CWTEXLIVE_COMPRESSOR\fR 4 .IX Item "TEXLIVE_COMPRESSOR" This variable allows selecting a different compressor program for backups and intermediate rollback containers. The order of selection is: .RS 4 -.IP "1." 8 +.IP 1. 8 If the environment variable \f(CW\*(C`TEXLIVE_COMPRESSOR\*(C'\fR is defined, use it; abort if it doesn't work. Possible values: \&\f(CW\*(C`lz4\*(C'\fR, \f(CW\*(C`gzip\*(C'\fR, \f(CW\*(C`xz\*(C'\fR. The necessary options are added internally. -.IP "2." 8 -If lz4 is available (either from the system or \s-1TL\s0) and working, use that. -.IP "3." 8 +.IP 2. 8 +If lz4 is available (either from the system or TL) and working, use that. +.IP 3. 8 If gzip is available (from the system) and working, use that. -.IP "4." 8 -If xz is available (either from the system or \s-1TL\s0) and working, use that. +.IP 4. 8 +If xz is available (either from the system or TL) and working, use that. .RE .RS 4 .Sp @@ -2328,42 +2250,42 @@ are preferred. The unconditional use of xz for the tlnet containers is unaffected, to minimize download sizes. .RE .ie n .IP """TEXLIVE_DOWNLOADER""" 4 -.el .IP "\f(CWTEXLIVE_DOWNLOADER\fR" 4 +.el .IP \f(CWTEXLIVE_DOWNLOADER\fR 4 .IX Item "TEXLIVE_DOWNLOADER" .PD 0 .ie n .IP """TL_DOWNLOAD_PROGRAM""" 4 -.el .IP "\f(CWTL_DOWNLOAD_PROGRAM\fR" 4 +.el .IP \f(CWTL_DOWNLOAD_PROGRAM\fR 4 .IX Item "TL_DOWNLOAD_PROGRAM" .ie n .IP """TL_DOWNLOAD_ARGS""" 4 -.el .IP "\f(CWTL_DOWNLOAD_ARGS\fR" 4 +.el .IP \f(CWTL_DOWNLOAD_ARGS\fR 4 .IX Item "TL_DOWNLOAD_ARGS" .PD These options allow selecting different download programs then the ones automatically selected by the installer. The order of selection is: .RS 4 -.IP "1." 8 +.IP 1. 8 If the environment variable \f(CW\*(C`TEXLIVE_DOWNLOADER\*(C'\fR is defined, use it; abort if the specified program doesn't work. Possible values: \f(CW\*(C`lwp\*(C'\fR, \&\f(CW\*(C`curl\*(C'\fR, \f(CW\*(C`wget\*(C'\fR. The necessary options are added internally. -.IP "2." 8 +.IP 2. 8 If the environment variable \f(CW\*(C`TL_DOWNLOAD_PROGRAM\*(C'\fR is defined (can be any value), use it together with \&\f(CW\*(C`TL_DOWNLOAD_ARGS\*(C'\fR; abort if it doesn't work. -.IP "3." 8 -If \s-1LWP\s0 is available and working, use that (by far the most +.IP 3. 8 +If LWP is available and working, use that (by far the most efficient method, as it supports persistent downloads). -.IP "4." 8 +.IP 4. 8 If curl is available (from the system) and working, use that. -.IP "5." 8 -If wget is available (either from the system or \s-1TL\s0) and working, use that. +.IP 5. 8 +If wget is available (either from the system or TL) and working, use that. .RE .RS 4 .Sp -\&\s-1TL\s0 provides \f(CW\*(C`wget\*(C'\fR binaries for platforms where necessary, so some +TL provides \f(CW\*(C`wget\*(C'\fR binaries for platforms where necessary, so some download method should always be available. .RE .ie n .IP """TEXLIVE_PREFER_OWN""" 4 -.el .IP "\f(CWTEXLIVE_PREFER_OWN\fR" 4 +.el .IP \f(CWTEXLIVE_PREFER_OWN\fR 4 .IX Item "TEXLIVE_PREFER_OWN" By default, compression and download programs provided by the system, i.e., found along \f(CW\*(C`PATH\*(C'\fR are preferred over those shipped with TeX @@ -2371,20 +2293,20 @@ Live. .Sp This can create problems with systems that are too old, and so can be overridden by setting the environment variable \f(CW\*(C`TEXLIVE_PREFER_OWN\*(C'\fR to -1. In this case, executables shipped with \s-1TL\s0 will be preferred. +1. In this case, executables shipped with TL will be preferred. .Sp -Extra compression/download programs not provided by \s-1TL,\s0 such as gzip, +Extra compression/download programs not provided by TL, such as gzip, lwp, and curl, are still checked for on the system and used if available, per the above. \f(CW\*(C`TEXLIVE_PREFER_OWN\*(C'\fR only applies when the -program being checked for is shipped with \s-1TL,\s0 namely the lz4 and +program being checked for is shipped with TL, namely the lz4 and xz compressors and wget downloader. .Sp -Exception: on Windows, the \f(CW\*(C`tar.exe\*(C'\fR shipped with \s-1TL\s0 is always used, +Exception: on Windows, the \f(CW\*(C`tar.exe\*(C'\fR shipped with TL is always used, regardless of any setting. .SH "AUTHORS AND COPYRIGHT" .IX Header "AUTHORS AND COPYRIGHT" This script and its documentation were written for the TeX Live distribution (<https://tug.org/texlive>) and both are licensed under the -\&\s-1GNU\s0 General Public License Version 2 or later. +GNU General Public License Version 2 or later. .PP -\&\f(CW$Id:\fR tlmgr.pl 66798 2023\-04\-08 00:15:21Z preining $ +\&\f(CW$Id:\fR tlmgr.pl 68283 2023\-09\-15 13:11:11Z preining $ |