summaryrefslogtreecommitdiffstats
path: root/jq.1.prebuilt
diff options
context:
space:
mode:
authorNicolas Williams <nico@cryptonector.com>2017-02-25 19:21:06 -0600
committerNicolas Williams <nico@cryptonector.com>2017-02-25 19:21:06 -0600
commitef8701005969fb9ed44c3bf746b1b6f72babffb9 (patch)
tree76afde4b7f02ec94dade609f26c3ac782bfd2422 /jq.1.prebuilt
parent66fb962a6608805f4d7667d39ad0d88158bd1262 (diff)
Document $ARGS and friends
Diffstat (limited to 'jq.1.prebuilt')
-rw-r--r--jq.1.prebuilt15
1 files changed, 15 insertions, 0 deletions
diff --git a/jq.1.prebuilt b/jq.1.prebuilt
index e07a1428..c4d25ea7 100644
--- a/jq.1.prebuilt
+++ b/jq.1.prebuilt
@@ -159,6 +159,9 @@ Sets the exit status of jq to 0 if the last output values was neither \fBfalse\f
.IP
This option passes a value to the jq program as a predefined variable\. If you run jq with \fB\-\-arg foo bar\fR, then \fB$foo\fR is available in the program and has the value \fB"bar"\fR\. Note that \fBvalue\fR will be treated as a string, so \fB\-\-arg foo 123\fR will bind \fB$foo\fR to \fB"123"\fR\.
.
+.IP
+Named arguments are also available to the jq program as \fB$ARGS\.named\fR\.
+.
.IP "\(bu" 4
\fB\-\-argjson name JSON\-text\fR:
.
@@ -181,6 +184,18 @@ Do not use\. Use \fB\-\-slurpfile\fR instead\.
(This option is like \fB\-\-slurpfile\fR, but when the file has just one text, then that is used, else an array of texts is used as in \fB\-\-slurpfile\fR\.)
.
.IP "\(bu" 4
+\fB\-\-args\fR:
+.
+.IP
+Remaining arguments are positional string arguments\. These are available to the jq program as \fB$ARGS\.positional[]\fR\.
+.
+.IP "\(bu" 4
+\fB\-\-jsonargs\fR:
+.
+.IP
+Remaining arguments are positional JSON text arguments\. These are available to the jq program as \fB$ARGS\.positional[]\fR\.
+.
+.IP "\(bu" 4
\fB\-\-run\-tests [filename]\fR:
.
.IP