diff --git a/docs/changes.rst b/docs/changes.rst index fe7f19f17..9cc8d67e8 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -214,8 +214,11 @@ The best check that everything is ok is to run a dry-run extraction:: .. _changelog: -Version 1.2.0xx (not released yet) ----------------------------------- +Change Log +========== + +Version 1.2.0b3 (2ß21-05-12) +---------------------------- Please note: @@ -286,7 +289,9 @@ Other changes: - create: add --upload-(ratelimit|buffer), deprecate --remote-* options, #5611 - create/extract/mount: add --numeric-ids, deprecate --numeric-owner option, #5724 - config: accept non-int value for max_segment_size / storage_quota -- use PyInstaller v4.2, #5671 +- use PyInstaller v4.3, #5671 +- vagrant: use Python 3.9.5 to build binaries +- tox.ini: modernize and enable execution without preinstalling deps - cleanup code style checks - get rid of distutils, use setuptools+packaging - github CI: test on Python 3.10-dev diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 2fcfccb2e..c07348d25 100644 --- a/docs/man/borg-benchmark-crud.1 +++ b/docs/man/borg-benchmark-crud.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BENCHMARK-CRUD 1 "2021-02-06" "" "borg backup tool" +.TH BORG-BENCHMARK-CRUD 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. . diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1 index 30b3db5dc..069942370 100644 --- a/docs/man/borg-benchmark.1 +++ b/docs/man/borg-benchmark.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BENCHMARK 1 "2021-02-06" "" "borg backup tool" +.TH BORG-BENCHMARK 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-benchmark \- benchmark command . diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1 index 407c0fdd3..ccc411a3d 100644 --- a/docs/man/borg-break-lock.1 +++ b/docs/man/borg-break-lock.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-BREAK-LOCK 1 "2021-02-06" "" "borg backup tool" +.TH BORG-BREAK-LOCK 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. . diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1 index 227f75c02..dd926fc80 100644 --- a/docs/man/borg-check.1 +++ b/docs/man/borg-check.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CHECK 1 "2021-02-06" "" "borg backup tool" +.TH BORG-CHECK 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency . diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1 index 05e7046be..acd460829 100644 --- a/docs/man/borg-common.1 +++ b/docs/man/borg-common.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMMON 1 "2021-02-06" "" "borg backup tool" +.TH BORG-COMMON 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands . @@ -57,6 +57,9 @@ enable TOPIC debugging (can be specified multiple times). The logger path is bor .B \-p\fP,\fB \-\-progress show progress information .TP +.B \-\-iec +format using IEC units (1KiB = 1024B) +.TP .B \-\-log\-json Output one JSON object per log line instead of formatted text. .TP @@ -79,10 +82,16 @@ set umask to M (local only, default: 0077) use PATH as borg executable on the remote (default: "borg") .TP .BI \-\-remote\-ratelimit \ RATE -set remote network upload rate limit in kiByte/s (default: 0=unlimited) +deprecated, use \fB\-\-upload\-ratelimit\fP instead +.TP +.BI \-\-upload\-ratelimit \ RATE +set network upload rate limit in kiByte/s (default: 0=unlimited) .TP .BI \-\-remote\-buffer \ UPLOAD_BUFFER -set upload buffer size in MiB. (default: 0=no buffer) +deprecated, use \fB\-\-upload\-buffer\fP instead +.TP +.BI \-\-upload\-buffer \ UPLOAD_BUFFER +set network upload buffer size in MiB. (default: 0=no buffer) .TP .B \-\-consider\-part\-files treat part files like normal files (e.g. to list/extract them) diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1 index 69f61dffc..109d1c3bb 100644 --- a/docs/man/borg-compact.1 +++ b/docs/man/borg-compact.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMPACT 1 "2021-02-06" "" "borg backup tool" +.TH BORG-COMPACT 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-compact \- compact segment files in the repository . diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index 998a53ff6..95e45320a 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMPRESSION 1 "2021-02-06" "" "borg backup tool" +.TH BORG-COMPRESSION 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression . diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1 index 9096c9eac..93db8f909 100644 --- a/docs/man/borg-config.1 +++ b/docs/man/borg-config.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CONFIG 1 "2021-02-06" "" "borg backup tool" +.TH BORG-CONFIG 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-config \- get, set, and delete values in a repository or cache config file . diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 51830ac13..7e8fe2a74 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CREATE 1 "2021-02-06" "" "borg backup tool" +.TH BORG-CREATE 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-create \- Create new archive . @@ -211,6 +211,9 @@ exclude files flagged NODUMP stay in the same file system and do not store mount points of other file systems. This might behave different from your expectations, see the docs. .TP .B \-\-numeric\-owner +deprecated, use \fB\-\-numeric\-ids\fP instead +.TP +.B \-\-numeric\-ids only store numeric user and group identifiers .TP .B \-\-noatime @@ -231,6 +234,12 @@ deprecated, use \fB\-\-noflags\fP instead .B \-\-noflags do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive .TP +.B \-\-noacls +do not read and store ACLs into archive +.TP +.B \-\-noxattrs +do not read and store xattrs into archive +.TP .B \-\-sparse detect sparse holes in input (supported only by fixed chunker) .TP diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index c13c1e4aa..8d8f7afc7 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-DELETE 1 "2021-02-06" "" "borg backup tool" +.TH BORG-DELETE 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives . diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index bcf4443b7..6e8d70447 100644 --- a/docs/man/borg-diff.1 +++ b/docs/man/borg-diff.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-DIFF 1 "2021-02-06" "" "borg backup tool" +.TH BORG-DIFF 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives . @@ -70,6 +70,9 @@ paths of items inside the archives to compare; patterns are supported .INDENT 0.0 .TP .B \-\-numeric\-owner +deprecated, use \fB\-\-numeric\-ids\fP instead +.TP +.B \-\-numeric\-ids only consider numeric user and group identifiers .TP .B \-\-same\-chunker\-params @@ -77,6 +80,9 @@ Override check of chunker parameters. .TP .B \-\-sort Sort the output lines by file path. +.TP +.B \-\-json\-lines +Format output as JSON Lines. .UNINDENT .SS Exclusion options .INDENT 0.0 @@ -111,6 +117,7 @@ $ chmod a+x file1 $ echo "something" >> file2 $ borg create ../testrepo::archive2 . +$ echo "testing 123" >> file1 $ rm file3 $ touch file4 $ borg create ../testrepo::archive3 . @@ -121,14 +128,21 @@ $ borg diff testrepo::archive1 archive2 +135 B \-252 B file2 $ borg diff testrepo::archive2 archive3 + +17 B \-5 B file1 added 0 B file4 removed 0 B file3 $ borg diff testrepo::archive1 archive3 -[\-rw\-r\-\-r\-\- \-> \-rwxr\-xr\-x] file1 + +17 B \-5 B [\-rw\-r\-\-r\-\- \-> \-rwxr\-xr\-x] file1 +135 B \-252 B file2 added 0 B file4 removed 0 B file3 + +$ borg diff \-\-json\-lines testrepo::archive1 archive3 +{"path": "file1", "changes": [{"type": "modified", "added": 17, "removed": 5}, {"type": "mode", "old_mode": "\-rw\-r\-\-r\-\-", "new_mode": "\-rwxr\-xr\-x"}]} +{"path": "file2", "changes": [{"type": "modified", "added": 135, "removed": 252}]} +{"path": "file4", "changes": [{"type": "added", "size": 0}]} +{"path": "file3", "changes": [{"type": "removed", "size": 0}] .ft P .fi .UNINDENT diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 31414679a..e744b0777 100644 --- a/docs/man/borg-export-tar.1 +++ b/docs/man/borg-export-tar.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-EXPORT-TAR 1 "2021-02-06" "" "borg backup tool" +.TH BORG-EXPORT-TAR 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball . diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index 1ff42abcb..152117ec4 100644 --- a/docs/man/borg-extract.1 +++ b/docs/man/borg-extract.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-EXTRACT 1 "2021-02-06" "" "borg backup tool" +.TH BORG-EXTRACT 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents . @@ -78,6 +78,9 @@ output verbose list of items (files, dirs, ...) do not actually change any files .TP .B \-\-numeric\-owner +deprecated, use \fB\-\-numeric\-ids\fP instead +.TP +.B \-\-numeric\-ids only obey numeric user and group identifiers .TP .B \-\-nobsdflags @@ -86,6 +89,12 @@ deprecated, use \fB\-\-noflags\fP instead .B \-\-noflags do not extract/set flags (e.g. NODUMP, IMMUTABLE) .TP +.B \-\-noacls +do not extract/set ACLs +.TP +.B \-\-noxattrs +do not extract/set xattrs +.TP .B \-\-stdout write all extracted data to stdout .TP diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index 6fe2203aa..d9553e496 100644 --- a/docs/man/borg-info.1 +++ b/docs/man/borg-info.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-INFO 1 "2021-02-06" "" "borg backup tool" +.TH BORG-INFO 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-info \- Show archive details such as disk space used . diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1 index 5f25f0053..6abe55441 100644 --- a/docs/man/borg-init.1 +++ b/docs/man/borg-init.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-INIT 1 "2021-02-06" "" "borg backup tool" +.TH BORG-INIT 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-init \- Initialize an empty repository . diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index ba7c22052..c4e4f74f5 100644 --- a/docs/man/borg-key-change-passphrase.1 +++ b/docs/man/borg-key-change-passphrase.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2021-02-06" "" "borg backup tool" +.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-key-change-passphrase \- Change repository key file passphrase . diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1 index 111e09ec3..040e17bb7 100644 --- a/docs/man/borg-key-export.1 +++ b/docs/man/borg-key-export.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-EXPORT 1 "2021-02-06" "" "borg backup tool" +.TH BORG-KEY-EXPORT 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-key-export \- Export the repository key for backup . diff --git a/docs/man/borg-key-import.1 b/docs/man/borg-key-import.1 index 247a97a91..a9ab1c2fd 100644 --- a/docs/man/borg-key-import.1 +++ b/docs/man/borg-key-import.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-IMPORT 1 "2021-02-06" "" "borg backup tool" +.TH BORG-KEY-IMPORT 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-key-import \- Import the repository key from backup . diff --git a/docs/man/borg-key-migrate-to-repokey.1 b/docs/man/borg-key-migrate-to-repokey.1 index 8cbd5ff95..138126bfa 100644 --- a/docs/man/borg-key-migrate-to-repokey.1 +++ b/docs/man/borg-key-migrate-to-repokey.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2021-02-06" "" "borg backup tool" +.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-key-migrate-to-repokey \- Migrate passphrase -> repokey . diff --git a/docs/man/borg-key.1 b/docs/man/borg-key.1 index 8732b7f8a..4d25a2c82 100644 --- a/docs/man/borg-key.1 +++ b/docs/man/borg-key.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-KEY 1 "2021-02-06" "" "borg backup tool" +.TH BORG-KEY 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-key \- Manage a keyfile or repokey of a repository . diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1 index fd22965a4..a09ba140f 100644 --- a/docs/man/borg-list.1 +++ b/docs/man/borg-list.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-LIST 1 "2021-02-06" "" "borg backup tool" +.TH BORG-LIST 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-list \- List archive or repository contents . diff --git a/docs/man/borg-mount.1 b/docs/man/borg-mount.1 index 9c37783a5..2c917c091 100644 --- a/docs/man/borg-mount.1 +++ b/docs/man/borg-mount.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-MOUNT 1 "2021-02-06" "" "borg backup tool" +.TH BORG-MOUNT 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-mount \- Mount archive or an entire repository as a FUSE filesystem . @@ -101,6 +101,12 @@ stay in foreground, do not daemonize .TP .B \-o Extra mount options +.TP +.B \-\-numeric\-owner +deprecated, use \fB\-\-numeric\-ids\fP instead +.TP +.B \-\-numeric\-ids +use numeric user and group identifiers from archive(s) .UNINDENT .SS Archive filters .INDENT 0.0 diff --git a/docs/man/borg-patterns.1 b/docs/man/borg-patterns.1 index 7ea4c5168..440596e12 100644 --- a/docs/man/borg-patterns.1 +++ b/docs/man/borg-patterns.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-PATTERNS 1 "2021-02-06" "" "borg backup tool" +.TH BORG-PATTERNS 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-patterns \- Details regarding patterns . @@ -129,14 +129,14 @@ wildcards at most. .UNINDENT .sp Exclusions can be passed via the command line option \fB\-\-exclude\fP\&. When used -from within a shell the patterns should be quoted to protect them from +from within a shell, the patterns should be quoted to protect them from expansion. .sp The \fB\-\-exclude\-from\fP option permits loading exclusion patterns from a text file with one pattern per line. Lines empty or starting with the number sign (\(aq#\(aq) after removing whitespace on both ends are ignored. The optional style selector prefix is also supported for patterns loaded from a file. Due to -whitespace removal paths with whitespace at the beginning or end can only be +whitespace removal, paths with whitespace at the beginning or end can only be excluded using regular expressions. .sp To test your exclusion patterns without performing an actual backup you can diff --git a/docs/man/borg-placeholders.1 b/docs/man/borg-placeholders.1 index 05fd2e4ed..c100aea75 100644 --- a/docs/man/borg-placeholders.1 +++ b/docs/man/borg-placeholders.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-PLACEHOLDERS 1 "2021-02-06" "" "borg backup tool" +.TH BORG-PLACEHOLDERS 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-placeholders \- Details regarding placeholders . diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1 index 958d26ff2..a402a1bb1 100644 --- a/docs/man/borg-prune.1 +++ b/docs/man/borg-prune.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-PRUNE 1 "2021-02-06" "" "borg backup tool" +.TH BORG-PRUNE 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-prune \- Prune repository archives according to specified rules . diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1 index a1fa11e75..7df09b8f3 100644 --- a/docs/man/borg-recreate.1 +++ b/docs/man/borg-recreate.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-RECREATE 1 "2021-02-06" "" "borg backup tool" +.TH BORG-RECREATE 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-recreate \- Re-create archives . diff --git a/docs/man/borg-rename.1 b/docs/man/borg-rename.1 index 4f4de588a..eafc3cb8a 100644 --- a/docs/man/borg-rename.1 +++ b/docs/man/borg-rename.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-RENAME 1 "2021-02-06" "" "borg backup tool" +.TH BORG-RENAME 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-rename \- Rename an existing archive . diff --git a/docs/man/borg-serve.1 b/docs/man/borg-serve.1 index 41845eb9b..ee02a8d0d 100644 --- a/docs/man/borg-serve.1 +++ b/docs/man/borg-serve.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-SERVE 1 "2021-02-06" "" "borg backup tool" +.TH BORG-SERVE 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-serve \- Start in server mode. This command is usually not used manually. . diff --git a/docs/man/borg-umount.1 b/docs/man/borg-umount.1 index fbd82b644..7c26462dc 100644 --- a/docs/man/borg-umount.1 +++ b/docs/man/borg-umount.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-UMOUNT 1 "2021-02-06" "" "borg backup tool" +.TH BORG-UMOUNT 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-umount \- un-mount the FUSE filesystem . diff --git a/docs/man/borg-upgrade.1 b/docs/man/borg-upgrade.1 index a878fb4ab..3bff4810d 100644 --- a/docs/man/borg-upgrade.1 +++ b/docs/man/borg-upgrade.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-UPGRADE 1 "2021-02-06" "" "borg backup tool" +.TH BORG-UPGRADE 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-upgrade \- upgrade a repository from a previous version . diff --git a/docs/man/borg-with-lock.1 b/docs/man/borg-with-lock.1 index 966165019..a991141c2 100644 --- a/docs/man/borg-with-lock.1 +++ b/docs/man/borg-with-lock.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-WITH-LOCK 1 "2021-02-06" "" "borg backup tool" +.TH BORG-WITH-LOCK 1 "2021-05-11" "" "borg backup tool" .SH NAME borg-with-lock \- run a user specified command with the repository lock held . diff --git a/docs/man/borg.1 b/docs/man/borg.1 index bccce28dd..a6b026dd8 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG 1 "2021-02-06" "" "borg backup tool" +.TH BORG 1 "2021-05-11" "" "borg backup tool" .SH NAME borg \- deduplicating and encrypting backup tool . diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1 index 70871a022..07f3fb405 100644 --- a/docs/man/borgfs.1 +++ b/docs/man/borgfs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORGFS 1 "2021-02-06" "" "borg backup tool" +.TH BORGFS 1 "2021-05-11" "" "borg backup tool" .SH NAME borgfs \- Mount archive or an entire repository as a FUSE filesystem . @@ -104,6 +104,12 @@ stay in foreground, do not daemonize .TP .B \-o Extra mount options +.TP +.B \-\-numeric\-owner +deprecated, use \fB\-\-numeric\-ids\fP instead +.TP +.B \-\-numeric\-ids +use numeric user and group identifiers from archive(s) .UNINDENT .SS Archive filters .INDENT 0.0 diff --git a/docs/usage/common-options.rst.inc b/docs/usage/common-options.rst.inc index e6e723ff0..f31f0fd49 100644 --- a/docs/usage/common-options.rst.inc +++ b/docs/usage/common-options.rst.inc @@ -6,6 +6,7 @@ --debug enable debug output, work on log level DEBUG --debug-topic TOPIC enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug. if TOPIC is not fully qualified. -p, --progress show progress information +--iec format using IEC units (1KiB = 1024B) --log-json Output one JSON object per log line instead of formatted text. --lock-wait SECONDS wait at most SECONDS for acquiring a repository/cache lock (default: 1). --bypass-lock Bypass locking mechanism @@ -13,8 +14,10 @@ --show-rc show/log the return code (rc) --umask M set umask to M (local only, default: 0077) --remote-path PATH use PATH as borg executable on the remote (default: "borg") ---remote-ratelimit RATE set remote network upload rate limit in kiByte/s (default: 0=unlimited) ---remote-buffer UPLOAD_BUFFER set upload buffer size in MiB. (default: 0=no buffer) +--remote-ratelimit RATE deprecated, use ``--upload-ratelimit`` instead +--upload-ratelimit RATE set network upload rate limit in kiByte/s (default: 0=unlimited) +--remote-buffer UPLOAD_BUFFER deprecated, use ``--upload-buffer`` instead +--upload-buffer UPLOAD_BUFFER set network upload buffer size in MiB. (default: 0=no buffer) --consider-part-files treat part files like normal files (e.g. to list/extract them) --debug-profile FILE Write execution profile in Borg format into FILE. For local use a Python-compatible file can be generated by suffixing FILE with ".pyprof". --rsh RSH Use this command to connect to the 'borg serve' process (default: 'ssh') diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index eeead2f7c..9129112c5 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -75,7 +75,9 @@ borg create +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-x``, ``--one-file-system`` | stay in the same file system and do not store mount points of other file systems. This might behave different from your expectations, see the docs. | +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | ``--numeric-owner`` | only store numeric user and group identifiers | + | | ``--numeric-owner`` | deprecated, use ``--numeric-ids`` instead | + +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``--numeric-ids`` | only store numeric user and group identifiers | +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--noatime`` | do not store atime into archive | +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -89,6 +91,10 @@ borg create +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--noflags`` | do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive | +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``--noacls`` | do not read and store ACLs into archive | + +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``--noxattrs`` | do not read and store xattrs into archive | + +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--sparse`` | detect sparse holes in input (supported only by fixed chunker) | +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--files-cache MODE`` | operate files cache in MODE. default: ctime,size,inode | @@ -157,13 +163,16 @@ borg create Filesystem options -x, --one-file-system stay in the same file system and do not store mount points of other file systems. This might behave different from your expectations, see the docs. - --numeric-owner only store numeric user and group identifiers + --numeric-owner deprecated, use ``--numeric-ids`` instead + --numeric-ids only store numeric user and group identifiers --noatime do not store atime into archive --atime do store atime into archive --noctime do not store ctime into archive --nobirthtime do not store birthtime (creation date) into archive --nobsdflags deprecated, use ``--noflags`` instead --noflags do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive + --noacls do not read and store ACLs into archive + --noxattrs do not read and store xattrs into archive --sparse detect sparse holes in input (supported only by fixed chunker) --files-cache MODE operate files cache in MODE. default: ctime,size,inode --read-special open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files. diff --git a/docs/usage/diff.rst.inc b/docs/usage/diff.rst.inc index 4947e8b28..21ae9a936 100644 --- a/docs/usage/diff.rst.inc +++ b/docs/usage/diff.rst.inc @@ -23,12 +23,16 @@ borg diff +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+ | **optional arguments** | +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+ - | | ``--numeric-owner`` | only consider numeric user and group identifiers | + | | ``--numeric-owner`` | deprecated, use ``--numeric-ids`` instead | + +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+ + | | ``--numeric-ids`` | only consider numeric user and group identifiers | +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+ | | ``--same-chunker-params`` | Override check of chunker parameters. | +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+ | | ``--sort`` | Sort the output lines by file path. | +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+ + | | ``--json-lines`` | Format output as JSON Lines. | + +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+ | .. class:: borg-common-opt-ref | | | | :ref:`common_options` | @@ -63,9 +67,11 @@ borg diff optional arguments - --numeric-owner only consider numeric user and group identifiers + --numeric-owner deprecated, use ``--numeric-ids`` instead + --numeric-ids only consider numeric user and group identifiers --same-chunker-params Override check of chunker parameters. --sort Sort the output lines by file path. + --json-lines Format output as JSON Lines. :ref:`common_options` diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc index c0e86b0cc..76e3e70b2 100644 --- a/docs/usage/extract.rst.inc +++ b/docs/usage/extract.rst.inc @@ -25,12 +25,18 @@ borg extract +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not actually change any files | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | | ``--numeric-owner`` | only obey numeric user and group identifiers | + | | ``--numeric-owner`` | deprecated, use ``--numeric-ids`` instead | + +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | | ``--numeric-ids`` | only obey numeric user and group identifiers | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--nobsdflags`` | deprecated, use ``--noflags`` instead | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--noflags`` | do not extract/set flags (e.g. NODUMP, IMMUTABLE) | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | | ``--noacls`` | do not extract/set ACLs | + +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | | ``--noxattrs`` | do not extract/set xattrs | + +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--stdout`` | write all extracted data to stdout | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--sparse`` | create holes in output sparse file from all-zero chunks | @@ -71,9 +77,12 @@ borg extract optional arguments --list output verbose list of items (files, dirs, ...) -n, --dry-run do not actually change any files - --numeric-owner only obey numeric user and group identifiers + --numeric-owner deprecated, use ``--numeric-ids`` instead + --numeric-ids only obey numeric user and group identifiers --nobsdflags deprecated, use ``--noflags`` instead --noflags do not extract/set flags (e.g. NODUMP, IMMUTABLE) + --noacls do not extract/set ACLs + --noxattrs do not extract/set xattrs --stdout write all extracted data to stdout --sparse create holes in output sparse file from all-zero chunks diff --git a/docs/usage/help.rst.inc b/docs/usage/help.rst.inc index 71fd24700..f2389c559 100644 --- a/docs/usage/help.rst.inc +++ b/docs/usage/help.rst.inc @@ -98,14 +98,14 @@ Path full-match, selector `pf:` wildcards at most. Exclusions can be passed via the command line option ``--exclude``. When used -from within a shell the patterns should be quoted to protect them from +from within a shell, the patterns should be quoted to protect them from expansion. The ``--exclude-from`` option permits loading exclusion patterns from a text file with one pattern per line. Lines empty or starting with the number sign ('#') after removing whitespace on both ends are ignored. The optional style selector prefix is also supported for patterns loaded from a file. Due to -whitespace removal paths with whitespace at the beginning or end can only be +whitespace removal, paths with whitespace at the beginning or end can only be excluded using regular expressions. To test your exclusion patterns without performing an actual backup you can diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index 1b297fd1c..bcf7358bf 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -29,6 +29,10 @@ borg mount +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-o`` | Extra mount options | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``--numeric-owner`` | deprecated, use ``--numeric-ids`` instead | + +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | | ``--numeric-ids`` | use numeric user and group identifiers from archive(s) | + +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | .. class:: borg-common-opt-ref | | | | :ref:`common_options` | @@ -80,6 +84,8 @@ borg mount --consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden). -f, --foreground stay in foreground, do not daemonize -o Extra mount options + --numeric-owner deprecated, use ``--numeric-ids`` instead + --numeric-ids use numeric user and group identifiers from archive(s) :ref:`common_options`