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

NAME

6       recollindex - indexing command for the Recoll full text search system
7

SYNOPSIS

9       recollindex -h
10       recollindex  [ -c <configdir> ] [ -z ] [ -m ] [ -w <seconds> ] [ -D ] [
11       -x ]
12       recollindex [ -c <configdir> ] -i [ -f ] [<filename [filename ...]>]
13       recollindex [ -c <configdir> ] -e [<filename [filename ...]>]
14       recollindex [ -c <configdir> ] -l
15       recollindex [ -c <configdir> ] -s <lang>
16       recollindex [ -c <configdir> ] -S
17
18

DESCRIPTION

20       The recollindex utility allows you to perform indexing  operations  for
21       the Recoll text search system.
22
23       The  -c  option  specifies the configuration directory name, overriding
24       the default or $RECOLL_CONFDIR.
25
26       There are several modes of operation.
27
28       The normal mode will index the set of files described in the configura‐
29       tion  file  recoll.conf.   This  will incrementally update the database
30       with files that changed since the last run. If option -z is given,  the
31       database will be erased before starting.
32
33       If option -m is given, recollindex is started for real time monitoring,
34       using the file system monitoring package it was configured for  (either
35       fam, gamin, or inotify). This mode must have been explicitly configured
36       when building the package, it is not available by default. The  program
37       will normally detach from the controlling terminal and become a daemon.
38       If option -D is given, it will stay in the foreground. Option -w  <sec‐
39       onds>  can  be  used  to  specify that the program should sleep for the
40       specified time before indexing begins. The default  value  is  60.  The
41       daemon  normally  monitors  the X11 session and exits when it is reset.
42       Option -x disables this X11 session monitoring (daemon will stay  alive
43       even if it cannot connect to the X11 server).
44
45       recollindex -l will list the names of available language stemmers.
46
47       recollindex  -i will index individual files into the database. The stem
48       expansion and aspell databases will not be  updated.  The  skippedPaths
49       and  skippedNames  configuration  variables  will be used, so that some
50       files may be skipped. You can tell recollindex to  ignore  skippedPaths
51       and  skippedNames  by  setting  the -f option. This allows fully custom
52       file selection for a given subtree, for which you  would  add  the  top
53       directory to skippedPaths, and use any custom tool to generate the file
54       list (ie: a tool from a source code control system).
55
56       recollindex -e will erase data for individual files from the  database.
57       The stem expansion databases will not be updated.
58
59       With options -i or -e , if no file names are given on the command line,
60       they will be read from stdin, so that you could for example run:
61
62       find /path/to/dir -print | recollindex -e
63
64       followed by
65
66       find /path/to/dir -print | recollindex -i
67
68       to force the reindexing of a directory tree (which has to exist  inside
69       the file system area defined by topdirs in recoll.conf).
70
71       recollindex  -s will build the stem expansion database for a given lan‐
72       guage, which may or may not be part of the list  in  the  configuration
73       file. If the language is not part of the configuration, the stem expan‐
74       sion database will be deleted at the end of the  next  normal  indexing
75       run. You can get the list of stemmer names from the recollindex -l com‐
76       mand. Note that this is mostly for experimental use, the normal way  to
77       add  a  stemming  language is to set it in the configuration, either by
78       editing "recoll.conf" or by using the GUI indexing  configuration  dia‐
79       log.
80       At  the  time  of  this writing, the following languages are recognized
81       (out of Xapian's stem.h):
82
83       ·      danish
84
85       ·      dutch
86
87       ·      english Martin Porter's 2002 revision of his stemmer
88
89       ·      english_lovins Lovin's stemmer
90
91       ·      english_porter Porter's stemmer as described in his 1980 paper
92
93       ·      finnish
94
95       ·      french
96
97       ·      german
98
99       ·      italian
100
101       ·      norwegian
102
103       ·      portuguese
104
105       ·      russian
106
107       ·      spanish
108
109       ·      swedish
110
111       recollindex -S will rebuild the phonetic/orthographic index. This  fea‐
112       ture uses the aspell package, which must be installed on the system.
113
114

SEE ALSO

116       recoll(1) recoll.conf(5)
117
118
119
120                                8 January 2006                  RECOLLINDEX(1)
Impressum