Browse Source

Merge pull request #5797 from ThomasWaldmann/rel120b3

release 1.2.0b3
TW 4 years ago
parent
commit
91cdaea96c

+ 8 - 3
docs/changes.rst

@@ -214,8 +214,11 @@ The best check that everything is ok is to run a dry-run extraction::
 
 
 .. _changelog:
 .. _changelog:
 
 
-Version 1.2.0xx (not released yet)
-----------------------------------
+Change Log
+==========
+
+Version 1.2.0b3 (2ß21-05-12)
+----------------------------
 
 
 Please note:
 Please note:
 
 
@@ -286,7 +289,9 @@ Other changes:
 - create: add --upload-(ratelimit|buffer), deprecate --remote-* options, #5611
 - create: add --upload-(ratelimit|buffer), deprecate --remote-* options, #5611
 - create/extract/mount: add --numeric-ids, deprecate --numeric-owner option, #5724
 - create/extract/mount: add --numeric-ids, deprecate --numeric-owner option, #5724
 - config: accept non-int value for max_segment_size / storage_quota
 - 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
 - cleanup code style checks
 - get rid of distutils, use setuptools+packaging
 - get rid of distutils, use setuptools+packaging
 - github CI: test on Python 3.10-dev
 - github CI: test on Python 3.10-dev

+ 1 - 1
docs/man/borg-benchmark-crud.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .
 .

+ 1 - 1
docs/man/borg-benchmark.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-benchmark \- benchmark command
 borg-benchmark \- benchmark command
 .
 .

+ 1 - 1
docs/man/borg-break-lock.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
 borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
 .
 .

+ 1 - 1
docs/man/borg-check.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-check \- Check repository consistency
 borg-check \- Check repository consistency
 .
 .

+ 12 - 3
docs/man/borg-common.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-common \- Common options of Borg commands
 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
 .B \-p\fP,\fB  \-\-progress
 show progress information
 show progress information
 .TP
 .TP
+.B \-\-iec
+format using IEC units (1KiB = 1024B)
+.TP
 .B \-\-log\-json
 .B \-\-log\-json
 Output one JSON object per log line instead of formatted text.
 Output one JSON object per log line instead of formatted text.
 .TP
 .TP
@@ -79,10 +82,16 @@ set umask to M (local only, default: 0077)
 use PATH as borg executable on the remote (default: "borg")
 use PATH as borg executable on the remote (default: "borg")
 .TP
 .TP
 .BI \-\-remote\-ratelimit \ RATE
 .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
 .TP
 .BI \-\-remote\-buffer \ UPLOAD_BUFFER
 .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
 .TP
 .B \-\-consider\-part\-files
 .B \-\-consider\-part\-files
 treat part files like normal files (e.g. to list/extract them)
 treat part files like normal files (e.g. to list/extract them)

+ 1 - 1
docs/man/borg-compact.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-compact \- compact segment files in the repository
 borg-compact \- compact segment files in the repository
 .
 .

+ 1 - 1
docs/man/borg-compression.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-compression \- Details regarding compression
 borg-compression \- Details regarding compression
 .
 .

+ 1 - 1
docs/man/borg-config.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-config \- get, set, and delete values in a repository or cache config file
 borg-config \- get, set, and delete values in a repository or cache config file
 .
 .

+ 10 - 1
docs/man/borg-create.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-create \- Create new archive
 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.
 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
 .TP
 .B \-\-numeric\-owner
 .B \-\-numeric\-owner
+deprecated, use \fB\-\-numeric\-ids\fP instead
+.TP
+.B \-\-numeric\-ids
 only store numeric user and group identifiers
 only store numeric user and group identifiers
 .TP
 .TP
 .B \-\-noatime
 .B \-\-noatime
@@ -231,6 +234,12 @@ deprecated, use \fB\-\-noflags\fP instead
 .B \-\-noflags
 .B \-\-noflags
 do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive
 do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive
 .TP
 .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
 .B \-\-sparse
 detect sparse holes in input (supported only by fixed chunker)
 detect sparse holes in input (supported only by fixed chunker)
 .TP
 .TP

+ 1 - 1
docs/man/borg-delete.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-delete \- Delete an existing repository or archives
 borg-delete \- Delete an existing repository or archives
 .
 .

+ 16 - 2
docs/man/borg-diff.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-diff \- Diff contents of two archives
 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
 .INDENT 0.0
 .TP
 .TP
 .B \-\-numeric\-owner
 .B \-\-numeric\-owner
+deprecated, use \fB\-\-numeric\-ids\fP instead
+.TP
+.B \-\-numeric\-ids
 only consider numeric user and group identifiers
 only consider numeric user and group identifiers
 .TP
 .TP
 .B \-\-same\-chunker\-params
 .B \-\-same\-chunker\-params
