commit fda40061bde8d8401090c09dd525029df7934ee2
parent 3d224fbf6ef3157c0b8a93a32da2e87b27aa943f
Author: lumidify <nobody@lumidify.org>
Date: Sat, 28 May 2022 13:11:31 +0200
Sort of document keysyms
Diffstat:
| M | leditrc.5 | | | 168 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- |
1 file changed, 163 insertions(+), 5 deletions(-)
diff --git a/leditrc.5 b/leditrc.5
@@ -79,7 +79,8 @@ at the cursor position.
When it is line based, the text is inserted after the line.
.It Ar softline/hardline
A hardline is an actual line separated from the other lines by a newline
-character. A softline is a displayed line, but might only be part of a
+character.
+A softline is a displayed line, but might only be part of a
hardline if the text is wrapped.
.Nm
can be in hardline or softline mode.
@@ -164,9 +165,7 @@ This is a list of statements of the form
.Op Sy mods Aq mods
.Pp
.Sy keysym
-is the symbolic description for a key, such as
-.Ar space .
-The full list is not documented yet (FIXME!).
+is the symbolic description for a key,
.Sy text
is the text corresponding to a key.
.Sy catchall
@@ -182,6 +181,9 @@ Exactly one of
and
.Sy catchall
must be specified.
+See
+.Sx KEYSYMS
+for a list of all currently supported keysyms.
.Pp
.Sy mods
specifies modifier keys.
@@ -247,7 +249,7 @@ is listed beside the function name, this means that a character must be
typed immediately after calling the function (this is used e.g. to get a
character when setting a mark).
.Pp
-Functions that overwrite the paste buffer usually only to that in normal
+Functions that overwrite the paste buffer usually only do that in normal
and visual mode.
It isn't entirely clear what the best behavior here would be.
.Bl -tag -width Ds
@@ -928,6 +930,162 @@ different keyboard layout.
If someone has a good idea for making other commands properly usable with other
keyboard mappings, I might consider it, though.
.El
+.Sh KEYSYMS
+These are the currently supported keysyms.
+I don't know what a lot of these are supposed to be, they were just
+copied from the list in the X header files.
+Let me know if there are any others I should add.
+.Bl -tag -width Ds
+.It Ar General keys
+.Pp
+.Bl -tag -width Ds -compact
+.It Ar backspace
+.It Ar begin
+.It Ar break
+.It Ar cancel
+.It Ar clear
+.It Ar delete
+.It Ar down
+.It Ar end
+.It Ar escape
+.It Ar execute
+.It Ar find
+.It Ar help
+.It Ar home
+.It Ar insert
+.It Ar left
+.It Ar linefeed
+.It Ar menu
+.It Ar mode-switch
+.It Ar next
+.It Ar num-lock
+.It Ar page-down
+.It Ar page-up
+.It Ar pause
+.It Ar print
+.It Ar prior
+.It Ar redo
+.It Ar return
+.It Ar right
+.It Ar script-switch
+.It Ar scroll-lock
+.It Ar select
+.It Ar space
+.It Ar sysreq
+.It Ar tab
+.It Ar up
+.It Ar undo
+.El
+.It Ar Function keys
+.Pp
+.Bl -tag -width Ds -compact
+.It Ar f1
+.It Ar f2
+.It Ar f3
+.It Ar f4
+.It Ar f5
+.It Ar f6
+.It Ar f7
+.It Ar f8
+.It Ar f9
+.It Ar f10
+.It Ar f11
+.It Ar f12
+.It Ar f13
+.It Ar f14
+.It Ar f15
+.It Ar f16
+.It Ar f17
+.It Ar f18
+.It Ar f19
+.It Ar f20
+.It Ar f21
+.It Ar f22
+.It Ar f23
+.It Ar f24
+.It Ar f25
+.It Ar f26
+.It Ar f27
+.It Ar f28
+.It Ar f29
+.It Ar f30
+.It Ar f31
+.It Ar f32
+.It Ar f33
+.It Ar f34
+.It Ar f35
+.El
+.It Ar Keypad keys
+.Pp
+.Bl -tag -width Ds -compact
+.It Ar kp-0
+.It Ar kp-1
+.It Ar kp-2
+.It Ar kp-3
+.It Ar kp-4
+.It Ar kp-5
+.It Ar kp-6
+.It Ar kp-7
+.It Ar kp-8
+.It Ar kp-9
+.It Ar kp-add
+.It Ar kp-begin
+.It Ar kp-decimal
+.It Ar kp-delete
+.It Ar kp-divide
+.It Ar kp-down
+.It Ar kp-end
+.It Ar kp-enter
+.It Ar kp-equal
+.It Ar kp-f1
+.It Ar kp-f2
+.It Ar kp-f3
+.It Ar kp-f4
+.It Ar kp-home
+.It Ar kp-insert
+.It Ar kp-left
+.It Ar kp-multiply
+.It Ar kp-next
+.It Ar kp-page-down
+.It Ar kp-page-up
+.It Ar kp-prior
+.It Ar kp-right
+.It Ar kp-separator
+.It Ar kp-space
+.It Ar kp-subtract
+.It Ar kp-tab
+.It Ar kp-up
+.El
+.It Ar Weird keys that I don't know
+.Pp
+.Bl -tag -width Ds -compact
+.It Ar l1
+.It Ar l2
+.It Ar l3
+.It Ar l4
+.It Ar l5
+.It Ar l6
+.It Ar l7
+.It Ar l8
+.It Ar l9
+.It Ar l10
+.It Ar r1
+.It Ar r2
+.It Ar r3
+.It Ar r4
+.It Ar r5
+.It Ar r6
+.It Ar r7
+.It Ar r8
+.It Ar r9
+.It Ar r10
+.It Ar r11
+.It Ar r12
+.It Ar r13
+.It Ar r14
+.It Ar r15
+.El
+.El
.Sh EXAMPLES
See the example configuration file
.Pa leditrc.example .
