1DOVECONF(1)                         Dovecot                        DOVECONF(1)
2
3
4

NAME

6       doveconf - Dovecot's configuration dumping utility
7

SYNOPSIS

9       doveconf [-adnPNSx] [-c config-file] [-f filter] [-m module]
10       doveconf [-n] [-c config-file] section_name ...
11       doveconf [-h] [-c config-file] [-f filter] setting_name ...
12

DESCRIPTION

14       doveconf  reads  and  parses Dovecot's configuration files and converts
15       them into a simpler format used by the rest of Dovecot. All  standalone
16       programs,  such  as dovecot(1) and dovecot-lda(1), will first get their
17       settings by executing doveconf.
18
19       For system administrators, doveconf is mainly useful  for  dumping  the
20       configuration in easy human readable output.
21

OPTIONS

23       -a     Show all settings with their currently configured values.
24
25       -c config-file
26              read  configuration  from  the  given  config-file.   By default
27              /etc/dovecot/dovecot.conf will be used.
28
29       -d     Show the setting's default value instead of  the  one  currently
30              configured.
31
32       -f filter
33              Show  the matching configuration for the specified filter condi‐
34              tion.  The filter option string has to be  given  as  name=value
35              pair.   For multiple filter conditions the -f option can be sup‐
36              plied multiple times.
37              Possible names for the filter are:
38
39              lname  The local hostname,  e.g.  mail.example.com.   This  will
40                     only match hostnames which were configured like:
41                     local_name mail.example.com { # special settings }
42
43              local  The  server's  hostname  or  IP  address.  This will also
44                     match hostnames which were configured like:
45                     local imap.example.net { # special settings }
46
47              protocol, service
48                     The protocol, e.g. imap or pop3
49
50              remote The client's hostname or IP address.
51
52       -h     Hide the setting's name, show only the setting's value.
53
54       -m module
55              Show only settings for the given module.
56              e.g.  imap, imap-login, lmtp, pop3 or pop3-login
57
58       -n     Show only settings with non-default values.
59
60       -N     Show settings with non-default values and explicitly set default
61              values.
62
63       -S     Dump settings in simplified machine parsable/readable format.
64
65
66       -P/
67              Show passwords and other sensitive values.
68
69       -x     Expand  configuration  variables  (e.g.  $mail_plugins  ⇒
70              quota) and show  file  contents  (from  e.g.  ssl_cert  =
71              </etc/ssl/certs/dovecot.pem).
72
73       section_name
74              Show only the current configuration of one or more speci‐
75              fied sections.
76
77       setting_name
78              Show only the setting of one or more setting_name(s) with
79              the  currently  configured  value. You can show a setting
80              inside a section using '/' as the section separator, e.g.
81              service/imap/executable.
82

EXAMPLE

84       When  Dovecot  was configured to use different settings for some
85       networks/subnets it is possible to show which settings  will  be
86       applied for a specific connection.
87
88       doveconf -f local=10.0.0.110 -f remote=10.11.1.2 -f service=pop3 -n
89
90       doveconf  can  be  also used to convert v1.x configuration files
91       into v2.x format.
92
93       doveconf -n -c /oldpath/dovecot.conf > /etc/dovecot/dovecot.conf.new
94
95       This example shows how to ask doveconf for a global setting  and
96       a  protocol  specific setting.  The second command uses also the
97       -h option, in order to hide the setting's name.
98
99       doveconf mail_plugins
100       mail_plugins = quota
101       doveconf  -h -f protocol=imap mail_plugins
102       quota imap_quota
103
104       This example demonstrates how to dump a whole configuration sec‐
105       tion.
106
107       doveconf dict
108       dict {
109         quota = pgsql:/etc/dovecot/dovecot-dict-sql.conf.ext
110       }
111
112       Or how to dump only the quota dict:
113
114       doveconf dict/quota
115       dict/quota = pgsql:/etc/dovecot/dovecot-dict-sql.conf.ext
116

REPORTING BUGS

118       Report  bugs, including doveconf -n output, to the Dovecot Mail‐
119       ing List  <dovecot@dovecot.org>.   Information  about  reporting
120       bugs is available at: http://dovecot.org/bugreport.html
121

SEE ALSO

123       doveadm(1), dovecot(1), dovecot-lda(1), dsync(1)
124
125
126
127Dovecot v2.3                      2014-10-19                       DOVECONF(1)
Impressum