From a7c370b5ed7fb6a692685eb94bc271f9b5308ee3 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Sun, 21 Aug 2016 23:37:07 +0200 Subject: [PATCH] add debug-info usage help file --- docs/usage/debug-info.rst.inc | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/usage/debug-info.rst.inc diff --git a/docs/usage/debug-info.rst.inc b/docs/usage/debug-info.rst.inc new file mode 100644 index 000000000..2f4f7237f --- /dev/null +++ b/docs/usage/debug-info.rst.inc @@ -0,0 +1,35 @@ +.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! + +.. _borg_debug-info: + +borg debug-info +--------------- +:: + + usage: borg debug-info [-h] [--critical] [--error] [--warning] [--info] + [--debug] [--lock-wait N] [--show-rc] + [--no-files-cache] [--umask M] [--remote-path PATH] + + display system information for debugging / bug reports + + 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-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") + +Description +~~~~~~~~~~~ + +This command displays some system information that might be useful for bug +reports and debugging problems. If a traceback happens, this information is +already appended at the end of the traceback.