'\" t .\" Title: kakoune .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.79.1 .\" Date: 11/16/2018 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" .TH KAK_OPTIONS 1 "" "" "options" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" options \- a .SH "TYPES" .PP \fBint\fR .RS 4 an integer number .RE .PP \fBbool\fR .RS 4 a boolean value, yes/true or no/false .RE .PP \fBstr\fR .RS 4 a string, some freeform text .RE .PP \fBcoord\fR .RS 4 a line, column pair (separated by comma) .RE .PP \fBregex\fR .RS 4 as a string but the set commands will complain if the entered text is not a valid regex .RE .PP \fBint\-list\fR, \fBstr\-list\fR .RS 4 a list, elements are separated by a colon (:) if an element needs to contain a colon, it can be escaped with a backslash .RE .PP \fBrange\-faces\fR .RS 4 a : separated list of a pairs of a buffer range (\&.,\&. or \&.+) and a face (separated by |), except for the first element which is just the timestamp of the buffer\&. .RE .PP \fBcompletions\fR .RS 4 a : separated list of || candidates, except for the first element which follows the \&.[+]@ format to define where the completion apply in the buffer\&. .RE .PP \fBenum(value1|value2|\&...)\fR .RS 4 an enum, taking one of the given values .RE .PP \fBflags(value1|value2|\&...)\fR .RS 4 a set of flags, taking a combination of the given values joined by a \fI|\fR character .RE .sp Refer to the \fIscopes\fR documentation page for more information about scopes\&. .SH "BUILTIN OPTIONS" .PP \fBtabstop\fR \fIint\fR .RS 4 width of a tab character .RE .PP \fBindentwidth\fR \fIint\fR .RS 4 width (in spaces) used for indentation, 0 means a tab character .RE .PP \fBscrolloff\fR \fIcoord\fR .RS 4 number of lines, columns to keep visible around the cursor when scrolling .RE .PP \fBeolformat\fR \fIenum(lf|crlf)\fR .RS 4 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 ignored .RE .PP \fBBOM\fR \fIenum(none|utf8)\fR .RS 4 define if the file should be written with an unicode byte order mark; values of this option assigned to the window scope are ignored .RE .PP \fBreadonly\fR \fIbool\fR .RS 4 prevent modifications from being saved to disk, all buffers if set to true in the global scope, or current buffer if set in the buffer scope; values of this option assigned to the window scope are ignored .RE .PP \fBincsearch\fR \fIbool\fR .RS 4 execute search as it is typed .RE .PP \fBaligntab\fR \fIbool\fR .RS 4 use tabs for alignment command .RE .PP \fBautoinfo\fR \fIflags(command|onkey|normal)\fR .RS 4 display automatic information box in the enabled contexts .RE .PP \fBautoshowcompl\fR \fIbool\fR .RS 4 automatically display possible completions when editing a prompt .RE .PP \fBignored_files\fR \fIregex\fR .RS 4 filenames matching this regex won\(cqt be considered as candidates on filename completion (except if the text being completed already matches it) .RE .PP \fBdisabled_hooks\fR \fIregex\fR .RS 4 hooks whose group matches this regex won\(cqt be executed\&. For example indentation hooks can be disabled with \fI\&.*\-indent\fR .RE .PP \fBfiletype\fR \fIstr\fR .RS 4 arbitrary string defining the type of the file filetype dependent actions should hook on this option changing for activation/deactivation .RE .PP \fBpath\fR \fIstr\-list\fR .RS 4 directories to search for gf command .RE .PP \fBcompleters\fR \fIstr\-list\fR .RS 4 completion engines to use for insert mode completion (they are tried in order until one generates candidates)\&. Existing completers are: .PP \fBword=all\fR, \fBword=buffer\fR .RS 4 which complete using words in all buffers (\fBword=all\fR) or only the current one (\fBword=buffer\fR) .RE .PP \fBfilename\fR .RS 4 which tries to detect when a filename is being entered and provides completion based on local filesystem .RE .PP \fBoption=\fR .RS 4 where \fBopt\-name\fR is a \fIcompletions\fR option\&. .RE .RE .PP \fBstatic_words\fR \fIstr\-list\fR .RS 4 list of words that are always added to completion candidates when completing words in insert mode .RE .PP \fBcompletions_extra_word_chars\fR \fIstr\fR .RS 4 a string containing all additional character that should be considered as word character for the purpose of insert mode completion\&. .RE .PP \fBautoreload\fR \fIenum(yes|no|ask)\fR .RS 4 auto reload the buffers when an external modification is detected .RE .PP \fBdebug\fR \fIflags(hooks|shell|profile)\fR .RS 4 dump various debug information in the \fI*debug*\fR buffer .RE .PP \fBidle_timeout\fR \fIint\fR .RS 4 timeout, in milliseconds, with no user input that will trigger the \fBInsertIdle\fR and \fBNormalIdle\fR hooks\&. .RE .PP \fBfs_checkout_timeout\fR \fIint\fR .RS 4 timeout, in milliseconds, between checks in normal mode of modifications of the file associated with the current buffer on the filesystem\&. .RE .PP \fBmodelinefmt\fR \fIstring\fR .RS 4 A format string used to generate the mode line, that string is first expanded as a command line would be (expanding \fI%\&...{\&...}\fR strings), then markup tags are applied (c\&.f\&. the \fIExpansions\fR documentation page) .RE .PP \fBui_options\fR .RS 4 colon separated list of key=value pairs that are forwarded to the user interface implementation\&. The NCurses UI support the following options: .PP \fBncurses_set_title\fR .RS 4 if \fByes\fR or \fBtrue\fR, the terminal emulator title will be changed .RE .PP \fBncurses_status_on_top\fR .RS 4 if \fByes\fR, or \fBtrue\fR the status line will be placed at the top of the terminal rather than at the bottom .RE .PP \fBncurses_assistant\fR .RS 4 specify the nice assistant you get in info boxes, can be \fBclippy\fR (the default), \fBcat\fR or \fBnone\fR .RE .PP \fBncurses_enable_mouse\fR .RS 4 boolean option that enables mouse support .RE .PP \fBncurses_wheel_down_button\fR, \fBncurses_wheel_up_button\fR .RS 4 specify which button send for wheel down/up events .RE .PP \fBncurses_buffer_padding_str\fR .RS 4 string that will be used to mark the end of the buffer .RE .PP \fBncurses_buffer_padding_type\fR .RS 4 if set to fill, the padding string will fill the entire space between the end of the buffer and the bottom of the current window, if set to single the padding string will be inserted once at the end of the buffer\&. A value of off disables any kind of padding .RE .RE