Docs: fix asciidoc list formatting issue
This commit is contained in:
parent
4043b552ee
commit
f2837442fc
|
@ -4,9 +4,11 @@
|
||||||
|
|
||||||
\'strings'::
|
\'strings'::
|
||||||
uninterpreted strings, use a backslash (\') to escape the separator
|
uninterpreted strings, use a backslash (\') to escape the separator
|
||||||
|
|
||||||
"strings"::
|
"strings"::
|
||||||
expanded strings, % strings (c.f. next section) contained are expended,
|
expanded strings, % strings (c.f. next section) contained are expended,
|
||||||
use a backslash (\\%) to escape the separator
|
use a backslash (\\%) to escape the separator
|
||||||
|
|
||||||
%\{strings\}::
|
%\{strings\}::
|
||||||
these strings are very useful when entering commands
|
these strings are very useful when entering commands
|
||||||
+
|
+
|
||||||
|
@ -34,16 +36,20 @@ parameter:
|
||||||
*sh*::
|
*sh*::
|
||||||
shell expansion, similar to posix shell '$(...)' construct (c.f. next
|
shell expansion, similar to posix shell '$(...)' construct (c.f. next
|
||||||
section)
|
section)
|
||||||
|
|
||||||
*reg*::
|
*reg*::
|
||||||
register expansion, will expand to the content of the register named
|
register expansion, will expand to the content of the register named
|
||||||
by *<content>*.
|
by *<content>*. See <<registers#,`:doc registers`>>
|
||||||
|
|
||||||
*opt*::
|
*opt*::
|
||||||
option expansion, will expand to the value of the option named by
|
option expansion, will expand to the value of the option named by
|
||||||
*<content>*
|
*<content>*. See <<options#,`:doc options`>>
|
||||||
|
|
||||||
*val*::
|
*val*::
|
||||||
value expansion, will expand to the value of the environment variables
|
value expansion, will expand to the value of the environment variables
|
||||||
available to shell expansion. *<content>* shall be the name of that
|
available to shell expansion. *<content>* shall be the name of that
|
||||||
variable without the *kak_* prefix.
|
variable without the *kak_* prefix.
|
||||||
|
|
||||||
*arg*::
|
*arg*::
|
||||||
argument expansion, expand to the arguments of the current
|
argument expansion, expand to the arguments of the current
|
||||||
command, *<content>* can be a number, or @ for all arguments
|
command, *<content>* can be a number, or @ for all arguments
|
||||||
|
@ -56,76 +62,108 @@ informations about Kakoune's state:
|
||||||
|
|
||||||
*kak_selection*::
|
*kak_selection*::
|
||||||
content of the main selection
|
content of the main selection
|
||||||
|
|
||||||
*kak_selections*::
|
*kak_selections*::
|
||||||
content of the selection separated by colons, colons in the selection
|
content of the selection separated by colons, colons in the selection
|
||||||
contents are escaped with a backslash
|
contents are escaped with a backslash
|
||||||
|
|
||||||
*kak_selection_desc*::
|
*kak_selection_desc*::
|
||||||
range of the main selection, represented as anchor,cursor; anchor
|
range of the main selection, represented as anchor,cursor; anchor
|
||||||
and cursor are in this format: line.column
|
and cursor are in this format: line.column
|
||||||
|
|
||||||
*kak_selections_desc*::
|
*kak_selections_desc*::
|
||||||
range of the selections separated by colons
|
range of the selections separated by colons
|
||||||
|
|
||||||
*kak_bufname*::
|
*kak_bufname*::
|
||||||
name of the current buffer
|
name of the current buffer
|
||||||
|
|
||||||
*kak_buffile*::
|
*kak_buffile*::
|
||||||
full path of the file or same as kak_bufname when there’s no
|
full path of the file or same as kak_bufname when there’s no
|
||||||
associated file
|
associated file
|
||||||
|
|
||||||
*kak_buflist*::
|
*kak_buflist*::
|
||||||
the current buffer list, each buffer separated by a colon
|
the current buffer list, each buffer separated by a colon
|
||||||
|
|
||||||
*kak_buf_line_count*::
|
*kak_buf_line_count*::
|
||||||
the current buffer line count
|
the current buffer line count
|
||||||
|
|
||||||
*kak_timestamp*::
|
*kak_timestamp*::
|
||||||
timestamp of the current buffer, the timestamp is an integer value
|
timestamp of the current buffer, the timestamp is an integer value
|
||||||
which is incremented each time the buffer is modified
|
which is incremented each time the buffer is modified
|
||||||
|
|
||||||
*kak_history_id*::
|
*kak_history_id*::
|
||||||
history id of the current buffer, the history id is an integer value
|
history id of the current buffer, the history id is an integer value
|
||||||
which is used to reference a specific buffer version in the undo tree
|
which is used to reference a specific buffer version in the undo tree
|
||||||
|
|
||||||
*kak_runtime*::
|
*kak_runtime*::
|
||||||
directory containing the kak support files, determined from kakoune's
|
directory containing the kak support files, determined from kakoune's
|
||||||
binary location.
|
binary location.
|
||||||
|
|
||||||
*kak_config*::
|
*kak_config*::
|
||||||
directory containing the user configuration
|
directory containing the user configuration
|
||||||
|
|
||||||
*kak_count*::
|
*kak_count*::
|
||||||
count parameter passed to the command
|
count parameter passed to the command
|
||||||
|
|
||||||
*kak_register*::
|
*kak_register*::
|
||||||
register parameter passed to the command
|
register parameter passed to the command
|
||||||
|
|
||||||
*kak_opt_<name>*::
|
*kak_opt_<name>*::
|
||||||
value of option *name*
|
value of option *name*
|
||||||
|
|
||||||
*kak_reg_<r>*::
|
*kak_reg_<r>*::
|
||||||
value of register *r*
|
value of register *r*
|
||||||
|
|
||||||
*kak_session*::
|
*kak_session*::
|
||||||
name of the current session
|
name of the current session
|
||||||
|
|
||||||
*kak_client*::
|
*kak_client*::
|
||||||
name of the current client
|
name of the current client
|
||||||
|
|
||||||
*kak_client_pid*::
|
*kak_client_pid*::
|
||||||
process id of the current client
|
process id of the current client
|
||||||
|
|
||||||
*kak_client_list*::
|
*kak_client_list*::
|
||||||
list of clients connected to the current session
|
list of clients connected to the current session
|
||||||
|
|
||||||
*kak_source*::
|
*kak_source*::
|
||||||
path of the file currently getting executed (through the source
|
path of the file currently getting executed (through the source
|
||||||
command)
|
command)
|
||||||
|
|
||||||
*kak_modified*::
|
*kak_modified*::
|
||||||
buffer has modifications not saved
|
buffer has modifications not saved
|
||||||
|
|
||||||
*kak_cursor_line*::
|
*kak_cursor_line*::
|
||||||
line of the end of the main selection
|
line of the end of the main selection
|
||||||
|
|
||||||
*kak_cursor_column*::
|
*kak_cursor_column*::
|
||||||
column of the end of the main selection (in byte)
|
column of the end of the main selection (in byte)
|
||||||
|
|
||||||
*kak_cursor_char_value*::
|
*kak_cursor_char_value*::
|
||||||
unicode value of the codepoint under the cursor
|
unicode value of the codepoint under the cursor
|
||||||
|
|
||||||
*kak_cursor_char_column*::
|
*kak_cursor_char_column*::
|
||||||
column of the end of the main selection (in character)
|
column of the end of the main selection (in character)
|
||||||
|
|
||||||
*kak_cursor_byte_offset*::
|
*kak_cursor_byte_offset*::
|
||||||
Offset of the main selection from the beginning of the buffer (in bytes).
|
Offset of the main selection from the beginning of the buffer (in bytes).
|
||||||
|
|
||||||
*kak_window_width*::
|
*kak_window_width*::
|
||||||
width of the current kakoune window
|
width of the current kakoune window
|
||||||
|
|
||||||
*kak_window_height*::
|
*kak_window_height*::
|
||||||
height of the current kakoune window
|
height of the current kakoune window
|
||||||
|
|
||||||
*kak_hook_param*::
|
*kak_hook_param*::
|
||||||
filtering text passed to the currently executing hook
|
filtering text passed to the currently executing hook
|
||||||
|
|
||||||
*kak_hook_param_capture_N*::
|
*kak_hook_param_capture_N*::
|
||||||
text captured by the hook filter regex capture N
|
text captured by the hook filter regex capture N
|
||||||
|
|
||||||
*kak_client_env_<name>*::
|
*kak_client_env_<name>*::
|
||||||
value of the *name* variable in the client environment
|
value of the *name* variable in the client environment
|
||||||
(e.g. *$kak_client_env_SHELL* is the SHELL variable)
|
(e.g. *$kak_client_env_SHELL* is the SHELL variable)
|
||||||
|
|
||||||
*kak_user_modes*::
|
*kak_user_modes*::
|
||||||
the user modes list, each modes separated by a colon
|
the user modes list, each modes separated by a colon
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@ Creating and removing shortcuts boils down to the following commands,
|
||||||
respectively:
|
respectively:
|
||||||
|
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
map [flags] <scope> <mode> <key> <keys>
|
map [switches] <scope> <mode> <key> <keys>
|
||||||
unmap <scope> <mode> <key> [<expected>]
|
unmap <scope> <mode> <key> [<expected>]
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
|
|
||||||
|
@ -16,18 +16,25 @@ The *map* command makes *key* behave as if the *keys* sequence was typed.
|
||||||
|
|
||||||
*insert*::
|
*insert*::
|
||||||
insert mode
|
insert mode
|
||||||
|
|
||||||
*normal*::
|
*normal*::
|
||||||
normal mode
|
normal mode
|
||||||
|
|
||||||
*prompt*::
|
*prompt*::
|
||||||
prompts, such as when entering a command through *:*, or a regex through */*
|
prompts, such as when entering a command through *:*, or a regex through */*
|
||||||
|
|
||||||
*menu*::
|
*menu*::
|
||||||
mode entered when a menu is displayed with the 'menu' command
|
mode entered when a menu is displayed with the 'menu' command
|
||||||
|
|
||||||
*user*::
|
*user*::
|
||||||
mode entered when the user prefix is hit (default: ',')
|
mode entered when the user prefix is hit (default: ',')
|
||||||
|
|
||||||
*goto*::
|
*goto*::
|
||||||
mode entered when the goto key is hit (default: 'g')
|
mode entered when the goto key is hit (default: 'g')
|
||||||
|
|
||||||
*view*::
|
*view*::
|
||||||
mode entered when the view key is hit (default: 'v')
|
mode entered when the view key is hit (default: 'v')
|
||||||
|
|
||||||
*object*::
|
*object*::
|
||||||
mode entered when an object selection is triggered (e.g. '<a-i>')
|
mode entered when an object selection is triggered (e.g. '<a-i>')
|
||||||
|
|
||||||
|
@ -74,7 +81,7 @@ be used:
|
||||||
The *<* and *>* characters.
|
The *<* and *>* characters.
|
||||||
|
|
||||||
*<plus>*, *<minus>*::
|
*<plus>*, *<minus>*::
|
||||||
The *+* and *-* characters..
|
The *+* and *-* characters.
|
||||||
|
|
||||||
*<ret>*::
|
*<ret>*::
|
||||||
The Return or Enter key.
|
The Return or Enter key.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user