From 1956abbedf6846ce9d852ec0379b469834555a52 Mon Sep 17 00:00:00 2001 From: Nicolas Williams Date: Wed, 25 Dec 2013 17:05:32 -0600 Subject: [PATCH] Add note to jq.1 about shell quoting --- docs/content/3.manual/manual.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml index b5952bb1..ef07fc47 100644 --- a/docs/content/3.manual/manual.yml +++ b/docs/content/3.manual/manual.yml @@ -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: |