programs.kakoune.enable
Whether to enable the kakoune text editor.
Type: boolean
Default:
false
Example:
true
Declared by:
programs.kakoune.package
The kakoune-unwrapped package to use.
Type: null or package
Default:
pkgs.kakoune-unwrapped
Declared by:
programs.kakoune.colorSchemePackage
A kakoune color schemes to add to your colors folder. This works
because kakoune recursively checks
$XDG_CONFIG_HOME/kak/colors/. To apply the color scheme use
programs.kakoune.config.colorScheme = "theme".
Type: null or package
Default:
null
Example:
pkgs.kakounePlugins.kakoune-catppuccin
Declared by:
programs.kakoune.config
kakoune configuration options.
Type: null or (submodule)
Default:
{ }
Declared by:
programs.kakoune.config.alignWithTabs
Use tabs for the align command.
Type: boolean
Default:
false
Declared by:
programs.kakoune.config.autoComplete
Modes in which to display possible completions.
The kakoune default is [ "insert" "prompt" ].
Type: null or (list of (one of “insert”, “prompt”))
Default:
null
Declared by:
programs.kakoune.config.autoInfo
Contexts in which to display automatic information box.
The kakoune default is [ "command" "onkey" ].
Type: null or (list of (one of “command”, “onkey”, “normal”))
Default:
null
Example:
[
"command"
"normal"
]
Declared by:
programs.kakoune.config.autoReload
Reload buffers when an external modification is detected.
The kakoune default is "ask".
Type: null or one of “yes”, “no”, “ask”
Default:
null
Declared by:
programs.kakoune.config.colorScheme
Set the color scheme. To see available schemes, enter
colorscheme at the kakoune prompt.
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.hooks
Global hooks. For documentation, see https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc.
Type: list of (submodule)
Default:
[ ]
Declared by:
programs.kakoune.config.hooks.*.commands
Commands to run when the hook is activated.
Type: strings concatenated with “\n”
Default:
""
Example:
"set-option window indentwidth 2"
Declared by:
programs.kakoune.config.hooks.*.group
Add the hook to the named group.
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.hooks.*.name
The name of the hook. For a description, see https://github.com/mawww/kakoune/blob/master/doc/pages/hooks.asciidoc#default-hooks.
Type: one of “NormalIdle”, “NormalKey”, “InsertIdle”, “InsertKey”, “InsertChar”, “InsertDelete”, “InsertMove”, “WinCreate”, “WinClose”, “WinResize”, “WinDisplay”, “WinSetOption”, “BufSetOption”, “BufNewFile”, “BufOpenFile”, “BufCreate”, “BufWritePre”, “BufWritePost”, “BufReload”, “BufClose”, “BufOpenFifo”, “BufReadFifo”, “BufCloseFifo”, “RuntimeError”, “ModeChange”, “PromptIdle”, “GlobalSetOption”, “KakBegin”, “KakEnd”, “FocusIn”, “FocusOut”, “RawKey”, “InsertCompletionShow”, “InsertCompletionHide”, “ModuleLoaded”, “ClientCreate”, “ClientClose”, “RegisterModified”, “User”
Example:
"SetOption"
Declared by:
programs.kakoune.config.hooks.*.once
Remove the hook after running it once.
Type: boolean
Default:
false
Declared by:
programs.kakoune.config.hooks.*.option
Additional option to pass to the hook.
Type: null or string
Default:
null
Example:
"filetype=latex"
Declared by:
programs.kakoune.config.incrementalSearch
Execute a search as it is being typed.
Type: boolean
Default:
true
Declared by:
programs.kakoune.config.indentWidth
The width of an indentation in spaces.
The kakoune default is 4.
If 0, a tab will be used instead.
Type: null or (unsigned integer, meaning >=0)
Default:
null
Declared by:
programs.kakoune.config.keyMappings
User-defined key mappings. For documentation, see https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc.
Type: list of (submodule)
Default:
[ ]
Declared by:
programs.kakoune.config.keyMappings.*.docstring
Optional documentation text to display in info boxes.
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.keyMappings.*.effect
The sequence of keys to be mapped.
Type: string
Example:
":wq<ret>"
Declared by:
programs.kakoune.config.keyMappings.*.key
The key to be mapped. See https://github.com/mawww/kakoune/blob/master/doc/pages/mapping.asciidoc#mappable-keys for possible values.
Type: string
Example:
"<a-x>"
Declared by:
programs.kakoune.config.keyMappings.*.mode
The mode in which the mapping takes effect.
Type: string
Example:
"user"
Declared by:
programs.kakoune.config.numberLines
Settings for the number lines highlighter.
Type: null or (submodule)
Default:
null
Declared by:
programs.kakoune.config.numberLines.enable
Whether to enable the number lines highlighter.
Type: boolean
Default:
false
Example:
true
Declared by:
programs.kakoune.config.numberLines.highlightCursor
Highlight the cursor line with a separate face.
Type: boolean
Default:
false
Declared by:
programs.kakoune.config.numberLines.relative
Show line numbers relative to the main cursor line.
Type: boolean
Default:
false
Declared by:
programs.kakoune.config.numberLines.separator
String that separates the line number column from the
buffer contents. The kakoune default is
"|".
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.scrollOff
How many lines and columns to keep visible around the cursor.
Type: null or (submodule)
Default:
null
Declared by:
programs.kakoune.config.scrollOff.columns
The number of columns to keep visible around the cursor.
Type: unsigned integer, meaning >=0
Default:
0
Declared by:
programs.kakoune.config.scrollOff.lines
The number of lines to keep visible around the cursor.
Type: unsigned integer, meaning >=0
Default:
0
Declared by:
programs.kakoune.config.showMatching
Highlight the matching char of the character under the
selections’ cursor using the MatchingChar
face.
Type: boolean
Default:
false
Declared by:
programs.kakoune.config.showWhitespace
Settings for the show whitespaces highlighter.
Type: null or (submodule)
Default:
null
Declared by:
programs.kakoune.config.showWhitespace.enable
Whether to enable the show whitespace highlighter.
Type: boolean
Default:
false
Example:
true
Declared by:
programs.kakoune.config.showWhitespace.lineFeed
The character to display for line feeds.
The kakoune default is "¬".
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.showWhitespace.nonBreakingSpace
The character to display for non-breaking spaces.
The kakoune default is "⍽".
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.showWhitespace.space
The character to display for spaces.
The kakoune default is "·".
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.showWhitespace.tab
The character to display for tabs.
The kakoune default is "→".
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.showWhitespace.tabStop
The character to append to tabs to reach the width of a tabstop.
The kakoune default is " ".
Type: null or string
Default:
null
Declared by:
programs.kakoune.config.tabStop
The width of a tab in spaces. The kakoune default is
6.
Type: null or (unsigned integer, meaning >=0)
Default:
null
Declared by:
programs.kakoune.config.ui
Settings for the ncurses interface.
Type: null or (submodule)
Default:
null
Declared by:
programs.kakoune.config.ui.enableMouse
Whether to enable mouse support.
Type: boolean
Default:
false
Declared by:
programs.kakoune.config.ui.assistant
The assistant displayed in info boxes.
Type: one of “clippy”, “cat”, “dilbert”, “none”
Default:
"clippy"
Declared by:
programs.kakoune.config.ui.setTitle
Change the title of the terminal emulator.
Type: boolean
Default:
false
Declared by:
programs.kakoune.config.ui.shiftFunctionKeys
Amount by which shifted function keys are offset. That
is, if the terminal sends F13 for Shift-F1, this
should be 12.
Type: null or (unsigned integer, meaning >=0)
Default:
null
Declared by:
programs.kakoune.config.ui.statusLine
Where to display the status line.
Type: one of “top”, “bottom”
Default:
"bottom"
Declared by:
programs.kakoune.config.wrapLines
Settings for the wrap lines highlighter.
Type: null or (submodule)
Default:
null
Declared by:
programs.kakoune.config.wrapLines.enable
Whether to enable the wrap lines highlighter.
Type: boolean
Default:
false
Example:
true
Declared by:
programs.kakoune.config.wrapLines.indent
Preserve line indentation when wrapping.
Type: boolean
Default:
false
Declared by:
programs.kakoune.config.wrapLines.marker
Prefix wrapped lines with marker text.
If not null,
the marker text will be displayed in the indentation if possible.
Type: null or string
Default:
null
Example:
"⏎"
Declared by:
programs.kakoune.config.wrapLines.maxWidth
Wrap text at maxWidth, even if the window is wider.
Type: null or (unsigned integer, meaning >=0)
Default:
null
Declared by:
programs.kakoune.config.wrapLines.word
Wrap at word boundaries instead of codepoint boundaries.
Type: boolean
Default:
false
Declared by:
programs.kakoune.defaultEditor
Whether to configure kak as the default
editor using the EDITOR and VISUAL
environment variables.
Type: boolean
Default:
false
Declared by:
programs.kakoune.extraConfig
Extra configuration lines to add to
$XDG_CONFIG_HOME/kak/kakrc.
Type: strings concatenated with “\n”
Default:
""
Declared by:
programs.kakoune.finalPackage
Resulting customized kakoune package.
Type: null or package (read only)
Default:
null
Declared by:
programs.kakoune.plugins
List of kakoune plugins to install. To get a list of
supported plugins run:
nix-env -f '<nixpkgs>' -qaP -A kakounePlugins.
Requires package to not be set to have effect.
Type: list of package
Default:
[ ]
Example:
[ pkgs.kakounePlugins.kak-fzf ]
Declared by: