1POSTCONF(1) General Commands Manual POSTCONF(1)
2
6 postconf - Postfix configuration utility
7
9 postconf [-dhnv] [-c config_dir] [parameter ...]
10 postconf [-aAmlv] [-c config_dir]
12 postconf [-ev] [-c config_dir] [parameter=value ...]
14 postconf [-#v] [-c config_dir] [parameter ...]
16 postconf [-btv] [-c config_dir] [template_file]
18
20 The postconf(1) command displays the actual values of configuration
21 parameters, changes configuration parameter values, or displays other
22 configuration information about the Postfix mail system.
23 Options:
25 -a List the available SASL server plug-in types. The SASL plug-in
27 type is selected with the smtpd_sasl_type configuration parame‐
28 ter by specifying one of the names listed below.
29 cyrus This server plug-in is available when Postfix is built
31 with Cyrus SASL support.
32 dovecot
34 This server plug-in uses the Dovecot authentication
35 server, and is available when Postfix is built with any
36 form of SASL support.
37 This feature is available with Postfix 2.3 and later.
39 -A List the available SASL client plug-in types. The SASL plug-in
41 type is selected with the smtp_sasl_type or lmtp_sasl_type con‐
42 figuration parameters by specifying one of the names listed
43 below.
44 cyrus This client plug-in is available when Postfix is built
46 with Cyrus SASL support.
47 This feature is available with Postfix 2.3 and later.
49 -b [template_file]
51 Display the message text that appears at the beginning of deliv‐
52 ery status notification (DSN) messages, with $name expressions
53 replaced by actual values. To override the built-in message
54 text, specify a template file at the end of the command line, or
55 specify a template file in main.cf with the bounce_template_file
56 parameter. To force selection of the built-in message text tem‐
57 plates, specify an empty template file name (in shell language:
58 "").
59 This feature is available with Postfix 2.3 and later.
61 -c config_dir
63 The main.cf configuration file is in the named directory instead
64 of the default configuration directory.
65 -d Print default parameter settings instead of actual settings.
67 -e Edit the main.cf configuration file. The file is copied to a
69 temporary file then renamed into place. Parameters and values
70 are specified on the command line. Use quotes in order to pro‐
71 tect shell metacharacters and whitespace.
72 -h Show parameter values only, not the ``name = '' label that nor‐
74 mally precedes the value.
75 -l List the names of all supported mailbox locking methods. Post‐
77 fix supports the following methods:
78 flock A kernel-based advisory locking method for local files
80 only. This locking method is available on systems with a
81 BSD compatible library.
82 fcntl A kernel-based advisory locking method for local and
84 remote files.
85 dotlock
87 An application-level locking method. An application locks
88 a file named filename by creating a file named file‐
89 name.lock. The application is expected to remove its own
90 lock file, as well as stale lock files that were left
91 behind after abnormal termination.
92 -m List the names of all supported lookup table types. In Postfix
94 configuration files, lookup tables are specified as type:name,
95 where type is one of the types listed below. The table name syn‐
96 tax depends on the lookup table type as described in the DATA‐
97 BASE_README document.
98 btree A sorted, balanced tree structure. This is available on
100 systems with support for Berkeley DB databases.
101 cdb A read-optimized structure with no support for incremen‐
103 tal updates. This is available on systems with support
104 for CDB databases.
105 cidr A table that associates values with Classless Inter-
107 Domain Routing (CIDR) patterns. This is described in
108 cidr_table(5).
109 dbm An indexed file type based on hashing. This is available
111 on systems with support for DBM databases.
112 environ
114 The UNIX process environment array. The lookup key is the
115 variable name. Originally implemented for testing, some‐
116 one may find this useful someday.
117 hash An indexed file type based on hashing. This is available
119 on systems with support for Berkeley DB databases.
120 internal
122 A non-shared, in-memory hash table. Its content are lost
123 when a process terminates.
124 ldap (read-only)
126 Perform lookups using the LDAP protocol. This is
127 described in ldap_table(5).
128 mysql (read-only)
130 Perform lookups using the MYSQL protocol. This is
131 described in mysql_table(5).
132 pcre (read-only)
134 A lookup table based on Perl Compatible Regular Expres‐
135 sions. The file format is described in pcre_table(5).
136 pgsql (read-only)
138 Perform lookups using the PostgreSQL protocol. This is
139 described in pgsql_table(5).
140 proxy (read-only)
142 A lookup table that is implemented via the Postfix prox‐
143 ymap(8) service. The table name syntax is type:name.
144 regexp (read-only)
146 A lookup table based on regular expressions. The file
147 format is described in regexp_table(5).
148 sdbm An indexed file type based on hashing. This is available
150 on systems with support for SDBM databases.
151 static (read-only)
153 A table that always returns its name as lookup result.
154 For example, static:foobar always returns the string foo‐
155 bar as lookup result.
156 tcp (read-only)
158 Perform lookups using a simple request-reply protocol
159 that is described in tcp_table(5). This feature is not
160 included with the stable Postfix release.
161 unix (read-only)
163 A limited way to query the UNIX authentication database.
164 The following tables are implemented:
165 unix:passwd.byname
167 The table is the UNIX password database. The key
168 is a login name. The result is a password file
169 entry in passwd(5) format.
170 unix:group.byname
172 The table is the UNIX group database. The key is a
173 group name. The result is a group file entry in
174 group(5) format.
175 Other table types may exist depending on how Postfix was built.
177 -n Print parameter settings that are not left at their built-in
179 default value, because they are explicitly specified in main.cf.
180 -t [template_file]
182 Display the templates for delivery status notification (DSN)
183 messages. To override the built-in templates, specify a template
184 file at the end of the command line, or specify a template file
185 in main.cf with the bounce_template_file parameter. To force
186 selection of the built-in templates, specify an empty template
187 file name (in shell language: "").
188 This feature is available with Postfix 2.3 and later.
190 -v Enable verbose logging for debugging purposes. Multiple -v
192 options make the software increasingly verbose.
193 -# Edit the main.cf configuration file. The file is copied to a
195 temporary file then renamed into place. The parameters specified
196 on the command line are commented-out, so that they revert to
197 their default values. Specify a list of parameter names, not
198 name=value pairs. There is no postconf command to perform the
199 reverse operation.
200 This feature is available with Postfix 2.6 and later.
202
204 Problems are reported to the standard error stream.
205
207 MAIL_CONFIG
208 Directory with Postfix configuration files.
209
211 The following main.cf parameters are especially relevant to this pro‐
212 gram.
213 The text below provides only a parameter summary. See postconf(5) for
215 more details including examples.
216 config_directory (see 'postconf -d' output)
218 The default location of the Postfix main.cf and master.cf con‐
219 figuration files.
220 bounce_template_file (empty)
222 Pathname of a configuration file with bounce message templates.
223
225 /etc/postfix/main.cf, Postfix configuration parameters
226
228 bounce(5), bounce template file format
229 postconf(5), configuration parameters
230
232 Use "postconf readme_directory" or "postconf html_directory" to locate
233 this information.
234 DATABASE_README, Postfix lookup table overview
235
237 The Secure Mailer license must be distributed with this software.
238
240 Wietse Venema
241 IBM T.J. Watson Research
242 P.O. Box 704
243 Yorktown Heights, NY 10598, USA
244 POSTCONF(1)