From fdc0743457085566327dd8ce6f627999d4a5cf57 Mon Sep 17 00:00:00 2001
From: Thomas Waldmann <tw@waldmann-edv.de>
Date: Mon, 12 Jul 2021 19:27:52 +0200
Subject: build_man

---
 docs/man/borg-benchmark-crud.1         |  2 +-
 docs/man/borg-benchmark.1              |  2 +-
 docs/man/borg-break-lock.1             |  2 +-
 docs/man/borg-change-passphrase.1      |  2 +-
 docs/man/borg-check.1                  | 12 +++++++++++-
 docs/man/borg-common.1                 |  2 +-
 docs/man/borg-compression.1            |  2 +-
 docs/man/borg-config.1                 |  2 +-
 docs/man/borg-create.1                 |  2 +-
 docs/man/borg-delete.1                 |  2 +-
 docs/man/borg-diff.1                   |  2 +-
 docs/man/borg-export-tar.1             |  2 +-
 docs/man/borg-extract.1                |  2 +-
 docs/man/borg-info.1                   |  2 +-
 docs/man/borg-init.1                   |  2 +-
 docs/man/borg-key-change-passphrase.1  |  2 +-
 docs/man/borg-key-export.1             |  2 +-
 docs/man/borg-key-import.1             |  2 +-
 docs/man/borg-key-migrate-to-repokey.1 |  2 +-
 docs/man/borg-key.1                    |  2 +-
 docs/man/borg-list.1                   |  2 +-
 docs/man/borg-mount.1                  |  2 +-
 docs/man/borg-patterns.1               | 10 +++++-----
 docs/man/borg-placeholders.1           |  2 +-
 docs/man/borg-prune.1                  |  2 +-
 docs/man/borg-recreate.1               |  2 +-
 docs/man/borg-rename.1                 |  2 +-
 docs/man/borg-serve.1                  |  2 +-
 docs/man/borg-umount.1                 |  2 +-
 docs/man/borg-upgrade.1                |  2 +-
 docs/man/borg-with-lock.1              |  2 +-
 docs/man/borg.1                        | 15 +++++++++++++++
 docs/man/borgfs.1                      |  2 +-
 33 files changed, 61 insertions(+), 36 deletions(-)

diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1
index cafa43d91..e2ceca444 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-BENCHMARK-CRUD 1 "2021-07-12" "" "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 b561628eb..43bbb6250 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-BENCHMARK 1 "2021-07-12" "" "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 e6eb43f54..6a85e8111 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 "2021-03-22" "" "borg backup tool"
+.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.
 .
diff --git a/docs/man/borg-change-passphrase.1 b/docs/man/borg-change-passphrase.1
index 0b8049a1a..a02f0858b 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-CHANGE-PASSPHRASE 1 "2021-07-12" "" "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 386357f3b..6ea4d7175 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-CHECK 1 "2021-07-12" "" "borg backup tool"
 .SH NAME
 borg-check \- Check repository consistency
 .
@@ -40,6 +40,11 @@ The check command verifies the consistency of a repository and the corresponding
 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
