git-annex/doc/git-annex-migrate.mdwn
Joey Hess b184fc490a
split out common options to its own page and mention it on each subcommand page
Sometimes users would get confused because an option they were looking
for was not mentioned on a subcommand's man page, and they had not
noticed that the main git-annex man page had a list of common options.
This change lets each subcommand mention the common options, similarly
to how the matching options are handled.

This commit was sponsored by Svenne Krap on Patreon.
2021-05-10 15:00:13 -04:00

52 lines
1.2 KiB
Markdown

# NAME
git-annex migrate - switch data to different backend
# SYNOPSIS
git annex migrate `[path ...]`
# DESCRIPTION
Changes the specified annexed files to use the default key-value backend
(or the one specified with `--backend`). Only files whose content
is currently available are migrated.
Note that the content is also still available using the old key after
migration. Use `git annex unused` to find and remove the old key.
Normally, nothing will be done to files already using the new backend.
However, if a backend changes the information it uses to construct a key,
this can also be used to migrate files to use the new key format.
When you have multiple repositories that each contain a copy of a file,
it's best to run migrate in all of them.
# OPTIONS
* `--backend`
Specify the new key-value backend to use for migrated data.
* `--force`
Force migration of keys that are already using the new backend.
* file matching options
The [[git-annex-matching-options]](1)
can be used to specify files to migrate.
* Also the [[git-annex-common-options]](1) can be used.
# SEE ALSO
[[git-annex]](1)
[[git-annex-upgrade]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.