path: root/README
diff options
authorJohn MacFarlane <>2013-09-01 16:22:40 -0700
committerJohn MacFarlane <>2013-09-01 16:22:40 -0700
commit8977b2aaed096a71e669e1161f6ce10d5286f34e (patch)
tree2abf2d18cfead0314fe243ec4653d10006f4b6f8 /README
parent1240edbc3b4f716c58fc3dfe9fc277c45b8529ab (diff)
Changed --metadata to return Boolean True if no value.
Also documented in README.
Diffstat (limited to 'README')
1 files changed, 6 insertions, 0 deletions
diff --git a/README b/README
index 7b75565c1..236637d10 100644
--- a/README
+++ b/README
@@ -284,6 +284,12 @@ Reader options
if no directory is provided. If you want to run a script in the
working directory, preface the filename with `./`.
+`-M` *KEY[=VAL]*, `--metadata=`*KEY[:VAL]*
+: Set the metadata field *KEY* to the value *VAL* after
+ parsing. A value specified on the command line overrides a value
+ specified in the document. Values will be interpreted as raw strings.
+ If no value is specified, the value will be treated as Boolean true.
: Normalize the document after reading: merge adjacent
`Str` or `Emph` elements, for example, and remove repeated `Space`s.