mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-01-01 04:37:34 +00:00
Code Issues Releases Wiki Activity

Merge pull request #3888 from borgbackup/rel116

Browse source 
release 1.1.6
This commit is contained in:
TW 2018-06-11 13:07:59 +02:00 committed by GitHub
commit e619f373d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
36 changed files with 67 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
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.1.6 (not released yet)
--------------------------------
Version 1.1.6 (2018-06-11)
--------------------------
Compatibility notes:

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-BENCHMARK-CRUD 1 "2018-03-29" "" "borg backup tool"
.TH BORG-BENCHMARK-CRUD 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-BENCHMARK 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-BREAK-LOCK 1 "2018-06-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-change-passphrase.1
View file

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-CHANGE-PASSPHRASE 1 "2018-03-29" "" "borg backup tool"
.TH BORG-CHANGE-PASSPHRASE 1 "2018-06-11" "" "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 "2018-03-29" "" "borg backup tool"
.TH BORG-CHECK 1 "2018-06-11" "" "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 "2018-03-29" "" "borg backup tool"
.TH BORG-COMMON 1 "2018-06-11" "" "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 "2018-03-29" "" "borg backup tool"
.TH BORG-COMPRESSION 1 "2018-06-11" "" "borg backup tool"
.SH NAME
borg-compression \- Details regarding compression
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-CONFIG 1 "2018-03-29" "" "borg backup tool"
.TH BORG-CONFIG 1 "2018-06-11" "" "borg backup tool"
.SH NAME
borg-config \- get, set, and delete values in a repository or cache config file
.
@ -32,16 +32,18 @@ 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.
For security reasons, this command only works on local repositories.
.sp
To delete a config value entirely, use \fB\-\-delete\fP\&. To get an existing key, pass
only the key name. To set a key, pass both the key name and the new value. Keys
can be specified in the format "section.name" or simply "name"; the section will
default to "repository" and "cache" for the repo and cache configs, respectively.
To delete a config value entirely, use \fB\-\-delete\fP\&. To list the values
of the configuration file or the default values, use \fB\-\-list\fP\&. To get and existing
key, pass only the key name. To set a key, pass both the key name and
the new value. Keys can be specified in the format "section.name" or
simply "name"; the section will default to "repository" and "cache" for
the repo and cache configs, respectively.
.sp
By default, borg config manipulates the repository config file. Using \fB\-\-cache\fP
edits the repository cache\(aqs config file instead.
@ -68,6 +70,9 @@ get and set values from the repo cache
.TP
.B \-d\fP,\fB \-\-delete
delete the key from the config file
.TP
.B \-l\fP,\fB \-\-list
list the configuration of the repo
.UNINDENT
.SH EXAMPLES
.sp

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

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

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DELETE 1 "2018-03-29" "" "borg backup tool"
.TH BORG-DELETE 1 "2018-06-11" "" "borg backup tool"
.SH NAME
borg-delete \- Delete an existing repository or archives
.
@ -58,6 +58,9 @@ archives to delete
.SS optional arguments
.INDENT 0.0
.TP
.B \-n\fP,\fB \-\-dry\-run
do not change repository
.TP
.B \-s\fP,\fB \-\-stats
print statistics for the deleted archive
.TP

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-DIFF 1 "2018-03-29" "" "borg backup tool"
.TH BORG-DIFF 1 "2018-06-11" "" "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 "2018-03-29" "" "borg backup tool"
.TH BORG-EXPORT-TAR 1 "2018-06-11" "" "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 "2018-03-29" "" "borg backup tool"
.TH BORG-EXTRACT 1 "2018-06-11" "" "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 "2018-03-29" "" "borg backup tool"
.TH BORG-INFO 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-INIT 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-KEY-EXPORT 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-KEY-IMPORT 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-KEY-MIGRATE-TO-REPOKEY 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-KEY 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-LIST 1 "2018-06-11" "" "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 "2018-03-29" "" "borg backup tool"
.TH BORG-MOUNT 1 "2018-06-11" "" "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 "2018-03-29" "" "borg backup tool"
.TH BORG-PATTERNS 1 "2018-06-11" "" "borg backup tool"
.SH NAME
borg-patterns \- Details regarding patterns
.

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

@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH BORG-PLACEHOLDERS 1 "2018-03-29" "" "borg backup tool"
.TH BORG-PLACEHOLDERS 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-PRUNE 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-RECREATE 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-RENAME 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-SERVE 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-UMOUNT 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-UPGRADE 1 "2018-06-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 "2018-03-29" "" "borg backup tool"
.TH BORG-WITH-LOCK 1 "2018-06-11" "" "borg backup tool"
.SH NAME
borg-with-lock \- run a user specified command with the repository lock held
.

4
docs/man/borg.1
View file

@ -498,6 +498,10 @@ will be linked against the system liblz4 instead of a bundled implementation. (s
.B BORG_LIBB2_PREFIX
Adds given prefix directory to the default locations. If a \(aqinclude/blake2.h\(aq is found Borg
will be linked against the system libb2 instead of a bundled implementation. (setup.py)
.TP
.B BORG_LIBZSTD_PREFIX
Adds given prefix directory to the default locations. If a \(aqinclude/zstd.h\(aq is found Borg
will be linked against the system libzstd instead of a bundled implementation. (setup.py)
.UNINDENT
.UNINDENT
.sp

2
docs/man/borgfs.1
View file

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

20
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
@ -27,6 +27,8 @@ borg config
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``-d``, ``--delete`` | delete the key from the config file |
+-------------------------------------------------------+----------------------+----------------------------------------+
| | ``-l``, ``--list`` | list the configuration of the repo |
+-------------------------------------------------------+----------------------+----------------------------------------+
| .. class:: borg-common-opt-ref |
| |
| :ref:`common_options` |
@ -51,8 +53,9 @@ borg config
optional arguments
-c, --cache get and set values from the repo cache
-d, --delete delete the key from the config file
-c, --cache get and set values from the repo cache
-d, --delete delete the key from the config file
-l, --list list the configuration of the repo
:ref:`common_options`
@ -64,10 +67,13 @@ Description
This command gets and sets options in a local repository or cache config file.
For security reasons, this command only works on local repositories.
To delete a config value entirely, use ``--delete``. To get an existing key, pass
only the key name. To set a key, pass both the key name and the new value. Keys
can be specified in the format "section.name" or simply "name"; the section will
default to "repository" and "cache" for the repo and cache configs, respectively.
To delete a config value entirely, use ``--delete``. To list the values
of the configuration file or the default values, use ``--list``. To get and existing
key, pass only the key name. To set a key, pass both the key name and
the new value. Keys can be specified in the format "section.name" or
simply "name"; the section will default to "repository" and "cache" for
the repo and cache configs, respectively.
By default, borg config manipulates the repository config file. Using ``--cache``
edits the repository cache's config file instead.

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

@ -21,6 +21,8 @@ borg delete
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| **optional arguments** |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``-n``, ``--dry-run`` | do not change repository |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``-s``, ``--stats`` | print statistics for the deleted archive |
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--cache-only`` | delete only the local cache for the given repository |
@ -63,6 +65,7 @@ borg delete
optional arguments
-n, --dry-run do not change repository
-s, --stats print statistics for the deleted archive
--cache-only delete only the local cache for the given repository
--force force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work.