= image:{logo}[K,30,30] Kakoune image:{travis-img}[link="{travis-url}"] :logo: https://rawgit.com/mawww/kakoune/master/doc/kakoune_logo.svg :travis-img: https://travis-ci.org/mawww/kakoune.svg?branch=master :travis-url: https://travis-ci.org/mawww/kakoune :icons: font :toc: right TL;DR ----- *Vim inspired* -- *Faster as in less keystrokes* -- *Multiple selections* -- *Orthogonal design* --------------------------------------------- git clone http://github.com/mawww/kakoune.git cd kakoune/src make ./kak --------------------------------------------- See http://github.com/mawww/golf for kakoune solutions to vimgolf challenges, regularly beating the best vim solution. See the link:doc/design.asciidoc[design document] for more information on Kakoune philosophy and design. :numbered: Introduction ------------ Kakoune is a code editor heavily inspired by Vim, as such most of its commands are similar to vi's ones. 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 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. see http://vimeo.com/82711574 Join us on freenode IRC `#Kakoune` Features ~~~~~~~~ * 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 or your X11 window manager to manage windows * 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 ~~~~~~~~~~~ [[screenshot-i3]] .Kakoune in i3 image::doc/screenshot-i3.gif[Kakoune in i3] [[screenshot-tmux]] .Kakoune in tmux image::doc/screenshot-tmux.gif[Kakoune in tmux] Getting started --------------- Building ~~~~~~~~ Kakoune dependencies are: * A C++11 compliant compiler (GCC >= 4.8 or clang >= 3.4) * boost (>= 1.50) * ncurses with wide-characters support (>= 5.3, generally refered as libncursesw) To build, just type *make* in the src 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 ~~~~~~~~~~ In order to install kak on your system, rather than running it directly from its source directory, type *make install*, you can specify the `PREFIX` and `DESTDIR` if needed. [TIP] .Homebrew (OSX) ==== ----------------------------------------------------------------------------------------------- brew install --HEAD https://raw.githubusercontent.com/mawww/kakoune/master/contrib/kakoune.rb ----------------------------------------------------------------------------------------------- ==== [TIP] .Fedora 21/22/Rawhide & Epel 7 ==== Use the https://copr.fedoraproject.org/coprs/jkonecny/kakoune/[copr] repository. --------------------------------- dnf copr enable jkonecny/kakoune dnf install kakoune --------------------------------- ==== [TIP] .Arch Linux ==== A PKGBUILD https://aur.archlinux.org/packages/kakoune-git[kakoune-git] to install Kakoune is available in the https://wiki.archlinux.org/index.php/Arch_User_Repository[AUR]. -------------------------------- # For example build and install Kakoune via yaourt yaourt -Sy kakoune-git -------------------------------- ==== [TIP] .Exherbo ==== -------------------------------- cave resolve -x repository/mawww cave resolve -x kakoune -------------------------------- ==== Running ~~~~~~~ Just running *kak* launch a new kak session with a client on local terminal. *kak* accepts some switches: * `-c `: connect to given session, sessions are unix sockets `/tmp/kak-` * `-e `: execute commands on startup * `-n`: ignore kakrc file * `-s `: set the session name, by default it will be the pid of the initial kak process. * `-d`: run Kakoune in daemon mode, without user interface. This requires the session name to be specified with -s. In this mode, the Kakoune server will keep running even if there is no connected client, and will quit when receiving SIGTERM. * `-p `: read stdin, and then send its content to the given session acting as a remote control. * `-f `: Work as a filter, read every file given on the command line and stdin if piped in, and apply given keys on each. 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 any files in `$XDG_CONFIG_HOME/kak/autoload` (with `$XDG_CONFIG_HOME` defaulting to `$HOME/.config`), and finally `$XDG_CONFIG_HOME/kak/kakrc`. 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 Interaction ----------------- Selections ~~~~~~~~~~ The main concept in Kakoune is the selection. A selection is an inclusive, directed range of character. A selection has two ends, the anchor and the cursor. There is always at least one selection, and a selection is always at least one character (in which case the anchor and cursor of the selections are on the same character). Normal Mode ~~~~~~~~~~~ In normal mode, keys are not inserted directly inside the buffer, but are editing commands. These commands provides ways to manipulate either the selections themselves, or the selected text. Insert Mode ~~~~~~~~~~~ When entering insert mode, keys are now directly inserted before each selections cursor. A few additional keys are supported, like arrow keys to move around, however their use is not encouraged. You can go back to normal mode by pressing the `` key. Movement ~~~~~~~~ * `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 * `alt-[wbe]`: same as [wbe] but select WORD instead of word * `m`: select to matching character * `M`: extend selection to matching character * `x`: select line on which selection end lies (or next line when end lies on an end-of-line) * `alt-x`: expand selections to contain full lines (including end-of-lines) * `alt-X`: trim selections to only contain full lines (not including last end-of-line) * `%`: select whole buffer * `alt-h`: select to line begin * `alt-l`: select to line end * `/`: search (select next match) * `alt-/`: search (select previous match) * `?`: search (extend to next match) * `alt-?`: search (extend to previous match) * `n`: select next match * `N`: add a new selection with next match * `alt-n`: select previous match * `alt-N`: add a new selection with previous match * `pageup`: scroll up * `pagedown`: scroll down * `'`: rotate selections (the main selection becomes the next one) * `;`: reduce selections to their cursor * `alt-;`: flip the selections direction * `alt-:`: ensure selections are in forward direction (cursor after anchor) A word is a sequence of alphanumeric characters or underscore, a WORD is a sequence of non whitespace characters. Appending ~~~~~~~~~ for most selection commands, using shift permits to extend current selection instead of replacing it. for example, `wWW` selects 3 consecutive words Using Counts ~~~~~~~~~~~~ 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. Changes ~~~~~~~ * `i`: enter insert mode before current selection * `a`: enter insert mode after current selection * `d`: yank and delete current selection * `c`: yank and delete current selection and enter insert mode * `.`: repeat last insert mode change (`i`, `a`, or `c`, including the inserted text) * `I`: enter insert mode at current selection begin line start * `A`: enter insert mode at current selection end line end * `o`: enter insert mode in a new line below current selection end * `O`: enter insert mode in a new line above current selection begin * `y`: yank selections * `p`: paste after current selection end * `P`: paste before current selection begin * `alt-p`: paste all after current selection end, and select each pasted string. * `alt-P`: paste all before current selection begin, and select each pasted string. * `R`: replace current selection with yanked text * `r`: replace each character with the next entered one * `alt-j`: join selected lines * `alt-J`: join selected lines and select spaces inserted in place of line breaks * `>`: indent selected lines * `alt->`: indent selected lines, including empty lines * `<`: deindent selected lines * `alt-<`: deindent selected lines, do not remove incomplete indent (3 leading spaces when indent is 4) * `|`: pipe each selections through the given external filter program and replace the selection with it's output. * `alt-|`: pipe each selections through the given external filter program and ignore its output * `!`: insert command output before selection * `a-!`: append command output after selection * `u`: undo last change * `U`: redo last change * `&`: align selection, align the cursor of selections by inserting spaces before the first character of the selection * `alt-&`: 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 * `alt-``: swap case * `@`: convert tabs to spaces in current selections, uses the buffer tabstop option or the count parameter for tabstop. * `alt-@`: convert spaces to tabs in current selections, uses the buffer tabstop option or the count parameter for tabstop. * `alt-'`: rotate selections content, if specified, the count groups selections, so `3` rotate (1, 2, 3) and (3, 4, 6) independently. Goto Commands ~~~~~~~~~~~~~ Commands begining with g are used to goto certain position and or buffer: * `gh`: select to line begin * `gl`: select to line end * `gg`, `gk`: go to the first line * `gj`: go to the last line * `ge`: go to last char of last line * `gt`: go to the first displayed line * `gc`: go to the middle displayed line * `gb`: go to the last displayed line * `ga`: go to the previous (alternate) buffer * `gf`: open the file whose name is selected * `g.`: go to last buffer modifiction position If a count is given prior to hitting `g`, `g` will jump to the given line. Using `G` will extend the selection rather than jump. View commands ~~~~~~~~~~~~~ Some commands, all begining with v permit to manipulate the current view. * `vv` or `vc`: center the main selection in the window * `vt`: scroll to put the main selection on the top line of the window * `vb`: scroll to put the main selection on the bottom line of the window * `vh`: scroll the window count columns left * `vj`: scroll the window count line downward * `vk`: scroll the window count line upward * `vl`: scroll the window count columns right Marks ~~~~~ Current selections position can be saved in a register and restored later on. `^` followed by a register will save the current selections in that register, `alt-^` followed by a register will restore the selections saved in it. Jump list ~~~~~~~~~ Some commands, like the goto commands, buffer switch or search commands, push the previous selections to the client's jump list. It is possible to forward or backward in the jump list using: * `control-i`: Jump forward * `control-o`: Jump backward * `control-s`: save current selections Multi Selection ~~~~~~~~~~~~~~~ Kak was designed from the start to handle multiple selections. One way to get a multiselection is via the `s` key. For example, to change all occurences of word 'roger' to word 'marcel' in a paragraph, here is what can be done: select the paragraph with enough `x`. press `s` and enter roger, then enter. Now paragraph selection was replaced with multiselection of each roger in the paragraph. Press `c` and marcel to replace rogers with marcels. A multiselection can also be obtained with `S`, which splits the current selection according to the regex entered. To split a comma separated list, use `S` then ', *' `s` and `S` share the search pattern with `/`, and hence entering an empty pattern uses the last one. As a convenience, `alt-s` allows you to split the current selections on line boundaries. To clear multiple selections, use `space`. To keep only the nth selection use `n` followed by `space`, in order to remove a selection, use `alt-space`. `alt-k` allows you to enter a regex and keep only the selections that contains a match for this regex. using `alt-K` you can keep the selections not containing a match. `C` copies the current selection to the next line (or lines if a count is given) `alt-C` does the same to previous lines. `$` allows you to enter a shell command and pipe each selections to it. Selections whose shell command returns 0 will be kept, other will be dropped. Object Selection ~~~~~~~~~~~~~~~~ Some keys allow you to select a text object: * `alt-a`: selects the whole object * `alt-i`: selects the inner object, that is the object excluding it's surrounder. for example, for a quoted string, this will not select the quote, and for a word this will not select trailing spaces. * `[`: selects to object start * `]`: selects to object end * `{`: extends selections to object start * `}`: extends selections to object end After this key, you need to enter a second key in order to specify which object you want. * `b`, `(` or `)`: select the enclosing parenthesis * `B`, `{` or `}`: select the enclosing {} block * `r`, `[` or `]`: select the enclosing [] block * `a`, `<` or `>`: select the enclosing <> block * `"`: select the enclosing double quoted string * `'`: select the enclosing single quoted string * ```: select the enclosing grave quoted string * `w`: select the whole word * `W`: select the whole WORD * `s`: select the sentence * `p`: select the paragraph * `␣`: select the whitespaces * `i`: select the current indentation block * `n`: select the number For nestable objects, a count can be used in order to specify which surrounding level to select. 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. You can cycle through the command history with `` and ``. Commands starting with horizontal whitespace (e.g. a space) will not be saved in the command history. Basic Commands ~~~~~~~~~~~~~~ * `e[dit] [ []]`: 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] []`: write buffer to or use it's name if filename is not given. * `w[rite]a[ll]`: write all buffers that are associated to a file. * `q[uit]`: exit Kakoune, use quit! to force quitting even if there is some unsaved buffers remaining. * `wq`: write current buffer and quit * `b[uffer] `: switch to buffer * `d[el]b[uf] []`: delete the buffer , use d[el]b[uf]! to force deleting a modified buffer. * `source `: execute commands in * `runtime `: execute commands in , is relative to kak executable path. * `colorscheme `: load named colorscheme. * `nameclient `: set current client name * `namebuf `: set current buffer name * `echo `: show in status line * `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 it's 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. String syntax ~~~~~~~~~~~~~ When entering a command, parameters are separated by whitespace (shell like), if you want to give parameters with spaces, you should quote them. Kakoune support three string syntax: * `'strings'`: uninterpreted strings, you can use `\'` to escape the separator, every other char is itself. * `"strings"`: expanded strings, % strings (see <>) contained are expended. Use \% to escape a % inside them, and \\ to escape a slash. * `%{strings}`: these strings are very useful when entering commands - the `{` and `}` delimiters are configurable: you can use any non alphanumeric character. like `%[string]`, `%`, `%(string)`, `%\~string~` or `%!string!`... - if the character following the % is one of {[(<, then the closing one is the matching }])> and the delimiters are not escapable but are nestable. for example `%{ roger {}; }` is a valid string, `%{ marcel \}` as well. Expansions ^^^^^^^^^^ A special kind of `%{strings}` can be used, with a type between `%` and the opening delimiter (which cannot be alphanumeric). These strings are expanded according to their type. For example `%opt{autoinfo}` is of type 'opt'. opt expansions are replaced by the value of the given option (here `autoinfo`). Supported types are: * `sh`: shell expansion, similar to posix shell $(...) construct, see <> for more details. * `reg`: register expansion, will be replaced by the content of the given register. * `opt`: option expansion, will be replaced with the value of the given option * `val`: value expansion, gives access to the environment variable available to the Shell expansion. The `kak_` prefix is not used there. for example you can display last search pattern with ------------- :echo %reg{/} ------------- Shell expansion ^^^^^^^^^^^^^^^ The `%sh{...}` expansion replaces its content with the output of the shell commands in it. It is similar to the shell $(...) syntax and is evaluated only when needed. for example: `%sh{ ls }` is replaced with the output of the ls command. Some of Kakoune state is available through environment variables: * `kak_selection`: content of the main selection * `kak_selections`: content of the selection separated by colons, colons in the selection contents are escapted with a backslash. * `kak_bufname`: name of the current buffer * `kak_buflist`: the current buffer list, each buffer seperated by a colon * `kak_timestamp`: timestamp of the current buffer, the timestamp is an integer value which is incremented each time the buffer is modified. * `kak_runtime`: directory containing the kak binary * `kak_opt_`: value of option * `kak_reg_`: value of register * `kak_socket`: filename of session socket (/tmp/kak-) * `kak_client`: name of current client * `kak_cursor_line`: line of the end of the main selection * `kak_cursor_column`: column of the end of the main selection (in byte) * `kak_cursor_char_column`: column of the end of the main selection (in character) * `kak_hook_param`: filtering text passed to the currently executing hook Note that in order to make only needed information available, Kakoune needs to find the environment variable reference in the shell script executed. Hence `%sh{ ./script.sh }` with `script.sh` referencing an environment variable will not work. For example you can print informations on the current file in the status line using: ------------------------------- :echo %sh{ ls -l $kak_bufname } ------------------------------- Kakrc ----- If not launched with the `-n` switch, Kakoune will source the `../share/kak/kakrc` file (relative to the `kak` binary), which will in turn 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 exists, 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. Options ------- For user configuration, Kakoune supports options. Options are typed, their type can be * `int`: an integer number * `bool`: a boolean value, `yes/true` or `no/false` * `yesnoask`: similar to a boolean, but the additional value `ask` is supported. * `str`: a string, some freeform text * `coord`: a line,column pair (separated by comma) * `regex`: as a string but the `set` commands will complain if the entered text is not a valid regex. * `{int,str}-list`: a list, elements are separated by a colon (:) if an element needs to contain a colon, it can be escaped with a backslash. Options value can be changed using the `set` commands: ------------------------------------------------------------------------------ :set [global,buffer,window]