update-info-dir
Update the info directory file
SYNOPSIS
update-info-dir [OPTION]...
PARAMETERS
--quiet
Suppresses all normal output from the command, showing only errors.
--verbose
Enables verbose output, providing more detailed information about the operations being performed.
--dry-run
Performs a 'dry run' operation. It shows what actions would be taken without actually modifying the `dir` file or any other system files.
--version
Displays the version information of the update-info-dir utility and then exits.
--help
Shows a help message detailing usage and available options, then exits.
DESCRIPTION
update-info-dir is a crucial utility within the GNU Info documentation system. Its primary function is to rebuild or update the `dir` file, which acts as the main index or table of contents for all Info manuals installed on a Linux system. When software packages containing Info documentation are installed or removed, this command ensures that the Info system's central directory accurately reflects the available documentation. It scans designated Info directories, identifies `.info` files, and generates or modifies entries in the `dir` file, making new documentation discoverable by the info command. While fundamental to the Info system's integrity, update-info-dir is typically invoked automatically by package management tools (like dpkg or rpm) rather than being run directly by end-users.
CAVEATS
update-info-dir typically requires root privileges to modify the global Info `dir` file, which is usually located in a system directory like /usr/share/info.
Incorrect or corrupted Info files can sometimes lead to issues during the rebuilding process. It primarily relies on the standard Info file naming and directory conventions.
INFO DIRECTORY LOCATION
The main Info directory file, named `dir`, is conventionally located at /usr/share/info/dir on most Linux distributions. This is the file that update-info-dir is designed to manage and rebuild.
AUTOMATIC INVOCATION BY PACKAGE MANAGERS
While update-info-dir can be run manually, it is most frequently invoked automatically by package management systems (e.g., apt, yum, dnf, pacman) as part of post-installation or pre-uninstallation scripts. This ensures that the Info documentation index remains up-to-date whenever software packages with Info manuals are added or removed from the system.
HISTORY
update-info-dir is an integral part of the GNU Info documentation suite, which has been a standard method for online documentation in the GNU/Linux ecosystem for decades. Its development has paralleled the growth of the GNU project, providing a consistent and searchable index for the vast array of GNU software documentation. It's designed to automate the maintenance of the central Info directory, a task that would otherwise be cumbersome and error-prone.
SEE ALSO
info(1), install-info(8)