borg/docs/usage/upgrade.rst.inc

71 lines
2.9 KiB
PHP
Raw Normal View History

.. _borg_upgrade:
borg upgrade
------------
::
2015-12-08 09:21:20 +00:00
usage: borg upgrade [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
2016-01-23 19:54:20 +00:00
[--no-files-cache] [--umask M] [--remote-path PATH] [-p]
[-n] [-i]
[REPOSITORY]
upgrade a repository from a previous version
positional arguments:
2015-12-08 09:21:20 +00:00
REPOSITORY path to the repository to be upgraded
optional arguments:
2015-12-08 09:21:20 +00:00
-h, --help show this help message and exit
-v, --verbose, --info
enable informative (verbose) output, work on log level
INFO
--debug enable debug output, work on log level DEBUG
--lock-wait N wait for the lock, but max. N seconds (default: 1).
--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: 0077)
--remote-path PATH set remote path to executable (default: "borg")
2016-01-23 19:54:20 +00:00
-p, --progress show progress display while upgrading the repository
2015-12-08 09:21:20 +00:00
-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
~~~~~~~~~~~
2016-01-23 19:54:20 +00:00
Upgrade an existing Borg repository. This currently
only supports converting an Attic repository, but may
eventually be extended to cover major Borg upgrades as well.
2016-01-23 19:54:20 +00:00
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.
2016-01-23 19:54:20 +00:00
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.
2016-01-23 19:54:20 +00:00
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
2016-01-23 19:54:20 +00:00
Unless ``--inplace`` is specified, the upgrade process first
creates a backup copy of the repository, in
2016-01-23 19:54:20 +00:00
REPOSITORY.upgrade-DATETIME, using hardlinks. This takes
longer than in place upgrades, but is much safer and gives
2016-01-23 19:54:20 +00:00
progress information (as opposed to ``cp -al``). Once you are
satisfied with the conversion, you can safely destroy the
backup copy.
2016-01-23 19:54:20 +00:00
WARNING: Running the upgrade in place will make the current
copy unusable with older version, with no way of going back
2016-01-23 19:54:20 +00:00
to previous versions. This can PERMANENTLY DAMAGE YOUR
REPOSITORY! Attic CAN NOT READ BORG REPOSITORIES, as the
2016-01-23 19:54:20 +00:00
magic strings have changed. You have been warned.