LinuxCommandLibrary

install-tl

Install TeX Live distribution

TLDR

Start the text-based installer (default on Unix systems)

$ install-tl -no-gui
copy

Start the GUI installer (default on macOS and Windows, requires Tcl/Tk)
$ install-tl -gui
copy

Install TeX Live as defined in a specific profile file
$ install-tl -profile [path/to/texlive.profile]
copy

Start the installer with the settings from a specific profile file
$ install-tl -init-from-file [path/to/texlive.profile]
copy

Start the installer for installation on a portable device, like a USB stick
$ install-tl -portable
copy

Display help
$ install-tl -help
copy

SYNOPSIS

install-tl [OPTIONS]

PARAMETERS

-gui
    Run the installer with a graphical user interface. This is the default on systems with a graphical environment.

-no-gui
    Force the installer to use a text-based interface, even if a graphical environment is detected. Useful for remote SSH sessions.

-profile file
    Specify a profile file to use for a non-interactive (unattended) installation. The file contains pre-defined installation settings.

-repository URL|path
    Specify the source of the TeX Live packages. This can be a URL to a CTAN mirror or a local path to an ISO image or unpacked distribution.

-lang lang-code
    Set the language for the installer's user interface, e.g., 'en' for English.

-select-paradigms
    Prompt the user to select one of the predefined installation schemes (e.g., 'full', 'basic', 'small').

-s, --scheme scheme-name
    Specify the installation scheme directly without prompting, e.g., 'full' for a complete installation.

-n, --no-interaction
    Run the installer completely non-interactively, using default settings or those provided by a profile file. Implies -no-gui.

-dry-run
    Simulate the installation process without actually installing any files. Useful for testing settings.

-force-platform platform
    Force the installer to use a specific platform identification, bypassing automatic detection. Useful in certain virtualized or unusual environments.

-allow-superuser
    Allow running the installer as the root user. This is generally discouraged unless strictly necessary due to permissions or specific installation paths.

-print-platform
    Print the detected platform identifier and exit, without starting the installation.

-v, --verbose
    Enable verbose output, providing more detailed information about the installation process.

-help
    Display a comprehensive help message with all available options and exit.

DESCRIPTION

install-tl is the primary script used to install the TeX Live distribution, a comprehensive and free software distribution for the TeX typesetting system. Written in Perl, it provides a flexible and robust way to set up TeX Live on various operating systems, including Linux, macOS, and Windows. Users can perform installations interactively with a graphical user interface (GUI) or a text-based interface, or non-interactively using a profile file for unattended installations. It manages the download of packages from network repositories or installation from local ISO/DVD images. install-tl handles package selection, directory paths, paper size settings, and other configuration options, ensuring a complete and functional TeX environment.

CAVEATS

Root Permissions: Running install-tl as root (with -allow-superuser) is generally discouraged unless you specifically need to install TeX Live into a system-wide directory like /usr/local. Installing as a regular user into your home directory is often preferred.

Disk Space: A full TeX Live installation requires a significant amount of disk space, potentially several gigabytes. Ensure you have sufficient free space before starting.

Perl Requirement: The install-tl script itself is written in Perl, so a working Perl interpreter must be available on your system.

Post-Installation PATH: After installation, the TeX Live binaries typically need to be added to your system's PATH environment variable for commands like pdflatex or latex to be found. The installer usually provides instructions for this, but it's a manual step.

INSTALLATION PROFILE (<I>-PROFILE</I>)

For unattended or automated installations, a profile file can be used. This plain text file contains all the settings typically chosen during an interactive installation, such as installation paths, selected schemes, paper sizes, and package collections. This allows for reproducible and consistent installations across multiple systems without manual intervention.

UPDATING TEX LIVE

It's important to note that install-tl is used for the initial installation of TeX Live. Once installed, managing packages, updating the distribution, or adding/removing components is handled by the tlmgr (TeX Live Manager) command, not install-tl itself.

HISTORY

The TeX Live project, initiated in the mid-1990s, aimed to create a robust, cross-platform TeX distribution. The install-tl script emerged as its primary installer, evolving from earlier, less flexible installation methods. Its development focused on providing a consistent and automated installation experience across various operating systems, including Windows, macOS, and Unix-like systems. This evolution replaced disparate, OS-specific installation procedures with a unified, Perl-based solution, emphasizing robust package management and maintainability, primarily through its companion tool, tlmgr, for post-installation updates.

SEE ALSO

tlmgr(1), texdoc(1), kpsewhich(1)

Copied to clipboard