mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-02-25 15:33:39 +00:00
Code Issues Releases Wiki Activity

build_man

Browse source
This commit is contained in:
Thomas Waldmann 2018-08-11 18:03:32 +02:00
parent 7df39ebb9f
commit e88c2346ea
33 changed files with 53 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/man/borg-benchmark-crud.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-BENCHMARK-CRUD 1 "2018-06-11" "" "borg backup tool" .TH BORG-BENCHMARK-CRUD 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
. .

2
docs/man/borg-benchmark.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-BENCHMARK 1 "2018-06-11" "" "borg backup tool" .TH BORG-BENCHMARK 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-benchmark \- benchmark command borg-benchmark \- benchmark command
. .

2
docs/man/borg-break-lock.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-BREAK-LOCK 1 "2018-06-11" "" "borg backup tool" .TH BORG-BREAK-LOCK 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
. .

2
docs/man/borg-change-passphrase.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-CHANGE-PASSPHRASE 1 "2018-06-11" "" "borg backup tool" .TH BORG-CHANGE-PASSPHRASE 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-change-passphrase \- Change repository key file passphrase borg-change-passphrase \- Change repository key file passphrase
. .

2
docs/man/borg-check.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-CHECK 1 "2018-06-11" "" "borg backup tool" .TH BORG-CHECK 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-check \- Check repository consistency borg-check \- Check repository consistency
. .

2
docs/man/borg-common.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-COMMON 1 "2018-06-11" "" "borg backup tool" .TH BORG-COMMON 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-common \- Common options of Borg commands borg-common \- Common options of Borg commands
. .

2
docs/man/borg-compression.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-COMPRESSION 1 "2018-06-11" "" "borg backup tool" .TH BORG-COMPRESSION 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-compression \- Details regarding compression borg-compression \- Details regarding compression
. .

2
docs/man/borg-config.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-CONFIG 1 "2018-06-11" "" "borg backup tool" .TH BORG-CONFIG 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-config \- get, set, and delete values in a repository or cache config file borg-config \- get, set, and delete values in a repository or cache config file
. .

2
docs/man/borg-create.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-CREATE 1 "2018-06-11" "" "borg backup tool" .TH BORG-CREATE 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-create \- Create new archive borg-create \- Create new archive
. .

2
docs/man/borg-delete.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-DELETE 1 "2018-06-11" "" "borg backup tool" .TH BORG-DELETE 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-delete \- Delete an existing repository or archives borg-delete \- Delete an existing repository or archives
. .

8
docs/man/borg-diff.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-DIFF 1 "2018-06-11" "" "borg backup tool" .TH BORG-DIFF 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-diff \- Diff contents of two archives borg-diff \- Diff contents of two archives
. .
@ -32,12 +32,12 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.. ..
.SH SYNOPSIS .SH SYNOPSIS
.sp .sp
borg [common options] diff [options] REPO_ARCHIVE1 ARCHIVE2 [PATH...] borg [common options] diff [options] REPO::ARCHIVE1 ARCHIVE2 [PATH...]
.SH DESCRIPTION .SH DESCRIPTION
.sp .sp
This command finds differences (file contents, user/group/mode) between archives. This command finds differences (file contents, user/group/mode) between archives.
.sp .sp
A repository location and an archive name must be specified for REPO_ARCHIVE1. A repository location and an archive name must be specified for REPO::ARCHIVE1.
ARCHIVE2 is just another archive name in same repository (no repository location ARCHIVE2 is just another archive name in same repository (no repository location
allowed). allowed).
.sp .sp
@ -57,7 +57,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments .SS arguments
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B REPO_ARCHIVE1 .B REPO::ARCHIVE1
repository location and ARCHIVE1 name repository location and ARCHIVE1 name
.TP .TP
.B ARCHIVE2 .B ARCHIVE2

