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

86
doc/pages/commands.asciidoc
View File

@ -410,9 +410,9 @@ but not really useful in that context.
declares a module *name* that is defined by *commands*. *commands* will be 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. 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 allow the module to replace an existing one with the same name. Fails if
the module has already been evaluated. the module has already been evaluated.
*require-module* <name>:: *require-module* <name>::
guarantees the commands associated with *name* have been evaluated before 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* *commands* is a string containing the commands to execute, and *switches*
can be any combination of the following parameters: can be any combination of the following parameters:
*-params* <num>::: *-params* <num>:::
the command accepts a *num* parameter, which can be either a number, the command accepts a *num* parameter, which can be either a number,
or of the form <min>..<max>, with both <min> and <max> omittable 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 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 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 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 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 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 following string is a shell command which takes parameters as
positional params and outputs one completion candidate per line. positional params and outputs one completion candidate per line.
The provided shell command will run after each keypress The provided shell command will run after each keypress
during the execution of the shell command, the following env vars are during the execution of the shell command, the following env vars are
available: available:
- *kak_token_to_complete*:::: - *kak_token_to_complete*::::
Index of the token being completed in the command line. Index of the token being completed in the command line.
- *kak_pos_in_token*:::: - *kak_pos_in_token*::::
Position of the cursor inside the token being completed, in bytes Position of the cursor inside the token being completed, in bytes
from token start. from token start.
*-shell-script-candidates*::: *-shell-script-candidates*:::
following string is a shell command which takes parameters as following string is a shell command which takes parameters as
positional params and outputs one completion candidate per line. positional params and outputs one completion candidate per line.
The provided shell command will run once at the beginning of each The provided shell command will run once at the beginning of each
completion session, candidates are cached and then used by kakoune completion session, candidates are cached and then used by kakoune
internal fuzzy engine internal fuzzy engine
during the execution of the shell command, the following env vars are during the execution of the shell command, the following env vars are
available: available:
- *kak_token_to_complete*:::: - *kak_token_to_complete*::::
Index of the token being completed in the command line. 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 allow the new command to replace an existing one with the same name
*-hidden*::: *-hidden*:::
do not show the command in command name completions do not show the command in command name completions
*-docstring*::: *-docstring*:::
define the documentation string for the command define the documentation string for the command
Using shell expansion allows defining complex commands or accessing Using shell expansion allows defining complex commands or accessing
Kakoune's state: Kakoune's state: