mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

build_man

This commit is contained in:
Thomas Waldmann 2021-05-11 22:33:28 +02:00
parent e79449157b
commit f301828241
33 changed files with 91 additions and 38 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.
.
.TH BORG-BENCHMARK-CRUD 1 "2021-02-06" "" "borg backup tool"
.TH BORG-BENCHMARK-CRUD 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-BENCHMARK 1 "2021-02-06" "" "borg backup tool"
.TH BORG-BENCHMARK 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-benchmark \- benchmark command
.

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

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

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

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

15
docs/man/borg-common.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-COMMON 1 "2021-02-06" "" "borg backup tool"
.TH BORG-COMMON 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-common \- Common options of Borg commands
.
@ -57,6 +57,9 @@ enable TOPIC debugging (can be specified multiple times). The logger path is bor
.B \-p\fP,\fB \-\-progress
show progress information
.TP
.B \-\-iec
format using IEC units (1KiB = 1024B)
.TP
.B \-\-log\-json
Output one JSON object per log line instead of formatted text.
.TP
@ -79,10 +82,16 @@ set umask to M (local only, default: 0077)
use PATH as borg executable on the remote (default: "borg")
.TP
.BI \-\-remote\-ratelimit \ RATE
set remote network upload rate limit in kiByte/s (default: 0=unlimited)
deprecated, use \fB\-\-upload\-ratelimit\fP instead
.TP
.BI \-\-upload\-ratelimit \ RATE
set network upload rate limit in kiByte/s (default: 0=unlimited)
.TP
.BI \-\-remote\-buffer \ UPLOAD_BUFFER
set upload buffer size in MiB. (default: 0=no buffer)
deprecated, use \fB\-\-upload\-buffer\fP instead
.TP
.BI \-\-upload\-buffer \ UPLOAD_BUFFER
set network upload buffer size in MiB. (default: 0=no buffer)
.TP
.B \-\-consider\-part\-files
treat part files like normal files (e.g. to list/extract them)

2
docs/man/borg-compact.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-COMPACT 1 "2021-02-06" "" "borg backup tool"
.TH BORG-COMPACT 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-compact \- compact segment files in the repository
.

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

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

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

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

11
docs/man/borg-create.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-CREATE 1 "2021-02-06" "" "borg backup tool"
.TH BORG-CREATE 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-create \- Create new archive
.
@ -211,6 +211,9 @@ exclude files flagged NODUMP
stay in the same file system and do not store mount points of other file systems. This might behave different from your expectations, see the docs.
.TP
.B \-\-numeric\-owner
deprecated, use \fB\-\-numeric\-ids\fP instead
.TP
.B \-\-numeric\-ids
only store numeric user and group identifiers
.TP
.B \-\-noatime
@ -231,6 +234,12 @@ deprecated, use \fB\-\-noflags\fP instead
.B \-\-noflags
do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive
.TP
.B \-\-noacls
do not read and store ACLs into archive
.TP
.B \-\-noxattrs
do not read and store xattrs into archive
.TP
.B \-\-sparse
detect sparse holes in input (supported only by fixed chunker)
.TP

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

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

