summaryrefslogtreecommitdiff
path: root/doc/git-annex-migrate.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
committerJoey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
commit0b029570a78f0324715a81ee986212d922fc9159 (patch)
tree7b1a80fe3bfd2d2d5794df2ff8d360e27e3f5639 /doc/git-annex-migrate.mdwn
parentc955fb2736ff1fc50c710104706a64996fffb85e (diff)
finished splitting out man pages for all commands
Diffstat (limited to 'doc/git-annex-migrate.mdwn')
-rw-r--r--doc/git-annex-migrate.mdwn48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/git-annex-migrate.mdwn b/doc/git-annex-migrate.mdwn
new file mode 100644
index 0000000000..b6e5f9f77a
--- /dev/null
+++ b/doc/git-annex-migrate.mdwn
@@ -0,0 +1,48 @@
+# 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.
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.