summaryrefslogtreecommitdiff
path: root/doc/git-annex.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-02-12 21:12:22 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-02-12 21:30:33 -0400
commitcb0dad5172b743679d90c7fd6e490d4927ea5a76 (patch)
tree0f487cc027688a9e47749c9030099ed877e467a2 /doc/git-annex.mdwn
parent41e5f8dfe79d6db8b0bd1492d8f28caf6b24ef5f (diff)
add metadata command to get/set metadata
Adds metadata log, and command. Note that unsetting field values seems to currently be broken. And in general this has had all of 2 minutes worth of testing. This commit was sponsored by Julien Lefrique.
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 4e672f608..17d78c555 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -695,6 +695,23 @@ subdirectories).
# UTILITY COMMANDS
+* `metadata file [field=value field+=value field-=value ...]`
+
+ Each file can have any number of metadata fields attached to it,
+ which each in turn have any number of values. This sets metadata
+ for a file, or if run without any values, shows its current metadata.
+
+ To set a field's value, removing any old value(s), use field=value.
+
+ To add an additional value, use field+=value.
+
+ To remove a value, use field-=value.
+
+ For example, to set some tags on a file:
+
+ git annex metadata annexscreencast.ogv tag+=video tag+=screencast
+
+
* `migrate [path ...]`
Changes the specified annexed files to use the default key-value backend