18
docs/man/borg-diff.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DIFF 1 "2021-02-06" "" "borg backup tool"
.TH BORG-DIFF 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-diff \- Diff contents of two archives
.
@ -70,6 +70,9 @@ paths of items inside the archives to compare; patterns are supported
.INDENT 0.0
.TP
.B \-\-numeric\-owner
deprecated, use \fB\-\-numeric\-ids\fP instead
.TP
.B \-\-numeric\-ids
only consider numeric user and group identifiers
.TP
.B \-\-same\-chunker\-params
@ -77,6 +80,9 @@ Override check of chunker parameters.
.TP
.B \-\-sort
Sort the output lines by file path.
.TP
.B \-\-json\-lines
Format output as JSON Lines.
.UNINDENT
.SS Exclusion options
.INDENT 0.0
@ -111,6 +117,7 @@ $ chmod a+x file1
$ echo "something" >> file2
$ borg create ../testrepo::archive2 .
$ echo "testing 123" >> file1
$ rm file3
$ touch file4
$ borg create ../testrepo::archive3 .
@ -121,14 +128,21 @@ $ borg diff testrepo::archive1 archive2
+135 B \-252 B file2
$ borg diff testrepo::archive2 archive3
+17 B \-5 B file1
added 0 B file4
removed 0 B file3
$ borg diff testrepo::archive1 archive3
[\-rw\-r\-\-r\-\- \-> \-rwxr\-xr\-x] file1
+17 B \-5 B [\-rw\-r\-\-r\-\- \-> \-rwxr\-xr\-x] file1
+135 B \-252 B file2
added 0 B file4
removed 0 B file3
$ borg diff \-\-json\-lines testrepo::archive1 archive3
{"path": "file1", "changes": [{"type": "modified", "added": 17, "removed": 5}, {"type": "mode", "old_mode": "\-rw\-r\-\-r\-\-", "new_mode": "\-rwxr\-xr\-x"}]}
{"path": "file2", "changes": [{"type": "modified", "added": 135, "removed": 252}]}
{"path": "file4", "changes": [{"type": "added", "size": 0}]}
{"path": "file3", "changes": [{"type": "removed", "size": 0}]
.ft P
.fi
.UNINDENT

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

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

11
docs/man/borg-extract.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-EXTRACT 1 "2021-02-06" "" "borg backup tool"
.TH BORG-EXTRACT 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-extract \- Extract archive contents
.
@ -78,6 +78,9 @@ output verbose list of items (files, dirs, ...)
do not actually change any files
.TP
.B \-\-numeric\-owner
deprecated, use \fB\-\-numeric\-ids\fP instead
.TP
.B \-\-numeric\-ids
only obey numeric user and group identifiers
.TP
.B \-\-nobsdflags
@ -86,6 +89,12 @@ deprecated, use \fB\-\-noflags\fP instead
.B \-\-noflags
do not extract/set flags (e.g. NODUMP, IMMUTABLE)
.TP
.B \-\-noacls
do not extract/set ACLs
.TP
.B \-\-noxattrs
do not extract/set xattrs
.TP
.B \-\-stdout
write all extracted data to stdout
.TP

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-INFO 1 "2021-02-06" "" "borg backup tool"
.TH BORG-INFO 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-INIT 1 "2021-02-06" "" "borg backup tool"
.TH BORG-INIT 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2021-02-06" "" "borg backup tool"
.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-KEY-EXPORT 1 "2021-02-06" "" "borg backup tool"
.TH BORG-KEY-EXPORT 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-KEY-IMPORT 1 "2021-02-06" "" "borg backup tool"
.TH BORG-KEY-IMPORT 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2021-02-06" "" "borg backup tool"
.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-KEY 1 "2021-02-06" "" "borg backup tool"
.TH BORG-KEY 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-LIST 1 "2021-02-06" "" "borg backup tool"
.TH BORG-LIST 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-list \- List archive or repository contents
.

8
docs/man/borg-mount.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-MOUNT 1 "2021-02-06" "" "borg backup tool"
.TH BORG-MOUNT 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-mount \- Mount archive or an entire repository as a FUSE filesystem
.
@ -101,6 +101,12 @@ stay in foreground, do not daemonize
.TP
.B \-o
Extra mount options
.TP
.B \-\-numeric\-owner
deprecated, use \fB\-\-numeric\-ids\fP instead
.TP
.B \-\-numeric\-ids
use numeric user and group identifiers from archive(s)
.UNINDENT
.SS Archive filters
.INDENT 0.0

6
docs/man/borg-patterns.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PATTERNS 1 "2021-02-06" "" "borg backup tool"
.TH BORG-PATTERNS 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-patterns \- Details regarding patterns
.
@ -129,14 +129,14 @@ wildcards at most.
.UNINDENT
.sp
Exclusions can be passed via the command line option \fB\-\-exclude\fP\&. When used
from within a shell the patterns should be quoted to protect them from
from within a shell, the patterns should be quoted to protect them from
expansion.
.sp
The \fB\-\-exclude\-from\fP option permits loading exclusion patterns from a text
file with one pattern per line. Lines empty or starting with the number sign
(\(aq#\(aq) after removing whitespace on both ends are ignored. The optional style
selector prefix is also supported for patterns loaded from a file. Due to
whitespace removal paths with whitespace at the beginning or end can only be
whitespace removal, paths with whitespace at the beginning or end can only be
excluded using regular expressions.
.sp
To test your exclusion patterns without performing an actual backup you can

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PRUNE 1 "2021-02-06" "" "borg backup tool"
.TH BORG-PRUNE 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-RECREATE 1 "2021-02-06" "" "borg backup tool"
.TH BORG-RECREATE 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-recreate \- Re-create archives
.

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-SERVE 1 "2021-02-06" "" "borg backup tool"
.TH BORG-SERVE 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-UMOUNT 1 "2021-02-06" "" "borg backup tool"
.TH BORG-UMOUNT 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-umount \- un-mount the FUSE filesystem
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-UPGRADE 1 "2021-02-06" "" "borg backup tool"
.TH BORG-UPGRADE 1 "2021-05-11" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-WITH-LOCK 1 "2021-02-06" "" "borg backup tool"
.TH BORG-WITH-LOCK 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg-with-lock \- run a user specified command with the repository lock held
.

2
docs/man/borg.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG 1 "2021-02-06" "" "borg backup tool"
.TH BORG 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borg \- deduplicating and encrypting backup tool
.

8
docs/man/borgfs.1
View File

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORGFS 1 "2021-02-06" "" "borg backup tool"
.TH BORGFS 1 "2021-05-11" "" "borg backup tool"
.SH NAME
borgfs \- Mount archive or an entire repository as a FUSE filesystem
.
@ -104,6 +104,12 @@ stay in foreground, do not daemonize
.TP
.B \-o
Extra mount options
.TP
.B \-\-numeric\-owner
deprecated, use \fB\-\-numeric\-ids\fP instead
.TP
.B \-\-numeric\-ids
use numeric user and group identifiers from archive(s)
.UNINDENT
.SS Archive filters
.INDENT 0.0