| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 |
- .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
- .. _borg_upgrade:
- borg upgrade
- ------------
- ::
- borg upgrade <options> REPOSITORY
- positional arguments
- REPOSITORY
- path to the repository to be upgraded
- optional arguments
- ``-p``, ``--progress``
- | show progress display while upgrading the repository
- ``-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.
- `Common options`_
- |
- Description
- ~~~~~~~~~~~
- Upgrade an existing Borg repository.
- This currently supports converting an Attic repository to Borg and also
- helps with converting Borg 0.xx to 1.0.
- Currently, only LOCAL repositories can be upgraded (issue #465).
- 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 ~/.config/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.
|
