summaryrefslogtreecommitdiff
path: root/autoload/tools/autorestore.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'autoload/tools/autorestore.asciidoc')
-rw-r--r--autoload/tools/autorestore.asciidoc13
1 files changed, 13 insertions, 0 deletions
diff --git a/autoload/tools/autorestore.asciidoc b/autoload/tools/autorestore.asciidoc
new file mode 100644
index 0000000..528fcf5
--- /dev/null
+++ b/autoload/tools/autorestore.asciidoc
@@ -0,0 +1,13 @@
+= Automatically restore unsaved work after a crash.
+
+When Kakoune crashes, it automatically writes out unsaved changes to backup
+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.
+
+By default, backup files are deleted when restored. You can set the
+`autorestore_purge_restored` option to `false` to prevent this.
+
+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.