Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-batch.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) 2013-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\-BATCH 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
16978
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
3 .SH NAME
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
4 doveadm\-batch \- Execute multiple commands for multiple users
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
6 .SH SYNOPSIS
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
7 .BR doveadm " [" \-Dv "] " batch " [" \-S
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
8 .IR socket_path "] "
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
9 .BI \-A " sep command sep command"
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
10 [...]
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
11 .br
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
12 .\"-------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
13 .BR doveadm " [" \-Dv "] " batch " [" \-S
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
14 .IR socket_path "] "
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
15 .BI \-F " file sep command sep command"
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
16 [...]
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
17 .br
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
18 .\"-------------------------------------
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
19 .BR doveadm " [" \-Dv "] " batch " [" \-S
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
20 .IR socket_path "] "
16978
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
21 .BI \-u " usermask sep command sep command"
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
22 [...]
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
23 .\"------------------------------------------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
24 .SH DESCRIPTION
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
25 The command
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
26 .B doveadm batch
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
27 is used to execute multiple
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
28 .BR doveadm (1)
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
29 .IR command s
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
30 sequentially for multiple users.
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
31 This is primarily an optimization where Dovecot can do all the mailbox
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 operations for the same user at once, instead of having to go through
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
33 the users multiple times.
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
34 .PP
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
35 In the first form
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
36 .BR doveadm (1)
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
37 will loop over all users, defined in the configured
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
38 .IR user_db (s),
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
39 and execute the sequence of
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
40 .IR command s
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
41 for each of them.
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
42 .PP
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
43 In the second form
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
44 .BR doveadm (1)
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
45 will loop over all users, listed in the given
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
46 .IR file .
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
47 .PP
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
48 In the third form the
16978
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
49 .IR command s
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
50 will be executed for each user matching the given
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
51 .IR usermask .
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
52 .\"------------------------------------------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
53 @INCLUDE:global-options@
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
54 .\" --- command specific options --- "/.
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
55 .PP
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
56 Command specific
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
57 .IR options :
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
58 .\"-------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
59 @INCLUDE:option-A@
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
60 .\"-------------------------------------
18604
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
61 @INCLUDE:option-F-file@
c469d8f4cde7 man: Added description of option `-F file'.
Pascal Volk <user@localhost.localdomain.org>
parents: 18137
diff changeset
62 .\"-------------------------------------
16978
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
63 @INCLUDE:option-S-socket@
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
64 .\"-------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
65 @INCLUDE:option-u-user@
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
66 .\"------------------------------------------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
67 .SH ARGUMENTS
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68 .TP
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
69 .I command
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
70 Any
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
71 .BR doveadm (1)
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
72 command, with arguments and options \(em except for the
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
73 .BR \-A ", " \-S " and " \-u " options."
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
74 .\"-------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
75 .TP
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
76 .I sep
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
77 A single character used as command separator, e.g. \(aq:\(aq.
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
78 Be careful, unquoted characters, like
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
79 .BR ; " or " & ,
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
80 may be interpreted by your shell and
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
81 .BR doveadm (1)
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
82 will never see them.
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
83 .\"------------------------------------------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
84 .SH EXAMPLE
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
85 In this example we move seen mails, older than one month, for all
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
86 example.net users to the alternative storage under /nfsmount:
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
87 .br
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
88 .nf
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
89 mail_location = mdbox:~/mdbox:ALT=/nfsmount/%h/mdbox
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
90 .fi
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
91 The second command will remove messages with refcount=0 from the
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
92 primary storage.
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
93 .PP
0ba1ca4552b7 man: Added doveadm-batch.1.
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: 16978
diff changeset
95 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16978
diff changeset
96 doveadm batch \-u \(rs*@example.net : altmove seen savedbefore 30d : purge
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16978
diff changeset
97 .ft P
16978
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
98 .fi
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
99 .\"------------------------------------------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
100 @INCLUDE:reporting-bugs@
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
101 .\"------------------------------------------------------------------------
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
102 .SH SEE ALSO
0ba1ca4552b7 man: Added doveadm-batch.1.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
103 .BR doveadm (1)