LinuxCommandLibrary

tlmgr-conf

Configure TeX Live Manager settings

TLDR

Show the current TeX Live configuration

$ tlmgr conf
copy

Show the current texmf, tlmgr, or updmap configuration
$ tlmgr conf [texmf|tlmgr|updmap]
copy

Show only a specific configuration option
$ tlmgr conf [texmf|tlmgr|updmap] [configuration_key]
copy

Set a specific configuration option
$ tlmgr conf [texmf|tlmgr|updmap] [configuration_key] [value]
copy

Delete a specific configuration option
$ tlmgr conf [texmf|tlmgr|updmap] --delete [configuration_key]
copy

Disable the execution of system calls via \write18
$ tlmgr conf texmf [shell_escape] [0]
copy

Show all additional texmf trees
$ tlmgr conf auxtrees show
copy

SYNOPSIS

tlmgr-conf <key>
tlmgr-conf <key> <value>
tlmgr-conf --help
tlmgr-conf --version

PARAMETERS

<key>
    Specifies the name of the configuration variable to query or modify. Examples include repository, autobackup, backupdir, sys_paper, sys_language, etc. When <key> is provided without <value>, the current setting for that variable is displayed.

<value>
    The new setting to assign to the specified <key>. If <value> is omitted, the command queries and displays the current setting of <key>. To unset a value, a specific "empty" or "default" value might be required depending on the key.

--help
    Displays a brief help message and exits.

--version
    Displays version information about tlmgr-conf (which usually reflects tlmgr's version) and exits.

DESCRIPTION

The tlmgr-conf command serves as a convenient wrapper or symbolic link, primarily used to manage the configuration settings of the TeX Live Manager (tlmgr). While it often invokes the tlmgr config or tlmgr option subcommands internally, its dedicated name emphasizes its role in configuration management. Users employ tlmgr-conf to query, set, or unset various operational parameters for tlmgr, affecting how it interacts with repositories, handles backups, sets default paper sizes, and more. This command provides a streamlined interface for customizing the behavior of your TeX Live installation, from system-wide preferences to user-specific overrides. It is an essential tool for administrators and advanced users who need fine-grained control over their TeX Live environment, ensuring updates and package installations proceed according to specific requirements.

CAVEATS

  • tlmgr-conf is often a simple script or alias that directly calls tlmgr with configuration-related arguments. Its exact behavior and available options are therefore heavily dependent on the underlying tlmgr version.
  • Modifying system-wide configuration options (e.g., those affecting TEXMFSYSCONFIG) typically requires administrative privileges (e.g., sudo). Incorrect changes can disrupt TeX Live's functionality or update process.
  • Be aware of the distinction between system-wide configuration (tlmgr config) and user-specific options (tlmgr option), as tlmgr-conf might default to one or offer ways to specify the scope.

CONFIGURATION SCOPES EXPLAINED

When managing TeX Live configuration, it's crucial to understand the two main scopes: system-wide and user-specific.
System-wide configuration, typically managed by tlmgr config (and thus accessible via tlmgr-conf), usually resides in files like TEXMFSYSCONFIG/tlmgr/config (e.g., /usr/local/texlive/YYYY/tlpkg/texlive.tlmgr-config). These settings apply to all users of the TeX Live installation and often require root privileges to modify.
User-specific options, handled by tlmgr option, are stored in a user's TEXMFCONFIG directory (e.g., ~/.texliveYYYY/tlmgr/config). These settings override system-wide defaults for the individual user, allowing for personalized behavior without affecting other users or requiring elevated privileges. tlmgr-conf usually interacts with the tlmgr config subsystem, but some distributions might configure it to interact with tlmgr option as well.

COMMON CONFIGURATION KEYS

While the exact set of configurable keys can vary, some commonly managed options include:

  • repository: Specifies the URL of the TeX Live package repository to use for updates and installations.
  • autobackup: A boolean (0 or 1) indicating whether tlmgr should automatically create backups of packages before updates.
  • backupdir: Defines the directory where tlmgr stores package backups.
  • sys_paper: Sets the system-wide default paper size (e.g., a4, letter).
  • sys_language: Configures the system-wide default language for tlmgr messages.

HISTORY

The tlmgr utility itself was introduced around TeX Live 2008, unifying package management tasks that were previously more complex or manual. The tlmgr-conf alias or script emerged as part of the broader effort to streamline tlmgr's extensive functionality, providing a clear, concise entry point specifically for configuration management, reflecting the growing importance of easily customizable TeX Live installations. Its development is intertwined with the evolution of TeX Live as a robust and user-friendly distribution.

SEE ALSO

tlmgr(1), tex(1), kpsewhich(1)

Copied to clipboard