mawww/kakoune

 * Multiple selections as a central way of interacting
 * Powerful selection manipulation primitives
   - Select all regex matches in current selections
   - Keep selections containing/not containing a match for a given regex
   - Split current selections with a regex
   - Text objects (paragraph, sentence, nestable blocks)
 * Powerful text manipulation primitives
   - Align selections
   - Rotate selection contents
   - Case manipulation
   - Indentation
   - Piping each selection to external filter
 * Client-Server architecture
   - Multiple clients on the same editing session
   - Use tmux, zellij, kitty, wezterm or your X11/Wayland window manager to
     manage splits/panes by spawning clients connected to the same session
 * Simple interaction with external programs
 * Automatic contextual help
 * Automatic as you type completion
 * Macros
 * Hooks
 * Syntax Highlighting
   - Supports multiple languages in the same buffer
   - Highlight a buffer differently in different windows

Screenshots

Kakoune's dependencies are:

 * A {cpp}20 compliant compiler (GCC >= 10.3 or clang >= 11) along with its
   associated {cpp} standard library (libstdc{pp} >= 10 or libc{pp})

To build, just type *make* in the root directory.
To generate man pages, type *make man* in the root directory.

Kakoune can be built on Linux, MacOS, and Cygwin. Due to Kakoune relying heavily
on being in a Unix-like environment, no native Windows version is planned.

Installing

Running *kak* launches a new kak session with a client on local terminal.
Run *kak -help* to discover the valid command line flags.

Configuration
^^^^^^^^^^^^^

There are two directories containing Kakoune's scripts:

* `runtime`: located in `../share/kak/` relative to the `kak` binary
  contains the system scripts, installed with Kakoune.
* `userconf`: located in `$XDG_CONFIG_HOME/kak/`, which will fallback
  to `$HOME/.config/kak/` if `$XDG_CONFIG_HOME` is not set, containing
  the user configuration.

Unless `-n` is specified, Kakoune will load its startup script located
at `${runtime}/kakrc` relative to the `kak` binary. This startup script
is responsible for loading the user configuration.

First, Kakoune will search recursively for `.kak` files in the `autoload`
directory. It will first look for an `autoload` directory at
`${userconf}/autoload` and will fallback to `${runtime}/autoload` if
it does not exist.

Once all those files are loaded, Kakoune will try to source
`${runtime}/kakrc.local`, which is expected to contain distribution provided
configuration.

Finally, the user configuration will load from `${userconf}/kakrc`.

NOTE: If you create a user `autoload` directory in `${userconf}/autoload`,
the system one at `${runtime}/autoload` will not load anymore. You can
add a symbolic link to it (or to individual scripts) inside
`${userconf}/autoload` to keep loading system scripts.

Basic Interaction
-----------------

Selections

In normal mode, keys are not inserted directly inside the buffer, but are editing
commands. These commands provide ways to manipulate either the selections themselves
or the selected text.

Insert Mode

See <<Appending>> below for instructions on extending (appending to) the current selection in order to select more text.

 * `h`: select the character on the left of selection end
 * `j`: select the character below the selection end
 * `k`: select the character above the selection end
 * `l`: select the character on the right of selection end

 * `w`: select the word and following whitespaces on the right of selection end
 * `b`: select preceding whitespaces and the word on the left of selection end
 * `e`: select preceding whitespaces and the word on the right of selection end
 * `<a-[wbe]>`: same as [wbe], but select WORD instead of word

 * `f`: select to (including) the next occurrence of the given character
 * `t`: select until (excluding) the next occurrence of the given character
 * `<a-[ft]>`: same as [ft] but in the other direction

 * `m`: select to matching character
 * `M`: extend selection to matching character

 * `x`: expand selections to contain full lines (including end-of-lines)
 * `<a-x>`: trim selections to only contain full lines (including
            end-of-lines)

 * `%`: select whole buffer

 * `<a-h>`: select to line begin
 * `<a-l>`: select to line end

 * `/`: search (select next match)
 * `<a-/>`: search (select previous match)
 * `?`: search (extend to next match)
 * `<a-?>`: search (extend to previous match)
 * `n`: select next match
 * `N`: add a new selection with next match
 * `<a-n>`: select previous match
 * `<a-N>`: add a new selection with previous match

 * `pageup, <c-b>`: scroll one page up
 * `pagedown, <c-f>`: scroll one page down
 * `<c-u>`: scroll half a page up
 * `<c-d>`: scroll half a page down

 * `)`: rotate selections (the main selection becomes the next one)
 * `(`: rotate selections backwards

 * `;`: reduce selections to their cursor
 * `<a-;>`: flip the selections' direction
 * `<a-:>`: ensure selections are in forward direction (cursor after anchor)

 * `<a-.>`: repeat last object or `f`/`t` selection command.

 * `_`: trim selections

