tlbuild: install-tl OPTIONS
A.5 OPTIONS
===========
As usual, all options can be specified in any order, and with either a
leading '-' or '--'. An argument value can be separated from its option
by either a space or '='.
*-gui* [[=]_module_]
If no _module_ is given, starts the Tcl/Tk (see below) GUI
installer.
If _module_ is given loads the given installer module. Currently
the following modules are supported:
'text'
The text mode user interface (default on Unix systems,
including Macs). Same as the '-no-gui' option.
'tcl' (or "perltk" or "wizard" or "expert" or nothing)
The Tcl/Tk user interface (default on Windows). It starts
with a small number of configuration options, roughly
equivalent to what the former wizard option offers, but a
button 'Advanced' takes you to a screen with roughly the same
options as the former 'perltk' interface.
The default GUI requires Tcl/Tk. This is standard on Macs
(although it is considered deprecated since Catalina) and is often
already installed on GNU/Linux, or can be easily installed through
a distro package manager. For Windows, TeX Live provides a Tcl/Tk
runtime.
*-no-gui*
Use the text mode installer (default except on Windows and Macs).
*-lang* _llcode_
By default, the Tcl GUI uses the language detection built into
Tcl/Tk. 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).
*-repository* _url|path_
Specify the package repository to be used as the source of the
installation. In short, this can be a directory name or a url
using http(s), ftp, or scp. The documentation for 'tlmgr' has the
details (<https://tug.org/texlive/doc/tlmgr.html#OPTIONS>).
For installation, the default is to pick a mirror automatically,
using <http://mirror.ctan.org/systems/texlive/tlnet>; the chosen
mirror is used for the entire download. You can use the special
argument 'ctan' as an abbreviation for this. (See
<https://ctan.org> for more about CTAN and its mirrors.)
After installation is complete, you can use that installation as
the repository for another installation. If you chose to install
less than the full scheme containing all packages, the list of
available schemes will be adjusted accordingly.
*-select-repository*
This option allows you to choose a particular mirror from the
current list of active CTAN mirrors. This option is supported in
the 'text' and 'gui' installer modes, and will also offer to
install from local media if available, or from a repository
specified on the command line. It's useful when the (default)
automatic redirection does not choose a good host for you.
*-all-options*
Normally options not relevant to the current platform are not shown
(e.g., when running on Unix, Windows-specific options are omitted).
Giving this command line option allows configuring such "foreign"
settings.
*-custom-bin* _path_
If you have built your own set of TeX Live binaries (perhaps
because your platform was not supported by TeX Live out of the
box), this option allows you to specify the _path_ to a directory
where the binaries for the current system are present. The
installation will continue as usual, but at the end all files from
_path_ are copied over to 'bin/custom/' under your installation
directory and this 'bin/custom/' directory is what will be added to
the path for the post-install actions. To install multiple custom
binary sets, manually rename 'custom' before doing each.
For more information on custom binaries, see
<https://tug.org/texlive/custom-bin.html>. For general information
on building TeX Live, see <https://tug.org/texlive/build.html>.
*-debug-translation*
In the former Perl/Tk GUI modes, this option reported any missing,
or more likely untranslated, messages to standard error. Not yet
implemented for the Tcl interface. Helpful for translators to see
what remains to be done.
*-force-platform* _platform_
Instead of auto-detecting the current platform, use _platform_.
Binaries for this platform must be present and they must actually
be runnable, or installation will fail. '-force-arch' is a
synonym.
*-help*, *-help*, *-?*
Display this help and exit. (This help is also on the web at
<https://tug.org/texlive/doc/install-tl.html>). Sometimes the
'perldoc' and/or 'PAGER' programs on the system have problems,
possibly resulting in control characters being literally output.
This can't always be detected, but you can set the 'NOPERLDOC'
environment variable and 'perldoc' will not be used.
*-in-place*
This is a quick-and-dirty installation option in case you already
have an rsync or svn checkout of TeX Live. It will use the
checkout as-is and will just do the necessary post-install. Be
warned that the file 'tlpkg/texlive.tlpdb' may be rewritten, that
removal has to be done manually, and that the only realistic way to
maintain this installation is to redo it from time to time. This
option is not available via the installer interfaces. USE AT YOUR
OWN RISK.
*-init-from-profile* _profile_file_
Similar to *-profile* (see ⇒PROFILES install-tl PROFILES.
below), but only initializes the installation configuration from
_profile_file_ and then starts a normal interactive session.
Environment variables are not ignored.
*-logfile* _file_
Write both all messages (informational, debugging, warnings) to
_file_, in addition to standard output or standard error.
If this option is not given, the installer will create a log file
in the root of the writable installation tree, for example,
'/usr/local/texlive/YYYY/install-tl.log' for the _YYYY_ release.
*-no-cls*
For the text mode installer only: do not clear the screen when
entering a new menu (for debugging purposes).
*-no-persistent-downloads*
*-persistent-downloads*
For network installs, activating this option makes the installer
try to set up a persistent connection using the 'Net::LWP' Perl
module. This opens only one connection between your computer and
the server per session and reuses it, instead of initiating a new
download for each package, which typically yields a significant
speed-up.
This option is turned on by default, and the installation program
will fall back to using 'wget' if this is not possible. To disable
usage of LWP and persistent connections, use
'-no-persistent-downloads'.
*-no-verify-downloads*
By default, if a GnuPG 'gpg' binary is found in PATH, downloads are
verified against a cryptographic signature. This option disables
such verification. The full description is in the Crytographic
Verification section of the 'tlmgr' documentation, e.g.,
<https://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION>
*-non-admin*
For Windows only: configure for the current user, not for all
users.
*-portable*
Install for portable use, e.g., on a USB stick. Also selectable
from within the perltk and text installers.
*-print-platform*
Print the TeX Live identifier for the detected platform
(hardware/operating system) combination to standard output, and
exit. '-print-arch' is a synonym.
*-profile* _profile_file_
Load _profile_file_ and do the installation with no user
interaction, that is, a batch (unattended) install. Environment
variables are ignored. See ⇒PROFILES install-tl PROFILES.
below.
*-q*
Omit normal informational messages.
*-scheme* _scheme_
Schemes are the highest level of package grouping in TeX Live; the
default is to use the 'full' scheme, which includes everything.
This option overrides that default. You can change the scheme
again before the actual installation with the usual menu. The
_scheme_ argument may optionally have a prefix 'scheme-'. The list
of supported scheme names depends on what your package repository
provides; see the interactive menu list.
*-v*
Include verbose debugging messages; repeat for maximum debugging:
'-v -v'. (Further repeats are accepted but ignored.)
*-version*, *-version*
Output version information and exit. If '-v' is also given, the
versions of the TeX Live modules used are also reported.
Info Catalog
tlbuild: install-tl REFERENCES
tlbuild: install-tl
tlbuild: install-tl PROFILES