summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorStephen Dolan <mu@netsoc.tcd.ie>2013-05-06 14:21:00 +0100
committerStephen Dolan <mu@netsoc.tcd.ie>2013-05-06 14:21:00 +0100
commit5be97463ecd4f93fdfbaec457d9100beeb9dc603 (patch)
treec60380d11fa33623ceb683189b12bf411bd24244 /docs
parent48be23233ad63bf1bd218c259efedff3e52106c5 (diff)
Add a --arg option to allow variables to be passed from the cmdline.
Closes #107
Diffstat (limited to 'docs')
-rw-r--r--docs/content/3.manual/manual.yml6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml
index 7b490659..c85fcd57 100644
--- a/docs/content/3.manual/manual.yml
+++ b/docs/content/3.manual/manual.yml
@@ -121,6 +121,12 @@ sections:
formatted as a JSON string with quotes. This can be useful for
making jq filters talk to non-JSON-based systems.
+ * `--arg name value`:
+
+ This option passes a value to the jq program as a predefined
+ variable. If you run jq with `--arg foo bar`, then `$foo` is
+ available in the program and has the value `"bar"`.
+
- title: Basic filters
entries:
- title: "`.`"