@@ -77,6 +80,9 @@ Override check of chunker parameters.
 .TP
 .TP
 .B \-\-sort
 .B \-\-sort
 Sort the output lines by file path.
 Sort the output lines by file path.
+.TP
+.B \-\-json\-lines
+Format output as JSON Lines.
 .UNINDENT
 .UNINDENT
 .SS Exclusion options
 .SS Exclusion options
 .INDENT 0.0
 .INDENT 0.0
@@ -111,6 +117,7 @@ $ chmod a+x file1
 $ echo "something" >> file2
 $ echo "something" >> file2
 $ borg create ../testrepo::archive2 .
 $ borg create ../testrepo::archive2 .
 
 
+$ echo "testing 123" >> file1
 $ rm file3
 $ rm file3
 $ touch file4
 $ touch file4
 $ borg create ../testrepo::archive3 .
 $ borg create ../testrepo::archive3 .
@@ -121,14 +128,21 @@ $ borg diff testrepo::archive1 archive2
    +135 B    \-252 B file2
    +135 B    \-252 B file2
 
 
 $ borg diff testrepo::archive2 archive3
 $ borg diff testrepo::archive2 archive3
+    +17 B      \-5 B file1
 added           0 B file4
 added           0 B file4
 removed         0 B file3
 removed         0 B file3
 
 
 $ borg diff testrepo::archive1 archive3
 $ 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
    +135 B    \-252 B file2
 added           0 B file4
 added           0 B file4
 removed         0 B file3
 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
 .ft P
 .fi
 .fi
 .UNINDENT
 .UNINDENT

+ 1 - 1
docs/man/borg-export-tar.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-export-tar \- Export archive contents as a tarball
 borg-export-tar \- Export archive contents as a tarball
 .
 .

+ 10 - 1
docs/man/borg-extract.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-extract \- Extract archive contents
 borg-extract \- Extract archive contents
 .
 .
@@ -78,6 +78,9 @@ output verbose list of items (files, dirs, ...)
 do not actually change any files
 do not actually change any files
 .TP
 .TP
 .B \-\-numeric\-owner
 .B \-\-numeric\-owner
+deprecated, use \fB\-\-numeric\-ids\fP instead
+.TP
+.B \-\-numeric\-ids
 only obey numeric user and group identifiers
 only obey numeric user and group identifiers
 .TP
 .TP
 .B \-\-nobsdflags
 .B \-\-nobsdflags
@@ -86,6 +89,12 @@ deprecated, use \fB\-\-noflags\fP instead
 .B \-\-noflags
 .B \-\-noflags
 do not extract/set flags (e.g. NODUMP, IMMUTABLE)
 do not extract/set flags (e.g. NODUMP, IMMUTABLE)
 .TP
 .TP
+.B \-\-noacls
+do not extract/set ACLs
+.TP
+.B \-\-noxattrs
+do not extract/set xattrs
+.TP
 .B \-\-stdout
 .B \-\-stdout
 write all extracted data to stdout
 write all extracted data to stdout
 .TP
 .TP

+ 1 - 1
docs/man/borg-info.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-info \- Show archive details such as disk space used
 borg-info \- Show archive details such as disk space used
 .
 .

+ 1 - 1
docs/man/borg-init.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-init \- Initialize an empty repository
 borg-init \- Initialize an empty repository
 .
 .

+ 1 - 1
docs/man/borg-key-change-passphrase.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-key-change-passphrase \- Change repository key file passphrase
 borg-key-change-passphrase \- Change repository key file passphrase
 .
 .

+ 1 - 1
docs/man/borg-key-export.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-key-export \- Export the repository key for backup
 borg-key-export \- Export the repository key for backup
 .
 .

+ 1 - 1
docs/man/borg-key-import.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-key-import \- Import the repository key from backup
 borg-key-import \- Import the repository key from backup
 .
 .

+ 1 - 1
docs/man/borg-key-migrate-to-repokey.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-key-migrate-to-repokey \- Migrate passphrase -> repokey
 borg-key-migrate-to-repokey \- Migrate passphrase -> repokey
 .
 .

+ 1 - 1
docs/man/borg-key.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-key \- Manage a keyfile or repokey of a repository
 borg-key \- Manage a keyfile or repokey of a repository
 .
 .

+ 1 - 1
docs/man/borg-list.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-list \- List archive or repository contents
 borg-list \- List archive or repository contents
 .
 .

+ 7 - 1
docs/man/borg-mount.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 .
 .
@@ -101,6 +101,12 @@ stay in foreground, do not daemonize
 .TP
 .TP
 .B \-o
 .B \-o
 Extra mount options
 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
 .UNINDENT
 .SS Archive filters
 .SS Archive filters
 .INDENT 0.0
 .INDENT 0.0

