1
.\" $Header: /cvsroot/lurker/lurker/index/lurker-index.1,v 1.10 2004/08/25 21:40:10 terpstra Exp $
3
.\" transcript compatibility for postscript use.
5
.\" synopsis: .P! <file.ps>
14
.fl \" force out current output buffer
15
\!!save /psv exch def currentpoint translate 0 0 moveto
18
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
22
.ie \\*(f1 .ds f1 \\n(.f
23
.el .ie \\*(f2 .ds f2 \\n(.f
24
.el .ie \\*(f3 .ds f3 \\n(.f
25
.el .ie \\*(f4 .ds f4 \\n(.f
26
.el .tm ? font overflow
46
.el .tm ? font underflow
53
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
54
.TH "LURKER\-INDEX" "1"
56
lurker\-index \(em imports messages into the archive
59
\fBlurker\-index\fR [\-c <config-file>] [\-l <list>] [\-i <mbox/maildir>] [\-v \-d \-n \-u \-f] [\-m | \-b <count>]
62
\fBlurker\-index\fR indexes messages from
63
standard input and stores them in the lurker database.
64
It imports either a single message, or a batch of messages
67
.IP "\fB\-c config-file\fP" 10
68
Use this config file for lurker settings.
69
.IP "\fB\-l listid\fP" 10
70
Import messages to the named mailing list. This should match
71
the value in the lurker.conf after the 'list = ' entry.
72
.IP "\fB\-b count\fP" 10
73
Import a batch of messages; flush every count messages. A
74
good value for count is 5. The larger this parameter, the more CPU
75
power lurker needs during import, but the less disk seeks.
77
It is important to note that lurker reads files from a
78
maildirs and mailboxes in order and may miss new messages
79
delivered during the import. For this reason, setting up lurker to
80
be invoked properly when new mail is delivered is essential. Only
81
use lurker\-index with '\-b' when importing from non-active mail
84
By default, lurker\-index reads from standard input in mbox
85
format, delimited by 'From <addr> <date>' lines.
86
Be aware that if the mbox is not delimited correctly between
87
messages it will be interpretted as a single message with an
88
invalid date. To read other sources, see the '\-i' option.
90
Import a single message. In this mode lurker will never
91
interpret 'From ' lines as message delimiters. When being fed
92
newly delivered mail, this is the preferred mode of operation.
93
Try to turn off the 'From ' escaping of your MTA when using
94
this mode as lurker does it's own escaping which is generally
97
This option should be used when lurker\-index is invoked by
98
the MTA for newly delivered email. For importing batches of
99
archived mail, see the '\-b' option.
100
.IP "\fB\-i mbox/maildir\fP" 10
101
Import messages from the specified mailbox or maildir.
102
When '\-b' is specified, lurker\-index by default reads a mailbox
103
(mbox format) from standard input. If the '\-i' parameter is a file,
104
the file is assumed to be in the mbox format and is read instead
105
of standard input. If the parameter is a directory, the directory
106
is assumed to be in maildir format.
108
If '\-m' is used, the input MUST be a raw email,
109
preferably with a mbox header, never a maildir.
111
Verbose operation. Lurker will output statistics about import
112
speed to assist you in tweaking options for best throughput on
113
your system. It also helps you know how much longer you will have
116
Drop duplicates per list. This option will check the
117
database to see if the message has already been imported to a
118
mailing list. Only if it has not been imported will lurker append
119
it to the mailbox. Even without this option lurker does not index
120
a message twice. If an import failed part-way through, you
121
probably want this option to avoid needless replication. However,
122
to generate mailboxes which accurately reflect delivery, leave the
125
Don't compress messages. This will increase the database
126
size and import speed. Lurker can handle a database with mixed
127
compressed and uncompressed messages. However, zcat/gzip and
128
database upgrades cannot. If you need these to function, you
129
should never mix compressed and uncompressed messages within a
132
Trust user Date headers from the email more than the delivery
133
time. Normally lurker compares the two and if the user time differs
134
too much from the delivery time, the delivery time is used instead.
135
When this option is used, lurker will simply trust the user Date
136
header whenever it exists, otherwise it uses the delivery time.
138
This option should never be used as a default. It is intended
139
for dealing with corrupt mailboxes or maildirs. A better solution
140
than using this option is to find an uncorrupted copy of the mail.
143
Fast import (but vulnerable to power-failure). This may
144
improve the lifetime of your hard-disk and increase import speed
145
by up to 30%. However, if the power fails during import or shortly
146
thereafter, it is possible you will have a corrupted database. If
147
you use a journaling filesystem, lurker guarantees no corruption
148
when you OMIT this parameter.
151
lurker\-prune(1), lurker\-params(1), lurker\-list(1), lurker\-search(1)
153
lurker documentation on http://lurker.sourceforge.net/
156
Copyright (C) 2002: Wesley W. Terpstra <terpstra@users.sourceforge.net>
159
This program is free software; you can redistribute it and/or modify
160
it under the terms of the GNU General Public License as published by
161
the Free Software Foundation; version 2.
164
This program is distributed in the hope that it will be useful,
165
but WITHOUT ANY WARRANTY; without even the implied warranty of
166
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
167
GNU General Public License for more details.
170
You should have received a copy of the GNU General Public License
171
along with this program; if not, write to the Free Software
172
Foundation, Inc., 59 Temple Place - Suite 330,
173
Boston, MA 02111-1307, USA.
177
Before reporting a bug, please confirm that the bug you found is
178
still present in the latest official release. If the problem persists,
179
then send mail with instructions describing how to reproduce the bug to
180
<lurker\-users@lists.sourceforge.net>.
181
.\" created by instant / docbook-to-man, Wed 25 Aug 2004, 23:39
added
removed
index/lurker-index.1
