build_man

2026-04-01 15:15:59 -04:00 · 2019-02-10 21:21:14 +01:00 · 2019-02-10 21:21:14 +01:00 · ee45e46060
commit ee45e46060
parent be2bc78d69
33 changed files with 57 additions and 41 deletions
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-BENCHMARK-CRUD 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-BENCHMARK 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-benchmark \- benchmark command
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-BREAK-LOCK 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-CHANGE-PASSPHRASE 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-change-passphrase \- Change repository key file passphrase
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-CHECK 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-check \- Check repository consistency
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-COMMON 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-common \- Common options of Borg commands
 .
@ -83,6 +83,9 @@ treat part files like normal files (e.g. to list/extract them)
 .TP
 .BI \-\-debug\-profile \ FILE
 Write execution profile in Borg format into FILE. For local use a Python\-compatible file can be generated by suffixing FILE with ".pyprof".
+.TP
+.BI \-\-rsh \ RSH
+Use this command to connect to the \(aqborg serve\(aq process (default: \(aqssh\(aq)
 .UNINDENT
 .SH SEE ALSO
 .sp
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-COMPRESSION 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-compression \- Details regarding compression
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-CONFIG 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-config \- get, set, and delete values in a repository or cache config file
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-CREATE 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-create \- Create new archive
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-DELETE 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-delete \- Delete an existing repository or archives
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-DIFF 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-diff \- Diff contents of two archives
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-EXPORT-TAR 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-export-tar \- Export archive contents as a tarball
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-EXTRACT 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-extract \- Extract archive contents
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-INFO 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-info \- Show archive details such as disk space used
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-INIT 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-init \- Initialize an empty repository
 .
@ -186,6 +186,9 @@ create an append\-only mode repository
 .TP
 .BI \-\-storage\-quota \ QUOTA
 Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.
+.TP
+.B \-\-make\-parent\-dirs
+create the parent directories of the repository directory, if they are missing.
 .UNINDENT
 .SH EXAMPLES
 .INDENT 0.0
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-key-change-passphrase \- Change repository key file passphrase
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-KEY-EXPORT 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-key-export \- Export the repository key for backup
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-KEY-IMPORT 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-key-import \- Import the repository key from backup
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-key-migrate-to-repokey \- Migrate passphrase -> repokey
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-KEY 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-key \- Manage a keyfile or repokey of a repository
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-LIST 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-list \- List archive or repository contents
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-MOUNT 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 .
@ -47,8 +47,9 @@ used in fstab entries:
 To allow a regular user to use fstab entries, add the \fBuser\fP option:
 \fB/path/to/repo /mnt/point fuse.borgfs defaults,noauto,user 0 0\fP
 .sp
-For mount options, see the fuse(8) manual page. Additional mount options
-supported by borg:
+For FUSE configuration and mount options, see the mount.fuse(8) manual page.
+.sp
+Additional mount options supported by borg:
 .INDENT 0.0
 .IP \(bu 2
 versions: when used with a repository mount, this gives a merged, versioned
@ -57,6 +58,10 @@ view of the files in the archives. EXPERIMENTAL, layout may change in future.
 allow_damaged_files: by default damaged files (where missing chunks were
 replaced with runs of zeros by borg check \fB\-\-repair\fP) are not readable and
 return EIO (I/O error). Set this option to read such files.
+.IP \(bu 2
+ignore_permissions: for security reasons the "default_permissions" mount
+option is internally enforced by borg. "ignore_permissions" can be given to
+not enforce "default_permissions".
 .UNINDENT
 .sp
 The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-PATTERNS 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-patterns \- Details regarding patterns
 .
@ -58,7 +58,7 @@ These patterns use a variant of shell pattern syntax, with \(aq*\(aq matching
 any number of characters, \(aq?\(aq matching any single character, \(aq[...]\(aq
 matching any single character specified, including ranges, and \(aq[!...]\(aq
 matching any character not specified. For the purpose of these patterns,
-the path separator (\(aq\(aq for Windows and \(aq/\(aq on other systems) is not
+the path separator (backslash for Windows and \(aq/\(aq on other systems) is not
 treated specially. Wrap meta\-characters in brackets for a literal
 match (i.e. \fI[?]\fP to match the literal character \fI?\fP). For a path
 to match a pattern, the full path must match, or it must match
@ -79,7 +79,7 @@ Regular expressions similar to those found in Perl are supported. Unlike
 shell patterns regular expressions are not required to match the full
 path and any substring match is sufficient. It is strongly recommended to
 anchor patterns to the start (\(aq^\(aq), to the end (\(aq$\(aq) or both. Path
-separators (\(aq\(aq for Windows and \(aq/\(aq on other systems) in paths are
+separators (backslash for Windows and \(aq/\(aq on other systems) in paths are
 always normalized to a forward slash (\(aq/\(aq) before applying a pattern. The
 regular expression syntax is described in the \fI\%Python documentation for
 the re module\fP\&.
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-PLACEHOLDERS 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-placeholders \- Details regarding placeholders
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-PRUNE 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-prune \- Prune repository archives according to specified rules
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-RECREATE 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-recreate \- Re-create archives
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-RENAME 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-rename \- Rename an existing archive
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-SERVE 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-serve \- Start in server mode. This command is usually not used manually.
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-UMOUNT 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-umount \- un-mount the FUSE filesystem
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-UPGRADE 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-upgrade \- upgrade a repository from a previous version
 .
--- 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 "2018-12-08" "" "borg backup tool"
+.TH BORG-WITH-LOCK 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borg-with-lock \- run a user specified command with the repository lock held
 .
--- a/docs/man/borg.1
+++ b/docs/man/borg.1
@ -394,7 +394,7 @@ When set, use the standard output of the command (trailing newlines are stripped
 passphrase question for encrypted repositories.
 It is used when a passphrase is needed to access an encrypted repo as well as when a new
 passphrase should be initially set when initializing an encrypted repo. Note that the command
-is executed without a shell. So variables, like \fB$HOME\fP\ will work, but \fB~\fP\ won't.
+is executed without a shell. So variables, like \fB$HOME\fP will work, but \fB~\fP won\(aqt.
 If BORG_PASSPHRASE is also set, it takes precedence.
 See also BORG_NEW_PASSPHRASE.
 .TP
@ -433,8 +433,8 @@ When set, use the given filename as \fI\%INI\fP\-style logging configuration.
 .TP
 .B BORG_RSH
 When set, use this command instead of \fBssh\fP\&. This can be used to specify ssh options, such as
-a custom identity file \fBssh \-i /path/to/private/key\fP\&. See \fBman ssh\fP for other options.
-Using the \fB\-\-rsh CMD\fP commandline option overrides the environment variable.
+a custom identity file \fBssh \-i /path/to/private/key\fP\&. See \fBman ssh\fP for other options. Using
+the \fB\-\-rsh CMD\fP commandline option overrides the environment variable.
 .TP
 .B BORG_REMOTE_PATH
 When set, use the given path as borg executable on the remote (defaults to "borg" if unset).
--- a/docs/man/borgfs.1
+++ b/docs/man/borgfs.1
@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORGFS 1 "2018-12-08" "" "borg backup tool"
+.TH BORGFS 1 "2019-02-10" "" "borg backup tool"
 .SH NAME
 borgfs \- Mount archive or an entire repository as a FUSE filesystem
 .
@ -47,8 +47,9 @@ used in fstab entries:
 To allow a regular user to use fstab entries, add the \fBuser\fP option:
 \fB/path/to/repo /mnt/point fuse.borgfs defaults,noauto,user 0 0\fP
 .sp
-For mount options, see the fuse(8) manual page. Additional mount options
-supported by borg:
+For FUSE configuration and mount options, see the mount.fuse(8) manual page.
+.sp
+Additional mount options supported by borg:
 .INDENT 0.0
 .IP \(bu 2
 versions: when used with a repository mount, this gives a merged, versioned
@ -57,6 +58,10 @@ view of the files in the archives. EXPERIMENTAL, layout may change in future.
 allow_damaged_files: by default damaged files (where missing chunks were
 replaced with runs of zeros by borg check \fB\-\-repair\fP) are not readable and
 return EIO (I/O error). Set this option to read such files.
+.IP \(bu 2
+ignore_permissions: for security reasons the "default_permissions" mount
+option is internally enforced by borg. "ignore_permissions" can be given to
+not enforce "default_permissions".
 .UNINDENT
 .sp
 The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users