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 ] [ -p ]
10 [ -e ] [ -m ] [ -n <[first-]cnt> ] [ -Q ] [ -s <stemming language> ] [
11 -S <fldname> ] [ -D ] [ -i <additional index directory> ] [ -F <quoted
12 space separated field name list> ] [ --extract-to <file path> ] <query
13 string>
14 recollq -P
16
19 The recollq command will execute the Recoll query specified on the com‐
20 mand line and print the results to the standard output. It is primarily
21 designed for diagnostics, or piping the data to some other program. The
22 basic format and its variations can be useful for command line query‐
23 ing. The -F option should exclusively be used for using the output data
24 in another program, as it is the only one for which output is guaran‐
25 teed to be fully parseable.
26 The -c option specifies the configuration directory name, overriding
28 the default or $RECOLL_CONFDIR.
29 The query string is built by concatenating all arguments found at the
31 end of the command line (after the options). It will be interpreted by
32 default as a query language string. Quoting should be used as needed to
33 escape characters that might be interpreted by the shell (ie: wild‐
34 cards). -a is specified, the query string will be interpreted as an
35 all words simple search query. If -o is specified, the query string
36 will be interpreted as an any word simple search query. If -f is speci‐
37 fied, the query string will be interpreted as a file name simple search
38 query.
39 -b (basic) can be specified to only print the result urls in the output
41 stream.
42 If -d is set, the text for the result files contents will be dumped to
44 stdout.
45 If -m is set, the whole metadata array will be dumped for each docu‐
47 ment.
48 If -A is set, the document abstracts will be printed. With an addi‐
50 tional -p option, snippets with page numbers (when available) will be
51 shown instead.
52 -S <fieldname> sorts the results according to the specified field. Use
54 -D for descending order.
55 -n <[first-]cnt> can be used to set the maximum number of results that
57 should be printed. The default is 2000. Use a value of 0 for no limit.
58 If the argument is of the form first-cnt, it also defines the first re‐
59 sult to output (from 0).
60 -s <language> selects the word stemming language. The value should
62 match an existing stemming database (as set in the configuration or
63 added with recollindex -s).
64 -i <extra dbdir> adds the specified Xapian index to the set used for
66 the query. Can be specified multiple times.
67 -F <space separated field list> (one argument, e.g. "author title")
69 should be used for piping the data to another program. After 2 initial
70 lines showing the actual query and the estimated result counts, it will
71 print one line for each result document. Each line will have exactly
72 the fields requested on the command line. Fields are encoded in base64
73 and separated by one space character. Empty fields are indicated by
74 consecutive space characters. There is one additional space character
75 at the end of each line.
76 --extract-to <file path> Will extract the first result document of the
78 query to the argument path, which must not exist. Use -n first-cnt to
79 select the document.
80 recollq -P (Period) will print the minimum and maximum modification
82 years for documents in the index.
83
86 recollindex(1) recollq(1) recoll.conf(5)
87 13 November 2007 RECOLLQ(1)