1RECOLLQ(1) General Commands Manual RECOLLQ(1)
2
6 recollq - command line / standard output Recoll query command.
7
9 recollq [ -c <configdir> ] [ -o | -f | -a ] [ -b ] [ -d ] [ -A ] [ -e ]
10 [ -m ] [ -n <[first-]cnt> ] [ -Q ] [ -s <stemming language> ] [ -S
11 <fldname> ] [ -D ] [ -i <additional index directory> ] [ -F <quoted
12 space separated field name list> ] <query string>
13 recollq -P
15
18 The recollq command will execute the Recoll query specified on the com‐
19 mand line and print the results to the standard output. It is primarily
20 designed for diagnostics, or piping the data to some other program. The
21 basic format and its variations can be useful for command line query‐
22 ing. The -F option should exclusively be used for using the output data
23 in another program, as it is the only one for which output is guaran‐
24 teed to be fully parseable.
25 The -c option specifies the configuration directory name, overriding
27 the default or $RECOLL_CONFDIR.
28 The query string is built by concatenating all arguments found at the
30 end of the command line (after the options). It will be interpreted by
31 default as a query language string. Quoting should be used as needed to
32 escape characters that might be interpreted by the shell (ie: wild‐
33 cards). -a is specified, the query string will be interpreted as an
34 all words simple search query. If -o is specified, the query string
35 will be interpreted as an any word simple search query. If -f is speci‐
36 fied, the query string will be interpreted as a file name simple search
37 query.
38 -b (basic) can be specified to only print the result urls in the output
40 stream.
41 If -d is set, the text for the result files contents will be dumped to
43 stdout.
44 If -m is set, the whole metadata array will be dumped for each docu‐
46 ment.
47 If -A is set, the document abstracts will be printed.
49 -S <fieldname> sorts the results according to the specified field. Use
51 -D for descending order.
52 -n <cnt> can be used to set the maximum number of results that should
54 be printed. The default is 2000. Use a value of 0 for no limit.
55 -s <language> selects the word stemming language. The value should
57 match an existing stemming database (as set in the configuration or
58 added with recollindex -s).
59 -i <extra dbdir> adds the specified Xapian index to the set used for
61 the query. Can be specified multiple times.
62 -F <space separated field list> (one argument, e.g. "author title")
64 should be used for piping the data to another program. After 2 initial
65 lines showing the actual query and the estimated result counts, it will
66 print one line for each result document. Each line will have exactly
67 the fields requested on the command line. Fields are encoded in base64
68 and separated by one space character. Empty fields are indicated by
69 consecutive space characters. There is one additional space character
70 at the end of each line.
71 recollq -P (Period) will print the minimum and maximum modification
73 years for documents in the index.
74
77 recollindex(1) recollq(1) recoll.conf(5)
78 13 November 2007 RECOLLQ(1)