LinuxCommandLibrary

tlmgr

Manage TeX Live packages

TLDR

Install a package and its dependencies

$ tlmgr install [package]
copy

Remove a package and its dependencies
$ tlmgr remove [package]
copy

Display information about a package
$ tlmgr info [package]
copy

Update all packages
$ tlmgr update --all
copy

Show possible updates without updating anything
$ tlmgr update --list
copy

Start a GUI version of tlmgr
$ tlmgr gui
copy

List all TeX Live configurations
$ tlmgr conf
copy

SYNOPSIS

tlmgr [option] subcommand [subcommand-options] [arguments]

PARAMETERS

--version
    Display the version information of tlmgr.

--dry-run
    Simulate the execution of a command without making any actual changes to the system. Useful for previewing updates or installations.

--repository
    Specify an alternative repository URL or local path to fetch packages from, instead of the default online CTAN mirrors.

--quiet, -q
    Suppress most of the output messages during command execution.

--no-execute-actions
    Prevent tlmgr from executing auxiliary programs (like updmap-sys or fmtutil-sys) automatically after installs or updates. Useful for manual control.

update [options]
    Update installed packages or the entire TeX Live distribution. Common options include --all to update everything, and --self to update tlmgr itself.

install
    Install one or more new packages from the configured repositories. E.g., tlmgr install pgf.

remove
    Remove one or more installed packages from the TeX Live system. This also handles dependencies if specified.

search [--file] [--global]
    Search for packages. Can search by package name, description, or files contained within packages (with --file). E.g., tlmgr search --file hyperref.sty.

info
    Display detailed information about specified packages, including description, dependencies, and installed files.

option [value]
    Get or set configuration options for tlmgr, such as default paper size or package download methods.

repository [add|remove|list|set]
    Manage TeX Live package repositories. Allows adding custom local or remote repositories, listing existing ones, or setting the current primary repository.

gui
    Launch the graphical user interface for tlmgr, providing an interactive way to manage packages.

path [add|remove|set]
    Manage the system's PATH environment variable to ensure TeX Live binaries are accessible. Typically handled during installation.

shell
    Enter an interactive tlmgr shell, where multiple commands can be executed without repeatedly typing tlmgr.

help [subcommand]
    Display general help information for tlmgr or detailed help for a specific subcommand.

DESCRIPTION

tlmgr (TeX Live Manager) is the essential command-line utility for managing a TeX Live installation, the most widely used TeX distribution. It provides comprehensive functionalities for maintaining the TeX system, including installing new packages, updating existing ones to their latest versions, and removing unnecessary components. Users can also leverage tlmgr to search for specific packages or files, inspect package information, and manage the repositories from which packages are downloaded. By connecting to official TeX Live online repositories (CTAN mirrors), tlmgr ensures that your TeX environment remains current, stable, and customized to your specific needs, streamlining the otherwise complex task of TeX system administration.

CAVEATS

Caveats and Limitations:
tlmgr typically requires internet access for online updates and installations from CTAN mirrors.
Administrative/root privileges are often needed for system-wide TeX Live installations and updates.
A full tlmgr update --all can be time-consuming and download a significant amount of data.
Always consider backing up critical files or configuration before major updates.

COMMON USAGE EXAMPLES

To update all installed packages: tlmgr update --all
To install a new package, e.g., tikz: tlmgr install pgf (tikz is part of pgf)
To find which package provides a specific file, e.g., amsmath.sty: tlmgr search --file amsmath.sty
To list all available packages: tlmgr list --only-installed or tlmgr list --all

OFFLINE INSTALLATIONS

While primarily used for online management, tlmgr can also manage installations from local TeX Live ISO images (e.g., DVD installations) or custom local repositories, enabling offline updates and installations after the initial setup.

HISTORY

tlmgr was developed as the comprehensive package manager for TeX Live, which emerged as the successor to other TeX distributions like teTeX. Its goal was to provide a robust, cross-platform solution for managing the increasingly large and complex TeX Live collection. It unified package management, which was previously handled by more fragmented tools or manual processes, making TeX Live easier to install, update, and maintain across different operating systems.

SEE ALSO

texdoc(1), kpsewhich(1), pdflatex(1), lualatex(1)

Copied to clipboard