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

NAME

6       doveconf - Dovecot's configuration dumping utility
7

SYNOPSIS

9       doveconf [-anNx] [-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       -f filter
30              Show the matching configuration for the specified filter  condi‐
31              tion.   The  filter  option string has to be given as name=value
32              pair.  For multiple filter conditions the -f option can be  sup‐
33              plied multiple times.
34              Possible names for the filter are:
35
36              lname  The  local  hostname,  e.g.  mail.example.com.  This will
37                     only match hostnames which were configured like:
38                     local_name mail.example.com { # special settings }
39
40              local  The server's hostname or  IP  address.   This  will  also
41                     match hostnames which were configured like:
42                     local imap.example.net { # special settings }
43
44              protocol, service
45                     The protocol, e.g. imap or pop3
46
47              remote The client's hostname or IP address.
48
49       -h     Hide the setting's name, show only the setting's value.
50
51       -m module
52              Show only settings for the given module.
53              e.g.  imap, imap-login, lmtp, pop3 or pop3-login
54
55       -n     Show only settings with non-default values.
56
57       -N     Show settings with non-default values and explicitly set default
58              values.
59
60       -x     Expand configuration variables (e.g. $mail_plugins ⇒ quota)  and
61              show  file  contents (from e.g. ssl_cert = </etc/ssl/certs/dove‐
62              cot.pem).
63
64       section_name
65              Show only the current configuration of  one  or  more  specified
66              sections.
67
68       setting_name
69              Show  only  the  setting of one or more setting_name(s) with the
70              currently configured value. You can show a setting inside a sec‐
71              tion using '/' as the section separator, e.g.  service/imap/exe‐
72              cutable.
73

EXAMPLE

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

REPORTING BUGS

108       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
109       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
110       at: http://dovecot.org/bugreport.html
111

SEE ALSO

113       doveadm(1), dovecot(1), dovecot-lda(1), dsync(1)
114
115
116
117Dovecot v2.0                      2011-05-11                       DOVECONF(1)
Impressum