2
docs/man/borg-export-tar.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-EXPORT-TAR 1 "2018-06-11" "" "borg backup tool" .TH BORG-EXPORT-TAR 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-export-tar \- Export archive contents as a tarball borg-export-tar \- Export archive contents as a tarball
. .

2
docs/man/borg-extract.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-EXTRACT 1 "2018-06-11" "" "borg backup tool" .TH BORG-EXTRACT 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-extract \- Extract archive contents borg-extract \- Extract archive contents
. .

2
docs/man/borg-info.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-INFO 1 "2018-06-11" "" "borg backup tool" .TH BORG-INFO 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-info \- Show archive details such as disk space used borg-info \- Show archive details such as disk space used
. .

2
docs/man/borg-init.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-INIT 1 "2018-06-11" "" "borg backup tool" .TH BORG-INIT 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-init \- Initialize an empty repository borg-init \- Initialize an empty repository
. .

2
docs/man/borg-key-change-passphrase.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2018-06-11" "" "borg backup tool" .TH BORG-KEY-CHANGE-PASSPHRASE 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-key-change-passphrase \- Change repository key file passphrase borg-key-change-passphrase \- Change repository key file passphrase
. .

2
docs/man/borg-key-export.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-KEY-EXPORT 1 "2018-06-11" "" "borg backup tool" .TH BORG-KEY-EXPORT 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-key-export \- Export the repository key for backup borg-key-export \- Export the repository key for backup
. .

2
docs/man/borg-key-import.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-KEY-IMPORT 1 "2018-06-11" "" "borg backup tool" .TH BORG-KEY-IMPORT 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-key-import \- Import the repository key from backup borg-key-import \- Import the repository key from backup
. .

2
docs/man/borg-key-migrate-to-repokey.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2018-06-11" "" "borg backup tool" .TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-key-migrate-to-repokey \- Migrate passphrase -> repokey borg-key-migrate-to-repokey \- Migrate passphrase -> repokey
. .

2
docs/man/borg-key.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-KEY 1 "2018-06-11" "" "borg backup tool" .TH BORG-KEY 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-key \- Manage a keyfile or repokey of a repository borg-key \- Manage a keyfile or repokey of a repository
. .

2
docs/man/borg-list.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-LIST 1 "2018-06-11" "" "borg backup tool" .TH BORG-LIST 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-list \- List archive or repository contents borg-list \- List archive or repository contents
. .

2
docs/man/borg-mount.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-MOUNT 1 "2018-06-11" "" "borg backup tool" .TH BORG-MOUNT 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-mount \- Mount archive or an entire repository as a FUSE filesystem borg-mount \- Mount archive or an entire repository as a FUSE filesystem
. .

2
docs/man/borg-patterns.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-PATTERNS 1 "2018-06-11" "" "borg backup tool" .TH BORG-PATTERNS 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-patterns \- Details regarding patterns borg-patterns \- Details regarding patterns
. .

2
docs/man/borg-placeholders.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-PLACEHOLDERS 1 "2018-06-11" "" "borg backup tool" .TH BORG-PLACEHOLDERS 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-placeholders \- Details regarding placeholders borg-placeholders \- Details regarding placeholders
. .

2
docs/man/borg-prune.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-PRUNE 1 "2018-06-11" "" "borg backup tool" .TH BORG-PRUNE 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-prune \- Prune repository archives according to specified rules borg-prune \- Prune repository archives according to specified rules
. .

2
docs/man/borg-recreate.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-RECREATE 1 "2018-06-11" "" "borg backup tool" .TH BORG-RECREATE 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-recreate \- Re-create archives borg-recreate \- Re-create archives
. .

2
docs/man/borg-rename.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-RENAME 1 "2018-06-11" "" "borg backup tool" .TH BORG-RENAME 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-rename \- Rename an existing archive borg-rename \- Rename an existing archive
. .

2
docs/man/borg-serve.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-SERVE 1 "2018-06-11" "" "borg backup tool" .TH BORG-SERVE 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-serve \- Start in server mode. This command is usually not used manually. borg-serve \- Start in server mode. This command is usually not used manually.
. .

