Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-import.1.in @ 12464:464fe0e62078

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
man: *roff syntax-fix.
author Pascal Volk <user@localhost.localdomain.org>
date Tue, 23 Nov 2010 17:39:19 +0000
parents 16338d5462ba
children fee02c0565e7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
1 .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
2 .TH DOVEADM\-IMPORT 1 "2010-11-23" "Dovecot v2.0" "Dovecot"
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
3 .SH NAME
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
4 doveadm\-import \- Import messages matching given search query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
6 .SH SYNOPSIS
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
7 .BR doveadm " [" \-Dv "] " import
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
8 .I source_location dest_parent search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
9 .br
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
10 .\"-------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
11 .BR doveadm " [" \-Dv "] " "import \-A"
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
12 .I source_location dest_parent search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
13 .br
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
14 .\"-------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
15 .BR doveadm " [" \-Dv "] " "import \-u"
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
16 .I user source_location dest_parent search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
17 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
18 .SH DESCRIPTION
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
19 This command can be used to import mails from another mail storage specified by
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
20 .I source_location
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
21 to one or more user\(aqs mailboxes. All the mailboxes are imported under the
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
22 given
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
23 .I dest_parent
12462
16338d5462ba man: Make it clear that doveadm-import allows dest_parent to be ""
Timo Sirainen <tss@iki.fi>
parents: 12304
diff changeset
24 mailbox, or to root level if
16338d5462ba man: Make it clear that doveadm-import allows dest_parent to be ""
Timo Sirainen <tss@iki.fi>
parents: 12304
diff changeset
25 .I dest_parent
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
26 is empty (\(dq\(dq). The
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
27 .I search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
28 can be used to restrict which mailboxes or messages are imported.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
29
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
30 In the first form,
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
31 .BR doveadm (1)
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
32 will executed the
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
33 .B import
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
34 action with the environment of the logged in system user.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
35 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
36 In the second form, the mails will be imported for all users.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
37 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
38 In the third form, the mails will be imported only for given
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
39 .IR user (s).
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
40 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
41 @INCLUDE:global-options@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
42 .\" --- command specific options --- "/.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
43 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
44 Command specific
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
45 .IR options :
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
46 .\"-------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
47 @INCLUDE:option-A@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
48 .\"-------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
49 @INCLUDE:option-u-user@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
50 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
51 .SH ARGUMENTS
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
52 .TP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
53 .I search_query
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
54 Copy messages matching this search query.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
55 See
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
56 .BR doveadm\-search\-query (7)
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
57 for details.
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
58 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
59 .SH EXAMPLE
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
60 This example imports all mails from a backup under a
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
61 .I backup\-20101026
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
62 mailbox:
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
63 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
64 .nf
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
65 .B doveadm import \-u jane.doe@example.org \(rs
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
66 .B mdbox:/backup/20101026/jane.doe/mdbox backup\-20101026 all
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
67 .fi
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
68 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
69 Another example that imports only messages from foo@example.org in the
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
70 backup mdbox\(aqs INBOX to jane\(aqs INBOX:
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
71 .PP
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
72 .nf
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
73 .B doveadm import \-u jane.doe@example.org \(rs
12464
464fe0e62078 man: *roff syntax-fix.
Pascal Volk <user@localhost.localdomain.org>
parents: 12462
diff changeset
74 .B mdbox:~/mdbox\-backup \(dq\(dq mailbox INBOX from foo@example.org
12304
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
75 .fi
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
76 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
77 @INCLUDE:reporting-bugs@
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
78 .\"------------------------------------------------------------------------
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
79 .SH SEE ALSO
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
80 .BR doveadm (1),
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
81 .BR doveadm\-fetch (1),
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
82 .BR doveadm\-search (1),
6c2d5ed0b664 doveadm: Added import command for importing mails from other storages.
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
83 .BR doveadm\-search\-query (7)