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

Fix :def documentation in README.asciidoc

Browse Source
This commit is contained in:
Maxime Coste 2015-12-02 00:58:15 +00:00
parent 982270abf9
commit 63d9218fbe
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.asciidoc
View File

@ -1295,15 +1295,20 @@ New commands can be defined using the `:def` command.
`def` can also takes some flags: `def` can also takes some flags:
* `-shell-params`: pass parameters given to commands as positional parameters * `-params <num>`: the command accept <num> parameters, with <num>
to any shell expansions used in the command. either a number, or of the form <min>..<max>, with both <min> and
<max> omittable.
* `-file-completion`: try file completion on any parameter passed * `-file-completion`: try file completion on any parameter passed
to this command 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
* `-shell-completion`: following string is a shell command which takes * `-shell-completion`: following string is a shell command which takes
parameters as positional params and output one parameters as positional params and output one completion candidate
completion candidate per line. per line.
* `-allow-override`: allow the new command to replace an exisiting one * `-allow-override`: allow the new command to replace an exisiting one
with the same name. 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