Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-altmove.1.in @ 22560:9a300e778b20

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
director: When logging "ring SYNC lost", include sync seq number in message This can help with debugging.
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Thu, 14 Sep 2017 17:26:39 +0300
parents 2e2563132d5f
children cb108f786fb4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21390
2e2563132d5f Updated copyright notices to include the year 2017.
Stephan Bosch <stephan.bosch@dovecot.fi>
parents: 19552
diff changeset
1 .\" Copyright (c) 2010-2017 Dovecot authors, see the included COPYING file
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
2 .TH DOVEADM\-ALTMOVE 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
3 .SH NAME
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
4 doveadm\-altmove \- Move matching mails to the alternative storage (dbox\-only)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
6 .SH SYNOPSIS
13496
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
7 .BR doveadm " [" \-Dv "] " altmove " [" \-r "] ["\-S
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11821
diff changeset
8 .IR socket_path "] " search_query
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
9 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
10 .\"-------------------------------------
13496
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
11 .BR doveadm " [" \-Dv "] " altmove " [" \-r "] ["\-S
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11821
diff changeset
12 .IR socket_path "] "
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11821
diff changeset
13 .BI \-A " search_query"
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
14 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
15 .\"-------------------------------------
13496
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
16 .BR doveadm " [" \-Dv "] " altmove " [" \-r "] ["\-S
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11821
diff changeset
17 .IR socket_path "] "
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
18 .BI \-F " file search_query"
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
19 .br
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
20 .\"-------------------------------------
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
21 .BR doveadm " [" \-Dv "] " altmove " [" \-r "] ["\-S
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
22 .IR socket_path "] "
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11821
diff changeset
23 .BI \-u " user search_query"
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
24 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
25 .SH DESCRIPTION
11821
0d16970d9df3 man: Also renamed "dbox" to "sdbox"
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
26 This command can be used with sdbox or mdbox storage to move mails to
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
27 alternative storage path when :ALT=<path> is specified for the mail
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
28 location.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
29 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
30 In the first form,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
31 .BR doveadm (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 will executed the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
33 .B altmove
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
34 action with the environment of the logged in system user.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
35 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
36 In the second form, the command will be performed for all users.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
37 .PP
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
38 In the third form, the command will be performed for all users listed in
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
39 the given
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
40 .IR file .
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
41 .PP
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
42 In the fourth form, only matching mails of the given
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
43 .IR user (s)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
44 will be moved to the alternative storage.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
45 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
46 @INCLUDE:global-options@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
47 .\" --- command specific options --- "/.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
48 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
49 Command specific
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
50 .IR options :
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
51 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
52 @INCLUDE:option-A@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
53 .\"-------------------------------------
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
54 @INCLUDE:option-F-file@
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
55 .\"-------------------------------------
13496
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
56 .TP
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
57 .B \-r
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
58 When the
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
59 .B \-r
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
60 option is given this
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
61 .I command
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
62 works the other way round.
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
63 Mails will be moved from the alternative storage back to the default mail
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
64 location.
85853915c8c0 man: Added -r option to doveadm-altmove.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 12471
diff changeset
65 .\"-------------------------------------
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11821
diff changeset
66 @INCLUDE:option-S-socket@
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11821
diff changeset
67 .\"-------------------------------------
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68 @INCLUDE:option-u-user@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
69 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
70 .SH ARGUMENTS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
71 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
72 .I search_query
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
73 Messages matching this search query will be moved to alt storage.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
74 See
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
75 .BR doveadm\-search\-query (7)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
76 for details.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
77 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
78 .SH FILES
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
79 .TP
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
80 .I @pkgsysconfdir@/conf.d/10\-mail.conf
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
81 Mailbox locations and namespaces.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
82 .TP
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
83 .I @pkgsysconfdir@/conf.d/auth\-*.conf.ext
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
84 Authentication processes, including userdb settings.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
85 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
86 .SH EXAMPLE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
87 This example moves seen mails older than one week to alternative storage
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
88 under /nfsmount:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
89 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
90 .nf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
91 mail_location = mdbox:~/mdbox:ALT=/nfsmount/%h/mdbox
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
92 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
93 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
94 .nf
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
95 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
96 doveadm altmove \-u johnd@example.com seen savedbefore 1w
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
97 .ft P
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
98 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
99 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
100 @INCLUDE:reporting-bugs@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
101 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
102 .SH SEE ALSO
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
103 .BR doveadm (1),
12471
fee02c0565e7 man: Added "-S socket_path" description.
Pascal Volk <user@localhost.localdomain.org>
parents: 11821
diff changeset
104 .BR doveadm\-search\-query (7)