upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-04-24 23:57:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

ran build_man

Browse source
This commit is contained in:
Thomas Waldmann 2017-04-30 01:32:26 +02:00
parent 3c279dbf78
commit b00700ae9d
28 changed files with 82 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-BREAK-LOCK 1 "2017-03-26" "" "borg backup tool"
.TH BORG-BREAK-LOCK 1 "2017-04-29" "" "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-03-26" "" "borg backup tool"
.TH BORG-CHANGE-PASSPHRASE 1 "2017-04-29" "" "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-03-26" "" "borg backup tool"
.TH BORG-CHECK 1 "2017-04-29" "" "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-03-26" "" "borg backup tool"
.TH BORG-COMMON 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-common \- Common options of Borg commands
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-COMPRESSION 1 "2017-03-26" "" "borg backup tool"
.TH BORG-COMPRESSION 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-compression \- Details regarding compression
.
@ -84,25 +84,6 @@ being any valid compression specifier.
.UNINDENT
.UNINDENT
.sp
The decision about which compression to use is done by borg like this:
.INDENT 0.0
.IP 1. 3
find a compression specifier (per file):
match the path/filename against all patterns in all \-\-compression\-from
files (if any). If a pattern matches, use the compression spec given for
that pattern. If no pattern matches (and also if you do not give any
\-\-compression\-from option), default to the compression spec given by
\-\-compression. See docs/misc/compression.conf for an example config.
.IP 2. 3
if the found compression spec is not "auto", the decision is taken:
use the found compression spec.
.IP 3. 3
if the found compression spec is "auto", test compressibility of each
chunk using lz4.
If it is compressible, use the C,[L] compression spec given within the
"auto" specifier. If it is not compressible, use no compression.
.UNINDENT
.sp
Examples:
.INDENT 0.0
.INDENT 3.5
@ -113,28 +94,7 @@ borg create \-\-compression lz4 REPO::ARCHIVE data
borg create \-\-compression zlib REPO::ARCHIVE data
borg create \-\-compression zlib,1 REPO::ARCHIVE data
borg create \-\-compression auto,lzma,6 REPO::ARCHIVE data
borg create \-\-compression\-from compression.conf \-\-compression auto,lzma ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
compression.conf has entries like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# example config file for \-\-compression\-from option
#
# Format of non\-comment / non\-empty lines:
# <compression\-spec>:<path/filename pattern>
# compression\-spec is same format as for \-\-compression option
# path/filename pattern is same format as for \-\-exclude option
none:*.gz
none:*.zip
none:*.mp3
none:*.ogg
borg create \-\-compression auto,lzma ...
.ft P
.fi
.UNINDENT

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-CREATE 1 "2017-03-26" "" "borg backup tool"
.TH BORG-CREATE 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-create \- Create new archive
.
@ -160,9 +160,6 @@ specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HA
.TP
.BI \-C \ COMPRESSION\fP,\fB \ \-\-compression \ COMPRESSION
select compression algorithm, see the output of the "borg help compression" command for details.
.TP
.BI \-\-compression\-from \ COMPRESSIONCONFIG
read compression patterns from COMPRESSIONCONFIG, see the output of the "borg help compression" command for details.
.UNINDENT
.SH EXAMPLES
.INDENT 0.0

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DELETE 1 "2017-03-26" "" "borg backup tool"
.TH BORG-DELETE 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-delete \- Delete an existing repository or archives
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DIFF 1 "2017-03-26" "" "borg backup tool"
.TH BORG-DIFF 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-diff \- Diff contents of two archives
.

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-MOUNT 1 "2017-03-26" "" "borg backup tool"
.TH BORG-MOUNT 1 "2017-04-29" "" "borg backup tool"
.SH NAME
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.
.
.TH BORG-PATTERNS 1 "2017-03-26" "" "borg backup tool"
.TH BORG-PATTERNS 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-patterns \- Details regarding patterns
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PLACEHOLDERS 1 "2017-03-26" "" "borg backup tool"
.TH BORG-PLACEHOLDERS 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-placeholders \- Details regarding placeholders
.
@ -107,6 +107,18 @@ The version of borg, only major, minor and patch version, e.g.: 1.0.8
.UNINDENT
.UNINDENT
.sp
If literal curly braces need to be used, double them for escaping:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
borg create /path/to/repo::{{literal_text}}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Examples:
.INDENT 0.0
.INDENT 3.5

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PRUNE 1 "2017-03-26" "" "borg backup tool"
.TH BORG-PRUNE 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-prune \- Prune repository archives according to specified rules
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-RECREATE 1 "2017-03-26" "" "borg backup tool"
.TH BORG-RECREATE 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-recreate \- Re-create archives
.
@ -44,9 +44,9 @@ have the exact same semantics as in "borg create". If PATHs are specified the
resulting archive will only contain files from these PATHs.
.sp
Note that all paths in an archive are relative, therefore absolute patterns/paths
will \fInot\fP match (\-\-exclude, \-\-exclude\-from, \-\-compression\-from, PATHs).
will \fInot\fP match (\-\-exclude, \-\-exclude\-from, PATHs).
.sp
\-\-compression: all chunks seen will be stored using the given method.
\-\-recompress allows to change the compression of existing data in archives.
Due to how Borg stores compressed size information this might display
incorrect information for archives that were not recreated at the same time.
There is no risk of data loss by this.
@ -143,11 +143,8 @@ manually specify the archive creation date/time (UTC, yyyy\-mm\-ddThh:mm:ss form
.BI \-C \ COMPRESSION\fP,\fB \ \-\-compression \ COMPRESSION
select compression algorithm, see the output of the "borg help compression" command for details.
.TP
.B \-\-always\-recompress
always recompress chunks, don\(aqt skip chunks already compressed with the same algorithm.
.TP
.BI \-\-compression\-from \ COMPRESSIONCONFIG
read compression patterns from COMPRESSIONCONFIG, see the output of the "borg help compression" command for details.
.B \-\-recompress
recompress data chunks according to \-\-compression if "if\-different". When "always", chunks that are already compressed that way are not skipped, but compressed again. Only the algorithm is considered for "if\-different", not the compression level (if any).
.TP
.BI \-\-chunker\-params \ PARAMS
specify the chunker parameters (CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or "default" to use the current defaults. default: 19,23,21,4095
@ -166,7 +163,7 @@ $ borg recreate /mnt/backup \-\-chunker\-params default \-\-progress
$ borg create /mnt/backup::archive /some/files \-\-compression lz4
# Then compress it \- this might take longer, but the backup has already completed, so no inconsistencies
# from a long\-running backup job.
$ borg recreate /mnt/backup::archive \-\-compression zlib,9
$ borg recreate /mnt/backup::archive \-\-recompress \-\-compression zlib,9
# Remove unwanted files from all archives in a repository
$ borg recreate /mnt/backup \-e /home/icke/Pictures/drunk_photos

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-RENAME 1 "2017-03-26" "" "borg backup tool"
.TH BORG-RENAME 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-rename \- Rename an existing archive
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-SERVE 1 "2017-03-26" "" "borg backup tool"
.TH BORG-SERVE 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-serve \- Start in server mode. This command is usually not used manually.
.
@ -53,10 +53,16 @@ only allow appending to repository segment files
borg serve has special support for ssh forced commands (see \fBauthorized_keys\fP
example below): it will detect that you use such a forced command and extract
the value of the \fB\-\-restrict\-to\-path\fP option(s).
.sp
It will then parse the original command that came from the client, makes sure
that it is also \fBborg serve\fP and enforce path restriction(s) as given by the
forced command. That way, other options given by the client (like \fB\-\-info\fP or
\fB\-\-umask\fP) are preserved (and are not fixed by the forced command).
.sp
Environment variables (such as BORG_HOSTNAME_IS_UNIQUE) contained in the original
command sent by the client are \fInot\fP interpreted, but ignored. If BORG_XXX environment
variables should be set on the \fBborg serve\fP side, then these must be set in system\-specific
locations like \fB/etc/environment\fP or in the forced command itself (example below).
.INDENT 0.0
.INDENT 3.5
.sp
@ -67,6 +73,10 @@ forced command. That way, other options given by the client (like \fB\-\-info\fP
# This will help to secure an automated remote backup system.
$ cat ~/.ssh/authorized_keys
command="borg serve \-\-restrict\-to\-path /path/to/repo",no\-pty,no\-agent\-forwarding,no\-port\-forwarding,no\-X11\-forwarding,no\-user\-rc ssh\-rsa AAAAB3[...]
# Set a BORG_XXX environment variable on the "borg serve" side
$ cat ~/.ssh/authorized_keys
command="export BORG_XXX=value; borg serve [...]",restrict ssh\-rsa [...]
.ft P
.fi
.UNINDENT

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-UMOUNT 1 "2017-03-26" "" "borg backup tool"
.TH BORG-UMOUNT 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-umount \- un-mount the FUSE filesystem
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-UPGRADE 1 "2017-03-26" "" "borg backup tool"
.TH BORG-UPGRADE 1 "2017-04-29" "" "borg backup tool"
.SH NAME
borg-upgrade \- upgrade a repository from a previous version
.
@ -35,7 +35,22 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
borg upgrade <options> REPOSITORY
.SH DESCRIPTION
.sp
Upgrade an existing Borg repository.
Upgrade an existing, local Borg repository.
.SS When you do not need borg upgrade
.sp
Not every change requires that you run \fBborg upgrade\fP\&.
.sp
You do \fBnot\fP need to run it when:
.INDENT 0.0
.IP \(bu 2
moving your repository to a different place
.IP \(bu 2
upgrading to another point release (like 1.0.x to 1.0.y),
except when noted otherwise in the changelog
.IP \(bu 2
upgrading from 1.0.x to 1.1.x,
except when noted otherwise in the changelog
.UNINDENT
.SS Borg 1.x.y upgrades
.sp
Use \fBborg upgrade \-\-tam REPO\fP to require manifest authentication
@ -63,8 +78,13 @@ helps with converting Borg 0.xx to 1.0.
.sp
Currently, only LOCAL repositories can be upgraded (issue #465).
.sp
It will change the magic strings in the repository\(aqs segments
to match the new Borg magic strings. The keyfiles found in
Please note that \fBborg create\fP (since 1.0.0) uses bigger chunks by
default than old borg or attic did, so the new chunks won\(aqt deduplicate
with the old chunks in the upgraded repository.
See \fB\-\-chunker\-params\fP option of \fBborg create\fP and \fBborg recreate\fP\&.
.sp
\fBborg upgrade\fP will change the magic strings in the repository\(aqs
segments to match the new Borg magic strings. The keyfiles found in
$ATTIC_KEYS_DIR or ~/.attic/keys/ will also be converted and
copied to $BORG_KEYS_DIR or ~/.config/borg/keys.
.sp

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

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

7
docs/man/borg.1
View file

@ -336,9 +336,10 @@ Main usecase for this is to fully automate \fBborg change\-passphrase\fP\&.
.B BORG_DISPLAY_PASSPHRASE
When set, use the value to answer the "display the passphrase for verification" question when defining a new passphrase for encrypted repositories.
.TP
.B BORG_HOSTNAME_IS_UNIQUE=yes
Use this to assert that your hostname is unique.
Borg will then automatically remove locks that it could determine to be stale.
.B BORG_HOSTNAME_IS_UNIQUE=no
Borg assumes that it can derive a unique hostname / identity (see \fBborg debug info\fP).
If this is not the case or you do not want Borg to automatically remove stale locks,
set this to \fIno\fP\&.
.TP
.B BORG_LOGGING_CONF
When set, use the given filename as \fI\%INI\fP\-style logging configuration.