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

Merge remote-tracking branch 'Delapouite/options-default'

Browse Source
This commit is contained in:
Maxime Coste 2017-09-18 10:02:07 +09:00
commit b0d0014455
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/manpages/options.asciidoc
View File

@ -53,40 +53,50 @@ Builtin options
--------------- ---------------
*tabstop* 'int':: *tabstop* 'int'::
*default* 8 +
width of a tab character width of a tab character
*indentwidth* 'int':: *indentwidth* 'int'::
*default* 4 +
width (in spaces) used for indentation, 0 means a tab character width (in spaces) used for indentation, 0 means a tab character
*scrolloff* 'coord':: *scrolloff* 'coord'::
*default* 0,0 +
number of lines, columns to keep visible around the cursor when number of lines, columns to keep visible around the cursor when
scrolling scrolling
*eolformat* 'enum(lf|crlf)':: *eolformat* 'enum(lf|crlf)'::
*default* lf +
the format of end of lines when writing a buffer, this is autodetected the format of end of lines when writing a buffer, this is autodetected
on load; values of this option assigned to the `window` scope are on load; values of this option assigned to the `window` scope are
ignored ignored
*BOM* 'enum(none|utf8)':: *BOM* 'enum(none|utf8)'::
*default* none +
define if the file should be written with a 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'::
*default* false +
prevent modifications from being saved to disk, all buffers if set prevent modifications from being saved to disk, all buffers if set
to `true` in the `global` scope, or current buffer if set in the to `true` in the `global` scope, or current buffer if set in the
`buffer` scope; values of this option assigned to the `window` `buffer` scope; values of this option assigned to the `window`
scope are ignored scope are ignored
*incsearch* 'bool':: *incsearch* 'bool'::
*default* true +
execute search as it is typed execute search as it is typed
*aligntab* 'bool':: *aligntab* 'bool'::
*default* false +
use tabs for alignment command use tabs for alignment command
*autoinfo* 'flags(command|onkey|normal)':: *autoinfo* 'flags(command|onkey|normal)'::
*default* command|onkey +
display automatic information box in the enabled contexts display automatic information box in the enabled contexts
*autoshowcompl* 'bool':: *autoshowcompl* 'bool'::
*default* true +
automatically display possible completions when editing a prompt automatically display possible completions when editing a prompt
*ignored_files* 'regex':: *ignored_files* 'regex'::
@ -103,9 +113,11 @@ Builtin options
actions should hook on this option changing for activation/deactivation actions should hook on this option changing for activation/deactivation
*path* 'str-list':: *path* 'str-list'::
*default* ./:/usr/include +
directories to search for gf command directories to search for gf command
*completers* 'str-list':: *completers* 'str-list'::
*default* filename:word=all +
completion engines to use for insert mode completion (they are tried completion engines to use for insert mode completion (they are tried
in order until one generates candidates). Existing completers are: in order until one generates candidates). Existing completers are:
@ -130,16 +142,19 @@ Builtin options
as word character for the purpose of insert mode completion. as word character for the purpose of insert mode completion.
*autoreload* 'enum(yes|no|ask)':: *autoreload* 'enum(yes|no|ask)'::
*default* ask +
auto reload the buffers when an external modification is detected auto reload the buffers when an external modification is detected
*debug* 'flags(hooks|shell|profile|keys|commands)':: *debug* 'flags(hooks|shell|profile|keys|commands)'::
dump various debug information in the '\*debug*' buffer dump various debug information in the '\*debug*' buffer
*idle_timeout* 'int':: *idle_timeout* 'int'::
*default* 50 +
timeout, in milliseconds, with no user input that will trigger the timeout, in milliseconds, with no user input that will trigger the
*PromptIdle*, *InsertIdle* and *NormalIdle* hooks. *PromptIdle*, *InsertIdle* and *NormalIdle* hooks.
*fs_checkout_timeout* 'int':: *fs_checkout_timeout* 'int'::
*default* 500 +
timeout, in milliseconds, between checks in normal mode of modifications timeout, in milliseconds, between checks in normal mode of modifications
of the file associated with the current buffer on the filesystem. of the file associated with the current buffer on the filesystem.