LinuxCommandLibrary

tlmgr-check

Check for updates to LaTeX packages

TLDR

Check the consistency of the whole TeX Live installation

$ tlmgr check all
copy

Check the consistency of the whole TeX Live information in verbose mode
$ tlmgr check all -v
copy

Check for missing dependencies
$ tlmgr check depends
copy

Check if all TeX Live executables are present
$ tlmgr check executes
copy

Check if all files listed in the local TLPDB are present
$ tlmgr check files
copy

Check for duplicate filenames in the runfiles sections
$ tlmgr check runfiles
copy

SYNOPSIS

tlmgr check [options]
tlmgr check --check-files [package...]
tlmgr check --check-depends [package...]
tlmgr check --check-mirrors
tlmgr check --check-mac-fonts
tlmgr check --check-profiles
tlmgr check --check-all

PARAMETERS

--check-all
    Performs all available integrity and consistency checks.

--check-files [pkg...]
    Verifies the existence of all files for specified packages (or all installed packages if none are given) according to the TeX Live database.

--check-depends [pkg...]
    Checks for missing dependencies for specified packages (or all installed packages if none are given).

--check-mirrors
    Validates the consistency and availability of the configured TeX Live mirrors.

--check-mac-fonts
    (macOS only) Checks consistency between TeX Live fonts and system font registrations.

--check-profiles
    Checks the consistency of font profiles, such as dvips and pdftex configurations.

--dry-run (-n)
    Simulates the check operation without making any actual changes or fixes.

DESCRIPTION

tlmgr-check is a subcommand of the TeX Live Manager (tlmgr) utility.
Its primary purpose is to verify the integrity and consistency of a TeX Live installation. It can perform various checks, such as verifying the existence of files listed in the TeX Live database, checking for missing dependencies, ensuring mirror consistency, and validating font profiles on macOS. This command helps users identify potential issues arising from incomplete installations, corrupted packages, or inconsistencies between the local installation and the TeX Live repository. It's a crucial tool for diagnosing problems and maintaining a healthy TeX Live environment, often used after updates or when troubleshooting unexpected behavior.

CAVEATS

Requires a working internet connection for mirror checks or when fetching information from the repository.
Can be time-consuming, especially for --check-all on large installations.
Fixing issues often requires subsequent tlmgr commands (e.g., update, install, remove). tlmgr-check identifies issues, but doesn't fix them.
On macOS, --check-mac-fonts might require administrator privileges or specific system configurations.

<B>RETURN STATUS</B>

The command typically returns a non-zero exit status if any issues are found during the checks, and zero if the installation is consistent. This allows for scripting and automated checks.

<B>OUTPUT DETAILS</B>

tlmgr check provides detailed output, indicating which checks are being performed and listing any inconsistencies or missing components it identifies. The verbosity level can be adjusted to control the amount of information displayed.

HISTORY

The tlmgr utility, including its check subcommand, is an integral part of TeX Live, a comprehensive distribution of the TeX typesetting system. TeX Live's development began in the mid-1990s as a cross-platform replacement for previous distributions. The tlmgr tool was introduced to provide a robust and flexible command-line and GUI interface for managing the TeX Live installation, including package updates, installations, and integrity checks. The check functionality has evolved alongside TeX Live, adapting to new package structures, platform-specific considerations (like macOS font handling), and the increasing complexity of the distribution to ensure stability and reliability for users.

SEE ALSO

Copied to clipboard