aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-metadata.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2015-03-25 12:09:49 -0400
commitf77d5bcc56a4692f321896dedab75c6ec32f967a (patch)
treeb57bf5d62fe1651502917f13d093ce9b4d79a6c3 /doc/git-annex-metadata.mdwn
parent00c09b2038611de97c26f4141a748f08cc8fe570 (diff)
finished splitting out man pages for all commands
Diffstat (limited to 'doc/git-annex-metadata.mdwn')
-rw-r--r--doc/git-annex-metadata.mdwn83
1 files changed, 83 insertions, 0 deletions
diff --git a/doc/git-annex-metadata.mdwn b/doc/git-annex-metadata.mdwn
new file mode 100644
index 000000000..7d613456b
--- /dev/null
+++ b/doc/git-annex-metadata.mdwn
@@ -0,0 +1,83 @@
+# NAME
+
+git-annex metadata - sets or gets metadata of a file
+
+# SYNOPSIS
+
+git annex metadata `[path ...]`
+
+# DESCRIPTION
+
+The content of an annexed file can have any number of metadata fields
+attached to it to describe it. Each metadata field can in turn
+have any number of values.
+
+This command can be used to set metadata, or show the currently set
+metadata.
+
+When run without any -s or -t parameters, displays the current metadata.
+
+# OPTIONS
+
+* `-g field`
+
+ Get the value(s) of a single field.
+
+ The values will be output one per line, with no other output, so
+ this is suitable for use in a script.
+
+* `-s field=value`
+
+ Set a field's value, removing any old values.
+
+* `-s field+=value`
+
+ Add an additional value, preserving any old values.
+
+* `-s field-=value`
+
+ Remove a value.
+
+* `-s field?=value`
+
+ Set a value, but only if the field does not already have a value set.
+
+* `-t tag`
+
+ Set a tag. Note that a tag is just a value of the "tag" field.
+
+* `-u tag`
+
+ Unset a tag.
+
+* `--force`
+
+ By default, `git annex metadata` refuses to recursively set metadata
+ throughout the files in a directory. This option enables such recursive
+ setting.
+
+* file matching options
+
+ The [[git-annex-matching-options]](1)
+ can be used to specify files to act on.
+
+* `--json`
+
+ Enable JSON output. This is intended to be parsed by programs that use
+ git-annex. Each line of output is a JSON object.
+
+# EXAMPLES
+
+To set some tags on a file and also its author:
+
+ git annex metadata annexscreencast.ogv -t video -t screencast -s author+=Alice
+
+# SEE ALSO
+
+[[git-annex]](1)
+
+# AUTHOR
+
+Joey Hess <id@joeyh.name>
+
+Warning: Automatically converted into a man page by mdwn2man. Edit with care.