diff options
author | Daniel Reichelt <hacking@nachtgeist.net> | 2016-03-17 03:30:31 +0100 |
---|---|---|
committer | Daniel Reichelt <hacking@nachtgeist.net> | 2016-03-17 14:35:56 +0100 |
commit | 9adf13d8b9825f4bc41d553f3b0ae256ee25c0bd (patch) | |
tree | b6e93f46387a775c276896761745c2e1b32049c7 | |
parent | 6dd5f6a179bfa279a126afaa731c5dfd5c8f28a0 (diff) |
add changes from running build_api and build_usage
-rw-r--r-- | docs/api.rst | 36 | ||||
-rw-r--r-- | docs/usage/break-lock.rst.inc | 6 | ||||
-rw-r--r-- | docs/usage/change-passphrase.rst.inc | 7 | ||||
-rw-r--r-- | docs/usage/check.rst.inc | 9 | ||||
-rw-r--r-- | docs/usage/create.rst.inc | 18 | ||||
-rw-r--r-- | docs/usage/debug-delete-obj.rst.inc | 7 | ||||
-rw-r--r-- | docs/usage/debug-dump-archive-items.rst.inc | 6 | ||||
-rw-r--r-- | docs/usage/debug-get-obj.rst.inc | 6 | ||||
-rw-r--r-- | docs/usage/debug-put-obj.rst.inc | 6 | ||||
-rw-r--r-- | docs/usage/delete.rst.inc | 7 | ||||
-rw-r--r-- | docs/usage/diff.rst.inc | 51 | ||||
-rw-r--r-- | docs/usage/extract.rst.inc | 11 | ||||
-rw-r--r-- | docs/usage/info.rst.inc | 6 | ||||
-rw-r--r-- | docs/usage/init.rst.inc | 7 | ||||
-rw-r--r-- | docs/usage/list.rst.inc | 8 | ||||
-rw-r--r-- | docs/usage/migrate-to-repokey.rst.inc | 7 | ||||
-rw-r--r-- | docs/usage/mount.rst.inc | 7 | ||||
-rw-r--r-- | docs/usage/prune.rst.inc | 11 | ||||
-rw-r--r-- | docs/usage/rename.rst.inc | 6 | ||||
-rw-r--r-- | docs/usage/serve.rst.inc | 7 | ||||
-rw-r--r-- | docs/usage/upgrade.rst.inc | 7 |
21 files changed, 161 insertions, 75 deletions
diff --git a/docs/api.rst b/docs/api.rst index 628d21d13..bdef963a5 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -2,11 +2,11 @@ API Documentation ================= -.. automodule:: borg.archiver +.. automodule:: borg.xattr :members: :undoc-members: -.. automodule:: borg.upgrader +.. automodule:: borg.hash_sizes :members: :undoc-members: @@ -14,7 +14,7 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.fuse +.. automodule:: borg.repository :members: :undoc-members: @@ -22,55 +22,55 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.locking +.. automodule:: borg.cache :members: :undoc-members: -.. automodule:: borg.shellpattern +.. automodule:: borg.helpers :members: :undoc-members: -.. automodule:: borg.repository +.. automodule:: borg.lrucache :members: :undoc-members: -.. automodule:: borg.lrucache +.. automodule:: borg.key :members: :undoc-members: -.. automodule:: borg.remote +.. automodule:: borg.upgrader :members: :undoc-members: -.. automodule:: borg.hash_sizes +.. automodule:: borg.shellpattern :members: :undoc-members: -.. automodule:: borg.xattr +.. automodule:: borg.locking :members: :undoc-members: -.. automodule:: borg.helpers +.. automodule:: borg.fuse :members: :undoc-members: -.. automodule:: borg.cache +.. automodule:: borg.logger :members: :undoc-members: -.. automodule:: borg.key +.. automodule:: borg.archiver :members: :undoc-members: -.. automodule:: borg.logger +.. automodule:: borg.remote :members: :undoc-members: -.. automodule:: borg.platform_darwin +.. automodule:: borg.chunker :members: :undoc-members: -.. automodule:: borg.platform_linux +.. automodule:: borg.platform_freebsd :members: :undoc-members: @@ -82,7 +82,7 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.chunker +.. automodule:: borg.platform_linux :members: :undoc-members: @@ -90,6 +90,6 @@ API Documentation :members: :undoc-members: -.. automodule:: borg.platform_freebsd +.. automodule:: borg.platform_darwin :members: :undoc-members: diff --git a/docs/usage/break-lock.rst.inc b/docs/usage/break-lock.rst.inc index d59b1dc05..34cb715ce 100644 --- a/docs/usage/break-lock.rst.inc +++ b/docs/usage/break-lock.rst.inc @@ -4,8 +4,9 @@ borg break-lock --------------- :: - usage: borg break-lock [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] + usage: borg break-lock [-h] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] REPOSITORY Break the repository lock (e.g. in case it was left by a dead borg. @@ -20,6 +21,7 @@ borg break-lock INFO --debug enable debug output, 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 diff --git a/docs/usage/change-passphrase.rst.inc b/docs/usage/change-passphrase.rst.inc index eb52399c3..a054bacd1 100644 --- a/docs/usage/change-passphrase.rst.inc +++ b/docs/usage/change-passphrase.rst.inc @@ -4,9 +4,9 @@ borg change-passphrase ---------------------- :: - usage: borg change-passphrase [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] - [--remote-path PATH] + usage: borg change-passphrase [-h] [-v] [--debug] [--lock-wait N] + [--show-version] [--show-rc] [--no-files-cache] + [--umask M] [--remote-path PATH] [REPOSITORY] Change repository key file passphrase @@ -21,6 +21,7 @@ borg change-passphrase INFO --debug enable debug output, 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 diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index b22d75383..ff4690f19 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] [-v] [--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 @@ -23,6 +23,7 @@ borg check INFO --debug enable debug output, 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 diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index 6ec3e7de7..fee55218f 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--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 @@ -29,6 +30,7 @@ borg create INFO --debug enable debug output, 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 @@ -60,6 +62,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 +81,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..228385d6f 100644 --- a/docs/usage/debug-delete-obj.rst.inc +++ b/docs/usage/debug-delete-obj.rst.inc @@ -4,9 +4,9 @@ borg debug-delete-obj --------------------- :: - usage: borg debug-delete-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] - [--remote-path PATH] + usage: borg debug-delete-obj [-h] [-v] [--debug] [--lock-wait N] + [--show-version] [--show-rc] [--no-files-cache] + [--umask M] [--remote-path PATH] [REPOSITORY] IDs [IDs ...] delete the objects with the given IDs from the repo @@ -22,6 +22,7 @@ borg debug-delete-obj INFO --debug enable debug output, 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 diff --git a/docs/usage/debug-dump-archive-items.rst.inc b/docs/usage/debug-dump-archive-items.rst.inc index 9265f2c09..4d51dc549 100644 --- a/docs/usage/debug-dump-archive-items.rst.inc +++ b/docs/usage/debug-dump-archive-items.rst.inc @@ -5,8 +5,9 @@ borg debug-dump-archive-items :: usage: borg debug-dump-archive-items [-h] [-v] [--debug] [--lock-wait N] - [--show-rc] [--no-files-cache] - [--umask M] [--remote-path PATH] + [--show-version] [--show-rc] + [--no-files-cache] [--umask M] + [--remote-path PATH] ARCHIVE dump (decrypted, decompressed) archive items metadata (not: data) @@ -21,6 +22,7 @@ borg debug-dump-archive-items INFO --debug enable debug output, 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 diff --git a/docs/usage/debug-get-obj.rst.inc b/docs/usage/debug-get-obj.rst.inc index f3213152a..f86726c19 100644 --- a/docs/usage/debug-get-obj.rst.inc +++ b/docs/usage/debug-get-obj.rst.inc @@ -4,8 +4,9 @@ borg debug-get-obj ------------------ :: - usage: borg debug-get-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] + usage: borg debug-get-obj [-h] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [REPOSITORY] ID PATH get object contents from the repository and write it into file @@ -22,6 +23,7 @@ borg debug-get-obj INFO --debug enable debug output, 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 diff --git a/docs/usage/debug-put-obj.rst.inc b/docs/usage/debug-put-obj.rst.inc index 44767c271..0597cfc60 100644 --- a/docs/usage/debug-put-obj.rst.inc +++ b/docs/usage/debug-put-obj.rst.inc @@ -4,8 +4,9 @@ borg debug-put-obj ------------------ :: - usage: borg debug-put-obj [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] [--remote-path PATH] + usage: borg debug-put-obj [-h] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [REPOSITORY] PATH [PATH ...] put file(s) contents into the repository @@ -21,6 +22,7 @@ borg debug-put-obj INFO --debug enable debug output, 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 diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index a278cc92e..a8a8fb713 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-p] [-s] [-c] [--save-space] [TARGET] Delete an existing repository or archive @@ -21,6 +21,7 @@ borg delete INFO --debug enable debug output, 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 diff --git a/docs/usage/diff.rst.inc b/docs/usage/diff.rst.inc new file mode 100644 index 000000000..a74ef35ac --- /dev/null +++ b/docs/usage/diff.rst.inc @@ -0,0 +1,51 @@ +.. _borg_diff: + +borg diff +--------- +:: + + usage: borg diff [-h] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-e PATTERN] + [--exclude-from EXCLUDEFILE] [--numeric-owner] + [--same-chunker-params] + ARCHIVE1 ARCHIVE2 [PATH [PATH ...]] + + Diff contents of two archives + + positional arguments: + ARCHIVE1 archive + ARCHIVE2 archive to compare with ARCHIVE1 (no repository + location) + PATH paths to compare; patterns are supported + + 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 + --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") + -e PATTERN, --exclude PATTERN + exclude paths matching PATTERN + --exclude-from EXCLUDEFILE + read exclude patterns from EXCLUDEFILE, one per line + --numeric-owner only consider numeric user and group identifiers + --same-chunker-params + Override check of chunker parameters. + +Description +~~~~~~~~~~~ + +This command finds differences in files (contents, user, group, mode) between archives. + +Both archives need to be in the same repository, and a repository location may only +be specified for ARCHIVE1. + +See the output of the "borg help patterns" command for more help on exclude patterns. diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc index 8c3a3b9cf..2a99f1834 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--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 @@ -24,6 +24,7 @@ borg extract INFO --debug enable debug output, 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 diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc index 7c2c44b5d..dfce74f2a 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] ARCHIVE Show archive details such as disk space used @@ -20,6 +21,7 @@ borg info INFO --debug enable debug output, 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 diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc index 0f37444f2..a98b45a68 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-e {none,keyfile,repokey}] [REPOSITORY] Initialize an empty repository @@ -21,6 +21,7 @@ borg init INFO --debug enable debug output, 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 diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc index 33593017f..02e40b70a 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [--short] [--list-format LISTFORMAT] + [-P PREFIX] [REPOSITORY_OR_ARCHIVE] List archive or repository contents @@ -22,6 +23,7 @@ borg list INFO --debug enable debug output, 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 diff --git a/docs/usage/migrate-to-repokey.rst.inc b/docs/usage/migrate-to-repokey.rst.inc index 2f662c70a..496c505dc 100644 --- a/docs/usage/migrate-to-repokey.rst.inc +++ b/docs/usage/migrate-to-repokey.rst.inc @@ -4,9 +4,9 @@ borg migrate-to-repokey ----------------------- :: - usage: borg migrate-to-repokey [-h] [-v] [--debug] [--lock-wait N] [--show-rc] - [--no-files-cache] [--umask M] - [--remote-path PATH] + usage: borg migrate-to-repokey [-h] [-v] [--debug] [--lock-wait N] + [--show-version] [--show-rc] [--no-files-cache] + [--umask M] [--remote-path PATH] [REPOSITORY] Migrate passphrase -> repokey @@ -21,6 +21,7 @@ borg migrate-to-repokey INFO --debug enable debug output, 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 diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index 310fbc562..8966b5384 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--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 @@ -23,6 +23,7 @@ borg mount INFO --debug enable debug output, 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 diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index 06718004b..3538a6e90 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--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 @@ -23,6 +23,7 @@ borg prune INFO --debug enable debug output, 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 diff --git a/docs/usage/rename.rst.inc b/docs/usage/rename.rst.inc index 8e0a4b617..f3aa80ca2 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] ARCHIVE NEWNAME Rename an existing archive @@ -21,6 +22,7 @@ borg rename INFO --debug enable debug output, 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 diff --git a/docs/usage/serve.rst.inc b/docs/usage/serve.rst.inc index 1e29ff2a4..da652ea5f 100644 --- a/docs/usage/serve.rst.inc +++ b/docs/usage/serve.rst.inc @@ -4,9 +4,9 @@ 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--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. @@ -18,6 +18,7 @@ borg serve INFO --debug enable debug output, 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 diff --git a/docs/usage/upgrade.rst.inc b/docs/usage/upgrade.rst.inc index 891f645e8..0273e9c75 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] [-v] [--debug] [--lock-wait N] [--show-version] + [--show-rc] [--no-files-cache] [--umask M] + [--remote-path PATH] [-p] [-n] [-i] [REPOSITORY] upgrade a repository from a previous version @@ -21,6 +21,7 @@ borg upgrade INFO --debug enable debug output, 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 |