+ 3 - 3
docs/man/borg-patterns.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-patterns \- Details regarding patterns
 borg-patterns \- Details regarding patterns
 .
 .
@@ -129,14 +129,14 @@ wildcards at most.
 .UNINDENT
 .UNINDENT
 .sp
 .sp
 Exclusions can be passed via the command line option \fB\-\-exclude\fP\&. When used
 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.
 expansion.
 .sp
 .sp
 The \fB\-\-exclude\-from\fP option permits loading exclusion patterns from a text
 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
 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
 (\(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
 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.
 excluded using regular expressions.
 .sp
 .sp
 To test your exclusion patterns without performing an actual backup you can
 To test your exclusion patterns without performing an actual backup you can

+ 1 - 1
docs/man/borg-placeholders.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-placeholders \- Details regarding placeholders
 borg-placeholders \- Details regarding placeholders
 .
 .

+ 1 - 1
docs/man/borg-prune.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-prune \- Prune repository archives according to specified rules
 borg-prune \- Prune repository archives according to specified rules
 .
 .

+ 1 - 1
docs/man/borg-recreate.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-recreate \- Re-create archives
 borg-recreate \- Re-create archives
 .
 .

+ 1 - 1
docs/man/borg-rename.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-rename \- Rename an existing archive
 borg-rename \- Rename an existing archive
 .
 .

+ 1 - 1
docs/man/borg-serve.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-serve \- Start in server mode. This command is usually not used manually.
 borg-serve \- Start in server mode. This command is usually not used manually.
 .
 .

+ 1 - 1
docs/man/borg-umount.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-umount \- un-mount the FUSE filesystem
 borg-umount \- un-mount the FUSE filesystem
 .
 .

+ 1 - 1
docs/man/borg-upgrade.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-upgrade \- upgrade a repository from a previous version
 borg-upgrade \- upgrade a repository from a previous version
 .
 .

+ 1 - 1
docs/man/borg-with-lock.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg-with-lock \- run a user specified command with the repository lock held
 borg-with-lock \- run a user specified command with the repository lock held
 .
 .

+ 1 - 1
docs/man/borg.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borg \- deduplicating and encrypting backup tool
 borg \- deduplicating and encrypting backup tool
 .
 .

+ 7 - 1
docs/man/borgfs.1

@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .\" 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
 .SH NAME
 borgfs \- Mount archive or an entire repository as a FUSE filesystem
 borgfs \- Mount archive or an entire repository as a FUSE filesystem
 .
 .
@@ -104,6 +104,12 @@ stay in foreground, do not daemonize
 .TP
 .TP
 .B \-o
 .B \-o
 Extra mount options
 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
 .UNINDENT
 .SS Archive filters
 .SS Archive filters
 .INDENT 0.0
 .INDENT 0.0

+ 5 - 2
docs/usage/common-options.rst.inc

@@ -6,6 +6,7 @@
 --debug            enable debug output, work on log level DEBUG
 --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.<TOPIC> if TOPIC is not fully qualified.
 --debug-topic TOPIC    enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
 -p, --progress     show progress information
 -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.
 --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).
 --lock-wait SECONDS    wait at most SECONDS for acquiring a repository/cache lock (default: 1).
 --bypass-lock      Bypass locking mechanism
 --bypass-lock      Bypass locking mechanism
@@ -13,8 +14,10 @@
 --show-rc          show/log the return code (rc)
 --show-rc          show/log the return code (rc)
 --umask M          set umask to M (local only, default: 0077)
 --umask M          set umask to M (local only, default: 0077)
 --remote-path PATH    use PATH as borg executable on the remote (default: "borg")
 --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)
 --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".
 --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')
 --rsh RSH          Use this command to connect to the 'borg serve' process (default: 'ssh')

+ 11 - 2
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. |
     |                                                       | ``-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                                                                                                                      |
     |                                                       | ``--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                                                                                    |
     |                                                       | ``--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)                                                                                       |
     |                                                       | ``--sparse``                                      | detect sparse holes in input (supported only by fixed chunker)                                                                                       |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--files-cache MODE``                            | operate files cache in MODE. default: ctime,size,inode                                                                                               |
     |                                                       | ``--files-cache MODE``                            | operate files cache in MODE. default: ctime,size,inode                                                                                               |
