summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorStephen Dolan <mu@netsoc.tcd.ie>2012-12-16 19:46:41 +0000
committerStephen Dolan <mu@netsoc.tcd.ie>2012-12-16 19:46:41 +0000
commit75421cbfe32ae6428fe08b6ba83f1f7ac0322c33 (patch)
treecff235884bdcbb039ec19760ba07859644e2edd3 /docs
parentb0aa62f2b77b2b97fca3e75030156455381d0df3 (diff)
Add the ability to specify input files on the commandline.
See #21.
Diffstat (limited to 'docs')
-rw-r--r--docs/content/3.manual/manual.yml6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml
index 6e8065c6..5acb212c 100644
--- a/docs/content/3.manual/manual.yml
+++ b/docs/content/3.manual/manual.yml
@@ -33,12 +33,16 @@ manpage_intro: |
## SYNOPSIS
- `jq` [<options>...] <filter>
+ `jq` [<options>...] <filter> [<files>...]
`jq` can transform JSON in various ways, by selecting, iterating,
reducing and otherwise mangling JSON documents. For instance,
running the command `jq 'map(.price) | add'` will take an array of
JSON objects as input and return the sum of their "price" fields.
+
+ By default, `jq` reads a stream of JSON objects (whitespace
+ separated) from `stdin`. One or more <files> may be specified, in
+ which case `jq` will read input from those instead.
The <options> are described in the [INVOKING JQ] section, they
mostly concern input and output formatting. The <filter> is written