From 75589941498f492eb94f4b0c76209e0d4f2a608d Mon Sep 17 00:00:00 2001 From: Frank LENORMAND Date: Mon, 11 Jul 2016 18:39:26 +0300 Subject: [PATCH] Document the `readonly` variable and `-ro` command line option --- README.asciidoc | 4 ++++ doc/manpages/options.asciidoc | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/README.asciidoc b/README.asciidoc index 48dbcc5f..6d3a5c11 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -231,6 +231,7 @@ Just running *kak* launch a new kak session with a client on local terminal. read keystrokes as json on stdin. * `-l`: list existing sessions, and check the dead ones * `-clear`: clear dead sessions socket files + * `-ro`: prevent modifications to all buffers from being saved to disk At startup, if `-n` is not specified, Kakoune will try to source the file `../share/kak/kakrc` relative to the kak binary. This kak file will then try @@ -861,6 +862,9 @@ Some options are built in Kakoune, and can be used to control it's behaviour: writing a buffer, this is autodetected on load. * `BOM` _enum(none|utf8)_: define if the file should be written with an unicode byte order mark. + * `readonly` _bool_: 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. * `incsearch` _bool_: execute search as it is typed * `aligntab` _bool_: use tabs for alignment command * `autoinfo` _flags(command|onkey|normal)_: display automatic information diff --git a/doc/manpages/options.asciidoc b/doc/manpages/options.asciidoc index 75c1e217..4b495dd3 100644 --- a/doc/manpages/options.asciidoc +++ b/doc/manpages/options.asciidoc @@ -66,6 +66,11 @@ Builtin options *BOM* 'enum(none|utf8)':: define if the file should be written with an unicode byte order mark +*readonly* 'bool':: + 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. + *incsearch* 'bool':: execute search as it is typed