@@ -157,13 +163,16 @@ borg create
 
 
     Filesystem options
     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.
         -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
         --noatime                 do not store atime into archive
         --atime                   do store atime into archive
         --atime                   do store atime into archive
         --noctime                 do not store ctime into archive
         --noctime                 do not store ctime into archive
         --nobirthtime             do not store birthtime (creation date) into archive
         --nobirthtime             do not store birthtime (creation date) into archive
         --nobsdflags              deprecated, use ``--noflags`` instead
         --nobsdflags              deprecated, use ``--noflags`` instead
         --noflags                 do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive
         --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)
         --sparse                  detect sparse holes in input (supported only by fixed chunker)
         --files-cache MODE        operate files cache in MODE. default: ctime,size,inode
         --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.
         --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.

+ 8 - 2
docs/usage/diff.rst.inc

@@ -23,12 +23,16 @@ borg diff
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     | **optional arguments**                                                                                                                                                     |
     | **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.                                      |
     |                                                       | ``--same-chunker-params``             | Override check of chunker parameters.                                      |
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     |                                                       | ``--sort``                            | Sort the output lines by file path.                                        |
     |                                                       | ``--sort``                            | Sort the output lines by file path.                                        |
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
+    |                                                       | ``--json-lines``                      | Format output as JSON Lines.                                               |
+    +-------------------------------------------------------+---------------------------------------+----------------------------------------------------------------------------+
     | .. class:: borg-common-opt-ref                                                                                                                                             |
     | .. class:: borg-common-opt-ref                                                                                                                                             |
     |                                                                                                                                                                            |
     |                                                                                                                                                                            |
     | :ref:`common_options`                                                                                                                                                      |
     | :ref:`common_options`                                                                                                                                                      |
@@ -63,9 +67,11 @@ borg diff
 
 
 
 
     optional arguments
     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.
         --same-chunker-params    Override check of chunker parameters.
         --sort     Sort the output lines by file path.
         --sort     Sort the output lines by file path.
+        --json-lines    Format output as JSON Lines. 
 
 
 
 
     :ref:`common_options`
     :ref:`common_options`

+ 11 - 2
docs/usage/extract.rst.inc

@@ -25,12 +25,18 @@ borg extract
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     |                                                       | ``-n``, ``--dry-run``                 | do not actually change any files                                                                          |
     |                                                       | ``-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                                                                     |
     |                                                       | ``--nobsdflags``                      | deprecated, use ``--noflags`` instead                                                                     |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     |                                                       | ``--noflags``                         | do not extract/set flags (e.g. NODUMP, IMMUTABLE)                                                         |
     |                                                       | ``--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                                                                        |
     |                                                       | ``--stdout``                          | write all extracted data to stdout                                                                        |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     |                                                       | ``--sparse``                          | create holes in output sparse file from all-zero chunks                                                   |
     |                                                       | ``--sparse``                          | create holes in output sparse file from all-zero chunks                                                   |
@@ -71,9 +77,12 @@ borg extract
     optional arguments
     optional arguments
         --list            output verbose list of items (files, dirs, ...)
         --list            output verbose list of items (files, dirs, ...)
         -n, --dry-run     do not actually change any files
         -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
         --nobsdflags      deprecated, use ``--noflags`` instead
         --noflags         do not extract/set flags (e.g. NODUMP, IMMUTABLE)
         --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
         --stdout          write all extracted data to stdout
         --sparse          create holes in output sparse file from all-zero chunks
         --sparse          create holes in output sparse file from all-zero chunks
 
 

+ 2 - 2
docs/usage/help.rst.inc

@@ -98,14 +98,14 @@ Path full-match, selector `pf:`
     wildcards at most.
     wildcards at most.
 
 
 Exclusions can be passed via the command line option ``--exclude``. When used
 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.
 expansion.
 
 
 The ``--exclude-from`` option permits loading exclusion patterns from a text
 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
 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
 ('#') after removing whitespace on both ends are ignored. The optional style
 selector prefix is also supported for patterns loaded from a file. Due to
 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.
 excluded using regular expressions.
 
 
 To test your exclusion patterns without performing an actual backup you can
 To test your exclusion patterns without performing an actual backup you can

+ 6 - 0
docs/usage/mount.rst.inc

@@ -29,6 +29,10 @@ borg mount
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``-o``                                | Extra mount options                                                                                                                                    |
     |                                                                             | ``-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                                                                                                                                                                                                                                               |
     | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                               |
     |                                                                                                                                                                                                                                                                              |
     |                                                                                                                                                                                                                                                                              |
     | :ref:`common_options`                                                                                                                                                                                                                                                        |
     | :ref:`common_options`                                                                                                                                                                                                                                                        |
@@ -80,6 +84,8 @@ borg mount
         --consider-checkpoints    Show checkpoint archives in the repository contents list (default: hidden).
         --consider-checkpoints    Show checkpoint archives in the repository contents list (default: hidden).
         -f, --foreground    stay in foreground, do not daemonize
         -f, --foreground    stay in foreground, do not daemonize
         -o     Extra mount options
         -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`
     :ref:`common_options`