summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Waldmann <tw@waldmann-edv.de>2022-06-04 22:42:08 +0200
committerThomas Waldmann <tw@waldmann-edv.de>2022-06-05 10:21:17 +0200
commit549df1e15eff8dde5af96a3daa949916baad9e2b (patch)
treeb9dc100b591e7c1d5e82018903da42d4f734748e
parent967d3c7fdc1bf846cb4e0792ac7ee1cc8b97752c (diff)
build_man
-rw-r--r--docs/man/borg-benchmark-crud.16
-rw-r--r--docs/man/borg-benchmark.16
-rw-r--r--docs/man/borg-break-lock.16
-rw-r--r--docs/man/borg-change-passphrase.16
-rw-r--r--docs/man/borg-check.116
-rw-r--r--docs/man/borg-common.130
-rw-r--r--docs/man/borg-compression.16
-rw-r--r--docs/man/borg-config.112
-rw-r--r--docs/man/borg-create.157
-rw-r--r--docs/man/borg-delete.116
-rw-r--r--docs/man/borg-diff.120
-rw-r--r--docs/man/borg-export-tar.116
-rw-r--r--docs/man/borg-extract.132
-rw-r--r--docs/man/borg-info.18
-rw-r--r--docs/man/borg-init.197
-rw-r--r--docs/man/borg-key-change-passphrase.16
-rw-r--r--docs/man/borg-key-export.128
-rw-r--r--docs/man/borg-key-import.18
-rw-r--r--docs/man/borg-key-migrate-to-repokey.16
-rw-r--r--docs/man/borg-key.16
-rw-r--r--docs/man/borg-list.177
-rw-r--r--docs/man/borg-mount.131
-rw-r--r--docs/man/borg-patterns.165
-rw-r--r--docs/man/borg-placeholders.16
-rw-r--r--docs/man/borg-prune.133
-rw-r--r--docs/man/borg-recreate.120
-rw-r--r--docs/man/borg-rename.16
-rw-r--r--docs/man/borg-serve.131
-rw-r--r--docs/man/borg-umount.18
-rw-r--r--docs/man/borg-upgrade.116
-rw-r--r--docs/man/borg-with-lock.16
-rw-r--r--docs/man/borg.144
-rw-r--r--docs/man/borgfs.133
33 files changed, 490 insertions, 274 deletions
diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1
index e2ceca444..4f1820eb7 100644
--- a/docs/man/borg-benchmark-crud.1
+++ b/docs/man/borg-benchmark-crud.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-BENCHMARK-CRUD 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-BENCHMARK-CRUD" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
.SH SYNOPSIS
.sp
borg [common options] benchmark crud [options] REPOSITORY PATH
diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1
index 43bbb6250..6e1e52a28 100644
--- a/docs/man/borg-benchmark.1
+++ b/docs/man/borg-benchmark.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-BENCHMARK 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-benchmark \- benchmark command
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-BENCHMARK" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-benchmark \- benchmark command
.SH SYNOPSIS
.nf
borg [common options] benchmark crud ...
diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1
index 6a85e8111..76161d7f5 100644
--- a/docs/man/borg-break-lock.1
+++ b/docs/man/borg-break-lock.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-BREAK-LOCK 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-BREAK-LOCK" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
.SH SYNOPSIS
.sp
borg [common options] break\-lock [options] [REPOSITORY]
diff --git a/docs/man/borg-change-passphrase.1 b/docs/man/borg-change-passphrase.1
index a02f0858b..afebc9f2e 100644
--- a/docs/man/borg-change-passphrase.1
+++ b/docs/man/borg-change-passphrase.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-CHANGE-PASSPHRASE 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-change-passphrase \- Change repository key file passphrase
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-CHANGE-PASSPHRASE" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-change-passphrase \- Change repository key file passphrase
.SH SYNOPSIS
.sp
borg [common options] change\-passphrase [options] [REPOSITORY]
diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1
index 6ea4d7175..969a012aa 100644
--- a/docs/man/borg-check.1
+++ b/docs/man/borg-check.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-CHECK 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-check \- Check repository consistency
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-CHECK" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-check \- Check repository consistency
.SH SYNOPSIS
.sp
borg [common options] check [options] [REPOSITORY_OR_ARCHIVE]
@@ -116,19 +116,19 @@ repository or archive to check consistency of
.SS optional arguments
.INDENT 0.0
.TP
-.B \-\-repository\-only
+.B \-\-repository\-only
only perform repository checks
.TP
-.B \-\-archives\-only
+.B \-\-archives\-only
only perform archives checks
.TP
-.B \-\-verify\-data
+.B \-\-verify\-data
perform cryptographic archive data integrity verification (conflicts with \fB\-\-repository\-only\fP)
.TP
-.B \-\-repair
+.B \-\-repair
attempt to repair any inconsistencies found
.TP
-.B \-\-save\-space
+.B \-\-save\-space
work slower, but using less space
.UNINDENT
.SS Archive filters
diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1
index 150e3f5a1..a31343269 100644
--- a/docs/man/borg-common.1
+++ b/docs/man/borg-common.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-COMMON 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-common \- Common options of Borg commands
.
.nr rst2man-indent-level 0
.
@@ -30,46 +27,49 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-COMMON" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-common \- Common options of Borg commands
.SH SYNOPSIS
.INDENT 0.0
.TP
-.B \-h\fP,\fB \-\-help
+.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
-.B \-\-critical
+.B \-\-critical
work on log level CRITICAL
.TP
-.B \-\-error
+.B \-\-error
work on log level ERROR
.TP
-.B \-\-warning
+.B \-\-warning
work on log level WARNING (default)
.TP
-.B \-\-info\fP,\fB \-v\fP,\fB \-\-verbose
+.B \-\-info\fP,\fB \-v\fP,\fB \-\-verbose
work on log level INFO
.TP
-.B \-\-debug
+.B \-\-debug
enable debug output, work on log level DEBUG
.TP
.BI \-\-debug\-topic \ TOPIC
enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
.TP
-.B \-p\fP,\fB \-\-progress
+.B \-p\fP,\fB \-\-progress
show progress information
.TP
-.B \-\-log\-json
+.B \-\-log\-json
Output one JSON object per log line instead of formatted text.
.TP
.BI \-\-lock\-wait \ SECONDS
wait at most SECONDS for acquiring a repository/cache lock (default: 1).
.TP
-.B \-\-bypass\-lock
+.B \-\-bypass\-lock
Bypass locking mechanism
.TP
-.B \-\-show\-version
+.B \-\-show\-version
show/log the borg version
.TP
-.B \-\-show\-rc
+.B \-\-show\-rc
show/log the return code (rc)
.TP
.BI \-\-umask \ M
@@ -81,7 +81,7 @@ use PATH as borg executable on the remote (default: "borg")
.BI \-\-remote\-ratelimit \ RATE
set remote network upload rate limit in kiByte/s (default: 0=unlimited)
.TP
-.B \-\-consider\-part\-files
+.B \-\-consider\-part\-files
treat part files like normal files (e.g. to list/extract them)
.TP
.BI \-\-debug\-profile \ FILE
diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1
index 3eb3ce73d..fc3dd9e5b 100644
--- a/docs/man/borg-compression.1
+++ b/docs/man/borg-compression.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-COMPRESSION 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-compression \- Details regarding compression
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-COMPRESSION" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-compression \- Details regarding compression
.SH DESCRIPTION
.sp
It is no problem to mix different compression methods in one repo,
diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1
index 06bf50e13..6c0fa3506 100644
--- a/docs/man/borg-config.1
+++ b/docs/man/borg-config.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-CONFIG 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-config \- get, set, and delete values in a repository or cache config file
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-CONFIG" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-config \- get, set, and delete values in a repository or cache config file
.SH SYNOPSIS
.sp
borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]
@@ -65,13 +65,13 @@ new value for key
.SS optional arguments
.INDENT 0.0
.TP
-.B \-c\fP,\fB \-\-cache
+.B \-c\fP,\fB \-\-cache
get and set values from the repo cache
.TP
-.B \-d\fP,\fB \-\-delete
+.B \-d\fP,\fB \-\-delete
delete the key from the config file
.TP
-.B \-l\fP,\fB \-\-list
+.B \-l\fP,\fB \-\-list
list the configuration of the repo
.UNINDENT
.SH EXAMPLES
diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1
index 32213ed9d..950ec158d 100644
--- a/docs/man/borg-create.1
+++ b/docs/man/borg-create.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-CREATE 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-create \- Create new archive
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-CREATE" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-create \- Create new archive
.SH SYNOPSIS
.sp
borg [common options] create [options] ARCHIVE [PATH...]
@@ -116,9 +116,9 @@ how much your repository will grow. Please note that the "All archives" stats re
the state after creation. Also, the \fB\-\-stats\fP and \fB\-\-dry\-run\fP options are mutually
exclusive because the data is not actually compressed and deduplicated during a dry run.
.sp
-See the output of the "borg help patterns" command for more help on exclude patterns.
+For more help on include/exclude patterns, see the \fIborg_patterns\fP command output.
.sp
-See the output of the "borg help placeholders" command for more help on placeholders.
+For more help on placeholders, see the \fIborg_placeholders\fP command output.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
@@ -134,25 +134,25 @@ paths to archive
.SS optional arguments
.INDENT 0.0
.TP
-.B \-n\fP,\fB \-\-dry\-run
+.B \-n\fP,\fB \-\-dry\-run
do not create a backup archive
.TP
-.B \-s\fP,\fB \-\-stats
+.B \-s\fP,\fB \-\-stats
print statistics for the created archive
.TP
-.B \-\-list
+.B \-\-list
output verbose list of items (files, dirs, ...)
.TP
.BI \-\-filter \ STATUSCHARS
only display items with the given status characters (see description)
.TP
-.B \-\-json
+.B \-\-json
output stats as JSON. Implies \fB\-\-stats\fP\&.
.TP
-.B \-\-no\-cache\-sync
+.B \-\-no\-cache\-sync
experimental: do not synchronize the cache. Implies not using the files cache.
.TP
-.B \-\-no\-files\-cache
+.B \-\-no\-files\-cache
do not load/update the file metadata cache used to detect unchanged files
.TP
.BI \-\-stdin\-name \ NAME
@@ -162,7 +162,7 @@ use NAME in archive for stdin data (default: "stdin")
set user USER in archive for stdin data (default: \(aqroot\(aq)
.TP
.BI \-\-stdin\-group \ GROUP
-set group GROUP in archive for stdin data (default: \(aqroot\(aq)
+set group GROUP in archive for stdin data (default: \(aqwheel\(aq)
.TP
.BI \-\-stdin\-mode \ M
set mode to M in archive for stdin data (default: 0660)
@@ -177,57 +177,57 @@ exclude paths matching PATTERN
read exclude patterns from EXCLUDEFILE, one per line
.TP
.BI \-\-pattern \ PATTERN
-experimental: include/exclude paths matching PATTERN
+include/exclude paths matching PATTERN
.TP
.BI \-\-patterns\-from \ PATTERNFILE
-experimental: read include/exclude patterns from PATTERNFILE, one per line
+read include/exclude patterns from PATTERNFILE, one per line
.TP
-.B \-\-exclude\-caches
+.B \-\-exclude\-caches
exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.bford.info/cachedir/spec.html\fP)
.TP
.BI \-\-exclude\-if\-present \ NAME
exclude directories that are tagged by containing a filesystem object with the given NAME
.TP
-.B \-\-keep\-exclude\-tags\fP,\fB \-\-keep\-tag\-files
+.B \-\-keep\-exclude\-tags\fP,\fB \-\-keep\-tag\-files
if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive
.TP
-.B \-\-exclude\-nodump
+.B \-\-exclude\-nodump
exclude files flagged NODUMP
.UNINDENT
.SS Filesystem options
.INDENT 0.0
.TP
-.B \-x\fP,\fB \-\-one\-file\-system
+.B \-x\fP,\fB \-\-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.
.TP
-.B \-\-numeric\-owner
+.B \-\-numeric\-owner
only store numeric user and group identifiers
.TP
-.B \-\-noatime
+.B \-\-noatime
do not store atime into archive
.TP
-.B \-\-noctime
+.B \-\-noctime
do not store ctime into archive
.TP
-.B \-\-nobirthtime
+.B \-\-nobirthtime
do not store birthtime (creation date) into archive
.TP
-.B \-\-nobsdflags
+.B \-\-nobsdflags
do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive
.TP
-.B \-\-noacls
+.B \-\-noacls
do not read and store ACLs into archive
.TP
-.B \-\-noxattrs
+.B \-\-noxattrs
do not read and store xattrs into archive
.TP
-.B \-\-ignore\-inode
+.B \-\-ignore\-inode
ignore inode data in the file metadata cache used to detect unchanged files.
.TP
.BI \-\-files\-cache \ MODE
operate files cache in MODE. default: ctime,size,inode
.TP
-.B \-\-read\-special
+.B \-\-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.
.UNINDENT
.SS Archive options
@@ -325,8 +325,7 @@ $ borg create /path/to/repo::daily\-projectA\-{now:%Y\-%m\-%d} projectA
.sp
The \fB\-\-exclude\fP patterns are not like tar. In tar \fB\-\-exclude\fP .bundler/gems will
exclude foo/.bundler/gems. In borg it will not, you need to use \fB\-\-exclude\fP
-\(aq*/.bundler/gems\(aq to get the same effect. See \fBborg help patterns\fP for
-more information.
+\(aq*/.bundler/gems\(aq to get the same effect.
.sp
In addition to using \fB\-\-exclude\fP patterns, it is possible to use
\fB\-\-exclude\-if\-present\fP to specify the name of a filesystem object (e.g. a file
diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1
index dba9a7840..30ad5f3eb 100644
--- a/docs/man/borg-delete.1
+++ b/docs/man/borg-delete.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-DELETE 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-delete \- Delete an existing repository or archives
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-DELETE" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-delete \- Delete an existing repository or archives
.SH SYNOPSIS
.sp
borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
@@ -58,19 +58,19 @@ archives to delete
.SS optional arguments
.INDENT 0.0
.TP
-.B \-n\fP,\fB \-\-dry\-run
+.B \-n\fP,\fB \-\-dry\-run
do not change repository
.TP
-.B \-s\fP,\fB \-\-stats
+.B \-s\fP,\fB \-\-stats
print statistics for the deleted archive
.TP
-.B \-\-cache\-only
+.B \-\-cache\-only
delete only the local cache for the given repository
.TP
-.B \-\-force
+.B \-\-force
force deletion of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work.
.TP
-.B \-\-save\-space
+.B \-\-save\-space
work slower, but using less space
.UNINDENT
.SS Archive filters
diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1
index b2d5f8f3a..424ad07a6 100644
--- a/docs/man/borg-diff.1
+++ b/docs/man/borg-diff.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-DIFF 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-diff \- Diff contents of two archives
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-DIFF" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-diff \- Diff contents of two archives
.SH SYNOPSIS
.sp
borg [common options] diff [options] REPO::ARCHIVE1 ARCHIVE2 [PATH...]
@@ -50,7 +50,7 @@ If you did not create the archives with different chunker params,
pass \fB\-\-same\-chunker\-params\fP\&.
Note that the chunker params changed from Borg 0.xx to 1.0.
.sp
-See the output of the "borg help patterns" command for more help on exclude patterns.
+For more help on include/exclude patterns, see the \fIborg_patterns\fP command output.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
@@ -69,16 +69,16 @@ paths of items inside the archives to compare; patterns are supported
.SS optional arguments
.INDENT 0.0
.TP
-.B \-\-numeric\-owner
+.B \-\-numeric\-owner
only consider numeric user and group identifiers
.TP
-.B \-\-same\-chunker\-params
+.B \-\-same\-chunker\-params
Override check of chunker parameters.
.TP
-.B \-\-sort
+.B \-\-sort
Sort the output lines by file path.
.TP
-.B \-\-json\-lines
+.B \-\-json\-lines
Format output as JSON Lines.
.UNINDENT
.SS Exclusion options
@@ -91,10 +91,10 @@ exclude paths matching PATTERN
read exclude patterns from EXCLUDEFILE, one per line
.TP
.BI \-\-pattern \ PATTERN
-experimental: include/exclude paths matching PATTERN
+include/exclude paths matching PATTERN
.TP
.BI \-\-patterns\-from \ PATTERNFILE
-experimental: read include/exclude patterns from PATTERNFILE, one per line
+read include/exclude patterns from PATTERNFILE, one per line
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1
index e4ff99fa4..059594955 100644
--- a/docs/man/borg-export-tar.1
+++ b/docs/man/borg-export-tar.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-EXPORT-TAR 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-export-tar \- Export archive contents as a tarball
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-EXPORT-TAR" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-export-tar \- Export archive contents as a tarball
.SH SYNOPSIS
.sp
borg [common options] export\-tar [options] ARCHIVE FILE [PATH...]
@@ -68,7 +68,7 @@ By default the entire archive is extracted but a subset of files and directories
can be selected by passing a list of \fBPATHs\fP as arguments.
The file selection can further be restricted by using the \fB\-\-exclude\fP option.
.sp
-See the output of the "borg help patterns" command for more help on exclude patterns.
+For more help on include/exclude patterns, see the \fIborg_patterns\fP command output.
.sp
\fB\-\-progress\fP can be slower than no progress display, since it makes one additional
pass over the archive metadata.
@@ -90,10 +90,10 @@ paths to extract; patterns are supported
.SS optional arguments
.INDENT 0.0
.TP
-.B \-\-tar\-filter
+.B \-\-tar\-filter
filter program to pipe data through
.TP
-.B \-\-list
+.B \-\-list
output verbose list of items (files, dirs, ...)
.UNINDENT
.SS Exclusion options
@@ -106,10 +106,10 @@ exclude paths matching PATTERN
read exclude patterns from EXCLUDEFILE, one per line
.TP
.BI \-\-pattern \ PATTERN
-experimental: include/exclude paths matching PATTERN
+include/exclude paths matching PATTERN
.TP
.BI \-\-patterns\-from \ PATTERNFILE
-experimental: read include/exclude patterns from PATTERNFILE, one per line
+read include/exclude patterns from PATTERNFILE, one per line
.TP
.BI \-\-strip\-components \ NUMBER
Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.
diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1
index 158bcbf14..85699a1dd 100644
--- a/docs/man/borg-extract.1
+++ b/docs/man/borg-extract.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-EXTRACT 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-extract \- Extract archive contents
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-EXTRACT" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-extract \- Extract archive contents
.SH SYNOPSIS
.sp
borg [common options] extract [options] ARCHIVE [PATH...]
@@ -40,7 +40,7 @@ archive is extracted but a subset of files and directories can be selected
by passing a list of \fBPATHs\fP as arguments. The file selection can further
be restricted by using the \fB\-\-exclude\fP option.
.sp
-See the output of the "borg help patterns" command for more help on exclude patterns.
+For more help on include/exclude patterns, see the \fIborg_patterns\fP command output.
.sp
By using \fB\-\-dry\-run\fP, you can do all extraction steps except actually writing the
output data: reading metadata and data chunks from the repo, checking the hash/hmac,
@@ -54,6 +54,10 @@ pass over the archive metadata.
.INDENT 3.5
Currently, extract always writes into the current working directory ("."),
so make sure you \fBcd\fP to the right place before calling \fBborg extract\fP\&.
+.sp
+When parent directories are not extracted (because of using file/directory selection
+or any other reason), borg can not restore parent directories\(aq metadata, e.g. owner,
+group, permission, etc.
.UNINDENT
.UNINDENT
.SH OPTIONS
@@ -71,28 +75,28 @@ paths to extract; patterns are supported
.SS optional arguments
.INDENT 0.0
.TP
-.B \-\-list
+.B \-\-list
output verbose list of items (files, dirs, ...)
.TP
-.B \-n\fP,\fB \-\-dry\-run
+.B \-n\fP,\fB \-\-dry\-run
do not actually change any files
.TP
-.B \-\-numeric\-owner
+.B \-\-numeric\-owner
only obey numeric user and group identifiers
.TP
-.B \-\-nobsdflags
+.B \-\-nobsdflags
do not extract/set bsdflags (e.g. NODUMP, IMMUTABLE)
.TP
-.B \-\-noacls
+.B \-\-noacls
do not extract/set ACLs
.TP
-.B \-\-noxattrs
+.B \-\-noxattrs
do not extract/set xattrs
.TP
-.B \-\-stdout
+.B \-\-stdout
write all extracted data to stdout
.TP
-.B \-\-sparse
+.B \-\-sparse
create holes in output sparse file from all\-zero chunks
.UNINDENT
.SS Exclusion options
@@ -105,10 +109,10 @@ exclude paths matching PATTERN
read exclude patterns from EXCLUDEFILE, one per line
.TP
.BI \-\-pattern \ PATTERN
-experimental: include/exclude paths matching PATTERN
+include/exclude paths matching PATTERN
.TP
.BI \-\-patterns\-from \ PATTERNFILE
-experimental: read include/exclude patterns from PATTERNFILE, one per line
+read include/exclude patterns from PATTERNFILE, one per line
.TP
.BI \-\-strip\-components \ NUMBER
Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.
diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1
index a810318d1..92dca61d7 100644
--- a/docs/man/borg-info.1
+++ b/docs/man/borg-info.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-INFO 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-info \- Show archive details such as disk space used
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-INFO" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-info \- Show archive details such as disk space used
.SH SYNOPSIS
.sp
borg [common options] info [options] [REPOSITORY_OR_ARCHIVE]
@@ -62,7 +62,7 @@ repository or archive to display information about
.SS optional arguments
.INDENT 0.0
.TP
-.B \-\-json
+.B \-\-json
format output as JSON
.UNINDENT
.SS Archive filters
diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1
index ab7706cb8..ab840767a 100644
--- a/docs/man/borg-init.1
+++ b/docs/man/borg-init.1
@@ -1,8 +1,5 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-INIT 1 "2021-07-12" "" "borg backup tool"
-.SH NAME
-borg-init \- Initialize an empty repository
.
.nr rst2man-indent-level 0
.
@@ -30,6 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
+.TH "BORG-INIT" 1 "2022-06-04" "" "borg backup tool"
+.SH NAME
+borg-init \- Initialize an empty repository
.SH SYNOPSIS
.sp
borg [common options] init [options] [REPOSITORY]
@@ -37,32 +37,61 @@ borg [common options] init [options] [REPOSITORY]
.sp
This command initializes an empty repository. A repository is a filesystem
directory containing the deduplicated data from zero or more archives.
+.SS Encryption mode TLDR
.sp
-Encryption can be enabled at repository init time. It cannot be changed later.
+The encryption mode can only be configured when creating a new repository \-
+you can neither configure it on a per\-archive basis nor change the
+encryption mode of an existing repository.
.sp
-It is not recommended to work without encryption. Repository encryption protects
-you e.g. against the case that an attacker has access to your backup repository.
-.sp
-Borg relies on randomly generated key material and uses that for chunking, id
-generation, encryption and authentication. The key material is encrypted using