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

commit usage files directly into git 

the generation of those files was causing us way too much pain to
justify automatically generating them all the time.

those will have to be re-generated with `build_api` or `build_usage`
as appropriate, for example when function signatures or commandline
flags change.

see #384
This commit is contained in:
Antoine Beaupré 2015-11-13 10:42:16 -05:00
parent f13dd6e579
commit 8e36075fe9
20 changed files with 803 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -15,8 +15,6 @@ platform_linux.c
*.pyc
*.pyo
*.so
docs/usage/*.inc
docs/api.rst
.idea/
.cache/
borg/_version.py

87
docs/api.rst Normal file
View File

@ -0,0 +1,87 @@
API Documentation
=================
.. automodule:: borg.key
:members:
:undoc-members:
.. automodule:: borg.cache
:members:
:undoc-members:
.. automodule:: borg.locking
:members:
:undoc-members:
.. automodule:: borg.platform
:members:
:undoc-members:
.. automodule:: borg.xattr
:members:
:undoc-members:
.. automodule:: borg.fuse
:members:
:undoc-members:
.. automodule:: borg.logger
:members:
:undoc-members:
.. automodule:: borg.repository
:members:
:undoc-members:
.. automodule:: borg.archiver
:members:
:undoc-members:
.. automodule:: borg.archive
:members:
:undoc-members:
.. automodule:: borg.lrucache
:members:
:undoc-members:
.. automodule:: borg.remote
:members:
:undoc-members:
.. automodule:: borg.upgrader
:members:
:undoc-members:
.. automodule:: borg.helpers
:members:
:undoc-members:
.. automodule:: borg.platform_freebsd
:members:
:undoc-members:
.. automodule:: borg.hashindex
:members:
:undoc-members:
.. automodule:: borg.chunker
:members:
:undoc-members:
.. automodule:: borg.platform_darwin
:members:
:undoc-members:
.. automodule:: borg.platform_linux
:members:
:undoc-members:
.. automodule:: borg.compress
:members:
:undoc-members:
.. automodule:: borg.crypto
:members:
:undoc-members:

29
docs/usage/change-passphrase.rst.inc Normal file
View File

@ -0,0 +1,29 @@
.. _borg_change-passphrase:
borg change-passphrase
----------------------
::
usage: borg change-passphrase [-h] [-v] [--show-rc] [--no-files-cache]
[--umask M] [--remote-path PATH]
[REPOSITORY]
Change repository key file passphrase
positional arguments:
REPOSITORY
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
Description
~~~~~~~~~~~
The key files used for repository encryption are optionally passphrase
protected. This command can be used to change this passphrase.

67
docs/usage/check.rst.inc Normal file
View File

@ -0,0 +1,67 @@
.. _borg_check:
borg check
----------
::
usage: borg check [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [--repository-only] [--archives-only]
[--repair] [--last N]
[REPOSITORY_OR_ARCHIVE]
Check repository consistency
positional arguments:
REPOSITORY_OR_ARCHIVE
repository or archive to check consistency of
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
--repository-only only perform repository checks
--archives-only only perform archives checks
--repair attempt to repair any inconsistencies found
--last N only check last N archives (Default: all)
Description
~~~~~~~~~~~
The check command verifies the consistency of a repository and the corresponding archives.
First, the underlying repository data files are checked:
- For all segments the segment magic (header) is checked
- For all objects stored in the segments, all metadata (e.g. crc and size) and
all data is read. The read data is checked by size and CRC. Bit rot and other
types of accidental damage can be detected this way.
- If we are in repair mode and a integrity error is detected for a segment,
we try to recover as many objects from the segment as possible.
- In repair mode, it makes sure that the index is consistent with the data
stored in the segments.
- If you use a remote repo server via ssh:, the repo check is executed on the
repo server without causing significant network traffic.
- The repository check can be skipped using the --archives-only option.
Second, the consistency and correctness of the archive metadata is verified:
- Is the repo manifest present? If not, it is rebuilt from archive metadata
chunks (this requires reading and decrypting of all metadata and data).
- Check if archive metadata chunk is present. if not, remove archive from
manifest.
- For all files (items) in the archive, for all chunks referenced by these
files, check if chunk is present (if not and we are in repair mode, replace
it with a same-size chunk of zeros). This requires reading of archive and
file metadata, but not data.
- If we are in repair mode and we checked all the archives: delete orphaned
chunks from the repo.
- if you use a remote repo server via ssh:, the archive check is executed on
the client machine (because if encryption is enabled, the checks will require
decryption and this is always done client-side, because key access will be
required).
- The archive checks can be time consuming, they can be skipped using the
--repository-only option.

73
docs/usage/create.rst.inc Normal file
View File

@ -0,0 +1,73 @@
.. _borg_create:
borg create
-----------
::
usage: borg create [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-s] [-p] [-e PATTERN]
[--exclude-from EXCLUDEFILE] [--exclude-caches]
[--exclude-if-present FILENAME] [--keep-tag-files]
[-c SECONDS] [-x] [--numeric-owner]
[--timestamp yyyy-mm-ddThh:mm:ss]
[--chunker-params CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,HASH_WINDOW_SIZE]
[-C COMPRESSION] [--read-special] [-n]
ARCHIVE PATH [PATH ...]
Create new archive
positional arguments:
ARCHIVE name of archive to create (must be also a valid
directory name)
PATH paths to archive
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
-s, --stats print statistics for the created archive
-p, --progress toggle progress display while creating the archive,
showing Original, Compressed and Deduplicated sizes,
followed by the Number of files seen and the path
being processed, default: True
-e PATTERN, --exclude PATTERN
exclude paths matching PATTERN
--exclude-from EXCLUDEFILE
read exclude patterns from EXCLUDEFILE, one per line
--exclude-caches exclude directories that contain a CACHEDIR.TAG file
(http://www.brynosaurus.com/cachedir/spec.html)
--exclude-if-present FILENAME
exclude directories that contain the specified file
--keep-tag-files keep tag files of excluded caches/directories
-c SECONDS, --checkpoint-interval SECONDS
write checkpoint every SECONDS seconds (Default: 300)
-x, --one-file-system
stay in same file system, do not cross mount points
--numeric-owner only store numeric user and group identifiers
--timestamp yyyy-mm-ddThh:mm:ss
manually specify the archive creation date/time (UTC).
alternatively, give a reference file/directory.
--chunker-params CHUNK_MIN_EXP,CHUNK_MAX_EXP,HASH_MASK_BITS,HASH_WINDOW_SIZE
specify the chunker parameters. default: 10,23,16,4095
-C COMPRESSION, --compression COMPRESSION
select compression algorithm (and level): none == no
compression (default), lz4 == lz4, zlib == zlib
(default level 6), zlib,0 .. zlib,9 == zlib (with
level 0..9), lzma == lzma (default level 6), lzma,0 ..
lzma,9 == lzma (with level 0..9).
--read-special open and read special files as if they were regular
files
-n, --dry-run do not create a backup archive
Description
~~~~~~~~~~~
This command creates a backup archive containing all files found while recursively
traversing all paths specified. The archive will consume almost no disk space for
files or parts of files that have already been stored in other archives.
See the output of the "borg help patterns" command for more help on exclude patterns.

29
docs/usage/debug-delete-obj.rst.inc Normal file
View File

@ -0,0 +1,29 @@
.. _borg_debug-delete-obj:
borg debug-delete-obj
---------------------
::
usage: borg debug-delete-obj [-h] [-v] [--show-rc] [--no-files-cache]
[--umask M] [--remote-path PATH]
[REPOSITORY] IDs [IDs ...]
delete the objects with the given IDs from the repo
positional arguments:
REPOSITORY repository to use
IDs hex object ID(s) to delete from the repo
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
Description
~~~~~~~~~~~
This command deletes objects from the repository.

28
docs/usage/debug-dump-archive-items.rst.inc Normal file
View File

@ -0,0 +1,28 @@
.. _borg_debug-dump-archive-items:
borg debug-dump-archive-items
-----------------------------
::
usage: borg debug-dump-archive-items [-h] [-v] [--show-rc] [--no-files-cache]
[--umask M] [--remote-path PATH]
ARCHIVE
dump (decrypted, decompressed) archive items metadata (not: data)
positional arguments:
ARCHIVE archive to dump
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
Description
~~~~~~~~~~~
This command dumps raw (but decrypted and decompressed) archive items (only metadata) to files.

30
docs/usage/debug-get-obj.rst.inc Normal file
View File

@ -0,0 +1,30 @@
.. _borg_debug-get-obj:
borg debug-get-obj
------------------
::
usage: borg debug-get-obj [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH]
[REPOSITORY] ID PATH
get object contents from the repository and write it into file
positional arguments:
REPOSITORY repository to use
ID hex object ID to get from the repo
PATH file to write object data into
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
Description
~~~~~~~~~~~
This command gets an object from the repository.

29
docs/usage/debug-put-obj.rst.inc Normal file
View File

@ -0,0 +1,29 @@
.. _borg_debug-put-obj:
borg debug-put-obj
------------------
::
usage: borg debug-put-obj [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH]
[REPOSITORY] PATH [PATH ...]
put file(s) contents into the repository
positional arguments:
REPOSITORY repository to use
PATH file(s) to read and create object(s) from
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
Description
~~~~~~~~~~~
This command puts objects into the repository.

32
docs/usage/delete.rst.inc Normal file
View File

@ -0,0 +1,32 @@
.. _borg_delete:
borg delete
-----------
::
usage: borg delete [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-s] [-c]
[TARGET]
Delete an existing repository or archive
positional arguments:
TARGET archive or repository to delete
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
-s, --stats print statistics for the deleted archive
-c, --cache-only delete only the local cache for the given repository
Description
~~~~~~~~~~~
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.

49
docs/usage/extract.rst.inc Normal file
View File

@ -0,0 +1,49 @@
.. _borg_extract:
borg extract
------------
::
usage: borg extract [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-n] [-e PATTERN]
[--exclude-from EXCLUDEFILE] [--numeric-owner]
[--strip-components NUMBER] [--stdout] [--sparse]
ARCHIVE [PATH [PATH ...]]
Extract archive contents
positional arguments:
ARCHIVE archive to extract
PATH paths to extract
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
-n, --dry-run do not actually change any files
-e PATTERN, --exclude PATTERN
exclude paths matching PATTERN
--exclude-from EXCLUDEFILE
read exclude patterns from EXCLUDEFILE, one per line
--numeric-owner only obey numeric user and group identifiers
--strip-components NUMBER
Remove the specified number of leading path elements.
Pathnames with fewer elements will be silently
skipped.
--stdout write all extracted data to stdout
--sparse create holes in output sparse file from all-zero
chunks
Description
~~~~~~~~~~~
This command extracts the contents of an archive. By default the entire
archive is extracted but a subset of files and directories can be selected
by passing a list of ``PATHs`` as arguments. The file selection can further
be restricted by using the ``--exclude`` option.
See the output of the "borg help patterns" command for more help on exclude patterns.

34
docs/usage/help.rst.inc Normal file
View File

@ -0,0 +1,34 @@
.. _borg_patterns:
borg help patterns
~~~~~~~~~~~~~~~~~~
::
Exclude patterns use a variant of shell pattern syntax, with '*' matching any
number of characters, '?' matching any single character, '[...]' matching any
single character specified, including ranges, and '[!...]' matching any
character not specified. For the purpose of these patterns, the path
separator ('\' for Windows and '/' on other systems) is not treated
specially. For a path to match a pattern, it must completely match from
start to end, or must match from the start to just before a path separator.
Except for the root path, paths will never end in the path separator when
matching is attempted. Thus, if a given pattern ends in a path separator, a
'*' is appended before matching is attempted. Patterns with wildcards should
be quoted to protect them from shell expansion.
Examples:
# Exclude '/home/user/file.o' but not '/home/user/file.odt':
$ borg create -e '*.o' backup /
# Exclude '/home/user/junk' and '/home/user/subdir/junk' but
# not '/home/user/importantjunk' or '/etc/junk':
$ borg create -e '/home/*/junk' backup /
# Exclude the contents of '/home/user/cache' but not the directory itself:
$ borg create -e /home/user/cache/ backup /
# The file '/home/user/cache/important' is *not* backed up:
$ borg create -e /home/user/cache/ backup / /home/user/cache/important

