summaryrefslogtreecommitdiffstats
path: root/docs/usage/check.rst.inc
diff options
context:
space:
mode:
authorMarian Beermann <public@enkore.de>2017-06-20 11:49:26 +0200
committerMarian Beermann <public@enkore.de>2017-06-20 11:49:26 +0200
commite5012b11cafc8ce7f3d2b3e552094672cba458e6 (patch)
treec2a6cbd413a85ca778efddaa43dc6d46e0c3b3cf /docs/usage/check.rst.inc
parent6290b73863b8098a4bf6f5d28e7a2cb1361277df (diff)
ran build_usage
Diffstat (limited to 'docs/usage/check.rst.inc')
-rw-r--r--docs/usage/check.rst.inc38
1 files changed, 15 insertions, 23 deletions
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc
index 047da6b28..ad31b6a2c 100644
--- a/docs/usage/check.rst.inc
+++ b/docs/usage/check.rst.inc
@@ -8,36 +8,28 @@ borg check
borg [common options] check [options] REPOSITORY_OR_ARCHIVE
-positional arguments
- REPOSITORY_OR_ARCHIVE
- repository or archive to check consistency of
+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
+ --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
+
:ref:`common_options`
|
filters
- ``-P``, ``--prefix``
- | only consider archive names starting with this prefix.
- ``-a``, ``--glob-archives``
- | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
- ``--sort-by``
- | 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
+ -P, --prefix only consider archive names starting with this prefix.
+ -a, --glob-archives only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+ --sort-by 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
+
Description
~~~~~~~~~~~