xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fix some issues in spelling, grammar and punctuation

Browse Source
This commit is contained in:
Frank LENORMAND 2017-04-21 13:32:47 +03:00
parent e722868c60
commit 41822f630c
13 changed files with 124 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

165
README.asciidoc
View File

@ -14,7 +14,7 @@ TL;DR
{website} {website}
*Vim inspired* -- *Faster as in less keystrokes* -- *Vim inspired* -- *Faster as in fewer keystrokes* --
*Multiple selections* -- *Orthogonal design* *Multiple selections* -- *Orthogonal design*
--------------------------------------------- ---------------------------------------------
@ -52,7 +52,7 @@ selections have an anchor and a cursor character. Most commands move both of
them, except when extending selection where the anchor character stays fixed them, except when extending selection where the anchor character stays fixed
and the cursor one moves around. and the cursor one moves around.
see http://vimeo.com/82711574 See http://vimeo.com/82711574
Join us on freenode IRC `#Kakoune` Join us on freenode IRC `#Kakoune`
@ -125,7 +125,7 @@ its source directory, type *make install*, you can specify the `PREFIX` and
.Homebrew (OSX) .Homebrew (OSX)
==== ====
NOTE: The ncurses library that comes with OSX is not new enough to support some NOTE: The ncurses library that comes with OSX is not new enough to support some
of the mouse based features of Kakoune (only tested on OSX 10.11.3, where the mouse based features of Kakoune (only tested on OSX 10.11.3, where the
packaged ncurses library is version 5.4, whereas the latest version is 6.0). packaged ncurses library is version 5.4, whereas the latest version is 6.0).
Currently, a fresh Kakoune install requires that you install ncurses 6.0. You Currently, a fresh Kakoune install requires that you install ncurses 6.0. You
can install ncurses 6.0 via Homebrew, can install ncurses 6.0 via Homebrew,
@ -244,7 +244,7 @@ Just running *kak* launch a new kak session with a client on local terminal.
- `json`: json-rpc based user interface that writes json on stdout and - `json`: json-rpc based user interface that writes json on stdout and
read keystrokes as json on stdin. read keystrokes as json on stdin.
* `-l`: list existing sessions, and check the dead ones * `-l`: list existing sessions, and check the dead ones
* `-clear`: clear dead sessions socket files * `-clear`: clear dead session's socket files
* `-ro`: prevent modifications to all buffers from being saved to disk * `-ro`: prevent modifications to all buffers from being saved to disk
* `+line[:column]`: specify a target line and column for the first file * `+line[:column]`: specify a target line and column for the first file
@ -266,7 +266,7 @@ is responsible for loading the user configuration.
First, Kakoune will search recursively for `.kak` files in the `autoload` First, Kakoune will search recursively for `.kak` files in the `autoload`
directory. It will first look for an `autoload` directory at directory. It will first look for an `autoload` directory at
`${userconf}/autoload` and will fallback to `${runtime}/autoload` if `${userconf}/autoload` and will fallback to `${runtime}/autoload` if
it does not exists. it does not exist.
Once all those files are loaded, Kakoune will try to source Once all those files are loaded, Kakoune will try to source
`${runtime}/kakrc.local` which is expected to contain distribution provided `${runtime}/kakrc.local` which is expected to contain distribution provided
@ -297,14 +297,14 @@ Normal Mode
~~~~~~~~~~~ ~~~~~~~~~~~
In normal mode, keys are not inserted directly inside the buffer, but are editing 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, commands. These commands provide ways to manipulate either the selections themselves,
or the selected text. or the selected text.
Insert Mode Insert Mode
~~~~~~~~~~~ ~~~~~~~~~~~
When entering insert mode, keys are now directly inserted before each selections When entering insert mode, keys are now directly inserted before each
cursor. Some additional keys are recognised in insert mode: selection's cursor. Some additional keys are recognised in insert mode:
* `<esc>`: leave insert mode * `<esc>`: leave insert mode
* `<backspace>`: delete characters before cursors * `<backspace>`: delete characters before cursors
@ -376,7 +376,7 @@ Movement
* `<a-'>`: rotate selections backwards * `<a-'>`: rotate selections backwards
* `;`: reduce selections to their cursor * `;`: reduce selections to their cursor
* `<a-;>`: flip the selections direction * `<a-;>`: flip the selections' direction
* `<a-:>`: ensure selections are in forward direction (cursor after anchor) * `<a-:>`: ensure selections are in forward direction (cursor after anchor)
* `<a-.>`: repeat last object or `f`/`t` selection command. * `<a-.>`: repeat last object or `f`/`t` selection command.
@ -388,7 +388,7 @@ sequence of non whitespace characters.
Appending Appending
~~~~~~~~~ ~~~~~~~~~
for most selection commands, using shift permits to extend current selection for most selection commands, using shift permits extending current selection
instead of replacing it. for example, `wWW` selects 3 consecutive words instead of replacing it. for example, `wWW` selects 3 consecutive words
Using Counts Using Counts
@ -397,7 +397,7 @@ Using Counts
Most selection commands also support counts, which are entered before the Most selection commands also support counts, which are entered before the
command itself. command itself.
for example, `3W` selects 3 consecutive words and `3w` select the third word on For example, `3W` selects 3 consecutive words and `3w` select the third word on
the right of selection end. the right of selection end.
Disabling Hooks Disabling Hooks
@ -449,9 +449,9 @@ Changes
* `<a-lt>`: deindent selected lines, do not remove incomplete * `<a-lt>`: deindent selected lines, do not remove incomplete
indent (3 leading spaces when indent is 4) indent (3 leading spaces when indent is 4)
* `|`: pipe each selections through the given external filter program * `|`: pipe each selection through the given external filter program
and replace the selection with it's output. and replace the selection with it's output.
* `<a-|>`: pipe each selections through the given external filter program * `<a-|>`: pipe each selection through the given external filter program
and ignore its output and ignore its output
* `!`: insert command output before selection * `!`: insert command output before selection
@ -553,15 +553,17 @@ One way to get a multiselection is via the `s` key.
For example, to change all occurrences of word 'roger' to word 'marcel' For example, to change all occurrences of word 'roger' to word 'marcel'
in a paragraph, here is what can be done: in a paragraph, here is what can be done:
select the paragraph with enough `x`. press `s` and enter roger, then enter. * select the paragraph with enough `x`
Now paragraph selection was replaced with multiselection of each roger in * press `s` and enter roger, then enter
the paragraph. Press `c` and marcel<esc> to replace rogers with marcels. * now paragraph selection was replaced with multiselection of each roger in
the paragraph
* press `c` and marcel<esc> to replace rogers with marcels
A multiselection can also be obtained with `S`, which splits the current A multiselection can also be obtained with `S`, which splits the current
selection according to the regex entered. To split a comma separated list, selection according to the regex entered. To split a comma separated list,
use `S` then ', *' use `S` then ', *'
The regex syntax supported by Kakoune is the Perl one and is describe The regex syntax supported by Kakoune is the Perl one and is described
here <<Regex syntax>>. here <<Regex syntax>>.
`s` and `S` share the search pattern with `/`, and hence entering an empty `s` and `S` share the search pattern with `/`, and hence entering an empty
@ -574,13 +576,13 @@ To clear multiple selections, use `space`. To keep only the nth selection
use `n` followed by `space`, in order to remove a selection, use `<a-space>`. use `n` followed by `space`, in order to remove a selection, use `<a-space>`.
`<a-k>` allows you to enter a regex and keep only the selections that `<a-k>` allows you to enter a regex and keep only the selections that
contains a match for this regex. using `<a-K>` you can keep the selections contains a match for this regex. Using `<a-K>` you can keep the selections
not containing a match. not containing a match.
`C` copies the current selection to the next line (or lines if a count is given) `C` copies the current selection to the next line (or lines if a count is given)
`<a-C>` does the same to previous lines. `<a-C>` does the same to previous lines.
`$` allows you to enter a shell command and pipe each selections to it. `$` allows you to enter a shell command and pipe each selection to it.
Selections whose shell command returns 0 will be kept, other will be dropped. Selections whose shell command returns 0 will be kept, other will be dropped.
Object Selection Object Selection
@ -589,8 +591,8 @@ Object Selection
Some keys allow you to select a text object: Some keys allow you to select a text object:
* `<a-a>`: selects the whole object * `<a-a>`: selects the whole object
* `<a-i>`: selects the inner object, that is the object excluding it's surrounder. * `<a-i>`: selects the inner object, that is the object excluding its surrounder.
for example, for a quoted string, this will not select the quote, and For example, for a quoted string, this will not select the quote, and
for a word this will not select trailing spaces. for a word this will not select trailing spaces.
* `[`: selects to object start * `[`: selects to object start
* `]`: selects to object end * `]`: selects to object end
@ -629,7 +631,7 @@ 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 Commands are used for non editing tasks, such as opening a buffer, writing the
current one, quitting, etc. current one, quitting, etc.
A few keys are recognized by prompt mode to help editing a command: A few keys are recognized by prompt mode to help edit a command:
* `<ret>`: validate prompt * `<ret>`: validate prompt
* `<esc>`: abandon without * `<esc>`: abandon without
@ -637,7 +639,7 @@ A few keys are recognized by prompt mode to help editing a command:
* `<left> or <a-h>`: move cursor to previous character * `<left> or <a-h>`: move cursor to previous character
* `<right> or <a-l>`: move cursor to previous character * `<right> or <a-l>`: move cursor to previous character
* `<home>`: move cursor to first character * `<home>`: move cursor to first character
* `<end>`: move cursor to passed last character * `<end>`: move cursor past the last character
* `<backspace> or <a-x>`: erase character before cursor * `<backspace> or <a-x>`: erase character before cursor
* `<del> or <a-d>`: erase character under cursor * `<del> or <a-d>`: erase character under cursor
@ -675,8 +677,8 @@ command `q!` has to be used).
displays the available topics. displays the available topics.
* `e[dit][!] <filename> [<line> [<column>]]`: open buffer on file, go to given * `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. line and column. If file is already opened, just switch to this file.
use edit! to force reloading. Use edit! to force reloading.
* `w[rite][!] [<filename>]`: write buffer to <filename> or use it's name if * `w[rite][!] [<filename>]`: write buffer to <filename> or use its name if
filename is not given. If the file is write-protected, its filename is not given. If the file is write-protected, its
permissions are temporarily changed to allow saving the buffer and permissions are temporarily changed to allow saving the buffer and
restored afterwards when the write! command is used. restored afterwards when the write! command is used.
@ -730,11 +732,11 @@ Kakoune support three string syntax:
* `%{strings}`: these strings are very useful when entering commands * `%{strings}`: these strings are very useful when entering commands
- the `{` and `}` delimiters are configurable: you can use any non - the `{` and `}` delimiters are configurable: you can use any non
alphanumeric character. like `%[string]`, `%<string>`, `%(string)`, alphanumeric character, e.g. `%[string]`, `%<string>`, `%(string)`,
`%\~string~` or `%!string!`... `%\~string~`, `%!string!`.
- if the character following the % is one of {[(<, then the closing one is - if the character following the % is one of {[(<, then the closing one is
the matching }])> and the delimiters are not escapable but are nestable. the matching }])> and the delimiters are not escapable but are nestable.
for example `%{ roger {}; }` is a valid string, `%{ marcel \}` as well. For example `%{ roger {}; }` is a valid string, `%{ marcel \}` as well.
Expansions Expansions
^^^^^^^^^^ ^^^^^^^^^^
@ -743,7 +745,7 @@ A special kind of `%{strings}` can be used, with a type between
`%` and the opening delimiter (which cannot be alphanumeric). These `%` and the opening delimiter (which cannot be alphanumeric). These
strings are expanded according to their type. strings are expanded according to their type.
For example `%opt{autoinfo}` is of type 'opt'. opt expansions are replaced For example `%opt{autoinfo}` is of type 'opt'. 'opt' expansions are replaced
by the value of the given option (here `autoinfo`). by the value of the given option (here `autoinfo`).
Supported types are: Supported types are:
@ -759,7 +761,7 @@ Supported types are:
* `arg`: argument expansion, gives access to the arguments of the current * `arg`: argument expansion, gives access to the arguments of the current
command, the content can be a number, or `@` for all arguments. command, the content can be a number, or `@` for all arguments.
for example you can display last search pattern with For example, you can display last search pattern with
------------- -------------
:echo %reg{/} :echo %reg{/}
@ -772,7 +774,7 @@ 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 commands in it. It is similar to the shell $(...) syntax and is evaluated
only when needed. only when needed.
for example: `%sh{ ls }` is replaced with the output of the ls command. For example: `%sh{ ls }` is replaced with the output of the ls command.
Some of Kakoune state is available through environment variables: Some of Kakoune state is available through environment variables:
@ -808,10 +810,10 @@ Some of Kakoune state is available through environment variables:
Note that in order to make only needed information available, Kakoune needs Note that in order to make only needed information available, Kakoune needs
to find the environment variable reference in the shell script executed. to find the environment variable reference in the shell script executed.
Hence `%sh{ ./script.sh }` with `script.sh` referencing an environment Hence, `%sh{ ./script.sh }` with `script.sh` referencing an environment
variable will not work. variable will not work.
For example you can print informations on the current file in the status For example, you can print informations on the current file in the status
line using: line using:
------------------------------- -------------------------------
@ -840,7 +842,7 @@ will source additional files:
If the `$XDG_CONFIG_HOME/kak/autoload` directory exists, load every If the `$XDG_CONFIG_HOME/kak/autoload` directory exists, load every
`*.kak` files in it, and load recursively any subdirectory. `*.kak` files in it, and load recursively any subdirectory.
If it does not exists, falls back to the site wide autoload directory If it does not exist, falls back to the site wide autoload directory
in `../share/kak/autoload/`. in `../share/kak/autoload/`.
After that, if it exists, source the `$XDG_CONFIG_HOME/kak/kakrc` file After that, if it exists, source the `$XDG_CONFIG_HOME/kak/kakrc` file
@ -856,7 +858,7 @@ Color Schemes
Kakoune ships with some color schemes that are installed to Kakoune ships with some color schemes that are installed to
`../share/kak/colors/`. If `$XDG_CONFIG_HOME/kak/colors/` is present `../share/kak/colors/`. If `$XDG_CONFIG_HOME/kak/colors/` is present
the builtin command `colorscheme` will offer completion for those the builtin command `colorscheme` will offer completion for those
color schemes. If a scheme is duplicated in userspace it will take color schemes. If a scheme is duplicated in userspace, it will take
precedence. precedence.
Options Options
@ -875,7 +877,7 @@ Options are typed, their type can be
* `{int,str}-list`: a list, elements are separated by a colon (:) * `{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 if an element needs to contain a colon, it can be escaped with a
backslash. backslash.
* `range-faces`: a `:` separated list of a pairs of a buffer range * `range-faces`: a `:` separated list of a pair of a buffer range
(`<begin line>.<begin column>,<end line>.<end column>` or (`<begin line>.<begin column>,<end line>.<end column>` or
`<begin line>.<end line>+<length>`) and a face (separated by `|`), `<begin line>.<end line>+<length>`) and a face (separated by `|`),
except for the first element which is just the timestamp of the buffer. except for the first element which is just the timestamp of the buffer.
@ -901,11 +903,11 @@ context (interactive edition for example), then the window value
in the context), and if not we use the global value. in the context), and if not we use the global value.
That means that two windows on the same buffer can use different options That means that two windows on the same buffer can use different options
(like different filetype, or different tabstop). However some options (like different filetype, or different tabstop). However, some options
might end up ignored if their scope is not in the command context: might end up ignored if their scope is not in the command context:
Writing a file never uses the window options for example, so any Writing a file never uses the window options for example, so any
options related to writing wont be taken into account if set in the options related to writing won't be taken into account if set in the
window scope (`BOM` or `eolformat` for example). window scope (`BOM` or `eolformat` for example).
New options can be declared using the `:decl` command: New options can be declared using the `:decl` command:
@ -914,10 +916,10 @@ New options can be declared using the `:decl` command:
:decl [-hidden] <type> <name> [<value>] :decl [-hidden] <type> <name> [<value>]
--------------------------------------- ---------------------------------------
the `-hidden` parameter makes the option invisible in completion, but The `-hidden` parameter makes the option invisible in completion, but
still modifiable. still modifiable.
Some options are built in Kakoune, and can be used to control it's behaviour: Some options are built in Kakoune, and can be used to control its behaviour:
* `tabstop` _int_: width of a tab character. * `tabstop` _int_: width of a tab character.
* `indentwidth` _int_: width (in spaces) used for indentation. * `indentwidth` _int_: width (in spaces) used for indentation.
@ -928,7 +930,7 @@ Some options are built in Kakoune, and can be used to control it's behaviour:
writing a buffer, this is autodetected on load; values of this option writing a buffer, this is autodetected on load; values of this option
assigned to the `window` scope are ignored assigned to the `window` scope are ignored
* `BOM` _enum(none|utf8)_: define if the file should be written * `BOM` _enum(none|utf8)_: define if the file should be written
with an unicode byte order mark. Values of this option assigned to the with a unicode byte order mark. Values of this option assigned to the
`window` scope are ignored `window` scope are ignored
* `readonly` _bool_: prevent modifications from being saved to disk, all * `readonly` _bool_: prevent modifications from being saved to disk, all
buffers if set to `true` in the `global` scope, or current buffer if set in buffers if set to `true` in the `global` scope, or current buffer if set in
@ -940,17 +942,17 @@ Some options are built in Kakoune, and can be used to control it's behaviour:
box in the enabled contexts. box in the enabled contexts.
* `autoshowcompl` _bool_: automatically display possible completions when * `autoshowcompl` _bool_: automatically display possible completions when
editing a prompt. editing a prompt.
* `ignored_files` _regex_: filenames matching this regex wont be considered * `ignored_files` _regex_: filenames matching this regex won't be considered
as candidates on filename completion (except if the text being completed as candidates on filename completion (except if the text being completed
already matches it). already matches it).
* `disabled_hooks` _regex_: hooks whose group matches this regex wont be * `disabled_hooks` _regex_: hooks whose group matches this regex won't be
executed. For example indentation hooks can be disabled with '.*-indent'. executed. For example indentation hooks can be disabled with '.*-indent'.
* `filetype` _str_: arbitrary string defining the type of the file * `filetype` _str_: arbitrary string defining the type of the file
filetype dependant actions should hook on this option changing for filetype dependant actions should hook on this option changing for
activation/deactivation. activation/deactivation.
* `path` _str-list_: directories to search for gf command. * `path` _str-list_: directories to search for gf command.
* `completers` _str-list_: completion systems to use for insert mode * `completers` _str-list_: completion systems to use for insert mode
completion. given completers are tried in order until one generate some completion. The given completers are tried in order until one generate some
completion candidates. Existing completers are: completion candidates. Existing completers are:
- `word=all` or `word=buffer` which complete using words in all buffers - `word=all` or `word=buffer` which complete using words in all buffers
(`word=all`) or only the current one (`word=buffer`) (`word=all`) or only the current one (`word=buffer`)
@ -1017,9 +1019,9 @@ fg_color and bg_color can be:
* `default`, which keeps the existing color * `default`, which keeps the existing color
* An rgb color: `rgb:RRGGBB`, with RRGGBB the hexadecimal value of the color. * An rgb color: `rgb:RRGGBB`, with RRGGBB the hexadecimal value of the color.
not specifying bg_color uses `default` Not specifying bg_color uses `default`
attributes is a string of letters each defining an attributes: `attributes` is a string of letters each defining an attribute:
* `u`: Underline * `u`: Underline
* `r`: Reverse * `r`: Reverse
@ -1084,7 +1086,7 @@ multiselection. Each selection has its own captures or yank buffer.
Alternate names Alternate names
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
non alphanumeric registers have an alternative name that can be used Non alphanumeric registers have an alternative name that can be used
in contexts where only alphanumeric identifiers are possible. in contexts where only alphanumeric identifiers are possible.
Special registers Special registers
@ -1127,7 +1129,7 @@ Using the `*` key, you can set the search pattern to the current selection.
This tries to be intelligent. It will for example detect if the current selection This tries to be intelligent. It will for example detect if the current selection
begins and/or ends at word boundaries and set the search pattern accordingly. begins and/or ends at word boundaries and set the search pattern accordingly.
with `<a-*>` you can set the search pattern to the current selection without With `<a-*>` you can set the search pattern to the current selection without
Kakoune trying to be smart. Kakoune trying to be smart.
Regex syntax Regex syntax
@ -1140,7 +1142,7 @@ http://www.boost.org/doc/libs/release/libs/regex/doc/html/boost_regex/syntax/per
Exec and Eval Exec and Eval
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
the `:exec` and `:eval` commands can be used for running Kakoune commands. The `:exec` and `:eval` commands can be used for running Kakoune commands.
`:exec` runs keys as if they were pressed, whereas `:eval` executes its given `:exec` runs keys as if they were pressed, whereas `:eval` executes its given
paremeters as if they were entered in the command prompt. By default, paremeters as if they were entered in the command prompt. By default,
they do their execution in the context of the current client. they do their execution in the context of the current client.
@ -1158,7 +1160,7 @@ Some parameters provide a way to change the context of execution:
the client. This permits to make some modification to the buffer the client. This permits to make some modification to the buffer
without modifying the user's selection. without modifying the user's selection.
* `-itersel` (requires `-draft`): execute once per selection, in a * `-itersel` (requires `-draft`): execute once per selection, in a
context with only the considered selection. This permits to avoid context with only the considered selection. This permits avoiding
cases where the selections may get merged. cases where the selections may get merged.
* `-buffer <names>`: execute in the context of each buffers in the * `-buffer <names>`: execute in the context of each buffers in the
comma separated list <names>, '*' as a name can be used to iterate comma separated list <names>, '*' as a name can be used to iterate
@ -1229,9 +1231,9 @@ and
`highlighter_id` is a name generated by the highlighter specified with `highlighter_name`, `highlighter_id` is a name generated by the highlighter specified with `highlighter_name`,
possibly dependent on the parameters. Use command completion on remove-highlighter to see the existing possibly dependent on the parameters. Use command completion on remove-highlighter to see the existing
highlighters id. highlighters' id.
general highlighters are: General highlighters are:
* `regex <ex> <capture_id>:<face>...`: highlight a regex, takes the regex as * `regex <ex> <capture_id>:<face>...`: highlight a regex, takes the regex as
first parameter, followed by any number of face parameters. first parameter, followed by any number of face parameters.
@ -1243,7 +1245,7 @@ general highlighters are:
* `flag_lines <flag> <option_name>`: add a column in front of text, and display the * `flag_lines <flag> <option_name>`: add a column in front of text, and display the
given flag in it for everly line contained in the int-list option named given flag in it for everly line contained in the int-list option named
<option_name>. <option_name>.
* `show_matching`: highlight matching char of the character under the selections * `show_matching`: highlight matching char of the character under the selections'
cursor using `MatchingChar` face. cursor using `MatchingChar` face.
* `show_whitespaces \<-tab <separator> \<-tabpad <separator> \<-lf <separator> \<-spc <separator> \<-nbsp <separator>`: display symbols on top of whitespaces to make them more explicit using the Whitespace face. * `show_whitespaces \<-tab <separator> \<-tabpad <separator> \<-lf <separator> \<-spc <separator> \<-nbsp <separator>`: display symbols on top of whitespaces to make them more explicit using the Whitespace face.
* `number_lines \<-relative> \<-hlcursor> \<-separator <separator text>`: show line numbers. * `number_lines \<-relative> \<-hlcursor> \<-separator <separator text>`: show line numbers.
@ -1257,7 +1259,7 @@ general highlighters are:
Highlighting Groups Highlighting Groups
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
the `group` highlighter is a container for other highlighters. You can add The `group` highlighter is a container for other highlighters. You can add
a group to the current window using a group to the current window using
---------------------------- ----------------------------
@ -1271,7 +1273,7 @@ inside this group.
add-highlighter -group <name> <type> <params>... add-highlighter -group <name> <type> <params>...
------------------------------------------------ ------------------------------------------------
groups can contain other groups, the `-group` switch can be used to define a path. Groups can contain other groups, the `-group` switch can be used to define a path.
---------------------------------------------------------- ----------------------------------------------------------
add-highlighter -group <name> group <subname> add-highlighter -group <name> group <subname>
@ -1299,7 +1301,7 @@ A region is defined by 4 parameters:
`recurse` is useful for regions that can be nested, for example the `%sh{ ... }` `recurse` is useful for regions that can be nested, for example the `%sh{ ... }`
construct in kakoune accept nested `{ ... }` so `%sh{ ... { ... } ... }` is valid. construct in kakoune accept nested `{ ... }` so `%sh{ ... { ... } ... }` is valid.
this region can be defined with: This region can be defined with:
------------------------ ------------------------
shell_expand %sh\{ \} \{ shell_expand %sh\{ \} \{
@ -1313,14 +1315,14 @@ add-highlighter regions <name> <region_name1> <opening1> <closing1> <recurse1>
<region_name2> <opening2> <closing2> <recurse2>... <region_name2> <opening2> <closing2> <recurse2>...
--------------------------------------------------------------------------------- ---------------------------------------------------------------------------------
defines multiple regions in which other highlighters can be added The above command defines multiple regions in which other highlighters can be added as follows:
----------------------------------------------- -----------------------------------------------
add-highlighter -group <name>/<region_name> ... add-highlighter -group <name>/<region_name> ...
----------------------------------------------- -----------------------------------------------
Regions are matched using the left-most rule: the left-most region opening starts Regions are matched using the left-most rule: the left-most region opening starts
a new region. when a region closes, the closest next opening start another region. a new region. When a region closes, the closest next opening start another region.
That matches the rule governing most programming language parsing. That matches the rule governing most programming language parsing.
@ -1352,7 +1354,7 @@ A shared highlighter can be defined with the `:add-highlighter` command
add-highlighter -group /<group_name> ... add-highlighter -group /<group_name> ...
---------------------------------------- ----------------------------------------
when the group switch values starts with a '/', it references a group in the When the group switch values starts with a '/', it references a group in the
shared highlighters, rather than the window highlighters. shared highlighters, rather than the window highlighters.
The common case would be to create a named shared group, and then fill it The common case would be to create a named shared group, and then fill it
@ -1369,7 +1371,7 @@ It can then be referenced in a window using the `ref` highlighter.
add-highlighter ref <name> add-highlighter ref <name>
-------------------------- --------------------------
the `ref` can reference any named highlighter in the shared namespace. The `ref` can reference any named highlighter in the shared namespace.
Hooks Hooks
~~~~~ ~~~~~
@ -1395,16 +1397,16 @@ use the following command:
:hook global WinCreate .*\.cc %{ add-highlighter number_lines } :hook global WinCreate .*\.cc %{ add-highlighter number_lines }
--------------------------------------------------------------- ---------------------------------------------------------------
if `<group>` is given, make this hook part of the named group. groups If `<group>` is given, make this hook part of the named group. groups
are used for removing hooks with the `remove-hooks` command are used for removing hooks with the `remove-hooks` command:
---------------------------- ----------------------------
remove-hooks <scope> <group> remove-hooks <scope> <group>
---------------------------- ----------------------------
will remove every hooks in `<scope>` that are part of the given group. The above remove every hooks in `<scope>` that are part of the given group.
existing hooks are: Existing hooks are:
* `NormalIdle`: A certain duration has passed since last key was pressed in * `NormalIdle`: A certain duration has passed since last key was pressed in
normal mode. normal mode.
@ -1447,20 +1449,20 @@ existing hooks are:
* `BufCloseFifo`: Executed when a fifo buffer closes its fifo file descriptor * `BufCloseFifo`: Executed when a fifo buffer closes its fifo file descriptor
either because the buffer is being deleted, or because the writing either because the buffer is being deleted, or because the writing
end has been closed. end has been closed.
* `RuntimeError`: an error was encountered while executing an user command * `RuntimeError`: an error was encountered while executing a user command
the error message is used for filtering the error message is used for filtering
* `KakBegin`: Kakoune started, this is called just after reading the user * `KakBegin`: Kakoune started, this is called just after reading the user
configuration files configuration files
* `KakEnd`: Kakoune is quitting. * `KakEnd`: Kakoune is quitting.
* `FocusIn`: On supported clients, triggered when the client gets focused. * `FocusIn`: On supported clients, triggered when the client gets focused.
the filtering text is the client name. The filtering text is the client name.
* `FocusOut`: On supported clients, triggered when the client gets unfocused. * `FocusOut`: On supported clients, triggered when the client gets unfocused.
the filtering text is the client name. The filtering text is the client name.
* `InsertCompletionShow`: Triggered when the insert completion menu gets * `InsertCompletionShow`: Triggered when the insert completion menu gets
displayed. displayed.
* `InsertCompletionHide`: Triggered when the insert completion menu gets * `InsertCompletionHide`: Triggered when the insert completion menu gets
hidden. hidden.
* `RawKey`: Triggered whenever an key is pressed by the user, the key is * `RawKey`: Triggered whenever a key is pressed by the user, the key is
used for filtering. used for filtering.
When not specified, the filtering text is an empty string. When not specified, the filtering text is an empty string.
@ -1468,15 +1470,15 @@ When not specified, the filtering text is an empty string.
Key Mapping Key Mapping
~~~~~~~~~~~ ~~~~~~~~~~~
You can redefine a key's meaning using the map command You can redefine a key's meaning using the map command:
-------------------------------- --------------------------------
:map <scope> <mode> <key> <keys> :map <scope> <mode> <key> <keys>
-------------------------------- --------------------------------
with `scope` being one of `global`, `buffer` or `window` (or any prefix), `scope` can be one of `global`, `buffer` or `window` (or any prefix),
mode being `insert`, `normal`, `prompt`, `menu` or `user` (or any prefix), mode one of `insert`, `normal`, `prompt`, `menu` or `user` (or any prefix),
`key` being a single key name and `keys` a list of keys. `key` a single key name and `keys` a list of keys.
`user` mode allows for user mapping behind the `,` key. Keys will be `user` mode allows for user mapping behind the `,` key. Keys will be
executed in normal mode. executed in normal mode.
@ -1505,7 +1507,7 @@ New commands can be defined using the `:def` command.
`<commands>` is a string containing the commands to execute. `<commands>` is a string containing the commands to execute.
`def` can also takes some flags: `def` can also take some flags:
* `-params <num>`: the command accept <num> parameters, with <num> * `-params <num>`: the command accept <num> parameters, with <num>
either a number, or of the form <min>..<max>, with both <min> and either a number, or of the form <min>..<max>, with both <min> and
@ -1524,7 +1526,7 @@ New commands can be defined using the `:def` command.
* `-hidden`: do not show the command in command name completions * `-hidden`: do not show the command in command name completions
* `-docstring`: define the documentation string for the command * `-docstring`: define the documentation string for the command
Using shell expansion permits to define complex commands or to access Using shell expansion permits defining complex commands or accessing
Kakoune state: Kakoune state:
------------------------------------------------------ ------------------------------------------------------
@ -1541,14 +1543,14 @@ Some helper commands can be used to define composite commands:
* `menu <label1> <commands1> <label2> <commands2>...`: display a menu using * `menu <label1> <commands1> <label2> <commands2>...`: display a menu using
labels, the selected label's commands are executed. labels, the selected label's commands are executed.
`menu` can take a -auto-single argument, to automatically run commands `menu` can take a -auto-single argument, to automatically run commands
when only one choice is provided. and a -select-cmds argument, in which when only one choice is provided. And a -select-cmds argument, in which
case menu takes three argument per item, the last one being a command case menu takes three argument per item, the last one being a command
to execute when the item is selected (but not validated). to execute when the item is selected (but not validated).
* `info <text>`: display text in an information box, at can take a -anchor * `info <text>`: display text in an information box, at can take a -anchor
option, which accepts `left`, `right` and `cursor` as value, in order to option, which accepts `left`, `right` and `cursor` as value, in order to
specify where the info box should be anchored relative to the main selection. specify where the info box should be anchored relative to the main selection.
* `try <commands> catch <on_error_commands>`: prevent an error in <commands> * `try <commands> catch <on_error_commands>`: prevent an error in <commands>
from aborting the whole commands execution, execute <on_error_commands> from aborting the command execution, execute <on_error_commands>
instead. If nothing is to be done on error, the catch part can be ommitted. instead. If nothing is to be done on error, the catch part can be ommitted.
* `reg <name> <content>`: set register <name> to <content> * `reg <name> <content>`: set register <name> to <content>
* `select <anchor_line>.<anchor_column>,<cursor_line>.<cursor_column>:...`: * `select <anchor_line>.<anchor_column>,<cursor_line>.<cursor_column>:...`:
@ -1564,26 +1566,25 @@ Aliases
With `:alias` commands can be given additional names. Aliases are scoped, so With `:alias` commands can be given additional names. Aliases are scoped, so
that an alias can refer to one command for a buffer, and to another for another that an alias can refer to one command for a buffer, and to another for another
buffer. buffer. The following command defines `<alias>` as an alias for `<command>`:
-------------------------------- --------------------------------
:alias <scope> <alias> <command> :alias <scope> <alias> <command>
-------------------------------- --------------------------------
with `<scope>` being `global`, `buffer` or `window`, will define `<alias>` as `<scope>` can be one of `global`, `buffer` or `window`.
an alias for `<command>`
------------------------------------- -------------------------------------
:unalias <scope> <alias> [<expected>] :unalias <scope> <alias> [<expected>]
------------------------------------- -------------------------------------
will remove the given alias in the given scope. If `<expected>` is specified Will remove the given alias in the given scope. If `<expected>` is specified
the alias will only be removed if its current value is `<expected>`. the alias will only be removed if its current value is `<expected>`.
FIFO Buffer FIFO Buffer
~~~~~~~~~~~ ~~~~~~~~~~~
the `:edit` command can take a `-fifo` parameter: The `:edit` command can take a `-fifo` parameter:
--------------------------------------------- ---------------------------------------------
:edit -fifo <filename> [-scroll] <buffername> :edit -fifo <filename> [-scroll] <buffername>
@ -1593,7 +1594,7 @@ In this case, a buffer named `<buffername>` is created which reads its content
from fifo `<filename>`. When the fifo is written to, the buffer is automatically from fifo `<filename>`. When the fifo is written to, the buffer is automatically
updated. updated.
if the `-scroll` switch is specified, the initial cursor position will be made If the `-scroll` switch is specified, the initial cursor position will be made
such as the window displaying the buffer will scroll as new data is read. such as the window displaying the buffer will scroll as new data is read.
This is very useful for running some commands asynchronously while displaying This is very useful for running some commands asynchronously while displaying

2
doc/autoedit.asciidoc
View File

@ -41,7 +41,7 @@ allowing for clearer separation. either use <space> or quote the argument to
use a space key) use a space key)
That works, however if the phase *2.* raises an error, the +:exec+ will stop That works, however if the phase *2.* raises an error, the +:exec+ will stop
and the user will get it's selections on the previous line. the solution and the user will get its selections on the previous line. The solution
is to use a *draft* context, instead of the one the user is interacting with. is to use a *draft* context, instead of the one the user is interacting with.
--------------------------------------------------------------- ---------------------------------------------------------------

