doveadm-stop(1)

1DOVEADM(1)                          Dovecot                         DOVEADM(1)
2
3
4

NAME

6       doveadm - Dovecot's administration utility
7

SYNOPSIS

9       doveadm  [-Dv]  [-f formatter] command [command_options] [command_argu‐
10       ments]
11

DESCRIPTION

13       doveadm is the Dovecot administration tool. It can be  used  to  manage
14       various parts of Dovecot, as well as access users' mailboxes.
15       Execute doveadm help, for a command usage listing.
16

OPTIONS

18       Global doveadm(1) options:
19
20       -D     Enables verbosity and debug messages.
21
22       -f formatter
23              Specifies  the  formatter  for formatting the output.  Supported
24              formatters are:
25
26              flow   prints each line with key=value pairs.
27
28              pager  prints each key: value pair on its own line and separates
29                     records with form feed character (^L).
30
31              tab    prints  a  table  header  followed by tab separated value
32                     lines.
33
34              table  prints a table header followed by adjusted value lines.
35
36       -o setting=value
37              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
38              cot.conf  and from the userdb with the given value.  In order to
39              override multiple settings, the -o option may be specified  mul‐
40              tiple times.
41
42       -v     Enables verbosity, including progress counter.
43

COMMANDS

45       These commands work directly with Dovecot's master process.
46
47   reload
48       doveadm reload
49
50       Force dovecot(1) to reload the configuration.
51
52   stop
53       doveadm stop
54
55       Stop dovecot(1) and all its child processes.
56
57   ADDITIONAL MASTER COMMANDS
58       doveadm director
59              doveadm-director(1),  Manage Dovecot directors (if used by proxy
60              servers).
61
62       doveadm exec
63              doveadm-exec(1),  Easily   execute   commands   from   Dovecot's
64              libexec_dir.
65
66       doveadm instance
67              doveadm-instance(1),   Manage   the   list  of  running  Dovecot
68              instances.
69
70       doveadm kick
71              doveadm-kick(1),  Disconnect  users  by  user  name  and/or   IP
72              address.
73
74       doveadm log
75              doveadm-log(1), Locate, test or reopen Dovecot's log files.
76
77       doveadm mount
78              doveadm-mount(1), Manage the list of mountpoints where mails are
79              stored.
80
81       doveadm penalty
82              doveadm-penalty(1), Show current penalties.
83
84       doveadm proxy
85              doveadm-proxy(1), Handle Dovecot proxy connections.
86
87       doveadm who
88              doveadm-who(1); Show who is logged in to the Dovecot server.
89
90   AUTHENTICATION COMMANDS
91       doveadm auth
92              doveadm-auth(1), Test authentication for a user.
93
94       doveadm pw
95              doveadm-pw(1), Dovecot's password hash generator.
96
97       doveadm user
98              doveadm-user(1), Perform a user lookup in Dovecot's userdbs
99
100   MAILBOX COMMANDS
101       doveadm acl
102              doveadm-acl(1), Manage Access Control List (ACL).
103
104       doveadm altmove
105              doveadm-altmove(1), Move matching mails to the alternative stor‐
106              age.
107
108       doveadm backup
109              doveadm-backup(1),  Dovecot's  one-way  mailbox  synchronization
110              utility.
111
112       doveadm batch
113              doveadm-batch(1), Execute multiple commands for multiple users.
114
115       doveadm copy
116              doveadm-copy(1), Copy messages matching the given  search  query
117              into another mailbox.
118
119       doveadm deduplicate
120              doveadm-deduplicate(1), Expunge duplicate messages.
121
122       doveadm dump
123              doveadm-dump(1),  Dump  the  content of Dovecot's binary mailbox
124              index/log.
125
126       doveadm expunge
127              doveadm-expunge(1),  Expunge  messages  matching  given   search
128              query.
129
130       doveadm fetch
131              doveadm-fetch(1), Fetch messages matching given search query.
132
133       doveadm flags
134              doveadm-flags(1), Add, remove or replace messages' flags.
135
136       doveadm fts
137              doveadm-fts(1), Manipulate the Full Text Search (FTS) index.
138
139       doveadm force-resync
140              doveadm-force-resync(1),  Repair broken mailboxes, in case Dove‐
141              cot doesn't automatically do that.
142
143       doveadm import
144              doveadm-import(1), Import messages matching given search query.
145
146       doveadm index
147              doveadm-index(1), Index messages in a given mailbox.
148
149       doveadm mailbox
150              doveadm-mailbox(1), Various commands related to  handling  mail‐
151              boxes.
152
153       doveadm move
154              doveadm-move(1)  Move  messages  matching the given search query
155              into another mailbox.
156
157       doveadm purge
158              doveadm-purge(1) Remove  messages  with  refcount=0  from  mdbox
159              files.
160
161       doveadm quota
162              doveadm-quota(1),  Initialize/recalculate  or show current quota
163              usage.
164
165       doveadm replicator
166              doveadm-replicator(1), Manage users' mail replicaton.
167
168       doveadm stats
169              doveadm-stats(1), Inspect or reset stats.
170
171       doveadm sync
172              doveadm-sync(1), Dovecot's two-way mailbox synchronization util‐
173              ity.
174
175       doveadm search
176              doveadm-search(1), Show a list of mailbox GUIDs and message UIDs
177              matching given search query.
178

EXIT STATUS

180       doveadm will exit with one of the following values:
181
182       0   Selected command was executed successful.
183
184       >0  Command failed in some way.
185

ENVIRONMENT

187       USER   This environment variable is used to determine  the  user  if  a
188              command accepts a user but none was specified.
189

FILES

191       /etc/dovecot/dovecot.conf
192              Dovecot's main configuration file.
193
194       /etc/dovecot/conf.d/10-mail.conf
195              Mailbox locations and namespaces.
196
197       /etc/dovecot/conf.d/90-plugin.conf
198              Plugin specific settings.
199

REPORTING BUGS

201       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
202       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
203       at: http://dovecot.org/bugreport.html
204