ginstall-info

ginstall-info [OPTION]... INFO-FILE [DIR-FILE]

--conf-dir=DIR
    Directory for .install-info configuration file

--debug
    Enable debugging output

--delete
    Delete matching entry instead of adding

--description=STR
    Set description field to STR

--dir-file=FILE
    Use FILE as the dir file (default: $(infodir)/dir)

--dribble=FILE
    Log actions to FILE for debugging

--dry-run
    Show changes without modifying files

--entry=TEXT
    Use TEXT as the first line of the entry

--help
    Display usage summary

--infodir=DIR
    Info directory (default: /usr/share/info)

--menu-entry=TEXT
    Use TEXT for the menu entry

--node=NODE
    Specify short node name in menu entry

--quiet
    Suppress non-error messages

--quiet-backup
    Do not announce backup creation

--remove-exactly
    Remove exactly matching entry

--section=SEC
    Place entry under section SEC

--set-variable=VAR=VAL
    Set configuration variable

--test
    Synonym for --dry-run

--version
    Print version and exit

ginstall-info is a utility from the Texinfo package (often symlinked or variant of install-info) used to maintain the master dir file in GNU Info documentation systems. It automatically adds, updates, or removes menu entries in the /usr/share/info/dir index file when Info manuals are installed or uninstalled.

The command scans an Info file (<INFO-FILE>) for its short name, title, and nodes, then inserts a formatted menu entry into the specified or default <DIR-FILE>. This ensures new documentation appears in the info reader's top-level menu, improving discoverability.

Key features include customizable menu text, section placement (e.g., 'Lisp'), node specification, and dry-run testing. It handles backups of the dir file and supports configuration via .install-info files for site-wide defaults.

Typically invoked during package installation via Makefiles (e.g., make install-info) or manually. Without options, it adds an entry; --delete removes it. Debug modes and dribble files aid troubleshooting.

Though powerful, it's configuration-sensitive and assumes standard Info formatting. Modern alternatives exist in some distros.

Deprecated in Debian/Ubuntu (>=2013); replaced by update-info-dir. May fail on non-standard Info files or permissions issues with dir. Always backup dir file manually.

ginstall-info --dir-file=/usr/share/info/dir foo.info <br> ginstall-info --delete --dir-file=/usr/share/info/dir foo.info <br> ginstall-info --section="File utilities" --description="Foo utility" foo.info

Create ~/.install-info or site-wide file with defaults like infodir = /usr/local/info.

Introduced in early GNU Texinfo (1990s) by Free Software Foundation for managing Info indices. Evolved with Texinfo releases; 'g' prefix appears in some GNU-native or cross-toolchain builds (e.g., alongside gawk, ginstall). Usage peaked with GNU/Linux packaging, declined with web docs.

info(1), makeinfo(1), texinfo(5), dir(5)