Update release date.
[aox:aox.git] / doc / aoximport.man
1 .\" Copyright 2009 The Archiveopteryx Developers <info@aox.org>
2 .TH aoximport 8 2009-07-13 aox.org "Archiveopteryx Documentation"
3 .SH NAME
4 aoximport - import messages into Archiveopteryx.
5 .SH SYNOPSIS
6 .B $BINDIR/aoximport
7 [-vqe]
8 .I mailbox
9 .I type
10 .I source-file
11 [
12 .I source-file ...
13 ]
14 .SH DESCRIPTION
15 .nh
16 .PP
17 .B aoximport
18 is used to import messages into Archiveopteryx en masse from other
19 mailboxes (mbox, MH, maildir and Cyrus mailboxes are currently supported).
20 .SH OPTIONS
21 .IP -v
22 enables more verbose output. Can be repeated.
23 .IP -q
24 sets the verbosity to zero.
25 .IP -e
26 makes
27 .B aoximport
28 write problem messages to the errors subdirectory. If a message has parse problems,
29 .B aoximport
30 writes a copy of the message to errors/anonymised if anonymisation
31 preserves the error, and to errors/plaintext else. The message is also
32 written to the target mailbox, as an attachment to a special error
33 message.
34 .IP
35 The messages in the errors directory may be sent to info@aox.org, and
36 we'll try to find out what the problem is. Please delete
37 personal/confidential messages from errors/plaintext first.
38 .SH SYNTAX
39 In the synopsis above,
40 .I mailbox
41 is the fully-qualified name of the destination mailbox (which must
42 exist) into which messages are imported.
43 .I type
44 may be
45 .IR mbox ,
46 .IR maildir ,
47 .IR mh ,
48 or
49 .IR cyrus .
50 The remaining arguments are interpreted as mailbox filenames of the
51 specified
52 .IR type .
53 .SH EXAMPLES
54 To import messages from the mbox files in ~/Mail/imap/* to a mailbox
55 named /users/nirmala/imap:
56 .IP
57 aoximport /users/nirmala/imap mbox ~/Mail/imap/*
58 .PP
59 After a large import, it's a good idea to run
60 .IR "aox vacuum" .
61 .SH AUTHOR
62 The Archiveopteryx Developers, info@aox.org.
63 .SH VERSION
64 This man page covers Archiveopteryx version 3.1.2, released 2009-07-13,
65 http://www.archiveopteryx.org/3.1.2
66 .SH SEE ALSO
67 .BR aox (8),
68 .BR archiveopteryx (8),
69 http://www.archiveopteryx.org