Document installation

This commit is contained in:
Maxime Coste 2013-12-23 21:41:42 +00:00
parent fa72d27f9a
commit c8d3e1d32a

View File

@ -31,6 +31,24 @@ 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 src directory, this will setup an initial $XDG_CONFIG_HOME/kak directory. See
the _Kakrc_ section for more information. the _Kakrc_ section for more information.
Installing
----------
In order to install kak on your system, rather than running it directly from
it's source directory, type *make install*, you can specify the +PREFIX+ and
+DESTDIR+ if needed.
Note that by default, no script files will be read if you do not add links
to them in $XDG_CONFIG_HOME/kak/autoload. Available script files will be
installed in $PREFIX/share/kak/rc
If you want to enable all files, set $XDG_CONFIG_HOME/kak/autoload to be
a symbolic link to the $PREFIX/share/kak/rc directory.
----------------------------------------------
ln -s /usr/share/kak/rc ~/.config/kak/autoload
----------------------------------------------
Running Running
------- -------
@ -48,6 +66,14 @@ Just running *kak* launch a new kak session with a client on local terminal.
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.
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
to source $XDG_CONFIG_HOME/kak/kakrc (with $XDG_CONFIG_HOME defaulting to
$HOME/.config), and any files in $XDG_CONFIG_HOME/kak/autoload.
The common pattern is to add links to $XDG_CONFIG_HOME/kak/autoload to the
scripts in $PREFIX/share/kak/rc that the user wants sourced at kak launch.
Basic Movement Basic Movement
-------------- --------------