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

Update documentation

Browse Source
This commit is contained in:
Maxime Coste 2014-03-02 02:08:17 +00:00
parent 30093413f7
commit 4ba99f7d6f
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.asciidoc
View File

@ -55,7 +55,6 @@ Kakoune dependencies are:
* boost (>= 1.50) * boost (>= 1.50)
* ncurses with wide-characters support (>= 5.3, generally refered as libncursesw) * ncurses with wide-characters support (>= 5.3, generally refered as libncursesw)
* bash (kak scripts use some bash specific features) * bash (kak scripts use some bash specific features)
* socat (used by kak scripts to write to kak control socket)
To build, just type *make* in the src directory To build, just type *make* in the src directory
@ -100,6 +99,8 @@ Just running *kak* launch a new kak session with a client on local terminal.
the session name to be specified with -s. In this mode, the Kakoune the session name to be specified with -s. In this mode, the Kakoune
server will keep running even if there is no connected client, and server will keep running even if there is no connected client, and
will quit when receiving SIGTERM. will quit when receiving SIGTERM.
* +-p <session>+: read stdin, and then send its content to the given session
this way kak act as a remote control.
At startup, if +-n+ is not specified, Kakoune will try to source the file At startup, if +-n+ is not specified, Kakoune will try to source the file
../share/kak/kakrc relative to the kak binary. This kak file will then try ../share/kak/kakrc relative to the kak binary. This kak file will then try

4
doc/interfacing.asciidoc
View File

@ -28,7 +28,7 @@ For example, we can echo a message in Kakoune in 10 seconds with:
:nop %sh{ ( :nop %sh{ (
sleep 10 sleep 10
echo "eval -client '$kak_client' 'echo sleep ended'" | echo "eval -client '$kak_client' 'echo sleep ended'" |
socat stdin UNIX-CONNECT:/tmp/kak-${kak_session} kak -p ${kak_session}
) >& /dev/null < /dev/null & } ) >& /dev/null < /dev/null & }
---- ----
@ -118,6 +118,6 @@ nop %sh{ ( # launch a detached shell
completions="$line.$column@$kak_timestamp:$candidates" completions="$line.$column@$kak_timestamp:$candidates"
# write to Kakoune socket for the buffer that triggered the completion # write to Kakoune socket for the buffer that triggered the completion
echo "set buffer=${kak_bufname} completions '$completions'" | echo "set buffer=${kak_bufname} completions '$completions'" |
socat stdin UNIX-SOCKET:/tmp/kak-${kak_session} kak -p ${kak_session}
) >& /dev/null < /dev/null & } ) >& /dev/null < /dev/null & }
----- -----