diff --git a/docs/changes.rst b/docs/changes.rst index c5128c232..e81f1d949 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -171,8 +171,8 @@ The best check that everything is ok is to run a dry-run extraction:: Changelog ========= -Version 1.1.4 (not released yet) --------------------------------- +Version 1.1.4 (2017-12-31) +-------------------------- Compatibility notes: diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index f30a93b2e..b3ec72dbc 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 "2017-11-26" "" "borg backup tool" +.TH BORG-BENCHMARK-CRUD 1 "2017-12-30" "" "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 ec71b4fac..e19ae66f9 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 "2017-11-26" "" "borg backup tool" +.TH BORG-BENCHMARK 1 "2017-12-30" "" "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 138cce29a..1d4fc7767 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 "2017-11-26" "" "borg backup tool" +.TH BORG-BREAK-LOCK 1 "2017-12-30" "" "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-change-passphrase.1 b/docs/man/borg-change-passphrase.1 index aee189f37..cbd4d702a 100644 --- a/docs/man/borg-change-passphrase.1 +++ b/docs/man/borg-change-passphrase.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-CHANGE-PASSPHRASE 1 "2017-11-26" "" "borg backup tool" +.TH BORG-CHANGE-PASSPHRASE 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-change-passphrase \- Change repository key file passphrase . diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1 index 7ae6964d3..d1ee488db 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 "2017-11-26" "" "borg backup tool" +.TH BORG-CHECK 1 "2017-12-30" "" "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 2f78e8bb2..97c92e0da 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 "2017-11-26" "" "borg backup tool" +.TH BORG-COMMON 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands . diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index c6aa534e4..1731c0e59 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 "2017-11-26" "" "borg backup tool" +.TH BORG-COMPRESSION 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression . @@ -50,7 +50,13 @@ Valid compression specifiers are: Do not compress. .TP .B lz4 -Use lz4 compression. High speed, low compression. (default) +Use lz4 compression. Very high speed, very low compression. (default) +.TP +.B zstd[,L] +Use zstd ("zstandard") compression, a modern wide\-range algorithm. +If you do not explicitely give the compression level L (ranging from 1 +to 22), it will use level 3. +Archives compressed with zstd are not compatible with borg < 1.1.4. .TP .B zlib[,L] Use zlib ("gz") compression. Medium speed, medium compression. @@ -82,6 +88,8 @@ Examples: .nf .ft C borg create \-\-compression lz4 REPO::ARCHIVE data +borg create \-\-compression zstd REPO::ARCHIVE data +borg create \-\-compression zstd,10 REPO::ARCHIVE data borg create \-\-compression zlib REPO::ARCHIVE data borg create \-\-compression zlib,1 REPO::ARCHIVE data borg create \-\-compression auto,lzma,6 REPO::ARCHIVE data diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1 index b136ec6c3..33d132e98 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 "2017-11-26" "" "borg backup tool" +.TH BORG-CONFIG 1 "2017-12-30" "" "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 c50666ea6..5ab0bf615 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 "2017-11-26" "" "borg backup tool" +.TH BORG-CREATE 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-create \- Create new archive . diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index 3c73d68ff..d71ecdb95 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 "2017-11-26" "" "borg backup tool" +.TH BORG-DELETE 1 "2017-12-30" "" "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 45e3856e5..14bd45a7d 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 "2017-11-26" "" "borg backup tool" +.TH BORG-DIFF 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives . diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 4a59ce80e..eb3443c9f 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 "2017-11-26" "" "borg backup tool" +.TH BORG-EXPORT-TAR 1 "2017-12-30" "" "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 823999bdd..df5096b38 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 "2017-11-26" "" "borg backup tool" +.TH BORG-EXTRACT 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents . diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index 412060464..898639c13 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 "2017-11-26" "" "borg backup tool" +.TH BORG-INFO 1 "2017-12-30" "" "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 66ec6e46e..7ee56350a 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 "2017-11-26" "" "borg backup tool" +.TH BORG-INIT 1 "2017-12-30" "" "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 80788292a..89d34e1cf 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 "2017-11-26" "" "borg backup tool" +.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2017-12-30" "" "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 365a4f2d8..8e5bf1167 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 "2017-11-26" "" "borg backup tool" +.TH BORG-KEY-EXPORT 1 "2017-12-30" "" "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 18375e877..520ab5bfb 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 "2017-11-26" "" "borg backup tool" +.TH BORG-KEY-IMPORT 1 "2017-12-30" "" "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 18090122e..c2b531d87 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 "2017-11-26" "" "borg backup tool" +.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2017-12-30" "" "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 bc550e8bd..70a078073 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 "2017-11-26" "" "borg backup tool" +.TH BORG-KEY 1 "2017-12-30" "" "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 cf38d7670..da92c0136 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 "2017-11-26" "" "borg backup tool" +.TH BORG-LIST 1 "2017-12-30" "" "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 8f97be5b9..5da4baf46 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 "2017-11-26" "" "borg backup tool" +.TH BORG-MOUNT 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-mount \- Mount archive or an entire repository as a FUSE filesystem . diff --git a/docs/man/borg-patterns.1 b/docs/man/borg-patterns.1 index e0d91c407..b4c71a172 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 "2017-11-26" "" "borg backup tool" +.TH BORG-PATTERNS 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-patterns \- Details regarding patterns . diff --git a/docs/man/borg-placeholders.1 b/docs/man/borg-placeholders.1 index ba7a631a7..5e8687c0c 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 "2017-11-26" "" "borg backup tool" +.TH BORG-PLACEHOLDERS 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-placeholders \- Details regarding placeholders . @@ -42,7 +42,7 @@ The (short) hostname of the machine. .B {fqdn} The full name of the machine. .TP -.B {reverse-fqdn} +.B {reverse\-fqdn} The full name of the machine in reverse domain name notation. .TP .B {now} diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1 index e051fa3a2..d7e75d271 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 "2017-11-26" "" "borg backup tool" +.TH BORG-PRUNE 1 "2017-12-30" "" "borg backup tool" .SH NAME borg-prune \- Prune repository archives according to specified rules . @@ -175,7 +175,7 @@ $ borg prune \-v \-\-list \-\-keep\-within=10d \-\-keep\-weekly=4 \-\-keep\-mont .UNINDENT .UNINDENT .sp -There is also a visualized prune example in \fBdocs/misc/prune\-example.txt\fP. +There is also a visualized prune example in \fBdocs/misc/prune\-example.txt\fP\&. .SH SEE ALSO .sp \fIborg\-common(1)\fP diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1 index caa377aeb..2269109e6 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 "2017-11-26" "" "borg backup tool" +.TH BORG-RECREATE 1 "2017-12-30" "" "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 285fe681c..8a8ba4c48 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 "2017-11-26" "" "borg backup tool" +.TH BORG-RENAME 1 "2017-12-30" "" "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 3b2c442fd..dacd2bb89 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 "2017-11-26" "" "borg backup tool" +.TH BORG-SERVE 1 "2017-12-30" "" "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 c9f1d6124..6b398386a 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 "2017-11-26" "" "borg backup tool" +.TH BORG-UMOUNT 1 "2017-12-30" "" "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 0b191045c..3f5ebe983 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 "2017-11-26" "" "borg backup tool" +.TH BORG-UPGRADE 1 "2017-12-30" "" "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 7b662c9b6..130b93f0e 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 "2017-11-26" "" "borg backup tool" +.TH BORG-WITH-LOCK 1 "2017-12-30" "" "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 36ac4b3c5..a141e70ad 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -438,23 +438,27 @@ allowed). So please test your scripts interactively before making them a non\-in .B Directories and files: .INDENT 7.0 .TP -.B BORG_KEYS_DIR -Default to \(aq~/.config/borg/keys\(aq. This directory contains keys for encrypted repositories. +.B BORG_BASE_DIR +Default to \(aq$HOME\(aq, \(aq~$USER\(aq, \(aq~\(aq (in that order)\(aq. +If we refer to ~ below, we in fact mean BORG_BASE_DIR. .TP -.B BORG_KEY_FILE -When set, use the given filename as repository key file. +.B BORG_CONFIG_DIR +Default to \(aq~/.config/borg\(aq. This directory contains the whole config directories. +.TP +.B BORG_CACHE_DIR +Default to \(aq~/.cache/borg\(aq. This directory contains the local cache and might need a lot +of space for dealing with big repositories. .TP .B BORG_SECURITY_DIR Default to \(aq~/.config/borg/security\(aq. This directory contains information borg uses to track its usage of NONCES ("numbers used once" \- usually in encryption context) and other security relevant data. .TP -.B BORG_CACHE_DIR -Default to \(aq~/.cache/borg\(aq. This directory contains the local cache and might need a lot -of space for dealing with big repositories). +.B BORG_KEYS_DIR +Default to \(aq~/.config/borg/keys\(aq. This directory contains keys for encrypted repositories. .TP -.B BORG_CONFIG_DIR -Default to \(aq~/.config/borg\(aq. This directory contains the whole config directories. +.B BORG_KEY_FILE +When set, use the given filename as repository key file. .UNINDENT .TP .B Building: @@ -463,8 +467,9 @@ Default to \(aq~/.config/borg\(aq. This directory contains the whole config dire .B BORG_OPENSSL_PREFIX Adds given OpenSSL header file directory to the default locations (setup.py). .TP -.B BORG_LZ4_PREFIX -Adds given LZ4 header file directory to the default locations (setup.py). +.B BORG_LIBLZ4_PREFIX +Adds given prefix directory to the default locations. If a \(aqinclude/lz4.h\(aq is found Borg +will be linked against the system liblz4 instead of a bundled implementation. (setup.py) .TP .B BORG_LIBB2_PREFIX Adds given prefix directory to the default locations. If a \(aqinclude/blake2.h\(aq is found Borg diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1 index 2c5f9357e..209319f8e 100644 --- a/docs/man/borgfs.1 +++ b/docs/man/borgfs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORGFS 1 "2017-11-26" "" "borg backup tool" +.TH BORGFS 1 "2017-12-30" "" "borg backup tool" .SH NAME borgfs \- Mount archive or an entire repository as a FUSE filesystem . diff --git a/docs/usage/help.rst.inc b/docs/usage/help.rst.inc index bed681768..98fee7982 100644 --- a/docs/usage/help.rst.inc +++ b/docs/usage/help.rst.inc @@ -241,7 +241,13 @@ none Do not compress. lz4 - Use lz4 compression. High speed, low compression. (default) + Use lz4 compression. Very high speed, very low compression. (default) + +zstd[,L] + Use zstd ("zstandard") compression, a modern wide-range algorithm. + If you do not explicitely give the compression level L (ranging from 1 + to 22), it will use level 3. + Archives compressed with zstd are not compatible with borg < 1.1.4. zlib[,L] Use zlib ("gz") compression. Medium speed, medium compression. @@ -268,6 +274,8 @@ auto,C[,L] Examples:: borg create --compression lz4 REPO::ARCHIVE data + borg create --compression zstd REPO::ARCHIVE data + borg create --compression zstd,10 REPO::ARCHIVE data borg create --compression zlib REPO::ARCHIVE data borg create --compression zlib,1 REPO::ARCHIVE data borg create --compression auto,lzma,6 REPO::ARCHIVE data