build_man

borgbackup · Nov 1, 2019 · 451c4dd · 451c4dd
1 parent 454dbfc
commit 451c4dd
Show file tree

Hide file tree

Showing 33 changed files with 49 additions and 34 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 "2019-09-06" "" "borg backup tool"
+.TH BORG-BENCHMARK-CRUD 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-BENCHMARK 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-BREAK-LOCK 1 "2019-11-01" "" "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
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-CHECK 1 "2019-09-06" "" "borg backup tool"
+.TH BORG-CHECK 1 "2019-11-01" "" "borg backup tool"
 .SH NAME
 borg-check \- Check repository consistency
 .

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 "2019-09-06" "" "borg backup tool"
+.TH BORG-COMMON 1 "2019-11-01" "" "borg backup tool"
 .SH NAME
 borg-common \- Common options of Borg commands
 .

diff --git 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 "2019-09-06" "" "borg backup tool"
+.TH BORG-COMPACT 1 "2019-11-01" "" "borg backup tool"
 .SH NAME
 borg-compact \- compact segment files in the repository
 .
@@ -47,6 +47,8 @@ client or also from the server.
 Depending on the amount of segments that need compaction, it may take a while,
 so consider using the \fB\-\-progress\fP option.
 .sp
+A segment is compacted if the amount of saved space is above the percentage value
+given by the \fB\-\-threshold\fP option. If ommitted, a threshold of 10% is used.
 When using \fB\-\-verbose\fP, borg will output an estimate of the freed space.
 .sp
 After upgrading borg (server) to 1.2+, you can use \fBborg compact \-\-cleanup\-commits\fP
@@ -68,6 +70,9 @@ repository to compact
 .TP
 .B \-\-cleanup\-commits
 cleanup commit\-only 17\-byte segment files
+.TP
+.BI \-\-threshold \ PERCENT
+set minimum threshold for saved space in PERCENT (Default: 10)
 .UNINDENT
 .SH EXAMPLES
 .INDENT 0.0

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 "2019-09-06" "" "borg backup tool"
+.TH BORG-COMPRESSION 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-CONFIG 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-CREATE 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-DELETE 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-DIFF 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-EXPORT-TAR 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-EXTRACT 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-INFO 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-INIT 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-KEY-EXPORT 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-KEY-IMPORT 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-KEY 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-LIST 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-MOUNT 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-PATTERNS 1 "2019-11-01" "" "borg backup tool"
 .SH NAME
 borg-patterns \- Details regarding patterns
 .
@@ -170,6 +170,16 @@ may specify the backup roots (starting points) and patterns for inclusion/exclus
 A root path starts with the prefix \fIR\fP, followed by a path (a plain path, not a
 file pattern). An include rule starts with the prefix +, an exclude rule starts
 with the prefix \-, an exclude\-norecurse rule starts with !, all followed by a pattern.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.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.
+.UNINDENT
+.UNINDENT
+.sp
 Inclusion patterns are useful to include paths that are contained in an excluded
 path. The first matching pattern is used so if an include pattern matches before
 an exclude pattern, the file is backed up. If an exclude\-norecurse pattern matches

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 "2019-09-06" "" "borg backup tool"
+.TH BORG-PLACEHOLDERS 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-PRUNE 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-RECREATE 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-RENAME 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-SERVE 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-UMOUNT 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-UPGRADE 1 "2019-11-01" "" "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 "2019-09-06" "" "borg backup tool"
+.TH BORG-WITH-LOCK 1 "2019-11-01" "" "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
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG 1 "2017-02-05" "" "borg backup tool"
+.TH BORG 1 "2019-11-01" "" "borg backup tool"
 .SH NAME
 borg \- deduplicating and encrypting backup tool
 .

diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORGFS 1 "2019-03-21" "" "borg backup tool"
+.TH BORGFS 1 "2019-11-01" "" "borg backup tool"
 .SH NAME
 borgfs \- Mount archive or an entire repository as a FUSE filesystem
 .
@@ -82,7 +82,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .INDENT 0.0
 .TP
 .B REPOSITORY_OR_ARCHIVE
-repository/archive to mount
+repository or archive to mount
 .TP
 .B MOUNTPOINT
 where to mount filesystem