FM / html

/usr/share/doc/info/html

Name	Size	Mode	Actions
Basic-Windows.html	8067	0644	edit dl rm
Colors-and-Styles.html	8200	0644	edit dl rm
command_002dline-menu-items.html	2753	0644	edit dl rm
Cursor-Commands.html	10480	0644	edit dl rm
cursor_002dmovement_002dscrolls.html	2753	0644	edit dl rm
Custom-Key-Bindings.html	5251	0644	edit dl rm
goto_002dinvocation.html	2705	0644	edit dl rm
goto_002dnode.html	2669	0644	edit dl rm
Index-Commands.html	6439	0644	edit dl rm
Index.html	103177	0644	edit dl rm
index.html	6234	0644	edit dl rm
infokey-format.html	9981	0644	edit dl rm
INFOPATH.html	2655	0644	edit dl rm
infopath_002dno_002ddefaults.html	2735	0644	edit dl rm
Invoking-Info.html	29153	0644	edit dl rm
min_002dsearch_002dlength.html	2717	0644	edit dl rm
Miscellaneous-Commands.html	12119	0644	edit dl rm
Node-Commands.html	15876	0644	edit dl rm
Parts-of-an-Xref.html	5875	0644	edit dl rm
Printing-Nodes.html	4905	0644	edit dl rm
repeated_002dsearch.html	2715	0644	edit dl rm
Scrolling-Commands.html	12168	0644	edit dl rm
scroll_002dbehavior.html	2697	0644	edit dl rm
Searching-Commands.html	11955	0644	edit dl rm
Selecting-Xrefs.html	8077	0644	edit dl rm
Stand_002dalone-Info.html	5167	0644	edit dl rm
The-Echo-Area.html	15310	0644	edit dl rm
The-Mode-Line.html	4781	0644	edit dl rm
Variables.html	20370	0644	edit dl rm
variable_002dassignment.html	2729	0644	edit dl rm
Window-Commands.html	4305	0644	edit dl rm
Xref-Commands.html	3994	0644	edit dl rm
_002d_002dall.html	2659	0644	edit dl rm
_002d_002dapropos.html	2683	0644	edit dl rm
_002d_002dinit_002dfile.html	2703	0644	edit dl rm
_002d_002draw_002descapes.html	2715	0644	edit dl rm
_002d_002dshow_002doptions.html	2721	0644	edit dl rm
_002d_002dvi_002dkeys.html	2691	0644	edit dl rm

Edit: /usr/share/doc/info/html/infokey-format.html (9981B)

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for Stand-alone GNU Info (version 6.8,
22 November 2020), a program for viewing documents in Info format
(usually created from Texinfo source files).

Copyright (C) 1992, 1993, 1996, 1997, 1998, 1999, 2001,
2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012,
2013, 2014, 2015, 2016, 2017, 2018, 2019 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts.  A copy of the license is included in the section entitled
"GNU Free Documentation License" in the Texinfo manual.

This document is part of a collection distributed under the GNU Free
Documentation License. If you want to distribute this document
separately from the collection, you can do so by adding a copy of the
license to the document, as described in section 6 of the license. -->
<title>infokey format (Stand-alone GNU Info 6.8)</title>

</head>

<body lang="en">
<div class="section" id="infokey-format">
<div class="header">

Up: <a href="Custom-Key-Bindings.html" accesskey="u" rel="up">Customizing Key Bindings and Variables</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]
</div>
<hr>
<h3 class="section">14.1 <code>infokey</code> format</h3>

Here is an example <samp>.infokey</samp> file which specifies the key
bindings that are activated by the <samp>--vi-keys</samp> option to Info 
(see <a href="Invoking-Info.html#g_t_002d_002dvi_002dkeys">--vi-keys</a>).

<div class="example">
<pre class="example">#info
g first-node
G last-node
\mb beginning-of-node
\me end-of-node
j next-line
k prev-line

f       scroll-forward-page-only
^f      scroll-forward-page-only
\m\     scroll-forward-page-only
z       scroll-forward-page-only-set-window

b       scroll-backward-page-only
^b      scroll-backward-page-only
w       scroll-backward-page-only-set-window

\kd     down-line
^e      down-line
^j      down-line
^m      down-line
\ku     up-line
^y      up-line
^k      up-line

d       scroll-half-screen-down
^d      scroll-half-screen-down
u       scroll-half-screen-up
^u      scroll-half-screen-up

^xn     next-node
^xp     prev-node
^xu     up-node
'       last-node
\mt     top-node
\md     dir-node

^xg     goto-node
I       goto-invocation-node