14
doc/design.asciidoc
View File

@ -22,8 +22,8 @@ and should, as a side effect, be very efficient at editing text in general.
Composability Composability
------------- -------------
Being limited in scope to code edition should not isolate Kakoune from it's Being limited in scope to code edition should not isolate Kakoune from its
environment. On the contrary, Kakoune is expected to run on an Unix-like environment. On the contrary, Kakoune is expected to run on a Unix-like
system, along with a lot of text-based tools, and should make it easy to system, along with a lot of text-based tools, and should make it easy to
interact with these tools. interact with these tools.
@ -35,14 +35,14 @@ The modern Unix environment is not limited to text filters, most people use
a graphical interface nowadays, and Kakoune should be able to take advantage a graphical interface nowadays, and Kakoune should be able to take advantage
of that, without hindering text mode support. For example Kakoune supports of that, without hindering text mode support. For example Kakoune supports
multiple clients on the same editing session, so that multiple windows can multiple clients on the same editing session, so that multiple windows can
be used, letting the system window manager handle it's responsibilities such be used, letting the system window manager handle its responsibilities such
as tiling or tabbing. as tiling or tabbing.
Orthogonality Orthogonality
------------- -------------
Kakoune features should be as orthogonal as possible, for example, in Vim, Kakoune features should be as orthogonal as possible, for example, in Vim,
there is multiple ways for modifying the buffer: Through normal/insert there are multiple ways for modifying the buffer: Through normal/insert
mode, command mode, and Vim scripts. In Kakoune, modifying the buffer is the mode, command mode, and Vim scripts. In Kakoune, modifying the buffer is the
normal/insert mode job. normal/insert mode job.
@ -74,7 +74,7 @@ keystrokes, and fast to execute.
or the same number of keys. or the same number of keys.
* Kakoune be designed with asynchronicity in mind, launching a background * Kakoune be designed with asynchronicity in mind, launching a background
process and using it's result when available should not block the editor. process and using its result when available should not block the editor.
* Kakoune should be implemented with speed in mind, a slow editor is a * Kakoune should be implemented with speed in mind, a slow editor is a
useless one. useless one.
@ -131,6 +131,6 @@ possible be integrated with the code so that it stays up to date.
Vim compatibility Vim compatibility
----------------- -----------------
Kakoune is inspired by Vim, and should try to keep it's commands close to Vim Kakoune is inspired by Vim, and should try to keep its commands close to
ones if there is no compelling reasons to change. However self consistency Vim's if there are no compelling reasons to change. However self-consistency
is more important than Vim compatibility. is more important than Vim compatibility.

