contrib/less/lesskey.nro

   1 .TH LESSKEY 1 "Version 491: 07 Apr 2017"
   2 .SH NAME
   3 lesskey \- specify key bindings for less
   4 .SH SYNOPSIS
   5 .B "lesskey [-o output] [--] [input]"
   6 .br
   7 .B "lesskey [--output=output] [--] [input]"
   8 .br
   9 .B "lesskey -V"
  10 .br
  11 .B "lesskey --version"
  12 .SH DESCRIPTION
  13 .I Lesskey
  14 is used to specify a set of key bindings to be used by
  15 .I less.
  16 The input file is a text file which describes the key bindings.
  17 If the input file is "-", standard input is read.
  18 If no input file is specified, a standard filename is used
  19 as the name of the input file, which depends on the system being used:
  20 On Unix systems, $HOME/.lesskey is used;
  21 on MS-DOS systems, $HOME/_lesskey is used;
  22 and on OS/2 systems $HOME/lesskey.ini is used,
  23 or $INIT/lesskey.ini if $HOME is undefined.
  24 The output file is a binary file which is used by
  25 .I less.
  26 If no output file is specified,
  27 and the environment variable LESSKEY is set,
  28 the value of LESSKEY is used as the name of the output file.
  29 Otherwise, a standard filename is used as the name of the output file,
  30 which depends on the system being used:
  31 On Unix and OS-9 systems, $HOME/.less is used;
  32 on MS-DOS systems, $HOME/_less is used;
  33 and on OS/2 systems, $HOME/less.ini is used,
  34 or $INIT/less.ini if $HOME is undefined.
  35 If the output file already exists,
  36 .I lesskey
  37 will overwrite it.
  38 .PP
  39 The -V or --version option causes
  40 .I lesskey
  41 to print its version number and immediately exit.
  42 If -V or --version is present, other options and arguments are ignored.
  43 .PP
  44 The input file consists of one or more
  45 .I sections.
  46 Each section starts with a line that identifies the type of section.
  47 Possible sections are:
  48 .IP #command
  49 Defines new command keys.
  50 .IP #line-edit
  51 Defines new line-editing keys.
  52 .IP #env
  53 Defines environment variables.
  54 .PP
  55 Blank lines and lines which start with a pound sign (#) are ignored,
  56 except for the special section header lines.
  57
  58 .SH "COMMAND SECTION"
  59 The command section begins with the line
  60 .sp
  61 #command
  62 .sp
  63 If the command section is the first section in the file,
  64 this line may be omitted.
  65 The command section consists of lines of the form:
  66 .sp
  67         \fIstring\fP <whitespace> \fIaction\fP [extra-string] <newline>
  68 .sp
  69 Whitespace is any sequence of one or more spaces and/or tabs.
  70 The \fIstring\fP is the command key(s) which invoke the action.
  71 The \fIstring\fP may be a single command key, or a sequence of up to 15 keys.
  72 The \fIaction\fP is the name of the less action, from the list below.
  73 The characters in the \fIstring\fP may appear literally, or be
  74 prefixed by a caret to indicate a control key.
  75 A backslash followed by one to three octal digits may be used to
  76 specify a character by its octal value.
  77 A backslash followed by certain characters specifies input
  78 characters as follows:
  79 .IP \eb
  80 BACKSPACE
  81 .IP \ee
  82 ESCAPE
  83 .IP \en
  84 NEWLINE
  85 .IP \er
  86 RETURN
  87 .IP \et
  88 TAB
  89 .IP \eku
  90 UP ARROW
  91 .IP \ekd
  92 DOWN ARROW
  93 .IP \ekr
  94 RIGHT ARROW
  95 .IP \ekl
  96 LEFT ARROW
  97 .IP \ekU
  98 PAGE UP
  99 .IP \ekD
 100 PAGE DOWN
 101 .IP \ekh
 102 HOME
 103 .IP \eke
 104 END
 105 .IP \ekx
 106 DELETE
 107 .PP
 108 A backslash followed by any other character indicates that character is
 109 to be taken literally.
 110 Characters which must be preceded by backslash include
 111 caret, space, tab and the backslash itself.
 112 .PP
 113 An action may be followed by an "extra" string.
 114 When such a command is entered while running
 115 .I less,
 116 the action is performed, and then the extra
 117 string is parsed, just as if it were typed in to
 118 .I less.
 119 This feature can be used in certain cases to extend
 120 the functionality of a command.
 121 For example, see the "{" and ":t" commands in the example below.
 122 The extra string has a special meaning for the "quit" action:
 123 when
 124 .I less
 125 quits, first character of the extra string is used as its exit status.
 126
 127 .SH EXAMPLE
 128 The following input file describes the set of
 129 default command keys used by less:
 130 .sp
 131 .nf
 132         #command
 133         \er             forw-line
 134         \en             forw-line
 135         e               forw-line
 136         j               forw-line
 137         \ekd            forw-line
 138         ^E              forw-line
 139         ^N              forw-line
 140         k               back-line
 141         y               back-line
 142         ^Y              back-line
 143         ^K              back-line
 144         ^P              back-line
 145         J               forw-line-force
 146         K               back-line-force
 147         Y               back-line-force
 148         d               forw-scroll
 149         ^D              forw-scroll
 150         u               back-scroll
 151         ^U              back-scroll
 152         \e40            forw-screen
 153         f               forw-screen
 154         ^F              forw-screen
 155         ^V              forw-screen
 156         \ekD            forw-screen
 157         b               back-screen
 158         ^B              back-screen
 159         \eev            back-screen
 160         \ekU            back-screen
 161         z               forw-window
 162         w               back-window
 163         \ee\e40         forw-screen-force
 164         F               forw-forever
 165         \eeF            forw-until-hilite
 166         R               repaint-flush
 167         r               repaint
 168         ^R              repaint
 169         ^L              repaint
 170         \eeu            undo-hilite
 171         g               goto-line
 172         \ekh            goto-line
 173         <               goto-line
 174         \ee<            goto-line
 175         p               percent
 176         %               percent
 177         \ee[            left-scroll
 178         \ee]            right-scroll
 179         \ee(            left-scroll
 180         \ee)            right-scroll
 181         \ekl            left-scroll
 182         \ekr            right-scroll
 183         \ee{            no-scroll
 184         \ee}            end-scroll
 185         {               forw-bracket {}
 186         }               back-bracket {}
 187         (               forw-bracket ()
 188         )               back-bracket ()
 189         [               forw-bracket []
 190         ]               back-bracket []
 191         \ee^F           forw-bracket
 192         \ee^B           back-bracket
 193         G               goto-end
 194         \ee>            goto-end
 195         >               goto-end
 196         \eke            goto-end
 197         \eeG            goto-end-buffered
 198         =               status
 199         ^G              status
 200         :f              status
 201         /               forw-search
 202         ?               back-search
 203         \ee/            forw-search *
 204         \ee?            back-search *
 205         n               repeat-search
 206         \een            repeat-search-all
 207         N               reverse-search
 208         \eeN            reverse-search-all
 209         &               filter
 210         m               set-mark
 211         '               goto-mark
 212         ^X^X            goto-mark
 213         E               examine
 214         :e              examine
 215         ^X^V            examine
 216         :n              next-file
 217         :p              prev-file
 218         t               next-tag
 219         T               prev-tag
 220         :x              index-file
 221         :d              remove-file
 222         -               toggle-option
 223         :t              toggle-option t
 224         s               toggle-option o
 225         _               display-option
 226         |               pipe
 227         v               visual
 228         !               shell
 229         +               firstcmd
 230         H               help
 231         h               help
 232         V               version
 233         0               digit
 234         1               digit
 235         2               digit
 236         3               digit
 237         4               digit
 238         5               digit
 239         6               digit
 240         7               digit
 241         8               digit
 242         9               digit
 243         q               quit
 244         Q               quit
 245         :q              quit
 246         :Q              quit
 247         ZZ              quit
 248 .fi
 249 .sp
 250 .SH PRECEDENCE
 251 Commands specified by
 252 .I lesskey
 253 take precedence over the default commands.
 254 A default command key may be disabled by including it in the
 255 input file with the action "invalid".
 256 Alternatively, a key may be defined
 257 to do nothing by using the action "noaction".
 258 "noaction" is similar to "invalid", but
 259 .I less
 260 will give an error beep for an "invalid" command,
 261 but not for a "noaction" command.
 262 In addition, ALL default commands may be disabled by
 263 adding this control line to the input file:
 264 .sp
 265 #stop
 266 .sp
 267 This will cause all default commands to be ignored.
 268 The #stop line should be the last line in that section of the file.
 269 .PP
 270 Be aware that #stop can be dangerous.
 271 Since all default commands are disabled,
 272 you must provide sufficient commands before the #stop line
 273 to enable all necessary actions.
 274 For example, failure to provide a "quit" command can lead to frustration.
 275
 276 .SH "LINE EDITING SECTION"
 277 The line-editing section begins with the line:
 278 .sp
 279 #line-edit
 280 .sp
 281 This section specifies new key bindings for the line editing commands,
 282 in a manner similar to the way key bindings for
 283 ordinary commands are specified in the #command section.
 284 The line-editing section consists of a list of keys and actions,
 285 one per line as in the example below.
 286
 287 .SH EXAMPLE
 288 The following input file describes the set of
 289 default line-editing keys used by less:
 290 .sp
 291 .nf
 292         #line-edit
 293         \et             forw-complete
 294         \e17            back-complete
 295         \ee\et          back-complete
 296         ^L              expand
 297         ^V              literal
 298         ^A              literal
 299         \eel            right
 300         \ekr            right
 301         \eeh            left
 302         \ekl            left
 303         \eeb            word-left
 304         \ee\ekl word-left
 305         \eew            word-right
 306         \ee\ekr word-right
 307         \eei            insert
 308         \eex            delete
 309         \ekx            delete
 310         \eeX            word-delete
 311         \eekx           word-delete
 312         \ee\eb          word-backspace
 313         \ee0            home
 314         \ekh            home
 315         \ee$            end
 316         \eke            end
 317         \eek            up
 318         \eku            up
 319         \eej            down
 320         ^G              abort
 321 .fi
 322 .sp
 323
 324 .SH "LESS ENVIRONMENT VARIABLES"
 325 The environment variable section begins with the line
 326 .sp
 327 #env
 328 .sp
 329 Following this line is a list of environment variable assignments.
 330 Each line consists of an environment variable name, an equals sign (=)
 331 and the value to be assigned to the environment variable.
 332 White space before and after the equals sign is ignored.
 333 Variables assigned in this way are visible only to
 334 .I less.
 335 If a variable is specified in the system environment and also in a
 336 lesskey file, the value in the lesskey file takes precedence.
 337 Although the lesskey file can be used to override variables set in the
 338 environment, the main purpose of assigning variables in the lesskey file
 339 is simply to have all
 340 .I less
 341 configuration information stored in one file.
 342
 343 .SH EXAMPLE
 344 The following input file sets the -i option whenever
 345 .I less
 346 is run, and specifies the character set to be "latin1":
 347 .sp
 348 .nf
 349         #env
 350         LESS = -i
 351         LESSCHARSET = latin1
 352 .fi
 353 .sp
 354
 355 .SH "SEE ALSO"
 356 less(1)
 357
 358 .SH WARNINGS
 359 On MS-DOS and OS/2 systems, certain keys send a sequence of characters
 360 which start with a NUL character (0).
 361 This NUL character should be represented as \e340 in a lesskey file.
 362
 363 .SH COPYRIGHT
 364 Copyright (C) 1984-2017  Mark Nudelman
 365 .PP
 366 less is part of the GNU project and is free software.
 367 You can redistribute it and/or modify it
 368 under the terms of either
 369 (1) the GNU General Public License as published by
 370 the Free Software Foundation; or (2) the Less License.
 371 See the file README in the less distribution for more details
 372 regarding redistribution.
 373 You should have received a copy of the GNU General Public License
 374 along with the source for less; see the file COPYING.
 375 If not, write to the Free Software Foundation, 59 Temple Place,
 376 Suite 330, Boston, MA  02111-1307, USA.
 377 You should also have received a copy of the Less License;
 378 see the file LICENSE.
 379 .PP
 380 less is distributed in the hope that it will be useful, but
 381 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 382 or FITNESS FOR A PARTICULAR PURPOSE.
 383 See the GNU General Public License for more details.
 384
 385 .SH AUTHOR
 386 .PP
 387 Mark Nudelman
 388 .br
 389 Send bug reports or comments to <bug-less@gnu.org>.