Browse Source

ran build_usage

Thomas Waldmann 9 years ago
parent
commit
f7abff87f9

+ 34 - 0
docs/usage/break-lock.rst.inc

@@ -0,0 +1,34 @@
+.. _borg_break-lock:
+
+borg break-lock
+---------------
+::
+
+    usage: borg break-lock [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                           [--no-files-cache] [--umask M] [--remote-path PATH]
+                           REPOSITORY
+    
+    Break the repository lock (e.g. in case it was left by a dead borg.
+    
+    positional arguments:
+      REPOSITORY            repository for which to break the locks
+    
+    optional arguments:
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
+    
+Description
+~~~~~~~~~~~
+
+This command breaks the repository and cache locks.
+Please use carefully and only while no borg process (on any machine) is
+trying to access the Cache or the Repository.

+ 14 - 9
docs/usage/change-passphrase.rst.inc

@@ -4,8 +4,9 @@ borg change-passphrase
 ----------------------
 ----------------------
 ::
 ::
 
 
-    usage: borg change-passphrase [-h] [-v] [--show-rc] [--no-files-cache]
-                                  [--umask M] [--remote-path PATH]
+    usage: borg change-passphrase [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                                  [--no-files-cache] [--umask M]
+                                  [--remote-path PATH]
                                   [REPOSITORY]
                                   [REPOSITORY]
     
     
     Change repository key file passphrase
     Change repository key file passphrase
@@ -14,13 +15,17 @@ borg change-passphrase
       REPOSITORY
       REPOSITORY
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~

+ 9 - 5
docs/usage/check.rst.inc

@@ -4,9 +4,9 @@ borg check
 ----------
 ----------
 ::
 ::
 
 
-    usage: borg check [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [--repository-only] [--archives-only]
-                      [--repair] [--last N]
+    usage: borg check [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                      [--no-files-cache] [--umask M] [--remote-path PATH]
+                      [--repository-only] [--archives-only] [--repair] [--last N]
                       [REPOSITORY_OR_ARCHIVE]
                       [REPOSITORY_OR_ARCHIVE]
     
     
     Check repository consistency
     Check repository consistency
@@ -17,11 +17,15 @@ borg check
     
     
     optional arguments:
     optional arguments:
       -h, --help            show this help message and exit
       -h, --help            show this help message and exit
-      -v, --verbose         verbose output
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-rc             show/log the return code (rc)
       --show-rc             show/log the return code (rc)
       --no-files-cache      do not load/update the file metadata cache used to
       --no-files-cache      do not load/update the file metadata cache used to
                             detect unchanged files
                             detect unchanged files
-      --umask M             set umask to M (local and remote, default: 63)
+      --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       --remote-path PATH    set remote path to executable (default: "borg")
       --repository-only     only perform repository checks
       --repository-only     only perform repository checks
       --archives-only       only perform archives checks
       --archives-only       only perform archives checks

+ 12 - 5
docs/usage/create.rst.inc

@@ -4,8 +4,9 @@ borg create
 -----------
 -----------
 ::
 ::
 
 
-    usage: borg create [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                       [--remote-path PATH] [-s] [-p] [-e PATTERN]
+    usage: borg create [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                       [--no-files-cache] [--umask M] [--remote-path PATH] [-s]
+                       [-p] [--filter STATUSCHARS] [-e PATTERN]
                        [--exclude-from EXCLUDEFILE] [--exclude-caches]
                        [--exclude-from EXCLUDEFILE] [--exclude-caches]
                        [--exclude-if-present FILENAME] [--keep-tag-files]
                        [--exclude-if-present FILENAME] [--keep-tag-files]
                        [-c SECONDS] [-x] [--numeric-owner]
                        [-c SECONDS] [-x] [--numeric-owner]
@@ -23,17 +24,23 @@ borg create
     
     
     optional arguments:
     optional arguments:
       -h, --help            show this help message and exit
       -h, --help            show this help message and exit
-      -v, --verbose         verbose output
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-rc             show/log the return code (rc)
       --show-rc             show/log the return code (rc)
       --no-files-cache      do not load/update the file metadata cache used to
       --no-files-cache      do not load/update the file metadata cache used to
                             detect unchanged files
                             detect unchanged files
-      --umask M             set umask to M (local and remote, default: 63)
+      --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       --remote-path PATH    set remote path to executable (default: "borg")
       -s, --stats           print statistics for the created archive
       -s, --stats           print statistics for the created archive
-      -p, --progress        toggle progress display while creating the archive,
+      -p, --progress, --no-progress
+                            toggle progress display while creating the archive,
                             showing Original, Compressed and Deduplicated sizes,
                             showing Original, Compressed and Deduplicated sizes,
                             followed by the Number of files seen and the path
                             followed by the Number of files seen and the path
                             being processed, default: True
                             being processed, default: True
+      --filter STATUSCHARS  only display items with the given status characters
       -e PATTERN, --exclude PATTERN
       -e PATTERN, --exclude PATTERN
                             exclude paths matching PATTERN
                             exclude paths matching PATTERN
       --exclude-from EXCLUDEFILE
       --exclude-from EXCLUDEFILE

+ 16 - 11
docs/usage/debug-delete-obj.rst.inc

@@ -4,24 +4,29 @@ borg debug-delete-obj
 ---------------------
 ---------------------
 ::
 ::
 
 
-    usage: borg debug-delete-obj [-h] [-v] [--show-rc] [--no-files-cache]
-                                 [--umask M] [--remote-path PATH]
+    usage: borg debug-delete-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                                 [--no-files-cache] [--umask M]
+                                 [--remote-path PATH]
                                  [REPOSITORY] IDs [IDs ...]
                                  [REPOSITORY] IDs [IDs ...]
     
     
     delete the objects with the given IDs from the repo
     delete the objects with the given IDs from the repo
     
     
     positional arguments:
     positional arguments:
-      REPOSITORY          repository to use
-      IDs                 hex object ID(s) to delete from the repo
+      REPOSITORY            repository to use
+      IDs                   hex object ID(s) to delete from the repo
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~

+ 14 - 9
docs/usage/debug-dump-archive-items.rst.inc

@@ -4,23 +4,28 @@ borg debug-dump-archive-items
 -----------------------------
 -----------------------------
 ::
 ::
 
 
-    usage: borg debug-dump-archive-items [-h] [-v] [--show-rc] [--no-files-cache]
+    usage: borg debug-dump-archive-items [-h] [-v] [--debug] [--lock-wait N]
+                                         [--show-rc] [--no-files-cache]
                                          [--umask M] [--remote-path PATH]
                                          [--umask M] [--remote-path PATH]
                                          ARCHIVE
                                          ARCHIVE
     
     
     dump (decrypted, decompressed) archive items metadata (not: data)
     dump (decrypted, decompressed) archive items metadata (not: data)
     
     
     positional arguments:
     positional arguments:
-      ARCHIVE             archive to dump
+      ARCHIVE               archive to dump
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~

+ 16 - 12
docs/usage/debug-get-obj.rst.inc

@@ -4,25 +4,29 @@ borg debug-get-obj
 ------------------
 ------------------
 ::
 ::
 
 
-    usage: borg debug-get-obj [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                              [--remote-path PATH]
+    usage: borg debug-get-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                              [--no-files-cache] [--umask M] [--remote-path PATH]
                               [REPOSITORY] ID PATH
                               [REPOSITORY] ID PATH
     
     
     get object contents from the repository and write it into file
     get object contents from the repository and write it into file
     
     
     positional arguments:
     positional arguments:
-      REPOSITORY          repository to use
-      ID                  hex object ID to get from the repo
-      PATH                file to write object data into
+      REPOSITORY            repository to use
+      ID                    hex object ID to get from the repo
+      PATH                  file to write object data into
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~

+ 15 - 11
docs/usage/debug-put-obj.rst.inc

@@ -4,24 +4,28 @@ borg debug-put-obj
 ------------------
 ------------------
 ::
 ::
 
 
-    usage: borg debug-put-obj [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                              [--remote-path PATH]
+    usage: borg debug-put-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                              [--no-files-cache] [--umask M] [--remote-path PATH]
                               [REPOSITORY] PATH [PATH ...]
                               [REPOSITORY] PATH [PATH ...]
     
     
     put file(s) contents into the repository
     put file(s) contents into the repository
     
     
     positional arguments:
     positional arguments:
-      REPOSITORY          repository to use
-      PATH                file(s) to read and create object(s) from
+      REPOSITORY            repository to use
+      PATH                  file(s) to read and create object(s) from
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~

+ 17 - 12
docs/usage/delete.rst.inc

@@ -4,25 +4,30 @@ borg delete
 -----------
 -----------
 ::
 ::
 
 
-    usage: borg delete [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                       [--remote-path PATH] [-s] [-c]
+    usage: borg delete [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                       [--no-files-cache] [--umask M] [--remote-path PATH] [-s]
+                       [-c]
                        [TARGET]
                        [TARGET]
     
     
     Delete an existing repository or archive
     Delete an existing repository or archive
     
     
     positional arguments:
     positional arguments:
-      TARGET              archive or repository to delete
+      TARGET                archive or repository to delete
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
-      -s, --stats         print statistics for the deleted archive
-      -c, --cache-only    delete only the local cache for the given repository
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
+      -s, --stats           print statistics for the deleted archive
+      -c, --cache-only      delete only the local cache for the given repository
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~

+ 11 - 6
docs/usage/extract.rst.inc

@@ -4,10 +4,11 @@ borg extract
 ------------
 ------------
 ::
 ::
 
 
-    usage: borg extract [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                        [--remote-path PATH] [-n] [-e PATTERN]
-                        [--exclude-from EXCLUDEFILE] [--numeric-owner]
-                        [--strip-components NUMBER] [--stdout] [--sparse]
+    usage: borg extract [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                        [--no-files-cache] [--umask M] [--remote-path PATH] [-n]
+                        [-e PATTERN] [--exclude-from EXCLUDEFILE]
+                        [--numeric-owner] [--strip-components NUMBER] [--stdout]
+                        [--sparse]
                         ARCHIVE [PATH [PATH ...]]
                         ARCHIVE [PATH [PATH ...]]
     
     
     Extract archive contents
     Extract archive contents
@@ -18,11 +19,15 @@ borg extract
     
     
     optional arguments:
     optional arguments:
       -h, --help            show this help message and exit
       -h, --help            show this help message and exit
-      -v, --verbose         verbose output
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-rc             show/log the return code (rc)
       --show-rc             show/log the return code (rc)
       --no-files-cache      do not load/update the file metadata cache used to
       --no-files-cache      do not load/update the file metadata cache used to
                             detect unchanged files
                             detect unchanged files
-      --umask M             set umask to M (local and remote, default: 63)
+      --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       --remote-path PATH    set remote path to executable (default: "borg")
       -n, --dry-run         do not actually change any files
       -n, --dry-run         do not actually change any files
       -e PATTERN, --exclude PATTERN
       -e PATTERN, --exclude PATTERN

+ 14 - 10
docs/usage/info.rst.inc

@@ -4,23 +4,27 @@ borg info
 ---------
 ---------
 ::
 ::
 
 
-    usage: borg info [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                     [--remote-path PATH]
+    usage: borg info [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                     [--no-files-cache] [--umask M] [--remote-path PATH]
                      ARCHIVE
                      ARCHIVE
     
     
     Show archive details such as disk space used
     Show archive details such as disk space used
     
     
     positional arguments:
     positional arguments:
-      ARCHIVE             archive to display information about
+      ARCHIVE               archive to display information about
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~

+ 9 - 4
docs/usage/init.rst.inc

@@ -4,8 +4,9 @@ borg init
 ---------
 ---------
 ::
 ::
 
 
-    usage: borg init [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                     [--remote-path PATH] [-e {none,keyfile,repokey,passphrase}]
+    usage: borg init [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                     [--no-files-cache] [--umask M] [--remote-path PATH]
+                     [-e {none,keyfile,repokey,passphrase}]
                      [REPOSITORY]
                      [REPOSITORY]
     
     
     Initialize an empty repository
     Initialize an empty repository
@@ -15,11 +16,15 @@ borg init
     
     
     optional arguments:
     optional arguments:
       -h, --help            show this help message and exit
       -h, --help            show this help message and exit
-      -v, --verbose         verbose output
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-rc             show/log the return code (rc)
       --show-rc             show/log the return code (rc)
       --no-files-cache      do not load/update the file metadata cache used to
       --no-files-cache      do not load/update the file metadata cache used to
                             detect unchanged files
                             detect unchanged files
-      --umask M             set umask to M (local and remote, default: 63)
+      --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       --remote-path PATH    set remote path to executable (default: "borg")
       -e {none,keyfile,repokey,passphrase}, --encryption {none,keyfile,repokey,passphrase}
       -e {none,keyfile,repokey,passphrase}, --encryption {none,keyfile,repokey,passphrase}
                             select encryption key mode
                             select encryption key mode

+ 9 - 4
docs/usage/list.rst.inc

@@ -4,8 +4,9 @@ borg list
 ---------
 ---------
 ::
 ::
 
 
-    usage: borg list [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                     [--remote-path PATH] [--short] [-p PREFIX]
+    usage: borg list [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                     [--no-files-cache] [--umask M] [--remote-path PATH] [--short]
+                     [-p PREFIX]
                      [REPOSITORY_OR_ARCHIVE]
                      [REPOSITORY_OR_ARCHIVE]
     
     
     List archive or repository contents
     List archive or repository contents
@@ -16,11 +17,15 @@ borg list
     
     
     optional arguments:
     optional arguments:
       -h, --help            show this help message and exit
       -h, --help            show this help message and exit
-      -v, --verbose         verbose output
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-rc             show/log the return code (rc)
       --show-rc             show/log the return code (rc)
       --no-files-cache      do not load/update the file metadata cache used to
       --no-files-cache      do not load/update the file metadata cache used to
                             detect unchanged files
                             detect unchanged files
-      --umask M             set umask to M (local and remote, default: 63)
+      --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       --remote-path PATH    set remote path to executable (default: "borg")
       --short               only print file/directory names, nothing else
       --short               only print file/directory names, nothing else
       -p PREFIX, --prefix PREFIX
       -p PREFIX, --prefix PREFIX

+ 9 - 4
docs/usage/mount.rst.inc

@@ -4,8 +4,9 @@ borg mount
 ----------
 ----------
 ::
 ::
 
 
-    usage: borg mount [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [-f] [-o OPTIONS]
+    usage: borg mount [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                      [--no-files-cache] [--umask M] [--remote-path PATH] [-f]
+                      [-o OPTIONS]
                       REPOSITORY_OR_ARCHIVE MOUNTPOINT
                       REPOSITORY_OR_ARCHIVE MOUNTPOINT
     
     
     Mount archive or an entire repository as a FUSE fileystem
     Mount archive or an entire repository as a FUSE fileystem
@@ -17,11 +18,15 @@ borg mount
     
     
     optional arguments:
     optional arguments:
       -h, --help            show this help message and exit
       -h, --help            show this help message and exit
-      -v, --verbose         verbose output
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-rc             show/log the return code (rc)
       --show-rc             show/log the return code (rc)
       --no-files-cache      do not load/update the file metadata cache used to
       --no-files-cache      do not load/update the file metadata cache used to
                             detect unchanged files
                             detect unchanged files
-      --umask M             set umask to M (local and remote, default: 63)
+      --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       --remote-path PATH    set remote path to executable (default: "borg")
       -f, --foreground      stay in foreground, do not daemonize
       -f, --foreground      stay in foreground, do not daemonize
       -o OPTIONS            Extra mount options
       -o OPTIONS            Extra mount options

+ 10 - 6
docs/usage/prune.rst.inc

@@ -4,10 +4,10 @@ borg prune
 ----------
 ----------
 ::
 ::
 
 
-    usage: borg prune [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [-n] [-s] [--keep-within WITHIN]
-                      [-H HOURLY] [-d DAILY] [-w WEEKLY] [-m MONTHLY] [-y YEARLY]
-                      [-p PREFIX]
+    usage: borg prune [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                      [--no-files-cache] [--umask M] [--remote-path PATH] [-n]
+                      [-s] [--keep-within WITHIN] [-H HOURLY] [-d DAILY]
+                      [-w WEEKLY] [-m MONTHLY] [-y YEARLY] [-p PREFIX]
                       [REPOSITORY]
                       [REPOSITORY]
     
     
     Prune repository archives according to specified rules
     Prune repository archives according to specified rules
@@ -17,11 +17,15 @@ borg prune
     
     
     optional arguments:
     optional arguments:
       -h, --help            show this help message and exit
       -h, --help            show this help message and exit
-      -v, --verbose         verbose output
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-rc             show/log the return code (rc)
       --show-rc             show/log the return code (rc)
       --no-files-cache      do not load/update the file metadata cache used to
       --no-files-cache      do not load/update the file metadata cache used to
                             detect unchanged files
                             detect unchanged files
-      --umask M             set umask to M (local and remote, default: 63)
+      --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       --remote-path PATH    set remote path to executable (default: "borg")
       -n, --dry-run         do not change repository
       -n, --dry-run         do not change repository
       -s, --stats           print statistics for the deleted archive
       -s, --stats           print statistics for the deleted archive

+ 15 - 11
docs/usage/rename.rst.inc

@@ -4,24 +4,28 @@ borg rename
 -----------
 -----------
 ::
 ::
 
 
-    usage: borg rename [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                       [--remote-path PATH]
+    usage: borg rename [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                       [--no-files-cache] [--umask M] [--remote-path PATH]
                        ARCHIVE NEWNAME
                        ARCHIVE NEWNAME
     
     
     Rename an existing archive
     Rename an existing archive
     
     
     positional arguments:
     positional arguments:
-      ARCHIVE             archive to rename
-      NEWNAME             the new archive name to use
+      ARCHIVE               archive to rename
+      NEWNAME               the new archive name to use
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --umask M             set umask to M (local and remote, default: 0077)
+      --remote-path PATH    set remote path to executable (default: "borg")
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~

+ 9 - 4
docs/usage/serve.rst.inc

@@ -4,19 +4,24 @@ borg serve
 ----------
 ----------
 ::
 ::
 
 
-    usage: borg serve [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                      [--remote-path PATH] [--restrict-to-path PATH]
+    usage: borg serve [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                      [--no-files-cache] [--umask M] [--remote-path PATH]
+                      [--restrict-to-path PATH]
     
     
     Start in server mode. This command is usually not used manually.
     Start in server mode. This command is usually not used manually.
             
             
     
     
     optional arguments:
     optional arguments:
       -h, --help            show this help message and exit
       -h, --help            show this help message and exit
-      -v, --verbose         verbose output
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
       --show-rc             show/log the return code (rc)
       --show-rc             show/log the return code (rc)
       --no-files-cache      do not load/update the file metadata cache used to
       --no-files-cache      do not load/update the file metadata cache used to
                             detect unchanged files
                             detect unchanged files
-      --umask M             set umask to M (local and remote, default: 63)
+      --umask M             set umask to M (local and remote, default: 0077)
       --remote-path PATH    set remote path to executable (default: "borg")
       --remote-path PATH    set remote path to executable (default: "borg")
       --restrict-to-path PATH
       --restrict-to-path PATH
                             restrict repository access to PATH
                             restrict repository access to PATH

+ 18 - 13
docs/usage/upgrade.rst.inc

@@ -4,26 +4,31 @@ borg upgrade
 ------------
 ------------
 ::
 ::
 
 
-    usage: borg upgrade [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
-                        [--remote-path PATH] [-n] [-i]
+    usage: borg upgrade [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
+                        [--no-files-cache] [--umask M] [--remote-path PATH] [-n]
+                        [-i]
                         [REPOSITORY]
                         [REPOSITORY]
     
     
     upgrade a repository from a previous version
     upgrade a repository from a previous version
     
     
     positional arguments:
     positional arguments:
-      REPOSITORY          path to the repository to be upgraded
+      REPOSITORY            path to the repository to be upgraded
     
     
     optional arguments:
     optional arguments:
-      -h, --help          show this help message and exit
-      -v, --verbose       verbose output
-      --show-rc           show/log the return code (rc)
-      --no-files-cache    do not load/update the file metadata cache used to
-                          detect unchanged files
-      --umask M           set umask to M (local and remote, default: 63)
-      --remote-path PATH  set remote path to executable (default: "borg")
-      -n, --dry-run       do not change repository
-      -i, --inplace       rewrite repository in place, with no chance of going
-                          back to older versions of the repository.
+      -h, --help            show this help message and exit
+      -v, --verbose, --info
+                            enable informative (verbose) output, work on log level
+                            INFO
+      --debug               enable debug output, work on log level DEBUG
+      --lock-wait N         wait for the lock, but max. N seconds (default: 1).
+      --show-rc             show/log the return code (rc)
+      --no-files-cache      do not load/update the file metadata cache used to
+                            detect unchanged files
+      --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
+      -i, --inplace         rewrite repository in place, with no chance of going
+                            back to older versions of the repository.
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~