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

Improve autoload behaviour documentation in README.asciidoc

Browse Source 
Fixes #554
This commit is contained in:
Maxime Coste 2016-01-13 10:40:15 +00:00
parent 1c418be498
commit 1e8ea9e5bd
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.asciidoc
View File

@ -198,11 +198,16 @@ Just running *kak* launch a new kak session with a client on local terminal.
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
to source any files in `$XDG_CONFIG_HOME/kak/autoload` (with `$XDG_CONFIG_HOME` to recursively source any files in `$XDG_CONFIG_HOME/kak/autoload` (with
defaulting to `$HOME/.config`), and finally `$XDG_CONFIG_HOME/kak/kakrc`. `$XDG_CONFIG_HOME` defaulting to `$HOME/.config`, and falling back to
`../share/kak/autoload/` if that autoload directory does not exists),
and finally `$XDG_CONFIG_HOME/kak/kakrc`.
The common pattern is to add links to `$XDG_CONFIG_HOME/kak/autoload` to the That leads to the following behaviour: by default, with no user autoload
scripts in `$PREFIX/share/kak/rc` that the user wants sourced at kak launch. directory, the system wide autoload directory is used, once the user wants
control on autoloading, they can create an autoload directory and eventually
symlink individual scripts, or the whole system wide autoload directory. They
can as well add any new scripts not provided with Kakoune.
Basic Interaction Basic Interaction
----------------- -----------------
@ -229,7 +234,7 @@ Insert Mode
~~~~~~~~~~~ ~~~~~~~~~~~
When entering insert mode, keys are now directly inserted before each selections When entering insert mode, keys are now directly inserted before each selections
cursor. Some additional keys are recognized in insert mode: cursor. Some additional keys are recognised in insert mode:
* `<esc>`: leave insert mode * `<esc>`: leave insert mode
* `<backspace>`: delete characters before cursors * `<backspace>`: delete characters before cursors
@ -248,7 +253,7 @@ cursor. Some additional keys are recognized in insert mode:
* `<c-r>`: insert contents of the register given by next key * `<c-r>`: insert contents of the register given by next key
* `<c-v>`: insert next keystroke directly into the buffer, * `<c-v>`: insert next keystroke directly into the buffer,
without interpretting it. without interpreting it.
* `<c-u>`: commit changes up to now as a single undo group. * `<c-u>`: commit changes up to now as a single undo group.