Mercurial > dovecot > core-2.2

annotate doc/man/doveconf.1.in @ 22711:25d4771ad0fd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
lib-storage: mailbox_list_index - indentation cleanup
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Thu, 14 Dec 2017 02:10:27 +0200
parents 2e2563132d5f
children cb108f786fb4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21390
2e2563132d5f Updated copyright notices to include the year 2017.
Stephan Bosch <stephan.bosch@dovecot.fi>
parents: 19552
diff changeset
1 .\" Copyright (c) 2010-2017 Dovecot authors, see the included COPYING file
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
2 .TH DOVECONF 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
3 .SH NAME
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
4 doveconf \- Dovecot\(aqs configuration dumping utility
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
6 .SH SYNOPSIS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
7 .B doveconf
14034
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
8 .RB [ \-adnNSx ]
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
9 [\fB\-c\fP \fIconfig\-file\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
10 [\fB\-f\fP \fIfilter\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
11 [\fB\-m\fP \fImodule\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
12 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
13 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
14 .B doveconf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
15 .RB [ \-n ]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
16 [\fB\-c\fP \fIconfig\-file\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
17 .IR section_name \ ...
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
18 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
19 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
20 .B doveconf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
21 .RB [ \-h ]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
22 [\fB\-c\fP \fIconfig\-file\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
23 [\fB\-f\fP \fIfilter\fP]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
24 .IR setting_name \ ...
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
25 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
26 .SH DESCRIPTION
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
27 .B doveconf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
28 reads and parses Dovecot\(aqs configuration files and converts them into a
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
29 simpler format used by the rest of Dovecot. All standalone programs, such
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
30 as
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
31 .BR dovecot (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 and
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
33 .BR dovecot\-lda (1),
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
34 will first get their settings by executing doveconf.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
35 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
36 For system administrators,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
37 .B doveconf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
38 is mainly useful for dumping the configuration in easy human readable
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
39 output.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
40 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
41 .SH OPTIONS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
42 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
43 .B \-a
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
44 Show all settings with their currently configured values.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
45 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
46 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
47 .BI \-c \ config\-file
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
48 read configuration from the given
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
49 .IR config\-file .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
50 By default
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
51 .I @pkgsysconfdir@/dovecot.conf
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
52 will be used.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
53 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
54 .TP
14034
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
55 .B \-d
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
56 Show the setting\(aqs default value instead of the one currently
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
57 configured.
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
58 .\"---------------------------------
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
59 .TP
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
60 .BI \-f \ filter
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
61 Show the matching configuration for the specified
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
62 .I filter
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
63 condition.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
64 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
65 .I filter
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
66 option string has to be given as
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
67 .IB name = value
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68 pair.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
69 For multiple filter conditions the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
70 .B \-f
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
71 option can be supplied multiple times.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
72 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
73 Possible names for the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
74 .I filter
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
75 are:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
76 .RS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
77 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
78 .B lname
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
79 The local hostname, e.g. mail.example.com.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
80 This will only match hostnames which were configured like:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
81 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
82 .B local_name mail.example.com { # special settings }
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
83 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
84 .B local
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
85 The server\(aqs hostname or IP address.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
86 This will also match hostnames which were configured like:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
87 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
88 .B local imap.example.net { # special settings }
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
89 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
90 .B protocol, service
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
91 The protocol, e.g. imap or pop3
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
92 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
93 .B remote
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
94 The client\(aqs hostname or IP address.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
95 .RE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
96 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
97 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
98 .B \-h
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
99 Hide the setting\(aqs name, show only the setting\(aqs value.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
100 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
101 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
102 .BI \-m\ module
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
103 Show only settings for the given
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
104 .IR module .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
105 .RS
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
106 e.g.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
107 .BR imap ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
108 .BR imap\-login ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
109 .BR lmtp ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
110 .BR pop3\ or
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
111 .B pop3\-login
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
112 .RE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
113 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
114 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
115 .B \-n
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
116 Show only settings with non\-default values.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
117 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
118 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
119 .B \-N
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
120 Show settings with non\-default values and explicitly set default values.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
121 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
122 .TP
14034
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
123 .B \-S
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
124 Dump settings in simplified machine parsable/readable format.
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
125 .\"---------------------------------
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
126 .TP
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
127 .B \-x
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
128 Expand configuration variables (e.g. \(Domail_plugins \(rA quota) and show
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
129 file contents (from e.g. ssl_cert = </etc/ssl/certs/dovecot.pem).
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
130 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
131 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
132 .I section_name
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
133 Show only the current configuration of one or more specified sections.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
134 .\"---------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
135 .TP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
136 .I setting_name
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
137 Show only the setting of one or more
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
138 .IR setting_name (s)
13017
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
139 with the currently configured value. You can show a setting inside a
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
140 section using \(aq/\(aq as the section separator, e.g.
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
141 service/imap/executable.
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
142 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
143 .SH EXAMPLE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
144 When Dovecot was configured to use different settings for some
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
145 networks/subnets it is possible to show which settings will be applied
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
146 for a specific connection.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
147 .sp
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
148 .nf
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
149 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
150 doveconf \-f local=10.0.0.110 \-f remote=10.11.1.2 \-f service=pop3 \-n
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
151 .ft P
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
152 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
153 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
154 .B doveconf
13707
a695e124e62f man: Dovecot version numbers updated.
Timo Sirainen <tss@iki.fi>
parents: 13017
diff changeset
155 can be also used to convert v1.x configuration files into v2.x format.
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
156 .sp
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
157 .nf
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
158 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
159 doveconf \-n \-c /oldpath/dovecot.conf > \
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
160 @pkgsysconfdir@/dovecot.conf.new
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
161 .ft P
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
162 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
163 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
164 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
165 This example shows how to ask
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
166 .B doveconf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
167 for a global setting and a protocol specific setting.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
168 The second command uses also the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
169 .B \-h
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
170 option, in order to hide the setting\(aqs name.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
171 .sp
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
172 .nf
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
173 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
174 doveconf mail_plugins
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
175 .ft P
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
176 mail_plugins = quota
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
177 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
178 doveconf \-h \-f protocol=imap mail_plugins
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
179 .ft P
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
180 quota imap_quota
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
181 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
182 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
183 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
184 This example demonstrates how to dump a whole configuration section.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
185 .sp
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
186 .nf
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
187 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
188 doveconf dict
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
189 .ft P
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
190 dict {
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
191 quota = pgsql:@pkgsysconfdir@/dovecot\-dict\-sql.conf.ext
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
192 }
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
193 .fi
13017
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
194 .PP
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
195 Or how to dump only the quota dict:
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
196 .sp
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
197 .nf
17967
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
198 .ft B
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
199 doveconf dict/quota
dcfb0baba621 man: Reworked some formatting requests.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
200 .ft P
13017
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
201 dict/quota = pgsql:@pkgsysconfdir@/dovecot\-dict\-sql.conf.ext
a6db801253c6 man: Updated doveconf.
Timo Sirainen <tss@iki.fi>
parents: 11798
diff changeset
202 .fi
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
203 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
204 @INCLUDE:reporting-bugs@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
205 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
206 .SH SEE ALSO
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
207 .BR doveadm (1),
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
208 .BR dovecot (1),
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
209 .BR dovecot\-lda (1),
14034
cc533cbd77b0 man: Added descriptions of -d and -S options to doveconf.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
210 .BR dsync (1)