xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: use full names for exec/eval and add links to relevant pages

Browse Source
This commit is contained in:
Delapouite 2017-11-08 18:38:31 +01:00
parent 8168882c3f
commit a1836b47a4
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/pages/execeval.asciidoc
View File

@ -1,22 +1,23 @@
= Exec and Eval
= Execute-keys and Evaluate-commands
== Description
The *exec* and *eval* commands can be used to run Kakoune commands, and
should be used as follows:
The *execute-keys* and *evaluate-commands* commands can be used to run
Kakoune commands, and should be used as follows:
----------------------------
exec [<flags>] <key> ...
eval [<flags>] <command> ...
execute-keys [<flags>] <key> ...
evaluate-commands [<flags>] <command> ...
----------------------------
*exec* runs keys as if they were pressed, whereas *eval* executes its given
parameters as if they were entered in the command prompt. By default, their
execution happens within the context of the current client, and stops when
the last key/command is reached, or an error is raised.
*execute-keys* runs keys as if they were pressed, whereas *evaluate-commands*
evaluates its given parameters as if they were entered in the command prompt.
By default, their execution happens within the context of the current client,
and stops when the last key/command is reached, or an error is raised.
These two commands also save the following registers, who are then restored
when the commands have been executed: */*, *"*, *|*, *^*, *@*.
(See <<registers#,`:doc registers`>>)
== Optional flags
@ -44,9 +45,11 @@ when the commands have been executed: */*, *"*, *|*, *^*, *@*.
*-no-hooks*::
disable hook execution while executing the keys/commands
(See <<hooks#,`:doc hooks`>>)
*-with-maps*::
use user key mapping in instead of built in keys (*exec* only)
use user key mapping in instead of built in keys (*execute-keys* only)
(See <<mapping#,`:doc mapping`>>)
*-save-regs* <regs>::
regs is a string of registers to be restored after execution (overwrites

5
doc/pages/hooks.asciidoc
View File

@ -180,5 +180,6 @@ A less temporary alternative is to set the `disabled_hooks` option which
accepts a regex describing which hooks won't be executed.
For example indentation hooks can be disabled with '.*-indent'.
Finally, hook execution can be disabled while using the `exec` or `eval`
commands by using the `-no-hooks` switch.
Finally, hook execution can be disabled while using the `execute-keys` or
`evaluate-commands` commands by using the `-no-hooks` switch.
(See <<execeval#,`:doc execeval`>>)