path: root/README
diff options
authorJohn MacFarlane <>2013-09-19 21:04:58 -0700
committerJohn MacFarlane <>2013-09-19 21:04:58 -0700
commitdf313b859f19857a9773627d60bf2e6c8d6ba9b3 (patch)
tree5e9730bdbb21b5b5d98d16499ad5a7f14dd44c18 /README
parent87def47e87d7d8ba20dabc323e7b91a424b95406 (diff)
Added small explanation of difference btw `-M` and `-V`.
Diffstat (limited to 'README')
1 files changed, 5 insertions, 1 deletions
diff --git a/README b/README
index 6c9c9d3ed..ba1f93661 100644
--- a/README
+++ b/README
@@ -289,7 +289,11 @@ Reader options
: Set the metadata field *KEY* to the value *VAL*. A value specified
on the command line overrides a value specified in the document.
Values will be parsed as YAML boolean or string values. If no value is
- specified, the value will be treated as Boolean true.
+ specified, the value will be treated as Boolean true. Like
+ `--variable`, `--metadata` causes template variables to be set.
+ But unlike `--variable`, `--metadata` affects the metadata of the
+ underlying document (which is accessible from filters and may be
+ printed in some output formats).
: Normalize the document after reading: merge adjacent