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

Merge pull request #4753 from borgbackup/rel120a7

Browse source 
Release 1.2.0a7
This commit is contained in:
TW 2019-09-07 05:46:14 +02:00 committed by GitHub
commit 2ee28f0aed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
44 changed files with 212 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/changes.rst
View file

@ -171,8 +171,8 @@ The best check that everything is ok is to run a dry-run extraction::
Changelog
=========
Version 1.2.0a7 (not released yet)
----------------------------------
Version 1.2.0a7 (2019-09-07)
----------------------------
Please note:
@ -238,6 +238,7 @@ Fixes:
New features:
- minimal native Windows support, see windows readme (work in progress)
- create: first ctrl-c (SIGINT) triggers checkpoint and abort, #4606
- new BORG_WORKAROUNDS mechanism, basesyncfile, #4710
- remove WSL autodetection. if WSL still has this problem, you need to
set BORG_WORKAROUNDS=basesyncfile in the borg process environment to

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-BENCHMARK-CRUD 1 "2019-04-22" "" "borg backup tool"
.TH BORG-BENCHMARK-CRUD 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
.
@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
borg [common options] benchmark crud [options] REPO PATH
borg [common options] benchmark crud [options] REPOSITORY PATH
.SH DESCRIPTION
.sp
This command benchmarks borg CRUD (create, read, update, delete) operations.
@ -44,8 +44,16 @@ command will create / read / update / delete some archives named borg\-benchmark
Make sure you have free space there, you\(aqll need about 1GB each (+ overhead).
.sp
If your repository is encrypted and borg needs a passphrase to unlock the key, use:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
BORG_PASSPHRASE=mysecret borg benchmark crud REPO PATH
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Measurements are done with different input file sizes and counts.
The file contents are very artificial (either all zero or all random),
@ -80,8 +88,8 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments
.INDENT 0.0
.TP
.B REPO
repo to use for benchmark (must exist)
.B REPOSITORY
repository to use for benchmark (must exist)
.TP
.B PATH
path were to create benchmark input data

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-BENCHMARK 1 "2019-04-22" "" "borg backup tool"
.TH BORG-BENCHMARK 1 "2019-09-06" "" "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 "2019-03-21" "" "borg backup tool"
.TH BORG-BREAK-LOCK 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-CHECK 1 "2019-03-21" "" "borg backup tool"
.TH BORG-CHECK 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-check \- Check repository consistency
.
@ -56,6 +56,8 @@ If you use a remote repo server via ssh:, the repo check is executed on the
repo server without causing significant network traffic.
.IP \(bu 2
The repository check can be skipped using the \fB\-\-archives\-only\fP option.
.IP \(bu 2
A repository check can be time consuming. Partial checks are possible with the \fB\-\-max\-duration\fP option.
.UNINDENT
.sp
Second, the consistency and correctness of the archive metadata is verified:
@ -87,6 +89,16 @@ The archive checks can be time consuming, they can be skipped using the
\fB\-\-repository\-only\fP option.
.UNINDENT
.sp
The \fB\-\-max\-duration\fP option can be used to split a long\-running repository check into multiple partial checks.
After the given number of seconds the check is interrupted. The next partial check will continue where the
previous one stopped, until the complete repository has been checked. Example: Assuming a full check took 7
hours, then running a daily check with \-\-max\-duration=3600 (1 hour) would result in one full check per week.
.sp
Attention: Partial checks can only do way less checks than a full check (only the CRC32 checks on segment file
entries are done) and cannot be combined with \fB\-\-repair\fP\&. Partial checks may therefore be useful only with very
large repositories where a full check would take too long. Doing a full repository check aborts a partial check;
the next partial check will start from the beginning.
.sp
The \fB\-\-verify\-data\fP option will perform a full integrity verification (as opposed to
checking the CRC32 of the segment) of data, which means reading the data from the
repository, decrypting and decompressing it. This is a cryptographic verification,

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

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

20
docs/man/borg-compact.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-COMPACT 1 "2019-03-21" "" "borg backup tool"
.TH BORG-COMPACT 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-compact \- compact segment files in the repository
.
@ -32,18 +32,26 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
borg [common options] compact [options] REPOSITORY
borg [common options] compact [options] [REPOSITORY]
.SH DESCRIPTION
.sp
This command frees repository space by compacting segments.
.sp
Use this regularly to avoid running out of space \- you do not need to use this
after each borg command though.
after each borg command though. It is especially useful after deleting archives,
because only compaction will really free repository space.
.sp
borg compact does not need a key, so it is possible to invoke it from the
client or also from the server.
.sp
Depending on the amount of segments that need compaction, it may take a while.
Depending on the amount of segments that need compaction, it may take a while,
so consider using the \fB\-\-progress\fP option.
.sp
When using \fB\-\-verbose\fP, borg will output an estimate of the freed space.
.sp
After upgrading borg (server) to 1.2+, you can use \fBborg compact \-\-cleanup\-commits\fP
to clean up the numerous 17byte commit\-only segments that borg 1.1 did not clean up
due to a bug. It is enough to do that once per repository.
.sp
See \fIseparate_compaction\fP in Additional Notes for more details.
.SH OPTIONS
@ -70,9 +78,7 @@ cleanup commit\-only 17\-byte segment files
# compact segments and free repo disk space
$ borg compact /path/to/repo
# same as above plus clean up 17byte commit\-only segments,
# use this one time after upgrading borg (server) to 1.2+
# to clean up the tiny segments files created by borg 1.1:
# same as above plus clean up 17byte commit\-only segments
$ borg compact \-\-cleanup\-commits /path/to/repo
.ft P
.fi

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-COMPRESSION 1 "2019-03-21" "" "borg backup tool"
.TH BORG-COMPRESSION 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-compression \- Details regarding compression
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-CONFIG 1 "2019-03-21" "" "borg backup tool"
.TH BORG-CONFIG 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-config \- get, set, and delete values in a repository or cache config file
.
@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
borg [common options] config [options] REPOSITORY [NAME] [VALUE]
borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]
.SH DESCRIPTION
.sp
This command gets and sets options in a local 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 "2019-03-21" "" "borg backup tool"
.TH BORG-CREATE 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-create \- Create new archive
.
@ -191,6 +191,9 @@ only store numeric user and group identifiers
.B \-\-noatime
do not store atime into archive
.TP
.B \-\-atime
do store atime into archive
.TP
.B \-\-noctime
do not store ctime into archive
.TP
@ -251,6 +254,10 @@ $ borg create /path/to/repo::my\-files /home \e
# use zlib compression (good, but slow) \- default is lz4 (fast, low compression ratio)
$ borg create \-C zlib,6 \-\-one\-file\-system /path/to/repo::root\-{now:%Y\-%m\-%d} /
# Backup onto a remote host ("push" style) via ssh to port 2222,
# logging in as user "borg" and storing into /path/to/repo
$ borg create ssh://borg@backup.example.org:2222/path/to/repo::{fqdn}\-root\-{now} /
# Backup a remote host locally ("pull" style) using sshfs
$ mkdir sshfs\-mount
$ sshfs root@example.com:/ sshfs\-mount
@ -284,7 +291,7 @@ $ borg create \-\-compression auto,lzma,N /path/to/repo::arch ~
# Use short hostname, user name and current time in archive name
$ borg create /path/to/repo::{hostname}\-{user}\-{now} ~
# Similar, use the same datetime format as borg 1.1 will have as default
# Similar, use the same datetime format that is default as of borg 1.1
$ borg create /path/to/repo::{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S} ~
# As above, but add nanoseconds
$ borg create /path/to/repo::{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S.%f} ~

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DELETE 1 "2019-03-21" "" "borg backup tool"
.TH BORG-DELETE 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-delete \- Delete an existing repository or archives
.
@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
borg [common options] delete [options] [TARGET] [ARCHIVE...]
borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
.SH DESCRIPTION
.sp
This command deletes an archive from the repository or the complete repository.
@ -64,8 +64,8 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments
.INDENT 0.0
.TP
.B TARGET
archive or repository to delete
.B REPOSITORY_OR_ARCHIVE
repository or archive to delete
.TP
.B ARCHIVE
archives to delete

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DIFF 1 "2019-03-21" "" "borg backup tool"
.TH BORG-DIFF 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-diff \- Diff contents of two archives
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-EXPORT-TAR 1 "2019-03-21" "" "borg backup tool"
.TH BORG-EXPORT-TAR 1 "2019-09-06" "" "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 "2019-03-21" "" "borg backup tool"
.TH BORG-EXTRACT 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-extract \- Extract archive contents
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-INFO 1 "2019-03-21" "" "borg backup tool"
.TH BORG-INFO 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-info \- Show archive details such as disk space used
.
@ -57,7 +57,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.INDENT 0.0
.TP
.B REPOSITORY_OR_ARCHIVE
archive or repository to display information about
repository or archive to display information about
.UNINDENT
.SS optional arguments
.INDENT 0.0

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-LIST 1 "2019-03-21" "" "borg backup tool"
.TH BORG-LIST 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-list \- List archive or repository contents
.
@ -45,7 +45,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.INDENT 0.0
.TP
.B REPOSITORY_OR_ARCHIVE
repository/archive to list contents of
repository or archive to list contents of
.TP
.B PATH
paths to list; patterns are supported
@ -236,6 +236,8 @@ sha384
.IP \(bu 2
sha512
.IP \(bu 2
xxh64: XXH64 checksum of this file (note: this is NOT a cryptographic hash!)
.IP \(bu 2
archiveid
.IP \(bu 2
archivename

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-MOUNT 1 "2019-03-21" "" "borg backup tool"
.TH BORG-MOUNT 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-mount \- Mount archive or an entire repository as a FUSE filesystem
.
@ -82,7 +82,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.INDENT 0.0
.TP
.B REPOSITORY_OR_ARCHIVE
repository/archive to mount
repository or archive to mount
.TP
.B MOUNTPOINT
where to mount filesystem

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PATTERNS 1 "2019-03-21" "" "borg backup tool"
.TH BORG-PATTERNS 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-patterns \- Details regarding patterns
.
@ -219,6 +219,8 @@ R /
+ /home/susan
# don\(aqt backup the other home directories
\- /home/*
# don\(aqt even look in /proc
! /proc
.ft P
.fi
.UNINDENT

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PLACEHOLDERS 1 "2019-03-21" "" "borg backup tool"
.TH BORG-PLACEHOLDERS 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-placeholders \- Details regarding placeholders
.
@ -32,8 +32,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH DESCRIPTION
.sp
Repository (or Archive) URLs, \fB\-\-prefix\fP and \fB\-\-remote\-path\fP values support these
placeholders:
Repository (or Archive) URLs, \fB\-\-prefix\fP, \fB\-\-glob\-archives\fP, \fB\-\-comment\fP
and \fB\-\-remote\-path\fP values support these placeholders:
.INDENT 0.0
.TP
.B {hostname}

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-RECREATE 1 "2019-03-21" "" "borg backup tool"
.TH BORG-RECREATE 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-recreate \- Re-create archives
.
@ -90,7 +90,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.INDENT 0.0
.TP
.B REPOSITORY_OR_ARCHIVE
repository/archive to recreate
repository or archive to recreate
.TP
.B PATH
paths to recreate; patterns are supported

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-SERVE 1 "2019-03-21" "" "borg backup tool"
.TH BORG-SERVE 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-serve \- Start in server mode. This command is usually not used manually.
.
@ -102,6 +102,48 @@ has been introduced in v7.2. We recommend to use
in this case.
.UNINDENT
.UNINDENT
.SS SSH Configuration
.sp
\fBborg serve\fP\(aqs pipes (\fBstdin\fP/\fBstdout\fP/\fBstderr\fP) are connected to the \fBsshd\fP process on the server side. In the event that the SSH connection between \fBborg serve\fP and the client is disconnected or stuck abnormally (for example, due to a network outage), it can take a long time for \fBsshd\fP to notice the client is disconnected. In the meantime, \fBsshd\fP continues running, and as a result so does the \fBborg serve\fP process holding the lock on the repository. This can cause subsequent \fBborg\fP operations on the remote repository to fail with the error: \fBFailed to create/acquire the lock\fP\&.
.sp
In order to avoid this, it is recommended to perform the following additional SSH configuration:
.sp
Either in the client side\(aqs \fB~/.ssh/config\fP file, or in the client\(aqs \fB/etc/ssh/ssh_config\fP file:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Host backupserver
ServerAliveInterval 10
ServerAliveCountMax 30
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Replacing \fBbackupserver\fP with the hostname, FQDN or IP address of the borg server.
.sp
This will cause the client to send a keepalive to the server every 10 seconds. If 30 consecutive keepalives are sent without a response (a time of 300 seconds), the ssh client process will be terminated, causing the borg process to terminate gracefully.
.sp
On the server side\(aqs \fBsshd\fP configuration file (typically \fB/etc/ssh/sshd_config\fP):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ClientAliveInterval 10
ClientAliveCountMax 30
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will cause the server to send a keep alive to the client every 10 seconds. If 30 consecutive keepalives are sent without a response (a time of 300 seconds), the server\(aqs sshd process will be terminated, causing the \fBborg serve\fP process to terminate gracefully and release the lock on the repository.
.sp
If you then run borg commands with \fB\-\-lock\-wait 600\fP, this gives sufficient time for the borg serve processes to terminate after the SSH connection is torn down after the 300 second wait for the keepalives to fail.
.sp
You may, of course, modify the timeout values demonstrated above to values that suit your environment and use case.
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-UPGRADE 1 "2019-03-21" "" "borg backup tool"
.TH BORG-UPGRADE 1 "2019-09-06" "" "borg backup tool"
.SH NAME
borg-upgrade \- upgrade a repository from a previous version
.
@ -100,7 +100,12 @@ from scratch, use \fIborg delete\fP over the copied repository to
make sure the cache files are also removed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
borg delete borg
.ft P
.fi
.UNINDENT
.UNINDENT
.sp

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

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

26
docs/man/borg.1
View file

@ -451,6 +451,21 @@ When set to no (default: yes), system information (like OS, Python version, ...)
exceptions is not shown.
Please only use for good reasons as it makes issues harder to analyze.
.TP
.B BORG_WORKAROUNDS
A list of comma separated strings that trigger workarounds in borg,
e.g. to work around bugs in other software.
.sp
Currently known strings are:
.INDENT 7.0
.TP
.B basesyncfile
Use the more simple BaseSyncFile code to avoid issues with sync_file_range.
You might need this to run borg on WSL (Windows Subsystem for Linux) or
in systemd.nspawn containers on some architectures (e.g. ARM).
Using this does not affect data safety, but might result in a more bursty
write to disk behaviour (not continuously streaming to disk).
.UNINDENT
.TP
.B TMPDIR
where temporary files are stored (might need a lot of temporary space for some operations), see \fI\%tempfile\fP for details
.UNINDENT
@ -658,7 +673,16 @@ the size of all deduplicated, small chunks in the repository. Big chunks
won\(aqt be locally cached.
.TP
.B Temporary files (server):
None.
A non\-trivial amount of data will be stored on the remote temp directory
for each client that connects to it. For some remotes, this can fill the
default temporary directory at /tmp. This can be remediated by ensuring the
$TMPDIR, $TEMP, or $TMP environment variable is properly set for the sshd
process.
For some OSes, this can be done just by setting the correct value in the
.bashrc (or equivalent login config file for other shells), however in
other cases it may be neccessary to first enable \fBPermitUserEnvironment yes\fP
in your \fBsshd_config\fP file, then add \fBenvironment="TMPDIR=/my/big/tmpdir"\fP
at the start of the public key to be used in the \fBauthorized_hosts\fP file.
.TP
.B Cache files (client only):
Contains the chunks index and files index (plus a collection of single\-

35
docs/usage/benchmark_crud.rst.inc
View file

@ -6,23 +6,23 @@ borg benchmark crud
-------------------
.. code-block:: none
borg [common options] benchmark crud [options] REPO PATH
borg [common options] benchmark crud [options] REPOSITORY PATH
.. only:: html
.. class:: borg-options-table
+-------------------------------------------------------+----------+------------------------------------------+
| **positional arguments** |
+-------------------------------------------------------+----------+------------------------------------------+
| | ``REPO`` | repo to use for benchmark (must exist) |
+-------------------------------------------------------+----------+------------------------------------------+
| | ``PATH`` | path were to create benchmark input data |
+-------------------------------------------------------+----------+------------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-------------------------------------------------------+----------+------------------------------------------+
+-------------------------------------------------------+----------------+----------------------------------------------+
| **positional arguments** |
+-------------------------------------------------------+----------------+----------------------------------------------+
| | ``REPOSITORY`` | repository to use for benchmark (must exist) |
+-------------------------------------------------------+----------------+----------------------------------------------+
| | ``PATH`` | path were to create benchmark input data |
+-------------------------------------------------------+----------------+----------------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
+-------------------------------------------------------+----------------+----------------------------------------------+
.. raw:: html
@ -34,8 +34,8 @@ borg benchmark crud
.. only:: latex
REPO
repo to use for benchmark (must exist)
REPOSITORY
repository to use for benchmark (must exist)
PATH
path were to create benchmark input data
@ -54,12 +54,9 @@ command will create / read / update / delete some archives named borg-benchmark-
Make sure you have free space there, you'll need about 1GB each (+ overhead).
Important: The space used in the repository will **not** be freed until you run
``borg compact``.
If your repository is encrypted and borg needs a passphrase to unlock the key, use::
If your repository is encrypted and borg needs a passphrase to unlock the key, use:
BORG_PASSPHRASE=mysecret borg benchmark crud REPO PATH
BORG_PASSPHRASE=mysecret borg benchmark crud REPO PATH
Measurements are done with different input file sizes and counts.
The file contents are very artificial (either all zero or all random),

14
docs/usage/compact.rst.inc
View file

@ -6,7 +6,7 @@ borg compact
------------
.. code-block:: none
borg [common options] compact [options] REPOSITORY
borg [common options] compact [options] [REPOSITORY]
.. only:: html
@ -53,11 +53,19 @@ Description
This command frees repository space by compacting segments.
Use this regularly to avoid running out of space - you do not need to use this
after each borg command though.
after each borg command though. It is especially useful after deleting archives,
because only compaction will really free repository space.
borg compact does not need a key, so it is possible to invoke it from the
client or also from the server.
Depending on the amount of segments that need compaction, it may take a while.
Depending on the amount of segments that need compaction, it may take a while,
so consider using the ``--progress`` option.
When using ``--verbose``, borg will output an estimate of the freed space.
After upgrading borg (server) to 1.2+, you can use ``borg compact --cleanup-commits``
to clean up the numerous 17byte commit-only segments that borg 1.1 did not clean up
due to a bug. It is enough to do that once per repository.
See :ref:`separate_compaction` in Additional Notes for more details.

2
docs/usage/config.rst.inc
View file

@ -6,7 +6,7 @@ borg config
-----------
.. code-block:: none
borg [common options] config [options] REPOSITORY [NAME] [VALUE]
borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]
.. only:: html

3
docs/usage/create.rst.inc
View file

@ -65,6 +65,8 @@ borg create
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--noatime`` | do not store atime into archive |
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--atime`` | do store atime into archive |
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--noctime`` | do not store ctime into archive |
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--nobirthtime`` | do not store birthtime (creation date) into archive |
@ -132,6 +134,7 @@ borg create
-x, --one-file-system stay in the same file system and do not store mount points of other file systems
--numeric-owner only store numeric user and group identifiers
--noatime do not store atime into archive
--atime do store atime into archive
--noctime do not store ctime into archive
--nobirthtime do not store birthtime (creation date) into archive
--nobsdflags do not read and store bsdflags (e.g. NODUMP, IMMUTABLE) into archive

8
docs/usage/delete.rst.inc
View file

@ -6,7 +6,7 @@ borg delete
-----------
.. code-block:: none
borg [common options] delete [options] [TARGET] [ARCHIVE...]
borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
.. only:: html
@ -15,7 +15,7 @@ borg delete
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``TARGET`` | archive or repository to delete |
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to delete |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``ARCHIVE`` | archives to delete |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -58,8 +58,8 @@ borg delete
.. only:: latex
TARGET
archive or repository to delete
REPOSITORY_OR_ARCHIVE
repository or archive to delete
ARCHIVE
archives to delete

6
docs/usage/help.rst.inc
View file

@ -171,6 +171,8 @@ Examples::
+ /home/susan
# don't backup the other home directories
- /home/*
# don't even look in /proc
! /proc
.. _borg_placeholders:
@ -178,8 +180,8 @@ borg help placeholders
~~~~~~~~~~~~~~~~~~~~~~
Repository (or Archive) URLs, ``--prefix`` and ``--remote-path`` values support these
placeholders:
Repository (or Archive) URLs, ``--prefix``, ``--glob-archives``, ``--comment``
and ``--remote-path`` values support these placeholders:
{hostname}
The (short) hostname of the machine.

4
docs/usage/info.rst.inc
View file

@ -15,7 +15,7 @@ borg info
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``REPOSITORY_OR_ARCHIVE`` | archive or repository to display information about |
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to display information about |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **optional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -49,7 +49,7 @@ borg info
.. only:: latex
REPOSITORY_OR_ARCHIVE
archive or repository to display information about
repository or archive to display information about
optional arguments

5
docs/usage/list.rst.inc
View file

@ -15,7 +15,7 @@ borg list
+-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``REPOSITORY_OR_ARCHIVE`` | repository/archive to list contents of |
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to list contents of |
+-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``PATH`` | paths to list; patterns are supported |
+-----------------------------------------------------------------------------+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -67,7 +67,7 @@ borg list
.. only:: latex
REPOSITORY_OR_ARCHIVE
repository/archive to list contents of
repository or archive to list contents of
PATH
paths to list; patterns are supported
@ -167,6 +167,7 @@ Keys for listing archive files:
- sha256
- sha384
- sha512
- xxh64: XXH64 checksum of this file (note: this is NOT a cryptographic hash!)
- archiveid
- archivename

4
docs/usage/mount.rst.inc
View file

@ -15,7 +15,7 @@ borg mount
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``REPOSITORY_OR_ARCHIVE`` | repository/archive to mount |
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to mount |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``MOUNTPOINT`` | where to mount filesystem |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -67,7 +67,7 @@ borg mount
.. only:: latex
REPOSITORY_OR_ARCHIVE
repository/archive to mount
repository or archive to mount
MOUNTPOINT
where to mount filesystem
PATH

4
docs/usage/recreate.rst.inc
View file

@ -15,7 +15,7 @@ borg recreate
+-------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** |
+-------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``REPOSITORY_OR_ARCHIVE`` | repository/archive to recreate |
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to recreate |
+-------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``PATH`` | paths to recreate; patterns are supported |
+-------------------------------------------------------+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -77,7 +77,7 @@ borg recreate
.. only:: latex
REPOSITORY_OR_ARCHIVE
repository/archive to recreate
repository or archive to recreate
PATH
paths to recreate; patterns are supported

2
docs/usage/upgrade.rst.inc
View file

@ -126,7 +126,7 @@ due to the cache resync.
Upgrade should be able to resume if interrupted, although it
will still iterate over all segments. If you want to start
from scratch, use `borg delete` over the copied repository to
make sure the cache files are also removed:
make sure the cache files are also removed::
borg delete borg