Mercurial > dovecot > core-2.2
view doc/man/doveconf.1.in @ 22644:2ed6735ffc7a
director: Change request callback to take mail_host parameter
This allows accessing the IP address both as struct and as string without
any conversions.
author | Timo Sirainen <timo.sirainen@dovecot.fi> |
---|---|
date | Sat, 04 Nov 2017 02:05:26 +0200 |
parents | 2e2563132d5f |
children | cb108f786fb4 |
line wrap: on
line source
.\" Copyright (c) 2010-2017 Dovecot authors, see the included COPYING file .TH DOVECONF 1 "2014-10-19" "Dovecot v2.2" "Dovecot" .SH NAME doveconf \- Dovecot\(aqs configuration dumping utility .\"------------------------------------------------------------------------ .SH SYNOPSIS .B doveconf .RB [ \-adnNSx ] [\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 \-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)