Rebuild jq.1.prebuilt

1 files changed, 1120 insertions, 57 deletions

diff --git a/jq.1.prebuilt b/jq.1.prebuilt
index adb6591d..7ca3cba3 100644
--- a/jq.1.prebuilt
+++ b/jq.1.prebuilt
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "JQ" "1" "June 2014" "" ""
+.TH "JQ" "1" "July 2015" "" ""
 .
 .SH "NAME"
 \fBjq\fR \- Command\-line JSON processor
@@ -13,10 +13,10 @@
 \fBjq\fR can transform JSON in various ways, by selecting, iterating, reducing and otherwise mangling JSON documents\. For instance, running the command \fBjq \'map(\.price) | add\'\fR will take an array of JSON objects as input and return the sum of their "price" fields\.
 .
 .P
-By default, \fBjq\fR reads a stream of JSON objects (whitespace separated) from \fBstdin\fR\. One or more \fIfiles\fR may be specified, in which case \fBjq\fR will read input from those instead\.
+\fBjq\fR can accept text input as well, but by default, \fBjq\fR reads a stream of JSON entities (including numbers and other literals) from \fBstdin\fR\. Whitespace is only needed to separate entities such as 1 and 2, and true and false\. One or more \fIfiles\fR may be specified, in which case \fBjq\fR will read input from those instead\.
 .
 .P
-The \fIoptions\fR are described in the \fIINVOKING JQ\fR section, they mostly concern input and output formatting\. The \fIfilter\fR is written in the jq language and specifies how to transform the input document\.
+The \fIoptions\fR are described in the \fIINVOKING JQ\fR section; they mostly concern input and output formatting\. The \fIfilter\fR is written in the jq language and specifies how to transform the input file or document\.
 .
 .SH "FILTERS"
 A jq program is a "filter": it takes an input, and produces an output\. There are a lot of builtin filters for extracting a particular field of an object, or converting a number to a string, or various other standard tasks\.
@@ -28,7 +28,7 @@ Filters can be combined in various ways \- you can pipe the output of one filter
 Some filters produce multiple results, for instance there\'s one that produces all the elements of its input array\. Piping that filter into a second runs the second filter for each element of the array\. Generally, things that would be done with loops and iteration in other languages are just done by gluing filters together in jq\.
 .
 .P
-It\'s important to remember that every filter has an input and an output\. Even literals like "hello" or 42 are filters \- they take an input but always produce the same literal as output\. Operations that combine two filters, like addition, generally feed the same input to both and combine the results\. So, you can implement an averaging filter as \fBadd / length\fR \- feeding the input array both to the \fBadd\fR filter and the \fBlength\fR filter and dividing the results\.
+It\'s important to remember that every filter has an input and an output\. Even literals like "hello" or 42 are filters \- they take an input but always produce the same literal as output\. Operations that combine two filters, like addition, generally feed the same input to both and combine the results\. So, you can implement an averaging filter as \fBadd / length\fR \- feeding the input array both to the \fBadd\fR filter and the \fBlength\fR filter and then performing the division\.
 .
 .P
 But that\'s getting ahead of ourselves\. :) Let\'s start with something simpler:
@@ -49,6 +49,21 @@ You can affect how jq reads and writes its input and output using some command\-
 Output the jq version and exit with zero\.
 .
 .IP "\(bu" 4
+\fB\-\-seq\fR:
+.
+.IP
+Use the \fBapplication/json\-seq\fR 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 more also parses the output of jq without the \fB\-\-seq\fR option\.
+.
+.IP "\(bu" 4
+\fB\-\-stream\fR:
+.
+.IP
+Parse the input in streaming fashion, outputing arrays of path and leaf values (scalars and empty arrays or empty objects)\. For example, \fB"a"\fR becomes \fB[[],"a"]\fR, and \fB[[],"a",["b"]]\fR becomes \fB[[0],[]]\fR, \fB[[1],"a"]\fR, and \fB[[1,0],"b"]\fR\.
+.
+.IP
+This is useful for processing very large inputs\. Use this in conjunction with filtering and the \fBreduce\fR and \fBforeach\fR syntax to reduce large inputs incrementally\.
+.
+.IP "\(bu" 4
 \fB\-\-slurp\fR/\fB\-s\fR:
 .
 .IP
@@ -73,6 +88,18 @@ Don\'t read any input at all! Instead, the filter is run once using \fBnull\fR a
 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\.
 .
 .IP "\(bu" 4
+\fB\-\-tab\fR:
+.
+.IP
+Use a tab for each indentation level instead of two spaces\.
+.
+.IP "\(bu" 4
+\fB\-\-indent n\fR:
+.
+.IP
+Use the given number of spaces (no more than 8) for indentation\.
+.
+.IP "\(bu" 4
 \fB\-\-color\-output\fR / \fB\-C\fR and \fB\-\-monochrome\-output\fR / \fB\-M\fR:
 .
 .IP
@@ -115,6 +142,12 @@ Like \fB\-r\fR but jq won\'t print a newline after each output\.
 Read filter from the file rather than from a command line, like awk\'s \-f option\. You can also use \'#\' to make comments\.
 .
 .IP "\(bu" 4
+\fB\-Ldirectory\fR / \fB\-L directory\fR:
+.
+.IP
+Prepend \fBdirectory\fR to the search list for modules\. If this option is used then no builtin search list is used\. See the section on modules below\.
+.
+.IP "\(bu" 4
 \fB\-e\fR / \fB\-\-exit\-status\fR:
 .
 .IP
