Browse Source

run build_usage

Thomas Waldmann 9 năm trước cách đây
mục cha
commit
c42f3d07f4

+ 2 - 2
docs/usage/check.rst.inc

@@ -7,7 +7,7 @@ borg check
     usage: borg check [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
     usage: borg check [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
                       [--no-files-cache] [--umask M] [--remote-path PATH]
                       [--no-files-cache] [--umask M] [--remote-path PATH]
                       [--repository-only] [--archives-only] [--repair]
                       [--repository-only] [--archives-only] [--repair]
-                      [--save-space] [--last N] [-p PREFIX]
+                      [--save-space] [--last N] [-P PREFIX]
                       [REPOSITORY_OR_ARCHIVE]
                       [REPOSITORY_OR_ARCHIVE]
     
     
     Check repository consistency
     Check repository consistency
@@ -33,7 +33,7 @@ borg check
       --repair              attempt to repair any inconsistencies found
       --repair              attempt to repair any inconsistencies found
       --save-space          work slower, but using less space
       --save-space          work slower, but using less space
       --last N              only check last N archives (Default: all)
       --last N              only check last N archives (Default: all)
-      -p PREFIX, --prefix PREFIX
+      -P PREFIX, --prefix PREFIX
                             only consider archive names starting with this prefix
                             only consider archive names starting with this prefix
     
     
 Description
 Description

+ 1 - 1
docs/usage/create.rst.inc

@@ -59,7 +59,7 @@ borg create
                             manually specify the archive creation date/time (UTC).
                             manually specify the archive creation date/time (UTC).
                             alternatively, give a reference file/directory.
                             alternatively, give a reference file/directory.
       --chunker-params CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,HASH_WINDOW_SIZE
       --chunker-params CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,HASH_WINDOW_SIZE
-                            specify the chunker parameters. default: 10,23,16,4095
+                            specify the chunker parameters. default: 19,23,21,4095
       -C COMPRESSION, --compression COMPRESSION
       -C COMPRESSION, --compression COMPRESSION
                             select compression algorithm (and level): none == no
                             select compression algorithm (and level): none == no
                             compression (default), lz4 == lz4, zlib == zlib
                             compression (default), lz4 == lz4, zlib == zlib

+ 3 - 2
docs/usage/extract.rst.inc

@@ -5,8 +5,8 @@ borg extract
 ::
 ::
 
 
     usage: borg extract [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
     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]
+                        [--no-files-cache] [--umask M] [--remote-path PATH]
+                        [--list] [-n] [-e PATTERN] [--exclude-from EXCLUDEFILE]
                         [--numeric-owner] [--strip-components NUMBER] [--stdout]
                         [--numeric-owner] [--strip-components NUMBER] [--stdout]
                         [--sparse]
                         [--sparse]
                         ARCHIVE [PATH [PATH ...]]
                         ARCHIVE [PATH [PATH ...]]
@@ -29,6 +29,7 @@ borg extract
                             detect unchanged files
                             detect unchanged files
       --umask M             set umask to M (local and remote, default: 0077)
       --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")
+      --list                output verbose list of items (files, dirs, ...)
       -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
                             exclude paths matching PATTERN
                             exclude paths matching PATTERN

+ 3 - 5
docs/usage/init.rst.inc

@@ -6,7 +6,7 @@ borg init
 
 
     usage: borg init [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
     usage: borg init [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
                      [--no-files-cache] [--umask M] [--remote-path PATH]
                      [--no-files-cache] [--umask M] [--remote-path PATH]
-                     [-e {none,keyfile,repokey,passphrase}]
+                     [-e {none,keyfile,repokey}]
                      [REPOSITORY]
                      [REPOSITORY]
     
     
     Initialize an empty repository
     Initialize an empty repository
@@ -26,8 +26,8 @@ borg init
                             detect unchanged files
                             detect unchanged files
       --umask M             set umask to M (local and remote, default: 0077)
       --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}
-                            select encryption key mode
+      -e {none,keyfile,repokey}, --encryption {none,keyfile,repokey}
+                            select encryption key mode (default: "repokey")
     
     
 Description
 Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~
@@ -35,5 +35,3 @@ Description
 This command initializes an empty repository. A repository is a filesystem
 This command initializes an empty repository. A repository is a filesystem
 directory containing the deduplicated data from zero or more archives.
 directory containing the deduplicated data from zero or more archives.
 Encryption can be enabled at repository init time.
 Encryption can be enabled at repository init time.
-Please note that the 'passphrase' encryption mode is DEPRECATED (instead of it,
-consider using 'repokey').

+ 2 - 2
docs/usage/list.rst.inc

@@ -6,7 +6,7 @@ borg list
 
 
     usage: borg list [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
     usage: borg list [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
                      [--no-files-cache] [--umask M] [--remote-path PATH] [--short]
                      [--no-files-cache] [--umask M] [--remote-path PATH] [--short]
-                     [-p PREFIX]
+                     [-P PREFIX]
                      [REPOSITORY_OR_ARCHIVE]
                      [REPOSITORY_OR_ARCHIVE]
     
     
     List archive or repository contents
     List archive or repository contents
@@ -28,7 +28,7 @@ borg list
       --umask M             set umask to M (local and remote, default: 0077)
       --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
                             only consider archive names starting with this prefix
                             only consider archive names starting with this prefix
     
     
 Description
 Description

+ 5 - 5
docs/usage/prune.rst.inc

@@ -7,7 +7,7 @@ borg prune
     usage: borg prune [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
     usage: borg prune [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
                       [--no-files-cache] [--umask M] [--remote-path PATH] [-n]
                       [--no-files-cache] [--umask M] [--remote-path PATH] [-n]
                       [-s] [--keep-within WITHIN] [-H HOURLY] [-d DAILY]
                       [-s] [--keep-within WITHIN] [-H HOURLY] [-d DAILY]
-                      [-w WEEKLY] [-m MONTHLY] [-y YEARLY] [-p PREFIX]
+                      [-w WEEKLY] [-m MONTHLY] [-y YEARLY] [-P PREFIX]
                       [--save-space]
                       [--save-space]
                       [REPOSITORY]
                       [REPOSITORY]
     
     
@@ -41,7 +41,7 @@ borg prune
                             number of monthly archives to keep
                             number of monthly archives to keep
       -y YEARLY, --keep-yearly YEARLY
       -y YEARLY, --keep-yearly YEARLY
                             number of yearly archives to keep
                             number of yearly archives to keep
-      -p PREFIX, --prefix PREFIX
+      -P PREFIX, --prefix PREFIX
                             only consider archive names starting with this prefix
                             only consider archive names starting with this prefix
       --save-space          work slower, but using less space
       --save-space          work slower, but using less space
     
     
@@ -52,8 +52,8 @@ The prune command prunes a repository by deleting archives not matching
 any of the specified retention options. This command is normally used by
 any of the specified retention options. This command is normally used by
 automated backup scripts wanting to keep a certain number of historic backups.
 automated backup scripts wanting to keep a certain number of historic backups.
 
 
-As an example, "-d 7" means to keep the latest backup on each day for 7 days.
-Days without backups do not count towards the total.
+As an example, "-d 7" means to keep the latest backup on each day, up to 7
+most recent days with backups (days without backups do not count).
 The rules are applied from hourly to yearly, and backups selected by previous
 The rules are applied from hourly to yearly, and backups selected by previous
 rules do not count towards those of later rules. The time that each backup
 rules do not count towards those of later rules. The time that each backup
 completes is used for pruning purposes. Dates and times are interpreted in
 completes is used for pruning purposes. Dates and times are interpreted in
@@ -66,7 +66,7 @@ to keep all archives that were created within the past 48 hours.
 "1m" is taken to mean "31d". The archives kept with this option do not
 "1m" is taken to mean "31d". The archives kept with this option do not
 count towards the totals specified by any other options.
 count towards the totals specified by any other options.
 
 
-If a prefix is set with -p, then only archives that start with the prefix are
+If a prefix is set with -P, then only archives that start with the prefix are
 considered for deletion and only those archives count towards the totals
 considered for deletion and only those archives count towards the totals
 specified by the rules.
 specified by the rules.
 Otherwise, *all* archives in the repository are candidates for deletion!
 Otherwise, *all* archives in the repository are candidates for deletion!

+ 1 - 1
docs/usage/upgrade.rst.inc

@@ -41,7 +41,7 @@ eventually be extended to cover major Borg upgrades as well.
 It will change the magic strings in the repository's segments
 It will change the magic strings in the repository's segments
 to match the new Borg magic strings. The keyfiles found in
 to match the new Borg magic strings. The keyfiles found in
 $ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and
 $ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and
-copied to $BORG_KEYS_DIR or ~/.borg/keys.
+copied to $BORG_KEYS_DIR or ~/.config/borg/keys.
 
 
 The cache files are converted, from $ATTIC_CACHE_DIR or
 The cache files are converted, from $ATTIC_CACHE_DIR or
 ~/.cache/attic to $BORG_CACHE_DIR or ~/.cache/borg, but the
 ~/.cache/attic to $BORG_CACHE_DIR or ~/.cache/borg, but the