summaryrefslogtreecommitdiffstats
path: root/docs/usage/check.rst.inc
diff options
context:
space:
mode:
authorJonas Borgström <jonas@borgstrom.se>2014-02-04 23:49:10 +0100
committerJonas Borgström <jonas@borgstrom.se>2014-02-05 00:04:30 +0100
commitfaedaf8160a5487a6074faccb9f5a9793bd229a1 (patch)
tree2c068872321bae5ab75d03c299fadf0a2bb8e079 /docs/usage/check.rst.inc
parentb5037cf460a212129fd5378742e1fe3401acf5f6 (diff)
Basic repository consistency check functionality.
Still no archive metadata validation or repair functionality.
Diffstat (limited to 'docs/usage/check.rst.inc')
-rw-r--r--docs/usage/check.rst.inc28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc
new file mode 100644
index 000000000..08fd36193
--- /dev/null
+++ b/docs/usage/check.rst.inc
@@ -0,0 +1,28 @@
+.. _attic_check:
+
+attic check
+-----------
+::
+
+
+ usage: attic check [-h] [-v] [--progress] [--no-progress] REPOSITORY
+
+ Check repository consistency
+
+ positional arguments:
+ REPOSITORY repository to check consistency of
+
+ optional arguments:
+ -h, --help show this help message and exit
+ -v, --verbose verbose output
+ --progress Report progress status to standard output stream
+ --no-progress Disable progress reporting
+
+ Progress status will be reported on the standard output stream by default when
+ it is attached to a terminal. Any problems found are printed to the standard
+ error stream and the command will have a non zero exit code.
+
+Description
+~~~~~~~~~~~
+
+