]> granicus.if.org Git - jq/commitdiff
Add note to jq.1 about shell quoting
authorNicolas Williams <nico@cryptonector.com>
Wed, 25 Dec 2013 23:05:32 +0000 (17:05 -0600)
committerNicolas Williams <nico@cryptonector.com>
Wed, 25 Dec 2013 23:05:32 +0000 (17:05 -0600)
docs/content/3.manual/manual.yml

index b5952bb14a10b4a04244ced0017fd6dcd5f263a0..ef07fc47facda6129e5ced3b3b055258ea8b220c 100644 (file)
@@ -49,6 +49,13 @@ 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`.
+
   ## FILTERS
 
 manpage_epilogue: |