Add feedkeys documentation

This commit is contained in:
Sebastian Ramacher 2019-04-26 19:37:06 +02:00
parent d27e2da05b
commit 641799c45a

View file

@ -62,16 +62,6 @@ accordingly or to escape the hash symbol.
set default-fg "#CCBBCC" set default-fg "#CCBBCC"
set default-fg \#CCBBCC set default-fg \#CCBBCC
map - Mapping a shortcut
------------------------
It is possible to map or remap new key bindings to shortcut functions which
allows a high level of customization. The ``:map`` command can also be used in
the *zathurarc* file to make those changes permanent:
::
map [mode] <binding> <shortcut function> <argument>
include - Including another config file include - Including another config file
--------------------------------------- ---------------------------------------
This commands allows one to include other configuration files. If a relative This commands allows one to include other configuration files. If a relative
@ -82,6 +72,16 @@ is currently processed.
include another-config include another-config
map - Mapping a shortcut
------------------------
It is possible to map or remap new key bindings to shortcut functions which
allows a high level of customization. The ``:map`` command can also be used in
the *zathurarc* file to make those changes permanent:
::
map [mode] <binding> <shortcut function> <argument>
Mode Mode
^^^^ ^^^^
The ``map`` command expects several arguments where only the ``binding`` as well as The ``map`` command expects several arguments where only the ``binding`` as well as
@ -122,7 +122,8 @@ keyboard. It is possible to use the following modifiers:
* C - Control * C - Control
* S - Shift * S - Shift
Now it is required to define the ``binding`` with the following structure: If any of the modifiers should be used for a binding, it is required to define
the ``binding`` with the following structure:
:: ::
@ -313,11 +314,19 @@ The following shortcut functions can be mapped:
Zoom in or out. Zoom in or out.
* ``mark_add`` * ``mark_add``
Set a quickmark. Set a quickmark.
* ``mark_evaluate`` * ``mark_evaluate``
Go to a quickmark. Go to a quickmark.
* ``feedkeys``
Simulate key presses. Note that all keys will be interpreted as if pressing a
key on the keyboard. To input uppercase letters, follow the same convention as
for key bindings, i.e. for ``X``, use ``<S-X>``.
Pass arguments Pass arguments
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^