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

fix(README): remove <register> from prompt and onkey commands

Browse Source
This commit is contained in:
Delapouite 2017-01-17 18:08:10 +01:00
parent 7316afd17b
commit c61aae0722
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.asciidoc
View File

@ -1508,12 +1508,11 @@ Kakoune state:
Some helper commands can be used to define composite commands: Some helper commands can be used to define composite commands:
* `prompt <prompt> <register> <command>`: Prompt the user for a string, when * `prompt <prompt> <command>`: prompt the user for a string, when the user validates,
the user validates, store the result in given <register> and run <commmand>. executes <command>. The entered text is available in the `text` value
the -init <str> switch allows setting initial content and -password allow accessible through `$kak_text` in shells or `%val{text}` in commands.
not to show the entered text (and clears the register after command execution). * `onkey <command>`: wait for next key from user, then execute <command>,
* `onkey <register> <command>`: Wait for next key from user, writes it into given the key is available through the `key` value, accessible through `$kak_key`.
<register> and execute commands.
* `menu <label1> <commands1> <label2> <commands2>...`: display a menu using * `menu <label1> <commands1> <label2> <commands2>...`: display a menu using
labels, the selected label's commands are executed. labels, the selected label's commands are executed.
`menu` can take a -auto-single argument, to automatically run commands `menu` can take a -auto-single argument, to automatically run commands