28
docs/usage/info.rst.inc Normal file
View File

@ -0,0 +1,28 @@
.. _borg_info:
borg info
---------
::
usage: borg info [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH]
ARCHIVE
Show archive details such as disk space used
positional arguments:
ARCHIVE archive to display information about
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
Description
~~~~~~~~~~~
This command displays some detailed information about the specified archive.

34
docs/usage/init.rst.inc Normal file
View File

@ -0,0 +1,34 @@
.. _borg_init:
borg init
---------
::
usage: borg init [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-e {none,keyfile,repokey,passphrase}]
[REPOSITORY]
Initialize an empty repository
positional arguments:
REPOSITORY repository to create
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
-e {none,keyfile,repokey,passphrase}, --encryption {none,keyfile,repokey,passphrase}
select encryption key mode
Description
~~~~~~~~~~~
This command initializes an empty repository. A repository is a filesystem
directory containing the deduplicated data from zero or more archives.
Encryption can be enabled at repository init time.
Please note that the 'passphrase' encryption mode is DEPRECATED (instead of it,
consider using 'repokey').

32
docs/usage/list.rst.inc Normal file
View File

@ -0,0 +1,32 @@
.. _borg_list:
borg list
---------
::
usage: borg list [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [--short] [-p PREFIX]
[REPOSITORY_OR_ARCHIVE]
List archive or repository contents
positional arguments:
REPOSITORY_OR_ARCHIVE
repository/archive to list contents of
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
--short only print file/directory names, nothing else
-p PREFIX, --prefix PREFIX
only consider archive names starting with this prefix
Description
~~~~~~~~~~~
This command lists the contents of a repository or an archive.

35
docs/usage/mount.rst.inc Normal file
View File

@ -0,0 +1,35 @@
.. _borg_mount:
borg mount
----------
::
usage: borg mount [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-f] [-o OPTIONS]
REPOSITORY_OR_ARCHIVE MOUNTPOINT
Mount archive or an entire repository as a FUSE fileystem
positional arguments:
REPOSITORY_OR_ARCHIVE
repository/archive to mount
MOUNTPOINT where to mount filesystem
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
-f, --foreground stay in foreground, do not daemonize
-o OPTIONS Extra mount options
Description
~~~~~~~~~~~
This command mounts an archive as a FUSE filesystem. This can be useful for
browsing an archive or restoring individual files. Unless the ``--foreground``
option is given the command will run in the background until the filesystem
is ``umounted``.

66
docs/usage/prune.rst.inc Normal file
View File

@ -0,0 +1,66 @@
.. _borg_prune:
borg prune
----------
::
usage: borg prune [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-n] [-s] [--keep-within WITHIN]
[-H HOURLY] [-d DAILY] [-w WEEKLY] [-m MONTHLY] [-y YEARLY]
[-p PREFIX]
[REPOSITORY]
Prune repository archives according to specified rules
positional arguments:
REPOSITORY repository to prune
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
-n, --dry-run do not change repository
-s, --stats print statistics for the deleted archive
--keep-within WITHIN keep all archives within this time interval
-H HOURLY, --keep-hourly HOURLY
number of hourly archives to keep
-d DAILY, --keep-daily DAILY
number of daily archives to keep
-w WEEKLY, --keep-weekly WEEKLY
number of weekly archives to keep
-m MONTHLY, --keep-monthly MONTHLY
number of monthly archives to keep
-y YEARLY, --keep-yearly YEARLY
number of yearly archives to keep
-p PREFIX, --prefix PREFIX
only consider archive names starting with this prefix
Description
~~~~~~~~~~~
The prune command prunes a repository by deleting archives not matching
any of the specified retention options. This command is normally used by
automated backup scripts wanting to keep a certain number of historic backups.
As an example, "-d 7" means to keep the latest backup on each day for 7 days.
Days without backups do not count towards the total.
The rules are applied from hourly to yearly, and backups selected by previous
rules do not count towards those of later rules. The time that each backup
completes is used for pruning purposes. Dates and times are interpreted in
the local timezone, and weeks go from Monday to Sunday. Specifying a
negative number of archives to keep means that there is no limit.
The "--keep-within" option takes an argument of the form "<int><char>",
where char is "H", "d", "w", "m", "y". For example, "--keep-within 2d" means
to keep all archives that were created within the past 48 hours.
"1m" is taken to mean "31d". The archives kept with this option do not
count towards the totals specified by any other options.
If a prefix is set with -p, then only archives that start with the prefix are
considered for deletion and only those archives count towards the totals
specified by the rules.
Otherwise, *all* archives in the repository are candidates for deletion!

29
docs/usage/rename.rst.inc Normal file
View File

@ -0,0 +1,29 @@
.. _borg_rename:
borg rename
-----------
::
usage: borg rename [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH]
ARCHIVE NEWNAME
Rename an existing archive
positional arguments:
ARCHIVE archive to rename
NEWNAME the new archive name to use
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
Description
~~~~~~~~~~~
This command renames an archive in the repository.

27
docs/usage/serve.rst.inc Normal file
View File

@ -0,0 +1,27 @@
.. _borg_serve:
borg serve
----------
::
usage: borg serve [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [--restrict-to-path PATH]
Start in server mode. This command is usually not used manually.
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
--restrict-to-path PATH
restrict repository access to PATH
Description
~~~~~~~~~~~
This command starts a repository server process. This command is usually not used manually.

65
docs/usage/upgrade.rst.inc Normal file
View File

@ -0,0 +1,65 @@
.. _borg_upgrade:
borg upgrade
------------
::
usage: borg upgrade [-h] [-v] [--show-rc] [--no-files-cache] [--umask M]
[--remote-path PATH] [-n] [-i]
[REPOSITORY]
upgrade a repository from a previous version
positional arguments:
REPOSITORY path to the repository to be upgraded
optional arguments:
-h, --help show this help message and exit
-v, --verbose verbose output
--show-rc show/log the return code (rc)
--no-files-cache do not load/update the file metadata cache used to
detect unchanged files
--umask M set umask to M (local and remote, default: 63)
--remote-path PATH set remote path to executable (default: "borg")
-n, --dry-run do not change repository
-i, --inplace rewrite repository in place, with no chance of going
back to older versions of the repository.
Description
~~~~~~~~~~~
upgrade an existing Borg repository. this currently
only support converting an Attic repository, but may
eventually be extended to cover major Borg upgrades as well.
it will change the magic strings in the repository's 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 ~/.borg/keys.
the cache files are converted, from $ATTIC_CACHE_DIR or
~/.cache/attic to $BORG_CACHE_DIR or ~/.cache/borg, but the
cache layout between Borg and Attic changed, so it is possible
the first backup after the conversion takes longer than expected
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:
borg delete borg
unless ``--inplace`` is specified, the upgrade process first
creates a backup copy of the repository, in
REPOSITORY.upgrade-DATETIME, using hardlinks. this takes
longer than in place upgrades, but is much safer and gives
progress information (as opposed to ``cp -al``). once you are
satisfied with the conversion, you can safely destroy the
backup copy.
WARNING: running the upgrade in place will make the current
copy unusable with older version, with no way of going back
to previous versions. this can PERMANENTLY DAMAGE YOUR
REPOSITORY! Attic CAN NOT READ BORG REPOSITORIES, as the
magic strings have changed. you have been warned.