summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDawid Ferenczy Rogožan <ferenczy@users.noreply.github.com>2023-06-16 15:47:37 +0200
committerGitHub <noreply@github.com>2023-06-16 22:47:37 +0900
commit11d909170ef555ffbb26b89b7b44956f1ee2f075 (patch)
tree09e02f2b4dac4fc421e376e80bff8c389dd2151d
parentc2026f5d9ef36c761a4aa5e48d3af9fa2d8e27cd (diff)
Added usage under Powershell to the manual (#2306)
-rw-r--r--docs/content/manual/manual.yml10
-rw-r--r--docs/content/manual/v1.6/manual.yml10
2 files changed, 18 insertions, 2 deletions
diff --git a/docs/content/manual/manual.yml b/docs/content/manual/manual.yml
index 0d552c7f..431ebcbc 100644
--- a/docs/content/manual/manual.yml
+++ b/docs/content/manual/manual.yml
@@ -91,7 +91,15 @@ sections:
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.
+ double-quotes in the jq program need backslash escaping. When using
+ the Powershell (`powershell.exe`) or the Powershell Core
+ (`pwsh`/`pwsh.exe`), use single-quote characters around the jq
+ program and backslash-escaped double-quotes (`\"`) inside the jq
+ program.
+
+ Unix shells: `jq '.["foo"]'`
+ Powershell: `jq '.[\"foo\"]'`
+ Windows command shell: `jq ".[\"foo\"]"`
You can affect how jq reads and writes its input and output
using some command-line options:
diff --git a/docs/content/manual/v1.6/manual.yml b/docs/content/manual/v1.6/manual.yml
index 5aadf0cc..58de6e91 100644
--- a/docs/content/manual/v1.6/manual.yml
+++ b/docs/content/manual/v1.6/manual.yml
@@ -90,7 +90,15 @@ sections:
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.
+ double-quotes in the jq program need backslash escaping. When using
+ the Powershell (`powershell.exe`) or the Powershell Core
+ (`pwsh`/`pwsh.exe`), use single-quote characters around the jq
+ program and backslash-escaped double-quotes (`\"`) inside the jq
+ program.
+
+ Unix shells: `jq '.["foo"]'`
+ Powershell: `jq '.[\"foo\"]'`
+ Windows command shell: `jq ".[\"foo\"]"`
You can affect how jq reads and writes its input and output
using some command-line options: