tlbuild: tlmgr OPTIONS
B.5 OPTIONS
===========
The following options to 'tlmgr' are global options, not specific to any
action. All options, whether global or action-specific, can be given
anywhere on the command line, and in any order. The first non-option
argument will be the main action. In all cases, '--'_option_ and
'-'_option_ are equivalent, and an '=' is optional between an option
name and its value.
*-repository* _url|path_
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 TLPDB,
which is given entirely in the file 'tlpkg/texlive.tlpdb').
This '--repository' option changes the location only for the
current run; to make a permanent change, use 'option repository'
(see the ⇒option tlmgr option. action).
As an example, you can choose a particular CTAN mirror with
something like this:
-repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet
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>.
Here's an example of using a local directory:
-repository /local/TL/repository
For backward compatibility and convenience, '--location' and
'--repo' are accepted as aliases for this option.
Locations can be specified as any of the following:
'/some/local/dir'
'file:/some/local/dir'
Equivalent ways of specifying a local directory.
'ctan'
'http://mirror.ctan.org/systems/texlive/tlnet'
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 'ctan' is merely an alias for the
full url. (See <https://ctan.org> for more about CTAN and its
mirrors.)
'http://server/path/to/tlnet'
Standard HTTP. If the (default) LWP method is used, persistent
connections are supported. TL can also use 'curl' or 'wget'
to do the downloads, or an arbitrary user-specified program,
as described in the 'tlmgr' documentation
(<https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES>).
'https://server/path/to/tlnet'
Again, if the (default) LWP method is used, this supports
persistent connections. Unfortunately, some versions of
'wget' and 'curl' do not support https, and even when 'wget'
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.
'ftp://server/path/to/tlnet'
If the (default) LWP method is used, persistent connections
are supported.
'user@machine:/path/to/tlnet'
'scp://user@machine/path/to/tlnet'
'ssh://user@machine/path/to/tlnet'
These forms are equivalent; they all use 'scp' to transfer
files. Using 'ssh-agent' is recommended. (Info:
<https://en.wikipedia.org/wiki/OpenSSH>,
<https://en.wikipedia.org/wiki/Ssh-agent>.)
If the repository is on the network, trailing '/' characters and/or
trailing '/tlpkg' and/or '/archive' components are ignored.
*-gui* [_action_]
Two notable GUI front-ends for 'tlmgr', 'tlshell' and 'tlcockpit',
are started up as separate programs; see their own documentation.
'tlmgr' itself has a graphical interface as well as the command
line interface. You can give the option to invoke it, '--gui',
together with an action to be brought directly into the respective
screen of the GUI. For example, running
tlmgr --gui update
starts you directly at the update screen. If no action is given,
the GUI will be started at the main screen. See ⇒GUI FOR
TLMGR tlmgr GUI FOR TLMGR.
However, the native GUI requires Perl/TK, which is no longer
included in TeX Live's Perl distribution for Windows. You may find
'tlshell' or 'tlcockpit' easier to work with.
*-gui-lang* _llcode_
By default, the GUI tries to deduce your language from the
environment (on Windows via the registry, on Unix via
'LC_MESSAGES'). If that fails you can select a different language
by giving this option with a 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).
tlshell shares its message catalog with tlmgr.
*-command-logfile* _file_
'tlmgr' logs the output of all programs invoked (mktexlr, mtxrun,
fmtutil, updmap) to a separate log file, by default
'TEXMFSYSVAR/web2c/tlmgr-commands.log'. This option allows you to
specify a different file for the log.
*-debug-translation*
In GUI mode, this switch tells 'tlmgr' to report any untranslated
(or missing) messages to standard error. This can help translators
to see what remains to be done.
*-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 ⇒MACHINE-READABLE OUTPUT tlmgr
MACHINE-READABLE OUTPUT. section below.
*-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 debugging.
*-package-logfile* _file_
'tlmgr' logs all package actions (install, remove, update, failed
updates, failed restores) to a separate log file, by default
'TEXMFSYSVAR/web2c/tlmgr.log'. This option allows you to specify a
different file for the log.
*-pause*
This option makes 'tlmgr' wait for user input before exiting.
Useful on Windows to avoid disappearing command windows.
*-persistent-downloads*
*-no-persistent-downloads*
For network-based installations, this option (on by default) makes
'tlmgr' try to set up a persistent connection (using the 'LWP' Perl
module). The idea is to open and reuse only one connection per
session between your computer and the server, instead of initiating
a new download for each package.
If this is not possible, 'tlmgr' will fall back to using 'wget'.
To disable these persistent connections, use
'--no-persistent-downloads'.
*-pin-file*
Change the pinning file location from
'TEXMFLOCAL/tlpkg/pinning.txt' (see ⇒Pinning tlmgr Pinning.
below). Documented only for completeness, as this is only useful
in debugging.
*-usermode*
Activates user mode for this run of 'tlmgr'; see ⇒USER MODE
tlmgr USER MODE. below.
*-usertree* _dir_
Uses _dir_ for the tree in user mode; see ⇒USER MODE tlmgr
USER MODE. below.
*-verify-repo=[none|main|all]*
Defines the level of verification done: If 'none' is specified, no
verification whatsoever is done. If 'main' is given and a working
GnuPG ('gpg') binary is available, all repositories are checked,
but only the main repository is required to be signed. If 'all' is
given, then all repositories need to be signed. See ⇒
CRYPTOGRAPHIC VERIFICATION tlmgr CRYPTOGRAPHIC VERIFICATION. below
for details.
The standard options for TeX Live programs are also accepted:
'--help/-h/-?', '--version', '-q' (no informational messages), '-v'
(debugging messages, can be repeated). For the details about these, see
the 'TeXLive::TLUtils' documentation.
The '--version' option shows version information about the TeX Live
release and about the 'tlmgr' script itself. If '-v' is also given,
revision number for the loaded TeX Live Perl modules are shown, too.
Info Catalog
tlbuild: tlmgr EXAMPLES
tlbuild: tlmgr
tlbuild: tlmgr ACTIONS