1POSTCONF(1) General Commands Manual POSTCONF(1)
2
6 postconf - Postfix configuration utility
7
9 Managing main.cf:
10 postconf [-dfhnovx] [-c config_dir] [-C class,...] [parameter ...]
12 postconf [-ev] [-c config_dir] [parameter=value ...]
14 postconf [-#vX] [-c config_dir] [parameter ...]
16 Managing master.cf:
18 postconf [-fMovx] [-c config_dir] [service ...]
20 Managing bounce message templates:
22 postconf [-btv] [-c config_dir] [template_file]
24 Managing other configuration:
26 postconf [-aAlmv] [-c config_dir]
28
30 By default, the postconf(1) command displays the values of main.cf con‐
31 figuration parameters, and warns about possible mis-typed parameter
32 names (Postfix 2.9 and later). It can also change main.cf configura‐
33 tion parameter values, or display other configuration information about
34 the Postfix mail system.
35 Options:
37 -a List the available SASL server plug-in types. The SASL plug-in
39 type is selected with the smtpd_sasl_type configuration parame‐
40 ter by specifying one of the names listed below.
41 cyrus This server plug-in is available when Postfix is built
43 with Cyrus SASL support.
44 dovecot
46 This server plug-in uses the Dovecot authentication
47 server, and is available when Postfix is built with any
48 form of SASL support.
49 This feature is available with Postfix 2.3 and later.
51 -A List the available SASL client plug-in types. The SASL plug-in
53 type is selected with the smtp_sasl_type or lmtp_sasl_type con‐
54 figuration parameters by specifying one of the names listed
55 below.
56 cyrus This client plug-in is available when Postfix is built
58 with Cyrus SASL support.
59 This feature is available with Postfix 2.3 and later.
61 -b [template_file]
63 Display the message text that appears at the beginning of deliv‐
64 ery status notification (DSN) messages, replacing $name expres‐
65 sions with actual values as described in bounce(5).
66 To override the built-in templates, specify a template file name
68 at the end of the postconf(1) command line, or specify a file
69 name in main.cf with the bounce_template_file parameter.
70 To force selection of the built-in templates, specify an empty
72 template file name on the postconf(1) command line (in shell
73 language: "").
74 This feature is available with Postfix 2.3 and later.
76 -c config_dir
78 The main.cf configuration file is in the named directory instead
79 of the default configuration directory.
80 -C class,...
82 When displaying main.cf parameters, select only parameters from
83 the specified class(es):
84 builtin
86 Parameters with built-in names.
87 service
89 Parameters with service-defined names (the first field of
90 a master.cf entry plus a Postfix-defined suffix).
91 user Parameters with user-defined names.
93 all All the above classes.
95 The default is as if "-C all" is specified.
97 -d Print main.cf default parameter settings instead of actual set‐
99 tings. Specify -df to fold long lines for human readability
100 (Postfix 2.9 and later).
101 -e Edit the main.cf configuration file, and update parameter set‐
103 tings with the "name=value" pairs on the postconf(1) command
104 line. The file is copied to a temporary file then renamed into
105 place. Specify quotes to protect special characters and white‐
106 space on the postconf(1) command line.
107 The -e is no longer needed with Postfix version 2.8 and later.
109 -f Fold long lines when printing main.cf or master.cf configuration
111 file entries, for human readability.
112 This feature is available with Postfix 2.9 and later.
114 -h Show main.cf parameter values without the "name = " label that
116 normally precedes the value.
117 -l List the names of all supported mailbox locking methods. Post‐
119 fix supports the following methods:
120 flock A kernel-based advisory locking method for local files
122 only. This locking method is available on systems with a
123 BSD compatible library.
124 fcntl A kernel-based advisory locking method for local and
126 remote files.
127 dotlock
129 An application-level locking method. An application locks
130 a file named filename by creating a file named file‐
131 name.lock. The application is expected to remove its own
132 lock file, as well as stale lock files that were left
133 behind after abnormal program termination.
134 -m List the names of all supported lookup table types. In Postfix
136 configuration files, lookup tables are specified as type:name,
137 where type is one of the types listed below. The table name syn‐
138 tax depends on the lookup table type as described in the DATA‐
139 BASE_README document.
140 btree A sorted, balanced tree structure. This is available on
142 systems with support for Berkeley DB databases.
143 cdb A read-optimized structure with no support for incremen‐
145 tal updates. This is available on systems with support
146 for CDB databases.
147 cidr A table that associates values with Classless Inter-
149 Domain Routing (CIDR) patterns. This is described in
150 cidr_table(5).
151 dbm An indexed file type based on hashing. This is available
153 on systems with support for DBM databases.
154 environ
156 The UNIX process environment array. The lookup key is the
157 variable name. Originally implemented for testing, some‐
158 one may find this useful someday.
159 fail A table that reliably fails all requests. The lookup ta‐
161 ble name is used for logging. This table exists to sim‐
162 plify Postfix error tests.
163 hash An indexed file type based on hashing. This is available
165 on systems with support for Berkeley DB databases.
166 internal
168 A non-shared, in-memory hash table. Its content are lost
169 when a process terminates.
170 ldap (read-only)
172 Perform lookups using the LDAP protocol. This is
173 described in ldap_table(5).
174 memcache
176 Perform lookups using the memcache protocol. This is
177 described in memcache_table(5).
178 mysql (read-only)
180 Perform lookups using the MYSQL protocol. This is
181 described in mysql_table(5).
182 pcre (read-only)
184 A lookup table based on Perl Compatible Regular Expres‐
185 sions. The file format is described in pcre_table(5).
186 pgsql (read-only)
188 Perform lookups using the PostgreSQL protocol. This is
189 described in pgsql_table(5).
190 proxy A lookup table that is implemented via the Postfix prox‐
192 ymap(8) service. The table name syntax is type:name.
193 regexp (read-only)
195 A lookup table based on regular expressions. The file
196 format is described in regexp_table(5).
197 sdbm An indexed file type based on hashing. This is available
199 on systems with support for SDBM databases.
200 socketmap (read-only)
202 Query a Sendmail-style socketmap server. The name of the
203 table specifies inet:host:port:socketmap-name for a TCP-
204 based server, or unix:pathname:socketmap-name for a UNIX-
205 domain server. In both cases, socketmap-name is the name
206 of the socketmap.
207 sqlite (read-only)
209 Perform lookups from SQLite database files. This is
210 described in sqlite_table(5).
211 static (read-only)
213 A table that always returns its name as lookup result.
214 For example, static:foobar always returns the string foo‐
215 bar as lookup result.
216 tcp (read-only)
218 Perform lookups using a simple request-reply protocol
219 that is described in tcp_table(5).
220 texthash (read-only)
222 Produces similar results as hash: files, except that you
223 don't need to run the postmap(1) command before you can
224 use the file, and that it does not detect changes after
225 the file is read.
226 unix (read-only)
228 A limited way to query the UNIX authentication database.
229 The following tables are implemented:
230 unix:passwd.byname
232 The table is the UNIX password database. The key
233 is a login name. The result is a password file
234 entry in passwd(5) format.
235 unix:group.byname
237 The table is the UNIX group database. The key is a
238 group name. The result is a group file entry in
239 group(5) format.
240 Other table types may exist depending on how Postfix was built.
242 -M Show master.cf file contents instead of main.cf file contents.
244 Specify -Mf to fold long lines for human readability.
245 If service ... is specified, only the matching services will be
247 output. For example, "postconf -Mf inet" will output all ser‐
248 vices that listen on the network.
249 Specify zero or more arguments, each with a service-type name
251 (inet, unix, fifo, or pass) or with a service-name.service-type
252 pair, where service-name is the first field of a master.cf
253 entry.
254 This feature is available with Postfix 2.9 and later.
256 -n Show only configuration parameters that have explicit name=value
258 settings in main.cf. Specify -nf to fold long lines for human
259 readability (Postfix 2.9 and later).
260 -o name=value
262 Override main.cf parameter settings.
263 This feature is available with Postfix 2.10 and later.
265 -t [template_file]
267 Display the templates for text that appears at the beginning of
268 delivery status notification (DSN) messages, without expanding
269 $name expressions.
270 To override the built-in templates, specify a template file name
272 at the end of the postconf(1) command line, or specify a file
273 name in main.cf with the bounce_template_file parameter.
274 To force selection of the built-in templates, specify an empty
276 template file name on the postconf(1) command line (in shell
277 language: "").
278 This feature is available with Postfix 2.3 and later.
280 -v Enable verbose logging for debugging purposes. Multiple -v
282 options make the software increasingly verbose.
283 -x Expand $name in main.cf or master.cf parameter values. The
285 expansion is recursive.
286 This feature is available with Postfix 2.10 and later.
288 -X Edit the main.cf configuration file, and remove the parameters
290 named on the postconf(1) command line. The file is copied to a
291 temporary file then renamed into place. Specify a list of
292 parameter names, not "name=value" pairs. There is no post‐
293 conf(1) command to perform the reverse operation.
294 This feature is available with Postfix 2.10 and later.
296 -# Edit the main.cf configuration file, and comment out the parame‐
298 ters named on the postconf(1) command line, so that those param‐
299 eters revert to their default values. The file is copied to a
300 temporary file then renamed into place. Specify a list of
301 parameter names, not "name=value" pairs. There is no post‐
302 conf(1) command to perform the reverse operation.
303 This feature is available with Postfix 2.6 and later.
305
307 Problems are reported to the standard error stream.
308
310 MAIL_CONFIG
311 Directory with Postfix configuration files.
312
314 The following main.cf parameters are especially relevant to this pro‐
315 gram.
316 The text below provides only a parameter summary. See postconf(5) for
318 more details including examples.
319 config_directory (see 'postconf -d' output)
321 The default location of the Postfix main.cf and master.cf con‐
322 figuration files.
323 bounce_template_file (empty)
325 Pathname of a configuration file with bounce message templates.
326
328 /etc/postfix/main.cf, Postfix configuration parameters
329 /etc/postfix/master.cf, Postfix master daemon configuraton
330
332 bounce(5), bounce template file format
333 master(5), master.cf configuration file syntax
334 postconf(5), main.cf configuration file syntax
335
337 Use "postconf readme_directory" or "postconf html_directory" to locate
338 this information.
339 DATABASE_README, Postfix lookup table overview
340
342 The Secure Mailer license must be distributed with this software.
343
345 Wietse Venema
346 IBM T.J. Watson Research
347 P.O. Box 704
348 Yorktown Heights, NY 10598, USA
349 POSTCONF(1)