|
a/src/doc/man/recollindex.1 |
|
b/src/doc/man/recollindex.1 |
| 1 |
.\" $Id: recollindex.1,v 1.7 2008-09-05 10:25:54 dockes Exp $ (C) 2005 J.F.Dockes\$
|
1 |
.\" $Id: recollindex.1,v 1.7 2008-09-05 10:25:54 dockes Exp $ (C) 2005 J.F.Dockes\$
|
| 2 |
.TH RECOLLINDEX 1 "8 January 2006"
|
2 |
.TH RECOLLINDEX 1 "8 January 2006"
|
| 3 |
.SH NAME
|
3 |
.SH NAME
|
| 4 |
recollindex \- indexing command for the Recoll full text search system
|
4 |
recollindex \- indexing command for the Recoll full text search system
|
| 5 |
.SH SYNOPSIS
|
5 |
.SH SYNOPSIS
|
| 6 |
.B recollindex -h
|
6 |
.B recollindex \-h
|
| 7 |
.br
|
7 |
.br
|
| 8 |
.B recollindex
|
8 |
.B recollindex
|
| 9 |
[
|
9 |
[
|
| 10 |
.B -c
|
10 |
.B \-c
|
| 11 |
<configdir>
|
11 |
<configdir>
|
| 12 |
]
|
12 |
]
|
| 13 |
[
|
13 |
[
|
| 14 |
.B -z
|
14 |
.B \-z
|
| 15 |
]
|
15 |
]
|
| 16 |
[
|
16 |
[
|
| 17 |
.B -m
|
17 |
.B \-m
|
| 18 |
]
|
18 |
]
|
| 19 |
[
|
19 |
[
|
| 20 |
.B -w
|
20 |
.B \-w
|
| 21 |
<seconds>
|
21 |
<seconds>
|
| 22 |
]
|
22 |
]
|
| 23 |
[
|
23 |
[
|
| 24 |
.B -D
|
24 |
.B \-D
|
| 25 |
]
|
25 |
]
|
| 26 |
[
|
26 |
[
|
| 27 |
.B -x
|
27 |
.B \-x
|
| 28 |
]
|
28 |
]
|
| 29 |
.br
|
29 |
.br
|
| 30 |
.B recollindex
|
30 |
.B recollindex
|
| 31 |
[
|
31 |
[
|
| 32 |
.B -c
|
32 |
.B \-c
|
| 33 |
<configdir>
|
33 |
<configdir>
|
| 34 |
]
|
34 |
]
|
| 35 |
.B -i
|
35 |
.B \-i
|
| 36 |
[<filename [filename ...]>]
|
36 |
[<filename [filename ...]>]
|
| 37 |
.br
|
37 |
.br
|
| 38 |
.B recollindex
|
38 |
.B recollindex
|
| 39 |
[
|
39 |
[
|
| 40 |
.B -c
|
40 |
.B \-c
|
| 41 |
<configdir>
|
41 |
<configdir>
|
| 42 |
]
|
42 |
]
|
| 43 |
.B -e
|
43 |
.B \-e
|
| 44 |
[<filename [filename ...]>]
|
44 |
[<filename [filename ...]>]
|
| 45 |
.br
|
45 |
.br
|
| 46 |
.B recollindex
|
46 |
.B recollindex
|
| 47 |
[
|
47 |
[
|
| 48 |
.B -c
|
48 |
.B \-c
|
| 49 |
<configdir>
|
49 |
<configdir>
|
| 50 |
]
|
50 |
]
|
| 51 |
.B -l
|
51 |
.B \-l
|
| 52 |
.br
|
52 |
.br
|
| 53 |
.B recollindex
|
53 |
.B recollindex
|
| 54 |
[
|
54 |
[
|
| 55 |
.B -c
|
55 |
.B \-c
|
| 56 |
<configdir>
|
56 |
<configdir>
|
| 57 |
]
|
57 |
]
|
| 58 |
.B -s
|
58 |
.B \-s
|
| 59 |
<lang>
|
59 |
<lang>
|
| 60 |
.br
|
60 |
.br
|
| 61 |
.B recollindex
|
61 |
.B recollindex
|
| 62 |
[
|
62 |
[
|
| 63 |
.B -c
|
63 |
.B \-c
|
| 64 |
<configdir>
|
64 |
<configdir>
|
| 65 |
]
|
65 |
]
|
| 66 |
.B -S
|
66 |
.B \-S
|
| 67 |
|
67 |
|
| 68 |
.SH DESCRIPTION
|
68 |
.SH DESCRIPTION
|
| 69 |
The
|
69 |
The
|
| 70 |
.B recollindex
|
70 |
.B recollindex
|
| 71 |
utility allows you to perform indexing operations for the Recoll text
|
71 |
utility allows you to perform indexing operations for the Recoll text
|
| 72 |
search system.
|
72 |
search system.
|
| 73 |
.PP
|
73 |
.PP
|
| 74 |
The
|
74 |
The
|
| 75 |
.B -c
|
75 |
.B \-c
|
| 76 |
option specifies the configuration directory name, overriding the
|
76 |
option specifies the configuration directory name, overriding the
|
| 77 |
default or $RECOLL_CONFDIR.
|
77 |
default or $RECOLL_CONFDIR.
|
| 78 |
.PP
|
78 |
.PP
|
| 79 |
There are several modes of operation.
|
79 |
There are several modes of operation.
|
| 80 |
.PP
|
80 |
.PP
|
| 81 |
The normal mode will index the set of files described in the configuration
|
81 |
The normal mode will index the set of files described in the configuration
|
| 82 |
file
|
82 |
file
|
| 83 |
.B recoll.conf.
|
83 |
.B recoll.conf.
|
| 84 |
This will incrementally update the database with files that changed since
|
84 |
This will incrementally update the database with files that changed since
|
| 85 |
the last run. If option
|
85 |
the last run. If option
|
| 86 |
.B -z
|
86 |
.B \-z
|
| 87 |
is given, the database will be erased before starting.
|
87 |
is given, the database will be erased before starting.
|
| 88 |
.PP
|
88 |
.PP
|
| 89 |
If option
|
89 |
If option
|
| 90 |
.B
|
90 |
.B
|
| 91 |
\-m
|
91 |
\-m
|
|
... |
|
... |
| 106 |
.B
|
106 |
.B
|
| 107 |
\-x
|
107 |
\-x
|
| 108 |
disables this X11 session monitoring (daemon will stay alive even if it
|
108 |
disables this X11 session monitoring (daemon will stay alive even if it
|
| 109 |
cannot connect to the X11 server).
|
109 |
cannot connect to the X11 server).
|
| 110 |
.PP
|
110 |
.PP
|
| 111 |
.B recollindex -l
|
111 |
.B recollindex \-l
|
| 112 |
will list the names of available language stemmers.
|
112 |
will list the names of available language stemmers.
|
| 113 |
.PP
|
113 |
.PP
|
| 114 |
The other modes are useful mainly for testing.
|
114 |
The other modes are useful mainly for testing.
|
| 115 |
.PP
|
115 |
.PP
|
| 116 |
.B recollindex -i
|
116 |
.B recollindex \-i
|
| 117 |
will index individual files into the database. The stem expansion databases
|
117 |
will index individual files into the database. The stem expansion databases
|
| 118 |
will not be updated.
|
118 |
will not be updated.
|
| 119 |
.PP
|
119 |
.PP
|
| 120 |
.B recollindex -e
|
120 |
.B recollindex \-e
|
| 121 |
will erase data for individual files from the database. The stem expansion
|
121 |
will erase data for individual files from the database. The stem expansion
|
| 122 |
databases will not be updated.
|
122 |
databases will not be updated.
|
| 123 |
.PP
|
123 |
.PP
|
| 124 |
With options
|
124 |
With options
|
| 125 |
.B -i
|
125 |
.B \-i
|
| 126 |
or
|
126 |
or
|
| 127 |
.B -e
|
127 |
.B \-e
|
| 128 |
, if no file names are given on the command line, they
|
128 |
, if no file names are given on the command line, they
|
| 129 |
will be read from stdin, so that you could for example run:
|
129 |
will be read from stdin, so that you could for example run:
|
| 130 |
.PP
|
130 |
.PP
|
| 131 |
find /path/to/dir \-print | recollindex -e
|
131 |
find /path/to/dir \-print | recollindex \-e
|
| 132 |
.PP
|
132 |
.PP
|
| 133 |
followed by
|
133 |
followed by
|
| 134 |
.PP
|
134 |
.PP
|
| 135 |
find /path/to/dir \-print | recollindex -i
|
135 |
find /path/to/dir \-print | recollindex \-i
|
| 136 |
.PP
|
136 |
.PP
|
| 137 |
to force the reindexing of a directory tree (which has to exist inside the
|
137 |
to force the reindexing of a directory tree (which has to exist inside the
|
| 138 |
file system area defined by
|
138 |
file system area defined by
|
| 139 |
.I topdirs
|
139 |
.I topdirs
|
| 140 |
in recoll.conf).
|
140 |
in recoll.conf).
|
| 141 |
.PP
|
141 |
.PP
|
| 142 |
.B recollindex -s
|
142 |
.B recollindex \-s
|
| 143 |
will build the stem expansion database for a given language, which may or
|
143 |
will build the stem expansion database for a given language, which may or
|
| 144 |
may not be part of the list in the configuration file. If the language is
|
144 |
may not be part of the list in the configuration file. If the language is
|
| 145 |
not part of the configuration, the stem expansion database will be deleted
|
145 |
not part of the configuration, the stem expansion database will be deleted
|
| 146 |
at the end of the next normal indexing run. You can get the list of stemmer
|
146 |
at the end of the next normal indexing run. You can get the list of stemmer
|
| 147 |
names from the
|
147 |
names from the
|
| 148 |
.B recollindex -l
|
148 |
.B recollindex \-l
|
| 149 |
command. Note that this is mostly for experimental use, the normal way to
|
149 |
command. Note that this is mostly for experimental use, the normal way to
|
| 150 |
add a stemming language is to set it in the configuration, either by
|
150 |
add a stemming language is to set it in the configuration, either by
|
| 151 |
editing "recoll.conf" or by using the GUI indexing configuration dialog.
|
151 |
editing "recoll.conf" or by using the GUI indexing configuration dialog.
|
| 152 |
.br
|
152 |
.br
|
| 153 |
At the time of this writing, the following languages
|
153 |
At the time of this writing, the following languages
|
|
... |
|
... |
| 179 |
.IP \(bu
|
179 |
.IP \(bu
|
| 180 |
spanish
|
180 |
spanish
|
| 181 |
.IP \(bu
|
181 |
.IP \(bu
|
| 182 |
swedish
|
182 |
swedish
|
| 183 |
.PP
|
183 |
.PP
|
| 184 |
.B recollindex -S
|
184 |
.B recollindex \-S
|
| 185 |
will rebuild the phonetic/orthographic index. This feature uses the
|
185 |
will rebuild the phonetic/orthographic index. This feature uses the
|
| 186 |
.B aspell
|
186 |
.B aspell
|
| 187 |
package, which must be installed on the system.
|
187 |
package, which must be installed on the system.
|
| 188 |
|
188 |
|
| 189 |
.SH SEE ALSO
|
189 |
.SH SEE ALSO
|