10
doc/interfacing.asciidoc
View File

@ -48,7 +48,7 @@ For example, we can echo a message in Kakoune in 10 seconds with:
Interactive output Interactive output
------------------ ------------------
It is a frequent interaction mode to run a program and display it's output It is a frequent interaction mode to run a program and display its output
in a Kakoune buffer. in a Kakoune buffer.
The common pattern to do that is to use a fifo buffer: The common pattern to do that is to use a fifo buffer:
@ -81,19 +81,19 @@ Completion candidates
Filetype specific completion should be provided by external programs. Filetype specific completion should be provided by external programs.
external completions are provided using an option to store completion, which External completions are provided using an option to store completion, which
have the following format. have the following format.
---- ----
line.column[+len]@timestamp:candidate1|desc1|menu1:candidate2|desc2|menu2:... line.column[+len]@timestamp:candidate1|desc1|menu1:candidate2|desc2|menu2:...
---- ----
the first element of this string list specify where and when this completions the first element of this string list specify where and when this completion
applies, the others are a triplet `<completion text>|<docstring>|<menu text>` applies, the others are a triplet `<completion text>|<docstring>|<menu text>`
The menu text is a a markup string, so it can contain `{face}` directives. The menu text is a markup string, so it can contain `{face}` directives.
to effectively use that completion option, it should get added to the completers To effectively use that completion option, it should get added to the completers
option. option.
--- ---

