|
a/src/doc/man/recollindex.1 |
|
b/src/doc/man/recollindex.1 |
| 1 |
.\" $Id: recollindex.1,v 1.3 2006-11-20 18:07:02 dockes Exp $ (C) 2005 J.F.Dockes\$
|
1 |
.\" $Id: recollindex.1,v 1.4 2006-12-22 11:01:28 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
|
|
... |
|
... |
| 15 |
]
|
15 |
]
|
| 16 |
[
|
16 |
[
|
| 17 |
.B -m
|
17 |
.B -m
|
| 18 |
]
|
18 |
]
|
| 19 |
[
|
19 |
[
|
|
|
20 |
.B -w
|
|
|
21 |
<seconds>
|
|
|
22 |
]
|
|
|
23 |
[
|
| 20 |
.B -D
|
24 |
.B -D
|
| 21 |
]
|
25 |
]
|
| 22 |
.br
|
26 |
.br
|
| 23 |
.B recollindex
|
27 |
.B recollindex
|
| 24 |
[
|
28 |
[
|
| 25 |
.B -c
|
29 |
.B -c
|
| 26 |
<configdir>
|
30 |
<configdir>
|
| 27 |
]
|
31 |
]
|
| 28 |
.B -i
|
32 |
.B -i
|
|
|
33 |
<filename [filename ...]>
|
|
|
34 |
.br
|
|
|
35 |
.B recollindex
|
|
|
36 |
[
|
|
|
37 |
.B -c
|
|
|
38 |
<configdir>
|
|
|
39 |
]
|
|
|
40 |
.B -e
|
| 29 |
<filename [filename ...]>
|
41 |
<filename [filename ...]>
|
| 30 |
.br
|
42 |
.br
|
| 31 |
.B recollindex
|
43 |
.B recollindex
|
| 32 |
[
|
44 |
[
|
| 33 |
.B -c
|
45 |
.B -c
|
|
... |
|
... |
| 52 |
The
|
64 |
The
|
| 53 |
.B -c
|
65 |
.B -c
|
| 54 |
option specifies the configuration directory name, overriding the
|
66 |
option specifies the configuration directory name, overriding the
|
| 55 |
default or $RECOLL_CONFDIR.
|
67 |
default or $RECOLL_CONFDIR.
|
| 56 |
.PP
|
68 |
.PP
|
| 57 |
There are three modes of operation.
|
69 |
There are several modes of operation.
|
| 58 |
.PP
|
70 |
.PP
|
| 59 |
The normal mode will index the set of files described in the configuration
|
71 |
The normal mode will index the set of files described in the configuration
|
| 60 |
file
|
72 |
file
|
| 61 |
.B recoll.conf.
|
73 |
.B recoll.conf.
|
| 62 |
This will incrementally update the database with files that changed since
|
74 |
This will incrementally update the database with files that changed since
|
|
... |
|
... |
| 65 |
is given, the database will be erased before starting.
|
77 |
is given, the database will be erased before starting.
|
| 66 |
.PP
|
78 |
.PP
|
| 67 |
If option
|
79 |
If option
|
| 68 |
.B
|
80 |
.B
|
| 69 |
-m
|
81 |
-m
|
| 70 |
is given, then recollindex is started for real time monitoring, using the
|
82 |
is given, recollindex is started for real time monitoring, using the
|
| 71 |
package it was configured for (either fam, gamin, or inotify). This mode
|
83 |
file system monitoring package it was configured for (either fam, gamin, or
|
| 72 |
must have been explicitely configured when building the package, it is not
|
84 |
inotify). This mode must have been explicitely configured when building the
|
| 73 |
available by default. The program will normally detach from the controlling
|
85 |
package, it is not available by default. The program will normally detach
|
| 74 |
terminal and become a daemon. If option
|
86 |
from the controlling terminal and become a daemon. If option
|
| 75 |
.B
|
87 |
.B
|
| 76 |
-D
|
88 |
-D
|
| 77 |
is given, it will stay in foreground.
|
89 |
is given, it will stay in the foreground. Option
|
|
|
90 |
.B
|
|
|
91 |
-w
|
|
|
92 |
<seconds> can be used to specify that the program should sleep for the
|
|
|
93 |
specified time before indexing. The default value is 60.
|
| 78 |
|
94 |
|
| 79 |
.PP
|
95 |
.PP
|
| 80 |
The two other modes are useful mainly for testing.
|
96 |
The other modes are useful mainly for testing.
|
| 81 |
.PP
|
97 |
.PP
|
| 82 |
.B recollindex -i
|
98 |
.B recollindex -i
|
| 83 |
will index individual files into the database. The stem expansion databases
|
99 |
will index individual files into the database. The stem expansion databases
|
| 84 |
will not be updated.
|
100 |
will not be updated.
|
|
|
101 |
.PP
|
|
|
102 |
.B recollindex -e
|
|
|
103 |
will erase data for individual files from the database. The stem expansion
|
|
|
104 |
databases will not be updated.
|
| 85 |
.PP
|
105 |
.PP
|
| 86 |
.B recollindex -s
|
106 |
.B recollindex -s
|
| 87 |
will build the stem expansion database for a given language, which may or
|
107 |
will build the stem expansion database for a given language, which may or
|
| 88 |
may not be part of the list in the configuration file. If the language is
|
108 |
may not be part of the list in the configuration file. If the language is
|
| 89 |
not part of the configuration, the stem expansion database will be deleted
|
109 |
not part of the configuration, the stem expansion database will be deleted
|