Add Debian directory
[mspang/vmailman.git] / debian / manpages / mmarch.8
1 .TH MMARCH 8 2006-08-09
2 .SH NAME
3 mmarch \- Rebuild a Mailman list's archive.
4
5 .SH SYNOPSIS
6 mmarch listname [options] <listname> [<mbox>]
7
8 .SH DESCRIPTION
9
10 Use this command to rebuild the archives for a mailing list.  You may want to
11 do this if you edit some messages in an archive, or remove some messages from
12 an archive.
13
14 \fB\-h\fB, \fB\-\-\fBhelp\fB
15
16 Print this error message and exit.
17
18 \fB\-q\fB, \fB\-\-\fBquiet\fB
19
20 Make the archiver output less verbose.
21
22 \fB\-\-\fBwipe\fB
23
24 First wipe out the original archive before regenerating.  You usually
25 want to specify this argument unless you're generating the archive in
26 chunks.
27
28 \fB\-s\fB \fIN\fI, \fB\-\-\fBstart=\fB\fIN\fI
29
30 Start indexing at article N, where article 0 is the first in the mbox.
31 Defaults to 0.
32
33 \fB\-e\fB \fIM\fI, \fB\-\-\fBend=\fB\fIM\fI
34
35 End indexing at article M.  This script is not very efficient with
36 respect to memory management, and for large archives, it may not be
37 possible to index the mbox entirely.  For that reason, you can specify
38 the start and end article numbers.
39
40
41 mbox is the path to a list's complete mbox archive.  Usually this will 
42 be some path in the archives/private directory.  For example:
43
44 % mmarch mylist archives/private/mylist.mbox/mylist.mbox
45
46 mbox is optional.  If it is missing, it is calculated.
47
48 .SH AUTHOR
49 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
50 information.  This manpage is written by Tollef Fog Heen
51 <tfheen@debian.org> for Debian
52
53 .SH SEE ALSO
54 Mailman documentation on http://www.list.org/ and in
55 /usr/share/doc/mailman.