diff options
author | Nicolas Williams <nico@cryptonector.com> | 2017-02-25 19:21:06 -0600 |
---|---|---|
committer | Nicolas Williams <nico@cryptonector.com> | 2017-02-25 19:21:06 -0600 |
commit | ef8701005969fb9ed44c3bf746b1b6f72babffb9 (patch) | |
tree | 76afde4b7f02ec94dade609f26c3ac782bfd2422 /docs | |
parent | 66fb962a6608805f4d7667d39ad0d88158bd1262 (diff) |
Document $ARGS and friends
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/3.manual/manual.yml | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml index ae2b7f91..a0d713e7 100644 --- a/docs/content/3.manual/manual.yml +++ b/docs/content/3.manual/manual.yml @@ -217,6 +217,9 @@ sections: `value` will be treated as a string, so `--arg foo 123` will bind `$foo` to `"123"`. + Named arguments are also available to the jq program as + `$ARGS.named`. + * `--argjson name JSON-text`: This option passes a JSON-encoded value to the jq program as a @@ -239,6 +242,16 @@ sections: one text, then that is used, else an array of texts is used as in `--slurpfile`.) + * `--args`: + + Remaining arguments are positional string arguments. These are + available to the jq program as `$ARGS.positional[]`. + + * `--jsonargs`: + + Remaining arguments are positional JSON text arguments. These + are available to the jq program as `$ARGS.positional[]`. + * `--run-tests [filename]`: Runs the tests in the given file or standard input. This must |