diff options
| author | Marian Beermann <public@enkore.de> | 2017-06-20 15:22:24 +0200 |
|---|---|---|
| committer | Marian Beermann <public@enkore.de> | 2017-06-20 15:23:52 +0200 |
| commit | e869e7dc2f88becd181bb8f0602a33341d6b1312 (patch) | |
| tree | 92a7074af7b528e619104573c7018bf2c26c0eae /docs/usage/check.rst.inc | |
| parent | b1747873d92eaa0412398eab1259cc0a5ccfae12 (diff) | |
ran build_usage
Diffstat (limited to 'docs/usage/check.rst.inc')
| -rw-r--r-- | docs/usage/check.rst.inc | 92 |
1 files changed, 69 insertions, 23 deletions
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index ae185a583..918a3af7c 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -8,29 +8,75 @@ borg check borg [common options] check [options] REPOSITORY_OR_ARCHIVE -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 - - -.. class:: borg-common-opt-ref - -: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 +.. only:: html + + .. 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 | + +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | .. class:: borg-common-opt-ref | + | | + | :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 | + +-------------------------------------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. raw:: html + + <script type='text/javascript'> + $(window).load(function () { + $('.borg-options-table colgroup').remove(); + }) + </script> + +.. only:: latex + + 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 + + + :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 Description |