From 0a369c0985ef9d0705b4d280fd4cf72598c165f5 Mon Sep 17 00:00:00 2001 From: Marian Beermann Date: Sun, 10 Apr 2016 01:28:18 +0200 Subject: Better help texts and Sphinx reproduction of usage - Group options - Nicer list of options in Sphinx - Deduplicate 'Common options' (including --help) The latter is done by explicitly declaring --help in the common_parser, which is then inherited by the sub-parsers; no change in observable behaviour. --- docs/usage/check.rst.inc | 59 +++++++++++++++++++----------------------------- 1 file changed, 23 insertions(+), 36 deletions(-) (limited to 'docs/usage/check.rst.inc') diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index 52355ab66..4dd5b05fb 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -4,42 +4,29 @@ borg check ---------- :: - usage: borg check [-h] [--critical] [--error] [--warning] [--info] [--debug] - [--lock-wait N] [--show-version] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] - [--repository-only] [--archives-only] [--repair] - [--save-space] [--last N] [-P PREFIX] - [REPOSITORY_OR_ARCHIVE] - - Check repository consistency - - positional arguments: - REPOSITORY_OR_ARCHIVE - repository or archive to check consistency of - - optional arguments: - -h, --help show this help message and exit - --critical work on log level CRITICAL - --error work on log level ERROR - --warning work on log level WARNING (default) - --info, -v, --verbose - work on log level INFO - --debug work on log level DEBUG - --lock-wait N wait for the lock, but max. N seconds (default: 1). - --show-version show/log the borg version - --show-rc show/log the return code (rc) - --no-files-cache do not load/update the file metadata cache used to - detect unchanged files - --umask M set umask to M (local and remote, default: 0077) - --remote-path PATH set remote path to executable (default: "borg") - --repository-only only perform repository checks - --archives-only only perform archives checks - --repair attempt to repair any inconsistencies found - --save-space work slower, but using less space - --last N only check last N archives (Default: all) - -P PREFIX, --prefix PREFIX - only consider archive names starting with this prefix - + borg check REPOSITORY_OR_ARCHIVE + +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 + ``--repair`` + | attempt to repair any inconsistencies found + ``--save-space`` + | work slower, but using less space + ``--last N`` + | only check last N archives (Default: all) + ``-P``, ``--prefix`` + | only consider archive names starting with this prefix + +`Common options`_ + | + Description ~~~~~~~~~~~ -- cgit v1.2.3