install-tl man page
install-tl — TeX Live cross-platform installer
This installer creates a runnable TeX Live installation from various media, including over the network. The installer works across all platforms supported by TeX Live. For information on initially downloading the TeX Live, see <http://tug.org/texlive/acquire.html>.
The basic idea of TeX Live installation is to choose one of the top-level schemes, each of which is defined as a different set of collections and packages, where a collection is a set of packages, and a package is what contains actual files.
Within the installer, you can choose a scheme, and further customize the set of collections to install, but not the set of the packages. To do that, use
"tlmgr" (reference below) after the initial installation is completely.
The default is
"scheme-full", to install everything, and this is highly recommended.
Post-installation configuration, package updates, and much more, are handled through tlmgr(1), the TeX Live Manager (<http://tug.org/texlive/tlmgr.html>).
The most up-to-date version of this documentation is on the Internet at <http://tug.org/texlive/doc/install-tl.html>.
For the full documentation of TeX Live, see <http://tug.org/texlive/doc>.
As usual, all options can be specified in any order, and with either a leading
"--". An argument value can be separated from its option by either a space or
- -gui [[=]module]
If no module is given starts the
"perltk"(see below) GUI installer.
If module is given loads the given installer module. Currently the following modules are supported:
The text mode user interface (default on Unix systems). Same as the
The wizard mode user interface (default on Windows), asking only minimal questions before installing all of TeX Live.
The expert GUI installer, providing access to more options. Can also be invoked on Windows by running
"wizard"modules, and thus also when calling with a bare
"-gui"(without module), requires the Perl/Tk module (<http://tug.org/texlive/distro.html#perltk>); if Perl/Tk is not available, installation continues in text mode.
Use the text mode installer (default except on Windows).
- -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).
- -repository url|path
Specify the package repository to be used as the source of the installation, either a local directory via
"file:/"url, or a network location via a
"ftp://"url. (No other protocols are supported.)
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 <http://ctan.org> for more about CTAN and its mirrors.
If the repository is on the network, trailing
"/"characters and/or trailing
"/archive"components are ignored. For example, you could choose a particular CTAN mirror with something like this:
Of course a real hostname and its particular top-level CTAN path have to be specified. The list of CTAN mirrors is available at <http://ctan.org/mirrors>.
If the repository is local, the installation type (compressed or live) is automatically determined, by checking for the presence of a
"archive"directory relative to the root. Compressed is preferred if both are available, since it is faster. Here's an example of using a local directory:
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.
For backward compatibility and convenience,
"--repo"are accepted as aliases for this option.
This option allows manual selection of a mirror from the current list of active CTAN mirrors. This option is supported in all installer modes (text, wizard, perltk), and will also offer to install from local media if available, or from a repository specified on the command line (see above). It's useful when the (default) automatic redirection does not choose a good host for you.
Normally options not relevant to the current platform are not shown (i.e., when running on Unix, Windows-specific options are omitted). Giving this command line option allows configuring settings in the final
"texlive.tlpdb"that do not have any immediate effect.
- -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. (By the way, for information on building TeX Live, see <http://tug.org/texlive/build.html>).
In GUI mode, this switch makes
"tlmgr"report any missing, or more likely untranslated, messages to standard error. 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 (on the web via <http://tug.org/texlive/doc/install-tl.html>). Sometimes the
"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.
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.
- -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.
(only for text mode installer) do not clear the screen when entering a new menu (for debugging purposes).
For Windows only: configure for the current user, not for all users.
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
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., <http://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION>
Install for portable use, e.g., on a USB stick. Also selectable from within the perltk and text installers.
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
Load the file profile and do the installation with no user interaction, that is, a batch (unattended) install.
A profile file contains all the values needed to perform an installation. After a normal installation has finished, a profile for that exact installation is written to the file DEST/tlpkg/texlive.profile. That file can be given as the argument to
"-profile"to redo the exact same installation on a different system, for example. Alternatively, you can use a custom profile, most easily created by starting from a generated one and changing values, or an empty file, which will take all the defaults.
Normally a profile has to specify the value
1for each collection to be installed, even if the scheme is specified. This follows from the logic of the installer in that you can first select a scheme and then change the collections being installed. But for convenience there is an exception to this within profiles: If the profile contains a variable for
"selected_scheme"and no collection variables at all are defined in the profile, then the collections which the specified scheme requires are installed.
Thus, a line
"selected_scheme scheme-medium"together with the definitions of the installation directories (
"TEXMFSYSVAR") suffices to install the medium scheme with all default options.
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.
Include verbose debugging messages; repeat for maximum debugging, as in
"-v -v". (Further repeats are accepted but ignored.)
- -version, --version
Output version information and exit. If
"-v"has also been given the revisions of the used modules are reported, too.
For ease in scripting and debugging,
"install-tl" will look for the following environment variables. They are not of interest in normal user installations.
Omit the check for environment variables containing the string
"tex". People developing TeX-related software are likely to have many such variables.
Omit creating the ConTeXt cache. This is useful for redistributors.
Specify the respective directories.
"TEXLIVE_INSTALL_TEXDIR"defaults to the release directory within that prefix, e.g.,
"/usr/local/texlive/2014". All the defaults can be seen by running the installer interactively and then typing
"D"for the directory menu.
Don't try to run the
Authors and Copyright
This script and its documentation were written for the TeX Live distribution (<http://tug.org/texlive>) and both are licensed under the GNU General Public License Version 2 or later.