mawww/kakoune
1
1
Fork 0
mirror of https://github.com/mawww/kakoune.git synced 2024-12-25 12:36:11 +03:00
Code Issues Projects Releases Wiki Activity

Wrap long lines

Browse Source
This commit is contained in:
Frank LENORMAND 2016-02-03 17:04:20 +02:00
parent b6e930a57d
commit 6951f3f2d9
1 changed files with 24 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/kakoune.1.txt
View File

@ -11,18 +11,21 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
Kakoune is a code editor heavily inspired by Vim, as such most of its commands are similar to Vi's ones, and it
shares Vi's "keystrokes as a text editing language" model.
Kakoune is a code editor heavily inspired by Vim, as such most of its commands are similar to Vi's ones, and it shares Vi's "keystrokes as a text editing language" model. Kakoune can operate in two modes, normal and insertion. In insertion mode, keys are directly inserted into the
current buffer. In normal mode, keys are used to manipulate the current selection and to enter insertion mode.
Kakoune can operate in two modes, normal and insertion. In insertion mode, keys are directly inserted into the current buffer. In normal mode, keys are used to manipulate the current selection and to enter insertion mode. Kakoune has a strong focus on interactivity, most commands provide immediate and incremental results, while still
being competitive (as in keystroke count) with Vim.
Kakoune has a strong focus on interactivity, most commands provide immediate and incremental results, while still being competitive (as in keystroke count) with Vim. Kakoune works on selections, which are oriented, inclusive range of characters, selections have an anchor and
a cursor character. Most commands move both of them, except when extending selection where the anchor character
Kakoune works on selections, which are oriented, inclusive range of characters, selections have an anchor and a cursor character. Most commands move both of them, except when extending selection where the anchor character stays fixed and the cursor one moves around. stays fixed and the cursor one moves around.
OPTIONS OPTIONS
------- -------
-q:: -q::
in filter mode, be quiet about errors applying keys in filter mode, be quiet about errors applying keys
@ -56,16 +59,18 @@ OPTIONS
file:: file::
one or more files to edit one or more files to edit
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 recursively source any files in At startup, if -n is not specified, Kakoune will try to source the file '../share/kak/kakrc' relative to the
*$XDG_CONFIG_HOME*'/kak/autoload' (with *$XDG_CONFIG_HOME* defaulting to *$HOME*'/.config', and falling back to '../share/kak/autoload' if that autoload directory does not exist), and finally kak binary. This kak file will then try to recursively source any files in *$XDG_CONFIG_HOME*'/kak/autoload'
*$XDG_CONFIG_HOME*'/kak/kakrc'. (with *$XDG_CONFIG_HOME* defaulting to *$HOME*'/.config', and falling back to '../share/kak/autoload' if that
autoload directory does not exist), and finally *$XDG_CONFIG_HOME*'/kak/kakrc'.
That leads to the following behaviour: by default, with no user autoload directory, the system wide autoload directory is used, once the user wants control on autoloading, they can That leads to the following behaviour: by default, with no user autoload directory, the system wide autoload
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. 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.
EXAMPLES EXAMPLES
-------- --------
kak /path/to/file:: kak /path/to/file::
Edit a file Edit a file
@ -80,11 +85,13 @@ kak -e "man dup2"::
FILES FILES
----- -----
If not started with the -n switch, Kakoune will source the '../share/kak/kakrc' file relative to the kak binary,
which will source additional files:
If not started with the -n switch, Kakoune will source the '../share/kak/kakrc' file relative to the kak binary, which will source additional files: * if the *$XDG_CONFIG_HOME*'/kak/autoload' directory exists, load every '*.kak' files in it, and load
recursively any subdirectory
* if the *$XDG_CONFIG_HOME*'/kak/autoload' directory exists, load every '*.kak' files in it, and load recursively any subdirectory
* if it does not exists, fall back to the system wide autoload directory in '../share/kak/autoload' * if it does not exists, fall back to the system wide autoload directory in '../share/kak/autoload'
After that, if it exists, source the *$XDG_CONFIG_HOME*'/kak/kakrc' file which should be used for user configuration. After that, if it exists, source the *$XDG_CONFIG_HOME*'/kak/kakrc' file which should be used for user
In order to continue autoloading site-wide files with a local autoload directory, just add a symbolic link to '../share/kak/autoload' into your local autoload directory. configuration. In order to continue autoloading site-wide files with a local autoload directory, just add a symbolic
link to '../share/kak/autoload' into your local autoload directory.