diff options
33 files changed, 162 insertions, 78 deletions
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index 5b611b1be..c71d221a7 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 "2020-04-21" "" "borg backup tool" +.TH BORG-BENCHMARK-CRUD 1 "2020-10-04" "" "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 3238ae2c0..4f4552b00 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 "2020-04-21" "" "borg backup tool" +.TH BORG-BENCHMARK 1 "2020-10-04" "" "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 d9a3907de..600ec6ec6 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 "2020-04-21" "" "borg backup tool" +.TH BORG-BREAK-LOCK 1 "2020-10-04" "" "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 6bf8cb8f9..86718cdeb 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 "2020-04-21" "" "borg backup tool" +.TH BORG-CHECK 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency . @@ -37,6 +37,9 @@ borg [common options] check [options] [REPOSITORY_OR_ARCHIVE] .sp The check command verifies the consistency of a repository and the corresponding archives. .sp +check \-\-repair is a potentially dangerous function and might lead to data loss +(for kinds of corruption it is not capable of dealing with). BE VERY CAREFUL! +.sp First, the underlying repository data files are checked: .INDENT 0.0 .IP \(bu 2 @@ -140,10 +143,10 @@ do only a partial repo check for max. SECONDS seconds (Default: unlimited) .SS Archive filters .INDENT 0.0 .TP -.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX +.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX only consider archive names starting with this prefix. .TP -.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB +.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1 index 86b883ad2..64b42039d 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 "2020-04-21" "" "borg backup tool" +.TH BORG-COMMON 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands . @@ -73,7 +73,7 @@ show/log the borg version show/log the return code (rc) .TP .BI \-\-umask \ M -set umask to M (local and remote, default: 0077) +set umask to M (local only, default: 0077) .TP .BI \-\-remote\-path \ PATH use PATH as borg executable on the remote (default: "borg") diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1 index 6da8ab847..bb726d658 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 "2020-04-21" "" "borg backup tool" +.TH BORG-COMPACT 1 "2020-10-04" "" "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 d7a8dbbf0..015acd779 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 "2020-04-21" "" "borg backup tool" +.TH BORG-COMPRESSION 1 "2020-10-04" "" "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 246db7156..7ab8b6635 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 "2020-04-21" "" "borg backup tool" +.TH BORG-CONFIG 1 "2020-10-04" "" "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 6e1662034..7ca2b8576 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 "2020-04-21" "" "borg backup tool" +.TH BORG-CREATE 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-create \- Create new archive . @@ -41,7 +41,9 @@ that means if relative paths are desired, the command has to be run from the cor directory. .sp When giving \(aq\-\(aq as path, borg will read data from standard input and create a -file \(aqstdin\(aq in the created archive from that data. +file \(aqstdin\(aq in the created archive from that data. In some cases it\(aqs more +appropriate to use \-\-content\-from\-command, however. See section \fIReading from +stdin\fP below for details. .sp The archive will consume almost no disk space for files or parts of files that have already been stored in other archives. @@ -150,12 +152,15 @@ output stats as JSON. Implies \fB\-\-stats\fP\&. experimental: do not synchronize the cache. Implies not using the files cache. .TP .BI \-\-stdin\-name \ NAME -use NAME in archive for stdin data (default: "stdin") +use NAME in archive for stdin data (default: \(aqstdin\(aq) +.TP +.B \-\-content\-from\-command +interpret PATH as command and store its stdout. See also section Reading from stdin below. .UNINDENT .SS Exclusion options .INDENT 0.0 .TP -.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN +.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN exclude paths matching PATTERN .TP .BI \-\-exclude\-from \ EXCLUDEFILE @@ -221,13 +226,13 @@ add a comment text to the archive .BI \-\-timestamp \ TIMESTAMP manually specify the archive creation date/time (UTC, yyyy\-mm\-ddThh:mm:ss format). Alternatively, give a reference file/directory. .TP -.BI \-c \ SECONDS\fP,\fB \ \-\-checkpoint\-interval \ SECONDS +.BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS write checkpoint every SECONDS seconds (Default: 1800) .TP .BI \-\-chunker\-params \ PARAMS specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE). default: buzhash,19,23,21,4095 .TP -.BI \-C \ COMPRESSION\fP,\fB \ \-\-compression \ COMPRESSION +.BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION select compression algorithm, see the output of the "borg help compression" command for details. .UNINDENT .SH EXAMPLES @@ -378,6 +383,53 @@ Other flags used include: .IP \(bu 2 \(aq?\(aq = missing status code (if you see this, please file a bug report!) .UNINDENT +.SS Reading from stdin +.sp +There are two methods to read from stdin. Either specify \fB\-\fP as path and +pipe directly to borg: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +backup\-vm \-\-id myvm \-\-stdout | borg create REPO::ARCHIVE \- +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Or use \fB\-\-content\-from\-command\fP to have Borg manage the execution of the +command and piping. If you do so, the first PATH argument is interpreted +as command to execute and any further arguments are treated as arguments +to the command: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +borg create \-\-content\-from\-command REPO::ARCHIVE \-\- backup\-vm \-\-id myvm \-\-stdout +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fB\-\-\fP is used to ensure \fB\-\-id\fP and \fB\-\-stdout\fP are \fBnot\fP considered +arguments to \fBborg\fP but rather \fBbackup\-vm\fP\&. +.sp +The difference between the two approaches is that piping to borg creates an +archive even if the command piping to borg exits with a failure. In this case, +\fBone can end up with truncated output being backed up\fP\&. Using +\fB\-\-content\-from\-command\fP, in contrast, borg is guaranteed to fail without +creating an archive should the command fail. The command is considered failed +when it returned a non\-zero exit code. +.sp +Reading from stdin yields just a stream of data without file metadata +associated with it, and the files cache is not needed at all. So it is +safe to disable it via \fB\-\-files\-cache disabled\fP and speed up backup +creation a bit. +.sp +By default, the content read from stdin is stored in a file called \(aqstdin\(aq. +Use \fB\-\-stdin\-name\fP to change the name. .SH SEE ALSO .sp \fIborg\-common(1)\fP, \fIborg\-delete(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-check(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-placeholders(1)\fP, \fIborg\-compression(1)\fP diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index d073a22ad..f3726fd6e 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 "2020-04-21" "" "borg backup tool" +.TH BORG-DELETE 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives . @@ -95,10 +95,10 @@ work slower, but using less space .SS Archive filters .INDENT 0.0 .TP -.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX +.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX only consider archive names starting with this prefix. .TP -.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB +.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index 150b38ba9..708ab4d0e 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 "2020-04-21" "" "borg backup tool" +.TH BORG-DIFF 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives . @@ -81,7 +81,7 @@ Sort the output lines by file path. .SS Exclusion options .INDENT 0.0 .TP -.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN +.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN exclude paths matching PATTERN .TP .BI \-\-exclude\-from \ EXCLUDEFILE diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 6880f82ae..30b346d6d 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 "2020-04-21" "" "borg backup tool" +.TH BORG-EXPORT-TAR 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball . @@ -99,7 +99,7 @@ output verbose list of items (files, dirs, ...) .SS Exclusion options .INDENT 0.0 .TP -.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN +.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN exclude paths matching PATTERN .TP .BI \-\-exclude\-from \ EXCLUDEFILE diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index 0124adcf2..0eab3c0d4 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 "2020-04-21" "" "borg backup tool" +.TH BORG-EXTRACT 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents . @@ -95,7 +95,7 @@ create holes in output sparse file from all\-zero chunks .SS Exclusion options .INDENT 0.0 .TP -.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN +.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN exclude paths matching PATTERN .TP .BI \-\-exclude\-from \ EXCLUDEFILE diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index 2e77b8511..23dbfb960 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 "2020-04-21" "" "borg backup tool" +.TH BORG-INFO 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-info \- Show archive details such as disk space used . @@ -68,10 +68,10 @@ format output as JSON .SS Archive filters .INDENT 0.0 .TP -.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX +.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX only consider archive names starting with this prefix. .TP -.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB +.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1 index a62843f6a..7aa74db80 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 "2020-04-21" "" "borg backup tool" +.TH BORG-INIT 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-init \- Initialize an empty repository . @@ -189,7 +189,7 @@ repository to create .SS optional arguments .INDENT 0.0 .TP -.BI \-e \ MODE\fP,\fB \ \-\-encryption \ MODE +.BI \-e \ MODE\fR,\fB \ \-\-encryption \ MODE select encryption key mode \fB(required)\fP .TP .B \-\-append\-only diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index eadc0bbfe..7307d48fa 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 "2020-04-21" "" "borg backup tool" +.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-key-change-passphrase \- Change repository key file passphrase . @@ -73,6 +73,11 @@ Enter new passphrase: Enter same passphrase again: Remember your passphrase. Your data will be inaccessible without it. Key updated + +# Import a previously\-exported key into the specified +# key file (creating or overwriting the output key) +# (keyfile repositories only) +$ BORG_KEY_FILE=/path/to/output\-key borg key import /path/to/repo /path/to/exported .ft P .fi .UNINDENT diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1 index df933de63..3cd026c70 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 "2020-04-21" "" "borg backup tool" +.TH BORG-KEY-EXPORT 1 "2020-10-04" "" "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 49b13f369..43bd11748 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 "2020-04-21" "" "borg backup tool" +.TH BORG-KEY-IMPORT 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-key-import \- Import the repository key from backup . @@ -40,6 +40,15 @@ This command restores a key previously backed up with the export command. If the \fB\-\-paper\fP option is given, the import will be an interactive process in which each line is checked for plausibility before proceeding to the next line. For this format PATH must not be given. +.sp +For repositories using keyfile encryption, the key file which \fBborg key +import\fP writes to depends on several factors. If the \fBBORG_KEY_FILE\fP +environment variable is set and non\-empty, \fBborg key import\fP creates +or overwrites that file named by \fB$BORG_KEY_FILE\fP\&. Otherwise, \fBborg +key import\fP searches in the \fB$BORG_KEYS_DIR\fP directory for a key file +associated with the repository. If a key file is found in +\fB$BORG_KEYS_DIR\fP, \fBborg key import\fP overwrites it; otherwise, \fBborg +key import\fP creates a new key file in \fB$BORG_KEYS_DIR\fP\&. .SH OPTIONS .sp See \fIborg\-common(1)\fP for common options of Borg commands. diff --git a/docs/man/borg-key-migrate-to-repokey.1 b/docs/man/borg-key-migrate-to-repokey.1 index 0879dc321..8c8e3ffad 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 "2020-04-21" "" "borg backup tool" +.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2020-10-04" "" "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 cde8b81c3..7d22eb6b6 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 "2020-04-21" "" "borg backup tool" +.TH BORG-KEY 1 "2020-10-04" "" "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 f24120ee3..715510b41 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 "2020-04-21" "" "borg backup tool" +.TH BORG-LIST 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-list \- List archive or repository contents . @@ -59,7 +59,7 @@ Show checkpoint archives in the repository contents list (default: hidden). .B \-\-short only print file/directory names, nothing else .TP -.BI \-\-format \ FORMAT\fP,\fB \ \-\-list\-format \ FORMAT +.BI \-\-format \ FORMAT\fR,\fB \ \-\-list\-format \ FORMAT specify format for file listing (default: "{mode} {user:6} {group:6} {size:8d} {mtime} {path}{extra}{NL}") .TP .B \-\-json @@ -71,10 +71,10 @@ Only valid for listing archive contents. Format output as JSON Lines. The form o .SS Archive filters .INDENT 0.0 .TP -.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX +.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX only consider archive names starting with this prefix. .TP -.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB +.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS @@ -89,7 +89,7 @@ consider last N archives after other filters were applied .SS Exclusion options .INDENT 0.0 .TP -.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN +.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN exclude paths matching PATTERN .TP .BI \-\-exclude\-from \ EXCLUDEFILE @@ -227,6 +227,10 @@ isoctime .IP \(bu 2 isoatime .IP \(bu 2 +blake2b +.IP \(bu 2 +blake2s +.IP \(bu 2 md5 .IP \(bu 2 sha1 @@ -237,8 +241,20 @@ sha256 .IP \(bu 2 sha384 .IP \(bu 2 +sha3_224 +.IP \(bu 2 +sha3_256 +.IP \(bu 2 +sha3_384 +.IP \(bu 2 +sha3_512 +.IP \(bu 2 sha512 .IP \(bu 2 +shake_128 +.IP \(bu 2 +shake_256 +.IP \(bu 2 xxh64: XXH64 checksum of this file (note: this is NOT a cryptographic hash!) .IP \(bu 2 archiveid diff --git a/docs/man/borg-mount.1 b/docs/man/borg-mount.1 index 932aa548c..e0aef8c22 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 "2020-04-21" "" "borg backup tool" +.TH BORG-MOUNT 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-mount \- Mount archive or an entire repository as a FUSE filesystem . @@ -105,10 +105,10 @@ Extra mount options .SS Archive filters .INDENT 0.0 .TP -.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX +.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX only consider archive names starting with this prefix. .TP -.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB +.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .TP .BI \-\-sort\-by \ KEYS @@ -123,7 +123,7 @@ consider last N archives after other filters were applied .SS Exclusion options .INDENT 0.0 .TP -.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN +.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN exclude paths matching PATTERN .TP .BI \-\-exclude\-from \ EXCLUDEFILE diff --git a/docs/man/borg-patterns.1 b/docs/man/borg-patterns.1 index e77e45c7f..1194a44ce 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 "2020-04-21" "" "borg backup tool" +.TH BORG-PATTERNS 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-patterns \- Details regarding patterns . @@ -104,7 +104,7 @@ path separator is always removed. This pattern style is (only) useful to match full paths. This is kind of a pseudo pattern as it can not have any variable or unspecified parts \- the full path must be given. \fIpf:root/file.ext\fP matches -\fIroot/file.txt\fP only. A leading path separator is always removed. +\fIroot/file.ext\fP only. A leading path separator is always removed. .sp Implementation note: this is implemented via very time\-efficient O(1) hashtable lookups (this means you can have huge amounts of such patterns diff --git a/docs/man/borg-placeholders.1 b/docs/man/borg-placeholders.1 index 97ea90e23..abe6d08a6 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 "2020-04-21" "" "borg backup tool" +.TH BORG-PLACEHOLDERS 1 "2020-10-04" "" "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 5b5cb4ce6..1bcd85eb4 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 "2020-04-21" "" "borg backup tool" +.TH BORG-PRUNE 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-prune \- Prune repository archives according to specified rules . @@ -98,7 +98,7 @@ repository to prune do not change repository .TP .B \-\-force -force pruning of corrupted archives +force pruning of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work. .TP .B \-s\fP,\fB \-\-stats print statistics for the deleted archive @@ -136,10 +136,10 @@ work slower, but using less space .SS Archive filters .INDENT 0.0 .TP -.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX +.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX only consider archive names starting with this prefix. .TP -.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB +.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive. .UNINDENT .SH EXAMPLES diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1 index c81f13653..daaa5be42 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 "2020-04-21" "" "borg backup tool" +.TH BORG-RECREATE 1 "2020-10-04" "" "borg backup tool" .SH NAME borg-recreate \- Re-create archives . @@ -37,13 +37,15 @@ borg [common options] recreate [options] [REPOSITORY_OR_ARCHIVE] [PATH...] .sp Recreate the contents of existing archives. .sp -This is an \fIexperimental\fP feature. Do \fInot\fP use this on your only backup. +recreate is a potentially dangerous function and might lead to data loss +(if used wrongly). BE VERY CAREFUL! .sp Important: Repository disk space is \fBnot\fP freed until you run \fBborg compact\fP\&. .sp -\fB\-\-exclude\fP, \fB\-\-exclude\-from\fP, \fB\-\-exclude\-if\-present\fP, \fB\-\-keep\-exclude\-tags\fP, and PATH -have the exact same semantics as in "borg create". If PATHs are specified the -resulting archive will only contain files from these PATHs. +\fB\-\-exclude\fP, \fB\-\-exclude\-from\fP, \fB\-\-exclude\-if\-present\fP, \fB\-\-keep\-exclude\-tags\fP +and PATH have the exact same semantics as in "borg create", but they only check +for files in the archives and not in the local file system. If PATHs are specified, +the resulting archives will only contain files from these PATHs. .sp Note that all paths in an archive are relative, therefore absolute patterns/paths will \fInot\fP match (\fB\-\-exclude\fP, \fB\-\-exclude\-from\fP, PATHs). @@ -61,7 +63,7 @@ Borg 1.x archives. Depending on the PATHs and patterns given, recreate can be used to permanently delete files from archives. When in doubt, use \fB\-\-dry\-run \-\-verbose \-\-list\fP to see how patterns/PATHS are -interpreted. +interpreted. See \fIlist_item_flags\fP in \fBborg create\fP for details. .sp The archive being recreated is only removed after the operation completes. The archive that is built during the operation exists at the same time at @@ -113,7 +115,7 @@ print statistics at end .SS Exclusion options .INDENT 0.0 .TP -.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN +.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN exclude paths matching PATTERN .TP .BI \-\-exclude\-from \ EXCLUDEFILE @@ -140,7 +142,7 @@ if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit .BI \-\-target \ TARGET create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive) .TP -.BI \-c \ SECONDS\fP,\fB \ \-\-checkpoint\-interval \ SECONDS +.BI \-c \ SECONDS\fR,\fB \ \-\-checkpoint\-interval \ SECONDS write checkpoint every SECONDS seconds (Default: 1800) .TP .BI \-\-comment \ COMMENT @@ -149,11 +151,11 @@ add a comment text to the archive .BI \-\-timestamp \ TIMESTAMP manually specify the archive creation date/time (UTC, yyyy\-mm\-ddThh:mm:ss format). alternatively, give a reference file/directory. .TP -.BI \-C \ COMPRESSION\fP,\fB \ \-\-compression \ COMPRESSION +.BI \-C \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION select compression algorithm, see the output of the "borg help compression" command for details. .TP .BI \-\-recompress \ MODE -recompress data chunks according to \fB\-\-compression\fP\&. MODE \fIif\-different\fP: recompress if current compression is with a different compression algorithm (the level is not considered). MODE \fIalways\fP: recompress even if current compression is with the same compression algorithm (use this to change the compression level). MODE \fInever\fP (default): do not recompress. +recompress data chunks according to \fIMODE\fP and \fB\-\-compression\fP\&. Possible modes are \fIif\-different\fP: recompress if current compression is with a different compression algorithm (the level is not considered); \fIalways\fP: recompress even if current compression is with the same compression algorithm (use this to change the compression level); and \fInever\fP: do not recompress (use this option to explicitly prevent recompression). If no MODE is given, \fIif\-different\fP will be used. Not passing \-\-recompress is equivalent to "\-\-recomp |