diff options
| author | Tim Allen <screwtape@froup.com> | 2021-06-11 00:27:13 +1000 |
|---|---|---|
| committer | Tim Allen <screwtape@froup.com> | 2021-06-11 00:27:13 +1000 |
| commit | bdb668ba5457ef04a054a9cf0d9edeee4ccbabf3 (patch) | |
| tree | f979e13b436b84c0d81058a366efc9dd5703566b | |
| parent | d758bbf09b949f0fef88ef3c6762cc55098cdb95 (diff) | |
Document how to escape special characters in completions.
| -rw-r--r-- | doc/pages/options.asciidoc | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/pages/options.asciidoc b/doc/pages/options.asciidoc index c12c9721..c985b8f9 100644 --- a/doc/pages/options.asciidoc +++ b/doc/pages/options.asciidoc @@ -143,6 +143,9 @@ are exclusively available to built-in options. except for the first element which follows the `<line>.<column>[+<length>]@<timestamp>` format to define where the completion apply in the buffer. + Any `|` or `\` characters that occur within the `<text>`, + `<select cmd>`, or `<menu text>` fields should be escaped as `\|` + or `\\`. Select commands are arbitrary Kakoune commands that will be executed each time the element is selected in the menu. The common use case is |