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
214
215
216
217
218
219
220
|
.\" Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file
.TH DOVECONF 1 "2014-10-19" "Dovecot v2.3" "Dovecot"
.SH NAME
doveconf \- Dovecot\(aqs configuration dumping utility
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.B doveconf
.RB [ \-adnPNSx ]
[\fB\-c\fP \fIconfig\-file\fP]
[\fB\-f\fP \fIfilter\fP]
[\fB\-m\fP \fImodule\fP]
.\"-------------------------------------
.br
.B doveconf
.RB [ \-n ]
[\fB\-c\fP \fIconfig\-file\fP]
.IR section_name \ ...
.\"-------------------------------------
.br
.B doveconf
.RB [ \-h ]
[\fB\-c\fP \fIconfig\-file\fP]
[\fB\-f\fP \fIfilter\fP]
.IR setting_name \ ...
.\"------------------------------------------------------------------------
.SH DESCRIPTION
.B doveconf
reads and parses Dovecot\(aqs configuration files and converts them into a
simpler format used by the rest of Dovecot. All standalone programs, such
as
.BR dovecot (1)
and
.BR dovecot\-lda (1),
will first get their settings by executing doveconf.
.PP
For system administrators,
.B doveconf
is mainly useful for dumping the configuration in easy human readable
output.
.\"------------------------------------------------------------------------
.SH OPTIONS
.TP
.B \-a
Show all settings with their currently configured values.
.\"---------------------------------
.TP
.BI \-c \ config\-file
read configuration from the given
.IR config\-file .
By default
.I @pkgsysconfdir@/dovecot.conf
will be used.
.\"---------------------------------
.TP
.B \-d
Show the setting\(aqs default value instead of the one currently
configured.
.\"---------------------------------
.TP
.BI \-f \ filter
Show the matching configuration for the specified
.I filter
condition.
The
.I filter
option string has to be given as
.IB name = value
pair.
For multiple filter conditions the
.B \-f
option can be supplied multiple times.
.br
Possible names for the
.I filter
are:
.RS
.TP
.B lname
The local hostname, e.g. mail.example.com.
This will only match hostnames which were configured like:
.br
.B local_name mail.example.com { # special settings }
.TP
.B local
The server\(aqs hostname or IP address.
This will also match hostnames which were configured like:
.br
.B local imap.example.net { # special settings }
.TP
.B protocol, service
The protocol, e.g. imap or pop3
.TP
.B remote
The client\(aqs hostname or IP address.
.RE
.\"---------------------------------
.TP
.B \-h
Hide the setting\(aqs name, show only the setting\(aqs value.
.\"---------------------------------
.TP
.BI \-m\ module
Show only settings for the given
.IR module .
.RS
e.g.
.BR imap ,
.BR imap\-login ,
.BR lmtp ,
.BR pop3\ or
.B pop3\-login
.RE
.\"---------------------------------
.TP
.B \-n
Show only settings with non\-default values.
.\"---------------------------------
.TP
.B \-N
Show settings with non\-default values and explicitly set default values.
.\"---------------------------------
.TP
.B \-S
Dump settings in simplified machine parsable/readable format.
.\"---------------------------------
.TP
.B \-s
Show also hidden settings. The hidden settings should not be changed normally.
.\"---------------------------------
.TP
.\"---------------------------------
.TP
.B \-P
Show passwords and other sensitive values.
.\"---------------------------------
.TP
.B \-x
Expand configuration variables (e.g. \(Domail_plugins \(rA quota) and show
file contents (from e.g. ssl_cert = </etc/ssl/certs/dovecot.pem).
.\"---------------------------------
.TP
.I section_name
Show only the current configuration of one or more specified sections.
.\"---------------------------------
.TP
.I setting_name
Show only the setting of one or more
.IR setting_name (s)
with the currently configured value. You can show a setting inside a
section using \(aq/\(aq as the section separator, e.g.
service/imap/executable.
.\"------------------------------------------------------------------------
.SH EXAMPLE
When Dovecot was configured to use different settings for some
networks/subnets it is possible to show which settings will be applied
for a specific connection.
.sp
.nf
.ft B
doveconf \-f local=10.0.0.110 \-f remote=10.11.1.2 \-f service=pop3 \-n
.ft P
.fi
.PP
.B doveconf
can be also used to convert v1.x configuration files into v2.x format.
.sp
.nf
.ft B
doveconf \-n \-c /oldpath/dovecot.conf > \
@pkgsysconfdir@/dovecot.conf.new
.ft P
.fi
.\"-------------------------------------
.PP
This example shows how to ask
.B doveconf
for a global setting and a protocol specific setting.
The second command uses also the
.B \-h
option, in order to hide the setting\(aqs name.
.sp
.nf
.ft B
doveconf mail_plugins
.ft P
mail_plugins = quota
.ft B
doveconf \-h \-f protocol=imap mail_plugins
.ft P
quota imap_quota
.fi
.\"-------------------------------------
.PP
This example demonstrates how to dump a whole configuration section.
.sp
.nf
.ft B
doveconf dict
.ft P
dict {
quota = pgsql:@pkgsysconfdir@/dovecot\-dict\-sql.conf.ext
}
.fi
.PP
Or how to dump only the quota dict:
.sp
.nf
.ft B
doveconf dict/quota
.ft P
dict/quota = pgsql:@pkgsysconfdir@/dovecot\-dict\-sql.conf.ext
.fi
.\"------------------------------------------------------------------------
@INCLUDE:reporting-bugs@
.\"------------------------------------------------------------------------
.SH SEE ALSO
.BR doveadm (1),
.BR dovecot (1),
.BR dovecot\-lda (1),
.BR dsync (1)
|
