build_usage

docs/usage/benchmark_crud.rst.inc

@@ -6,23 +6,23 @@ borg benchmark crud
 -------------------
 .. code-block:: none
 
-    borg [common options] benchmark crud [options] REPO PATH
+    borg [common options] benchmark crud [options] REPOSITORY PATH
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+----------+------------------------------------------+
-    | **positional arguments**                                                                                    |
-    +-------------------------------------------------------+----------+------------------------------------------+
-    |                                                       | ``REPO`` | repo to use for benchmark (must exist)   |
-    +-------------------------------------------------------+----------+------------------------------------------+
-    |                                                       | ``PATH`` | path were to create benchmark input data |
-    +-------------------------------------------------------+----------+------------------------------------------+
-    | .. class:: borg-common-opt-ref                                                                              |
-    |                                                                                                             |
-    | :ref:`common_options`                                                                                       |
-    +-------------------------------------------------------+----------+------------------------------------------+
+    +-------------------------------------------------------+----------------+----------------------------------------------+
+    | **positional arguments**                                                                                              |
+    +-------------------------------------------------------+----------------+----------------------------------------------+
+    |                                                       | ``REPOSITORY`` | repository to use for benchmark (must exist) |
+    +-------------------------------------------------------+----------------+----------------------------------------------+
+    |                                                       | ``PATH``       | path were to create benchmark input data     |
+    +-------------------------------------------------------+----------------+----------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                        |
+    |                                                                                                                       |
+    | :ref:`common_options`                                                                                                 |
+    +-------------------------------------------------------+----------------+----------------------------------------------+
 
     .. raw:: html
 
@@ -34,8 +34,8 @@ borg benchmark crud
 
 .. only:: latex
 
-    REPO
-        repo to use for benchmark (must exist)
+    REPOSITORY
+        repository to use for benchmark (must exist)
     PATH
         path were to create benchmark input data
 
@@ -54,12 +54,9 @@ command will create / read / update / delete some archives named borg-benchmark-
 
 Make sure you have free space there, you'll need about 1GB each (+ overhead).
 
-Important: The space used in the repository will **not** be freed until you run
-``borg compact``.
+If your repository is encrypted and borg needs a passphrase to unlock the key, use::
 
-If your repository is encrypted and borg needs a passphrase to unlock the key, use:
-
-BORG_PASSPHRASE=mysecret borg benchmark crud REPO PATH
+    BORG_PASSPHRASE=mysecret borg benchmark crud REPO PATH
 
 Measurements are done with different input file sizes and counts.
 The file contents are very artificial (either all zero or all random),

docs/usage/compact.rst.inc

@@ -6,7 +6,7 @@ borg compact
 ------------
 .. code-block:: none
 
-    borg [common options] compact [options] REPOSITORY
+    borg [common options] compact [options] [REPOSITORY]
 
 .. only:: html
 
@@ -53,11 +53,19 @@ Description
 This command frees repository space by compacting segments.
 
 Use this regularly to avoid running out of space - you do not need to use this
-after each borg command though.
+after each borg command though. It is especially useful after deleting archives,
+because only compaction will really free repository space.
 
 borg compact does not need a key, so it is possible to invoke it from the
 client or also from the server.
 
-Depending on the amount of segments that need compaction, it may take a while.
+Depending on the amount of segments that need compaction, it may take a while,
+so consider using the ``--progress`` option.
+
+When using ``--verbose``, borg will output an estimate of the freed space.
+
+After upgrading borg (server) to 1.2+, you can use ``borg compact --cleanup-commits``
+to clean up the numerous 17byte commit-only segments that borg 1.1 did not clean up
+due to a bug. It is enough to do that once per repository.
 
 See :ref:`separate_compaction` in Additional Notes for more details.

docs/usage/config.rst.inc

@@ -6,7 +6,7 @@ borg config
 -----------
 .. code-block:: none
 
-    borg [common options] config [options] REPOSITORY [NAME] [VALUE]
+    borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]
 
 .. only:: html
 

docs/usage/create.rst.inc

@@ -65,6 +65,8 @@ borg create
     +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--noatime``                                     | do not store atime into archive                                                                                                                   |
     +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--atime``                                       | do store atime into archive                                                                                                                       |
+    +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--noctime``                                     | do not store ctime into archive                                                                                                                   |
     +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--nobirthtime``                                 | do not store birthtime (creation date) into archive                                                                                               |
@@ -132,6 +134,7 @@ borg create
         -x, --one-file-system     stay in the same file system and do not store mount points of other file systems
         --numeric-owner           only store numeric user and group identifiers
         --noatime                 do not store atime into archive
+        --atime                   do store atime into archive
         --noctime                 do not store ctime into archive
         --nobirthtime             do not store birthtime (creation date) into archive
         --nobsdflags              do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive

docs/usage/delete.rst.inc

@@ -6,7 +6,7 @@ borg delete
 -----------
 .. code-block:: none
 
-    borg [common options] delete [options] [TARGET] [ARCHIVE...]
+    borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
 
 .. only:: html
 
@@ -15,7 +15,7 @@ borg delete
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                                                                                     |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``TARGET``                            | archive or repository to delete                                                                                                                        |
+    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository or archive to delete                                                                                                                        |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``ARCHIVE``                           | archives to delete                                                                                                                                     |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -58,8 +58,8 @@ borg delete
 
 .. only:: latex
 
-    TARGET
-        archive or repository to delete
+    REPOSITORY_OR_ARCHIVE
+        repository or archive to delete
     ARCHIVE
         archives to delete
 

docs/usage/help.rst.inc

@@ -171,6 +171,8 @@ Examples::
         + /home/susan
         # don't backup the other home directories
         - /home/*
+        # don't even look in /proc
+        ! /proc
 
 .. _borg_placeholders:
 
@@ -178,8 +180,8 @@ borg help placeholders
 ~~~~~~~~~~~~~~~~~~~~~~
 
 
-Repository (or Archive) URLs, ``--prefix`` and ``--remote-path`` values support these
-placeholders:
+Repository (or Archive) URLs, ``--prefix``, ``--glob-archives``, ``--comment``
+and ``--remote-path`` values support these placeholders:
 
 {hostname}
     The (short) hostname of the machine.

docs/usage/info.rst.inc

@@ -15,7 +15,7 @@ borg info
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                                                                                     |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | archive or repository to display information about                                                                                                     |
+    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository or archive to display information about                                                                                                     |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **optional arguments**                                                                                                                                                                                                                                                       |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -49,7 +49,7 @@ borg info
 .. only:: latex
 
     REPOSITORY_OR_ARCHIVE
-        archive or repository to display information about
+        repository or archive to display information about
 
 
     optional arguments

docs/usage/list.rst.inc

@@ -15,7 +15,7 @@ borg list
     +-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                                                                                                                                                                                                               |
     +-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY_OR_ARCHIVE``                     | repository/archive to list contents of                                                                                                                                                                                                                                   |
+    |                                                                             | ``REPOSITORY_OR_ARCHIVE``                     | repository or archive to list contents of                                                                                                                                                                                                                                |
     +-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``PATH``                                      | paths to list; patterns are supported                                                                                                                                                                                                                                    |
     +-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -67,7 +67,7 @@ borg list
 .. only:: latex
 
     REPOSITORY_OR_ARCHIVE
-        repository/archive to list contents of
+        repository or archive to list contents of
     PATH
         paths to list; patterns are supported
 
@@ -167,6 +167,7 @@ Keys for listing archive files:
 - sha256
 - sha384
 - sha512
+- xxh64: XXH64 checksum of this file (note: this is NOT a cryptographic hash!)
 
 - archiveid
 - archivename

docs/usage/mount.rst.inc

@@ -15,7 +15,7 @@ borg mount
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                                                                                     |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository/archive to mount                                                                                                                            |
+    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository or archive to mount                                                                                                                         |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``MOUNTPOINT``                        | where to mount filesystem                                                                                                                              |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -67,7 +67,7 @@ borg mount
 .. only:: latex
 
     REPOSITORY_OR_ARCHIVE
-        repository/archive to mount
+        repository or archive to mount
     MOUNTPOINT
         where to mount filesystem
     PATH

docs/usage/recreate.rst.inc

@@ -15,7 +15,7 @@ borg recreate
     +-------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
     +-------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``REPOSITORY_OR_ARCHIVE``                         | repository/archive to recreate                                                                                                                                                                                                                                                                                                                                             |
+    |                                                       | ``REPOSITORY_OR_ARCHIVE``                         | repository or archive to recreate                                                                                                                                                                                                                                                                                                                                          |
     +-------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``PATH``                                          | paths to recreate; patterns are supported                                                                                                                                                                                                                                                                                                                                  |
     +-------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -77,7 +77,7 @@ borg recreate
 .. only:: latex
 
     REPOSITORY_OR_ARCHIVE
-        repository/archive to recreate
+        repository or archive to recreate
     PATH
         paths to recreate; patterns are supported
 

docs/usage/upgrade.rst.inc

@@ -126,7 +126,7 @@ due to the cache resync.
 Upgrade should be able to resume if interrupted, although it
 will still iterate over all segments. If you want to start
 from scratch, use `borg delete` over the copied repository to
-make sure the cache files are also removed:
+make sure the cache files are also removed::
 
     borg delete borg