tlbuild: install-tl OPTIONS
A.6 install-tl 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 '='.
The options relating to customization of the installation can also be
selected in the interactive installation menus (GUI or text).
*-gui* [[=]_module_]
*-no-gui*
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 was standard on Macs, but
has been removed in the latest macOS releases. It's 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.
*-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 <https://mirror.ctan.org/systems/texlive/tlnet>; the chosen
mirror is then 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 (e.g., because
precompiled binaries were not provided by TL for your platform),
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-fakenet*
Pretend we're doing a network install. This is for the sole
purpose of testing the code to handle broken downloads, via moving
package files aside in a tlnet mirror hierarchy.
*-debug-setup-vars*
Print final values of directory variables; for more debugging
information on how they were set, also specify '-v'.
*-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 in 'bin/'_platform_'/'
and they must 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.
*-no-continue*
Quit early on installation failure of a non-core package.
By default, a few core packages are installed first; then, a failed
installation of any other (non-core) package is noted, but does not
stop the installation. Any such failed packages are retried, once.
If the retry also fails, by default the installer proceeds to
completion anyway, with the idea that it was a transient network
problem and reinstallation will succeed later. If this option is
specified, and the retry fails, the installer aborts.
*-no-doc-install*
*-no-src-install*
Do not install the documentation resp. source package files, both
for the immediate installation and for future updates. After
installation, inclusion of the doc/src files can be re-enabled via
'tlmgr':
tlmgr option docfiles 1
tlmgr option srcfiles 1
If you later find that you want the doc/src files for a package
that has been installed without them, you can get them like this
(using the 'fontspec' package as the example):
tlmgr install --reinstall --with-doc --with-src fontspec
The source files mentioned here are those relating to TeX packages,
such as '.dtx' files. The sources that are compiled to make the
binaries are available separately: see
<https://tug.org/texlive/svn/>.
*-no-installation*
Do not perform any installation. This is for debugging the
initialization and setup routines without touching the disk.
*-no-interaction*
Do not enter the interactive menu; immediately perform the
installation after initialization and option parsing. Also omit
the check for a previous installation and asking about importing
previous settings.
*-no-persistent-downloads*
*-persistent-downloads*
For network installs, activating this option makes the installer
try to set up a persistent connection using the '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.
*-paper* 'a4'*|*'letter'
Set the default paper size for all TeX Live programs, as specified.
The default is 'a4'. The paper size can be set after installation
with the 'tlmgr paper' command.
*-portable*
Install for portable use, e.g., on a USB stick. See the
'instopt_portable' description below for details.
*-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. The _scheme_ argument value
may optionally have a prefix 'scheme-'. The list of supported
scheme names depends on what your package repository provides; see
the interactive menu list.
*-texdir* _dir_
Specify the system installation directory; the default is
'/usr/local/texlive/YYYY' for release YYYY. Specifying this option
also causes the 'TEXMFLOCAL', 'TEXMFSYSCONFIG', and 'TEXMFSYSVAR'
directories to be set as subdirectories of _dir_, so they don't
have to be set individually.
There is a brief summary of these directories trees at ⇒
DIRECTORY TREES install-tl DIRECTORY TREES. below; for details on
the trees set up by default, and their intended usage, see the main
TeX Live documentation at <https://tug.org/texlive/doc>.
*-texuserdir* _dir_
Specify the user installation directory; the default is
'~/.texliveYYYY' (except on Macs, where there is no leading dot).
Specifying this also causes the 'TEXMFHOME', 'TEXMFCONFIG', and
'TEXMFVAR' directories to be set as subdirectories of _dir_.
*-texmflocal* _dir_
Specify the 'TEXMFLOCAL' directory; the default is
'/usr/local/texlive/texmf-local', that is, one level up from the
main installation. This is so locally-installed packages can be
easily used across releases, which is usually desirable.
Specifying the '-texdir' option changes this, putting 'TEXMFLOCAL'
under the main tree. The '-texmflocal' option can be used to
specify an explicit directory.
Anything installed here must follow the TeX directory structure
(TDS), e.g., 'TEXMFHOME/tex/latex/mypkg/mypkg.sty'. TDS reference:
<https://tug.org/tds>.
*-texmfhome* _dir_
Specify the 'TEXMFHOME' directory; the default is '~/texmf', except
on Macs, where it is '~/Library/texmf'. Analogously to
'TEXMFLOCAL', the '-texuserdir' option changes this default.
Also as with 'TEXMFLOCAL', anything installed here must follow the
TDS.
*-texmfsysconfig* _dir_
*-texmfsysvar* _dir_
Specify the 'TEXMFSYSCONFIG' and 'TEXMFSYSVAR' system directories.
*-texmfconfig* _dir_
*-texmfvar* _dir_
Specify the 'TEXMFCONFIG' and 'TEXMFVAR' user directories. The
defaults are '~/.texliveYYYY/texmf-{config,var}', except on Macs,
where the leading dot is omitted ('~/texliveYYYY/...').
*-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 EXAMPLES
tlbuild: install-tl
tlbuild: install-tl PROFILES