summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2022-12-24 15:34:56 +0100
committerThomas Waldmann <tw@waldmann-edv.de>2022-12-24 18:09:32 +0100
commitec49d60d1f49d6f6c69d8db059473ebd7c8e5e25 (patch)
tree0988ce7a4d587e787e35caa11fecf5fe445cda81
parente4cbd28bdd1a4c9353e6680f0d9ffdee06ffb3be (diff)
build_usage
-rw-r--r--docs/usage/check.rst.inc76
-rw-r--r--docs/usage/compact.rst.inc4
-rw-r--r--docs/usage/config.rst.inc4
-rw-r--r--docs/usage/create.rst.inc8
-rw-r--r--docs/usage/delete.rst.inc96
-rw-r--r--docs/usage/diff.rst.inc4
-rw-r--r--docs/usage/export-tar.rst.inc6
-rw-r--r--docs/usage/extract.rst.inc4
-rw-r--r--docs/usage/help.rst.inc2
-rw-r--r--docs/usage/import-tar.rst.inc6
-rw-r--r--docs/usage/info.rst.inc56
-rw-r--r--docs/usage/init.rst.inc4
-rw-r--r--docs/usage/key_export.rst.inc4
-rw-r--r--docs/usage/key_import.rst.inc4
-rw-r--r--docs/usage/list.rst.inc12
-rw-r--r--docs/usage/mount.rst.inc104
-rw-r--r--docs/usage/prune.rst.inc96
-rw-r--r--docs/usage/recreate.rst.inc4
-rw-r--r--docs/usage/serve.rst.inc4
-rw-r--r--docs/usage/upgrade.rst.inc4
20 files changed, 250 insertions, 252 deletions
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc
index 0f4ff7afb..eebfc5652 100644
--- a/docs/usage/check.rst.inc
+++ b/docs/usage/check.rst.inc
@@ -12,41 +12,41 @@ borg check
.. class:: borg-options-table
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | **positional arguments** |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to check consistency of |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | **optional arguments** |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--repository-only`` | only perform repository checks |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--archives-only`` | only perform archives checks |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--verify-data`` | perform cryptographic archive data integrity verification (conflicts with ``--repository-only``) |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--repair`` | attempt to repair any inconsistencies found |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--save-space`` | work slower, but using less space |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--max-duration SECONDS`` | do only a partial repo check for max. SECONDS seconds (Default: unlimited) |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | .. class:: borg-common-opt-ref |
- | |
- | :ref:`common_options` |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | **Archive filters** — Archive filters can be applied to repository targets. |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``-P PREFIX``, ``--prefix PREFIX`` | only consider archive names starting with this prefix. |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``-a GLOB``, ``--glob-archives GLOB`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--first N`` | consider first N archives after other filters were applied |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--last N`` | consider last N archives after other filters were applied |
- +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | **positional arguments** |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to check consistency of |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | **options** |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--repository-only`` | only perform repository checks |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--archives-only`` | only perform archives checks |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--verify-data`` | perform cryptographic archive data integrity verification (conflicts with ``--repository-only``) |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--repair`` | attempt to repair any inconsistencies found |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--save-space`` | work slower, but using less space |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--max-duration SECONDS`` | do only a partial repo check for max. SECONDS seconds (Default: unlimited) |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | .. class:: borg-common-opt-ref |
+ | |
+ | :ref:`common_options` |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | **Archive filters** — Archive filters can be applied to repository targets. |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``-P PREFIX``, ``--prefix PREFIX`` | only consider archive names starting with this prefix. (deprecated) |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``-a GLOB``, ``--glob-archives GLOB`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--first N`` | consider first N archives after other filters were applied |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--last N`` | consider last N archives after other filters were applied |
+ +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------+
.. raw:: html
@@ -62,7 +62,7 @@ borg check
repository or archive to check consistency of
- optional arguments
+ options
--repository-only only perform repository checks
--archives-only only perform archives checks
--verify-data perform cryptographic archive data integrity verification (conflicts with ``--repository-only``)
@@ -75,8 +75,8 @@ borg check
|
Archive filters
- -P PREFIX, --prefix PREFIX only consider archive names starting with this prefix.
- -a GLOB, --glob-archives GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+ -P PREFIX, --prefix PREFIX only consider archive names starting with this prefix. (deprecated)
+ -a GLOB, --glob-archives GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
--first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied
diff --git a/docs/usage/compact.rst.inc b/docs/usage/compact.rst.inc
index 8187bbf7f..514dbf575 100644
--- a/docs/usage/compact.rst.inc
+++ b/docs/usage/compact.rst.inc
@@ -17,7 +17,7 @@ borg compact
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
| | ``REPOSITORY`` | repository to compact |
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
- | **optional arguments** |
+ | **options** |
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
| | ``--cleanup-commits`` | cleanup commit-only 17-byte segment files |
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
@@ -42,7 +42,7 @@ borg compact
repository to compact
- optional arguments
+ options
--cleanup-commits cleanup commit-only 17-byte segment files
--threshold PERCENT set minimum threshold for saved space in PERCENT (Default: 10)
diff --git a/docs/usage/config.rst.inc b/docs/usage/config.rst.inc
index d90c327ee..fdb44bf83 100644
--- a/docs/usage/config.rst.inc
+++ b/docs/usage/config.rst.inc
@@ -21,7 +21,7 @@ borg config
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``VALUE`` | new value for key |
+-------------------------------------------------------+----------------------+----------------------------------------+
- | **optional arguments** |
+ | **options** |
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``-c``, ``--cache`` | get and set values from the repo cache |
+-------------------------------------------------------+----------------------+----------------------------------------+
@@ -52,7 +52,7 @@ borg config
new value for key
- optional arguments
+ options
-c, --cache get and set values from the repo cache
-d, --delete delete the key from the config file
-l, --list list the configuration of the repo
diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc
index b61fb9794..68fa29184 100644
--- a/docs/usage/create.rst.inc
+++ b/docs/usage/create.rst.inc
@@ -19,7 +19,7 @@ borg create
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``PATH`` | paths to archive |
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
- | **optional arguments** |
+ | **options** |
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``-n``, ``--dry-run`` | do not create a backup archive |
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -37,7 +37,7 @@ borg create
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--stdin-user USER`` | set user USER in archive for stdin data (default: 'root') |
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--stdin-group GROUP`` | set group GROUP in archive for stdin data (default: 'root') |
+ | | ``--stdin-group GROUP`` | set group GROUP in archive for stdin data (default: 'wheel') |
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--stdin-mode M`` | set mode to M in archive for stdin data (default: 0660) |
+-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -130,7 +130,7 @@ borg create
paths to archive
- optional arguments
+ options
-n, --dry-run do not create a backup archive
-s, --stats print statistics for the created archive
--list output verbose list of items (files, dirs, ...)
@@ -139,7 +139,7 @@ borg create
--no-cache-sync experimental: do not synchronize the cache. Implies not using the files cache.
--stdin-name NAME use NAME in archive for stdin data (default: 'stdin')
--stdin-user USER set user USER in archive for stdin data (default: 'root')
- --stdin-group GROUP set group GROUP in archive for stdin data (default: 'root')
+ --stdin-group GROUP set group GROUP in archive for stdin data (default: 'wheel')
--stdin-mode M set mode to M in archive for stdin data (default: 0660)
--content-from-command interpret PATH as command and store its stdout. See also section Reading from stdin below.
--paths-from-stdin read DELIM-separated list of paths to backup from stdin. Will not recurse into directories.
diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc
index 84b01f04c..20bc8a843 100644
--- a/docs/usage/delete.rst.inc
+++ b/docs/usage/delete.rst.inc
@@ -12,47 +12,47 @@ borg delete
.. class:: borg-options-table
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | **positional arguments** |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to delete |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``ARCHIVE`` | archives to delete |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | **optional arguments** |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``-n``, ``--dry-run`` | do not change repository |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--list`` | output verbose list of archives |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``-s``, ``--stats`` | print statistics for the deleted archive |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--cache-only`` | delete only the local cache for the given repository |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--force`` | force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work. |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--keep-security-info`` | keep the local security info when deleting a repository |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--save-space`` | work slower, but using less space |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``-c SECONDS``, ``--checkpoint-interval SECONDS`` | write checkpoint every SECONDS seconds (Default: 1800) |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | .. class:: borg-common-opt-ref |
- | |
- | :ref:`common_options` |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | **Archive filters** — Archive filters can be applied to repository targets. |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``-P PREFIX``, ``--prefix PREFIX`` | only consider archive names starting with this prefix. |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``-a GLOB``, ``--glob-archives GLOB`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive. |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--first N`` | consider first N archives after other filters were applied |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
- | | ``--last N`` | consider last N archives after other filters were applied |
- +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | **positional arguments** |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to delete |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``ARCHIVE`` | archives to delete |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | **options** |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``-n``, ``--dry-run`` | do not change repository |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--list`` | output verbose list of archives |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``-s``, ``--stats`` | print statistics for the deleted archive |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--cache-only`` | delete only the local cache for the given repository |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--force`` | force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work. |
+ +-----------------------------------------------------------------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------+
+ | | ``--keep-security-info`` | keep the local security info when deleting a repository |
+ +-------------------------------------------------------------------