Document the readonly variable and -ro command line option

This commit is contained in:
Frank LENORMAND 2016-07-11 18:39:26 +03:00
parent 8a4596bea9
commit 7558994149
2 changed files with 9 additions and 0 deletions

View File

@ -231,6 +231,7 @@ Just running *kak* launch a new kak session with a client on local terminal.
read keystrokes as json on stdin. read keystrokes as json on stdin.
* `-l`: list existing sessions, and check the dead ones * `-l`: list existing sessions, and check the dead ones
* `-clear`: clear dead sessions socket files * `-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 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 `../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. writing a buffer, this is autodetected on load.
* `BOM` _enum(none|utf8)_: define if the file should be written * `BOM` _enum(none|utf8)_: define if the file should be written
with an unicode byte order mark. 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 * `incsearch` _bool_: execute search as it is typed
* `aligntab` _bool_: use tabs for alignment command * `aligntab` _bool_: use tabs for alignment command
* `autoinfo` _flags(command|onkey|normal)_: display automatic information * `autoinfo` _flags(command|onkey|normal)_: display automatic information

View File

@ -66,6 +66,11 @@ Builtin options
*BOM* 'enum(none|utf8)':: *BOM* 'enum(none|utf8)'::
define if the file should be written with an unicode byte order mark 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':: *incsearch* 'bool'::
execute search as it is typed execute search as it is typed