n       search-next
N       search-previous

\mf     xref-item
^xr     xref-item

\mg     select-reference-this-line
^x^j    select-reference-this-line
^x^m    select-reference-this-line

^c      abort-key

\mh     get-info-help-node

:q      quit
ZZ      quit

#echo-area
\mh echo-area-backward
\ml echo-area-forward
\m0 echo-area-beg-of-line
\m$ echo-area-end-of-line
\mw echo-area-forward-word
\mx echo-area-delete
\mu echo-area-abort
^v echo-area-quoted-insert
\mX echo-area-kill-word
</pre></div>

The file consists of one or more sections. Each section starts with
a line that identifies the type of section. The possible sections are:

<dl compact="compact">
<dt><code>#info</code></dt>
<dd>Key bindings for Info windows.
The start of this section is indicated by a line containing just
<code>#info</code> by itself. If this is the first section in the source
file, the <code>#info</code> line can be omitted. The rest of this section
consists of lines of the form:

<div class="example">
<pre class="example"><var>string</var> whitespace <var>action</var> [ whitespace [ # comment ] ] newline
</pre></div>

Whitespace is any sequence of one or more spaces and/or tabs. Comment
is any sequence of any characters, excluding newline. <var>string</var> is
the key sequence which invokes the action. <var>action</var> is the name of
an Info command. The characters in <var>string</var> are interpreted
literally or prefixed by a caret (<code>^</code>) to indicate a control
character. A backslash followed by certain characters specifies input
keystrokes as follows:

<dl compact="compact">
<dt><code>\b</code></dt>
<dd>Backspace
</dd>
<dt><code>\e</code></dt>
<dd>Escape (ESC)
</dd>
<dt><code>\n</code></dt>
<dd>Newline
</dd>
<dt><code>\r</code></dt>
<dd>Return
</dd>
<dt><code>\t</code></dt>
<dd>Tab
</dd>
<dt><code>\ku</code></dt>
<dd>Up arrow
</dd>
<dt><code>\kd</code></dt>
<dd>Down arrow
</dd>
<dt><code>\kl</code></dt>
<dd>Left arrow
</dd>
<dt><code>\kr</code></dt>
<dd>Right arrow
</dd>
<dt><code>\kU</code></dt>
<dd>Page Up
</dd>
<dt><code>\kD</code></dt>
<dd>Page Down
</dd>
<dt><code>\kh</code></dt>
<dd>HOME
</dd>
<dt><code>\ke</code></dt>
<dd>END
</dd>
<dt><code>\kx</code></dt>
<dd>Delete (DEL)
</dd>
<dt><code>\m<var>x</var></code></dt>
<dd>Meta-<var>x</var> where <var>x</var> is any character as described above.
</dd>
</dl>

Backslash followed by any other character indicates that character is to
be taken literally. Characters which must be preceded by a backslash
include caret, space, tab, and backslash itself.

</dd>
<dt><code>#echo-area</code></dt>
<dd>Key bindings for the echo area.
The start of this section is indicated by a line containing just
<code>#echo-area</code> by itself. The rest of this section has a syntax
identical to that for the key definitions for the Info area, described
above.

</dd>
<dt><code>#var</code></dt>
<dd>Variable initializations. The start of this section is indicated by a
line containing just <code>#var</code> by itself. Following this line is a
list of variable assignments, one per line. Each line consists of a
variable name (see <a href="Variables.html">Manipulating Variables</a>) followed by <code>=</code> followed by a
value. There may be no white space between the variable name and the
<code>=</code>, and all characters following the <code>=</code>, including white
space, are included in the value.
</dd>
</dl>

Blank lines and lines starting with <code>#</code> are ignored, except for
the special section header lines.

Key bindings defined in the <samp>.infokey</samp> file take precedence over GNU
Info&rsquo;s default key bindings, whether or not &lsquo;<samp>--vi-keys</samp>&rsquo; is used. A
default key binding may be disabled by overriding it in the <samp>.infokey</samp>
file with the action <code>invalid</code>. In addition, all default
key bindings can be disabled by adding this line anywhere in the
relevant section:

<div class="example">
<pre class="example">#stop
</pre></div>

This will cause GNU Info to ignore all the default key commands for that
section.

Beware: <code>#stop</code> can be dangerous. Since it disables all default
key bindings, you must supply enough new key bindings to enable all
necessary actions. Failure to bind any key to the <code>quit</code> command,
for example, can lead to frustration.

Note that some keys (such as <tt class="key">C-c</tt>) have special meanings
to terminals, and any bindings for these would not be effective.
See <a data-manual="coreutils" href="../coreutils/Special-Characters.html#Special-Characters">Special Characters</a> in <cite>GNU Coreutils</cite>.

The order in which key bindings are defined in the <samp>.infokey</samp> file is
not important, except that the command summary produced by the
<code>get-help-window</code> command only displays the first key that
is bound to each command.

</div>
<hr>
<div class="header">

Up: <a href="Custom-Key-Bindings.html">Customizing Key Bindings and Variables</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]
</div>

</body>
</html>

infokey format (Stand-alone GNU Info 6.8)

14.1 `infokey` format

Here is an example .infokey file which specifies the key bindings that are activated by the --vi-keys option to Info (see --vi-keys).

#info
g       first-node
G       last-node
\mb     beginning-of-node
\me     end-of-node
j       next-line
k       prev-line

f       scroll-forward-page-only
^f      scroll-forward-page-only
\m\     scroll-forward-page-only
z       scroll-forward-page-only-set-window

b       scroll-backward-page-only
^b      scroll-backward-page-only
w       scroll-backward-page-only-set-window

\kd     down-line
^e      down-line
^j      down-line
^m      down-line
\ku     up-line
^y      up-line
^k      up-line

d       scroll-half-screen-down
^d      scroll-half-screen-down
u       scroll-half-screen-up
^u      scroll-half-screen-up

^xn     next-node
^xp     prev-node
^xu     up-node
'       last-node
\mt     top-node
\md     dir-node

^xg     goto-node
I       goto-invocation-node

n       search-next
N       search-previous

\mf     xref-item
^xr     xref-item

\mg     select-reference-this-line
^x^j    select-reference-this-line
^x^m    select-reference-this-line

^c      abort-key

\mh     get-info-help-node

:q      quit
ZZ      quit

#echo-area
\mh     echo-area-backward
\ml     echo-area-forward
\m0     echo-area-beg-of-line
\m$     echo-area-end-of-line
\mw     echo-area-forward-word
\mx     echo-area-delete
\mu     echo-area-abort
^v      echo-area-quoted-insert
\mX     echo-area-kill-word

The file consists of one or more sections. Each section starts with a line that identifies the type of section. The possible sections are:

#info

Key bindings for Info windows. The start of this section is indicated by a line containing just #info by itself. If this is the first section in the source file, the #info line can be omitted. The rest of this section consists of lines of the form:

string whitespace action [ whitespace [ # comment ] ] newline

Whitespace is any sequence of one or more spaces and/or tabs. Comment is any sequence of any characters, excluding newline. string is the key sequence which invokes the action. action is the name of an Info command. The characters in string are interpreted literally or prefixed by a caret (^) to indicate a control character. A backslash followed by certain characters specifies input keystrokes as follows:

\b: Backspace
\e: Escape (ESC)
\n: Newline
\r: Return
\t: Tab
\ku: Up arrow
\kd: Down arrow
\kl: Left arrow
\kr: Right arrow
\kU: Page Up
\kD: Page Down
\kh: HOME
\ke: END
\kx: Delete (DEL)
\mx: Meta-x where x is any character as described above.

Backslash followed by any other character indicates that character is to be taken literally. Characters which must be preceded by a backslash include caret, space, tab, and backslash itself.

#echo-area

Key bindings for the echo area. The start of this section is indicated by a line containing just #echo-area by itself. The rest of this section has a syntax identical to that for the key definitions for the Info area, described above.

#var

Variable initializations. The start of this section is indicated by a line containing just #var by itself. Following this line is a list of variable assignments, one per line. Each line consists of a variable name (see Manipulating Variables) followed by = followed by a value. There may be no white space between the variable name and the =, and all characters following the =, including white space, are included in the value.

Blank lines and lines starting with # are ignored, except for the special section header lines.

Key bindings defined in the .infokey file take precedence over GNU Info’s default key bindings, whether or not ‘--vi-keys’ is used. A default key binding may be disabled by overriding it in the .infokey file with the action invalid. In addition, all default key bindings can be disabled by adding this line anywhere in the relevant section:

#stop

This will cause GNU Info to ignore all the default key commands for that section.

Beware: #stop can be dangerous. Since it disables all default key bindings, you must supply enough new key bindings to enable all necessary actions. Failure to bind any key to the quit command, for example, can lead to frustration.

Note that some keys (such as C-c) have special meanings to terminals, and any bindings for these would not be effective. See Special Characters in GNU Coreutils.

The order in which key bindings are defined in the .infokey file is not important, except that the command summary produced by the get-help-window command only displays the first key that is bound to each command.

14.1 infokey format

14.1 `infokey` format