You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: doc/kakoune.1.txt
+24-17
Original file line number
Diff line number
Diff line change
@@ -11,18 +11,21 @@ SYNOPSIS
11
11
12
12
DESCRIPTION
13
13
-----------
14
+
Kakoune is a code editor heavily inspired by Vim, as such most of its commands are similar to Vi's ones, and it
15
+
shares Vi's "keystrokes as a text editing language" model.
14
16
15
-
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.
17
+
Kakoune can operate in two modes, normal and insertion. In insertion mode, keys are directly inserted into the
18
+
current buffer. In normal mode, keys are used to manipulate the current selection and to enter insertion mode.
16
19
17
-
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.
20
+
Kakoune has a strong focus on interactivity, most commands provide immediate and incremental results, while still
21
+
being competitive (as in keystroke count) with Vim.
18
22
19
-
Kakoune has a strong focus on interactivity, most commands provide immediate and incremental results, while still being competitive (as in keystroke count) with Vim.
20
-
21
-
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.
23
+
Kakoune works on selections, which are oriented, inclusive range of characters, selections have an anchor and
24
+
a cursor character. Most commands move both of them, except when extending selection where the anchor character
25
+
stays fixed and the cursor one moves around.
22
26
23
27
OPTIONS
24
28
-------
25
-
26
29
-q::
27
30
in filter mode, be quiet about errors applying keys
28
31
@@ -56,16 +59,18 @@ OPTIONS
56
59
file::
57
60
one or more files to edit
58
61
59
-
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
60
-
*$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
61
-
*$XDG_CONFIG_HOME*'/kak/kakrc'.
62
+
At startup, if -n is not specified, Kakoune will try to source the file '../share/kak/kakrc' relative to the
63
+
kak binary. This kak file will then try to recursively source any files in *$XDG_CONFIG_HOME*'/kak/autoload'
64
+
(with *$XDG_CONFIG_HOME* defaulting to *$HOME*'/.config', and falling back to '../share/kak/autoload' if that
65
+
autoload directory does not exist), and finally *$XDG_CONFIG_HOME*'/kak/kakrc'.
62
66
63
-
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
64
-
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.
67
+
That leads to the following behaviour: by default, with no user autoload directory, the system wide autoload
68
+
directory is used, once the user wants control on autoloading, they can create an autoload directory and eventually
69
+
symlink individual scripts, or the whole system wide autoload directory. They can as well add any new scripts not
70
+
provided with Kakoune.
65
71
66
72
EXAMPLES
67
73
--------
68
-
69
74
kak /path/to/file::
70
75
Edit a file
71
76
@@ -80,11 +85,13 @@ kak -e "man dup2"::
80
85
81
86
FILES
82
87
-----
88
+
If not started with the -n switch, Kakoune will source the '../share/kak/kakrc' file relative to the kak binary,
89
+
which will source additional files:
83
90
84
-
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:
85
-
86
-
* if the *$XDG_CONFIG_HOME*'/kak/autoload' directory exists, load every '*.kak' files in it, and load recursively any subdirectory
91
+
* if the *$XDG_CONFIG_HOME*'/kak/autoload' directory exists, load every '*.kak' files in it, and load
92
+
recursively any subdirectory
87
93
* if it does not exists, fall back to the system wide autoload directory in '../share/kak/autoload'
88
94
89
-
After that, if it exists, source the *$XDG_CONFIG_HOME*'/kak/kakrc' file which should be used for user configuration.
90
-
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.
95
+
After that, if it exists, source the *$XDG_CONFIG_HOME*'/kak/kakrc' file which should be used for user
96
+
configuration. In order to continue autoloading site-wide files with a local autoload directory, just add a symbolic
97
+
link to '../share/kak/autoload' into your local autoload directory.
0 commit comments