recollq(1)

1RECOLLQ(1)                  General Commands Manual                 RECOLLQ(1)
2
3
4

NAME

6       recollq - command line / standard output Recoll query command.
7

SYNOPSIS

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> ] <query string>
13
14       recollq -P
15
16

DESCRIPTION

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
26       The -c option specifies the configuration  directory  name,  overriding
27       the default or $RECOLL_CONFDIR.
28
29       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
39       -b (basic) can be specified to only print the result urls in the output
40       stream.
41
42       If -d is set, the text for the result files contents will be dumped  to
43       stdout.
44
45       If  -m  is  set, the whole metadata array will be dumped for each docu‐
46       ment.
47
48       If -A is set, the document abstracts will be  printed.  With  an  addi‐
49       tional  -p  option, snippets with page numbers (when available) will be
50       shown instead.
51
52       -S <fieldname> sorts the results according to the specified field.  Use
53       -D for descending order.
54
55       -n  <cnt>  can be used to set the maximum number of results that should
56       be printed. The default is 2000. Use a value of 0 for no limit.
57
58       -s <language> selects the word  stemming  language.  The  value  should
59       match  an  existing  stemming  database (as set in the configuration or
60       added with recollindex -s).
61
62       -i <extra dbdir> adds the specified Xapian index to the  set  used  for
63       the query. Can be specified multiple times.
64
65       -F  <space  separated  field  list> (one argument, e.g. "author title")
66       should be used for piping the data to another program. After 2  initial
67       lines showing the actual query and the estimated result counts, it will
68       print one line for each result document. Each line  will  have  exactly
69       the  fields requested on the command line. Fields are encoded in base64
70       and separated by one space character. Empty  fields  are  indicated  by
71       consecutive  space  characters. There is one additional space character
72       at the end of each line.
73
74       recollq -P (Period) will print the  minimum  and  maximum  modification
75       years for documents in the index.
76
77

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO