update usage files

20 files changed, 86 insertions, 43 deletions

diff --git a/docs/usage/break-lock.rst.inc b/docs/usage/break-lock.rst.inc
index 4edef5c23..43707040a 100644
--- a/docs/usage/break-lock.rst.inc
+++ b/docs/usage/break-lock.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_break-lock:
 
 borg break-lock
diff --git a/docs/usage/change-passphrase.rst.inc b/docs/usage/change-passphrase.rst.inc
index 08ba4ee9f..ac0019285 100644
--- a/docs/usage/change-passphrase.rst.inc
+++ b/docs/usage/change-passphrase.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_change-passphrase:
 
 borg change-passphrase
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc
index 9ad6a4b35..738f7d614 100644
--- a/docs/usage/check.rst.inc
+++ b/docs/usage/check.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_check:
 
 borg check
diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc
index d294197b6..fbf531bc6 100644
--- a/docs/usage/create.rst.inc
+++ b/docs/usage/create.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_create:
 
 borg create
@@ -70,10 +72,10 @@ borg create
                             compression (default), lz4 == lz4, zlib == zlib
                             (default level 6), zlib,0 .. zlib,9 == zlib (with
                             level 0..9), lzma == lzma (default level 6), lzma,0 ..
-                            lzma,6 == lzma (with level 0..6. levels above 6 do not
-                            improve compression and only waste many cpu cycles)
-      --read-special        open and read special files as if they were regular
-                            files
+                            lzma,9 == lzma (with level 0..9).
+      --read-special        open and read block and char device files as well as
+                            FIFOs as if they were regular files. Also follows
+                            symlinks pointing to these kinds of files.
       -n, --dry-run         do not create a backup archive
     
 Description
diff --git a/docs/usage/debug-delete-obj.rst.inc b/docs/usage/debug-delete-obj.rst.inc
index bfc31043a..7ed144bfb 100644
--- a/docs/usage/debug-delete-obj.rst.inc
+++ b/docs/usage/debug-delete-obj.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_debug-delete-obj:
 
 borg debug-delete-obj
diff --git a/docs/usage/debug-dump-archive-items.rst.inc b/docs/usage/debug-dump-archive-items.rst.inc
index fd2cd62c9..e83bbf854 100644
--- a/docs/usage/debug-dump-archive-items.rst.inc
+++ b/docs/usage/debug-dump-archive-items.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_debug-dump-archive-items:
 
 borg debug-dump-archive-items
diff --git a/docs/usage/debug-get-obj.rst.inc b/docs/usage/debug-get-obj.rst.inc
index ef5b78d38..f38f0e884 100644
--- a/docs/usage/debug-get-obj.rst.inc
+++ b/docs/usage/debug-get-obj.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_debug-get-obj:
 
 borg debug-get-obj
diff --git a/docs/usage/debug-put-obj.rst.inc b/docs/usage/debug-put-obj.rst.inc
index 32a4558da..4f02324bf 100644
--- a/docs/usage/debug-put-obj.rst.inc
+++ b/docs/usage/debug-put-obj.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_debug-put-obj:
 
 borg debug-put-obj
diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc
index 8e453ab28..64c85bdb9 100644
--- a/docs/usage/delete.rst.inc
+++ b/docs/usage/delete.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_delete:
 
 borg delete