2
docs/man/borg-umount.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-UMOUNT 1 "2018-06-11" "" "borg backup tool" .TH BORG-UMOUNT 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-umount \- un-mount the FUSE filesystem borg-umount \- un-mount the FUSE filesystem
. .

2
docs/man/borg-upgrade.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-UPGRADE 1 "2018-06-11" "" "borg backup tool" .TH BORG-UPGRADE 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-upgrade \- upgrade a repository from a previous version borg-upgrade \- upgrade a repository from a previous version
. .

2
docs/man/borg-with-lock.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORG-WITH-LOCK 1 "2018-06-11" "" "borg backup tool" .TH BORG-WITH-LOCK 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borg-with-lock \- run a user specified command with the repository lock held borg-with-lock \- run a user specified command with the repository lock held
. .

24
docs/man/borg.1
View file

@ -411,6 +411,14 @@ Borg assumes that it can derive a unique hostname / identity (see \fBborg debug
If this is not the case or you do not want Borg to automatically remove stale locks, If this is not the case or you do not want Borg to automatically remove stale locks,
set this to \fIno\fP\&. set this to \fIno\fP\&.
.TP .TP
.B BORG_HOST_ID
Borg usually computes a host id from the FQDN plus the results of \fBuuid.getnode()\fP (which usually returns
a unique id based on the MAC address of the network interface. Except if that MAC happens to be all\-zero \- in
that case it returns a random value, which is not what we want (because it kills automatic stale lock removal).
So, if you have a all\-zero MAC address or other reasons to better externally control the host id, just set this
environment variable to a unique value. If all your FQDNs are unique, you can just use the FQDN. If not,
use \fI\%fqdn@uniqueid\fP\&.
.TP
.B BORG_LOGGING_CONF .B BORG_LOGGING_CONF
When set, use the given filename as \fI\%INI\fP\-style logging configuration. When set, use the given filename as \fI\%INI\fP\-style logging configuration.
.TP .TP
@ -433,7 +441,7 @@ exceptions is not shown.
Please only use for good reasons as it makes issues harder to analyze. Please only use for good reasons as it makes issues harder to analyze.
.TP .TP
.B TMPDIR .B TMPDIR
where temporary files are stored (might need a lot of temporary space for some operations) where temporary files are stored (might need a lot of temporary space for some operations), see \fI\%tempfile\fP for details
.UNINDENT .UNINDENT
.TP .TP
.B Some automatic "answerers" (if set, they automatically answer confirmation questions): .B Some automatic "answerers" (if set, they automatically answer confirmation questions):
@ -735,6 +743,8 @@ T} T{
Yes Yes
T} T{ T} T{
Yes Yes
T} T{
Yes (all)
T} T}
_ _
T{ T{
@ -743,6 +753,8 @@ T} T{
n/a n/a
T} T{ T} T{
n/a n/a
T} T{
Yes (all)
T} T}
_ _
T{ T{
@ -751,10 +763,14 @@ T} T{
n/a n/a
T} T{ T} T{
No [2] No [2]
T} T{
Yes (all)
T} T}
_ _
T{ T{
Solaris 11 Solaris and derivatives
T} T{
No [3]
T} T{ T} T{
No [3] No [3]
T} T{ T} T{
@ -762,10 +778,6 @@ n/a
T} T}
_ _
T{ T{
OpenIndiana
T}
_
T{
Windows (cygwin) Windows (cygwin)
T} T{ T} T{
No [4] No [4]

2
docs/man/borgfs.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH BORGFS 1 "2018-06-11" "" "borg backup tool" .TH BORGFS 1 "2018-08-11" "" "borg backup tool"
.SH NAME .SH NAME
borgfs \- Mount archive or an entire repository as a FUSE filesystem borgfs \- Mount archive or an entire repository as a FUSE filesystem
. .