Exploring the Command 'tlmgr info' for TeX Live Package Management (with examples)

The TeX Live Manager (tlmgr) is an essential command-line utility for managing TeX Live installations. TeX Live is a comprehensive distribution of the TeX document preparation system, encompassing a wide range of packages for creating high-quality documents. The ’tlmgr info’ command is particularly invaluable as it provides detailed information regarding these packages, allowing users to efficiently manage their TeX Live setup. Whether you’re installing new packages or simply wanting to audit the current packages, ’tlmgr info’ offers a variety of options tailored for different use cases.

Use case 1: List all available TeX Live packages, prefixing installed ones with i

Code:

tlmgr info

Motivation:
This command is mainly intended for users who want a comprehensive overview of all available TeX Live packages. By prefixing installed packages with an ‘i’, it quickly distinguishes which packages are already a part of your TeX Live installation. This is extremely useful for users who manage a large number of packages and need a clear understanding of what’s currently installed versus available.

Explanation:

• tlmgr: The base command invoking the TeX Live Manager.
• info: This subcommand tells tlmgr that the user wants to retrieve information about packages.

Example Output:

package1
i package2
package3
...

In this output, package2 is marked with ‘i’, indicating it is installed, while package1 and package3 are available but not installed.

Use case 2: List all available collections

Code:

tlmgr info collections

Motivation:
Collections are groupings of related TeX Live packages. This command helps users identify and understand the thematic groupings available, which might simplify the installation and management of packages intended for specific types of documentation or purposes.

Explanation:

• collections: This argument specifies the desired focus on collections of packages, which are convenient predefined groups.

Example Output:

collection-basic
collection-latex
collection-mathextra
...

This output shows various collections such as collection-basic and collection-latex, providing a summary of themes and groups within TeX Live.

Use case 3: List all available schemes

Code:

tlmgr info scheme

Motivation:
TeX Live schemes are higher-level sets of collections that define the broad scope of package installation. This command is useful for users at the initial setup phase, seeking to understand the installation scope options available to them.

Explanation:

• scheme: An option to list different schemes, these are essentially macros that encompass a broad selection of collections for various levels or types of installations (e.g., minimal, full).

Example Output:

scheme-full
scheme-small
scheme-basic
...

The output lists schemes like scheme-full and scheme-small, guiding users on the scale and scope of potential TeX Live installations.

Use case 4: Show information about a specific package

Code:

tlmgr info package

Motivation:
This command is ideal for users needing detailed data about a specific package. Whether verifying compatibility, dependencies, or simply wanting more information before installation, this is the go-to command.

Explanation:

• package: A placeholder for the actual package name the user wants to gather information on. This retrieves all available metadata about that package.

Example Output:

package: graphics
category: Package
installed: Yes
revision: 12345
...

Here we see information regarding the package graphics, including its category, installation status, revision number, etc.

Use case 5: List all files contained in a specific package

Code:

tlmgr info package --list

Motivation:
Listing all files within a package provides insights into what will be installed or what comprises an installed package. This is crucial for users concerned with disk usage, organization, or troubleshooting installations.

Explanation:

• --list: This flag extends the ‘info’ command to include a comprehensive list of files contained within the specified package.

Example Output:

/usr/local/texlive/2023/texmf-dist/tex/latex/graphics/graphics.tex
/usr/local/texlive/2023/texmf-dist/doc/latex/graphics/graphics.pdf
...

This output enumerates all files associated with the specified package, outlining their directories.

Use case 6: List all installed packages

Code:

tlmgr info --only-installed

Motivation:
Understanding what is currently installed is crucial for both maintaining and auditing a TeX Live installation. This command provides a targeted view, removing distractions from uninstalled packages.

Explanation:

• --only-installed: This argument filters the output to show only the packages that are currently installed, skipping over others.

Example Output:

i package1
i package2
i package3
...

This output provides a simple listing of installed packages, each prefixed with an ‘i’, emphasizing their installation status.

Use case 7: Show only specific information about a package

Code:

tlmgr info package --data "name,category,installed,size,depends,..."

Motivation:
Sometimes, users need specific information rather than an overwhelming amount of metadata. This command allows for tailored output to see exactly what information is required, which is useful for scripting or documentation purposes.

Explanation:

• --data: This option specifies which information aspects are desired about the package, allowing for customized and succinct data presentation.

Example Output:

name: graphics
category: Package
installed: Yes
size: 1MB
depends: pgf, xcolor
...

This concise output returns only the requested data fields about the graphics package, e.g., its name and dependencies.

Use case 8: Print all available packages as a JSON encoded array

Code:

tlmgr info --json

Motivation:
For developers or advanced users, JSON formatted outputs are a necessity for parsing package information programmatically. This facilitates integration with other tools or detailed logging.

Explanation:

• --json: Directs the command to output package information in JSON format, a machine-readable format easy to parse with various programming languages.

Example Output:

[
  {
    "name": "aeguill",
    "category": "Package",
    "size": "25431",
    ...
  },
  ...
]

The JSON-formatted output provides a structured view, ideal for consumption by applications or scripts to process data efficiently.

Conclusion:

The ’tlmgr info’ command is a versatile tool that caters to varying needs—from general package management to specific information retrieval and scripting integration. Understanding and leveraging these use cases equips users with essential control over their TeX Live installation for optimized performance and precise document preparation management.