summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrank LENORMAND <1379068+lenormf@users.noreply.github.com>2020-11-17 16:09:56 +0300
committerGitHub <noreply@github.com>2020-11-17 16:09:56 +0300
commit5931655397f62d6dccf9ba7dfecc7e287727fd4e (patch)
tree167398b50d26e6c42ef72f21f1f665d77e8a5b81
parentcdcf4b0c7d2f5b2bb07bd38599e19b886942cea4 (diff)
doc commands: Align mis-indented command flags
-rw-r--r--doc/pages/commands.asciidoc86
1 files changed, 43 insertions, 43 deletions
diff --git a/doc/pages/commands.asciidoc b/doc/pages/commands.asciidoc
index d855f285..c9265181 100644
--- a/doc/pages/commands.asciidoc
+++ b/doc/pages/commands.asciidoc
@@ -410,9 +410,9 @@ but not really useful in that context.
declares a module *name* that is defined by *commands*. *commands* will be
evaluated as if by source the first time *require-module <name>* is run.
-*-override*:::
- allow the module to replace an existing one with the same name. Fails if
- the module has already been evaluated.
+ *-override*:::
+ allow the module to replace an existing one with the same name. Fails if
+ the module has already been evaluated.
*require-module* <name>::
guarantees the commands associated with *name* have been evaluated before
@@ -437,61 +437,61 @@ New commands can be defined using the *define-command* command:
*commands* is a string containing the commands to execute, and *switches*
can be any combination of the following parameters:
-*-params* <num>:::
- the command accepts a *num* parameter, which can be either a number,
- or of the form <min>..<max>, with both <min> and <max> omittable
+ *-params* <num>:::
+ the command accepts a *num* parameter, which can be either a number,
+ or of the form <min>..<max>, with both <min> and <max> omittable
-*-file-completion*:::
- try file completion on any parameter passed to this command
+ *-file-completion*:::
+ try file completion on any parameter passed to this command
-*-client-completion*:::
- try client name completion on any parameter passed to this command
+ *-client-completion*:::
+ try client name completion on any parameter passed to this command
-*-buffer-completion*:::
- try buffer name completion on any parameter passed to this command
+ *-buffer-completion*:::
+ try buffer name completion on any parameter passed to this command
-*-command-completion*:::
- try command completion on any parameter passed to this command
+ *-command-completion*:::
+ try command completion on any parameter passed to this command
-*-shell-completion*:::
- try shell command completion on any parameter passed to this command
+ *-shell-completion*:::
+ try shell command completion on any parameter passed to this command
-*-shell-script-completion*:::
- following string is a shell command which takes parameters as
- positional params and outputs one completion candidate per line.
- The provided shell command will run after each keypress
+ *-shell-script-completion*:::
+ following string is a shell command which takes parameters as
+ positional params and outputs one completion candidate per line.
+ The provided shell command will run after each keypress
- during the execution of the shell command, the following env vars are
- available:
+ during the execution of the shell command, the following env vars are
+ available:
- - *kak_token_to_complete*::::
- Index of the token being completed in the command line.
+ - *kak_token_to_complete*::::
+ Index of the token being completed in the command line.
- - *kak_pos_in_token*::::
- Position of the cursor inside the token being completed, in bytes
- from token start.
+ - *kak_pos_in_token*::::
+ Position of the cursor inside the token being completed, in bytes
+ from token start.
-*-shell-script-candidates*:::
- following string is a shell command which takes parameters as
- positional params and outputs one completion candidate per line.
- The provided shell command will run once at the beginning of each
- completion session, candidates are cached and then used by kakoune
- internal fuzzy engine
+ *-shell-script-candidates*:::
+ following string is a shell command which takes parameters as
+ positional params and outputs one completion candidate per line.
+ The provided shell command will run once at the beginning of each
+ completion session, candidates are cached and then used by kakoune
+ internal fuzzy engine
- during the execution of the shell command, the following env vars are
- available:
+ during the execution of the shell command, the following env vars are
+ available:
- - *kak_token_to_complete*::::
- Index of the token being completed in the command line.
+ - *kak_token_to_complete*::::
+ Index of the token being completed in the command line.
-*-override*:::
- allow the new command to replace an existing one with the same name
+ *-override*:::
+ allow the new command to replace an existing one with the same name
-*-hidden*:::
- do not show the command in command name completions
+ *-hidden*:::
+ do not show the command in command name completions
-*-docstring*:::
- define the documentation string for the command
+ *-docstring*:::
+ define the documentation string for the command
Using shell expansion allows defining complex commands or accessing
Kakoune's state: