/usr/share/doc/ne/html/Key-Bindings.html is in ne-doc 2.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | <html lang="en">
<head>
<title>Key Bindings - ne's manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="ne's manual">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Configuration.html#Configuration" title="Configuration">
<link rel="next" href="Changing-Menus.html#Changing-Menus" title="Changing Menus">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="Key-Bindings"></a>
<p>
Next: <a rel="next" accesskey="n" href="Changing-Menus.html#Changing-Menus">Changing Menus</a>,
Up: <a rel="up" accesskey="u" href="Configuration.html#Configuration">Configuration</a>
<hr>
</div>
<h3 class="section">5.1 Key Bindings</h3>
<p><a name="index-Key-bindings-224"></a><a name="index-Configuring-the-keyboard-225"></a>
<code>ne</code> allows you to associate any keystroke with any command. To
accomplish this task, you have to create a (possibly UTf-8) file named
<samp><span class="file">.keys</span></samp> in your <samp><span class="file">~/.ne</span></samp> directory. You can change
the default name (possibly specifying a complete path) using the
<code>--keys</code> argument (see <a href="Arguments.html#Arguments">Arguments</a>).
<p>The format of the file is very simple: each line starting with the ‘<samp><span class="samp">KEY</span></samp>’
sequence of capital characters is considered the description of a key binding.
Each line starting with ‘<samp><span class="samp">SEQ</span></samp>’ binds a character sequence to a key.
All other lines are considered comments. The format of a key binding
description is
<pre class="example"> KEY <var>hexcode</var> <var>command</var>
</pre>
<p>The <var>hexcode</var> value is the <span class="sc">ascii</span> code of the keystroke. (For
special keys such as <Insert> or function keys, you should take a
look at the file <samp><span class="file">default.keys</span></samp> that comes with <code>ne</code>'s
distribution: it contains a complete, commented definition of
<code>ne</code>'s standard bindings that you can modify with a trial-and-error
approach.) The easiest way to see the code <code>ne</code> uses for a given
key is by using the <a href="KeyCode.html#KeyCode">KeyCode</a> command. It prompts you to press a
key, then reports the code for that key on the status bar.
<p>You can write just the hexadecimal digits, nothing else is
necessary (but a prefixing ‘<samp><span class="samp">0x</span></samp>’ is tolerated). For instance,
<pre class="example"> KEY 1 MoveSOL
</pre>
<p class="noindent">binds to <kbd><Control>-A</kbd> the action of moving to the start
of a line, while
<pre class="example"> KEY 101 LineUp
</pre>
<p class="noindent">binds to the “cursor-up” key the action of moving the cursor
one line up.
<p><var>command</var> can be any <code>ne</code> command, including <code>Escape</code>
(which allows reconfiguring the menu activator) and <code>Macro</code>, which
allows binding complex sequences of actions to a single keystroke. The binding
of a macro is very fast because on the first call the macro is cached in memory.
See <a href="Macro.html#Macro">Macro</a>.
<p>Note that you cannot <em>ever</em> redefine <Return> or <Escape>. This
is a basic issue—however brain damaged is the current configuration, you will
always be able to exploit fully the menus and the command line.
<p>Besides the “standard” combinations (e.g.,
<kbd><Control>-</kbd><var>letter</var>), it possible to program combinations
based on the <Meta> key (a.k.a. <Alt>). The situation in this
case is a bit more involved, because depending on the terminal emulator you are
using, the effect of the <Meta> key can be widely different. For
instance, <code>xterm</code> raises the eighth bit of a character, so, for
instance,
<pre class="example"> KEY 81 MoveSOF
</pre>
<p class="noindent">binds <kbd><Control>-<Meta>-a</kbd> to the action of moving to the
start of the document. However, <code>gnome-terminal</code> will emit the
character of ASCII code 1 prefixed with ESC instead (“<code>\x1b\x01</code>”). To handle this case,
<code>ne</code> provides codes from 180 on for <em>simulated <Meta>
sequences</em>: for instance,
<pre class="example"> KEY 181 MoveSOF
</pre>
<p class="noindent">binds the abovementioned sequence to the same action as
before. In general, the code 180+<var>x</var> corresponds to the sequence
ESC followed by the ASCII character of code <var>x</var>. Note that some of
these sequences may be disabled, if they conflict with existing sequences
of your terminal (for instance, ESC followed by ‘<samp><span class="samp">O</span></samp>’ is always
disabled because it prefixes several built-in keyboard sequences).
<p>As a final note, we remark that typing <kbd><Meta>-a</kbd> on
<code>gnome-terminal</code> will produce an ESC followed by ‘<samp><span class="samp">a</span></samp>’ (“<code>\x1ba</code>”). Since it
is obviously easier to press just <Meta> rather than <Meta> and
<Control> at the same time, it is a good idea to associate the same
sequence also to this combination, using
<pre class="example"> KEY 1E1 MoveSOF
</pre>
<p class="noindent">Moreover, this setting provides the user with a second choice: one can
press <Escape> followed by a letter instead of using modifiers.
<p>This is the approach used by default in <code>ne</code>: this way,
<Control> with <Meta> plus a letter should always work, and
<Meta> should work sometimes (of course, if you're sure to use
always the same kind of emulator you can bind more features). Again, the
best place to look at it's <samp><span class="file">default.keys</span></samp>.
<p>As stated above, each line starting with ‘<samp><span class="samp">SEQ</span></samp>’ binds a character sequence
to a key code. The format for a ‘<samp><span class="samp">SEQ</span></samp>’ binding is
<pre class="example"> SEQ "<var>sequence</var>" <var>hexcode</var>
</pre>
<p class="noindent">where "<var>sequence</var>" is a double-quoted string of characters
(which can include escaped hexadecimals) followed by a hexadecimal key code
as described above for ‘<samp><span class="samp">KEY</span></samp>’ definitions.
<p>You should rarely need this, as properly configured systems already do
this for most keys. However, some key combinations (<Control> in
conjunction with cursor keys for example) are usually not defined. If you
know the character sequence your system generates for such a combination, you may use
‘<samp><span class="samp">SEQ</span></samp>’ to bind that sequence to a particular key code if that sequence
isn't already defined on your system. For example,
<Control>-“cursor-left” may generate the sequence
<code>\x1b[1;5D</code>. The following lines bind that sequence to the <F10>
key code ‘<samp><span class="samp">14A</span></samp>’, then bind that key code to the ‘<samp><span class="samp">HELP</span></samp>’ command.
<pre class="example"> SEQ "\x1b[1;5D" 14A
KEY 14A HELP
</pre>
<p>Sequences are inherently terminal- or terminal emulator-specific, so
their utility will vary depending on how many emulators you use. At least
they give you the posibility to use keys or key combinations that aren't
covered by <code>curses</code>.
<p>The key binding file is parsed at startup. If something does not work,
<code>ne</code> exits displaying an error message. If you want <code>ne</code> to skip
parsing the key binding file (for instance, to correct the broken
file), just give <code>ne</code> the <code>--no-config</code> argument. See <a href="Arguments.html#Arguments">Arguments</a>.
</body></html>
|