Add a doc command, as well as several themed documentation pages
This commit is contained in:
Frank LENORMAND
parent
043f742ec3
commit
33008f9ea7
185
doc/manpages/commands
Normal file
185
doc/manpages/commands
Normal file
|
|
@ -0,0 +1,185 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "COMMANDS"
|
||||||
|
|
||||||
|
.SS Primitives
|
||||||
|
.TP
|
||||||
|
.BR e[dit] " <filename> [<line> [<column>]]"
|
||||||
|
open buffer on file, go to given line and column. If file is already opened, just switch to this file. Use edit! to force reloading
|
||||||
|
.TP
|
||||||
|
.BR w[rite] " [<filename>]"
|
||||||
|
write buffer to <filename> or use it's name if filename is not given
|
||||||
|
.TP
|
||||||
|
.BR w[rite]a[ll]
|
||||||
|
write all buffers that are associated to a file
|
||||||
|
.TP
|
||||||
|
.BR q[uit]
|
||||||
|
exit Kakoune, use quit! to force quitting even if there is some unsaved buffers remaining
|
||||||
|
.TP
|
||||||
|
.BR wq
|
||||||
|
write current buffer and quit
|
||||||
|
.TP
|
||||||
|
.BR b[uffer] " <name>"
|
||||||
|
switch to buffer <name>
|
||||||
|
.TP
|
||||||
|
.BR d[el]b[uf] " [<name>]"
|
||||||
|
delete the buffer <name>, use d[el]b[uf]! to force deleting a modified buffer
|
||||||
|
.TP
|
||||||
|
.BR source " <filename>"
|
||||||
|
execute commands in <filename>
|
||||||
|
.TP
|
||||||
|
.BR runtime " <filename>"
|
||||||
|
execute commands in <filename>, <filename> is relative to kak executable path
|
||||||
|
.TP
|
||||||
|
.BR colorscheme " <name>"
|
||||||
|
load named colorscheme
|
||||||
|
.TP
|
||||||
|
.BR nameclient " <name>"
|
||||||
|
set current client name
|
||||||
|
.TP
|
||||||
|
.BR namebuf " <name>"
|
||||||
|
set current buffer name
|
||||||
|
.TP
|
||||||
|
.BR echo " <text>"
|
||||||
|
show <text> in status line
|
||||||
|
.TP
|
||||||
|
.BR nop
|
||||||
|
does nothing, but arguments will be evaluated (e.g. shell expansion)
|
||||||
|
.TP
|
||||||
|
.BR set " <scope> <name> <value>"
|
||||||
|
change the value of an option (c.f. the 'options' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR alias " <scope> <name> <command>"
|
||||||
|
define a new alias, within the context of a scope
|
||||||
|
.TP
|
||||||
|
.BR unalias " <scope> <name> [<command>]"
|
||||||
|
remove an alias if its current value is the same as the one passed as an optional parameter, remove it unconditionally otherwise
|
||||||
|
.TP
|
||||||
|
.BR decl " [-hidden] <type> <name> [<value>]"
|
||||||
|
declare a new option, the -hidden hides the option in completion suggestions (c.f. the 'options' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR face " <name> <facespec>"
|
||||||
|
define a face (c.f. the 'faces' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR exec " [<flags>] <key> …"
|
||||||
|
execute a series of keys, as if they were hit (c.f. the 'execeval' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR eval " [<flags>] <command> …"
|
||||||
|
execute commands, as if they were entered in the command prompt (c.f. the 'execeval' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR def " [<flags>] <name> <command>"
|
||||||
|
define a new command (c.f. the 'Declaring new commands' section below)
|
||||||
|
.TP
|
||||||
|
.BR map " <scope> <mode> <key> <keys>"
|
||||||
|
bind a combination of keys to another one (c.f. the 'commands' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR hook " [-group <group>] <scope> <hook_name> <filtering_regex> <command>"
|
||||||
|
execute a command whenever an event is triggered (c.f. the 'hooks' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR rmhooks " <scope> <group>"
|
||||||
|
remove every hooks in
|
||||||
|
.IR <scope>
|
||||||
|
that are part of the given
|
||||||
|
.IR <group>
|
||||||
|
(c.f. the 'hooks' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR addhl " [<flags>] <highlighter_name> <highlighter_parameters> …"
|
||||||
|
add a highlighter to the current window (c.f. the 'highlighters' documentation page)
|
||||||
|
.TP
|
||||||
|
.BR rmhl " <highlighter_id>"
|
||||||
|
remove the highlighter whose id is
|
||||||
|
.IR highlighter_id
|
||||||
|
(c.f. the 'highlighters' documentation page)
|
||||||
|
|
||||||
|
.SS Helpers
|
||||||
|
Kakoune provides some helper commands that can be used to define composite commands:
|
||||||
|
.TP
|
||||||
|
.BR prompt " <prompt> <register> <command>"
|
||||||
|
prompt the user for a string, when the user validates, store the result in given
|
||||||
|
.IR <register> " and run " <commmand> "."
|
||||||
|
the
|
||||||
|
.IR -init <str>
|
||||||
|
switch allows setting initial content
|
||||||
|
.TP
|
||||||
|
.BR onkey " <register> <command>"
|
||||||
|
wait for next key from user, writes it into given <register> and execute commands
|
||||||
|
.TP
|
||||||
|
.BR menu " <label1> <commands1> <label2> <commands2> …"
|
||||||
|
display a menu using labels, the selected label’s commands are executed. menu can take an
|
||||||
|
.IR -auto-single
|
||||||
|
argument, to automatically run commands when only one choice is provided, and a
|
||||||
|
.IR -select-cmds
|
||||||
|
argument, in which case menu takes three argument per item, the last one being a command to execute when the item is selected (but not validated)
|
||||||
|
.TP
|
||||||
|
.BR info " <text>"
|
||||||
|
display text in an information box, at can take an
|
||||||
|
.IR -anchor
|
||||||
|
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
|
||||||
|
.TP
|
||||||
|
.BR try " <commands> catch <on_error_commands>"
|
||||||
|
prevent an error in
|
||||||
|
.IR <commands>
|
||||||
|
from aborting the whole commands execution, execute
|
||||||
|
.IR <on_error_commands>
|
||||||
|
instead. If nothing is to be done on error, the catch part can be ommitted
|
||||||
|
.TP
|
||||||
|
.BR reg " <name> <content>"
|
||||||
|
set register
|
||||||
|
.IR <name> " to " <content>
|
||||||
|
.RE
|
||||||
|
|
||||||
|
Note that those commands are also available in the interactive mode, but are not really useful in that context.
|
||||||
|
|
||||||
|
.SS Multiple commands
|
||||||
|
Commands (c.f. previous sections) can be chained, by being separated either by new lines or by semicolons, as such a
|
||||||
|
semicolon must be escaped with a backslash (\;) to be considered as a literal semicolon argument
|
||||||
|
|
||||||
|
.SS Declaring new commands
|
||||||
|
|
||||||
|
New commands can be defined using the
|
||||||
|
.IR def
|
||||||
|
command:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR def " [flags] <command_name> <commands>"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.IR <commands>
|
||||||
|
is a string containing the commands to execute, and
|
||||||
|
.IR flags
|
||||||
|
can be any combination of the following parameters:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR -params " <num>"
|
||||||
|
the command accepts a
|
||||||
|
.IR <num>
|
||||||
|
parameter, which can be either a number, or of the form <min>..<max>, with both <min> and <max> omittable
|
||||||
|
.TP
|
||||||
|
.BR -file-completion
|
||||||
|
try file completion on any parameter passed to this command
|
||||||
|
.TP
|
||||||
|
.BR -client-completion
|
||||||
|
try client name completion on any parameter passed to this command
|
||||||
|
.TP
|
||||||
|
.BR -buffer-completion
|
||||||
|
try buffer name completion on any parameter passed to this command
|
||||||
|
.TP
|
||||||
|
.BR -shell-completion
|
||||||
|
following string is a shell command which takes parameters as positional params and output one completion candidate per line
|
||||||
|
.TP
|
||||||
|
.BR -allow-override
|
||||||
|
allow the new command to replace an exisiting one with the same name
|
||||||
|
.TP
|
||||||
|
.BR -hidden
|
||||||
|
do not show the command in command name completions
|
||||||
|
.TP
|
||||||
|
.BR -docstring
|
||||||
|
define the documentation string for the command
|
||||||
|
.RE
|
||||||
|
|
||||||
|
Using shell expansion allows to define complex commands or to access Kakoune state:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR def " print_selection %{ echo %sh{ ${kak_selection} } }"
|
||||||
|
.RE
|
||||||
53
doc/manpages/execeval
Normal file
53
doc/manpages/execeval
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "EXEC & EVAL"
|
||||||
|
|
||||||
|
.TP
|
||||||
|
The
|
||||||
|
.IR exec " and " eval
|
||||||
|
commands can be used to run Kakoune commands, and should be used as follows:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR exec " [<flags>] <key> …"
|
||||||
|
.TP
|
||||||
|
.BR eval " [<flags>] <command> …"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.IR exec
|
||||||
|
runs keys as if they were pressed, whereas
|
||||||
|
.IR eval
|
||||||
|
executes its given paremeters as if they were entered in the command prompt. \
|
||||||
|
By default, their execution happens within the context of the current client, \
|
||||||
|
and stops when the last key/command is reached, or an error is raised.
|
||||||
|
|
||||||
|
.SS Optional flags
|
||||||
|
.TP
|
||||||
|
.BR -client " <name>"
|
||||||
|
execute in the context of the client named
|
||||||
|
.IR <name>
|
||||||
|
.TP
|
||||||
|
.BR -try-client " <name>"
|
||||||
|
execute in the context of the client named
|
||||||
|
.IR <name>
|
||||||
|
if such client exists, or else in the current context
|
||||||
|
.TP
|
||||||
|
.BR -draft
|
||||||
|
execute in a copy of the context of the selected client modifications to the selections or input state will not affect the client. This permits to make some modification to the buffer without modifying the user’s selection
|
||||||
|
.TP
|
||||||
|
.BR -itersel " (requires -draft)"
|
||||||
|
execute once per selection, in a context with only the considered selection. This permits to avoid cases where the selections may get merged
|
||||||
|
.TP
|
||||||
|
.BR -buffer " <names>"
|
||||||
|
execute in the context of each buffers in the comma separated list
|
||||||
|
.IR <names> ", " *
|
||||||
|
as a name can be used to iterate on all buffers
|
||||||
|
.TP
|
||||||
|
.BR -no-hooks
|
||||||
|
disable hook execution while executing the keys/commands
|
||||||
|
.TP
|
||||||
|
.BR -with-maps
|
||||||
|
use user key mapping in
|
||||||
|
.IR exec
|
||||||
|
instead of built in keys
|
||||||
|
.TP
|
||||||
|
.BR -save-regs " <regs>"
|
||||||
|
regs is a string of registers to be restored after execution
|
||||||
115
doc/manpages/expansions
Normal file
115
doc/manpages/expansions
Normal file
|
|
@ -0,0 +1,115 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "EXPANSIONS"
|
||||||
|
|
||||||
|
.SS Strings
|
||||||
|
.TP
|
||||||
|
.BR 'strings'
|
||||||
|
uninterpreted strings, use a backslash (\\') to escape the separator
|
||||||
|
.TP
|
||||||
|
.BR "strings"
|
||||||
|
expanded strings, % strings (c.f. next section) contained are expended, use a backslash (\\%) to escape the separator
|
||||||
|
.TP
|
||||||
|
.BR %{strings}
|
||||||
|
these strings are very useful when entering commands the
|
||||||
|
.IR { " and " }
|
||||||
|
delimiters are configurable, you can use any non alphanumeric character
|
||||||
|
e.g. %[string], %<string>, %(string), %~string~, %!string!
|
||||||
|
if the character following '%' is one of '{[(<', then the closing one is the matching '}])>' and the delimiters are not escapable but are nestable
|
||||||
|
e.g.
|
||||||
|
.IR %{\ roger\ {};\ } " is a valid string
|
||||||
|
|
||||||
|
.SS Typed expansions
|
||||||
|
.TP
|
||||||
|
.BR sh
|
||||||
|
shell expansion, similar to posix shell $(…) construct (c.f. next section)
|
||||||
|
.TP
|
||||||
|
.BR reg
|
||||||
|
register expansion, will be replaced by the content of the given register
|
||||||
|
.TP
|
||||||
|
.BR opt
|
||||||
|
option expansion, will be replaced with the value of the given option
|
||||||
|
.TP
|
||||||
|
.BR val
|
||||||
|
value expansion, gives access to the environment variable available to the Shell expansion. The kak_ prefix is not used there
|
||||||
|
.TP
|
||||||
|
.BR arg
|
||||||
|
argument expansion, gives access to the arguments of the current command, the content can be a number, or @ for all arguments
|
||||||
|
|
||||||
|
.SS Shell expansions
|
||||||
|
The
|
||||||
|
.IR %sh{…}
|
||||||
|
expansion replaces its content with the output of the shell commands in it. The following environment variables are used to pass informations about Kakoune's state:
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BR kak_selection
|
||||||
|
content of the main selection
|
||||||
|
.TP
|
||||||
|
.BR kak_selections
|
||||||
|
content of the selection separated by colons, colons in the selection contents are escapted with a backslash.
|
||||||
|
.TP
|
||||||
|
.BR kak_selection_desc
|
||||||
|
range of the main selection, represented as anchor,cursor; anchor and cursor are in this format: line.column
|
||||||
|
.TP
|
||||||
|
.BR kak_selections_desc
|
||||||
|
range of the selecations separated by colons
|
||||||
|
.TP
|
||||||
|
.BR kak_bufname
|
||||||
|
name of the current buffer
|
||||||
|
.TP
|
||||||
|
.BR kak_buffile
|
||||||
|
full path of the file or same as kak_bufname when there’s no associated file
|
||||||
|
.TP
|
||||||
|
.BR kak_buflist
|
||||||
|
the current buffer list, each buffer seperated by a colon
|
||||||
|
.TP
|
||||||
|
.BR kak_timestamp
|
||||||
|
timestamp of the current buffer, the timestamp is an integer value which is incremented each time the buffer is modified.
|
||||||
|
.TP
|
||||||
|
.BR kak_runtime
|
||||||
|
directory containing the kak binary
|
||||||
|
.TP
|
||||||
|
.BR kak_opt_<name>
|
||||||
|
value of option
|
||||||
|
.IR <name>
|
||||||
|
.TP
|
||||||
|
.BR kak_reg_<r>
|
||||||
|
value of register
|
||||||
|
.IR <r>
|
||||||
|
.TP
|
||||||
|
.BR kak_socket
|
||||||
|
filename of session socket (/tmp/kak-<session>)
|
||||||
|
.TP
|
||||||
|
.BR kak_session
|
||||||
|
name of the current session
|
||||||
|
.TP
|
||||||
|
.BR kak_client
|
||||||
|
name of current client
|
||||||
|
.TP
|
||||||
|
.BR kak_cursor_line
|
||||||
|
line of the end of the main selection
|
||||||
|
.TP
|
||||||
|
.BR kak_cursor_column
|
||||||
|
column of the end of the main selection (in byte)
|
||||||
|
.TP
|
||||||
|
.BR kak_cursor_char_column
|
||||||
|
column of the end of the main selection (in character)
|
||||||
|
.TP
|
||||||
|
.BR kak_window_width
|
||||||
|
width of the current kakoune window
|
||||||
|
.TP
|
||||||
|
.BR kak_window_height
|
||||||
|
height of the current kakoune window
|
||||||
|
.TP
|
||||||
|
.BR kak_hook_param
|
||||||
|
filtering text passed to the currently executing hook
|
||||||
|
.TP
|
||||||
|
.BR kak_client_env_<name>
|
||||||
|
value of the
|
||||||
|
.IR <name>
|
||||||
|
variable in the client environment (e.g. $kak_client_env_SHELL is the SHELL variable)
|
||||||
|
|
||||||
|
Note that in order for Kakoune to pass a value in the environment, the variable has to be spelled out within the body of the expansion
|
||||||
|
|
||||||
|
.SS Markup strings
|
||||||
|
In certain contexts, Kakoune can take a markup string, which is a string containing formatting informations.
|
||||||
|
In these strings, the {facename} syntax will enable the face facename until another face gets activated, or the end of the string is reached.
|
||||||
|
Literal '{' characters shall be written '\\{', and a literal backslash ('\\') that preceeds a '{' character shall be escaped as well ('\\\\')
|
||||||
100
doc/manpages/faces
Normal file
100
doc/manpages/faces
Normal file
|
|
@ -0,0 +1,100 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "FACES"
|
||||||
|
|
||||||
|
.SS Declaration
|
||||||
|
.TP
|
||||||
|
A "face" refers how the specified text is displayed, it has a foreground color, a background color, and some attributes. The value of a face has the following format:
|
||||||
|
.IR fg_color[,bg_color][+attributes]
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BR fg_color ", " bg_color
|
||||||
|
a color whose value can be expressed in the following formats:
|
||||||
|
.RS 7
|
||||||
|
.TP
|
||||||
|
.BR black ", " red ", " green ", " yellow ", " blue ", " magenta ", " cyan ", " white
|
||||||
|
a named color
|
||||||
|
.TP
|
||||||
|
.BR default
|
||||||
|
keep the existing color
|
||||||
|
.TP
|
||||||
|
.BR rgb:RRGGBB
|
||||||
|
hexadecimal value
|
||||||
|
.RE
|
||||||
|
.TP
|
||||||
|
.BR attributes
|
||||||
|
string whose individual letters set an attribute:
|
||||||
|
.RS 7
|
||||||
|
.TP
|
||||||
|
.BR u
|
||||||
|
underline
|
||||||
|
.TP
|
||||||
|
.BR r
|
||||||
|
reverse
|
||||||
|
.TP
|
||||||
|
.BR b
|
||||||
|
bold
|
||||||
|
.TP
|
||||||
|
.BR B
|
||||||
|
blink
|
||||||
|
.TP
|
||||||
|
.BR d
|
||||||
|
dim
|
||||||
|
.TP
|
||||||
|
.BR i
|
||||||
|
italic
|
||||||
|
.TP
|
||||||
|
.BR e
|
||||||
|
exclusive, override previous faces instead of merging with them
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.SS Builtin faces
|
||||||
|
.TP
|
||||||
|
The following default faces are used by color schemes to highlight certains areas of the user interface:
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BR Default
|
||||||
|
default colors
|
||||||
|
.TP
|
||||||
|
.BR PrimarySelection
|
||||||
|
main selection face for every selected character except the cursor
|
||||||
|
.TP
|
||||||
|
.BR SecondarySelection
|
||||||
|
secondary selection face for every selected character except the cursor
|
||||||
|
.TP
|
||||||
|
.BR PrimaryCursor
|
||||||
|
cursor of the primary selection
|
||||||
|
.TP
|
||||||
|
.BR SecondaryCursor
|
||||||
|
cursor of the secondary selection
|
||||||
|
.TP
|
||||||
|
.BR LineNumbers
|
||||||
|
face used by the number_lines highlighter
|
||||||
|
.TP
|
||||||
|
.BR LineNumberAbsolute
|
||||||
|
face used to highlight the line number of the main selection
|
||||||
|
.TP
|
||||||
|
.BR MenuForeground
|
||||||
|
face for the selected element in menus
|
||||||
|
.TP
|
||||||
|
.BR MenuBackground
|
||||||
|
face for the not selected elements in menus
|
||||||
|
.TP
|
||||||
|
.BR Information
|
||||||
|
face for the informations windows and information messages
|
||||||
|
.TP
|
||||||
|
.BR Error
|
||||||
|
face of error messages
|
||||||
|
.TP
|
||||||
|
.BR StatusLine
|
||||||
|
face used for the status line
|
||||||
|
.TP
|
||||||
|
.BR StatusCursor
|
||||||
|
face used for the status line cursor
|
||||||
|
.TP
|
||||||
|
.BR Prompt
|
||||||
|
face used prompt displayed on the status line
|
||||||
|
.TP
|
||||||
|
.BR MatchingChar
|
||||||
|
face used by the show_matching highlighter
|
||||||
|
.TP
|
||||||
|
.BR Search
|
||||||
|
face used to highlight search results
|
||||||
195
doc/manpages/highlighters
Normal file
195
doc/manpages/highlighters
Normal file
|
|
@ -0,0 +1,195 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "HIGHLIGHTERS"
|
||||||
|
|
||||||
|
.TP
|
||||||
|
Manipulation of the displayed text is done through highlighters, which can be added or removed with the following commands:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " <highlighter_name> <highlighter_parameters> …"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
and
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR rmhl " <highlighter_id>"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.IR highlighter_id
|
||||||
|
is a name generated by the highlighter specified with
|
||||||
|
.IR highlighter_name ","
|
||||||
|
possibly dependent on the parameters. Use command completion in a prompt on the
|
||||||
|
.IR rmhl
|
||||||
|
command to see the existing highlighters ids.
|
||||||
|
|
||||||
|
.SH General highlighters
|
||||||
|
.TP
|
||||||
|
.BR regex " <ex> <capture_id>:<face> …"
|
||||||
|
highlight a regex, takes the regex as first parameter, followed by any number of face parameters. For example:
|
||||||
|
.IR addhl regex //(\h`TODO:)?[^\n] 0:cyan 1:yellow,red`
|
||||||
|
will highlight C++ style comments in cyan, with an eventual 'TODO:' in yellow on red background
|
||||||
|
.TP
|
||||||
|
.BR dynregex
|
||||||
|
Similar to regex, but expand (like a command paramater would) the given expression before building a regex from the result
|
||||||
|
.TP
|
||||||
|
.BR 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 <option_name>
|
||||||
|
.TP
|
||||||
|
.BR show_matching
|
||||||
|
highlight matching char of the character under the selections cursor using MatchingChar face
|
||||||
|
.TP
|
||||||
|
.BR number_lines " <-relative> <-hlcursor> <-separator <separator text> >"
|
||||||
|
show line numbers, with the following options:
|
||||||
|
.RS 7
|
||||||
|
.TP
|
||||||
|
.BR -relative
|
||||||
|
show line numbers relative to the main cursor line
|
||||||
|
.TP
|
||||||
|
.BR -hlcursor
|
||||||
|
highlight the cursor line with a separate face
|
||||||
|
.TP
|
||||||
|
.BR -separator
|
||||||
|
specify a string to separate the line numbers column with the rest of the buffer (default is
|
||||||
|
.IR | ")"
|
||||||
|
.RE
|
||||||
|
.TP
|
||||||
|
.BR fill " <face>"
|
||||||
|
fill using the given
|
||||||
|
.IR face ","
|
||||||
|
mostly useful with regions highlighters
|
||||||
|
|
||||||
|
.SH Highlighting Groups
|
||||||
|
|
||||||
|
The group highlighter is a container for other highlighters. You can add a group to the current window using
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " group <name>"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
The
|
||||||
|
.IR -group
|
||||||
|
switch of the
|
||||||
|
.IR addhl
|
||||||
|
command provides a mean to add highlighters inside this group:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group <name> <type> <params>..."
|
||||||
|
.RE
|
||||||
|
|
||||||
|
Groups can contain other groups, the
|
||||||
|
.IR -group
|
||||||
|
switch can be used to define a path as follows:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group <name> group <subname>"
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group <name>/<subname> <type> <params>…"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.SH Regions highlighters
|
||||||
|
|
||||||
|
A special highlighter provides a way to segment the buffer into regions, which are to be highlighted differently.
|
||||||
|
|
||||||
|
A region is defined by 4 parameters:
|
||||||
|
.TP
|
||||||
|
.BR name
|
||||||
|
user defined, used to identify the region
|
||||||
|
.TP
|
||||||
|
.BR opening
|
||||||
|
regex that defines the region start text
|
||||||
|
.TP
|
||||||
|
.BR closing
|
||||||
|
regex that defines the region end text
|
||||||
|
.TP
|
||||||
|
.BR recurse
|
||||||
|
regex that defines the text that matches recursively an end token into the region
|
||||||
|
.RE
|
||||||
|
|
||||||
|
The
|
||||||
|
.IR recurse
|
||||||
|
option is useful for regions that can be nested, for example the
|
||||||
|
.IR %sh{\ …\ }
|
||||||
|
construct in kakoune accept nested
|
||||||
|
.IR {\ …\ } " so " %sh{\ …\ {\ …\ }\ …\ }
|
||||||
|
is valid. This region can be defined with:
|
||||||
|
.IR shell_expand\ %sh\\{\ \\}\ \\{
|
||||||
|
|
||||||
|
Regions are used in the regions highlighter which can take any number of regions.
|
||||||
|
|
||||||
|
The command:
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " regions <name> <region_name1> <opening1> <closing1> <recurse1>"
|
||||||
|
<region_name2> <opening2> <closing2> <recurse2>…
|
||||||
|
.RE
|
||||||
|
|
||||||
|
defines multiple regions in which other highlighters can be added as follows:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group <name>/<region_name> …"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
That matches the rule governing most programming language parsing.
|
||||||
|
|
||||||
|
Regions also supports a
|
||||||
|
.IR -default
|
||||||
|
switch to define the default region, when no other region matches the current buffer range:
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR -default " <default_region>"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
Most programming languages can then be properly highlighted using a regions highlighter as root:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " regions -default code <lang>"
|
||||||
|
string <str_opening> <str_closing> <str_recurse> \
|
||||||
|
comment <comment_opening> <comment_closing> <comment_recurse>
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group <lang>/code …"
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group <lang>/string …"
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group <lang>/comment …"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.SH Shared Highlighters
|
||||||
|
|
||||||
|
Highlighters are often defined for a specific filetype, and it makes then sense to share the highlighters between all the windows on the same filetypes.
|
||||||
|
|
||||||
|
A shared highlighter can be defined with the following command:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group /<group_name> …"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
When the group switch values starts with a
|
||||||
|
.IR / ","
|
||||||
|
it references a group in the shared highlighters, rather than the window highlighters.
|
||||||
|
|
||||||
|
The common case would be to create a named shared group, and then fill it with highlighters:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group / group <name>"
|
||||||
|
.TP
|
||||||
|
.BR addhl " -group /name regex …"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
It can then be referenced in a window using the ref highlighter.
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR addhl " ref <name>"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
The ref can reference any named highlighter in the shared namespace.
|
||||||
127
doc/manpages/hooks
Normal file
127
doc/manpages/hooks
Normal file
|
|
@ -0,0 +1,127 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "HOOKS"
|
||||||
|
|
||||||
|
.TP
|
||||||
|
Commands can be registred to be executed when certain events arise. To register a hook use the following command:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR hook " [-group <group>] <scope> <hook_name> <filtering_regex> <commands>"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
.IR <scope>
|
||||||
|
can be one of
|
||||||
|
.IR global ", " buffer " or " window
|
||||||
|
|
||||||
|
.IR <command>
|
||||||
|
is a string containing the commands to execute when the hook is called
|
||||||
|
|
||||||
|
For example to automatically use line numbering with .cc files, use the following command:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR hook " global WinCreate .*\.cc %{ addhl number_lines }"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
if
|
||||||
|
.IR <group>
|
||||||
|
is given, make this hook part of the named group. Groups are used for removing hooks with the following command:
|
||||||
|
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR rmhooks " <scope> <group>"
|
||||||
|
.RE
|
||||||
|
|
||||||
|
A call to the command above will remove every hooks in
|
||||||
|
.IR <scope>
|
||||||
|
that are part of the given group.
|
||||||
|
|
||||||
|
.SS Default hooks
|
||||||
|
.TP
|
||||||
|
.BR NormalIdle
|
||||||
|
a certain duration has passed since last key was pressed in normal mode
|
||||||
|
.TP
|
||||||
|
.BR NormalBegin
|
||||||
|
entering normal mode
|
||||||
|
.TP
|
||||||
|
.BR NormalEnd
|
||||||
|
leaving normal mode
|
||||||
|
.TP
|
||||||
|
.BR NormalKey
|
||||||
|
a key is received in normal mode, the key is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR InsertIdle
|
||||||
|
a certain duration has passed since last key was pressed in insert mode
|
||||||
|
.TP
|
||||||
|
.BR InsertBegin
|
||||||
|
entering insert mode
|
||||||
|
.TP
|
||||||
|
.BR InsertEnd
|
||||||
|
leaving insert mode
|
||||||
|
.TP
|
||||||
|
.BR InsertKey
|
||||||
|
a key is received in insert mode, the key is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR InsertMove
|
||||||
|
the cursor moved (without inserting) in insert mode, the key that triggered the move is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR WinCreate
|
||||||
|
a window was created, the filtering text is the buffer name
|
||||||
|
.TP
|
||||||
|
.BR WinClose
|
||||||
|
a window was detroyed, the filtering text is the buffer name
|
||||||
|
.TP
|
||||||
|
.BR WinDisplay
|
||||||
|
a window was bound a client, the filtering text is the buffer name
|
||||||
|
.TP
|
||||||
|
.BR WinSetOption
|
||||||
|
an option was set in a window context, the filtering text is
|
||||||
|
.IR <option_name>=<new_value>
|
||||||
|
.TP
|
||||||
|
.BR BufSetOption
|
||||||
|
an option was set in a buffer context, the filtering text is
|
||||||
|
.IR <option_name>=<new_value>
|
||||||
|
.TP
|
||||||
|
.BR BufNew
|
||||||
|
a buffer for a new file has been created, filename is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR BufOpen
|
||||||
|
a buffer for an existing file has been created, filename is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR BufCreate
|
||||||
|
a buffer has been created, filename is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR BufWritePre
|
||||||
|
executed just before a buffer is written, filename is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR BufWritePost
|
||||||
|
executed just after a buffer is written, filename is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR BufClose
|
||||||
|
executed when a buffer is deleted, while it is still valid
|
||||||
|
.TP
|
||||||
|
.BR BufOpenFifo
|
||||||
|
executed when a buffer opens a fifo
|
||||||
|
.TP
|
||||||
|
.BR BufReadFifo
|
||||||
|
executed after some data has been red from a fifo and inserted in the buffer
|
||||||
|
.TP
|
||||||
|
.BR BufCloseFifo
|
||||||
|
executed when a fifo buffer closes its fifo file descriptor either because the buffer is being deleted, or because the writing end has been closed
|
||||||
|
.TP
|
||||||
|
.BR RuntimeError
|
||||||
|
an error was encountered while executing an user command the error message is used for filtering
|
||||||
|
.TP
|
||||||
|
.BR KakBegin
|
||||||
|
kakoune has started, this hook is called just after reading the user configuration files
|
||||||
|
.TP
|
||||||
|
.BR KakEnd
|
||||||
|
kakoune is quitting
|
||||||
|
.TP
|
||||||
|
.BR FocusIn
|
||||||
|
on supported clients, triggered when the client gets focused. the filtering text is the client name
|
||||||
|
.TP
|
||||||
|
.BR FocusOut
|
||||||
|
on supported clients, triggered when the client gets unfocused. the filtering text is the client name
|
||||||
|
.RE
|
||||||
|
|
||||||
|
When not specified, the filtering text is an empty string.
|
||||||
181
doc/manpages/options
Normal file
181
doc/manpages/options
Normal file
|
|
@ -0,0 +1,181 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "OPTIONS"
|
||||||
|
|
||||||
|
.SS Types
|
||||||
|
.TP
|
||||||
|
.BR int
|
||||||
|
an integer number
|
||||||
|
.TP
|
||||||
|
.BR bool
|
||||||
|
a boolean value, yes/true or no/false
|
||||||
|
.TP
|
||||||
|
.BR str
|
||||||
|
a string, some freeform text
|
||||||
|
.TP
|
||||||
|
.BR coord
|
||||||
|
a line, column pair (separated by comma)
|
||||||
|
.TP
|
||||||
|
.BR regex
|
||||||
|
as a string but the set commands will complain if the entered text is not a valid regex
|
||||||
|
.TP
|
||||||
|
.BR int-list,\ str-list
|
||||||
|
a list, elements are separated by a colon (:) if an element needs to contain a colon, it can be escaped with a backslash
|
||||||
|
.TP
|
||||||
|
.BR enum(value1|value2|…)
|
||||||
|
an enum, taking one of the given values
|
||||||
|
.TP
|
||||||
|
.BR flags(value1|value2|…)
|
||||||
|
a set of flags, taking a combination of the given values joined by a '|' character
|
||||||
|
|
||||||
|
.SS Scopes
|
||||||
|
.TP
|
||||||
|
.BR window
|
||||||
|
context linked to the window displaying a buffer
|
||||||
|
.TP
|
||||||
|
.BR buffer
|
||||||
|
context linked directly to the buffer
|
||||||
|
.TP
|
||||||
|
.BR global
|
||||||
|
global context linked to the instance of Kakoune
|
||||||
|
.RE
|
||||||
|
|
||||||
|
Options can have individual values that change from one scope to the other, which will be considered one after another in the following order:
|
||||||
|
.IR window " → "
|
||||||
|
.IR buffer " → "
|
||||||
|
.IR global "."
|
||||||
|
That means that two windows on the same buffer can use different options (e.g. different
|
||||||
|
.IR filetype ")."
|
||||||
|
However some options might end up being ignored if their scope is not in the command context.
|
||||||
|
For example, writing a file never uses the
|
||||||
|
.IR window
|
||||||
|
scope when considering options, so any option related to writing won't be taken into account if set in the
|
||||||
|
.IR window
|
||||||
|
scope (e.g.
|
||||||
|
.IR BOM ", "
|
||||||
|
.IR eolformat ")."
|
||||||
|
|
||||||
|
.SS Builtin options
|
||||||
|
.TP
|
||||||
|
.BR tabstop
|
||||||
|
.IR int
|
||||||
|
width of a tab character
|
||||||
|
.TP
|
||||||
|
.BR indentwidth
|
||||||
|
.IR int
|
||||||
|
width (in spaces) used for indentation, 0 means a tab character
|
||||||
|
.TP
|
||||||
|
.BR scrolloff
|
||||||
|
.IR coord
|
||||||
|
number of lines, columns to keep visible around the cursor when scrolling
|
||||||
|
.TP
|
||||||
|
.BR eolformat
|
||||||
|
.IR enum(lf|crlf)
|
||||||
|
the format of end of lines when writing a buffer, this is autodetected on load
|
||||||
|
.TP
|
||||||
|
.BR BOM
|
||||||
|
.IR enum(none|utf8)
|
||||||
|
define if the file should be written with an unicode byte order mark
|
||||||
|
.TP
|
||||||
|
.BR complete_prefix
|
||||||
|
.IR bool
|
||||||
|
when completing in command line, and multiple candidates exist, enable completion with common prefix
|
||||||
|
.TP
|
||||||
|
.BR incsearch
|
||||||
|
.IR bool
|
||||||
|
execute search as it is typed
|
||||||
|
.TP
|
||||||
|
.BR aligntab
|
||||||
|
.IR bool
|
||||||
|
use tabs for alignement command
|
||||||
|
.TP
|
||||||
|
.BR autoinfo
|
||||||
|
.IR flags(command|onkey|normal)
|
||||||
|
display automatic information box in the enabled contexts
|
||||||
|
.TP
|
||||||
|
.BR autoshowcompl
|
||||||
|
.IR bool
|
||||||
|
automatically display possible completions when editing a prompt
|
||||||
|
.TP
|
||||||
|
.BR ignored_files
|
||||||
|
.IR regex
|
||||||
|
filenames matching this regex wont be considered as candidates on filename completion (except if the text being completed already matches it)
|
||||||
|
.TP
|
||||||
|
.BR disabled_hooks
|
||||||
|
.IR regex
|
||||||
|
hooks whose group matches this regex wont be executed. For example indentation hooks can be disabled with '.*-indent'
|
||||||
|
.TP
|
||||||
|
.BR filetype
|
||||||
|
.IR str
|
||||||
|
arbitrary string defining the type of the file filetype dependant actions should hook on this option changing for activation/deactivation
|
||||||
|
.TP
|
||||||
|
.BR path
|
||||||
|
.IR str-list
|
||||||
|
directories to search for gf command
|
||||||
|
.TP
|
||||||
|
.BR completers
|
||||||
|
.IR str-list
|
||||||
|
completion engines to use for insert mode completion (they are tried in order until one generates candidates). Existing completers are:
|
||||||
|
.TP
|
||||||
|
.BR word=all,\ word=buffer
|
||||||
|
which complete using words in all buffers (
|
||||||
|
.IR word=all " )"
|
||||||
|
or only the current one (
|
||||||
|
.IR word=buffer " )"
|
||||||
|
.TP
|
||||||
|
.BR filename
|
||||||
|
which tries to detect when a filename is being entered and provides completion based on local filesystem
|
||||||
|
.TP
|
||||||
|
.BR option=<opt-name>
|
||||||
|
where
|
||||||
|
.IR <opt-name>
|
||||||
|
is a
|
||||||
|
.IR str-list
|
||||||
|
option. The first element of the list should follow the format:
|
||||||
|
.IR <line>.<column>[+<length>]@<timestamp>
|
||||||
|
to define where the completion apply in the buffer, and the other strings are the candidates
|
||||||
|
.TP
|
||||||
|
.BR static_words
|
||||||
|
.IR str-list
|
||||||
|
list of words that are always added to completion candidates when completing words in insert mode
|
||||||
|
.TP
|
||||||
|
.BR autoreload
|
||||||
|
.IR enum(yes|no|ask)
|
||||||
|
auto reload the buffers when an external modification is detected
|
||||||
|
.TP
|
||||||
|
.BR debug
|
||||||
|
.IR flags(hooks|shell|profile)
|
||||||
|
dump various debug information in the `*debug*` buffer
|
||||||
|
.TP
|
||||||
|
.BR modelinefmt
|
||||||
|
.IR string
|
||||||
|
A format string used to generate the mode line, that string is first expanded as a command line would be (expanding
|
||||||
|
.IR %...{...}
|
||||||
|
strings), then markup tags are applied (c.f. Expansions documentation page)
|
||||||
|
.TP
|
||||||
|
.BR ui_options
|
||||||
|
colon separated list of key=value pairs that are forwarded to the user interface implementation. The NCurses UI support the following options:
|
||||||
|
|
||||||
|
.RS 7
|
||||||
|
.BR ncurses_set_title
|
||||||
|
if
|
||||||
|
.IR yes
|
||||||
|
or
|
||||||
|
.IR true ","
|
||||||
|
the terminal emulator title will be changed
|
||||||
|
.TP
|
||||||
|
.BR ncurses_status_on_top
|
||||||
|
if
|
||||||
|
.IR yes ","
|
||||||
|
or
|
||||||
|
.IR true
|
||||||
|
the status line will be placed at the top of the terminal rather than at the bottom
|
||||||
|
.TP
|
||||||
|
.BR ncurses_assistant
|
||||||
|
specify the nice assistant you get in info boxes, can be
|
||||||
|
.IR clippy
|
||||||
|
(the default),
|
||||||
|
.IR cat
|
||||||
|
or
|
||||||
|
.IR none
|
||||||
|
.TP
|
||||||
|
.BR ncurses_wheel_down_button,\ ncurses_wheel_up_button
|
||||||
|
specify which button send for wheel down/up events
|
||||||
56
doc/manpages/registers
Normal file
56
doc/manpages/registers
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "REGISTERS"
|
||||||
|
|
||||||
|
.SS Registers
|
||||||
|
.TP
|
||||||
|
Registers are named lists of text -instead of simply text- in order to interact well with multiselection. \
|
||||||
|
They are used for various purposes, like storing the last yanked test, or the captured groups associated with the selections.
|
||||||
|
|
||||||
|
.SS Interacting
|
||||||
|
.TP
|
||||||
|
.BR <c-r><c>
|
||||||
|
when in insert mode or in a prompt, insert the value stored in the
|
||||||
|
.IR <c>
|
||||||
|
register (single character)
|
||||||
|
.TP
|
||||||
|
.BR """<c>
|
||||||
|
in normal mode, select the
|
||||||
|
.IR <c>
|
||||||
|
register (single character)
|
||||||
|
|
||||||
|
.SS Default registers
|
||||||
|
.TP
|
||||||
|
Most commands using a register default to a specific one if not specified:
|
||||||
|
|
||||||
|
.RS 7
|
||||||
|
.TP
|
||||||
|
.BR """
|
||||||
|
default yank, used by yanking and pasting commands like
|
||||||
|
.IR y ", " p " and " R
|
||||||
|
.TP
|
||||||
|
.BR /
|
||||||
|
default search register, used by regex based commands like
|
||||||
|
.IR s ", " * " or " /
|
||||||
|
.TP
|
||||||
|
.BR @
|
||||||
|
default macro register, used by
|
||||||
|
.IR q " and " Q
|
||||||
|
.TP
|
||||||
|
.BR ^
|
||||||
|
default mark register, used by
|
||||||
|
.IR z " and " Z
|
||||||
|
|
||||||
|
.SS Special registers
|
||||||
|
.TP
|
||||||
|
Some registers are not general purposes, they cannot be written to, but they contain some special dat
|
||||||
|
|
||||||
|
.RS 7
|
||||||
|
.TP
|
||||||
|
.BR %
|
||||||
|
current buffer name
|
||||||
|
.TP
|
||||||
|
.BR .
|
||||||
|
current selection contents
|
||||||
|
.TP
|
||||||
|
.BR #
|
||||||
|
selection indices (first selection has 1, second has 2, …)
|
||||||
|
.RE
|
||||||
571
doc/manpages/shortcuts
Normal file
571
doc/manpages/shortcuts
Normal file
|
|
@ -0,0 +1,571 @@
|
||||||
|
.TH KAKOUNE 1 "" "" "SHORTCUTS"
|
||||||
|
|
||||||
|
.SS Insert mode
|
||||||
|
.TP
|
||||||
|
.BR <esc>
|
||||||
|
leave insert mode
|
||||||
|
.TP
|
||||||
|
.BR <backspace>
|
||||||
|
delete characters before cursors
|
||||||
|
.TP
|
||||||
|
.BR <del>
|
||||||
|
delete characters under cursors
|
||||||
|
.TP
|
||||||
|
.BR <left>,\ <right>,\ <up>,\ <down>
|
||||||
|
move the cursors in given direction
|
||||||
|
.TP
|
||||||
|
.BR <home>
|
||||||
|
move cursors to line begin
|
||||||
|
.TP
|
||||||
|
.BR <end>
|
||||||
|
move cursors to end of line
|
||||||
|
.TP
|
||||||
|
.BR <c-n>
|
||||||
|
select next completion candidate
|
||||||
|
.TP
|
||||||
|
.BR <c-p>
|
||||||
|
select previous completion candidate
|
||||||
|
.TP
|
||||||
|
.BR <c-x>
|
||||||
|
explicit insert completion query, followed by:
|
||||||
|
.RS 7
|
||||||
|
.TP
|
||||||
|
.BR f
|
||||||
|
explicit file completion
|
||||||
|
.TP
|
||||||
|
.BR w
|
||||||
|
explicit word completion
|
||||||
|
.TP
|
||||||
|
.BR l
|
||||||
|
explicit line completion
|
||||||
|
.RE
|
||||||
|
.TP
|
||||||
|
.BR <c-o>
|
||||||
|
disable automatic completion for this insert session
|
||||||
|
.TP
|
||||||
|
.BR <c-r>
|
||||||
|
insert contents of the register given by next key
|
||||||
|
.TP
|
||||||
|
.BR <c-v>
|
||||||
|
insert next keystroke directly into the buffer, without interpreting it
|
||||||
|
.TP
|
||||||
|
.BR <c-u>
|
||||||
|
commit changes up to now as a single undo group
|
||||||
|
.TP
|
||||||
|
.BR <a-;>
|
||||||
|
escape to normal mode for a single command
|
||||||
|
|
||||||
|
.SS Movement
|
||||||
|
"word" is a sequence of alphanumeric characters or underscore, and "WORD" is a sequence of non whitespace characters
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BR h
|
||||||
|
select the character on the left of selection end
|
||||||
|
.TP
|
||||||
|
.BR j
|
||||||
|
select the character below the selection end
|
||||||
|
.TP
|
||||||
|
.BR k
|
||||||
|
select the character above the selection end
|
||||||
|
.TP
|
||||||
|
.BR l
|
||||||
|
select the character on the right of selection end
|
||||||
|
.TP
|
||||||
|
.BR w
|
||||||
|
select the word and following whitespaces on the right of selection end
|
||||||
|
.TP
|
||||||
|
.BR b
|
||||||
|
select preceding whitespaces and the word on the left of selection end
|
||||||
|
.TP
|
||||||
|
.BR e
|
||||||
|
select preceding whitespaces and the word on the right of selection end
|
||||||
|
.TP
|
||||||
|
.BR <a-[wbe]>
|
||||||
|
same as [wbe] but select WORD instead of word
|
||||||
|
.TP
|
||||||
|
.BR m
|
||||||
|
select to matching character
|
||||||
|
.TP
|
||||||
|
.BR M
|
||||||
|
extend selection to matching character
|
||||||
|
.TP
|
||||||
|
.BR x
|
||||||
|
select line on which selection end lies (or next line when end lies on an end-of-line)
|
||||||
|
.TP
|
||||||
|
.BR <a-x>
|
||||||
|
expand selections to contain full lines (including end-of-lines)
|
||||||
|
.TP
|
||||||
|
.BR <a-X>
|
||||||
|
trim selections to only contain full lines (not including last end-of-line)
|
||||||
|
.TP
|
||||||
|
.BR %
|
||||||
|
select whole buffer
|
||||||
|
.TP
|
||||||
|
.BR <a-h>
|
||||||
|
select to line begin
|
||||||
|
.TP
|
||||||
|
.BR <a-l>
|
||||||
|
select to line end
|
||||||
|
.TP
|
||||||
|
.BR /
|
||||||
|
search (select next match)
|
||||||
|
.TP
|
||||||
|
.BR <a-/>
|
||||||
|
search (select previous match)
|
||||||
|
.TP
|
||||||
|
.BR ?
|
||||||
|
search (extend to next match)
|
||||||
|
.TP
|
||||||
|
.BR <a-?>
|
||||||
|
search (extend to previous match)
|
||||||
|
.TP
|
||||||
|
.BR n
|
||||||
|
select next match
|
||||||
|
.TP
|
||||||
|
.BR N
|
||||||
|
add a new selection with next match
|
||||||
|
.TP
|
||||||
|
.BR <a-n>
|
||||||
|
select previous match
|
||||||
|
.TP
|
||||||
|
.BR <a-N>
|
||||||
|
add a new selection with previous match
|
||||||
|
.TP
|
||||||
|
.BR pageup
|
||||||
|
scroll up
|
||||||
|
.TP
|
||||||
|
.BR pagedown
|
||||||
|
scroll down
|
||||||
|
.TP
|
||||||
|
.BR '
|
||||||
|
rotate selections (the main selection becomes the next one)
|
||||||
|
.TP
|
||||||
|
.BR ;
|
||||||
|
reduce selections to their cursor
|
||||||
|
.TP
|
||||||
|
.BR <a-;>
|
||||||
|
flip the selections direction
|
||||||
|
.TP
|
||||||
|
.BR <a-:>
|
||||||
|
ensure selections are in forward direction (cursor after anchor)
|
||||||
|
|
||||||
|
.SS Changes
|
||||||
|
.TP
|
||||||
|
.BR i
|
||||||
|
enter insert mode before current selection
|
||||||
|
.TP
|
||||||
|
.BR a
|
||||||
|
enter insert mode after current selection
|
||||||
|
.TP
|
||||||
|
.BR d
|
||||||
|
yank and delete current selection
|
||||||
|
.TP
|
||||||
|
.BR c
|
||||||
|
yank and delete current selection and enter insert mode
|
||||||
|
.TP
|
||||||
|
.BR .
|
||||||
|
repeat last insert mode change (`i`, `a`, or `c, including the inserted text)
|
||||||
|
.TP
|
||||||
|
.BR I
|
||||||
|
enter insert mode at current selection begin line start
|
||||||
|
.TP
|
||||||
|
.BR A
|
||||||
|
enter insert mode at current selection end line end
|
||||||
|
.TP
|
||||||
|
.BR o
|
||||||
|
enter insert mode in a new line below current selection end
|
||||||
|
.TP
|
||||||
|
.BR O
|
||||||
|
enter insert mode in a new line above current selection begin
|
||||||
|
.TP
|
||||||
|
.BR y
|
||||||
|
yank selections
|
||||||
|
.TP
|
||||||
|
.BR p
|
||||||
|
paste after current selection end
|
||||||
|
.TP
|
||||||
|
.BR P
|
||||||
|
paste before current selection begin
|
||||||
|
.TP
|
||||||
|
.BR <a-p>
|
||||||
|
paste all after current selection end, and select each pasted string
|
||||||
|
.TP
|
||||||
|
.BR <a-P>
|
||||||
|
paste all before current selection begin, and select each pasted string
|
||||||
|
.TP
|
||||||
|
.BR R
|
||||||
|
replace current selection with yanked text
|
||||||
|
.TP
|
||||||
|
.BR r
|
||||||
|
replace each character with the next entered one
|
||||||
|
.TP
|
||||||
|
.BR <a-j>
|
||||||
|
join selected lines
|
||||||
|
.TP
|
||||||
|
.BR <a-J>
|
||||||
|
join selected lines and select spaces inserted in place of line breaks
|
||||||
|
.TP
|
||||||
|
.BR >
|
||||||
|
indent selected lines
|
||||||
|
.TP
|
||||||
|
.BR <a->>
|
||||||
|
indent selected lines, including empty lines
|
||||||
|
.TP
|
||||||
|
.BR <
|
||||||
|
deindent selected lines
|
||||||
|
.TP
|
||||||
|
.BR <a-<>
|
||||||
|
deindent selected lines, do not remove incomplete indent (3 leading spaces when indent is 4)
|
||||||
|
.TP
|
||||||
|
.BR !
|
||||||
|
insert command output before selection
|
||||||
|
.TP
|
||||||
|
.BR a-!
|
||||||
|
append command output after selection
|
||||||
|
.TP
|
||||||
|
.BR u
|
||||||
|
undo last change
|
||||||
|
.TP
|
||||||
|
.BR U
|
||||||
|
redo last change
|
||||||
|
.TP
|
||||||
|
.BR &
|
||||||
|
align selection, align the cursor of selections by inserting spaces before the first character of the selection
|
||||||
|
.TP
|
||||||
|
.BR <a-&>
|
||||||
|
copy indent, copy the indentation of the main selection (or the count one if a count is given) to all other ones
|
||||||
|
.TP
|
||||||
|
.BR `
|
||||||
|
to lower case
|
||||||
|
.TP
|
||||||
|
.BR ~
|
||||||
|
to upper case
|
||||||
|
.TP
|
||||||
|
.BR <a-`>
|
||||||
|
swap case
|
||||||
|
.TP
|
||||||
|
.BR @
|
||||||
|
convert tabs to spaces in current selections, uses the buffer tabstop option or the count parameter for tabstop
|
||||||
|
.TP
|
||||||
|
.BR <a-@>
|
||||||
|
convert spaces to tabs in current selections, uses the buffer tabstop option or the count parameter for tabstop
|
||||||
|
.TP
|
||||||
|
.BR <a-'>
|
||||||
|
rotate selections content, if specified, the count groups selections, so
|
||||||
|
.IR 3<a-'>
|
||||||
|
rotate (1, 2, 3) and (3, 4, 6) independently
|
||||||
|
|
||||||
|
.SS Goto Commands
|
||||||
|
If a count is given prior to hitting `g`, `g` will jump to the given line
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BR gh
|
||||||
|
select to line begin
|
||||||
|
.TP
|
||||||
|
.BR gl
|
||||||
|
select to line end
|
||||||
|
.TP
|
||||||
|
.BR gg,\ gk
|
||||||
|
go to the first line
|
||||||
|
.TP
|
||||||
|
.BR gj
|
||||||
|
go to the last line
|
||||||
|
.TP
|
||||||
|
.BR ge
|
||||||
|
go to last char of last line
|
||||||
|
.TP
|
||||||
|
.BR gt
|
||||||
|
go to the first displayed line
|
||||||
|
.TP
|
||||||
|
.BR gc
|
||||||
|
go to the middle displayed line
|
||||||
|
.TP
|
||||||
|
.BR gb
|
||||||
|
go to the last displayed line
|
||||||
|
.TP
|
||||||
|
.BR ga
|
||||||
|
go to the previous (alternate) buffer
|
||||||
|
.TP
|
||||||
|
.BR gf
|
||||||
|
open the file whose name is selected
|
||||||
|
.TP
|
||||||
|
.BR g.
|
||||||
|
go to last buffer modifiction position
|
||||||
|
|
||||||
|
.SS View commands
|
||||||
|
.TP
|
||||||
|
.BR V
|
||||||
|
lock view mode until <esc> is hit
|
||||||
|
.TP
|
||||||
|
.BR vv,\ vc
|
||||||
|
center the main selection in the window
|
||||||
|
.TP
|
||||||
|
.BR vt
|
||||||
|
scroll to put the main selection on the top line of the window
|
||||||
|
.TP
|
||||||
|
.BR vb
|
||||||
|
scroll to put the main selection on the bottom line of the window
|
||||||
|
.TP
|
||||||
|
.BR vh
|
||||||
|
scroll the window count columns left
|
||||||
|
.TP
|
||||||
|
.BR vj
|
||||||
|
scroll the window count line downward
|
||||||
|
.TP
|
||||||
|
.BR vk
|
||||||
|
scroll the window count line upward
|
||||||
|
.TP
|
||||||
|
.BR vl
|
||||||
|
scroll the window count columns right
|
||||||
|
|
||||||
|
|
||||||
|
.SS Marks
|
||||||
|
Marks use the
|
||||||
|
.IR ^
|
||||||
|
register by default
|
||||||
|
.TP
|
||||||
|
.BR Z
|
||||||
|
will save the current selections to the register
|
||||||
|
.TP
|
||||||
|
.BR z
|
||||||
|
will restore the selections from the register
|
||||||
|
.TP
|
||||||
|
.BR <a-z>
|
||||||
|
will add the selections from the register to the existing ones
|
||||||
|
|
||||||
|
.SS Macros
|
||||||
|
Macros use the
|
||||||
|
.IR @
|
||||||
|
register by default
|
||||||
|
.TP
|
||||||
|
.BR Q
|
||||||
|
record a macro
|
||||||
|
.TP
|
||||||
|
.BR q
|
||||||
|
play a recorded macro
|
||||||
|
|
||||||
|
.SS Searching
|
||||||
|
Searches use the
|
||||||
|
.IR /
|
||||||
|
register by default
|
||||||
|
.TP
|
||||||
|
.BR *
|
||||||
|
set the search pattern to the current selection (automatically detects word boundaries)
|
||||||
|
.TP
|
||||||
|
.BR <a-*>
|
||||||
|
set the search pattern to the current selection (verbatim, no smart detection)
|
||||||
|
|
||||||
|
.SS Jump list
|
||||||
|
.TP
|
||||||
|
.BR <c-i>
|
||||||
|
Jump forward
|
||||||
|
.TP
|
||||||
|
.BR <c-o>
|
||||||
|
Jump backward
|
||||||
|
.TP
|
||||||
|
.BR <c-s>
|
||||||
|
save current selections
|
||||||
|
|
||||||
|
.SS Multiple selections
|
||||||
|
.TP
|
||||||
|
.BR s
|
||||||
|
create a selection
|
||||||
|
.TP
|
||||||
|
.BR <a-s>
|
||||||
|
split the current selections on line boundaries
|
||||||
|
.TP
|
||||||
|
.BR S
|
||||||
|
split the current selection
|
||||||
|
.TP
|
||||||
|
.BR C
|
||||||
|
copy the current selection to the next line
|
||||||
|
.TP
|
||||||
|
.BR <a-C>
|
||||||
|
copy the current selection to the previous line
|
||||||
|
.TP
|
||||||
|
.BR <space>
|
||||||
|
clear a multiple selection
|
||||||
|
.TP
|
||||||
|
.BR <a-space>
|
||||||
|
clear the current selection
|
||||||
|
.TP
|
||||||
|
.BR <a-k>
|
||||||
|
keep the selections that match the given regex
|
||||||
|
.TP
|
||||||
|
.BR <a-K>
|
||||||
|
clear selections that match the given regex
|
||||||
|
.TP
|
||||||
|
.BR |
|
||||||
|
pipe each selection through the given external filter program and replace the selection with its output
|
||||||
|
.TP
|
||||||
|
.BR <a-|>
|
||||||
|
pipe each selection through the given external filter program and ignore its output
|
||||||
|
.TP
|
||||||
|
.BR $
|
||||||
|
pipe each selection to the given shell command
|
||||||
|
|
||||||
|
.SS Object Selection
|
||||||
|
.TP
|
||||||
|
.BR <a-a>
|
||||||
|
selects the whole object
|
||||||
|
.TP
|
||||||
|
.BR <a-i>
|
||||||
|
selects the inner object, that is the object excluding it's surrounder
|
||||||
|
.TP
|
||||||
|
.BR [
|
||||||
|
selects to object start
|
||||||
|
.TP
|
||||||
|
.BR ]
|
||||||
|
selects to object end
|
||||||
|
.TP
|
||||||
|
.BR {
|
||||||
|
extends selections to object start
|
||||||
|
.TP
|
||||||
|
.BR }
|
||||||
|
extends selections to object end
|
||||||
|
.RE
|
||||||
|
|
||||||
|
After this key, you need to enter a second key in order to specify which object you want
|
||||||
|
.TP
|
||||||
|
.BR b,\ (,\ )
|
||||||
|
select the enclosing parenthesis
|
||||||
|
.TP
|
||||||
|
.BR B,\ {,\ }
|
||||||
|
select the enclosing {} block
|
||||||
|
.TP
|
||||||
|
.BR r,\ [,\ ]
|
||||||
|
select the enclosing [] block
|
||||||
|
.TP
|
||||||
|
.BR a,\ <,\ >
|
||||||
|
select the enclosing <> block
|
||||||
|
.TP
|
||||||
|
.BR "
|
||||||
|
select the enclosing double quoted string
|
||||||
|
.TP
|
||||||
|
.BR '
|
||||||
|
select the enclosing single quoted string
|
||||||
|
.TP
|
||||||
|
.BR `
|
||||||
|
select the enclosing grave quoted string
|
||||||
|
.TP
|
||||||
|
.BR w
|
||||||
|
select the whole word
|
||||||
|
.TP
|
||||||
|
.BR W
|
||||||
|
select the whole WORD
|
||||||
|
.TP
|
||||||
|
.BR s
|
||||||
|
select the sentence
|
||||||
|
.TP
|
||||||
|
.BR p
|
||||||
|
select the paragraph
|
||||||
|
.TP
|
||||||
|
.BR ␣
|
||||||
|
select the whitespaces
|
||||||
|
.TP
|
||||||
|
.BR i
|
||||||
|
select the current indentation block
|
||||||
|
.TP
|
||||||
|
.BR n
|
||||||
|
select the number
|
||||||
|
.TP
|
||||||
|
.BR :
|
||||||
|
select user defined object, will prompt for open and close text
|
||||||
|
|
||||||
|
.SS Prompt Commands
|
||||||
|
.TP
|
||||||
|
.BR <ret>
|
||||||
|
validate prompt
|
||||||
|
.TP
|
||||||
|
.BR <esc>
|
||||||
|
abandon without
|
||||||
|
.TP
|
||||||
|
.BR <left>,\ <a-h>
|
||||||
|
move cursor to previous character
|
||||||
|
.TP
|
||||||
|
.BR <right>,\ <a-l>
|
||||||
|
move cursor to previous character
|
||||||
|
.TP
|
||||||
|
.BR <home>
|
||||||
|
move cursor to first character
|
||||||
|
.TP
|
||||||
|
.BR <end>
|
||||||
|
move cursor to passed last character
|
||||||
|
.TP
|
||||||
|
.BR <backspace>,\ <a-x>
|
||||||
|
erase character before cursor
|
||||||
|
.TP
|
||||||
|
.BR <del>,\ <a-d>
|
||||||
|
erase character under cursor
|
||||||
|
.TP
|
||||||
|
.BR <c-w>
|
||||||
|
avance to next word begin
|
||||||
|
.TP
|
||||||
|
.BR <c-a-w>
|
||||||
|
advance to next WORD begin
|
||||||
|
.TP
|
||||||
|
.BR <c-b>
|
||||||
|
go back to previous word begin
|
||||||
|
.TP
|
||||||
|
.BR <c-a-b>
|
||||||
|
go back to previous WORD begin
|
||||||
|
.TP
|
||||||
|
.BR <c-e>
|
||||||
|
advance to next word end
|
||||||
|
.TP
|
||||||
|
.BR <c-a-e>
|
||||||
|
advance to next word end
|
||||||
|
.TP
|
||||||
|
.BR <up>,\ <c-p>
|
||||||
|
select previous entry in history
|
||||||
|
.TP
|
||||||
|
.BR <down>,\ <c-n>
|
||||||
|
select next entry in history
|
||||||
|
.TP
|
||||||
|
.BR <tab>
|
||||||
|
select next completion candidate
|
||||||
|
.TP
|
||||||
|
.BR <backtab>
|
||||||
|
select previous completion candidate
|
||||||
|
.TP
|
||||||
|
.BR <c-r>
|
||||||
|
insert then content of the register given by next key
|
||||||
|
.TP
|
||||||
|
.BR <c-v>
|
||||||
|
insert next keystroke without interpretting it
|
||||||
|
.TP
|
||||||
|
.BR <c-o>
|
||||||
|
disable auto completion for this prompt
|
||||||
|
|
||||||
|
.SS Key mapping
|
||||||
|
Mapping a combination of keys to another one (a.k.a. key mapping or binding) can be done with the following command:
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.BR map " <scope> <mode> <key> <keys>"
|
||||||
|
.RS 3
|
||||||
|
.TP
|
||||||
|
.BR scope
|
||||||
|
can be one of
|
||||||
|
.IR global ", " window " or " buffer
|
||||||
|
.TP
|
||||||
|
.BR mode
|
||||||
|
can be one of
|
||||||
|
.IR insert ", " normal ", " prompt ", " menu ", " user
|
||||||
|
or a one character long arbitrary prefix (the
|
||||||
|
.IR user
|
||||||
|
mode uses the
|
||||||
|
.IR ,
|
||||||
|
prefix)
|
||||||
|
.TP
|
||||||
|
.BR key
|
||||||
|
the key to which the combination will be bound
|
||||||
|
.TP
|
||||||
|
.BR keys
|
||||||
|
string that lists the keys that will be executed when
|
||||||
|
.IR key
|
||||||
|
is hit
|
||||||
|
.RE
|
||||||
|
|
||||||
|
Keys are always executed within the
|
||||||
|
.IR normal
|
||||||
|
mode
|
||||||
49
rc/doc.kak
Normal file
49
rc/doc.kak
Normal file
|
|
@ -0,0 +1,49 @@
|
||||||
|
|
||||||
|
decl str doc_path "/usr/share/doc/kak/manpages"
|
||||||
|
|
||||||
|
def -hidden -params 1..2 _doc-open %{
|
||||||
|
%sh{
|
||||||
|
manout=$(mktemp /tmp/kak-man-XXXXXX)
|
||||||
|
colout=$(mktemp /tmp/kak-man-XXXXXX)
|
||||||
|
|
||||||
|
MANWIDTH=${kak_window_width} man -l "$1" > $manout
|
||||||
|
retval=$?
|
||||||
|
|
||||||
|
col -b -x > ${colout} < ${manout}
|
||||||
|
rm ${manout}
|
||||||
|
|
||||||
|
if [ "${retval}" -eq 0 ]; then
|
||||||
|
echo "
|
||||||
|
edit! -scratch '*doc*'
|
||||||
|
exec |cat<space>${colout}<ret>gg
|
||||||
|
nop %sh{rm ${colout}}
|
||||||
|
set buffer filetype man
|
||||||
|
"
|
||||||
|
|
||||||
|
if [ $# -gt 1 ]; then
|
||||||
|
echo "try %{ exec '%<a-s><a-k>^\s+\S*\Q${2}\E<ret>\'' } catch %{ exec <space>gg }"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
echo "echo -color Error %{doc '$@' failed: see *debug* buffer for details}"
|
||||||
|
rm ${colout}
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
def -params 1..2 \
|
||||||
|
-shell-completion %{
|
||||||
|
find "${kak_opt_doc_path}" -type f -iname "*$@*" -printf '%f\n'
|
||||||
|
} \
|
||||||
|
doc -docstring "Open a buffer containing the documentation about a given subject" %{
|
||||||
|
%sh{
|
||||||
|
readonly PATH_DOC="${kak_opt_doc_path}/${1}"
|
||||||
|
|
||||||
|
shift
|
||||||
|
if [ ! -f "${PATH_DOC}" ]; then
|
||||||
|
echo "echo -color Error No such doc file: ${PATH_DOC}"
|
||||||
|
exit
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "eval -try-client %opt{docsclient} _doc-open ${PATH_DOC} $@"
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user