@@ -6,7 +8,8 @@ borg delete
 
     usage: borg delete [-h] [--critical] [--error] [--warning] [--info] [--debug]
                        [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
-                       [--remote-path PATH] [-p] [-s] [-c] [--save-space]
+                       [--remote-path PATH] [-p] [-s] [-c] [--force]
+                       [--save-space]
                        [TARGET]
     
     Delete an existing repository or archive
@@ -31,6 +34,7 @@ borg delete
       -p, --progress        show progress display while deleting a single archive
       -s, --stats           print statistics for the deleted archive
       -c, --cache-only      delete only the local cache for the given repository
+      --force               force deletion of corrupted archives
       --save-space          work slower, but using less space
     
 Description
diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc
index 227b254e9..9cf2d4f9c 100644
--- a/docs/usage/extract.rst.inc
+++ b/docs/usage/extract.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_extract:
 
 borg extract
diff --git a/docs/usage/help.rst.inc b/docs/usage/help.rst.inc
index 9b8d23d66..c83dfb0aa 100644
--- a/docs/usage/help.rst.inc
+++ b/docs/usage/help.rst.inc
@@ -1,41 +1,5 @@
-.. _borg_placeholders:
-
-borg help placeholders
-~~~~~~~~~~~~~~~~~~~~~~
-::
-
-
-Repository (or Archive) URLs and --prefix values support these placeholders:
-
-{hostname}
-
-    The (short) hostname of the machine.
-
-{fqdn}
-
-    The full name of the machine.
-
-{now}
-
-    The current local date and time.
-
-{utcnow}
-
-    The current UTC date and time.
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
 
-{user}
-
-    The user name (or UID, if no name is available) of the user running borg.
-
-{pid}
-
-    The current process ID.
-
-Examples::
-
-    borg create /path/to/repo::{hostname}-{user}-{utcnow} ...
-    borg create /path/to/repo::{hostname}-{now:%Y-%m-%d_%H:%M:%S} ...
-    borg prune --prefix '{hostname}-' ...
 .. _borg_patterns:
 
 borg help patterns
@@ -129,3 +93,41 @@ Examples::
     sh:/home/*/.thumbnails
     EOF
     $ borg create --exclude-from exclude.txt backup /
+.. _borg_placeholders:
+
+borg help placeholders
+~~~~~~~~~~~~~~~~~~~~~~
+::
+
+
+Repository (or Archive) URLs and --prefix values support these placeholders:
+
+{hostname}
+
+    The (short) hostname of the machine.
+
+{fqdn}
+
+    The full name of the machine.
+
+{now}
+
+    The current local date and time.
+
+{utcnow}
+
+    The current UTC date and time.
+
+{user}
+
+    The user name (or UID, if no name is available) of the user running borg.
+
+{pid}
+
+    The current process ID.
+
+Examples::
+
+    borg create /path/to/repo::{hostname}-{user}-{utcnow} ...
+    borg create /path/to/repo::{hostname}-{now:%Y-%m-%d_%H:%M:%S} ...
+    borg prune --prefix '{hostname}-' ...
diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc
index 1c57c5b56..68c9194ec 100644
--- a/docs/usage/info.rst.inc
+++ b/docs/usage/info.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_info:
 
 borg info
diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc
index 9af244271..798fe6e53 100644
--- a/docs/usage/init.rst.inc
+++ b/docs/usage/init.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_init:
 
 borg init
diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc
index 4725db5e0..8f1d2a45e 100644
--- a/docs/usage/list.rst.inc
+++ b/docs/usage/list.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_list:
 
 borg list
diff --git a/docs/usage/migrate-to-repokey.rst.inc b/docs/usage/migrate-to-repokey.rst.inc
index 674c0f774..c5ff21be3 100644
--- a/docs/usage/migrate-to-repokey.rst.inc
+++ b/docs/usage/migrate-to-repokey.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_migrate-to-repokey:
 
 borg migrate-to-repokey
diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc
index b41886aab..1754b0e2c 100644
--- a/docs/usage/mount.rst.inc
+++ b/docs/usage/mount.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_mount:
 
 borg mount
diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc
index 08f54605f..274d60c2a 100644
--- a/docs/usage/prune.rst.inc
+++ b/docs/usage/prune.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_prune:
 
 borg prune
@@ -6,7 +8,7 @@ borg prune
 
     usage: borg prune [-h] [--critical] [--error] [--warning] [--info] [--debug]
                       [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [-n] [-s] [--list]
+                      [--remote-path PATH] [-n] [--force] [-s] [--list]
                       [--keep-within WITHIN] [-H HOURLY] [-d DAILY] [-w WEEKLY]
                       [-m MONTHLY] [-y YEARLY] [-P PREFIX] [--save-space]
                       [REPOSITORY]
@@ -31,6 +33,7 @@ borg prune
       --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       -n, --dry-run         do not change repository
+      --force               force pruning of corrupted archives
       -s, --stats           print statistics for the deleted archive
       --list                output verbose list of archives it keeps/prunes
       --keep-within WITHIN  keep all archives within this time interval
diff --git a/docs/usage/rename.rst.inc b/docs/usage/rename.rst.inc
index 483aa2516..cfafb0022 100644
--- a/docs/usage/rename.rst.inc
+++ b/docs/usage/rename.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_rename:
 
 borg rename
diff --git a/docs/usage/serve.rst.inc b/docs/usage/serve.rst.inc
index e8eb6c028..eb57a975b 100644
--- a/docs/usage/serve.rst.inc
+++ b/docs/usage/serve.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_serve:
 
 borg serve
diff --git a/docs/usage/upgrade.rst.inc b/docs/usage/upgrade.rst.inc
index bd920149b..6c44edf74 100644
--- a/docs/usage/upgrade.rst.inc
+++ b/docs/usage/upgrade.rst.inc
@@ -1,3 +1,5 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
 .. _borg_upgrade:
 
 borg upgrade