From a1836b47a485e9ceba52fac60993a000b539a4d3 Mon Sep 17 00:00:00 2001 From: Delapouite Date: Wed, 8 Nov 2017 18:38:31 +0100 Subject: [PATCH] Docs: use full names for exec/eval and add links to relevant pages --- doc/pages/execeval.asciidoc | 23 +++++++++++++---------- doc/pages/hooks.asciidoc | 5 +++-- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/doc/pages/execeval.asciidoc b/doc/pages/execeval.asciidoc index 6d8db681..2826004d 100644 --- a/doc/pages/execeval.asciidoc +++ b/doc/pages/execeval.asciidoc @@ -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 [] ... -eval [] ... +execute-keys [] ... +evaluate-commands [] ... ---------------------------- -*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 <>) == Optional flags @@ -44,9 +45,11 @@ when the commands have been executed: */*, *"*, *|*, *^*, *@*. *-no-hooks*:: disable hook execution while executing the keys/commands + (See <>) *-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 <>) *-save-regs* :: regs is a string of registers to be restored after execution (overwrites diff --git a/doc/pages/hooks.asciidoc b/doc/pages/hooks.asciidoc index 48127a41..b3fdc22e 100644 --- a/doc/pages/hooks.asciidoc +++ b/doc/pages/hooks.asciidoc @@ -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 <>)