A word is a sequence of alphanumeric characters or underscore, a WORD is a
sequence of non whitespace characters.

Appending

Most selection commands also support counts, which are entered before the
command itself.

For example, `3W` selects 3 consecutive words and `3w` select the third word on
the right of selection end.

Disabling Hooks

 * `i`: enter insert mode before each selection
 * `a`: enter insert mode after each selection
 * `d`: yank and delete each selection
 * `c`: yank and delete each selection and enter insert mode
 * `.`: repeat last insert mode change (`i`, `a`, or `c`, including
        the inserted text)

 * `<a-d>`: delete each selection
 * `<a-c>`: delete each selection and enter insert mode

 * `I`: enter insert mode at each selection begin line start
 * `A`: enter insert mode at each selection end line end
 * `o`: enter insert mode in one (or given count) new lines below
        each selection end
 * `O`: enter insert mode in one (or given count)  new lines above
        each selection begin

 * `<a-o>`: add an empty line below each cursor
 * `<a-O>`: add an empty line above each cursor

 * `y`: yank selections
 * `p`: paste after each selection end
 * `P`: paste before each selection begin
 * `<a-p>`: paste all after each selection end
 * `<a-P>`: paste all before each selection begin
 * `R`: replace each selection with yanked text
 * `<a-R>`: replace each selection with every yanked text

 * `r`: replace each character with the next entered one

 * `<a-j>`: join selected lines
 * `<a-J>`: join selected lines and select spaces inserted
            in place of line breaks
 * `<a-_>`: merge contiguous selections together (works across lines as well)

 * `<gt> (>)`: indent selected lines
 * `<a-gt>`: indent selected lines, including empty lines
 * `<lt> (<)`: deindent selected lines
 * `<a-lt>`: deindent selected lines, do not remove incomplete
        indent (3 leading spaces when indent is 4)

 * `|`: pipe each selection through the given external filter program
        and replace the selection with its output.
 * `<a-|>`: pipe each selection through the given external filter program
        and ignore its output

 * `!`: insert command output before each selection
 * `<a-!>`: append command output after each selection

 * `u`: undo last change
 * `<c-k>`: move backward in history
 * `<a-u>`: undo selection changes
 * `U`: redo last change
 * `<c-j>`: move forward in history
 * `<a-U>`: redo selection changes

 * `&`: align selections, align the cursor of selections by inserting
        spaces before the first character of the selection
 * `<a-&>`: copy indent, copy the indentation of the main selection
        (or the count one if a count is given) to all other ones

 * ```: to lower case
 * `~`: to upper case
 * ``<a-`>``: swap case

 * `@`: convert selected tabs to spaces, uses the buffer tabstop option or
        the count parameter for tabstop.
 * `<a-@>`: convert selected spaces to tabs, uses the buffer tabstop option
            or the count parameter for tabstop.

 * `<a-)>`: rotate selections content, if specified, the count groups
            selections, so `3<a-)>` rotate (1, 2, 3) and (4, 5, 6)
            independently.
 * `<a-(>`: rotate selections content backwards

Goto Commands

Commands beginning with `v` permit to center or scroll the current
view. Using `V` will lock view mode until `<esc>` is hit

See <<doc/pages/keys#view-commands,`:doc keys view-commands`>>.

Marks
~~~~~

Current selections position can be saved in a register and restored later on.

See <<doc/pages/keys#marks,`:doc keys marks`>>.

Jump list
~~~~~~~~~

Some commands, like the goto commands, buffer switch or search commands,
push the previous selections to the client's jump list.

See <<doc/pages/keys#jump-list,`:doc keys jump-list`>>.

Multi Selection

Objects are specific portions of text, like sentences, paragraphs, numbers…
Kakoune offers many keys allowing you to select various text objects.

See <<doc/pages/keys#object-selection,`:doc keys object-selection`>>.

Commands
--------

When pressing `:` in normal mode, Kakoune will open a prompt to enter a command.

Commands are used for non editing tasks, such as opening a buffer, writing the
current one, quitting, etc.

See <<doc/pages/keys#prompt-commands,`:doc keys prompt-commands`>>.

Basic Commands
~~~~~~~~~~~~~~

Some commands take an exclamation mark (`!`), which can be used to force
the execution of the command (i.e. to quit a modified buffer, the
command `q!` has to be used).

