File: dovecot.1

package info (click to toggle)
dovecot 1%3A2.4.1%2Bdfsg1-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 46,224 kB
  • sloc: ansic: 596,204; makefile: 7,825; sh: 6,005; cpp: 1,866; perl: 487; yacc: 412; lex: 320; python: 253; xml: 232
file content (213 lines) | stat: -rw-r--r-- 3,426 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
.TH "DOVECOT" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdovecot\fR - A secure and highly configurable IMAP and POP3 server
.SH "SYNOPSIS"
.P
\fBdovecot\fR \[lB]\fB-Fp\fR\[rB] \[lB]\fB-c\fR \fIconfig-file\fR\[rB]
.P
\fBdovecot -a\fR \[lB]\fB-c\fR \fIconfig-file\fR\[rB]
.P
\fBdovecot -n\fR \[lB]\fB-c\fR \fIconfig-file\fR\[rB]
.P
\fBdovecot --build-options\fR
.P
\fBdovecot --help\fR
.P
\fBdovecot --hostdomain\fR
.P
\fBdovecot --version\fR
.P
\fBdovecot reload\fR
.P
\fBdovecot stop\fR
.SH "DESCRIPTION"
.P
Dovecot is an open source IMAP and POP3 server for Linux/UNIX-like systems, written with security primarily in mind. Dovecot is an excellent choice for both small and large installations. It's fast, simple to set up, requires no special administration and it uses very little memory.
.SH "OPTIONS"
.P
\fB-a\fR
.RS 0
.RS 4
.P
Dump all configuration settings to stdout and exit successfully. The same as \fIdoveconf -a\fR.
.RE 0

.RE 0

.P
\fB-c\fR \fIconfig-file\fR
.RS 0
.RS 4
.P
Start \fBdovecot\fR with an alternative configuration.
.RE 0

.RE 0

.P
\fB-F\fR
.RS 0
.RS 4
.P
Run \fBdovecot\fR in foreground, do not daemonize.
.RE 0

.RE 0

.P
\fB-n\fR
.RS 0
.RS 4
.P
Dump non-default settings to stdout and exit successfully. The same as \fIdoveconf -n\fR.
.RE 0

.RE 0

.P
\fB-p\fR
.RS 0
.RS 4
.P
Prompt for the ssl key password for the configured \fIssl_server_key\fR on startup.
.RE 0

.RE 0

.P
\fB--build-options\fR
.RS 0
.RS 4
.P
Show Dovecot's build options and exit successfully.
.RE 0

.RE 0

.P
\fB--help\fR
.RS 0
.RS 4
.P
Print a usage message to stdout and exit successfully.
.RE 0

.RE 0

.P
\fB--hostdomain\fR
.RS 0
.RS 4
.P
Shows the current \fIhost\fR.\fIdomain\fR name of the system. If the domain lookup should fail for some reason, only the hostname will be shown.
.RE 0

.RE 0

.P
\fB--version\fR
.RS 0
.RS 4
.P
Show Dovecot's version and exit successfully.
.RE 0

.RE 0

.SH "COMMANDS"
.P
\fBreload\fR
.RS 0
.RS 4
.P
Force \fBdovecot\fR to reload its configuration.
.RE 0

.RE 0

.P
\fBstop\fR
.RS 0
.RS 4
.P
Shutdown \fBdovecot\fR and all its child processes.
.RE 0

.RE 0

.P
When \fIshutdown_clients\fR is set to \fBno\fR, existing sessions will continue to use the old settings, after a \fBdovecot reload\fR. Also all sessions will keep alive after a \fBdovecot stop\fR.
.P
By default all active sessions will be shut down.
.SH "SIGNALS"
.P
Dovecot handles the following \fIsignals\fR as described:
.P
\fBHUP\fR
.RS 0
.RS 4
.P
Force \fBdovecot\fR to reload its configuration.
.RE 0

.RE 0

.P
\fBINT\fR
.RS 0
.RS 4
.P
Shutdown \fBdovecot\fR and all its child processes.
.RE 0

.RE 0

.P
\fBTERM\fR
.RS 0
.RS 4
.P
Shutdown \fBdovecot\fR and all its child processes.
.RE 0

.RE 0

.P
\fBUSR1\fR
.RS 0
.RS 4
.P
Force \fBdovecot\fR to reopen all configured log files (\fIlog_path\fR, \fIinfo_log_path\fR and \fIdebug_log_path\fR).
.RE 0

.RE 0

.P
The \fIsignals\fR \fBALARM\fR and \fBPIPE\fR are ignored.
.SH "FILES"
.P
\fI/etc/dovecot/dovecot.conf\fR
.RS 0
.RS 4
.P
Dovecot's main configuration file.
.RE 0

.RE 0

.P
\fI/etc/dovecot/conf.d/\fR.conf*
.RS 0
.RS 4
.P
Configuration files of different services and settings.
.RE 0

.RE 0

.SH "REPORTING BUGS"
.P
Report bugs, including \fIdoveconf -n\fR output, to the Dovecot Mailing List \fI\(ladovecot@dovecot.org\(ra\fR. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
.SH "SEE ALSO"
.P
doveadm(1)