@@ -124,13 +157,37 @@ Sets the exit status of jq to 0 if the last output values was neither \fBfalse\f
 \fB\-\-arg name value\fR:
 .
 .IP
-This option passes a value to the jq program as a predefined variable\. If you run jq with \fB\-\-arg foo bar\fR, then \fB$foo\fR is available in the program and has the value \fB"bar"\fR\.
+This option passes a value to the jq program as a predefined variable\. If you run jq with \fB\-\-arg foo bar\fR, then \fB$foo\fR is available in the program and has the value \fB"bar"\fR\. Note that \fBvalue\fR will be treated as a string, so \fB\-\-arg foo 123\fR will bind \fB$foo\fR to \fB"123"\fR\.
 .
 .IP "\(bu" 4
-\fB\-\-argfile name filename\fR:
+\fB\-\-argjson name JSON\-text\fR:
 .
 .IP
-This option passes the first value from the named file as a value to the jq program as a predefined variable\. If you run jq with \fB\-\-argfile foo bar\fR, then \fB$foo\fR is available in the program and has the value resulting from parsing the content of the file named \fBbar\fR\.
+This option passes a JSON\-encoded value to the jq program as a predefined variable\. If you run jq with \fB\-\-argjson foo 123\fR, then \fB$foo\fR is available in the program and has the value \fB123\fR\.
+.
+.IP "\(bu" 4
+\fB\-\-slurpfile variable\-name filename\fR:
+.
+.IP
+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 \fB\-\-argfile foo bar\fR, then \fB$foo\fR is available in the program and has an array whose elements correspond to the texts in the file named \fBbar\fR\.
+.
+.IP "\(bu" 4
+\fB\-\-argfile variable\-name filename\fR:
+.
+.IP
+Do not use\. Use \fB\-\-slurpfile\fR instead\.
+.
+.IP
+(This option is like \fB\-\-slurpfile\fR, but when the file has just one text, then that is used, else an array of texts is used as in \fB\-\-slurfile\fR\.)
+.
+.IP "\(bu" 4
+\fB\-\-run\-tests [filename]\fR:
+.
+.IP
+Runs the tests in the given file or standard input\. This must be the last option given and does not honor all preceding options\. The input consts of comment lines, empty lines, and 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, then a line containing an error message to compare to the actual\.
+.
+.IP
+Be warned that this option can change backwards\-incompatibly\.
 .
 .IP "" 0
 .
