summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorNicolas Williams <nico@cryptonector.com>2017-02-22 23:01:39 -0600
committerNicolas Williams <nico@cryptonector.com>2017-02-26 16:34:56 -0600
commit6bac4ed059966007a6bc0e4a3639aca7d59f3b10 (patch)
tree3d8a50fc6be61618ae903ac36a0d72ca56d92355 /docs
parenta03ae02f4489e35cc874bb529570092414eee729 (diff)
Document `stderr`
Diffstat (limited to 'docs')
-rw-r--r--docs/content/3.manual/manual.yml16
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml
index 84675182..cadc6fbd 100644
--- a/docs/content/3.manual/manual.yml
+++ b/docs/content/3.manual/manual.yml
@@ -2763,11 +2763,13 @@ sections:
jq itself. These two builtins, and jq's own reading actions, can
be interleaved with each other.
- One builtin provides minimal output capabilities, `debug`.
- (Recall that a jq program's output values are always output as
- JSON texts on `stdout`.) The `debug` builtin can have
+ Two builtins provide minimal output capabilities, `debug`, and
+ `stderr`. (Recall that a jq program's output values are always
+ output as JSON texts on `stdout`.) The `debug` builtin can have
application-specific behavior, such as for executables that use
- the libjq C API but aren't the jq executable itself.
+ the libjq C API but aren't the jq executable itself. The `stderr`
+ builtin outputs its input in raw mode to stder with no additional
+ decoration, not even a newline.
Most jq builtins are referentially transparent, and yield constant
and repeatable value streams when applied to constant inputs.
@@ -2795,6 +2797,12 @@ sections:
`["DEBUG:", <input-value>]` and prints that and a newline on
stderr, compactly. This may change in the future.
+ - title: "`stderr`"
+ body: |
+
+ Prints its input in raw and compact mode to stderr with no
+ additional decoration, not even a newline.
+
- title: "`input_filename`"
body: |