1RECOLLINDEX(1) General Commands Manual RECOLLINDEX(1)
2
6 recollindex - indexing command for the Recoll full text search system
7
9 recollindex -h
10 recollindex [ -c <configdir> ] [ -z|-Z ] [ -k ]
11 recollindex [ -c <cd> ] -m [ -w <secs> ] [ -D ] [ -x ] [ -C ] [ -n|-k ]
12 recollindex [ -c <cd> ] -i [ -Z -k -f -P ] [<path [path ...]>]
13 recollindex [ -c <cd> ] -r [ -Z -K -e -f ] [ -p pattern ] <dirpath>
14 recollindex [ -c <configdir> ] -e [<path [path ...]>]
15 recollindex [ -c <configdir> ] -l
16 recollindex [ -c <configdir> ] -s <lang>
17 recollindex [ -c <configdir> ] -S
18 recollindex [ -c <configdir> ] -E
19
22 The recollindex command is the Recoll indexer.
23 As indexing can sometimes take a long time, the command can be inter‐
25 rupted by sending an interrupt (Ctrl-C, SIGINT) or terminate (SIGTERM)
26 signal. Some time may elapse before the process exits, because it needs
27 to properly flush and close the index. This can also be done from the
28 recoll GUI (menu entry: File/Stop_Indexing). After such an interrup‐
29 tion, the index will be somewhat inconsistent because some operations
30 which are normally performed at the end of the indexing pass will have
31 been skipped (for example, the stemming and spelling databases will be
32 inexistent or out of date). You just need to restart indexing at a
33 later time to restore consistency. The indexing will restart at the
34 interruption point (the full file tree will be traversed, but files
35 that were indexed up to the interruption and for which the index is
36 still up to date will not need to be reindexed).
37 The -c option specifies the configuration directory name, overriding
39 the default or $RECOLL_CONFDIR.
40 There are several modes of operation.
42 The normal mode will index the set of files described in the configura‐
44 tion file recoll.conf. This will incrementally update the database
45 with files that changed since the last run. If option -z is given, the
46 database will be erased before starting. If option -Z is given, the
47 database will not be reset, but all files will be considered as needing
48 reindexing (in place reset).
49 As of version 1.21, recollindex usually does not process again files
51 which previously failed to index (for example because of a missing
52 helper program). If option -k is given, recollindex will try again to
53 process all failed files. Please note that recollindex may also decide
54 to retry failed files if the auxiliary checking script defined by the
55 "checkneedretryindexscript" configuration variable indicates that this
56 should happen.
57 If option -m is given, recollindex is started for real time monitoring,
59 using the file system monitoring package it was configured for (either
60 fam, gamin, or inotify). This mode must have been explicitly configured
61 when building the package, it is not available by default. The program
62 will normally detach from the controlling terminal and become a daemon.
63 If option -D is given, it will stay in the foreground. Option -w <sec‐
64 onds> can be used to specify that the program should sleep for the
65 specified time before indexing begins. The default value is 60. The
66 daemon normally monitors the X11 session and exits when it is reset.
67 Option -x disables this X11 session monitoring (daemon will stay alive
68 even if it cannot connect to the X11 server). You need to use this too
69 if you use the daemon without an X11 context. You can use option -n to
70 skip the initial incrementing pass which is normally performed before
71 monitoring starts. Once monitoring is started, the daemon normally mon‐
72 itors the configuration and restarts from scratch if a change is made.
73 You can disable this with option -C
74 recollindex -i will index individual files into the database. The stem
76 expansion and aspell databases will not be updated. The skippedPaths
77 and skippedNames configuration variables will be used, so that some
78 files may be skipped. You can tell recollindex to ignore skippedPaths
79 and skippedNames by setting the -f option. This allows fully custom
80 file selection for a given subtree, for which you would add the top
81 directory to skippedPaths, and use any custom tool to generate the file
82 list (ie: a tool from a source code control system). When run this way,
83 the indexer normally does not perform the deleted files purge pass,
84 because it cannot be sure to have seen all the existing files. You can
85 force a purge pass with -P.
86 recollindex -e will erase data for individual files from the database.
88 The stem expansion databases will not be updated.
89 Options -i and -e can be combined. This will first perform the purge,
91 then the indexing.
92 With options -i or -e , if no file names are given on the command line,
94 they will be read from stdin, so that you could for example run:
95 find /path/to/dir -print | recollindex -e -i
97 to force the reindexing of a directory tree (which has to exist inside
99 the file system area defined by topdirs in recoll.conf). You could
100 mostly accomplish the same thing with
101 find /path/to/dir -print | recollindex -Z -i
103 The latter will perform a less thorough job of purging stale sub-docu‐
105 ments though.
106 recollindex -r mostly works like -i , but the parameter is a single
108 directory, which will be recursively updated. This mostly does nothing
109 more than find topdir | recollindex -i but it may be more convenient to
110 use when started from another program. This retries failed files by
111 default, use option -K to change. One or multiple -p options can be
112 used to set shell-type selection patterns (e.g.: *.pdf).
113 recollindex -l will list the names of available language stemmers.
115 recollindex -s will build the stem expansion database for a given lan‐
117 guage, which may or may not be part of the list in the configuration
118 file. If the language is not part of the configuration, the stem expan‐
119 sion database will be deleted at the end of the next normal indexing
120 run. You can get the list of stemmer names from the recollindex -l com‐
121 mand. Note that this is mostly for experimental use, the normal way to
122 add a stemming language is to set it in the configuration, either by
123 editing "recoll.conf" or by using the GUI indexing configuration dia‐
124 log.
125 At the time of this writing, the following languages are recognized
126 (out of Xapian's stem.h):
127 · danish
129 · dutch
131 · english Martin Porter's 2002 revision of his stemmer
133 · english_lovins Lovin's stemmer
135 · english_porter Porter's stemmer as described in his 1980 paper
137 · finnish
139 · french
141 · german
143 · italian
145 · norwegian
147 · portuguese
149 · russian
151 · spanish
153 · swedish
155 recollindex -S will rebuild the phonetic/orthographic index. This fea‐
157 ture uses the aspell package, which must be installed on the system.
158 recollindex -E will check the configuration file for topdirs and other
160 relevant paths existence (to help catch typos).
161
164 recoll(1) recoll.conf(5)
165 8 January 2006 RECOLLINDEX(1)