How to use the command 'install-tl' (with examples)

The install-tl command is a versatile tool that serves as the TeX Live cross-platform installer, facilitating the installation of TeX Live, a comprehensive distribution of the LaTeX typesetting system. This command provides different modes of installation and configuration tailored to various user needs, making it an essential utility for LaTeX users across different operating systems.

Use case 1: Start the text-based installer (default on Unix systems)

Code:

install-tl -no-gui

Motivation:

When working on Unix-based systems, a text-based installer is often preferred due to its simplicity and compatibility with command-line environments. This mode is resource-light and does not require a graphical interface, making it ideal for server environments or minimal installations.

Explanation:

• -no-gui: This argument instructs the installer to run in text-based mode, skipping any graphical interface. It is particularly important for users working over SSH or on systems without windowing capabilities.

Example Output:

Welcome to the TeX Live installer.
  
I will install TeX Live with the following settings:
  - directory: /usr/local/texlive/2023
  - platforms: all
  - selected collections: all

Press <Enter> to proceed ...

Use case 2: Start the GUI installer (default on macOS and Windows, requires Tcl/Tk)

Code:

install-tl -gui

Motivation:

On platforms such as macOS and Windows, users often prefer a graphical user interface for ease of navigation and user-friendliness. The GUI installer allows users to easily select components and configure settings through graphical elements, which can be more intuitive for users unfamiliar with command-line systems.

Explanation:

• -gui: This command-line flag initiates the graphical user interface, provided that the underlying system supports Tcl/Tk, the toolkit required to run the GUI version of the installer.

Example Output:

A window opens with a clean, organized interface, allowing you to select installation directories, package collections, and other settings.

Use case 3: Install TeX Live as defined in a specific profile file

Code:

install-tl -profile path/to/texlive.profile

Motivation:

For users who need to consistently replicate installations across multiple systems or prefer automated installation processes, using a profile file to define installation settings is advantageous. This method enables batch installations and ensures uniformity in configuration.

Explanation:

• -profile path/to/texlive.profile: This option tells the installer to follow the specifications outlined in the provided profile file, which contains pre-defined settings such as target directories, selected packages, and more.

Example Output:

Reading profile: path/to/texlive.profile
Installing TeX Live according to the provided profile ...
Installation successful.

Use case 4: Start the installer with the settings from a specific profile file

Code:

install-tl -init-from-file path/to/texlive.profile

Motivation:

Similar to the profile installation, initializing the installer with settings from a profile file allows users to start installations with predefined parameters, eliminating the need for manual input during the installation process. This is particularly useful for setting advanced configurations before starting the installation.

Explanation:

• -init-from-file path/to/texlive.profile: This initializes the installer using settings specified in the given profile file, streamlining the setup process by preloading configurations.

Example Output:

Initializing TeX Live Installer with '/path/to/texlive.profile'
Profile settings loaded. Ready for installation.

Use case 5: Start the installer for installation on a portable device, like a USB stick

Code:

install-tl -portable

Motivation:

There are scenarios where users might need a portable version of TeX Live that can run independently of the host machine’s configuration. This is especially useful for educators or professionals who frequently switch between different workstations as it allows them to carry their LaTeX environment on a USB stick.

Explanation:

• -portable: This flag configures the installation for portability, ensuring that all necessary files are included so the installation can be easily moved across systems without reinstallation.

Example Output:

Preparing TeX Live installation on a portable device ...
Portable installation complete. It's now ready to use.

Use case 6: Display help

Code:

install-tl -help

Motivation:

New users or those unfamiliar with install-tl can greatly benefit from directly accessing the command line help options. It provides necessary guidance for command usage, available options, and general advice on the installation procedures.

Explanation:

• -help: Displays detailed help information about the install-tl command, listing all possible flags and arguments along with brief descriptions.

Example Output:

Usage: install-tl [options]
Options:
  -no-gui      Run the text installer, no GUI
  -gui         Run the installer with a graphical user interface
  ...

Conclusion:

The install-tl command is a powerful tool designed to cater to various user needs for installing TeX Live across different platforms and environments. By offering different modes and configurations through a simple command-line interface, it ensures that users can easily manage their LaTeX installations with precision and convenience. Whether you prefer a graphical installer on Windows or need a portable version to carry on a USB drive, install-tl provides flexible options to suit every requirement.