Skip to content

Commit

Permalink
Make the note about shell quoting appear on site
Browse files Browse the repository at this point in the history
  • Loading branch information
nicowilliams committed Jun 9, 2014
1 parent cf145ec commit fdf843c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/content/3.manual/manual.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -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:
Expand Down

0 comments on commit fdf843c

Please sign in to comment.