Git commit 666c1c8372f862ee1263569c587e22032a860752 by Kurt Hindenburg, on
behalf of Ahmad Samir.
Committed on 11/04/2018 at 13:11.
Pushed by hindenburg into branch 'master'.
Add docs to the user manual about the terminal key bindings
Summary:
Also mention the manual on the Keyboard tab in the Edit Profile Dialog
to make it more discoverable for users.
Sources used while writing this documentation:
- data/keyboard-layouts/README.KeyTab
- doc/user/README.keyboard
- https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
- https://www.vt100.net/docs/vt100-ug
Reviewers: #konsole, hindenburg, yurchor, ltoscano
Reviewed By: #konsole, hindenburg
Subscribers: kde-doc-english, hindenburg, #konsole
Tags: #konsole
Differential Revision: https://phabricator.kde.org/D12015
M +209 -2doc/manual/index.docbook
M +1-1src/EditProfileDialog.ui
https://commits.kde.org/konsole/666c1c8372f862ee1263569c587e22032a860752
diff --git a/doc/manual/index.docbook b/doc/manual/index.docbook
index d872230a..7cd95624 100644
--- a/doc/manual/index.docbook
+++ b/doc/manual/index.docbook
@@ -3,6 +3,8 @@
"dtd/kdedbx45.dtd" [
+AhmadSamir'>
+a.samir...@gmail.com'>
]>
@@ -12,6 +14,7 @@
+
@@ -42,10 +45,15 @@
+
+2018
+
+
+
-2018-03-10
-Applications 18.04
+2018-04-03
+Applications 18.08
is 's terminal emulator.
@@ -1320,6 +1328,205 @@ For more information, please visit
+
+Terminal Key Bindings
+
+
+How Uses Key Bindings
+
+
+Introduction
+ uses *.keytab files to translate key combinations into control
characters and escape sequences that are sent to the shell or to interactive
programs (typically programs that use the Alternate Screen buffer,
vim, less,
screen) running in the shell.
+
+Users can customize the key bindings settings in using the Key
Bindings Editor. A key combination can be configured to send a specific control
or escape sequence to the terminal.
+
+You can open the Key Bindings Editor from the menu entry
SettingsEdit Current
Profile, and going to the
Keyboard tab. Listed there are the Key Bindings schemas
that come by default with .
+
+
+
+Key Combinations and Modes
+
+Key combinations follow the pattern:
+Key (+|-) Modes
+
+
+for example:
+
+Up+Shift+AppScreen
+Down+Shift-AppScreen
+Space+Ctrl
+
+
+
+Key names are defined in the qnamespace.h header file, with the
Qt::Key_ prefix removed, for a list of key names check the
https://doc.qt.io/qt-5/qt.html#Key-enum;>Qt::Key enumeration in the
documentation.
+
+A + preceding a Mode name means that mode is
set; for a modifier key, that means it's pressed, whereas
for all other modes it means that particular mode is in effect ( active).
For example +Ctrl means the key combination will work only if
the key is pressed.
+
+A - preceding a Mode name means that mode is
reset; basically this is the opposite of putting
+ before a Mode name, so for a modifier key that means the key
isn't pressed, whereas for all other modes it means that particular mode is
inactive. For example -Ctrl means the key combination will work
only if the key is not pressed.
+
+
+If a Mode name isn't present in a key combination, its state is
ignored.
+
+
+The supported Key Bindings modes are listed below:
+
+
+
+
+Alt, Ctrl, Shift
+
+One or more of these Modes can be used in a key combination, if any of
them is set, the key combination uses that modifier key, respectively; and vice
versa if it's reset
+
+
+
+
+AnyModifier
+
+If this mode is set, the key combination uses any modifier key (any of
the previous three modifier keys); and vice versa if it's reset
+
+
+
+
+Ansi
+
+If this mode is set, will send ANSI escape and control
sequences
+If this mode is reset will send VT52 escape and control
sequences
+
+
+
+
+AppScreen
+
+If this mode is set, the key combination will only affect interactive
programs that use the Alternate Screen buffer
+If this mode is reset the key combination will only affect the terminal
when it's using the Normal Screen buffer
+
+
+ makes use of two screen buffers:
+
+
+The Normal Screen buffer (default): allows you to scroll back to view
previous lines of output, this is the default buffer you usually use to execute
commands...
+
+
+The Alternate Screen buffer: the terminal switches to this buffer when
you run an interactive program ( less,
vim, screen,
tmux... )
+
+
+
+
+
+
+
+
+KeyPad
+
+If this mode is set, the key combination uses a key on the Keypad
(Number Pad). This mode is useful to distinguish between keys on the keyboard
and keys on the Keypad. For example when Num Lock is on
you can configure two separate key combinations, one using the key labelled
1 on the keyboard (usually under the F1 key)
and the other using the key labelled 1 on the Keypad. The same
concept applies when Num Lock is off for the End, Home,
Cursor Keys ...etc on the Keypad
+
+
+
+
+AppCursorKeys
+
+This mode implements the VT100
