From d86b98fa7cfb43d01563c36770827b15c6fb7935 Mon Sep 17 00:00:00 2001 From: Maxime Coste Date: Sun, 20 Sep 2015 17:40:06 +0100 Subject: [PATCH] Document Markup strings and modelinefmt --- README.asciidoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.asciidoc b/README.asciidoc index f2b2ec42..15a71ea9 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -604,6 +604,15 @@ line using: :echo %sh{ ls -l $kak_bufname } ------------------------------- +Markup strings +^^^^^^^^^^^^^^ + +In certain context, kakoune can take a markup string, which is a string containing +formatting informations. In these strings, syntax `{facename}` will enable the +face _facename_ until another face gets activated (or the end of the string. +Literal `{` shall be written `\{`, and literal `\` that preceed a `{` shall +be written `\\` + Configuration & Autoloading --------------------------- @@ -725,6 +734,9 @@ Some options are built in Kakoune, and can be used to control it's behaviour: apply in the buffer, and the other strings are the candidates. * `autoreload` _yesnoask_: auto reload the buffers when an external modification is detected. + * `modelinefmt` _string_: A format string used to generate the mode line, that + string is first expanded as a command line would be (expanding `%...{...}` + strings), then markup tags are applied (see <>). * `ui_options`: colon separated list of key=value pairs that are forwarded to the user interface implementation. The NCurses UI support the following options: - `ncurses_set_title`: if `yes` or `true`, the terminal emulator title will