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

doc commands: Align mis-indented command flags

Browse Source
This commit is contained in:
Frank LENORMAND 2020-11-17 16:09:56 +03:00 committed by GitHub
parent cdcf4b0c7d
commit 5931655397
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/pages/commands.asciidoc
View File

@ -410,7 +410,7 @@ 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*:::
*-override*:::
allow the module to replace an existing one with the same name. Fails if
the module has already been evaluated.
@ -437,26 +437,26 @@ 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>:::
*-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*:::
*-file-completion*:::
try file completion on any parameter passed to this command
*-client-completion*:::
*-client-completion*:::
try client name completion on any parameter passed to this command
*-buffer-completion*:::
*-buffer-completion*:::
try buffer name completion on any parameter passed to this command
*-command-completion*:::
*-command-completion*:::
try command completion on any parameter passed to this command
*-shell-completion*:::
*-shell-completion*:::
try shell command completion on any parameter passed to this command
*-shell-script-completion*:::
*-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
@ -471,7 +471,7 @@ New commands can be defined using the *define-command* command:
Position of the cursor inside the token being completed, in bytes
from token start.
*-shell-script-candidates*:::
*-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
@ -484,13 +484,13 @@ New commands can be defined using the *define-command* command:
- *kak_token_to_complete*::::
Index of the token being completed in the command line.
*-override*:::
*-override*:::
allow the new command to replace an existing one with the same name
*-hidden*:::
*-hidden*:::
do not show the command in command name completions
*-docstring*:::
*-docstring*:::
define the documentation string for the command
Using shell expansion allows defining complex commands or accessing