--- a/src/doc/man/recollq.1
+++ b/src/doc/man/recollq.1
@@ -25,11 +25,17 @@
.B \-A
]
[
+.B \-e
+]
+[
.B \-m
]
[
.B \-n
<cnt>
+]
+[
+.B \-Q
]
[
.B \-s
@@ -46,6 +52,10 @@
.B \-i
<additional index directory>
]
+[
+.B \-F
+<space separated field name list>
+]
<query string>
.B recollq \-P
@@ -54,15 +64,21 @@
The
.B recollq
command will execute the Recoll query specified on the command line and
-print the results to the standard output.
+print the results to the standard output. It is primarily designed for
+diagnostics, or piping the data to some other program. The basic format and
+its variations can be useful for command line querying. The -F option
+should exclusively be used for using the output data in another program, as
+it is the only one for which output is guaranteed to be fully parseable.
.PP
The
.B \-c
option specifies the configuration directory name, overriding the
default or $RECOLL_CONFDIR.
.PP
-The query string will be interpreted by default as a query language string.
-If
+The query string is built by concatenating all arguments found at the end
+of the command line (after the options). It will be interpreted by default
+as a query language string. Quoting should be used as needed to escape
+characters that might be interpreted by the shell (ie: wildcards).
.B \-a
is specified, the query string will be interpreted as an
.I all words
@@ -100,7 +116,8 @@
.PP
.B \-n
<cnt>
-can be used to set the maximum number of results that should be printed.
+can be used to set the maximum number of results that should be
+printed. The default is 2000. Use a value of 0 for no limit.
.PP
.B \-s
<language>
@@ -111,6 +128,16 @@
<extra dbdir>
adds the specified Xapian index to the set used for the query. Can be
specified multiple times.
+.PP
+.B \-F
+<space separated field list>
+should be used for piping the data to another program. After 2 initial
+lines showing the actual query and the estimated result counts, it will
+print one line for each result document. Each line will have
+exactly the fields requested on the command line. Fields are encoded in
+base64 and separated by one space character. Empty fields are indicated by
+consecutive space characters. There is one additional space character at
+the end of each line.
.PP
.B recollq \-P
(Period) will print the minimum and maximum modification years for