+Pursuant to the previous warning it is also highly recommended to test the
+reliability of the hardware running this software with stress testing software
+such as memory testers. Unreliable hardware can also lead to data loss especially
+when this command is run in repair mode.
+.sp
 First, the underlying repository data files are checked:
 .INDENT 0.0
 .IP \(bu 2
@@ -80,6 +85,11 @@ In repair mode, when all the archives were checked, orphaned chunks are deleted
 from the repo. One cause of orphaned chunks are input file related errors (like
 read errors) in the archive creation process.
 .IP \(bu 2
+In verify\-data mode, a complete cryptographic verification of the archive data
+integrity is performed. This conflicts with \fB\-\-repository\-only\fP as this mode
+only makes sense if the archive checks are enabled. The full details of this mode
+are documented below.
+.IP \(bu 2
 If checking a remote repo via \fBssh:\fP, the archive check is executed on the
 client machine because it requires decryption, and this is always done client\-side
 as key access is needed.
diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1
index 7f0fa2af1..150e3f5a1 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-COMMON 1 "2021-07-12" "" "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 905c5c1c0..3eb3ce73d 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-COMPRESSION 1 "2021-07-12" "" "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 76eca361d..06bf50e13 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 "2021-03-22" "" "borg backup tool"
+.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
 .
diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1
index 0e4c4ef98..32213ed9d 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-CREATE 1 "2021-07-12" "" "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 8d0485869..dba9a7840 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-DELETE 1 "2021-07-12" "" "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 4e6f8a649..b2d5f8f3a 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-DIFF 1 "2021-07-12" "" "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 726009e81..e4ff99fa4 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-EXPORT-TAR 1 "2021-07-12" "" "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 4a02aff56..158bcbf14 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-EXTRACT 1 "2021-07-12" "" "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 cb76a2681..a810318d1 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-INFO 1 "2021-07-12" "" "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 5b5796f84..ab7706cb8 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-INIT 1 "2021-07-12" "" "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 7b1c2ca5c..6d2806243 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2021-07-12" "" "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 4675feb58..94ddb828b 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-KEY-EXPORT 1 "2021-07-12" "" "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 3637cbcee..069bb16c4 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-KEY-IMPORT 1 "2021-07-12" "" "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 e2bef3671..03de5571e 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2021-07-12" "" "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 394ec3340..7f678b7ce 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-KEY 1 "2021-07-12" "" "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 0ba056422..f75309dd2 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-LIST 1 "2021-07-12" "" "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 1162ddaa6..7bfbc4963 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-MOUNT 1 "2021-07-12" "" "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 f5c655817..6c9c41329 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-PATTERNS 1 "2021-07-12" "" "borg backup tool"
 .SH NAME
 borg-patterns \- Details regarding patterns
 .
@@ -168,9 +168,9 @@ $ cat >exclude.txt <<EOF
 /home/*/junk
 *.tmp
 fm:aa:something/*
-re:^home/[^/]\e.tmp/
-sh:home/*/.thumbnails
- # Example with spaces, no need to escape as it is processed by borg
+re:^/home/[^/]+\e.tmp/
+sh:/home/*/.thumbnails
+# Example with spaces, no need to escape as it is processed by borg
 some file with spaces.txt
 EOF
 $ borg create \-\-exclude\-from exclude.txt backup /
@@ -190,7 +190,7 @@ with the prefix \-, an exclude\-norecurse rule starts with !, all followed by a
 .INDENT 3.5
 Via \fB\-\-pattern\fP or \fB\-\-patterns\-from\fP you can define BOTH inclusion and exclusion
 of files using pattern prefixes \fB+\fP and \fB\-\fP\&. With \fB\-\-exclude\fP and
-\fB\-\-exlude\-from\fP ONLY excludes are defined.
+\fB\-\-exclude\-from\fP ONLY excludes are defined.
 .UNINDENT
 .UNINDENT
 .sp
diff --git a/docs/man/borg-placeholders.1 b/docs/man/borg-placeholders.1
index 9aaa0afc4..de97fcc77 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-PLACEHOLDERS 1 "2021-07-12" "" "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 cb084d5fe..827eb70ba 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-PRUNE 1 "2021-07-12" "" "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 6dcb95d7c..ddc109112 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-RECREATE 1 "2021-07-12" "" "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 0be2d4f15..ed7fe0fb6 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-RENAME 1 "2021-07-12" "" "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 67429bf1c..361fba792 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-SERVE 1 "2021-07-12" "" "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 5aab0c51e..218909881 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-UMOUNT 1 "2021-07-12" "" "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 37c8bbf95..35866e25c 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-UPGRADE 1 "2021-07-12" "" "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 a753f6f03..b33387bbf 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 "2021-03-22" "" "borg backup tool"
+.TH BORG-WITH-LOCK 1 "2021-07-12" "" "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 81e220f28..062c9823f 100644
--- a/docs/man/borg.1
+++ b/docs/man/borg.1
@@ -456,6 +456,21 @@ When set to no (default: yes), system information (like OS, Python version, ...)
 exceptions is not shown.
 Please only use for good reasons as it makes issues harder to analyze.
 .TP
+.B BORG_LIBC
+borg uses \fBctypes.util.find_library\fP to locate the \(aqc\(aq library (aka libc).
+find_library needs a shell and will invoke some tools like ldconfig, gcc/cc or objdump.
+If a shell or these tools are not available, you can give the name of your libc via
+BORG_LIBC=libc.so.6 (for example) and borg will not try the \fBfind_library\fP call.
+.TP
+.B BORG_SELFTEST
+This can be used to influence borg\(aqs builtin self\-tests. The default is to execute the tests
+at the beginning of each borg command invocation.
+.sp
+BORG_SELFTEST=disabled can be used to switch off the tests and rather save some time.
+Disabling is not recommended for normal borg users, but large scale borg storage providers can
+use this to optimize production servers after at least doing a one\-time test borg (with
+selftests not disabled) when installing or upgrading machines / OS / borg.
+.TP
 .B BORG_WORKAROUNDS
 A list of comma separated strings that trigger workarounds in borg,
 e.g. to work around bugs in other software.
diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1
index 1af510feb..bd8e7210e 100644
--- a/docs/man/borgfs.1
+++ b/docs/man/borgfs.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORGFS 1 "2021-03-22" "" "borg backup tool"
+.TH BORGFS 1 "2021-07-12" "" "borg backup tool"
 .SH NAME
 borgfs \- Mount archive or an entire repository as a FUSE filesystem
 .
-- 
cgit v1.2.3