build_man

borgbackup · Jul 12, 2021 · fdc0743 · fdc0743
1 parent fc3b7fd
commit fdc0743
Show file tree

Hide file tree

Showing 33 changed files with 61 additions and 36 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
 .