From 7d30b7d5536e7e35ad2184ccff0b1be371b35d47 Mon Sep 17 00:00:00 2001
From: Jean-Francois Dockes <jfd@recoll.org>
Date: Fri, 25 Nov 2011 15:01:13 +0100
Subject: [PATCH] man: recollq update + user manual typo

---
 src/doc/man/recollq.1        | 35 +++++++++++++++++++++++++++++++----
 src/doc/user/usermanual.sgml |  2 +-
 2 files changed, 32 insertions(+), 5 deletions(-)

diff --git a/src/doc/man/recollq.1 b/src/doc/man/recollq.1
index 4634bc61..6651a713 100644
--- a/src/doc/man/recollq.1
+++ b/src/doc/man/recollq.1
@@ -25,6 +25,9 @@ recollq \- command line / standard output Recoll query command.
 .B \-A
 ]
 [
+.B \-e
+]
+[
 .B \-m
 ]
 [
@@ -32,6 +35,9 @@ recollq \- command line / standard output Recoll query command.
 <cnt>
 ]
 [
+.B \-Q
+]
+[
 .B \-s
 <stemming language>
 ]
@@ -46,6 +52,10 @@ recollq \- command line / standard output Recoll query command.
 .B \-i
 <additional index directory>
 ]
+[
+.B \-F
+<space separated field name list>
+]
 <query string>
 
 .B recollq \-P
@@ -54,15 +64,21 @@ recollq \- command line / standard output Recoll query command.
 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 @@ for descending order.
 .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 @@ stemming database (as set in the configuration or added with recollindex \-s).
 <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
diff --git a/src/doc/user/usermanual.sgml b/src/doc/user/usermanual.sgml
index c11e625e..a3e258a4 100644
--- a/src/doc/user/usermanual.sgml
+++ b/src/doc/user/usermanual.sgml
@@ -2390,7 +2390,7 @@ text/html       [file:///Users/uncrypted-dockes/projets/bateaux/ilur/factEtCie/r
        mime type.</para>
 
       <para>The association of file types to filters is performed in
-      the <link linkend="rcl.install.config.mimemap">
+      the <link linkend="rcl.install.config.mimeconf">
       <filename>mimeconf</filename> file</link>. A sample will probably be
       of better help than a long explanation:</para>
 <programlisting>