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

NAME

6       recoll - user interface for the Recoll full text search system
7

SYNOPSIS

9       recoll [ -c <configdir> ] [ -o | -l | -f | -a ] [ -t ] [ -q <query> ]
10
11       recoll [ -c <configdir> ] <url>
12

DESCRIPTION

14       In  the  first  form,  the recoll command will start the graphical user
15       interface for querying the Recoll database.
16
17       On the first run, recoll will create the user configuration  which  can
18       be customized before starting the first indexation.
19
20       The  -c  option  specifies the configuration directory name, overriding
21       the default or $RECOLL_CONFDIR.
22
23       The -q option can be used to specify an initial query  on  the  command
24       line.  This  query  will  be interpreted by default as a query language
25       string.  If -a is specified, the query string will be interpreted as an
26       all  words  simple  search  query. If -o is specified, the query string
27       will be interpreted as an any word simple search query. If -f is speci‐
28       fied, the query string will be interpreted as a file name simple search
29       query. If -l is specified, the query string will be  interpreted  as  a
30       query language simple search query.
31
32       If -t is specified, or if recoll is called as recollq (through a link),
33       the Graphical User Interface will not be started, and results  will  be
34       printed  to  the  standard output. Additional options understood by the
35       recollq command may be specified in this case. These  can  control  the
36       output format and the maximum number of results to be printed.
37
38       Please refer to online help for a full description.
39
40       In  the  second  form, the recoll command can be used to start a native
41       viewer for a document indexed by Recoll. It will understand a final URL
42       fragment  (separated  by  a  '#'  character) to indicate an ipath , the
43       specifier for the part of the Recoll document access path which  is  is
44       internal  to  a  container  such as a mbox folder or a zip archive, and
45       will, if needed, create a temporary file to let a normal system utility
46       display the document.
47
48       The  second form is mostly used for opening embedded documents from the
49       Ubuntu Unity Recoll lens.
50

SEE ALSO

52       recollindex(1) recollq(1) recoll.conf(5)
53
54
55
56                                8 January 2006                       RECOLL(1)
Impressum