From 245382532d1e0500db388bb9a51b6dda1f57b338 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 25 Jul 2023 06:28:15 +0000 Subject: Update website --- manual/index.html | 172 +++++++++++++++++++++++++------------------------ manual/v1.3/index.html | 36 +++++------ manual/v1.4/index.html | 86 +++++++++++++------------ manual/v1.5/index.html | 138 ++++++++++++++++++++------------------- manual/v1.6/index.html | 140 +++++++++++++++++++++------------------- 5 files changed, 294 insertions(+), 278 deletions(-) diff --git a/manual/index.html b/manual/index.html index b66fe23b..7c8dd6ce 100644 --- a/manual/index.html +++ b/manual/index.html @@ -179,58 +179,24 @@ program.

You can affect how jq reads and writes its input and output using some command-line options:

-

Output the jq version and exit with zero.

- -

Use the application/json-seq MIME type scheme for separating - JSON texts in jq's input and output. This means that an ASCII - RS (record separator) character is printed before each value on - output and an ASCII LF (line feed) is printed after every - output. Input JSON texts that fail to parse are ignored (but - warned about), discarding all subsequent input until the next - RS. This mode also parses the output of jq without the --seq - option.

- -

Parse the input in streaming fashion, outputting arrays of path - and leaf values (scalars and empty arrays or empty objects). - For example, "a" becomes [[],"a"], and [[],"a",["b"]] - becomes [[0],[]], [[1],"a"], and [[2,0],"b"].

-

This is useful for processing very large inputs. Use this in - conjunction with filtering and the reduce and foreach syntax - to reduce large inputs incrementally.

- -

