LinuxCommandLibrary

tlmgr-install

Install LaTeX packages using TeX Live Manager

TLDR

Install a package and its dependencies

$ sudo tlmgr install [package]
copy

Reinstall a package
$ sudo tlmgr install --reinstall [package]
copy

Simulate installing a package without making any changes
$ tlmgr install --dry-run [package]
copy

Install a package without its dependencies
$ sudo tlmgr install --no-depends [package]
copy

Install a package from a specific file
$ sudo tlmgr install --file [path/to/package]
copy

SYNOPSIS

tlmgr install [option...] package|collection|scheme ...

PARAMETERS

package|collection|scheme
    One or more package names, collection names, or scheme names to be installed.

--reinstall
    Forces reinstallation of packages that are already installed.

--force
    Proceeds with the installation even if it means overwriting existing files or bypassing warnings.

--repository url|path
    Specifies an alternative repository URL or local path from which to install packages.

--dry-run
    Simulates the installation process and displays what would be done without making any actual changes.

--no-depends
    Prevents the automatic installation of dependencies required by the specified packages.

--local
    Installs a local `.tlmgr` or `.tar.xz` package file instead of fetching from a remote repository.

--user
    Installs packages into the user's personal TeX tree instead of the system-wide tree (does not require root privileges).

DESCRIPTION

tlmgr-install is a vital subcommand of the TeX Live Manager (tlmgr) dedicated to installing packages, collections, or schemes into a TeX Live distribution.

It functions by connecting to the configured TeX Live repository, typically an online mirror or a local source, and then downloads and integrates the specified components into the local TeX Live tree. This command is essential for enhancing an existing TeX Live installation with new features, fonts, styles, or tools that may not have been part of the initial setup.

By default, tlmgr-install automatically resolves and installs any required dependencies for the specified items. Users can specify individual package names, or opt for higher-level structures like collections (pre-defined groups of related packages) or schemes (comprehensive sets of collections that represent a complete TeX Live profile). The command offers various options to customize the installation process, including forcing reinstallation, performing dry runs to preview changes, or specifying an alternative repository location. Correct usage ensures a robust and well-maintained TeX Live environment.

CAVEATS

For system-wide installations, tlmgr-install often requires root or administrator privileges.
Network connectivity is necessary when installing from online repositories.
Using the --force option should be done with caution, as it can overwrite custom files or lead to unexpected behavior.
For updating already installed packages, tlmgr update is generally the preferred command over tlmgr install.

COLLECTIONS AND SCHEMES

Beyond individual packages, tlmgr-install can install collections (logical groups of packages, e.g., collection-fontsrecommended) and schemes (pre-defined, comprehensive sets of collections, e.g., scheme-full or scheme-basic). This significantly simplifies the management of large sets of related packages.

SYSTEM VS. USER INSTALLATION

By default, tlmgr-install attempts a system-wide installation. However, the --user option allows users to install packages into their home directory's personal TeX tree. This is particularly useful for users without root privileges or for those wishing to test packages without affecting the global system installation.

HISTORY

The TeX Live Manager (tlmgr) replaced older package management tools like teXconfig and tla as the standard utility for managing TeX Live distributions. The install subcommand has been a fundamental part of tlmgr since its inception, providing a centralized and robust mechanism for adding components to a TeX Live installation. Its development has mirrored the evolution of TeX Live itself, aiming for greater ease of use and reliability in maintaining complex TeX environments.

SEE ALSO

tlmgr(1), tlmgr update(1), tlmgr remove(1), tlmgr search(1), kpsewhich(1)

Copied to clipboard