From 9664ce5f89d4514ea03b6179931efcd527950d09 Mon Sep 17 00:00:00 2001 From: Maxime Coste Date: Tue, 11 Sep 2012 13:54:43 +0200 Subject: [PATCH] update README --- README.asciidoc | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.asciidoc b/README.asciidoc index d09b2ec9..55ae9077 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -260,6 +260,7 @@ Some of kakoune state is available through environment variables: * *kak_selection*: content of the last selection * *kak_bufname*: name of the current buffer + * *kak_runtime*: directory containing the kak binary * *kak_opt_name*: value of option name * *kak_reg_x*: value of register x @@ -288,8 +289,10 @@ new commands can be defined using the *def* command. def can also takes some flags: * *-env-params*: pass parameters given to commands in the environement as kak_paramN with N the parameter number + * *-shell-params*: pass parameters given to commands as positional parameters + to any shell expansions used in the command. * *-shell-completion*: following string is a shell command which takes - parameters through the environemnt and output one + parameters as positional params and output one completion candidate per line. * *-allow-override*: allow the new command to replace an exisiting one with the same name. @@ -309,3 +312,14 @@ Some helper commands can be used to define composite commands: Note that these commands are available in interactive command mode, but are not that useful in this context. + +FIFO Buffer +----------- + +the *edit* command can take a -fifo parameter: +:edit -fifo +in this case, a buffer named is created which reads its content +from . When filename is appended to, the buffer is automatically +updated. +This is very useful for running some commands asynchronously while displaying +their result in a buffer. See rc/make.kak and rc/grep.kak for examples.