LinuxCommandLibrary

install-info

Update or create Info directory file

SYNOPSIS

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

PARAMETERS

--build-dir[=DIR]
    Pretend INFO-FILE is in DIR (default: current dir)

--conf-dir=DIR
    Look for .install-info in DIR

--conf-file=FILE
    Read FILE instead of .install-info

--debug
    Emit debugging information

--delete
    Delete existing entry for INFO-FILE

--description=STRING
    Use STRING as entry description

--dir-file=FILE
    Use FILE as dir file (default: /usr/share/info/dir)

--dribble=FILE
    Record actions to FILE

--dry-run
    Do not update files; show what would happen

--entry=STRING
    Use STRING as full entry text

--help
    Display usage summary

--infodir=DIR
    Search for dir file in DIR

--infokey=KEY
    Use KEY as index key (default: INFO-FILE basename)

--internal
    Use internal dir file handling

--menu-entry=STRING
    Use STRING as menu entry

--node=NAME
    Expect node named NAME

--quiet
    Suppress output

--remove-exactly
    Remove exactly matching entry

--section=SECTION
    Place entry in SECTION

--silent
    Suppress warnings

--test
    Test if entry exists (exit codes)

--version
    Print version info

DESCRIPTION

install-info is a utility from the GNU Texinfo distribution that updates the master Info directory file (dir), adding or removing menu entries for specified Info files. The dir file serves as the top-level index for the info reader, organizing documentation hierarchically by topics.

Typically used in package installation scripts (e.g., post-install hooks), it scans an Info file (<tt>INFO-FILE</tt>) for nodes and menus to generate entries. Without <
Options control entry details like section placement, custom descriptions, or dry-run testing. It ensures seamless integration of new manuals into the Info system, vital for Texinfo-generated docs from <i>texinfo</i> sources. However, reliance on a central <i>dir</i> is legacy; modern systems favor directory scanning.

CAVEATS

Deprecated in Texinfo 6.7+; removed in 6.8 (2021). Use texi2any --document-language or dirless Info setups instead. Requires write access to dir file.

DEFAULT USAGE

install-info /usr/share/info/foo.info adds entry to default dir.

REMOVAL

install-info --delete --dir-file=/usr/share/info/dir foo.info

PERMISSIONS

Requires root or dir file write perms; often run via dpkg or rpm scripts.

HISTORY

Developed for GNU Texinfo (1992+); maintained until Texinfo 6.7 (2020). Phased out as info supports scanning info dirs directly, reducing central dir dependency.

SEE ALSO

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

Copied to clipboard