2
doc/kak.1.txt
View File

@ -100,7 +100,7 @@ which will source additional files:
* if the *$XDG_CONFIG_HOME*'/kak/autoload' directory exists, load every '*.kak' files in it, and load * if the *$XDG_CONFIG_HOME*'/kak/autoload' directory exists, load every '*.kak' files in it, and load
recursively any subdirectory recursively any subdirectory
* if it does not exists, fall back to the system wide autoload directory in '../share/kak/autoload' * if it does not exist, 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 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 configuration. In order to continue autoloading site-wide files with a local autoload directory, just add a symbolic

10
doc/manpages/commands.asciidoc
View File

@ -25,7 +25,7 @@ command *q!* has to be used).
opened, just switch to this file. Use edit! to force reloading opened, just switch to this file. Use edit! to force reloading
*w[rite][!]* [<filename>]:: *w[rite][!]* [<filename>]::
write buffer to <filename> or use it's name if filename is not write buffer to <filename> or use its name if filename is not
given. If the file is write-protected, its permissions are temporarily given. If the file is write-protected, its permissions are temporarily
changed to allow saving the buffer and restored afterwards when changed to allow saving the buffer and restored afterwards when
the write! command is used. the write! command is used.
@ -168,7 +168,7 @@ commands:
*menu* <label1> <commands1> <label2> <commands2> ...:: *menu* <label1> <commands1> <label2> <commands2> ...::
display a menu using labels, the selected label’s commands are display a menu using labels, the selected label’s commands are
executed. menu can take an *-auto-single* argument, to automatically executed. The *menu* command can take an *-auto-single* argument, to automatically
run commands when only one choice is provided, and a *-select-cmds* run commands when only one choice is provided, and a *-select-cmds*
argument, in which case menu takes three argument per item, the argument, in which case menu takes three argument per item, the
last one being a command to execute when the item is selected (but last one being a command to execute when the item is selected (but
@ -187,7 +187,7 @@ commands:
set the title of the message box set the title of the message box
*try* <commands> catch <on_error_commands>:: *try* <commands> catch <on_error_commands>::
prevent an error in *commands* from aborting the whole commands prevent an error in *commands* from aborting the whole command
execution, execute *on_error_commands* instead. If nothing is to be execution, execute *on_error_commands* instead. If nothing is to be
done on error, the catch part can be omitted done on error, the catch part can be omitted
@ -243,8 +243,8 @@ New commands can be defined using the *define-command* command:
*-docstring*::: *-docstring*:::
define the documentation string for the command define the documentation string for the command
Using shell expansion allows to define complex commands or to access Kakoune Using shell expansion allows defining complex commands or accessing
state: Kakoune's state:
-------------------------------------------------------- --------------------------------------------------------
def " print_selection %{ echo %sh{ ${kak_selection} } }" def " print_selection %{ echo %sh{ ${kak_selection} } }"

2
doc/manpages/execeval.asciidoc
View File

@ -40,7 +40,7 @@ Optional flags
*-itersel* (requires -draft):: *-itersel* (requires -draft)::
execute once per selection, in a context with only the considered execute once per selection, in a context with only the considered
selection. This permits to avoid cases where the selections may selection. This permits avoiding cases where the selections may
get merged get merged
*-buffer* <names>:: *-buffer* <names>::

4
doc/manpages/faq.asciidoc
View File

@ -10,7 +10,7 @@ How to pronounce the name of the project and what does it mean ?
The name of the project is pronounced "Kak-oon", and is a word taken from a The name of the project is pronounced "Kak-oon", and is a word taken from a
New Caledonian dialect based on french. It means a hard blow, usually a punch, New Caledonian dialect based on french. It means a hard blow, usually a punch,
but generally refers to a blow into which which all of one's strength went. but generally refers to a blow into which all of one's strength went.
Is there going to be a Windows port of Kakoune ? Is there going to be a Windows port of Kakoune ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -127,7 +127,7 @@ Why aren't there other scopes similar to `%sh{}` e.g. python ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Supporting custom scopes would add hard dependencies to the project, which Supporting custom scopes would add hard dependencies to the project, which
is too much of an drawback when balanced against the low cost of using is too much of a drawback when balanced against the low cost of using
an interpreter in a regular shell scope (e.g. `%sh{ python -c "..." }`). an interpreter in a regular shell scope (e.g. `%sh{ python -c "..." }`).
The shell scope allows users to spawn any interpreter they want, for a minimal The shell scope allows users to spawn any interpreter they want, for a minimal
cost in terms of performance, it is therefore the reason why it's the only cost in terms of performance, it is therefore the reason why it's the only

8
doc/manpages/highlighters.asciidoc
View File

@ -48,7 +48,7 @@ General highlighters
every line contained in the int-list option named <option_name> every line contained in the int-list option named <option_name>
*show_matching*:: *show_matching*::
highlight matching char of the character under the selections cursor highlight matching char of the character under the selections' cursor
using MatchingChar face using MatchingChar face
*show_whitespaces* [options]:: *show_whitespaces* [options]::
@ -62,7 +62,7 @@ General highlighters
a one character long separator that will replace spaces a one character long separator that will replace spaces
*-nbsp* <separator>::: *-nbsp* <separator>:::
a one character long separator that will replace non breakable spaces a one character long separator that will replace non-breakable spaces
*-tab* <separator>::: *-tab* <separator>:::
a one character long separator that will replace tabulations a one character long separator that will replace tabulations
@ -151,7 +151,7 @@ This region can be defined with:
shell_expand %sh\{ \} \{ shell_expand %sh\{ \} \{
------------------------ ------------------------
Regions are used in the regions highlighter which can take any number Regions are used in the region highlighters which can take any number
of regions. of regions.
The following command: The following command:
@ -180,7 +180,7 @@ If the *-match-capture* switch is passed, then region closing and recurse
matches are considered valid for a given region opening match only if they matches are considered valid for a given region opening match only if they
matched the same content for the capture 1. matched the same content for the capture 1.
Most programming languages can then be properly highlighted using a regions Most programming languages can then be properly highlighted using a region
highlighter as root: highlighter as root:
----------------------------------------------------------------- -----------------------------------------------------------------

10
doc/manpages/hooks.asciidoc
View File

@ -28,7 +28,7 @@ following command:
hook global WinCreate .*\.cc %{ add-highlighter number_lines } hook global WinCreate .*\.cc %{ add-highlighter number_lines }
---------------------------------------------------- ----------------------------------------------------
if *group* is given, make this hook part of the named group. Groups are used If *group* is given, make this hook part of the named group. Groups are used
for removing hooks with the following command: for removing hooks with the following command:
----------------------- -----------------------
@ -130,7 +130,7 @@ Default hooks
or because the writing end has been closed or because the writing end has been closed
*RuntimeError*:: *RuntimeError*::
an error was encountered while executing an user command the error an error was encountered while executing a user command the error
message is used for filtering message is used for filtering
*KakBegin*:: *KakBegin*::
@ -141,11 +141,11 @@ Default hooks
kakoune is quitting kakoune is quitting
*FocusIn*:: *FocusIn*::
on supported clients, triggered when the client gets focused. the on supported clients, triggered when the client gets focused. The
filtering text is the client name filtering text is the client name
*FocusOut*:: *FocusOut*::
on supported clients, triggered when the client gets unfocused. the on supported clients, triggered when the client gets unfocused. The
filtering text is the client name filtering text is the client name
*InsertCompletionShow*:: *InsertCompletionShow*::
@ -155,7 +155,7 @@ Default hooks
Triggered when the insert completion menu gets hidden Triggered when the insert completion menu gets hidden
*RawKey*:: *RawKey*::
Triggered whenever an key is pressed by the user, the key is Triggered whenever a key is pressed by the user, the key is
used for filtering. used for filtering.
When not specified, the filtering text is an empty string. Note that When not specified, the filtering text is an empty string. Note that

10
doc/manpages/keys.asciidoc
View File

@ -76,7 +76,7 @@ Using Counts
In normal mode, commands can be prefixed with a numeric count, which can control In normal mode, commands can be prefixed with a numeric count, which can control
the command behaviour. the command behaviour.
for example, *3W* selects 3 consecutive words and *3w* select the third word on For example, *3W* selects 3 consecutive words and *3w* select the third word on
the right of selection end. the right of selection end.
Disabling Hooks Disabling Hooks
@ -227,11 +227,11 @@ Changes
enter insert mode at current selection end line end enter insert mode at current selection end line end
*o*:: *o*::
enter insert mode in one (or given count) new lines below enter insert mode in a new line (or in a given count of new lines) below
current selection end current selection end
*O*:: *O*::
enter insert mode in a on (or given count) lines above enter insert mode in a new line (or in a given count of new lines) above
current selection begin current selection begin
*y*:: *y*::
@ -498,7 +498,7 @@ Object Selection
selects the whole object selects the whole object
*<a-i>*:: *<a-i>*::
selects the inner object, that is the object excluding it's surrounder selects the inner object, that is the object excluding its surrounder
*[*:: *[*::
selects to object start selects to object start
@ -582,7 +582,7 @@ Prompt Commands
move cursor to first character move cursor to first character
*<end>*:: *<end>*::
move cursor to passed last character move cursor past the last character
*<backspace>*, *<a-x>*:: *<backspace>*, *<a-x>*::
erase character before cursor erase character before cursor

8
doc/manpages/options.asciidoc
View File

@ -23,7 +23,7 @@ Types
to contain a colon, it can be escaped to contain a colon, it can be escaped
with a backslash with a backslash
*range-faces*:: *range-faces*::
a `:` separated list of a pairs of a buffer range a `:` separated list of a pair of a buffer range
(`<begin line>.<begin column>,<end line>.<end column>` or (`<begin line>.<begin column>,<end line>.<end column>` or
`<begin line>.<begin column>+<length>`) and a face (separated by `|`), `<begin line>.<begin column>+<length>`) and a face (separated by `|`),
except for the first element which is just the timestamp of the buffer. except for the first element which is just the timestamp of the buffer.
@ -60,7 +60,7 @@ Builtin options
ignored ignored
*BOM* 'enum(none|utf8)':: *BOM* 'enum(none|utf8)'::
define if the file should be written with an unicode byte order mark; define if the file should be written with a unicode byte order mark;
values of this option assigned to the `window` scope are ignored values of this option assigned to the `window` scope are ignored
*readonly* 'bool':: *readonly* 'bool'::
@ -82,12 +82,12 @@ Builtin options
automatically display possible completions when editing a prompt automatically display possible completions when editing a prompt
*ignored_files* 'regex':: *ignored_files* 'regex'::
filenames matching this regex wont be considered as candidates on filenames matching this regex won't be considered as candidates on
filename completion (except if the text being completed already filename completion (except if the text being completed already
matches it) matches it)
*disabled_hooks* 'regex':: *disabled_hooks* 'regex'::
hooks whose group matches this regex wont be executed. For example hooks whose group matches this regex won't be executed. For example
indentation hooks can be disabled with '.*-indent' indentation hooks can be disabled with '.*-indent'
*filetype* 'str':: *filetype* 'str'::

2
doc/manpages/registers.asciidoc
View File

@ -23,7 +23,7 @@ Interacting
Alternate names Alternate names
--------------- ---------------
non alphanumeric registers have an alternative name that can be used Non alphanumeric registers have an alternative name that can be used
in contexts where only alphanumeric identifiers are possible. in contexts where only alphanumeric identifiers are possible.
Default registers Default registers