Like --stream, but invalid JSON inputs yield array values - where the first element is the error and the second is a path. - For example, ["a",n] produces ["Invalid literal at line 1, - column 9",[1]]`.

-

Implies --stream. Invalid JSON inputs produce no error values - when --stream without --stream-errors.

- -

Instead of running the filter for each JSON object in the - input, read the entire input stream into a large array and run - the filter just once.

+

Don't read any input at all. Instead, the filter is run once + using null as the input. This is useful when using jq as a + simple calculator or to construct JSON data from scratch.

Don't parse the input as JSON. Instead, each line of text is passed to the filter as a string. If combined with --slurp, then the entire input is passed to the filter as a single long string.

-

Don't read any input at all! Instead, the filter is run once - using null as the input. This is useful when using jq as a - simple calculator or to construct JSON data from scratch.

+

Instead of running the filter for each JSON object in the + input, read the entire input stream into a large array and run + the filter just once.

@@ -238,13 +204,33 @@ using some command-line options:

will result in more compact output by instead putting each JSON object on a single line.

-

Use a tab for each indentation level instead of two spaces.

+

With this option, if the filter's result is a string then it + will be written directly to standard output rather than being + formatted as a JSON string with quotes. This can be useful for + making jq filters talk to non-JSON-based systems.

-

Use the given number of spaces (no more than 7) for indentation.

+

Like -r but jq won't print a newline after each output.

+ +

Like -r but jq will print NUL instead of newline after each output. + This can be useful when the values being output can contain newlines.

+ +

jq usually outputs non-ASCII Unicode codepoints as UTF-8, even + if the input specified them as escape sequences (like + "\u03bc"). Using this option, you can force jq to produce pure + ASCII output with every non-ASCII character replaced with the + equivalent escape sequence.

+ +

Output the fields of each object with the keys in sorted order.

@@ -256,19 +242,13 @@ using some command-line options:

Colors can be configured with the JQ_COLORS environment variable (see below).

-

Windows users using WSL, MSYS2, or Cygwin, should use this option - when using a native jq.exe, otherwise jq will turn newlines (LFs) - into carriage-return-then-newline (CRLF).

+

Use a tab for each indentation level instead of two spaces.

-

jq usually outputs non-ASCII Unicode codepoints as UTF-8, even - if the input specified them as escape sequences (like - "\u03bc"). Using this option, you can force jq to produce pure - ASCII output with every non-ASCII character replaced with the - equivalent escape sequence.

+

Use the given number of spaces (no more than 7) for indentation.

@@ -276,48 +256,47 @@ using some command-line options:

you're piping a slow data source into jq and piping jq's output elsewhere).

-

Output the fields of each object with the keys in sorted order.

- -

With this option, if the filter's result is a string then it - will be written directly to standard output rather than being - formatted as a JSON string with quotes. This can be useful for - making jq filters talk to non-JSON-based systems.

+

Parse the input in streaming fashion, outputting arrays of path + and leaf values (scalars and empty arrays or empty objects). + For example, "a" becomes [[],"a"], and [[],"a",["b"]] + becomes [[0],[]], [[1],"a"], and [[2,0],"b"].

+

This is useful for processing very large inputs. Use this in + conjunction with filtering and the reduce and foreach syntax + to reduce large inputs incrementally.

-

Like -r but jq won't print a newline after each output.

+

Like --stream, but invalid JSON inputs yield array values + where the first element is the error and the second is a path. + For example, ["a",n] produces ["Invalid literal at line 1, + column 7",[1]].

+

Implies --stream. Invalid JSON inputs produce no error values + when --stream without --stream-errors.

-

Like -r but jq will print NUL instead of newline after each output. - This can be useful when the values being output can contain newlines.

+

Use the application/json-seq MIME type scheme for separating + JSON texts in jq's input and output. This means that an ASCII + RS (record separator) character is printed before each value on + output and an ASCII LF (line feed) is printed after every + output. Input JSON texts that fail to parse are ignored (but + warned about), discarding all subsequent input until the next + RS. This mode also parses the output of jq without the --seq + option.

Read filter from the file rather than from a command line, like awk's -f option. You can also use '#' to make comments.

Prepend directory to the search list for modules. If this option is used then no builtin search list is used. See the section on modules below.

-

Sets the exit status of jq to 0 if the last output value was - neither false nor null, 1 if the last output value was - either false or null, or 4 if no valid result was ever - produced. Normally jq exits with 2 if there was any usage - problem or system error, 3 if there was a jq program compile - error, or 0 if the jq program ran.

-

Another way to set the exit status is with the halt_error - builtin function.

-

This option passes a value to the jq program as a predefined @@ -366,6 +345,31 @@ using some command-line options:

Remaining arguments are positional JSON text arguments. These are available to the jq program as $ARGS.positional[].

+

Sets the exit status of jq to 0 if the last output value was + neither false nor null, 1 if the last output value was + either false or null, or 4 if no valid result was ever + produced. Normally jq exits with 2 if there was any usage + problem or system error, 3 if there was a jq program compile + error, or 0 if the jq program ran.

+

Another way to set the exit status is with the halt_error + builtin function.

+ +

Windows users using WSL, MSYS2, or Cygwin, should use this option + when using a native jq.exe, otherwise jq will turn newlines (LFs) + into carriage-return-then-newline (CRLF).

+ +

Output the jq version and exit with zero.

+ +

Output the jq help and exit with zero.

+

Terminates argument processing. Remaining arguments are @@ -380,7 +384,7 @@ using some command-line options:

program lines followed by one input line, as many lines of output as are expected (one per output), and a terminating empty line. Compilation failure tests start with a line containing - only "%%FAIL", then a line containing the program to compile, + only %%FAIL, then a line containing the program to compile, then a line containing an error message to compare to the actual.

Be warned that this option can change backwards-incompatibly.

diff --git a/manual/v1.3/index.html b/manual/v1.3/index.html index 921eb42a..e6449a78 100644 --- a/manual/v1.3/index.html +++ b/manual/v1.3/index.html @@ -135,24 +135,24 @@ sequence of newline-separated JSON data.

You can affect how jq reads and writes its input and output using some command-line options:

-

Instead of running the filter for each JSON object in the - input, read the entire input stream into a large array and run - the filter just once.

+

Don't read any input at all. Instead, the filter is run once + using null as the input. This is useful when using jq as a + simple calculator or to construct JSON data from scratch.

Don't parse the input as JSON. Instead, each line of text is passed to the filter as a string. If combined with --slurp, then the entire input is passed to the filter as a single long string.

-

Don't read any input at all! Instead, the filter is run once - using null as the input. This is useful when using jq as a - simple calculator or to construct JSON data from scratch.

+

Instead of running the filter for each JSON object in the + input, read the entire input stream into a large array and run + the filter just once.

@@ -160,11 +160,12 @@ using some command-line options:

will result in more compact output by instead putting each JSON object on a single line.

-

By default, jq outputs colored JSON if writing to a - terminal. You can force it to produce color even if writing to - a pipe or a file using -C, and disable color with -M.

+

With this option, if the filter's result is a string then it + will be written directly to standard output rather than being + formatted as a JSON string with quotes. This can be useful for + making jq filters talk to non-JSON-based systems.

@@ -174,12 +175,11 @@ using some command-line options:

ASCII output with every non-ASCII character replaced with the equivalent escape sequence.

-

With this option, if the filter's result is a string then it - will be written directly to standard output rather than being - formatted as a JSON string with quotes. This can be useful for - making jq filters talk to non-JSON-based systems.

+

By default, jq outputs colored JSON if writing to a + terminal. You can force it to produce color even if writing to + a pipe or a file using -C, and disable color with -M.

diff --git a/manual/v1.4/index.html b/manual/v1.4/index.html index 578491ac..e91473a9 100644 --- a/manual/v1.4/index.html +++ b/manual/v1.4/index.html @@ -145,46 +145,43 @@ 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:

-

Output the jq version and exit with zero.

+

Don't read any input at all. Instead, the filter is run once + using null as the input. This is useful when using jq as a + simple calculator or to construct JSON data from scratch.

+ +

Don't parse the input as JSON. Instead, each line of text is + passed to the filter as a string. If combined with --slurp, + then the entire input is passed to the filter as a single long + string.

Instead of running the filter for each JSON object in the input, read the entire input stream into a large array and run the filter just once.

When the top-level input value is an array produce its elements instead of the array. This allows on-line processing of potentially very large top-level arrays' elements.

-

Don't parse the input as JSON. Instead, each line of text is - passed to the filter as a string. If combined with --slurp, - then the entire input is passed to the filter as a single long - string.

- -

Don't read any input at all! Instead, the filter is run once - using null as the input. This is useful when using jq as a - simple calculator or to construct JSON data from scratch.

-

By default, jq pretty-prints JSON output. Using this option will result in more compact output by instead putting each JSON object on a single line.

-

By default, jq outputs colored JSON if writing to a - terminal. You can force it to produce color even if writing to - a pipe or a file using -C, and disable color with -M.

+

With this option, if the filter's result is a string then it + will be written directly to standard output rather than being + formatted as a JSON string with quotes. This can be useful for + making jq filters talk to non-JSON-based systems.

@@ -194,37 +191,27 @@ using some command-line options:

ASCII output with every non-ASCII character replaced with the equivalent escape sequence.

-

Flush the output after each JSON object is printed (useful if - you're piping a slow data source into jq and piping jq's - output elsewhere).

-

Output the fields of each object with the keys in sorted order.

-

With this option, if the filter's result is a string then it - will be written directly to standard output rather than being - formatted as a JSON string with quotes. This can be useful for - making jq filters talk to non-JSON-based systems.

+

By default, jq outputs colored JSON if writing to a + terminal. You can force it to produce color even if writing to + a pipe or a file using -C, and disable color with -M.

+ +

Flush the output after each JSON object is printed (useful if + you're piping a slow data source into jq and piping jq's + output elsewhere).

Read filter from the file rather than from a command line, like awk's -f option. You can also use '#' to make comments.

-

Sets the exit status of jq to 0 if the last output value was - neither false nor null, 1 if the last output value was - either false or null, or 4 if no valid result was ever - produced. Normally jq exits with 2 if there was any usage - problem or system error, 3 if there was a jq program compile - error, or 0 if the jq program ran.

-

This option passes a value to the jq program as a predefined @@ -238,6 +225,23 @@ using some command-line options:

with --argfile foo bar, then $foo is available in the program and has the value resulting from parsing the content of the file named bar.

+ +

Sets the exit status of jq to 0 if the last output value was + neither false nor null, 1 if the last output value was + either false or null, or 4 if no valid result was ever + produced. Normally jq exits with 2 if there was any usage + problem or system error, 3 if there was a jq program compile + error, or 0 if the jq program ran.

+ +

Output the jq version and exit with zero.

+ +

Output the jq help and exit with zero.

diff --git a/manual/v1.5/index.html b/manual/v1.5/index.html index 84be4c69..a8b59ee8 100644 --- a/manual/v1.5/index.html +++ b/manual/v1.5/index.html @@ -165,49 +165,24 @@ 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:

-

Output the jq version and exit with zero.

- -

Use the application/json-seq MIME type scheme for separating - JSON texts in jq's input and output. This means that an ASCII - RS (record separator) character is printed before each value on - output and an ASCII LF (line feed) is printed after every - output. Input JSON texts that fail to parse are ignored (but - warned about), discarding all subsequent input until the next - RS. This mode also parses the output of jq without the --seq - option.

- -

Parse the input in streaming fashion, outputting arrays of path - and leaf values (scalars and empty arrays or empty objects). - For example, "a" becomes [[],"a"], and [[],"a",["b"]] - becomes [[0],[]], [[1],"a"], and [[2,0],"b"].

-

This is useful for processing very large inputs. Use this in - conjunction with filtering and the reduce and foreach syntax - to reduce large inputs incrementally.

- -

Instead of running the filter for each JSON object in the - input, read the entire input stream into a large array and run - the filter just once.

+

Don't read any input at all. Instead, the filter is run once + using null as the input. This is useful when using jq as a + simple calculator or to construct JSON data from scratch.

Don't parse the input as JSON. Instead, each line of text is passed to the filter as a string. If combined with --slurp, then the entire input is passed to the filter as a single long string.

-

Don't read any input at all! Instead, the filter is run once - using null as the input. This is useful when using jq as a - simple calculator or to construct JSON data from scratch.

+

Instead of running the filter for each JSON object in the + input, read the entire input stream into a large array and run + the filter just once.

@@ -215,19 +190,16 @@ using some command-line options:

will result in more compact output by instead putting each JSON object on a single line.

-

Use a tab for each indentation level instead of two spaces.

- -

Use the given number of spaces (no more than 7) for indentation.

+

With this option, if the filter's result is a string then it + will be written directly to standard output rather than being + formatted as a JSON string with quotes. This can be useful for + making jq filters talk to non-JSON-based systems.

-

By default, jq outputs colored JSON if writing to a - terminal. You can force it to produce color even if writing to - a pipe or a file using -C, and disable color with -M.

+

Like -r but jq won't print a newline after each output.

@@ -237,47 +209,62 @@ using some command-line options:

ASCII output with every non-ASCII character replaced with the equivalent escape sequence.

+

Output the fields of each object with the keys in sorted order.

+ +

By default, jq outputs colored JSON if writing to a + terminal. You can force it to produce color even if writing to + a pipe or a file using -C, and disable color with -M.

+ +

Use a tab for each indentation level instead of two spaces.

+ +

Use the given number of spaces (no more than 7) for indentation.

+

Flush the output after each JSON object is printed (useful if you're piping a slow data source into jq and piping jq's output elsewhere).

-

Output the fields of each object with the keys in sorted order.

- -

With this option, if the filter's result is a string then it - will be written directly to standard output rather than being - formatted as a JSON string with quotes. This can be useful for - making jq filters talk to non-JSON-based systems.

+

Parse the input in streaming fashion, outputting arrays of path + and leaf values (scalars and empty arrays or empty objects). + For example, "a" becomes [[],"a"], and [[],"a",["b"]] + becomes [[0],[]], [[1],"a"], and [[2,0],"b"].

+

This is useful for processing very large inputs. Use this in + conjunction with filtering and the reduce and foreach syntax + to reduce large inputs incrementally.

-

Like -r but jq won't print a newline after each output.

+

Use the application/json-seq MIME type scheme for separating + JSON texts in jq's input and output. This means that an ASCII + RS (record separator) character is printed before each value on + output and an ASCII LF (line feed) is printed after every + output. Input JSON texts that fail to parse are ignored (but + warned about), discarding all subsequent input until the next + RS. This mode also parses the output of jq without the --seq + option.

Read filter from the file rather than from a command line, like awk's -f option. You can also use '#' to make comments.

Prepend directory to the search list for modules. If this option is used then no builtin search list is used. See the section on modules below.

-

Sets the exit status of jq to 0 if the last output value was - neither false nor null, 1 if the last output value was - either false or null, or 4 if no valid result was ever - produced. Normally jq exits with 2 if there was any usage - problem or system error, 3 if there was a jq program compile - error, or 0 if the jq program ran.

-

This option passes a value to the jq program as a predefined @@ -296,7 +283,7 @@ using some command-line options:

This option reads all the JSON texts in the named file and binds an array of the parsed JSON values to the given global variable. - If you run jq with --argfile foo bar, then $foo is available + If you run jq with --slurpfile foo bar, then $foo is available in the program and has an array whose elements correspond to the texts in the file named bar.