2017-03-08 07:51:34 +01:00
|
|
|
= image:{logo}[K,30,30,link="{website}"] Kakoune image:{travis-img}[link="{travis-url}"] image:{irc-img}[link="{irc-url}"]
|
2017-11-01 12:49:13 +01:00
|
|
|
ifdef::env-github,env-browser[:outfilesuffix: .asciidoc]
|
2015-03-31 20:21:31 +02:00
|
|
|
:logo: https://rawgit.com/mawww/kakoune/master/doc/kakoune_logo.svg
|
2015-10-18 13:42:52 +02:00
|
|
|
:website: http://kakoune.org
|
2015-05-18 14:47:44 +02:00
|
|
|
:travis-img: https://travis-ci.org/mawww/kakoune.svg?branch=master
|
2015-03-31 20:21:31 +02:00
|
|
|
:travis-url: https://travis-ci.org/mawww/kakoune
|
2017-03-08 07:51:34 +01:00
|
|
|
:irc-img: https://img.shields.io/badge/IRC-%23kakoune-blue.svg
|
|
|
|
:irc-url: https://webchat.freenode.net/?channels=kakoune
|
2015-04-03 19:42:12 +02:00
|
|
|
:icons: font
|
|
|
|
:toc: right
|
2017-01-19 22:52:42 +01:00
|
|
|
:pp: ++
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2014-07-30 20:14:37 +02:00
|
|
|
TL;DR
|
|
|
|
-----
|
|
|
|
|
2015-10-18 13:42:52 +02:00
|
|
|
{website}
|
|
|
|
|
2017-12-27 08:13:11 +01:00
|
|
|
*Modal editor* -- *Faster as in fewer keystrokes* --
|
2014-10-06 21:23:56 +02:00
|
|
|
*Multiple selections* -- *Orthogonal design*
|
|
|
|
|
2014-07-31 01:08:00 +02:00
|
|
|
---------------------------------------------
|
2014-07-30 20:14:37 +02:00
|
|
|
git clone http://github.com/mawww/kakoune.git
|
|
|
|
cd kakoune/src
|
|
|
|
make
|
|
|
|
./kak
|
2014-07-31 01:08:00 +02:00
|
|
|
---------------------------------------------
|
2014-07-30 20:14:37 +02:00
|
|
|
|
2015-01-23 20:14:12 +01:00
|
|
|
See http://github.com/mawww/golf for kakoune solutions to vimgolf challenges,
|
2017-12-27 08:13:11 +01:00
|
|
|
regularly beating the best Vim solution.
|
2015-01-23 20:14:12 +01:00
|
|
|
|
2015-06-12 14:38:53 +02:00
|
|
|
See the link:doc/design.asciidoc[design document] for more information on
|
|
|
|
Kakoune philosophy and design.
|
|
|
|
|
2015-03-31 20:21:31 +02:00
|
|
|
:numbered:
|
|
|
|
|
|
|
|
Introduction
|
|
|
|
------------
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2017-12-27 08:13:11 +01:00
|
|
|
Kakoune is a code editor that implements Vi's "keystrokes as a text editing
|
|
|
|
language" model. As it's also a modal editor, it is somewhat similar to the
|
|
|
|
Vim editor (after which Kakoune was originally inspired).
|
2011-11-04 10:09:27 +01:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2014-01-28 14:53:44 +01:00
|
|
|
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.
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
See http://vimeo.com/82711574
|
2013-12-26 12:59:30 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
Join us on freenode IRC `#Kakoune`
|
2014-01-03 21:17:33 +01:00
|
|
|
|
2013-12-31 20:40:09 +01:00
|
|
|
Features
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~
|
2013-12-31 20:40:09 +01:00
|
|
|
|
2014-03-23 21:35:11 +01:00
|
|
|
* Multiple selections as a central way of interacting
|
2013-12-31 20:40:09 +01:00
|
|
|
* Powerful selection manipulation primitives
|
|
|
|
- Select all regex matches in current selections
|
2014-01-28 14:53:44 +01:00
|
|
|
- Keep selections containing/not containing a match for a given regex
|
2013-12-31 20:40:09 +01:00
|
|
|
- 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
|
2014-05-12 20:02:15 +02:00
|
|
|
* Client-Server architecture
|
|
|
|
- Multiple clients on the same editing session
|
|
|
|
- Use tmux or your X11 window manager to manage windows
|
2013-12-31 20:40:09 +01:00
|
|
|
* Simple interaction with external programs
|
2014-01-28 14:53:44 +01:00
|
|
|
* Automatic contextual help
|
|
|
|
* Automatic as you type completion
|
2013-12-31 20:40:09 +01:00
|
|
|
* Macros
|
|
|
|
* Hooks
|
|
|
|
* Syntax Highlighting
|
2014-06-16 02:18:11 +02:00
|
|
|
- Supports multiple languages in the same buffer
|
|
|
|
- Highlight a buffer differently in different windows
|
2013-12-31 20:40:09 +01:00
|
|
|
|
2015-05-07 01:34:50 +02:00
|
|
|
Screenshots
|
2015-05-07 01:36:32 +02:00
|
|
|
~~~~~~~~~~~
|
2015-05-07 01:34:50 +02:00
|
|
|
|
2015-06-04 08:52:46 +02:00
|
|
|
[[screenshot-i3]]
|
2015-05-07 01:34:50 +02:00
|
|
|
.Kakoune in i3
|
|
|
|
image::doc/screenshot-i3.gif[Kakoune in i3]
|
|
|
|
|
|
|
|
[[screenshot-tmux]]
|
|
|
|
.Kakoune in tmux
|
|
|
|
image::doc/screenshot-tmux.gif[Kakoune in tmux]
|
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
Getting started
|
|
|
|
---------------
|
|
|
|
|
2011-11-04 15:05:05 +01:00
|
|
|
Building
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~
|
2011-11-04 15:05:05 +01:00
|
|
|
|
|
|
|
Kakoune dependencies are:
|
2011-11-04 15:28:29 +01:00
|
|
|
|
2017-10-21 07:13:41 +02:00
|
|
|
* A {cpp}14 compliant compiler (GCC >= 5 or clang >= 3.9) along with its
|
2017-01-19 22:52:42 +01:00
|
|
|
associated {cpp} standard library (libstdc{pp} or libc{pp})
|
2015-11-01 14:03:19 +01:00
|
|
|
* ncurses with wide-characters support (>= 5.3, generally referred to as libncursesw)
|
2016-02-04 15:46:23 +01:00
|
|
|
* asciidoc (for the `a2k` tool), to generate man pages
|
2011-11-04 15:05:05 +01:00
|
|
|
|
2016-12-20 04:17:32 +01:00
|
|
|
To build, just type *make* in the src directory.
|
2017-11-29 23:04:22 +01:00
|
|
|
To generate man pages, type *make man* in the src directory.
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2013-12-31 20:40:09 +01:00
|
|
|
Kakoune can be built on Linux, MacOS, and Cygwin. Due to Kakoune relying heavily
|
2015-06-04 08:52:46 +02:00
|
|
|
on being in a Unix-like environment, no native Windows version is planned.
|
2013-12-31 20:40:09 +01:00
|
|
|
|
2013-12-23 22:41:42 +01:00
|
|
|
Installing
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~
|
2013-12-23 22:41:42 +01:00
|
|
|
|
|
|
|
In order to install kak on your system, rather than running it directly from
|
2015-06-04 08:52:46 +02:00
|
|
|
its source directory, type *make install*, you can specify the `PREFIX` and
|
2015-04-03 19:58:26 +02:00
|
|
|
`DESTDIR` if needed.
|
2013-12-23 22:41:42 +01:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
[TIP]
|
2018-05-26 11:52:37 +02:00
|
|
|
.Homebrew (macOS) or Linuxbrew
|
2015-04-03 19:42:12 +02:00
|
|
|
====
|
2016-12-15 00:47:32 +01:00
|
|
|
---------------------------------
|
2018-05-23 15:35:47 +02:00
|
|
|
brew install kakoune
|
2016-12-15 00:47:32 +01:00
|
|
|
---------------------------------
|
2015-04-03 19:42:12 +02:00
|
|
|
====
|
2015-03-24 14:56:16 +01:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
[TIP]
|
2017-11-13 17:06:53 +01:00
|
|
|
.Fedora supported versions and Rawhide
|
2015-04-03 19:42:12 +02:00
|
|
|
====
|
2016-12-15 23:12:28 +01:00
|
|
|
Use the https://copr.fedoraproject.org/coprs/jkonecny/kakoune/[copr]
|
|
|
|
repository.
|
2015-03-31 16:29:50 +02:00
|
|
|
|
2015-03-24 21:13:27 +01:00
|
|
|
---------------------------------
|
|
|
|
dnf copr enable jkonecny/kakoune
|
|
|
|
dnf install kakoune
|
|
|
|
---------------------------------
|
2015-04-03 19:42:12 +02:00
|
|
|
====
|
2015-03-24 21:13:27 +01:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
[TIP]
|
|
|
|
.Arch Linux
|
|
|
|
====
|
2018-05-25 19:10:17 +02:00
|
|
|
Kakoune is found in the https://www.archlinux.org/packages/community/x86_64/kakoune/[repositories].
|
2016-12-15 23:12:28 +01:00
|
|
|
--------------------------------------------------
|
2018-05-25 19:10:17 +02:00
|
|
|
pacman -S kakoune
|
2016-12-15 23:12:28 +01:00
|
|
|
--------------------------------------------------
|
2015-04-03 19:42:12 +02:00
|
|
|
====
|
2015-03-30 20:13:04 +02:00
|
|
|
|
2016-05-11 00:08:56 +02:00
|
|
|
[TIP]
|
|
|
|
.Gentoo
|
|
|
|
====
|
|
|
|
Kakoune is found in portage as
|
|
|
|
https://packages.gentoo.org/packages/app-editors/kakoune[app-editors/kakoune]
|
|
|
|
====
|
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
[TIP]
|
|
|
|
.Exherbo
|
|
|
|
====
|
2015-03-25 14:46:41 +01:00
|
|
|
--------------------------------
|
|
|
|
cave resolve -x repository/mawww
|
|
|
|
cave resolve -x kakoune
|
|
|
|
--------------------------------
|
2015-04-03 19:42:12 +02:00
|
|
|
====
|
2015-03-25 14:46:41 +01:00
|
|
|
|
2015-11-13 16:40:00 +01:00
|
|
|
[TIP]
|
|
|
|
.openSUSE
|
|
|
|
====
|
2016-12-15 23:12:28 +01:00
|
|
|
kakoune can be found in the
|
|
|
|
https://build.opensuse.org/package/show/editors/kakoune[editors] devel
|
|
|
|
project. Make sure to adjust the link below to point to the repository of
|
|
|
|
your openSUSE version.
|
2015-11-13 16:40:00 +01:00
|
|
|
|
2016-12-15 23:12:28 +01:00
|
|
|
---------------------------------------------------------------------------------------------------
|
2015-11-13 16:40:00 +01:00
|
|
|
#Example for Tumbleweed:
|
|
|
|
sudo zypper addrepo http://download.opensuse.org/repositories/editors/openSUSE_Factory/editors.repo
|
|
|
|
sudo zypper refresh
|
|
|
|
sudo zypper install kakoune
|
2016-12-15 23:12:28 +01:00
|
|
|
---------------------------------------------------------------------------------------------------
|
2015-11-13 16:40:00 +01:00
|
|
|
====
|
|
|
|
|
2017-08-28 22:20:46 +02:00
|
|
|
[TIP]
|
|
|
|
.Ubuntu
|
|
|
|
====
|
|
|
|
Building on Ubuntu 16.04.
|
|
|
|
Make sure you have .local/bin in your path to make the kak binary available from your shell.
|
|
|
|
|
2017-11-01 07:15:11 +01:00
|
|
|
----------------------------------------------------------------
|
|
|
|
sudo apt install libncursesw5-dev asciidoc
|
2017-08-28 22:20:46 +02:00
|
|
|
git clone https://github.com/mawww/kakoune.git && cd kakoune/src
|
|
|
|
make
|
|
|
|
PREFIX=$HOME/.local make install
|
2017-11-01 07:15:11 +01:00
|
|
|
----------------------------------------------------------------
|
2017-08-28 22:20:46 +02:00
|
|
|
====
|
|
|
|
|
2018-04-13 13:16:34 +02:00
|
|
|
[TIP]
|
|
|
|
.FreeBSD
|
|
|
|
====
|
|
|
|
Kakoune is available in the official ports tree as
|
|
|
|
https://www.freshports.org/editors/kakoune[editors/kakoune].
|
|
|
|
|
|
|
|
A binary package is also available and can be installed with
|
|
|
|
--------------------------------------------------
|
|
|
|
pkg install kakoune
|
|
|
|
--------------------------------------------------
|
|
|
|
====
|
|
|
|
|
2018-08-11 00:10:19 +02:00
|
|
|
[TIP]
|
|
|
|
.Solus
|
|
|
|
====
|
|
|
|
Kakoune is available in the Solus stable repository.
|
|
|
|
|
|
|
|
It can be installed with
|
|
|
|
---------------------
|
|
|
|
eopkg install kakoune
|
|
|
|
---------------------
|
2018-09-12 16:58:41 +02:00
|
|
|
====
|
|
|
|
|
|
|
|
[TIP]
|
|
|
|
.Void
|
|
|
|
====
|
|
|
|
Kakoune is available in the repositories.
|
|
|
|
|
|
|
|
It can be installed with
|
|
|
|
---------------------
|
|
|
|
xbps-install -S kakoune
|
|
|
|
---------------------
|
|
|
|
====
|
|
|
|
|
|
|
|
[TIP]
|
|
|
|
.Termux
|
|
|
|
====
|
|
|
|
Kakoune is available in the repositories.
|
|
|
|
|
|
|
|
It can be installed with
|
|
|
|
---------------------
|
|
|
|
pkg install kakoune
|
|
|
|
---------------------
|
2018-08-11 00:10:19 +02:00
|
|
|
====
|
|
|
|
|
2013-01-07 14:25:19 +01:00
|
|
|
Running
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~
|
2013-01-07 14:25:19 +01:00
|
|
|
|
|
|
|
Just running *kak* launch a new kak session with a client on local terminal.
|
2017-11-18 17:33:13 +01:00
|
|
|
Run *kak -help* to discover the valid <<doc/kak.1#options,command line flags>>.
|
2013-01-07 14:25:19 +01:00
|
|
|
|
2017-01-05 12:28:22 +01:00
|
|
|
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.
|
2018-09-01 08:17:58 +02:00
|
|
|
* `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.
|
2017-01-05 12:28:22 +01:00
|
|
|
|
2017-01-05 20:30:38 +01:00
|
|
|
Unless `-n` is specified, Kakoune will load its startup script located
|
2017-01-05 12:28:22 +01:00
|
|
|
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
|
2017-04-21 12:32:47 +02:00
|
|
|
it does not exist.
|
2017-01-05 12:28:22 +01:00
|
|
|
|
|
|
|
Once all those files are loaded, Kakoune will try to source
|
|
|
|
`${runtime}/kakrc.local` which is expected to contain distribution provided
|
|
|
|
configuration.
|
|
|
|
|
|
|
|
And finally, the user configuration will be loaded from `${userconf}/kakrc`.
|
|
|
|
|
|
|
|
NOTE: If you create a user `autoload` directory in `${userconf}/autoload`,
|
|
|
|
the system one at `${runtime}/autoload` will not be loaded anymore. You can
|
|
|
|
add a symbolic link to it (or to individual scripts) inside
|
|
|
|
`${userconf}/autoload` to keep loading system scripts.
|
2013-12-23 22:41:42 +01:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
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
|
2017-04-21 12:32:47 +02:00
|
|
|
commands. These commands provide ways to manipulate either the selections themselves,
|
2015-04-03 19:42:12 +02:00
|
|
|
or the selected text.
|
|
|
|
|
|
|
|
Insert Mode
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
When entering insert mode, keys are now directly inserted before each
|
|
|
|
selection's cursor. Some additional keys are recognised in insert mode:
|
2015-11-15 14:25:02 +01:00
|
|
|
|
|
|
|
* `<esc>`: leave insert mode
|
|
|
|
* `<backspace>`: delete characters before cursors
|
|
|
|
* `<del>`: delete characters under cursors
|
|
|
|
* `<left>, <right>, <up>, <down>`: move the cursors in given direction
|
|
|
|
* `<home>`: move cursors to line begin
|
|
|
|
* `<end>`: move cursors to end of line
|
|
|
|
|
|
|
|
* `<c-n>`: select next completion candidate
|
|
|
|
* `<c-p>`: select previous completion candidate
|
|
|
|
* `<c-x>`: explicit insert completion query, followed by:
|
|
|
|
- `f`: explicit file completion
|
|
|
|
- `w`: explicit word completion
|
|
|
|
- `l`: explicit line completion
|
|
|
|
* `<c-o>`: disable automatic completion for this insert session
|
|
|
|
|
|
|
|
* `<c-r>`: insert contents of the register given by next key
|
|
|
|
* `<c-v>`: insert next keystroke directly into the buffer,
|
2016-01-13 11:40:15 +01:00
|
|
|
without interpreting it.
|
2015-11-15 14:25:02 +01:00
|
|
|
|
|
|
|
* `<c-u>`: commit changes up to now as a single undo group.
|
|
|
|
|
|
|
|
* `<a-;>`: escape to normal mode for a single command
|
2015-04-03 19:42:12 +02:00
|
|
|
|
|
|
|
Movement
|
|
|
|
~~~~~~~~
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2015-06-04 08:52:46 +02:00
|
|
|
* `h`: select the character on the left of selection end
|
2015-04-03 19:58:26 +02:00
|
|
|
* `j`: select the character below the selection end
|
|
|
|
* `k`: select the character above the selection end
|
2015-06-04 08:52:46 +02:00
|
|
|
* `l`: select the character on the right of selection end
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `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
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-[wbe]>`: same as [wbe] but select WORD instead of word
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2016-02-02 21:15:47 +01:00
|
|
|
* `f`: select to the next occurence of given character
|
|
|
|
* `t`: select until the next occurence of given character
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-[ft]>`: same as [ft] but in the other direction
|
2016-02-02 21:15:47 +01:00
|
|
|
|
2015-07-15 20:03:53 +02:00
|
|
|
* `m`: select to matching character
|
|
|
|
* `M`: extend selection to matching character
|
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `x`: select line on which selection end lies (or next line when end lies on
|
2011-11-22 15:32:05 +01:00
|
|
|
an end-of-line)
|
2017-04-25 10:39:50 +02:00
|
|
|
* `X`: similar to `x`, except the current selection is extended
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-x>`: expand selections to contain full lines (including end-of-lines)
|
|
|
|
* `<a-X>`: trim selections to only contain full lines (not including last
|
2013-04-16 14:30:11 +02:00
|
|
|
end-of-line)
|
2011-11-22 15:32:05 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `%`: select whole buffer
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-h>`: select to line begin
|
|
|
|
* `<a-l>`: select to line end
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `/`: search (select next match)
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-/>`: search (select previous match)
|
2015-04-03 19:58:26 +02:00
|
|
|
* `?`: search (extend to next match)
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-?>`: search (extend to previous match)
|
2015-04-03 19:58:26 +02:00
|
|
|
* `n`: select next match
|
|
|
|
* `N`: add a new selection with next match
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-n>`: select previous match
|
|
|
|
* `<a-N>`: add a new selection with previous match
|
2013-01-03 14:01:48 +01:00
|
|
|
|
2017-10-04 12:47:56 +02:00
|
|
|
* `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
|
2012-10-16 18:53:05 +02:00
|
|
|
|
2018-03-29 14:18:16 +02:00
|
|
|
* `)`: rotate selections (the main selection becomes the next one)
|
|
|
|
* `(`: rotate selections backwards
|
2013-10-02 20:10:31 +02:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `;`: reduce selections to their cursor
|
2017-04-21 12:32:47 +02:00
|
|
|
* `<a-;>`: flip the selections' direction
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-:>`: ensure selections are in forward direction (cursor after anchor)
|
2014-07-05 13:01:12 +02:00
|
|
|
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-.>`: repeat last object or `f`/`t` selection command.
|
2016-12-14 21:45:15 +01:00
|
|
|
|
2018-03-29 14:18:16 +02:00
|
|
|
* `_`: trim selections
|
2014-07-05 13:01:12 +02:00
|
|
|
|
2014-03-23 21:35:11 +01:00
|
|
|
A word is a sequence of alphanumeric characters or underscore, a WORD is a
|
|
|
|
sequence of non whitespace characters.
|
|
|
|
|
2011-11-04 10:09:27 +01:00
|
|
|
Appending
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
for most selection commands, using shift permits extending current selection
|
2015-04-03 19:58:26 +02:00
|
|
|
instead of replacing it. for example, `wWW` selects 3 consecutive words
|
2011-11-04 10:09:27 +01:00
|
|
|
|
|
|
|
Using Counts
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~~
|
2011-11-04 10:09:27 +01:00
|
|
|
|
|
|
|
Most selection commands also support counts, which are entered before the
|
|
|
|
command itself.
|
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
For example, `3W` selects 3 consecutive words and `3w` select the third word on
|
2011-11-04 10:09:27 +01:00
|
|
|
the right of selection end.
|
|
|
|
|
2017-02-19 14:18:00 +01:00
|
|
|
Disabling Hooks
|
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Any normal mode command can be prefixed with `\` which will disable hook execution
|
|
|
|
for the duration for the command (including the duration of modes the command could
|
|
|
|
move to, so `\i` will disable hooks for the whole insert session).
|
|
|
|
|
|
|
|
As autoindentation is implemented in terms of hooks, this can be used to disable
|
|
|
|
it when pasting text.
|
|
|
|
|
2011-11-04 10:09:27 +01:00
|
|
|
Changes
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `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
|
2014-05-05 19:09:16 +02:00
|
|
|
the inserted text)
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2017-07-11 06:49:29 +02:00
|
|
|
* `<a-d>`: delete current selection
|
|
|
|
* `<a-c>`: delete current selection and enter insert mode
|
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `I`: enter insert mode at current selection begin line start
|
|
|
|
* `A`: enter insert mode at current selection end line end
|
2016-10-24 20:41:05 +02:00
|
|
|
* `o`: enter insert mode in one (or given count) new lines below
|
|
|
|
current selection end
|
|
|
|
* `O`: enter insert mode in one (or given count) new lines above
|
|
|
|
current selection begin
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2017-07-10 11:55:19 +02:00
|
|
|
* `<a-o>`: add an empty line below cursor
|
|
|
|
* `<a-O>`: add an empty line above cursor
|
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `y`: yank selections
|
|
|
|
* `p`: paste after current selection end
|
|
|
|
* `P`: paste before current selection begin
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-p>`: paste all after current selection end, and
|
2014-07-03 01:25:39 +02:00
|
|
|
select each pasted string.
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-P>`: paste all before current selection begin, and
|
2014-07-03 01:25:39 +02:00
|
|
|
select each pasted string.
|
2015-04-03 19:58:26 +02:00
|
|
|
* `R`: replace current selection with yanked text
|
2017-07-09 12:00:28 +02:00
|
|
|
* `<a-R>`: replace current selection with every yanked text
|
2014-07-03 01:25:39 +02:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `r`: replace each character with the next entered one
|
2011-11-04 10:09:27 +01:00
|
|
|
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-j>`: join selected lines
|
|
|
|
* `<a-J>`: join selected lines and select spaces inserted
|
2013-04-23 18:54:31 +02:00
|
|
|
in place of line breaks
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-m>`: merge contiguous selections together (works across lines as well)
|
2011-11-22 15:32:05 +01:00
|
|
|
|
2016-12-27 19:50:55 +01:00
|
|
|
* `<gt> (>)`: indent selected lines
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-gt>`: indent selected lines, including empty lines
|
2016-12-27 19:50:55 +01:00
|
|
|
* `<lt> (<)`: deindent selected lines
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-lt>`: deindent selected lines, do not remove incomplete
|
2013-11-14 01:20:49 +01:00
|
|
|
indent (3 leading spaces when indent is 4)
|
2013-01-03 14:01:48 +01:00
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
* `|`: pipe each selection through the given external filter program
|
2013-12-24 17:48:52 +01:00
|
|
|
and replace the selection with it's output.
|
2017-04-21 12:32:47 +02:00
|
|
|
* `<a-|>`: pipe each selection through the given external filter program
|
2014-12-13 14:17:05 +01:00
|
|
|
and ignore its output
|
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `!`: insert command output before selection
|
2017-05-31 19:22:01 +02:00
|
|
|
* `<a-!>`: append command output after selection
|
2011-12-28 20:09:54 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `u`: undo last change
|
2017-05-31 19:22:01 +02:00
|
|
|
* `<a-u>`: move backward in history
|
2015-04-03 19:58:26 +02:00
|
|
|
* `U`: redo last change
|
2017-05-31 19:22:01 +02:00
|
|
|
* `<a-U>`: move forward in history
|
2013-01-03 14:01:48 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `&`: align selection, align the cursor of selections by inserting
|
2014-01-28 14:53:44 +01:00
|
|
|
spaces before the first character of the selection
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-&>`: copy indent, copy the indentation of the main selection
|
2014-01-28 14:53:44 +01:00
|
|
|
(or the count one if a count is given) to all other ones
|
|
|
|
|
2015-04-13 14:03:43 +02:00
|
|
|
* ```: to lower case
|
2015-04-03 19:58:26 +02:00
|
|
|
* `~`: to upper case
|
2017-11-29 23:04:22 +01:00
|
|
|
* ``<a-`>``: swap case
|
2013-05-15 18:47:58 +02:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
* `@`: convert tabs to spaces in current selections, uses the buffer
|
2014-03-02 02:04:26 +01:00
|
|
|
tabstop option or the count parameter for tabstop.
|
2016-12-27 07:56:06 +01:00
|
|
|
* `<a-@>`: convert spaces to tabs in current selections, uses the buffer
|
2014-03-02 02:04:26 +01:00
|
|
|
tabstop option or the count parameter for tabstop.
|
|
|
|
|
2018-03-29 14:18:16 +02:00
|
|
|
* `<a-)>`: rotate selections content, if specified, the count groups
|
2017-02-01 21:54:29 +01:00
|
|
|
selections, so `3<a-">` rotate (1, 2, 3) and (3, 4, 6)
|
2014-03-27 00:42:10 +01:00
|
|
|
independently.
|
2018-03-29 14:18:16 +02:00
|
|
|
* `<a-(>`: rotate selections content backwards
|
2013-10-02 20:10:31 +02:00
|
|
|
|
2013-04-11 21:15:54 +02:00
|
|
|
Goto Commands
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~~~
|
2013-04-11 21:15:54 +02:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Commands beginning with `g` are used to goto certain position and or buffer.
|
2015-06-25 20:41:07 +02:00
|
|
|
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.
|
|
|
|
|
2017-11-08 15:59:03 +01:00
|
|
|
See <<doc/pages/keys#goto-commands,`:doc keys goto-commands`>>.
|
2017-11-07 09:37:16 +01:00
|
|
|
|
2013-04-16 13:54:04 +02:00
|
|
|
View commands
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~~~
|
2013-04-11 21:15:54 +02:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Commands beginning with `v` permit to center or scroll the current
|
|
|
|
view. Using `V` will lock view mode until `<esc>` is hit
|
2013-04-11 21:15:54 +02:00
|
|
|
|
2017-11-08 15:59:03 +01:00
|
|
|
See <<doc/pages/keys#view-commands,`:doc keys view-commands`>>.
|
2015-11-05 14:39:29 +01:00
|
|
|
|
2015-06-25 15:00:50 +02:00
|
|
|
Marks
|
|
|
|
~~~~~
|
|
|
|
|
|
|
|
Current selections position can be saved in a register and restored later on.
|
2015-08-19 22:16:26 +02:00
|
|
|
|
2017-11-10 18:06:38 +01:00
|
|
|
See <<doc/pages/keys#marks,`:doc keys marks`>>.
|
2015-06-25 15:00:50 +02:00
|
|
|
|
2013-10-02 19:48:50 +02:00
|
|
|
Jump list
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~
|
2013-10-02 19:48:50 +02:00
|
|
|
|
|
|
|
Some commands, like the goto commands, buffer switch or search commands,
|
2017-11-10 18:06:38 +01:00
|
|
|
push the previous selections to the client's jump list.
|
2013-10-02 19:48:50 +02:00
|
|
|
|
2017-11-10 18:06:38 +01:00
|
|
|
See <<doc/pages/keys#jump-list,`:doc keys jump-list`>>.
|
2013-10-02 19:48:50 +02:00
|
|
|
|
2011-11-16 15:15:40 +01:00
|
|
|
Multi Selection
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~~~~~
|
2011-11-16 15:15:40 +01:00
|
|
|
|
|
|
|
Kak was designed from the start to handle multiple selections.
|
2015-04-03 19:58:26 +02:00
|
|
|
One way to get a multiselection is via the `s` key.
|
2011-11-16 15:15:40 +01:00
|
|
|
|
2016-03-05 19:21:29 +01:00
|
|
|
For example, to change all occurrences of word 'roger' to word 'marcel'
|
2011-11-16 15:15:40 +01:00
|
|
|
in a paragraph, here is what can be done:
|
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
* 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<esc> to replace rogers with marcels
|
2011-11-16 15:15:40 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
A multiselection can also be obtained with `S`, which splits the current
|
2011-11-21 20:35:02 +01:00
|
|
|
selection according to the regex entered. To split a comma separated list,
|
2015-04-03 19:58:26 +02:00
|
|
|
use `S` then ', *'
|
2013-02-22 18:37:34 +01:00
|
|
|
|
2018-07-31 16:58:07 +02:00
|
|
|
The regex syntax supported by Kakoune is the based on the ECMAScript script
|
|
|
|
syntax and is described at <<doc/pages/regex#,`:doc regex`>>.
|
2016-02-22 22:22:05 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
`s` and `S` share the search pattern with `/`, and hence entering an empty
|
2013-02-22 18:37:34 +01:00
|
|
|
pattern uses the last one.
|
|
|
|
|
2016-12-27 07:56:06 +01:00
|
|
|
As a convenience, `<a-s>` allows you to split the current selections on
|
2013-02-22 18:37:34 +01:00
|
|
|
line boundaries.
|
2011-11-21 20:35:02 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
To clear multiple selections, use `space`. To keep only the nth selection
|
2016-12-27 07:56:06 +01:00
|
|
|
use `n` followed by `space`, in order to remove a selection, use `<a-space>`.
|
2012-01-25 22:26:41 +01:00
|
|
|
|
2016-12-27 07:56:06 +01:00
|
|
|
`<a-k>` allows you to enter a regex and keep only the selections that
|
2017-04-21 12:32:47 +02:00
|
|
|
contains a match for this regex. Using `<a-K>` you can keep the selections
|
2013-04-03 19:05:57 +02:00
|
|
|
not containing a match.
|
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
`C` copies the current selection to the next line (or lines if a count is given)
|
2016-12-27 07:56:06 +01:00
|
|
|
`<a-C>` does the same to previous lines.
|
2015-02-05 22:25:04 +01:00
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
`$` allows you to enter a shell command and pipe each selection to it.
|
2014-05-05 19:00:24 +02:00
|
|
|
Selections whose shell command returns 0 will be kept, other will be dropped.
|
|
|
|
|
2012-05-29 13:32:29 +02:00
|
|
|
Object Selection
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~~~~~~
|
2012-05-29 13:32:29 +02:00
|
|
|
|
2017-11-10 18:06:38 +01:00
|
|
|
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`>>.
|
2013-10-08 20:38:10 +02:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
Commands
|
|
|
|
--------
|
2013-11-14 14:59:32 +01:00
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
When pressing `:` in normal mode, Kakoune will open a prompt to enter a command.
|
2013-02-19 19:04:09 +01:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
Commands are used for non editing tasks, such as opening a buffer, writing the
|
2015-11-15 14:25:02 +01:00
|
|
|
current one, quitting, etc.
|
|
|
|
|
2017-11-10 18:06:38 +01:00
|
|
|
See <<doc/pages/keys#prompt-commands,`:doc keys prompt-commands`>>.
|
2013-04-02 18:46:33 +02:00
|
|
|
|
2012-08-08 00:11:36 +02:00
|
|
|
Basic Commands
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~~~~
|
2012-08-08 00:11:36 +02:00
|
|
|
|
2016-04-08 18:00:24 +02:00
|
|
|
Some commands take an exclamation mark (`!`), which can be used to force
|
2016-03-12 10:13:49 +01:00
|
|
|
the execution of the command (i.e. to quit a modified buffer, the
|
|
|
|
command `q!` has to be used).
|
|
|
|
|
2017-11-10 18:06:38 +01:00
|
|
|
Commands starting with horizontal whitespace (e.g. a space) will not be
|
|
|
|
saved in the command history.
|
|
|
|
|
2017-10-03 23:00:08 +02:00
|
|
|
* `cd [<directory>]`: change the current directory to `<directory>`, or the home directory if unspecified
|
2016-12-13 19:11:45 +01:00
|
|
|
* `doc <topic>`: display documentation about a topic. The completion list
|
|
|
|
displays the available topics.
|
2016-03-12 10:13:49 +01:00
|
|
|
* `e[dit][!] <filename> [<line> [<column>]]`: open buffer on file, go to given
|
2012-08-08 00:11:36 +02:00
|
|
|
line and column. If file is already opened, just switch to this file.
|
2017-04-21 12:32:47 +02:00
|
|
|
Use edit! to force reloading.
|
|
|
|
* `w[rite][!] [<filename>]`: write buffer to <filename> or use its name if
|
2017-04-19 17:47:07 +02:00
|
|
|
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.
|
2015-04-03 19:58:26 +02:00
|
|
|
* `w[rite]a[ll]`: write all buffers that are associated to a file.
|
2017-08-23 08:22:23 +02:00
|
|
|
* `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>.
|
2016-04-29 22:58:04 +02:00
|
|
|
* `kill[!]`: terminate the current session, all the clients as well as the server,
|
|
|
|
use kill! to ignore unsaved buffers
|
2015-04-03 19:58:26 +02:00
|
|
|
* `b[uffer] <name>`: switch to buffer <name>
|
2016-03-12 10:13:49 +01:00
|
|
|
* `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>
|
2015-04-03 19:58:26 +02:00
|
|
|
* `source <filename>`: execute commands in <filename>
|
2015-07-03 22:14:08 +02:00
|
|
|
* `colorscheme <name>`: load named colorscheme.
|
2016-12-15 19:39:05 +01:00
|
|
|
* `rename-client <name>`: set current client name
|
|
|
|
* `rename-buffer <name>`: set current buffer name
|
|
|
|
* `rename-session <name>`: set current session name
|
2016-03-12 10:13:49 +01:00
|
|
|
* `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
|
2015-04-03 19:58:26 +02:00
|
|
|
* `nop`: does nothing, but as with every other commands, arguments may be
|
2016-03-12 10:13:49 +01:00
|
|
|
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.
|
2017-10-17 04:02:11 +02:00
|
|
|
* `fail <text>`: raise an error, uses <text> as its description
|
2012-08-08 00:11:36 +02:00
|
|
|
|
2016-01-03 22:48:55 +01:00
|
|
|
Multiple commands
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Multiple commands can be separated either by new lines or by semicolons,
|
|
|
|
as such a semicolon must be escaped with `\;` to be considered as a literal
|
|
|
|
semicolon argument.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
String syntax and expansions
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2012-08-08 00:11:36 +02:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Values, options and shell context can be interpolated in strings.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/expansions#,`:doc expansions`>>.
|
2015-09-20 18:40:06 +02:00
|
|
|
|
2015-07-17 16:54:07 +02:00
|
|
|
Configuration & Autoloading
|
|
|
|
---------------------------
|
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
Kakrc
|
2015-07-17 16:54:07 +02:00
|
|
|
~~~~~
|
2015-04-03 19:42:12 +02:00
|
|
|
|
2015-05-30 15:32:04 +02:00
|
|
|
If not launched with the `-n` switch, Kakoune will source the
|
2015-07-17 16:54:07 +02:00
|
|
|
`../share/kak/kakrc` file relative to the `kak` binary, which
|
|
|
|
will source additional files:
|
2015-05-30 15:32:04 +02:00
|
|
|
|
|
|
|
If the `$XDG_CONFIG_HOME/kak/autoload` directory exists, load every
|
|
|
|
`*.kak` files in it, and load recursively any subdirectory.
|
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
If it does not exist, falls back to the site wide autoload directory
|
2015-05-30 15:32:04 +02:00
|
|
|
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.
|
2015-04-03 19:42:12 +02:00
|
|
|
|
2015-07-17 16:54:07 +02:00
|
|
|
Color Schemes
|
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
Kakoune ships with some color schemes that are installed to
|
|
|
|
`../share/kak/colors/`. If `$XDG_CONFIG_HOME/kak/colors/` is present
|
2016-03-05 19:21:29 +01:00
|
|
|
the builtin command `colorscheme` will offer completion for those
|
2017-04-21 12:32:47 +02:00
|
|
|
color schemes. If a scheme is duplicated in userspace, it will take
|
2015-07-17 16:54:07 +02:00
|
|
|
precedence.
|
|
|
|
|
2013-07-24 23:16:32 +02:00
|
|
|
Options
|
|
|
|
-------
|
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Kakoune can store named and typed values that can be used both to
|
|
|
|
customize the core editor behaviour, and to keep data used by extension
|
|
|
|
scripts.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/options#,`:doc options`>>.
|
2015-04-03 19:42:12 +02:00
|
|
|
|
|
|
|
|
|
|
|
Advanced topics
|
|
|
|
---------------
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
Faces
|
2017-11-05 23:06:32 +01:00
|
|
|
~~~~~
|
2015-08-11 14:44:07 +02:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Faces describe how characters are displayed on the screen: color, bold, italic...
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/faces#,`:doc faces`>>.
|
2015-11-10 21:30:27 +01:00
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
Registers
|
|
|
|
~~~~~~~~~
|
2015-11-10 21:30:27 +01:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Registers are named lists of text. They are used for various purposes,
|
|
|
|
like storing the last yanked text, or the captured groups associated with the selections.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/registers#,`:doc registers`>>.
|
2015-11-10 21:30:27 +01:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
Macros
|
|
|
|
~~~~~~
|
|
|
|
|
2015-06-04 08:52:46 +02:00
|
|
|
Kakoune can record and replay a sequence of key presses.
|
2015-04-03 19:42:12 +02:00
|
|
|
|
2017-11-10 18:06:38 +01:00
|
|
|
See <<doc/pages/keys#macros,`:doc keys macros`>>.
|
2015-04-03 19:42:12 +02:00
|
|
|
|
|
|
|
Search selection
|
|
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
|
2015-04-03 19:58:26 +02:00
|
|
|
Using the `*` key, you can set the search pattern to the current selection.
|
2017-11-10 18:06:38 +01:00
|
|
|
See <<doc/pages/keys#searching,`:doc keys searching`>>.
|
2015-04-03 19:42:12 +02:00
|
|
|
|
2016-02-22 22:22:05 +01:00
|
|
|
Regex syntax
|
|
|
|
~~~~~~~~~~~~
|
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Kakoune regex syntax is based on the ECMAScript syntax (ECMA-262 standard).
|
|
|
|
It always run on Unicode codepoint sequences, not on bytes.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/regex#,`:doc regex`>>.
|
2016-02-22 22:22:05 +01:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
Exec and Eval
|
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
The `execute-keys` and `evaluate-commands` are useful for scripting
|
|
|
|
in non interactive contexts.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/execeval#,`:doc execeval`>>.
|
2013-08-04 19:34:08 +02:00
|
|
|
|
2015-04-03 19:42:12 +02:00
|
|
|
Insert mode completion
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
2018-03-05 08:47:28 +01:00
|
|
|
Kakoune can propose completions while inserting text: filenames, words, lines…
|
|
|
|
|
|
|
|
See <<doc/pages/keys#insert-mode-completion,`:doc keys insert-mode-completion`>>.
|
2015-06-04 08:52:46 +02:00
|
|
|
|
2015-06-14 18:54:31 +02:00
|
|
|
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 `:`),
|
2017-01-31 23:48:24 +01:00
|
|
|
or any other modes (using `:on-key` or `:menu` for example), and these modes
|
2015-06-14 18:54:31 +02:00
|
|
|
will get back to the insert mode afterwards.
|
|
|
|
|
2016-03-05 19:21:29 +01:00
|
|
|
This feature is tailored for scripting/macros, as it provides a more predictable
|
2015-06-14 18:54:31 +02:00
|
|
|
behaviour than leaving insert mode with `<esc>`, executing normal mode command
|
|
|
|
and entering back insert mode (with which binding ?)
|
|
|
|
|
2018-02-23 14:31:28 +01:00
|
|
|
See <<doc/pages/modes#,`:doc modes`>>.
|
|
|
|
|
2011-11-29 23:37:20 +01:00
|
|
|
Highlighters
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~~
|
2011-11-08 15:30:10 +01:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Manipulation of the displayed text, such as syntax coloration and wrapping
|
|
|
|
is done through highlighters.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/highlighters#,`:doc highlighters`>>.
|
2013-12-03 23:20:33 +01:00
|
|
|
|
2011-11-26 20:19:08 +01:00
|
|
|
Hooks
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~
|
2011-11-26 20:19:08 +01:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Commands can be registered to be executed when certain events arise with hooks.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/hooks#,`:doc hooks`>>.
|
2013-03-20 19:10:16 +01:00
|
|
|
|
2013-10-26 01:51:19 +02:00
|
|
|
Key Mapping
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~
|
2013-10-26 01:51:19 +02:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
Custom key shortcuts can be registered through mappings.
|
|
|
|
|
2017-11-01 12:49:13 +01:00
|
|
|
See <<doc/pages/mapping#,`:doc mapping`>>.
|
2016-09-19 10:10:41 +02:00
|
|
|
|
2012-08-08 00:11:36 +02:00
|
|
|
Defining Commands
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~~~~~~~
|
2012-08-08 00:11:36 +02:00
|
|
|
|
2017-11-07 09:37:16 +01:00
|
|
|
New commands can be created using `:define-command`.
|
|
|
|
|
2017-11-08 15:59:03 +01:00
|
|
|
See <<doc/pages/commands#declaring-new-commands,`:doc commands declaring-new-commands`>>.
|
2017-11-07 09:37:16 +01:00
|
|
|
|
|
|
|
Some helper commands are available to define composite commands.
|
|
|
|
|
2017-11-08 15:59:03 +01:00
|
|
|
See <<doc/pages/commands#helpers,`:doc commands helpers`>>.
|
2012-09-11 13:54:43 +02:00
|
|
|
|
2014-10-30 00:22:54 +01:00
|
|
|
Aliases
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~
|
2014-10-30 00:22:54 +01:00
|
|
|
|
2015-06-04 08:52:46 +02:00
|
|
|
With `:alias` commands can be given additional names. Aliases are scoped, so
|
2014-10-30 00:22:54 +01:00
|
|
|
that an alias can refer to one command for a buffer, and to another for another
|
2017-04-21 12:32:47 +02:00
|
|
|
buffer. The following command defines `<alias>` as an alias for `<command>`:
|
2014-10-30 00:22:54 +01:00
|
|
|
|
|
|
|
--------------------------------
|
|
|
|
:alias <scope> <alias> <command>
|
|
|
|
--------------------------------
|
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
`<scope>` can be one of `global`, `buffer` or `window`.
|
2014-10-30 00:22:54 +01:00
|
|
|
|
|
|
|
-------------------------------------
|
|
|
|
:unalias <scope> <alias> [<expected>]
|
|
|
|
-------------------------------------
|
|
|
|
|
2017-04-21 12:32:47 +02:00
|
|
|
Will remove the given alias in the given scope. If `<expected>` is specified
|
2015-04-03 19:58:26 +02:00
|
|
|
the alias will only be removed if its current value is `<expected>`.
|
2014-10-30 00:22:54 +01:00
|
|
|
|
2017-11-10 19:50:54 +01:00
|
|
|
FIFO Buffers
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~~~~~~~
|
2012-09-11 13:54:43 +02:00
|
|
|
|
2017-11-10 19:50:54 +01:00
|
|
|
FIFO buffers are very useful for running some commands asynchronously while
|
|
|
|
progressively displaying their result in Kakoune.
|
2013-01-03 18:57:30 +01:00
|
|
|
|
2017-11-10 19:50:54 +01:00
|
|
|
See <<doc/pages/buffers#fifo-buffers,`:doc buffers fifo-buffers`>>.
|
2012-09-12 19:54:46 +02:00
|
|
|
|
2012-11-09 18:30:24 +01:00
|
|
|
Menus
|
2015-04-03 19:42:12 +02:00
|
|
|
~~~~~
|
2012-11-09 18:30:24 +01:00
|
|
|
|
2016-12-27 07:56:06 +01:00
|
|
|
When a menu is displayed, you can use `j`, `<c-n>` or `<tab>` to select the next
|
|
|
|
entry, and `k`, `<c-p>` or `<shift-tab>` to select the previous one.
|
2012-11-09 18:30:24 +01:00
|
|
|
|
2015-04-13 14:12:13 +02:00
|
|
|
Using the `/` key, you can enter some regex in order to restrict available choices
|
2012-11-09 18:30:24 +01:00
|
|
|
to the matching ones.
|