Browse Source

Merge pull request #1733 from ThomasWaldmann/update-usage

Update usage.rst / api.rst
TW 8 years ago
parent
commit
cf9e7adb9f
4 changed files with 23 additions and 6 deletions
  1. 4 0
      docs/api.rst
  2. 9 0
      docs/usage/info.rst.inc
  3. 5 5
      docs/usage/key_export.rst.inc
  4. 5 1
      docs/usage/serve.rst.inc

+ 4 - 0
docs/api.rst

@@ -27,6 +27,10 @@ API Documentation
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
+.. automodule:: borg.keymanager
+    :members:
+    :undoc-members:
+
 .. automodule:: borg.logger
 .. automodule:: borg.logger
     :members:
     :members:
     :undoc-members:
     :undoc-members:

+ 9 - 0
docs/usage/info.rst.inc

@@ -35,3 +35,12 @@ Description
 ~~~~~~~~~~~
 ~~~~~~~~~~~
 
 
 This command displays some detailed information about the specified archive.
 This command displays some detailed information about the specified archive.
+
+Please note that the deduplicated sizes of the individual archives do not add
+up to the deduplicated size of the repository ("all archives"), because the two
+are meaning different things:
+
+This archive / deduplicated size = amount of data stored ONLY for this archive
+                                 = unique chunks of this archive.
+All archives / deduplicated size = amount of data stored in the repo
+                                 = all chunks in the repository.

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

@@ -42,14 +42,14 @@ If repository encryption is used, the repository is inaccessible
 without the key. This command allows to backup this essential key.
 without the key. This command allows to backup this essential key.
 
 
 There are two backup formats. The normal backup format is suitable for
 There are two backup formats. The normal backup format is suitable for
-digital storage as a file. The ``--paper`` backup format is optimized for
-print out and later type-in, with per line checks to reduce problems
-with manual input.
+digital storage as a file. The ``--paper`` backup format is optimized
+for printing and typing in while importing, with per line checks to
+reduce problems with manual input.
 
 
 For repositories using keyfile encryption the key is saved locally
 For repositories using keyfile encryption the key is saved locally
 on the system that is capable of doing backups. To guard against loss
 on the system that is capable of doing backups. To guard against loss
-of this key the key needs to be backed up independent of the main data
-backup.
+of this key, the key needs to be backed up independently of the main
+data backup.
 
 
 For repositories using the repokey encryption the key is saved in the
 For repositories using the repokey encryption the key is saved in the
 repository in the config file. A backup is thus not strictly needed,
 repository in the config file. A backup is thus not strictly needed,

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

@@ -29,7 +29,11 @@ borg serve
       --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")
       --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         only allow appending to repository segment files
       --append-only         only allow appending to repository segment files
     
     
 Description
 Description