RECOLLINDEX(1)						      General Commands Manual						    RECOLLINDEX(1)

NAME

       recollindex - indexing command for the Recoll full text search system

SYNOPSIS

       recollindex -h
       recollindex [ -c <configdir> ] [ -z ] [ -m ] [ -w <seconds> ] [ -D ] [ -x ]
       recollindex [ -c <configdir> ] -i [ -f ] [<filename [filename ...]>]
       recollindex [ -c <configdir> ] -e [<filename [filename ...]>]
       recollindex [ -c <configdir> ] -l
       recollindex [ -c <configdir> ] -s <lang>
       recollindex [ -c <configdir> ] -S

DESCRIPTION

       The recollindex utility allows you to perform indexing operations for the Recoll text search system.

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

       There are several modes of operation.

       The  normal  mode will index the set of files described in the configuration file recoll.conf.  This will incrementally update the database
       with files that changed since the last run. If option -z is given, the database will be erased before starting.

       If option -m is given, recollindex is started for real time monitoring, using the file system monitoring  package  it  was  configured  for
       (either	fam, gamin, or inotify). This mode must have been explicitly configured when building the package, it is not available by default.
       The program will normally detach from the controlling terminal and become a daemon. If option -D is given, it will stay in the  foreground.
       Option  -w  <seconds> can be used to specify that the program should sleep for the specified time before indexing begins. The default value
       is 60. The daemon normally monitors the X11 session and exits when it is reset.	Option -x disables this  X11  session  monitoring  (daemon
       will stay alive even if it cannot connect to the X11 server). You need to use this too if you use the daemon without an X11 context.

       recollindex -l will list the names of available language stemmers.

       recollindex -i will index individual files into the database. The stem expansion and aspell databases will not be updated. The skippedPaths
       and skippedNames configuration variables will be used, so that some files may be skipped. You can tell recollindex to  ignore  skippedPaths
       and  skippedNames  by  setting  the -f option. This allows fully custom file selection for a given subtree, for which you would add the top
       directory to skippedPaths, and use any custom tool to generate the file list (ie: a tool from a source code control system).

       recollindex -e will erase data for individual files from the database. The stem expansion databases will not be updated.

       With options -i or -e , if no file names are given on the command line, they will be read from stdin, so that you could for example run:

       find /path/to/dir -print | recollindex -e

       followed by

       find /path/to/dir -print | recollindex -i

       to force the reindexing of a directory tree (which has to exist inside the file system area defined by topdirs in recoll.conf).

       recollindex -s will build the stem expansion database for a given language, which may or may not be part of the list in	the  configuration
       file.  If the language is not part of the configuration, the stem expansion database will be deleted at the end of the next normal indexing
       run. You can get the list of stemmer names from the recollindex -l command. Note that this is mostly for experimental use, the  normal  way
       to  add	a  stemming language is to set it in the configuration, either by editing "recoll.conf" or by using the GUI indexing configuration
       dialog.
       At the time of this writing, the following languages are recognized (out of Xapian's stem.h):

       o      danish

       o      dutch

       o      english Martin Porter's 2002 revision of his stemmer

       o      english_lovins Lovin's stemmer

       o      english_porter Porter's stemmer as described in his 1980 paper

       o      finnish

       o      french

       o      german

       o      italian

       o      norwegian

       o      portuguese

       o      russian

       o      spanish

       o      swedish

       recollindex -S will rebuild the phonetic/orthographic index. This feature uses the aspell package, which must be installed on the system.

SEE ALSO

       recoll(1) recoll.conf(5)

								  8 January 2006						    RECOLLINDEX(1)