diff options
Diffstat (limited to 'docs')
33 files changed, 49 insertions, 37 deletions
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 8d27709c3..2ef94b0e7 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 "2018-03-29" "" "borg backup tool" +.TH BORG-BENCHMARK-CRUD 1 "2018-06-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 a4e900738..104ce6a89 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 "2018-03-29" "" "borg backup tool" +.TH BORG-BENCHMARK 1 "2018-06-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 4657aade6..ee5ff9f6f 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 "2018-03-29" "" "borg backup tool" +.TH BORG-BREAK-LOCK 1 "2018-06-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-change-passphrase.1 b/docs/man/borg-change-passphrase.1 index 93142f8a1..1ba7dcf34 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 "2018-03-29" "" "borg backup tool" +.TH BORG-CHANGE-PASSPHRASE 1 "2018-06-11" "" "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 dda65c0fb..038491bb0 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 "2018-03-29" "" "borg backup tool" +.TH BORG-CHECK 1 "2018-06-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 b330cca78..ab682b556 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 "2018-03-29" "" "borg backup tool" +.TH BORG-COMMON 1 "2018-06-11" "" "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 5f89d4ebf..4b2a6df1c 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 "2018-03-29" "" "borg backup tool" +.TH BORG-COMPRESSION 1 "2018-06-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 4f1415f2b..ad14accee 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 "2018-03-29" "" "borg backup tool" +.TH BORG-CONFIG 1 "2018-06-11" "" "borg backup tool" .SH NAME borg-config \- get, set, and delete values in a repository or cache config file . @@ -32,16 +32,18 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .SH SYNOPSIS .sp -borg [common options] config [options] REPOSITORY NAME [VALUE] +borg [common options] config [options] REPOSITORY [NAME] [VALUE] .SH DESCRIPTION .sp This command gets and sets options in a local repository or cache config file. For security reasons, this command only works on local repositories. .sp -To delete a config value entirely, use \fB\-\-delete\fP\&. To get an existing key, pass -only the key name. To set a key, pass both the key name and the new value. Keys -can be specified in the format "section.name" or simply "name"; the section will -default to "repository" and "cache" for the repo and cache configs, respectively. +To delete a config value entirely, use \fB\-\-delete\fP\&. To list the values +of the configuration file or the default values, use \fB\-\-list\fP\&. To get and existing +key, pass only the key name. To set a key, pass both the key name and +the new value. Keys can be specified in the format "section.name" or +simply "name"; the section will default to "repository" and "cache" for +the repo and cache configs, respectively. .sp By default, borg config manipulates the repository config file. Using \fB\-\-cache\fP edits the repository cache\(aqs config file instead. @@ -68,6 +70,9 @@ get and set values from the repo cache .TP .B \-d\fP,\fB \-\-delete delete the key from the config file +.TP +.B \-l\fP,\fB \-\-list +list the configuration of the repo .UNINDENT .SH EXAMPLES .sp diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 47ec523cd..f1b93f8db 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 "2018-03-29" "" "borg backup tool" +.TH BORG-CREATE 1 "2018-06-11" "" "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 3f72d3963..7ec9aa79a 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 "2018-03-29" "" "borg backup tool" +.TH BORG-DELETE 1 "2018-06-11" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives . @@ -58,6 +58,9 @@ archives to delete .SS optional arguments .INDENT 0.0 .TP +.B \-n\fP,\fB \-\-dry\-run +do not change repository +.TP .B \-s\fP,\fB \-\-stats print statistics for the deleted archive .TP diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index 9a7575826..b77f205a6 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 "2018-03-29" "" "borg backup tool" +.TH BORG-DIFF 1 "2018-06-11" "" "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 af947a304..bb063c3e9 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 "2018-03-29" "" "borg backup tool" +.TH BORG-EXPORT-TAR 1 "2018-06-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 07c60b5e6..026d27cc2 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 "2018-03-29" "" "borg backup tool" +.TH BORG-EXTRACT 1 "2018-06-11" "" "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 fb7a97334..5d8a7309d 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 "2018-03-29" "" "borg backup tool" +.TH BORG-INFO 1 "2018-06-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 c04391d34..7f0bdcd9e 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 "2018-03-29" "" "borg backup tool" +.TH BORG-INIT 1 "2018-06-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 c43da2593..ee4d58de8 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 "2018-03-29" "" "borg backup tool" +.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2018-06-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 887c2b183..200ed60da 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 "2018-03-29" "" "borg backup tool" +.TH BORG-KEY-EXPORT 1 "2018-06-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 dab559887..5b9349172 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 "2018-03-29" "" "borg backup tool" +.TH BORG-KEY-IMPORT 1 "2018-06-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 b7a5874ae..e11ce439d 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 "2018-03-29" "" "borg backup tool" +.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2018-06-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 43332fd02..2aee68de9 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 "2018-03-29" "" "borg backup tool" +.TH BORG-KEY 1 "2018-06-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 dd4f3fd4e..b5220b7b5 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 "2018-03-29" "" "borg backup tool" +.TH BORG-LIST 1 "2018-06-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 966764042..5e578103e 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 "2018-03-29" "" "borg backup tool" +.TH BORG-MOUNT 1 "2018-06-11" "" "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 0b36bccf5..8a91ad223 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 "2018-03-29" "" "borg backup tool" +.TH BORG-PATTERNS 1 "2018-06-11" "" "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 3fee53f35..18d81bfd9 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 "2018-03-29" "" "borg backup tool" +.TH BORG-PLACEHOLDERS 1 "2018-06-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 000741fef..5508c2717 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 "2018-03-29" "" "borg backup tool" +.TH BORG-PRUNE 1 "2018-06-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 708d14dc6..670d82ee6 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 "2018-03-29" "" "borg backup tool" +.TH BORG-RECREATE 1 "2018-06-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 e9e0039ac..4399c1e4a 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 "2018-03-29" "" "borg backup tool" +.TH BORG-RENAME 1 "2018-06-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 2cf9a0da3..27657ae2f 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 "2018-03-29" "" "borg backup tool" +.TH BORG-SERVE 1 "2018-06-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 b19c01121..74cbde8c8 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 "2018-03-29" "" "borg backup tool" +.TH BORG-UMOUNT 1 "2018-06-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 6ecfc34fb..7ce36f6d4 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 "2018-03-29" "" "borg backup tool" +.TH BORG-UPGRADE 1 "2018-06-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 5c5b9e6e1..2d7b3876e 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 "2018-03-29" "" "borg backup tool" +.TH BORG-WITH-LOCK 1 "2018-06-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 5cfc3182f..60faec533 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -498,6 +498,10 @@ will be linked against the system liblz4 instead of a bundled implementation. (s .B BORG_LIBB2_PREFIX Adds given prefix directory to the default locations. If a \(aqinclude/blake2.h\(aq is found Borg will be linked against the system libb2 instead of a bundled implementation. (setup.py) +.TP +.B BORG_LIBZSTD_PREFIX +Adds given prefix directory to the default locations. If a \(aqinclude/zstd.h\(aq is found Borg +will be linked against the system libzstd instead of a bundled implementation. (setup.py) .UNINDENT .UNINDENT .sp diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1 index 1b3871591..3a01af071 100644 --- a/docs/man/borgfs.1 +++ b/docs/man/borgfs.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORGFS 1 "2018-03-29" "" "borg backup tool" +.TH BORGFS 1 "2018-06-11" "" "borg backup tool" .SH NAME borgfs \- Mount archive or an entire repository as a FUSE filesystem . |