upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-03-19 00:52:11 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

build_man

Browse source
This commit is contained in:
Thomas Waldmann 2017-11-05 23:09:39 +01:00
parent 851e85b426
commit 3097c059ff
31 changed files with 71 additions and 61 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 "2017-10-22" "" "borg backup tool"
.TH BORG-BENCHMARK-CRUD 1 "2017-11-05" "" "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 "2017-10-22" "" "borg backup tool"
.TH BORG-BENCHMARK 1 "2017-11-05" "" "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 "2017-10-22" "" "borg backup tool"
.TH BORG-BREAK-LOCK 1 "2017-11-05" "" "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-change-passphrase.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-CHANGE-PASSPHRASE 1 "2017-10-22" "" "borg backup tool"
.TH BORG-CHANGE-PASSPHRASE 1 "2017-11-05" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-CHECK 1 "2017-10-22" "" "borg backup tool"
.TH BORG-CHECK 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-check \- Check repository consistency
.

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

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

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-CREATE 1 "2017-10-22" "" "borg backup tool"
.TH BORG-CREATE 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-create \- Create new archive
.
@ -108,6 +108,11 @@ The \fB\-\-progress\fP option shows (from left to right) Original, Compressed an
(O, C and D, respectively), then the Number of files (N) processed so far, followed by
the currently processed path.
.sp
When using \fB\-\-stats\fP, you will get some statistics about how much data was
added \- the "This Archive" deduplicated size there is most interesting as that is
how much your repository will grow.
Please note that the "All archives" stats refer to the state after creation.
.sp
See the output of the "borg help patterns" command for more help on exclude patterns.
See the output of the "borg help placeholders" command for more help on placeholders.
.SH OPTIONS
@ -306,9 +311,6 @@ all of its contents will be omitted from the backup. If, however, you wish to
only include the objects specified by \fB\-\-exclude\-if\-present\fP in your backup,
and not include any other contents of the containing folder, this can be enabled
through using the \fB\-\-keep\-exclude\-tags\fP option.
.sp
Borg respects the nodump flag. Files flagged nodump will be marked as excluded (x)
in \fB\-\-list\fP output.
.SS Item flags
.sp
\fB\-\-list\fP outputs a list of all files, directories and other

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DELETE 1 "2017-10-22" "" "borg backup tool"
.TH BORG-DELETE 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-delete \- Delete an existing repository or archives
.
@ -38,6 +38,11 @@ borg [common options] delete [options] [TARGET] [ARCHIVE...]
This command deletes an archive from the repository or the complete repository.
Disk space is reclaimed accordingly. If you delete the complete repository, the
local cache for it (if any) is also deleted.
.sp
When using \fB\-\-stats\fP, you will get some statistics about how much data was
deleted \- the "Deleted data" deduplicated size there is most interesting as
that is how much your repository will shrink.
Please note that the "All archives" stats refer to the state after deletion.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DIFF 1 "2017-10-22" "" "borg backup tool"
.TH BORG-DIFF 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-diff \- Diff contents of two archives
.
@ -92,15 +92,6 @@ experimental: include/exclude paths matching PATTERN
.TP
.BI \-\-patterns\-from \ PATTERNFILE
experimental: read include/exclude patterns from PATTERNFILE, one per line
.TP
.B \-\-exclude\-caches
exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.brynosaurus.com/cachedir/spec.html\fP)
.TP
.BI \-\-exclude\-if\-present \ NAME
exclude directories that are tagged by containing a filesystem object with the given NAME
.TP
.B \-\-keep\-exclude\-tags\fP,\fB \-\-keep\-tag\-files
if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive
.UNINDENT
.SH EXAMPLES
.INDENT 0.0

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-EXPORT-TAR 1 "2017-10-22" "" "borg backup tool"
.TH BORG-EXPORT-TAR 1 "2017-11-05" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-EXTRACT 1 "2017-10-22" "" "borg backup tool"
.TH BORG-EXTRACT 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-extract \- Extract archive contents
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-INFO 1 "2017-10-22" "" "borg backup tool"
.TH BORG-INFO 1 "2017-11-05" "" "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 "2017-10-22" "" "borg backup tool"
.TH BORG-INIT 1 "2017-11-05" "" "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 "2017-10-22" "" "borg backup tool"
.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2017-11-05" "" "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 "2017-10-22" "" "borg backup tool"
.TH BORG-KEY-EXPORT 1 "2017-11-05" "" "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 "2017-10-22" "" "borg backup tool"
.TH BORG-KEY-IMPORT 1 "2017-11-05" "" "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 "2017-10-22" "" "borg backup tool"
.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2017-11-05" "" "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 "2017-10-22" "" "borg backup tool"
.TH BORG-KEY 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-key \- Manage a keyfile or repokey of a repository
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-LIST 1 "2017-10-22" "" "borg backup tool"
.TH BORG-LIST 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-list \- List archive or repository contents
.
@ -97,15 +97,6 @@ experimental: include/exclude paths matching PATTERN
.TP
.BI \-\-patterns\-from \ PATTERNFILE
experimental: read include/exclude patterns from PATTERNFILE, one per line
.TP
.B \-\-exclude\-caches
exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.brynosaurus.com/cachedir/spec.html\fP)
.TP
.BI \-\-exclude\-if\-present \ NAME
exclude directories that are tagged by containing a filesystem object with the given NAME
.TP
.B \-\-keep\-exclude\-tags\fP,\fB \-\-keep\-tag\-files
if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive
.UNINDENT
.SH EXAMPLES
.INDENT 0.0

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PATTERNS 1 "2017-10-22" "" "borg backup tool"
.TH BORG-PATTERNS 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-patterns \- Details regarding patterns
.
@ -160,10 +160,12 @@ with the experimental \fB\-\-pattern\fP and \fB\-\-patterns\-from\fP options. Us
may specify the backup roots (starting points) and patterns for inclusion/exclusion.
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 \-, both followed by a pattern.
with the prefix \-, an exclude\-norecurse rule starts with !, all followed by a pattern.
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.
an exclude pattern, the file is backed up. If an exclude\-norecurse pattern matches
a directory, it won\(aqt recurse into it and won\(aqt discover any potential matches for
include rules below that directory.
.sp
Note that the default pattern style for \fB\-\-pattern\fP and \fB\-\-patterns\-from\fP is
shell style (\fIsh:\fP), so those patterns behave similar to rsync include/exclude

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PRUNE 1 "2017-10-22" "" "borg backup tool"
.TH BORG-PRUNE 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-prune \- Prune repository archives according to specified rules
.
@ -73,6 +73,11 @@ negative number of archives to keep means that there is no limit.
The \fB\-\-keep\-last N\fP option is doing the same as \fB\-\-keep\-secondly N\fP (and it will
keep the last N archives under the assumption that you do not create more than one
backup archive in the same second).
.sp
When using \fB\-\-stats\fP, you will get some statistics about how much data was
deleted \- the "Deleted data" deduplicated size there is most interesting as
that is how much your repository will shrink.
Please note that the "All archives" stats refer to the state after pruning.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
@ -171,7 +176,7 @@ $ borg prune \-v \-\-list \-\-keep\-within=10d \-\-keep\-weekly=4 \-\-keep\-mont
.UNINDENT
.sp
There is also a visualized prune example in \fBdocs/misc/prune\-example.txt\fP:
.IP "System Message: ERROR/3 (docs/virtmanpage.rst:, line 140)"
.IP "System Message: ERROR/3 (docs/virtmanpage.rst:, line 145)"
Unknown directive type "highlight".
.INDENT 0.0
.INDENT 3.5

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-RECREATE 1 "2017-10-22" "" "borg backup tool"
.TH BORG-RECREATE 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-recreate \- Re-create archives
.
@ -71,6 +71,17 @@ When rechunking space usage can be substantial, expect at least the entire
deduplicated size of the archives using the previous chunker params.
When recompressing expect approx. (throughput / checkpoint\-interval) in space usage,
assuming all chunks are recompressed.
.sp
If you recently ran borg check \-\-repair and it had to fix lost chunks with all\-zero
replacement chunks, please first run another backup for the same data and re\-run
borg check \-\-repair afterwards to heal any archives that had lost chunks which are
still generated from the input data.
.sp
Important: running borg recreate to re\-chunk will remove the chunks_healthy
metadata of all items with replacement chunks, so healing will not be possible
any more after re\-chunking (it is also unlikely it would ever work: due to the
change of chunking parameters, the missing chunk likely will never be seen again
even if you still have the data that produced it).
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-UPGRADE 1 "2017-10-22" "" "borg backup tool"
.TH BORG-UPGRADE 1 "2017-11-05" "" "borg backup tool"
.SH NAME
borg-upgrade \- upgrade a repository from a previous version
.
@ -104,13 +104,13 @@ borg delete borg
.UNINDENT
.UNINDENT
.sp
Unless \fB\-\-inplace\fP is specified, the upgrade process first
creates a backup copy of the repository, in
REPOSITORY.before\-upgrade\-DATETIME, using hardlinks. This takes
longer than in place upgrades, but is much safer and gives
progress information (as opposed to \fBcp \-al\fP). Once you are
satisfied with the conversion, you can safely destroy the
backup copy.
Unless \fB\-\-inplace\fP is specified, the upgrade process first creates a backup
copy of the repository, in REPOSITORY.before\-upgrade\-DATETIME, using hardlinks.
This requires that the repository and its parent directory reside on same
filesystem so the hardlink copy can work.
This takes longer than in place upgrades, but is much safer and gives
progress information (as opposed to \fBcp \-al\fP). Once you are satisfied
with the conversion, you can safely destroy the backup copy.
.sp
WARNING: Running the upgrade in place will make the current
copy unusable with older version, with no way of going back

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

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

3
docs/man/borg.1
View file

@ -432,6 +432,9 @@ security relevant data.
.B BORG_CACHE_DIR
Default to \(aq~/.cache/borg\(aq. This directory contains the local cache and might need a lot
of space for dealing with big repositories).
.TP
.B BORG_CONFIG_DIR
Default to \(aq~/.config/borg\(aq. This directory contains the whole config directories.
.UNINDENT
.TP
.B Building: