From 4fc598cd48af95b66bf3b3351b39b5a348ccc58d Mon Sep 17 00:00:00 2001 From: Maxime Coste Date: Mon, 7 Jan 2013 14:25:19 +0100 Subject: [PATCH] README: add info on command line switches and update env vars docs --- README.asciidoc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.asciidoc b/README.asciidoc index 0f8d2095..41e14813 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -29,6 +29,17 @@ To setup a basic configuration on your account, type *make userconfig* in the src directory, this will setup an initial $XDG_CONFIG_HOME/kak directory. See the _Kakrc_ section for more information. +Running +------- + +Just running *kak* launch a new kak session with a client on local terminal. +*kak* accepts some switches: + + * +-c +: connect to given session (which is the pid of the + initial kak process), sessions are unix sockets +/tmp/kak-+ + * +-e +: execute commands on startup + * +-n+: ignore kakrc file + Basic Movement -------------- @@ -328,6 +339,8 @@ Some of kakoune state is available through environment variables: * +kak_runtime+: directory containing the kak binary * +kak_opt_name+: value of option name * +kak_reg_x+: value of register x + * +kak_socket+: filename of session socket (/tmp/kak-) + * +kak_client+: name of current client for example you can print informations on the current file in the status line using: