diff --git a/docs/api.rst b/docs/api.rst index 628d21d13..7f56c4f77 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -2,43 +2,15 @@ API Documentation ================= -.. automodule:: borg.archiver - :members: - :undoc-members: - -.. automodule:: borg.upgrader - :members: - :undoc-members: - -.. automodule:: borg.archive - :members: - :undoc-members: - -.. automodule:: borg.fuse - :members: - :undoc-members: - .. automodule:: borg.platform :members: :undoc-members: -.. automodule:: borg.locking - :members: - :undoc-members: - .. automodule:: borg.shellpattern :members: :undoc-members: -.. automodule:: borg.repository - :members: - :undoc-members: - -.. automodule:: borg.lrucache - :members: - :undoc-members: - -.. automodule:: borg.remote +.. automodule:: borg.locking :members: :undoc-members: @@ -46,7 +18,19 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.xattr +.. automodule:: borg.logger + :members: + :undoc-members: + +.. automodule:: borg.remote + :members: + :undoc-members: + +.. automodule:: borg.fuse + :members: + :undoc-members: + +.. automodule:: borg.archive :members: :undoc-members: @@ -54,6 +38,22 @@ API Documentation :members: :undoc-members: +.. automodule:: borg.lrucache + :members: + :undoc-members: + +.. automodule:: borg.xattr + :members: + :undoc-members: + +.. automodule:: borg.archiver + :members: + :undoc-members: + +.. automodule:: borg.repository + :members: + :undoc-members: + .. automodule:: borg.cache :members: :undoc-members: @@ -62,7 +62,7 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.logger +.. automodule:: borg.upgrader :members: :undoc-members: @@ -70,19 +70,11 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.platform_linux - :members: - :undoc-members: - -.. automodule:: borg.hashindex - :members: - :undoc-members: - .. automodule:: borg.compress :members: :undoc-members: -.. automodule:: borg.chunker +.. automodule:: borg.platform_linux :members: :undoc-members: @@ -90,6 +82,14 @@ API Documentation :members: :undoc-members: +.. automodule:: borg.chunker + :members: + :undoc-members: + .. automodule:: borg.platform_freebsd :members: :undoc-members: + +.. automodule:: borg.hashindex + :members: + :undoc-members: diff --git a/docs/usage/break-lock.rst.inc b/docs/usage/break-lock.rst.inc index d59b1dc05..4edef5c23 100644 --- a/docs/usage/break-lock.rst.inc +++ b/docs/usage/break-lock.rst.inc @@ -4,7 +4,8 @@ borg break-lock --------------- :: - usage: borg break-lock [-h] [-v] [--debug] [--lock-wait N] [--show-rc] + usage: borg break-lock [-h] [--critical] [--error] [--warning] [--info] + [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] REPOSITORY @@ -15,10 +16,12 @@ borg break-lock optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/change-passphrase.rst.inc b/docs/usage/change-passphrase.rst.inc index eb52399c3..08ba4ee9f 100644 --- a/docs/usage/change-passphrase.rst.inc +++ b/docs/usage/change-passphrase.rst.inc @@ -4,7 +4,8 @@ borg change-passphrase ---------------------- :: - usage: borg change-passphrase [-h] [-v] [--debug] [--lock-wait N] [--show-rc] + usage: borg change-passphrase [-h] [--critical] [--error] [--warning] [--info] + [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] [REPOSITORY] @@ -16,10 +17,12 @@ borg change-passphrase optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index b22d75383..9ad6a4b35 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -4,10 +4,10 @@ borg check ---------- :: - usage: borg check [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] - [--repository-only] [--archives-only] [--repair] - [--save-space] [--last N] [-P PREFIX] + usage: borg check [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--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 @@ -18,10 +18,12 @@ borg check optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index 6ec3e7de7..ec9e7dc66 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -4,15 +4,16 @@ borg create ----------- :: - usage: borg create [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] [-s] - [-p] [--list] [--filter STATUSCHARS] [-e PATTERN] + usage: borg create [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-s] [-p] [--list] + [--filter STATUSCHARS] [-e PATTERN] [--exclude-from EXCLUDEFILE] [--exclude-caches] [--exclude-if-present FILENAME] [--keep-tag-files] [-c SECONDS] [-x] [--numeric-owner] [--timestamp yyyy-mm-ddThh:mm:ss] [--chunker-params CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,HASH_WINDOW_SIZE] - [-C COMPRESSION] [--read-special] [-n] + [--ignore-inode] [-C COMPRESSION] [--read-special] [-n] ARCHIVE PATH [PATH ...] Create new archive @@ -24,10 +25,12 @@ borg create optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 @@ -60,6 +63,8 @@ borg create alternatively, give a reference file/directory. --chunker-params CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,HASH_WINDOW_SIZE specify the chunker parameters. default: 19,23,21,4095 + --ignore-inode ignore inode data in the file metadata cache used to + detect unchanged files. -C COMPRESSION, --compression COMPRESSION select compression algorithm (and level): none == no compression (default), lz4 == lz4, zlib == zlib @@ -77,4 +82,10 @@ This command creates a backup archive containing all files found while recursive traversing all paths specified. The archive will consume almost no disk space for files or parts of files that have already been stored in other archives. + +To speed up pulling backups over sshfs and similar network file systems which do +not provide correct inode information the --ignore-inode flag can be used. This +potentially decreases reliability of change detection, while avoiding always reading +all files on these file systems. + See the output of the "borg help patterns" command for more help on exclude patterns. diff --git a/docs/usage/debug-delete-obj.rst.inc b/docs/usage/debug-delete-obj.rst.inc index b02d7b721..bfc31043a 100644 --- a/docs/usage/debug-delete-obj.rst.inc +++ b/docs/usage/debug-delete-obj.rst.inc @@ -4,7 +4,8 @@ borg debug-delete-obj --------------------- :: - usage: borg debug-delete-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc] + usage: borg debug-delete-obj [-h] [--critical] [--error] [--warning] [--info] + [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] [REPOSITORY] IDs [IDs ...] @@ -17,10 +18,12 @@ borg debug-delete-obj optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/debug-dump-archive-items.rst.inc b/docs/usage/debug-dump-archive-items.rst.inc index 9265f2c09..fd2cd62c9 100644 --- a/docs/usage/debug-dump-archive-items.rst.inc +++ b/docs/usage/debug-dump-archive-items.rst.inc @@ -4,7 +4,8 @@ borg debug-dump-archive-items ----------------------------- :: - usage: borg debug-dump-archive-items [-h] [-v] [--debug] [--lock-wait N] + usage: borg debug-dump-archive-items [-h] [--critical] [--error] [--warning] + [--info] [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] ARCHIVE @@ -16,10 +17,12 @@ borg debug-dump-archive-items optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/debug-get-obj.rst.inc b/docs/usage/debug-get-obj.rst.inc index f3213152a..ef5b78d38 100644 --- a/docs/usage/debug-get-obj.rst.inc +++ b/docs/usage/debug-get-obj.rst.inc @@ -4,7 +4,8 @@ borg debug-get-obj ------------------ :: - usage: borg debug-get-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc] + usage: borg debug-get-obj [-h] [--critical] [--error] [--warning] [--info] + [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] [REPOSITORY] ID PATH @@ -17,10 +18,12 @@ borg debug-get-obj optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/debug-put-obj.rst.inc b/docs/usage/debug-put-obj.rst.inc index 44767c271..32a4558da 100644 --- a/docs/usage/debug-put-obj.rst.inc +++ b/docs/usage/debug-put-obj.rst.inc @@ -4,7 +4,8 @@ borg debug-put-obj ------------------ :: - usage: borg debug-put-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc] + usage: borg debug-put-obj [-h] [--critical] [--error] [--warning] [--info] + [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] [REPOSITORY] PATH [PATH ...] @@ -16,10 +17,12 @@ borg debug-put-obj optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index a278cc92e..8e453ab28 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -4,9 +4,9 @@ borg delete ----------- :: - usage: borg delete [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] [-p] - [-s] [-c] [--save-space] + usage: borg delete [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-p] [-s] [-c] [--save-space] [TARGET] Delete an existing repository or archive @@ -16,10 +16,12 @@ borg delete optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc index 8c3a3b9cf..227b254e9 100644 --- a/docs/usage/extract.rst.inc +++ b/docs/usage/extract.rst.inc @@ -4,11 +4,11 @@ borg extract ------------ :: - usage: borg extract [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] - [--list] [-n] [-e PATTERN] [--exclude-from EXCLUDEFILE] - [--numeric-owner] [--strip-components NUMBER] [--stdout] - [--sparse] + usage: borg extract [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [--list] [-n] [-e PATTERN] + [--exclude-from EXCLUDEFILE] [--numeric-owner] + [--strip-components NUMBER] [--stdout] [--sparse] ARCHIVE [PATH [PATH ...]] Extract archive contents @@ -19,10 +19,12 @@ borg extract optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc index 7c2c44b5d..1c57c5b56 100644 --- a/docs/usage/info.rst.inc +++ b/docs/usage/info.rst.inc @@ -4,8 +4,9 @@ borg info --------- :: - usage: borg info [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] + usage: borg info [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] ARCHIVE Show archive details such as disk space used @@ -15,10 +16,12 @@ borg info optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc index 0f37444f2..9af244271 100644 --- a/docs/usage/init.rst.inc +++ b/docs/usage/init.rst.inc @@ -4,9 +4,9 @@ borg init --------- :: - usage: borg init [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] - [-e {none,keyfile,repokey}] + usage: borg init [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-e {none,keyfile,repokey}] [REPOSITORY] Initialize an empty repository @@ -16,10 +16,12 @@ borg init optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc index 33593017f..4725db5e0 100644 --- a/docs/usage/list.rst.inc +++ b/docs/usage/list.rst.inc @@ -4,9 +4,10 @@ borg list --------- :: - usage: borg list [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] [--short] - [--list-format LISTFORMAT] [-P PREFIX] + usage: borg list [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [--short] [--list-format LISTFORMAT] + [-P PREFIX] [REPOSITORY_OR_ARCHIVE] List archive or repository contents @@ -17,10 +18,12 @@ borg list optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/migrate-to-repokey.rst.inc b/docs/usage/migrate-to-repokey.rst.inc index 2f662c70a..674c0f774 100644 --- a/docs/usage/migrate-to-repokey.rst.inc +++ b/docs/usage/migrate-to-repokey.rst.inc @@ -4,7 +4,8 @@ borg migrate-to-repokey ----------------------- :: - usage: borg migrate-to-repokey [-h] [-v] [--debug] [--lock-wait N] [--show-rc] + usage: borg migrate-to-repokey [-h] [--critical] [--error] [--warning] + [--info] [--debug] [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] [--remote-path PATH] [REPOSITORY] @@ -16,10 +17,12 @@ borg migrate-to-repokey optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index 380df549b..b41886aab 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -4,9 +4,9 @@ borg mount ---------- :: - usage: borg mount [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] [-f] - [-o OPTIONS] + usage: borg mount [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-f] [-o OPTIONS] REPOSITORY_OR_ARCHIVE MOUNTPOINT Mount archive or an entire repository as a FUSE fileystem @@ -18,10 +18,12 @@ borg mount optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index 06718004b..3dc67b7fa 100644 --- a/docs/usage/prune.rst.inc +++ b/docs/usage/prune.rst.inc @@ -4,11 +4,11 @@ borg prune ---------- :: - usage: borg prune [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] [-n] - [-s] [--list] [--keep-within WITHIN] [-H HOURLY] [-d DAILY] - [-w WEEKLY] [-m MONTHLY] [-y YEARLY] [-P PREFIX] - [--save-space] + usage: borg prune [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-n] [-s] [--list] + [--keep-within WITHIN] [-H HOURLY] [-d DAILY] [-w WEEKLY] + [-m MONTHLY] [-y YEARLY] [-P PREFIX] [--save-space] [REPOSITORY] Prune repository archives according to specified rules @@ -18,10 +18,12 @@ borg prune optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/rename.rst.inc b/docs/usage/rename.rst.inc index 8e0a4b617..483aa2516 100644 --- a/docs/usage/rename.rst.inc +++ b/docs/usage/rename.rst.inc @@ -4,8 +4,9 @@ borg rename ----------- :: - usage: borg rename [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] + usage: borg rename [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] ARCHIVE NEWNAME Rename an existing archive @@ -16,10 +17,12 @@ borg rename optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/serve.rst.inc b/docs/usage/serve.rst.inc index 1e29ff2a4..70a0c5866 100644 --- a/docs/usage/serve.rst.inc +++ b/docs/usage/serve.rst.inc @@ -4,19 +4,21 @@ borg serve ---------- :: - usage: borg serve [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] - [--restrict-to-path PATH] + usage: borg serve [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [--restrict-to-path PATH] Start in server mode. This command is usually not used manually. optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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 diff --git a/docs/usage/upgrade.rst.inc b/docs/usage/upgrade.rst.inc index 891f645e8..bd920149b 100644 --- a/docs/usage/upgrade.rst.inc +++ b/docs/usage/upgrade.rst.inc @@ -4,9 +4,9 @@ borg upgrade ------------ :: - usage: borg upgrade [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] [-p] - [-n] [-i] + usage: borg upgrade [-h] [--critical] [--error] [--warning] [--info] [--debug] + [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-p] [-n] [-i] [REPOSITORY] upgrade a repository from a previous version @@ -16,10 +16,12 @@ borg upgrade optional arguments: -h, --help show this help message and exit - -v, --verbose, --info - enable informative (verbose) output, work on log level - INFO - --debug enable debug output, work on log level DEBUG + --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