@@ -217,6 +274,12 @@ You can also look up fields of an object using syntax like \fB\.["foo"]\fR (\.fo
 The \fB\.[10:15]\fR syntax can be used to return a subarray of an array or substring of a string\. The array returned by \fB\.[10:15]\fR will be of length 5, containing the elements from index 10 (inclusive) to index 15 (exclusive)\. Either index may be negative (in which case it counts backwards from the end of the array), or omitted (in which case it refers to the start or end of the array)\.
 .
 .P
+The \fB\.[2]\fR syntax can be used to return the element at the given index\. Negative indices are allowed, with \-1 referring to the last element, \-2 referring to the next to last element, and so on\.
+.
+.P
+The \fB\.foo\fR syntax only works for simply keys i\.e\. keys that are all alphanumeric characters\. \fB\.[<string>]\fR works with keys that contain special charactors such as colons and dots\. For example \fB\.["foo::bar"]\fR and \fB\.["foo\.bar"]\fR work while \fB\.foo::bar\fR and \fB\.foo\.bar\fR would not\.
+.
+.P
 The \fB?\fR "operator" can also be used with the slice operator, as in \fB\.[10:15]?\fR, which outputs values where the inputs are slice\-able\.
 .
 .IP "" 4
@@ -246,6 +309,10 @@ jq \'\.[:3]\'
 jq \'\.[\-2:]\'
    ["a","b","c","d","e"]
 => ["d", "e"]
+
+jq \'\.[\-2]\'
+   [1,2,3]
+=> 2
 .
 .fi
 .
@@ -531,7 +598,7 @@ These operators only work on numbers, and do the expected\.
 Multiplying a string by a number produces the concatenation of that string that many times\.
 .
 .P
-Dividing a string by another splits the first using the second as separators\.
+Dividing a string by another splits the first using the second as separators\. Division by zero raises an error\.
 .
 .P
 Multiplying two objects will merge them recursively: this works like addition but if both objects contain a value for the same key, and the values are objects, the two are merged with the same strategy\.
@@ -551,6 +618,10 @@ jq \'\. / ", "\'
 jq \'{"k": {"a": 1, "b": 2}} * {"k": {"a": 0,"c": 3}}\'
    null
 => {"k": {"a": 0, "b": 2, "c": 3}}
+
+jq \'\.[] | (1 / \.)?\'
+   [1,0,\-1]
+=> 1, \-1
 .
 .fi
 .
@@ -576,7 +647,7 @@ jq \'\.[] | length\' [[1,2], "string", {"a":2}, null] => 2, 6, 1, 0
 .
 .IP "" 0
 .
-.SS "keys"
+.SS "keys, keys_unsorted"
 The builtin function \fBkeys\fR, when given an object, returns its keys in an array\.
 .
 .P
@@ -585,6 +656,9 @@ The keys are sorted "alphabetically", by unicode codepoint order\. This is not a
 .P
 When \fBkeys\fR is given an array, it returns the valid indices for that array: the integers from 0 to length\-1\.
 .
+.P
+The \fBkeys_unsorted\fR function is just like \fBkeys\fR, but if the input is an object then the keys will not be sorted, instead the keys will roughly be in insertion order\.
+.
 .IP "" 4
 .
 .nf
@@ -623,6 +697,56 @@ jq \'map(has(2))\'
 .
 .IP "" 0
 .
+.SS "in"
+The builtin function \fBin\fR returns the input key is in the given object, or the input index corresponds to an element in the given array\. It is, essentially, an inversed version of \fBhas\fR\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'\.[] | in({"foo": 42})\'
+   ["foo", "bar"]
+=> true, false
+
+jq \'map(in([0,1]))\'
+   [2, 0]
+=> [false, true]
+.
+.fi
+.
+.IP "" 0
+.
+.SS "path(path_expression)"
+Outputs array representations of the given path expression in \fB\.\fR\. The outputs are arrays of strings (keys in objects0 and/or numbers (array indices\.
+.
+.P
+Path expressions are jq expressions like \fB\.a\fR, but also \fB\.[]\fR\. There are two types of path expressions: ones that can match exactly, and ones that cannot\. For example, \fB\.a\.b\.c\fR is an exact match path expression, while \fB\.a[]\.b\fR is not\.
+.
+.P
+\fBpath(exact_path_expression)\fR will produce the array representation of the path expression even if it does not exist in \fB\.\fR, if \fB\.\fR is \fBnull\fR or an array or an object\.
+.
+.P
+\fBpath(pattern)\fR will produce array representations of the paths matching \fBpattern\fR if the paths exist in \fB\.\fR\.
+.
+.P
+Note that the path expressions are not different from normal expressions\. The expression \fBpath(\.\.|select(type=="boolean"))\fR outputs all the paths to boolean values in \fB\.\fR, and only those paths\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'path(\.a[0]\.b)\'
+   null
+=> ["a",0,"b"]
+
+jq \'[path(\.\.)]\'
+   {"a":[{"b":1}]}
+=> [[],["a"],["a",0],["a",0,"b"]]
+.
+.fi
+.
+.IP "" 0
+.
 .SS "del(path_expression)"
 The builtin function \fBdel\fR removes a key and its corresponding value from an object\.
 .
@@ -631,11 +755,11 @@ The builtin function \fBdel\fR removes a key and its corresponding value from an
 .nf
 
 jq \'del(\.foo)\'
-   [{"foo": 42, "bar": 9001, "baz": 42}]
+   {"foo": 42, "bar": 9001, "baz": 42}
 => {"bar": 9001, "baz": 42}
 
 jq \'del(\.[1, 2])\'
-   [["foo", "bar", "baz"]]
+   ["foo", "bar", "baz"]
 => ["foo"]
 .
 .fi
@@ -646,7 +770,7 @@ jq \'del(\.[1, 2])\'
 These functions convert between an object and an array of key\-value pairs\. If \fBto_entries\fR is passed an object, then for each \fBk: v\fR entry in the input, the output array includes \fB{"key": k, "value": v}\fR\.
 .
 .P
-\fBfrom_entries\fR does the opposite conversion, and \fBwith_entries(foo)\fR is a shorthand for \fBto_entries | map(foo) | from_entries\fR, useful for doing some operation to all keys and values of an object\.
+\fBfrom_entries\fR does the opposite conversion, and \fBwith_entries(foo)\fR is a shorthand for \fBto_entries | map(foo) | from_entries\fR, useful for doing some operation to all keys and values of an object\. \fBfrom_entries\fR accepts key, Key, Name, value and Value as keys\.
 .
 .IP "" 4
 .
@@ -681,13 +805,17 @@ It\'s useful for filtering lists: \fB[1,2,3] | map(select(\. >= 2))\fR will give
 jq \'map(select(\. >= 2))\'
    [1,5,3,0,7]
 => [5,3,7]
+
+jq \'\.[] | select(\.id == "second")\'
+   [{"id": "first", "val": 1}, {"id": "second", "val": 2}]
+=> {"id": "second", "val": 2}
 .
 .fi
 .
 .IP "" 0
 .
-.SS "arrays, objects, iterables, booleans, numbers, strings, nulls, values, scalars"
-These built\-ins select only inputs that are arrays, objects, iterables (arrays or objects), booleans, numbers, strings, null, non\-null values, and non\-iterables, respectively\.
+.SS "arrays, objects, iterables, booleans, numbers, normals, finites, strings, nulls, values, scalars"
+These built\-ins select only inputs that are arrays, objects, iterables (arrays or objects), booleans, numbers, normal numbers, finite numbers, strings, null, non\-null values, and non\-iterables, respectively\.
 .
 .IP "" 4
 .
@@ -723,11 +851,32 @@ jq \'[1,2,empty,3]\'
 .
 .IP "" 0
 .
-.SS "map(x)"
+.SS "error(message)"
+Produces an error, just like \fB\.a\fR applied to values other than null and objects would, but with the given message as the error\'s value\.
+.
+.SS "$__loc__"
+Produces an object with a "file" key and a "line" key, with the filename and line number where \fB$__loc__\fR occurs, as values\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'try error("\e($__loc__)") catch \.\'
+   null
+=> "{\e"file\e":\e"<top\-level>\e",\e"line\e":1}"
+.
+.fi
+.
+.IP "" 0
+.
+.SS "map(x), map_values(x)"
 For any filter \fBx\fR, \fBmap(x)\fR will run that filter for each element of the input array, and produce the outputs a new array\. \fBmap(\.+1)\fR will increment each element of an array of numbers\.
 .
 .P
-\fBmap(x)\fR is equivalent to \fB[\.[] | x]\fR\. In fact, this is how it\'s defined\.
+Similarly, \fBmap_values(x)\fR will run that filter for each element, but it will return an object when an object is passed\.
+.
+.P
+\fBmap(x)\fR is equivalent to \fB[\.[] | x]\fR\. In fact, this is how it\'s defined\. Similarly, \fBmap_values(x)\fR is defined as \fB\.[] |= x\fR\.
 .
 .IP "" 4
 .
@@ -736,6 +885,10 @@ For any filter \fBx\fR, \fBmap(x)\fR will run that filter for each element of th
 jq \'map(\.+1)\'
    [1,2,3]
 => [2,3,4]
+
+jq \'map_values(\.+1)\'
+   {"a": 1, "b": 2, "c": 3}
+=> {"a": 2, "b": 3, "c": 4}
 .
 .fi
 .
@@ -792,12 +945,18 @@ jq \'add\'
 .
 .IP "" 0
 .
-.SS "any"
+.SS "any, any(condition), any(generator; condition)"
 The filter \fBany\fR takes as input an array of boolean values, and produces \fBtrue\fR as output if any of the the elements of the array is \fBtrue\fR\.
 .
 .P
 If the input is an empty array, \fBany\fR returns \fBfalse\fR\.
 .
+.P
+The \fBany(condition)\fR form applies the given condition to the elements of the input array\.
+.
+.P
+The \fBany(generator; condition)\fR form applies the given condition to all the outputs of the given generator\.
+.
 .IP "" 4
 .
 .nf
@@ -818,10 +977,16 @@ jq \'any\'
 .
 .IP "" 0
 .
-.SS "all"
+.SS "all, all(condition), all(generator; condition)"
 The filter \fBall\fR takes as input an array of boolean values, and produces \fBtrue\fR as output if all of the the elements of the array are \fBtrue\fR\.
 .
 .P
+The \fBall(condition)\fR form applies the given condition to the elements of the input array\.
+.
+.P
+The \fBall(generator; condition)\fR form applies the given condition to all the outputs of the given generator\.
+.
+.P
 If the input is an empty array, \fBall\fR returns \fBtrue\fR\.
 .
 .IP "" 4
@@ -844,7 +1009,7 @@ jq \'all\'
 .
 .IP "" 0
 .
-.SS "flatten, flatten(depth)"
+.SS "[Requires 1\.5] flatten, flatten(depth)"
 The filter \fBflatten\fR takes as input an array of nested arrays, and produces a flat array in which all arrays inside the original array have been recursively replaced by their values\. You can pass an argument to it to specify how many levels of nesting to flatten\.
 .
 .P
@@ -874,11 +1039,17 @@ jq \'flatten\'
 .
 .IP "" 0
 .
-.SS "range(upto),range(from;upto)`"
+.SS "range(upto), range(from;upto) range(from;upto;by)"
 The \fBrange\fR function produces a range of numbers\. \fBrange(4;10)\fR produces 6 numbers, from 4 (inclusive) to 10 (exclusive)\. The numbers are produced as separate outputs\. Use \fB[range(4;10)]\fR to get a range as an array\.
 .
 .P
-Its first argument can be omitted; it defaults to zero\.
+The one argument form generates numbers from 0 to the given number, with an increment of 1\.
+.
+.P
+The two argument form generates numbers from \fBfrom\fR to \fBupto\fR with an increment of 1\.
+.
+.P
+The three argument form generates numbers \fBfrom\fR to \fBupto\fR with an increment of \fBby\fR\.
 .
 .IP "" 4
 .
@@ -895,6 +1066,18 @@ jq \'[range(2;4)]\'
 jq \'[range(4)]\'
    null
 => [0,1,2,3]
+
+jq \'[range(0;10;3)]\'
+   null
+=> [0,3,6,9]
+
+jq \'[range(0;10;\-1)]\'
+   null
+=> []
+
+jq \'[range(0;\-5;\-1)]\'
+   null
+=> [0,\-1,\-2,\-3,\-4]
 .
 .fi
 .
@@ -975,7 +1158,32 @@ jq \'map(type)\'
 .
 .IP "" 0
 .
-.SS "sort, sort(path_expression), sort_by(path_expression)"
+.SS "infinite, nan, isinfinite, isnan, isfinite, isnormal"
+Some arithmetic operations can yield infinities and "not a number" (NaN) values\. The \fBisinfinite\fR builtin returns \fBtrue\fR if its input is infinite\. The \fBisnan\fR builtin returns \fBtrue\fR if its input is a NaN\. The \fBinfinite\fR builtin returns a positive infinite value\. The \fBnan\fR builtin returns a NaN\. The \fBisnormal\fR builtin returns true if its input is a normal number\.
+.
+.P
+Note that division by zero raises an error\.
+.
+.P
+Currently most arithmetic operations operating on infinities, NaNs, and sub\-normals do not raise errors\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'\.[] | (infinite * \.) < 0\'
+   [\-1, 1]
+=> true, false
+
+jq \'infinite, nan | type\'
+   null
+=> "number", "number"
+.
+.fi
+.
+.IP "" 0
+.
+.SS "sort, sort_by(path_expression)"
 The \fBsort\fR functions sorts its input, which must be an array\. Values are sorted in the following order:
 .
 .IP "\(bu" 4
@@ -1008,10 +1216,7 @@ The ordering for objects is a little complex: first they\'re compared by compari
 \fBsort\fR may be used to sort by a particular field of an object, or by applying any jq filter\.
 .
 .P
-\fBsort(foo)\fR compares two elements by comparing the result of \fBfoo\fR on each element\.
-.
-.P
-\fBsort_by(foo)\fR is an alias of \fBsort(foo)\fR; \fBsort_by()\fR is \fIdeprecated\fR and will be removed in the next major release\.
+\fBsort_by(foo)\fR compares two elements by comparing the result of \fBfoo\fR on each element\.
 .
 .IP "" 4
 .
@@ -1021,7 +1226,7 @@ jq \'sort\'
    [8,3,null,6]
 => [null,3,6,8]
 
-jq \'sort(\.foo)\'
+jq \'sort_by(\.foo)\'
    [{"foo":4, "bar":10}, {"foo":3, "bar":100}, {"foo":2, "bar":1}]
 => [{"foo":2, "bar":1}, {"foo":3, "bar":100}, {"foo":4, "bar":10}]
 .
@@ -1029,20 +1234,17 @@ jq \'sort(\.foo)\'
 .
 .IP "" 0
 .
-.SS "group(path_expression), group_by(path_expression)"
-\fBgroup(\.foo)\fR takes as input an array, groups the elements having the same \fB\.foo\fR field into separate arrays, and produces all of these arrays as elements of a larger array, sorted by the value of the \fB\.foo\fR field\.
+.SS "group_by(path_expression)"
+\fBgroup_by(\.foo)\fR takes as input an array, groups the elements having the same \fB\.foo\fR field into separate arrays, and produces all of these arrays as elements of a larger array, sorted by the value of the \fB\.foo\fR field\.
 .
 .P
 Any jq expression, not just a field access, may be used in place of \fB\.foo\fR\. The sorting order is the same as described in the \fBsort\fR function above\.
 .
-.P
-\fBgroup_by(foo)\fR is an alias of \fBgroup(foo)\fR; \fBgroup_by()\fR is \fIdeprecated\fR and will be removed in the next major release\.
-.
 .IP "" 4
 .
 .nf
 
-jq \'group(\.foo)\'
+jq \'group_by(\.foo)\'
    [{"foo":1, "bar":10}, {"foo":3, "bar":100}, {"foo":1, "bar":1}]
 => [[{"foo":1, "bar":10}, {"foo":1, "bar":1}], [{"foo":3, "bar":100}]]
 .
@@ -1050,11 +1252,11 @@ jq \'group(\.foo)\'
 .
 .IP "" 0
 .
-.SS "min, max, min(path_exp), max(path_exp), min_by(path_exp), max_by(path_exp)"
-Find the minimum or maximum element of the input array\. This filter accepts an optional argument that allows you to specify a particular field or property to examine, e\.g\. \fBmin(\.foo)\fR finds the object with the smallest \fBfoo\fR field\.
+.SS "min, max, min_by(path_exp), max_by(path_exp)"
+Find the minimum or maximum element of the input array\.
 .
 .P
-For legacy reasons, \fBmin_by(\.foo)\fR and \fBmax_by(\.foo)\fR exist as aliases for \fBmin(\.foo)\fR and \fBmax(\.foo)\fR\. These aliases are considered \fIdeprecated\fR and will be removed in the next major release\.
+The \fBmin_by(path_exp)\fR and \fBmax_by(path_exp)\fR functions allow you to specify a particular field or property to examine, e\.g\. \fBmin_by(\.foo)\fR finds the object with the smallest \fBfoo\fR field\.
 .
 .IP "" 4
 .
@@ -1064,7 +1266,7 @@ jq \'min\'
    [5,4,2,7]
 => 2
 
-jq \'max(\.foo)\'
+jq \'max_by(\.foo)\'
    [{"foo":1, "bar":14}, {"foo":2, "bar":3}]
 => {"foo":2, "bar":3}
 .
@@ -1072,11 +1274,11 @@ jq \'max(\.foo)\'
 .
 .IP "" 0
 .
-.SS "unique, unique(path_exp), unique_by(path_exp)"
-The \fBunique\fR function takes as input an array and produces an array of the same elements, in sorted order, with duplicates removed\. If an optional argument is passed, it will keep only one element for each value obtained by applying the argument\. Think of it as making an array by taking one element out of every group produced by \fBgroup\fR\.
+.SS "unique, unique_by(path_exp)"
+The \fBunique\fR function takes as input an array and produces an array of the same elements, in sorted order, with duplicates removed\.
 .
 .P
-For legacy reasons, \fBunique_by(\.foo)\fR exists as an alias for \fBunique(\.foo)\fR\. This alias is considered \fIdeprecated\fR and will be removed in the next major release\.
+The \fBunique_by(path_exp)\fR function will keep only one element for each value obtained by applying the argument\. Think of it as making an array by taking one element out of every group produced by \fBgroup\fR\.
 .
 .IP "" 4
 .
@@ -1086,13 +1288,13 @@ jq \'unique\'
    [1,2,5,3,5,3,1,3]
 => [1,2,3,5]
 
-jq \'unique(\.foo)\'
+jq \'unique_by(\.foo)\'
    [{"foo": 1, "bar": 2}, {"foo": 1, "bar": 3}, {"foo": 4, "bar": 5}]
 => [{"foo": 1, "bar": 2}, {"foo": 4, "bar": 5}]
 
-jq \'unique(length)\'
+jq \'unique_by(length)\'
    ["chunky", "bacon", "kitten", "cicada", "asparagus"]
-=> ["chunky", "bacon", "asparagus"]
+=> ["bacon", "chunky", "asparagus"]
 .
 .fi
 .
@@ -1114,7 +1316,7 @@ jq \'reverse\'
 .IP "" 0
 .
 .SS "contains(element)"
-The filter \fBcontains(b)\fR will produce true if b is completely contained within the input\. A string B is contained in a string A if B is a substring of A\. An array B is contained in an array A is all elements in B are contained in any element in A\. An object B is contained in object A if all of the values in B are contained in the value in A with the same key\. All other types are assumed to be contained in each other if they are equal\.
+The filter \fBcontains(b)\fR will produce true if b is completely contained within the input\. A string B is contained in a string A if B is a substring of A\. An array B is contained in an array A if all elements in B are contained in any element in A\. An object B is contained in object A if all of the values in B are contained in the value in A with the same key\. All other types are assumed to be contained in each other if they are equal\.
 .
 .IP "" 4
 .
@@ -1178,7 +1380,7 @@ jq \'index(", ")\'
    "a,b, cd, efg, hijk"
 => 3
 
-jq \'rindex(", ")]\'
+jq \'rindex(", ")\'
    "a,b, cd, efg, hijk"
 => 12
 .
@@ -1186,6 +1388,37 @@ jq \'rindex(", ")]\'
 .
 .IP "" 0
 .
+.SS "inside"
+The filter \fBinside(b)\fR will produce true if the input is completely contained within b\. It is, essentially, an inversed version of \fBcontains\fR\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'inside("foobar")\'
+   "bar"
+=> true
+
+jq \'inside(["foobar", "foobaz", "blarp"])\'
+   ["baz", "bar"]
+=> true
+
+jq \'inside(["foobar", "foobaz", "blarp"])\'
+   ["bazzzzz", "bar"]
+=> false
+
+jq \'inside({"foo": 12, "bar":[1,2,{"barp":12, "blip":13}]})\'
+   {"foo": 12, "bar": [{"barp": 12}]}
+=> true
+
+jq \'inside({"foo": 12, "bar":[1,2,{"barp":12, "blip":13}]})\'
+   {"foo": 12, "bar": [{"barp": 15}]}
+=> false
+.
+.fi
+.
+.IP "" 0
+.
 .SS "startswith(str)"
 Outputs \fBtrue\fR if \. starts with the given string argument\.
 .
@@ -1210,7 +1443,26 @@ Outputs \fBtrue\fR if \. ends with the given string argument\.
 
 jq \'[\.[]|endswith("foo")]\'
    ["foobar", "barfoo"]
-=> [false, true, true, false, false]
+=> [false, true]
+.
+.fi
+.
+.IP "" 0
+.
+.SS "combinations, combinations(n)"
+Outputs all combinations of the elements of the arrays in the input array\. If given an argument \fBn\fR, it outputs all combinations of \fBn\fR repetitions of the input array\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'combinations\'
+   [[1,2], [3, 4]]
+=> [1, 3], [1, 4], [2, 3], [2, 4]
+
+jq \'combinations(2)\'
+   [0, 1]
+=> [0, 0], [0, 1], [1, 0], [1, 1]
 .
 .fi
 .
@@ -1232,7 +1484,7 @@ jq \'[\.[]|ltrimstr("foo")]\'
 .IP "" 0
 .
 .SS "rtrimstr(str)"
-Outputs its input with the given suffix string removed, if it starts with it\.
+Outputs its input with the given suffix string removed, if it ends with it\.
 .
 .IP "" 4
 .
@@ -1284,8 +1536,8 @@ Splits an input string on the separator argument\.
 .nf
 
 jq \'split(", ")\'
-   "a, b,c,d, e"
-=> ["a","b,c,d","e"]
+   "a, b,c,d, e, "
+=> ["a","b,c,d","e",""]
 .
 .fi
 .
@@ -1306,7 +1558,46 @@ jq \'join(", ")\'
 .
 .IP "" 0
 .
-.SS "recurse(f), recurse, recurse_down"
+.SS "ascii_downcase, ascii_upcase"
+Emit a copy of the input string with its alphabetic characters (a\-z and A\-Z) converted to the specified case\.
+.
+.SS "while(cond; update)"
+The \fBwhile(cond; update)\fR function allows you to repeatedly apply an update to \fB\.\fR until \fBcond\fR is false\.
+.
+.P
+Note that \fBwhile(cond; update)\fR is internally defined as a recursive jq function\. Recursive calls within \fBwhile\fR will not consume additional memory if \fBupdate\fR produces at most one output for each input\. See advanced topics below\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'[while(\.<100; \.*2)]\'
+   1
+=> [1,2,4,8,16,32,64]
+.
+.fi
+.
+.IP "" 0
+.
+.SS "until(cond; next)"
+The \fBuntil(cond; next)\fR function allows you to repeatedly apply the expression \fBnext\fR, initially to \fB\.\fR then to its own output, until \fBcond\fR is true\. For example, this can be used to implement a factorial function (see below)\.
+.
+.P
+Note that \fBuntil(cond; next)\fR is internally defined as a recursive jq function\. Recursive calls within \fBuntil()\fR will not consume additional memory if \fBnext\fR produces at most one output for each input\. See advanced topics below\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'[\.,1]|until(\.[0] < 1; [\.[0] \- 1, \.[1] * \.[0]])|\.[1]\'
+   4
+=> 24
+.
+.fi
+.
+.IP "" 0
+.
+.SS "recurse(f), recurse, recurse(f; condition), recurse_down"
 The \fBrecurse(f)\fR function allows you to search through a recursive structure, and extract interesting data from all levels\. Suppose your input represents a filesystem:
 .
 .IP "" 4
@@ -1342,8 +1633,17 @@ recurse(\.children[]) | \.name
 When called without an argument, \fBrecurse\fR is equivalent to \fBrecurse(\.[]?)\fR\.
 .
 .P
+\fBrecurse(f)\fR is identical to \fBrecurse(f; \. != null)\fR and can be used without concerns about recursion depth\.
+.
+.P
+\fBrecurse(f; condition)\fR is a generator which begins by emitting \. and then emits in turn \.|f, \.|f|f, \.|f|f|f, \.\.\. so long as the computed value satisfies the condition\. For example, to generate all the integers, at least in principle, one could write \fBrecurse(\.+1; true)\fR\.
+.
+.P
 For legacy reasons, \fBrecurse_down\fR exists as an alias to calling \fBrecurse\fR without arguments\. This alias is considered \fIdeprecated\fR and will be removed in the next major release\.
 .
+.P
+The recursive calls in \fBrecurse\fR will not consume additional memory whenever \fBf\fR produces at most a single output for each input\.
+.
 .IP "" 4
 .
 .nf
@@ -1354,7 +1654,11 @@ jq \'recurse(\.foo[])\'
 
 jq \'recurse\'
    {"a":0,"b":[1]}
-=> 0, [1], 1
+=> {"a":0,"b":[1]}, 0, [1], 1
+
+jq \'recurse(\. * \.; \. < 20)\'
+   2
+=> 2, 4, 16
 .
 .fi
 .
@@ -1390,6 +1694,44 @@ jq \'env\.PAGER\'
 .
 .IP "" 0
 .
+.SS "transpose"
+Transpose a possibly jagged matrix (an array of arrays)\. Rows are padded with nulls so the result is always rectangular\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'transpose\'
+   [[1], [2,3]]
+=> [[1,2],[null,3]]
+.
+.fi
+.
+.IP "" 0
+.
+.SS "bsearch(x)"
+bsearch(x) conducts a binary search for x in the input array\. If the input is sorted and contains x, then bsearch(x) will return its index in the array; otherwise, if the array is sorted, it will return (\-1 \- ix) where ix is an insertion point such that the array would still be sorted after the insertion of x at ix\. If the array is not sorted, bsearch(x) will return an integer that is probably of no interest\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'bsearch(0)\'
+   [0,1]
+=> 0
+
+jq \'bsearch(0)\'
+   [1,2,3]
+=> \-1
+
+jq \'bsearch(4) as $ix | if $ix < 0 then \.[\-(1+$ix)] = 4 else \. end\'
+   [1,2,3]
+=> [1,2,3,4]
+.
+.fi
+.
+.IP "" 0
+.
 .SS "String interpolation \- \e(foo)"
 Inside a string, you can put an expression inside parens after a backslash\. Whatever the expression returns will be interpolated into the string\.
 .
@@ -1453,7 +1795,7 @@ Applies HTML/XML escaping, by mapping the characters \fB<>&\'"\fR to their entit
 \fB@uri\fR:
 .
 .IP
-Applies percent\-encoding, by mapping all reserved URI characters to a \fB%xx\fR sequence\.
+Applies percent\-encoding, by mapping all reserved URI characters to a \fB%XX\fR sequence\.
 .
 .TP
 \fB@csv\fR:
@@ -1462,6 +1804,12 @@ Applies percent\-encoding, by mapping all reserved URI characters to a \fB%xx\fR
 The input must be an array, and it is rendered as CSV with double quotes for strings, and quotes escaped by repetition\.
 .
 .TP
+\fB@tsv\fR:
+.
+.IP
+The input must be an array, and it is rendered as TSV (tab\-separated values)\. Each input array will be printed as a single line\. Fields are separated by a single tab (ascii \fB0x09\fR)\. Input characters line\-feed (ascii \fB0x0a\fR), carriage\-return (ascii \fB0x0d\fR), tab (ascii \fB0x09\fR) and backslash (ascii \fB0x5c\fR) will be output as escape sequences \fB\en\fR, \fB\er\fR, \fB\et\fR, \fB\e\e\fR respectively\.
+.
+.TP
 \fB@sh\fR:
 .
 .IP
@@ -1493,7 +1841,7 @@ will produce the following output for the input \fB{"search":"what is jq?"}\fR:
 .
 .nf
 
-"http://www\.google\.com/search?q=what%20is%20jq%3f"
+"http://www\.google\.com/search?q=what%20is%20jq%3F"
 .
 .fi
 .
@@ -1518,6 +1866,62 @@ jq \'@sh "echo \e(\.)"\'
 .
 .IP "" 0
 .
+.SS "Dates"
+jq provides some basic date handling functionality, with some high\-level and low\-level builtins\. In all cases these builtins deal exclusively with time in UTC\.
+.
+.P
+The \fBfromdateiso8601\fR builtin parses datetimes in the ISO 8601 format to a number of seconds since the Unix epoch (1970\-01\-01T00:00:00Z)\. The \fBtodateiso8601\fR builtin does the inverse\.
+.
+.P
+The \fBfromdate\fR builtin parses datetime strings\. Currently \fBfromdate\fR only supports ISO 8601 datetime strings, but in the future it will attempt to parse datetime strings in more formats\.
+.
+.P
+The \fBtodate\fR builtin is an alias for \fBtodateiso8601\fR\.
+.
+.P
+The \fBnow\fR builtin outputs the current time, in seconds since the Unix epoch\.
+.
+.P
+Low\-level jq interfaces to the C\-library time functions are also provided: \fBstrptime\fR, \fBstrftime\fR, \fBmktime\fR, and \fBgmtime\fR\. Refer to your host operating system\'s documentation for the format strings used by \fBstrptime\fR and \fBstrftime\fR\. Note: these are not necessarily stable interfaces in jq, particularly as to their localization functionality\.
+.
+.P
+The \fBgmtime\fR builtin consumes a number of seconds since the Unix epoch and outputs a "broken down time" representation of time as an array of numbers representing (in this order): the year, the month (zero\-based), the day of the month, the hour of the day, the minute of the hour, the second of the minute, the day of the week, and the day of the year \-\- all one\-based unless otherwise stated\.
+.
+.P
+The \fBmktime\fR builtin consumes "broken down time" representations of time output by \fBgmtime\fR and \fBstrptime\fR\.
+.
+.P
+The \fBstrptime(fmt)\fR builtin parses input strings matching the \fBfmt\fR argument\. The output is in the "broken down time" representation consumed by \fBgmtime\fR and output by \fBmktime\fR\.
+.
+.P
+The \fBstrftime(fmt)\fR builtin formats a time with the given format\.
+.
+.P
+The format strings for \fBstrptime\fR and \fBstrftime\fR are described in typical C library documentation\. The format string for ISO 8601 datetime is \fB"%Y\-%m\-%dT%H:%M:%SZ"\fR\.
+.
+.P
+jq may not support some or all of this date functionality on some systems\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'fromdate\'
+   "2015\-03\-05T23:51:47Z"
+=> 1425599507
+
+jq \'strptime("%Y\-%m\-%dT%H:%M:%SZ")\'
+   "2015\-03\-05T23:51:47Z"
+=> [2015,2,5,23,51,47,4,63]
+
+jq \'strptime("%Y\-%m\-%dT%H:%M:%SZ")|mktime\'
+   "2015\-03\-05T23:51:47Z"
+=> 1425599507
+.
+.fi
+.
+.IP "" 0
+.
 .SH "CONDITIONALS AND COMPARISONS"
 .
 .SS "==, !="
@@ -1650,6 +2054,298 @@ jq \'\.foo // 42\'
 .
 .IP "" 0
 .
+.SS "try\-catch"
+Errors can be caught by using \fBtry EXP catch EXP\fR\. The first expression is executed, and if it fails then the second is executed with the error message\. The output of the handler, if any, is output as if it had been the output of the expression to try\.
+.
+.P
+The \fBtry EXP\fR form uses \fBempty\fR as the exception handler\.
+.
+.IP "" 4
+.
+.nf
+
+jq \'try \.a catch "\. is not an object"\'
+   true
+=> "\. is not an object"
+
+jq \'[\.[]|try \.a]\'
+   [{}, true, {"a":1}]
+=> [null, 1]
+
+jq \'try error("some exception") catch \.\'
+   true
+=> "some exception"
+.
+.fi
+.
+.IP "" 0
+.
+.SS "Breaking out of control structures"
+A convenient use of try/catch is to break out of control structures like \fBreduce\fR, \fBforeach\fR, \fBwhile\fR, and so on\.
+.
+.P
+For example:
+.
+.IP "" 4
+.
+.nf
+
+# Repeat an expression until it raises "break" as an
+# error, then stop repeating without re\-raising the error\.
+# But if the error caught is not "break" then re\-raise it\.
+try repeat(exp) catch \.=="break" then empty else error;
+.
+.fi
+.
+.IP "" 0
+.
+.P
+jq has a syntax for named lexical labels to "break" or "go (back) to":
+.
+.IP "" 4
+.
+.nf
+
+label $out | \.\.\. break $out \.\.\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The \fBbreak $label_name\fR expression will cause the program to to act as though the nearest (to the left) \fBlabel $label_name\fR produced \fBempty\fR\.
+.
+.P
+The relationship between the \fBbreak\fR and corresponding \fBlabel\fR is lexical: the label has to be "visible" from the break\.
+.
+.P
+To break out of a \fBreduce\fR, for example:
+.
+.IP "" 4
+.
+.nf
+
+label $out | reduce \.[] as $item (null; if \.==false then break $out else \.\.\. end)