NAME

       recoll - user interface for the Recoll full text search system

SYNOPSIS

       recoll [ -h ] [ -c <configdir> ] [ -L <lang> ] [ -w ] [ -o | -l | -f | -a ] [ -q <query> ]

       recoll -t [ -h ] [ -c <configdir> ] [ -o | -l | -f | -a ] [ -q <query> ]

       recoll [ -c <configdir> ] <url>

DESCRIPTION

       In  the  first form, the recoll command will start the index query graphical user interface. On the first
       run, this will create the user configuration which can be customized before starting the index creation.

       In the second form (with a -t option), recoll will behave like the recollq command. It will not  start  a
       GUI,  but  will run the query and output the results to the terminal (standard output). This will also be
       the case if recoll is called as recollq through a link. Additional  options  understood  by  the  recollq
       command  may  be  specified  in  this case. These can control the output format and the maximum number of
       results to be printed.  Please refer to the command help obtained through the -t -h options,  or  to  the
       recollq manual page for a full description.

       The -c option specifies the configuration directory name, overriding the default or $RECOLL_CONFDIR.

       With  the -w option, the GUI starts minimized, which can be useful for starting it automatically with the
       desktop.  -W is similar, but will only show a system tray icon. It can only be used if  the  system  tray
       option is set in the preferences.

       The -q option can be used to specify an initial query on the command line. This query will be interpreted
       by  default  as  a query language string.  If -a is specified, the query string will be interpreted as an
       all words simple search query. If -o is specified, the query string will be interpreted as  an  any  word
       simple  search  query.  If  -f  is  specified, the query string will be interpreted as a file name simple
       search query. If -l is specified (or,  by  default,  without  any  option),  the  query  string  will  be
       interpreted as a query language simple search query.

       In  the  third  form,  the  recoll command can be used to start a native viewer for a document indexed by
       Recoll. It will understand a final URL fragment (separated by a '#' character) to indicate an ipath , the
       specifier for the part of the Recoll document access path which is internal to a container such as a mbox
       folder or a zip archive, and will, if needed, create a temporary file to  let  a  normal  system  utility
       display  the  document.  This form is mostly used for opening embedded documents from an external desktop
       search interface.

SEE ALSO

       recollindex(1) recollq(1) recoll.conf(5)

                                                 8 January 2006                                        RECOLL(1)