diff --git a/rc/tools/autorestore.asciidoc b/rc/tools/autorestore.asciidoc index 7112ae3b..528fcf5c 100644 --- a/rc/tools/autorestore.asciidoc +++ b/rc/tools/autorestore.asciidoc @@ -5,19 +5,9 @@ files with predictable names. When you edit a file, if such a backup file exists, this plugin will automatically load the content of the backup file instead. -== Commands +By default, backup files are deleted when restored. You can set the +`autorestore_purge_restored` option to `false` to prevent this. -*autorestore-restore-buffer*:: - Restore the backup for the current file if it exists. - -*autorestore-purge-backups*:: - Remove all the backups of the current buffer. - -*autorestore-disable*:: - Disable automatic backup recovering for this session. - -== Options - -*autorestore_purge_restored* (bool):: - *default* true + - If true, remove backups once they've been restored +If you don't want backups to be restored automatically, use the +`autorestore-disable` command to disable the feature for the current session, +or put it in your `kakrc` to disable the feature forever. diff --git a/rc/tools/doc.asciidoc b/rc/tools/doc.asciidoc index c33698bd..407260a6 100644 --- a/rc/tools/doc.asciidoc +++ b/rc/tools/doc.asciidoc @@ -2,6 +2,12 @@ This is Kakoune's online documentation system. +To see what documentation topics are available, type `:doc` and look at the +completion menu. To view the a particular documentation topic, type the topic +name or choose it from the completion menu and hit Enter. + +Documentation will be displayed in the client named in the `docsclient` option. + == Using the documentation browser Documentation buffers are like any other buffer, so you can scroll through them @@ -11,24 +17,6 @@ follow it by moving the cursor onto it and pressing Enter. If the link takes you to a different documentation topic, you can get back by using the `:buffer` command. -== Commands - -*doc* []:: - *alias* help + - This command displays documentation about the named topic in a new buffer. - If a target is supplied, Kakoune will automatically jump to that target - when the buffer is opened. - + - For a list of available topics, or available targets within a topic, check - the completion menu that appears when typing the command at the prompt. - -== Options - -*docsclient* (str):: - If set, the `:doc` command will try to display documentation in the Kakoune - client with this name. - See <> - == Writing documentation Documentation must be in AsciiDoc format, with the extension `.asciidoc`, @@ -37,14 +25,14 @@ Kakoune's built-in documentation renderer does not necessarily support every feature, so don't go overboard with formatting. To create a link to another documentation topic, the URL should be the topic- -name, just like <> uses. Because topics are identified +name, just like `:doc` uses. Because topics are identified only by their basename, you should take care that your topic's name does not collide with any of the names used by other plugins or Kakoune's standard library. == Sources -The <> searches within the following locations for +The `:doc` command searches within the following locations for documents in the AsciiDoc format (`*.asciidoc`): * The user plugin directory, `"%val{config}/autoload"` diff --git a/rc/tools/lint.asciidoc b/rc/tools/lint.asciidoc index da7213bf..3fe7f5ad 100644 --- a/rc/tools/lint.asciidoc +++ b/rc/tools/lint.asciidoc @@ -11,46 +11,15 @@ format: If the 'kind' field contains 'error', the message is treated as an error, otherwise it is assumed to be a warning. -This plugin can run such tools and collect the resulting messages. The complete -output is collected in the `*lint-output*` buffer, and any lines in the current -file with messages will have a marker displayed next to them in the left margin. -When the cursor moves onto a line with the problem, the associated messages will -be displayed in a tool tip. +The `:lint-buffer` and `:lint-selections` commands will run the shell command +specified in the `lintcmd` option, collect the result in the `*lint-output*` +buffer, and analyze it. If `toolsclient` is set, the `*lint-output*` buffer will +be displayed in the named client. -== Commands - -*lint-buffer*:: - *alias* lint + - Pass the entire buffer through the program named in `lintcmd`. The buffer - may contain unsaved changes. - -*lint-selections* [-command ]:: - Pass each of the selections through `` or, if the `-command` switch is - not provided, through the program named in `lintcmd`. The buffer may contain - unsaved changes. - -*lint-hide-diagnostics*:: - Hide line markers and disable the automatic display of messages, if any. - -*lint-next-message*:: - Jump to the next message generated by the last `lint-buffer` or - `lint-selections` command. - -*lint-previous-message*:: - Jump to the previous message generated by the last `lint-buffer` or - `lint-selections` command. - -== Options - -*lintcmd* (str):: - The shell command used by lint-buffer and lint-selections. - + - It will be given the path to a file containing the text to be - linted, and must produce output in the format described above. - - -*toolsclient* (str):: - If set, the `:lint` command will try to display its results in the Kakoune - client with this name. - See <> +Each reported error or warning causes a marker to appear in the left-hand +margin of the buffer that was checked. When the main cursor moves onto that +line, the associated messages are displayed. If they get distracting, you can +turn off the markers and messages with the `:lint-hide-diagnostics` command. +You can also use `:lint-next-message` and `:lint-previous-message` to jump +between the lines with messages.