lesskey - Man Page

specify key bindings for less

SYNOPSIS (deprecated)

lesskey [-o output] [--] [input]
lesskey [--output=output] [--] [input]
lesskey -V
lesskey --version

Scope

This document describes the format of the lesskey source file, which is used by less version 582 and later. In previous versions of less, a separate program called lesskey was used to compile the lesskey source file into a format understood by less. This compilation step is no longer required and the lesskey program is therefore deprecated although the file format remains supported by less itself.

File Format

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

#command

Defines new command keys.

#line-edit

Defines new line-editing keys.

#env

Defines environment variables.

Blank lines and lines which start with a pound sign (#) are ignored, except for the special section header lines.

Command Section

The command section begins with the line

#command

If the command section is the first section in the file, this line may be omitted. The command section consists of lines of the form:

string <whitespace> action [extra-string] <newline>

Whitespace is any sequence of one or more spaces and/or tabs. The string is the command key(s) which invoke the action. The string may be a single command key, or a sequence of up to 15 keys. The action is the name of the less action, from the list below. The characters in the string may appear literally, or be prefixed by a caret to indicate a control key. A backslash followed by one to three octal digits may be used to specify a character by its octal value. A backslash followed by certain characters specifies input characters as follows:

\b

BACKSPACE

\e

ESCAPE

\n

NEWLINE

\r

RETURN

\t

TAB

\ku

UP ARROW

\kd

DOWN ARROW

\kr

RIGHT ARROW

\kl

LEFT ARROW

\kU

PAGE UP

\kD

PAGE DOWN

\kh

HOME

\ke

END

\kx

DELETE

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

An action may be followed by an "extra" string. When such a command is entered while running less, the action is performed, and then the extra string is parsed, just as if it were typed in to less. This feature can be used in certain cases to extend the functionality of a command. For example, see the "{" and ":t" commands in the example below. The extra string has a special meaning for the "quit" action: when less quits, the first character of the extra string is used as its exit status.

Example

The following input file describes the set of default command keys used by less:

#command
\rforw-line
\nforw-line
eforw-line
jforw-line
\kdforw-line
^Eforw-line
^Nforw-line
kback-line
yback-line
^Yback-line
^Kback-line
^Pback-line
Jforw-line-force
Kback-line-force
Yback-line-force
dforw-scroll
^Dforw-scroll
uback-scroll
^Uback-scroll
\40forw-screen
fforw-screen
^Fforw-screen
^Vforw-screen
\kDforw-screen
bback-screen
^Bback-screen
\evback-screen
\kUback-screen
zforw-window
wback-window
\e\40forw-screen-force
Fforw-forever
\eFforw-until-hilite
Rrepaint-flush
rrepaint
^Rrepaint
^Lrepaint
\euundo-hilite
\eUclear-search
ggoto-line
\khgoto-line
<goto-line
\e<goto-line
ppercent
%percent
\e[left-scroll
\e]right-scroll
\e(left-scroll
\e)right-scroll
\klleft-scroll
\krright-scroll
\e{no-scroll
\e}end-scroll
{forw-bracket {}
}back-bracket {}
(forw-bracket ()
)back-bracket ()
[forw-bracket []
]back-bracket []
\e^Fforw-bracket
\e^Bback-bracket
Ggoto-end
\e>goto-end
>goto-end
\kegoto-end
\eGgoto-end-buffered
=status
^Gstatus
:fstatus
/forw-search
?back-search
\e/forw-search *
\e?back-search *
nrepeat-search
\enrepeat-search-all
Nreverse-search
\eNreverse-search-all
&filter
mset-mark
Mset-mark-bottom
\emclear-mark
^X^Xgoto-mark
Eexamine
:eexamine
^X^Vexamine
:nnext-file
:pprev-file
tnext-tag
Tprev-tag
:xindex-file
:dremove-file
-toggle-option
:ttoggle-option t
stoggle-option o
_display-option
|pipe
vvisual
!shell
+firstcmd
Hhelp
hhelp
Vversion
0digit
1digit
2digit
3digit
4digit
5digit
6digit
7digit
8digit
9digit
qquit
Qquit
:qquit
:Qquit
ZZquit

Precedence

Commands specified by lesskey take precedence over the default commands. A default command key may be disabled by including it in the input file with the action "invalid". Alternatively, a key may be defined to do nothing by using the action "noaction". "noaction" is similar to "invalid", but less will give an error beep for an "invalid" command, but not for a "noaction" command. In addition, ALL default commands may be disabled by adding this control line to the input file:

#stop

This will cause all default commands to be ignored. The #stop line should be the last line in that section of the file.

Be aware that #stop can be dangerous. Since all default commands are disabled, you must provide sufficient commands before the #stop line to enable all necessary actions. For example, failure to provide a "quit" command can lead to frustration.

Line Editing Section

The line-editing section begins with the line:

#line-edit

This section specifies new key bindings for the line editing commands, in a manner similar to the way key bindings for ordinary commands are specified in the #command section. The line-editing section consists of a list of keys and actions, one per line as in the example below.

Example

The following input file describes the set of default line-editing keys used by less:

#line-edit
\tforw-complete
\17back-complete
\e\tback-complete
^Lexpand
^Vliteral
^Aliteral
\elright
\krright
\ehleft
\klleft
\ebword-left
\e\klword-left
\ewword-right
\e\krword-right
\eiinsert
\exdelete
\kxdelete
\eXword-delete
\ekxword-delete
\e\bword-backspace
\e0home
\khhome
\e$end
\keend
\ekup
\kuup
\ejdown
^Gabort

Less Environment Variables

The environment variable section begins with the line

#env

Following this line is a list of environment variable assignments. Each line consists of an environment variable name, an equals sign (=) and the value to be assigned to the environment variable. White space before and after the equals sign is ignored. Variables assigned in this way are visible only to less. If a variable is specified in the system environment and also in a lesskey file, the value in the lesskey file takes precedence. Although the lesskey file can be used to override variables set in the environment, the main purpose of assigning variables in the lesskey file is simply to have all less configuration information stored in one file.

Example

The following input file sets the -i option whenever less is run, and specifies the character set to be "latin1":

	#env
	LESS = -i
	LESSCHARSET = latin1

See Also

less(1)

Warnings

On MS-DOS and OS/2 systems, certain keys send a sequence of characters which start with a NUL character (0). This NUL character should be represented as \340 in a lesskey file.

Author

Mark Nudelman
Report bugs at https://github.com/gwsw/less/issues.

Referenced By

less(1).

Version 590: 03 Jun 2021