LinuxCommandLibrary

infokey

Show terminfo key sequence information

SYNOPSIS

infokey [OPTION]...

PARAMETERS

-h, --header
    Produces a C header file containing definitions for info key bindings. This is the default output format if no other format option is specified.

-s, --sed
    Outputs a sed script, designed to help convert or update old info key binding configurations to a newer format.

-o FILE, --output=FILE
    Directs the generated output to the specified FILE instead of standard output.

-k KEY, --key-name=KEY
    Prints the internal name that corresponds to the given KEY sequence. This is useful for understanding info's internal key mapping or for debugging.

-v, --version
    Displays the version information for infokey and then exits.

--help
    Shows a detailed help message, listing all available options, and then exits.

DESCRIPTION

infokey is a specialized utility included with the GNU Info documentation system. Its core function is to process and output key binding definitions used by the info reader. By default, it generates a C header file that defines symbolic constants for info's key sequences and their associated commands. Alternatively, it can produce a sed script, which is useful for transforming or migrating key binding configurations. While infokey is vital for the development, maintenance, and customization of the info program itself, it is generally not a command intended for regular end-user interaction. Its output serves primarily as input for other compilation steps or for debugging key mapping issues within the info environment.

CAVEATS

infokey is primarily a developer-oriented tool for the GNU Info system. It is not typically used by general users as its output formats (C header, sed script) are specific to the info program's build and customization processes.

HISTORY

infokey is an integral component of the GNU Texinfo distribution, which underpins the GNU Info documentation system. Texinfo itself was initiated by the GNU Project in the 1980s. infokey's specific role is to manage and compile the key binding information crucial for the info reader, highlighting the system's design for customizable keyboard navigation and interactive documentation.

SEE ALSO

info(1), texinfo(1)

Copied to clipboard