Commands starting with horizontal whitespace (e.g. a space) will not be
saved in the command history.

 * `cd [<directory>]`: change the current directory to `<directory>`, or the home directory if unspecified
 * `doc <topic>`: display documentation about a topic. The completion list
     displays the available topics.
 * `e[dit][!] <filename> [<line> [<column>]]`: open buffer on file, go to given
     line and column. If file is already opened, just switch to this file.
     Use edit! to force reloading.
 * `w[rite][!] [<filename>]`: write buffer to <filename> or use its name if
     filename is not given. If the file is write-protected, its
     permissions are temporarily changed to allow saving the buffer and
     restored afterwards when the write! command is used.
 * `w[rite]a[ll]`: write all buffers that are associated to a file.
 * `q[uit][!] [<exit status>]`: exit Kakoune, use quit! to force quitting even
     if there is some unsaved buffers remaining. If specified, the client exit
     status will be set to <exit status>.
 * `w[a]q[!] [<exit status>]`: write the current buffer (or all buffers when
     `waq` is used) and quit. If specified, the client exit status will be set
     to <exit status>.
 * `kill[!]`: terminate the current session, all the clients as well as the server,
     use kill! to ignore unsaved buffers
 * `b[uffer] <name>`: switch to buffer <name>
 * `b[uffer]n[ext]`: switch to the next buffer
 * `b[uffer]p[rev]`: switch to the previous buffer
 * `d[el]b[uf][!] [<name>]`: delete the buffer <name>
 * `source <filename>`: execute commands in <filename>
 * `colorscheme <name>`: load named colorscheme.
 * `rename-client <name>`: set current client name
 * `rename-buffer <name>`: set current buffer name
 * `rename-session <name>`: set current session name
 * `echo [options] <text>`: show <text> in status line, with the following options:
   ** `-markup`: expand the markup strings in <text>
   ** `-debug`: print the given text to the `\*debug*` buffer
 * `nop`: does nothing, but as with every other commands, arguments may be
     evaluated. So nop can be used for example to execute a shell command
     while being sure that its output will not be interpreted by kak.
     `:%sh{ echo echo tchou }` will echo tchou in Kakoune, whereas
     `:nop %sh{ echo echo tchou }` will not, but both will execute the
     shell command.
 * `fail <text>`: raise an error, uses <text> as its description

Multiple commands

If not launched 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 it does not exist, falls back to the site 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.

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.

Color Schemes

Faces describe how characters are displayed on the screen: color, bold, italic...

See <<doc/pages/faces#,`:doc faces`>>.

Registers

Kakoune can record and replay a sequence of key presses.

See <<doc/pages/keys#macros,`:doc keys macros`>>.

Search selection

Kakoune regex syntax is based on the ECMAScript syntax (ECMA-262 standard).
It always runs on Unicode codepoint sequences, not on bytes.

See <<doc/pages/regex#,`:doc regex`>>.

Exec and Eval

Kakoune can propose completions while inserting text: filenames, words, lines…

See <<doc/pages/keys#insert-mode-completion,`:doc keys insert-mode-completion`>>.

Escape to normal mode
~~~~~~~~~~~~~~~~~~~~~

From insert mode, pressing `<a-;>` allows you to execute a single normal mode
command. This provides a few advantages:

 * The selections are not modified: when leaving insert mode using `<esc>` the
   selections can change, for example when insert mode was entered with `a` the
   cursor will go back one char. Or if on an end of line the cursor will go back
   left (if possible).

 * The modes are nested: that means the normal mode can enter prompt (with `:`),
   or any other modes (using `:on-key` or `:menu` for example), and these modes
   will get back to the insert mode afterwards.

This feature is tailored for scripting/macros, as it provides a more predictable
behaviour than leaving insert mode with `<esc>`, executing normal mode command
and entering back insert mode (with which binding ?)

See <<doc/pages/modes#,`:doc modes`>>.

Highlighters
~~~~~~~~~~~~

Manipulation of the displayed text, such as syntax coloration and wrapping
is done through highlighters.

See <<doc/pages/highlighters#,`:doc highlighters`>>.

Hooks
~~~~~

Commands can be registered to be executed when certain events arise with hooks.

See <<doc/pages/hooks#,`:doc hooks`>>.

Key Mapping
~~~~~~~~~~~

Custom key shortcuts can be registered through mappings.

See <<doc/pages/mapping#,`:doc mapping`>>.

Defining Commands and Aliases

FIFO buffers are very useful for running some commands asynchronously while
progressively displaying their result in Kakoune.

See <<doc/pages/buffers#fifo-buffers,`:doc buffers fifo-buffers`>>.

Credits
-------

Thanks to https://github.com/p0nce[p0nce] for designing the
https://github.com/mawww/kakoune/blob/master/doc/kakoune_logo.svg[Kakoune
logo].

And thanks to all the
https://github.com/mawww/kakoune/graphs/contributors[contributors] who help
move the project forward!