diff options
author | Nicolas Williams <nico@cryptonector.com> | 2023-07-29 13:44:14 -0500 |
---|---|---|
committer | Nico Williams <nico@cryptonector.com> | 2023-08-01 23:06:01 -0500 |
commit | 27a4d5757e42d9653585eeddda78e8d313bad194 (patch) | |
tree | 6ab7361f58b7316d1546b1d344e6f035015b2afb /docs | |
parent | 044b38595cc2d6670fed510ecba9df87f6b39e1b (diff) |
Require a main program (fix #2785)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/manual/manual.yml | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/content/manual/manual.yml b/docs/content/manual/manual.yml index e4c8c64b..d2c5f538 100644 --- a/docs/content/manual/manual.yml +++ b/docs/content/manual/manual.yml @@ -81,9 +81,18 @@ sections: output(s) of the filter are written to standard output, as a sequence of newline-separated JSON data. + The simplest and most common filter (or jq program) is `.`, + which is the identity operator, copying the inputs of the jq + processor to the output stream. Because the default behavior of + the jq processor is to read JSON texts from the input stream, + and to pretty-print outputs, the `.` program's main use is to + validate and pretty-print the inputs. The jq programming + language is quite rich and allows for much more than just + validation and pretty-printing. + Note: it is important to mind the shell's quoting rules. As a general rule it's best to always quote (with single-quote - characters) the jq program, as too many characters with special + characters on Unix shells) the jq program, as too many characters with special meaning to jq are also shell meta-characters. For example, `jq "foo"` will fail on most Unix shells because that will be the same as `jq foo`, which will generally fail because `foo is not @@ -100,6 +109,9 @@ sections: * Powershell: `jq '.[\"foo\"]'` * Windows command shell: `jq ".[\"foo\"]"` + Note: jq allows user-defined functions, but every jq program + must have a top-level expression. + You can affect how jq reads and writes its input and output using some command-line options: |