Browse Source

run setup.py build_usage

Thomas Waldmann 8 years ago
parent
commit
82cd1fd392
3 changed files with 7 additions and 12 deletions
  1. 2 0
      docs/usage/list.rst.inc
  2. 4 11
      docs/usage/recreate.rst.inc
  3. 1 1
      docs/usage/serve.rst.inc

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

@@ -95,3 +95,5 @@ The following keys are available for --format:
  - archiveid
  - archiveid
  - archivename
  - archivename
  - extra: prepends {source} with " -> " for soft links and " link to " for hard links
  - extra: prepends {source} with " -> " for soft links and " link to " for hard links
+
+ - health: either "healthy" (file ok) or "broken" (if file has all-zero replacement chunks)

+ 4 - 11
docs/usage/recreate.rst.inc

@@ -64,6 +64,8 @@ Description
 
 
 Recreate the contents of existing archives.
 Recreate the contents of existing archives.
 
 
+This is an *experimental* feature. Do *not* use this on your only backup.
+
 --exclude, --exclude-from and PATH have the exact same semantics
 --exclude, --exclude-from and PATH have the exact same semantics
 as in "borg create". If PATHs are specified the resulting archive
 as in "borg create". If PATHs are specified the resulting archive
 will only contain files from these PATHs.
 will only contain files from these PATHs.
@@ -80,15 +82,6 @@ There is no risk of data loss by this.
 used to have upgraded Borg 0.xx or Attic archives deduplicate with
 used to have upgraded Borg 0.xx or Attic archives deduplicate with
 Borg 1.x archives.
 Borg 1.x archives.
 
 
-borg recreate is signal safe. Send either SIGINT (Ctrl-C on most terminals) or
-SIGTERM to request termination.
-
-Use the *exact same* command line to resume the operation later - changing excludes
-or paths will lead to inconsistencies (changed excludes will only apply to newly
-processed files/dirs). Changing compression leads to incorrect size information
-(which does not cause any data loss, but can be misleading).
-Changing chunker params between invocations might lead to data loss.
-
 USE WITH CAUTION.
 USE WITH CAUTION.
 Depending on the PATHs and patterns given, recreate can be used to permanently
 Depending on the PATHs and patterns given, recreate can be used to permanently
 delete files from archives.
 delete files from archives.
@@ -103,5 +96,5 @@ With --target the original archive is not replaced, instead a new archive is cre
 
 
 When rechunking space usage can be substantial, expect at least the entire
 When rechunking space usage can be substantial, expect at least the entire
 deduplicated size of the archives using the previous chunker params.
 deduplicated size of the archives using the previous chunker params.
-When recompressing approximately 1 % of the repository size or 512 MB
-(whichever is greater) of additional space is used.
+When recompressing expect approx. (throughput / checkpoint-interval) in space usage,
+assuming all chunks are recompressed.

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

@@ -10,7 +10,7 @@ borg serve
 
 
 optional arguments
 optional arguments
     ``--restrict-to-path PATH``
     ``--restrict-to-path PATH``
-        | restrict repository access to PATH
+        | restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.
     ``--append-only``
     ``--append-only``
         | only allow appending to repository segment files
         | only allow appending to repository segment files