diff options
| author | Nicolas Williams <nico@cryptonector.com> | 2014-06-09 17:43:17 -0500 |
|---|---|---|
| committer | Nicolas Williams <nico@cryptonector.com> | 2014-06-09 17:43:17 -0500 |
| commit | fdf843c08b00d86fd7bc5d154868193c24abdda8 (patch) | |
| tree | 06f91d35a59c630cc87ac3135bc052f16fb1c55e | |
| parent | cf145ec65e72c64683b85cc5a053e152ff4bb672 (diff) | |
Make the note about shell quoting appear on site
| -rw-r--r-- | docs/content/3.manual/manual.yml | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml index fe98a6ff..e9d05e77 100644 --- a/docs/content/3.manual/manual.yml +++ b/docs/content/3.manual/manual.yml @@ -49,17 +49,6 @@ manpage_intro: | in the jq language and specifies how to transform the input document. - 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 - 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 defined`. - When using the Windows command shell (cmd.exe) it's best to use double - quotes around your jq program when given on the command-line (instead - of the `-f program-file` option), but then double-quotes in the jq - program need backslash escaping. - ## FILTERS manpage_epilogue: | @@ -83,6 +72,17 @@ sections: output(s) of the filter are written to standard out, again as a sequence of whitespace-separated JSON data. + 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 + 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 + defined`. When using the Windows command shell (cmd.exe) it's + best to use double quotes around your jq program when given on the + command-line (instead of the `-f program-file` option), but then + double-quotes in the jq program need backslash escaping. + You can affect how jq reads and writes its input and output using some command-line options: |