1<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" 2 "http://www.w3.org/TR/html4/loose.dtd"> 3<html> <head> 4<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> 5<title> Postfix manual - postconf(1) </title> 6</head> <body> <pre> 7POSTCONF(1) POSTCONF(1) 8 9<b>NAME</b> 10 postconf - Postfix configuration utility 11 12<b>SYNOPSIS</b> 13 <b>Managing <a href="postconf.5.html">main.cf</a>:</b> 14 15 <b>postconf</b> [<b>-dfhnopvx</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<b>-C</b> <i>class,...</i>] [<i>parameter ...</i>] 16 17 <b>postconf</b> [<b>-epv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>parameter</i><b>=</b><i>value ...</i> 18 19 <b>postconf -#</b> [<b>-pv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>parameter ...</i> 20 21 <b>postconf -X</b> [<b>-pv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>parameter ...</i> 22 23 <b>Managing <a href="master.5.html">master.cf</a> service entries:</b> 24 25 <b>postconf -M</b> [<b>-fovx</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>service</i>[<b>/</b><i>type</i>] <i>...</i>] 26 27 <b>postconf -M</b> [<b>-ev</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>service</i><b>/</b><i>type</i><b>=</b><i>value ...</i> 28 29 <b>postconf -M#</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>service</i><b>/</b><i>type ...</i> 30 31 <b>postconf -MX</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>service</i><b>/</b><i>type ...</i> 32 33 <b>Managing <a href="master.5.html">master.cf</a> service fields:</b> 34 35 <b>postconf -F</b> [<b>-fovx</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>service</i>[<b>/</b><i>type</i>[<b>/</b><i>field</i>]] <i>...</i>] 36 37 <b>postconf -F</b> [<b>-ev</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>service</i><b>/</b><i>type</i><b>/</b><i>field</i><b>=</b><i>value ...</i> 38 39 <b>Managing <a href="master.5.html">master.cf</a> service parameters:</b> 40 41 <b>postconf -P</b> [<b>-fovx</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>service</i>[<b>/</b><i>type</i>[<b>/</b><i>parameter</i>]] <i>...</i>] 42 43 <b>postconf -P</b> [<b>-ev</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>service</i><b>/</b><i>type</i><b>/</b><i>parameter</i><b>=</b><i>value ...</i> 44 45 <b>postconf -PX</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>service</i><b>/</b><i>type</i><b>/</b><i>parameter ...</i> 46 47 <b>Managing bounce message templates:</b> 48 49 <b>postconf -b</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>template</i><b>_</b><i>file</i>] 50 51 <b>postconf -t</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>template</i><b>_</b><i>file</i>] 52 53 <b>Managing other configuration:</b> 54 55 <b>postconf -a</b>|<b>-A</b>|<b>-l</b>|<b>-m</b> [<b>-v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] 56 57<b>DESCRIPTION</b> 58 By default, the <a href="postconf.1.html"><b>postconf</b>(1)</a> command displays the values of <a href="postconf.5.html"><b>main.cf</b></a> con- 59 figuration parameters, and warns about possible mis-typed parameter 60 names (Postfix 2.9 and later). It can also change <a href="postconf.5.html"><b>main.cf</b></a> configura- 61 tion parameter values, or display other configuration information about 62 the Postfix mail system. 63 64 Options: 65 66 <b>-a</b> List the available SASL server plug-in types. The SASL plug-in 67 type is selected with the <b><a href="postconf.5.html#smtpd_sasl_type">smtpd_sasl_type</a></b> configuration parame- 68 ter by specifying one of the names listed below. 69 70 <b>cyrus</b> This server plug-in is available when Postfix is built 71 with Cyrus SASL support. 72 73 <b>dovecot</b> 74 This server plug-in uses the Dovecot authentication 75 server, and is available when Postfix is built with any 76 form of SASL support. 77 78 This feature is available with Postfix 2.3 and later. 79 80 <b>-A</b> List the available SASL client plug-in types. The SASL plug-in 81 type is selected with the <b><a href="postconf.5.html#smtp_sasl_type">smtp_sasl_type</a></b> or <b><a href="postconf.5.html#lmtp_sasl_type">lmtp_sasl_type</a></b> con- 82 figuration parameters by specifying one of the names listed 83 below. 84 85 <b>cyrus</b> This client plug-in is available when Postfix is built 86 with Cyrus SASL support. 87 88 This feature is available with Postfix 2.3 and later. 89 90 <b>-b</b> [<i>template</i><b>_</b><i>file</i>] 91 Display the message text that appears at the beginning of deliv- 92 ery status notification (DSN) messages, replacing $<b>name</b> expres- 93 sions with actual values as described in <a href="bounce.5.html"><b>bounce</b>(5)</a>. 94 95 To override the built-in templates, specify a template file name 96 at the end of the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line, or specify a file 97 name in <a href="postconf.5.html"><b>main.cf</b></a> with the <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a></b> parameter. 98 99 To force selection of the built-in templates, specify an empty 100 template file name on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line (in shell 101 language: ""). 102 103 This feature is available with Postfix 2.3 and later. 104 105 <b>-c</b> <i>config</i><b>_</b><i>dir</i> 106 The <a href="postconf.5.html"><b>main.cf</b></a> configuration file is in the named directory instead 107 of the default configuration directory. 108 109 <b>-C</b> <i>class,...</i> 110 When displaying <a href="postconf.5.html"><b>main.cf</b></a> parameters, select only parameters from 111 the specified class(es): 112 113 <b>builtin</b> 114 Parameters with built-in names. 115 116 <b>service</b> 117 Parameters with service-defined names (the first field of 118 a <a href="master.5.html"><b>master.cf</b></a> entry plus a Postfix-defined suffix). 119 120 <b>user</b> Parameters with user-defined names. 121 122 <b>all</b> All the above classes. 123 124 The default is as if "<b>-C all</b>" is specified. 125 126 This feature is available with Postfix 2.9 and later. 127 128 <b>-d</b> Print <a href="postconf.5.html"><b>main.cf</b></a> default parameter settings instead of actual set- 129 tings. Specify <b>-df</b> to fold long lines for human readability 130 (Postfix 2.9 and later). 131 132 <b>-e</b> Edit the <a href="postconf.5.html"><b>main.cf</b></a> configuration file, and update parameter set- 133 tings with the "<i>name=value</i>" pairs on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command 134 line. 135 136 With <b>-M</b>, edit the <a href="master.5.html"><b>master.cf</b></a> configuration file, and replace one 137 or more service entries with new values as specified with "<i>ser-</i> 138 <i>vice/type=value</i>" on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. 139 140 With <b>-F</b>, edit the <a href="master.5.html"><b>master.cf</b></a> configuration file, and replace one 141 or more service fields with new values as specied with "<i>ser-</i> 142 <i>vice/type/field=value</i>" on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. Cur- 143 rently, the "command" field contains the command name and com- 144 mand arguments. this may change in the near future, so that the 145 "command" field contains only the command name, and a new "argu- 146 ments" pseudofield contains the command arguments. 147 148 With <b>-P</b>, edit the <a href="master.5.html"><b>master.cf</b></a> configuration file, and add or 149 update one or more service parameter settings (-o parame- 150 ter=value settings) with new values as specied with "<i>ser-</i> 151 <i>vice/type/parameter=value</i>" on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. 152 153 In all cases the file is copied to a temporary file then renamed 154 into place. Specify quotes to protect special characters and 155 whitespace on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. 156 157 The <b>-e</b> option is no longer needed with Postfix version 2.8 and 158 later. 159 160 <b>-f</b> Fold long lines when printing <a href="postconf.5.html"><b>main.cf</b></a> or <a href="master.5.html"><b>master.cf</b></a> configuration 161 file entries, for human readability. 162 163 This feature is available with Postfix 2.9 and later. 164 165 <b>-F</b> Show <a href="master.5.html"><b>master.cf</b></a> per-entry field settings (by default all services 166 and all fields), formatted as one "<i>service/type/field=value</i>" per 167 line. Specify <b>-Ff</b> to fold long lines. 168 169 Specify one or more "<i>service/type/field</i>" instances on the <a href="postconf.1.html"><b>post-</b></a> 170 <a href="postconf.1.html"><b>conf</b>(1)</a> command line to limit the output to fields of interest. 171 Trailing parameter name or service type fields that are omitted 172 will be handled as "*" wildcard fields. 173 174 This feature is available with Postfix 2.11 and later. 175 176 <b>-h</b> Show parameter or attribute values without the "<i>name</i> = " label 177 that normally precedes the value. 178 179 <b>-l</b> List the names of all supported mailbox locking methods. Post- 180 fix supports the following methods: 181 182 <b>flock</b> A kernel-based advisory locking method for local files 183 only. This locking method is available on systems with a 184 BSD compatible library. 185 186 <b>fcntl</b> A kernel-based advisory locking method for local and 187 remote files. 188 189 <b>dotlock</b> 190 An application-level locking method. An application locks 191 a file named <i>filename</i> by creating a file named <i>file-</i> 192 <i>name</i><b>.lock</b>. The application is expected to remove its own 193 lock file, as well as stale lock files that were left 194 behind after abnormal program termination. 195 196 <b>-m</b> List the names of all supported lookup table types. In Postfix 197 configuration files, lookup tables are specified as <i>type</i><b>:</b><i>name</i>, 198 where <i>type</i> is one of the types listed below. The table <i>name</i> syn- 199 tax depends on the lookup table type as described in the <a href="DATABASE_README.html">DATA</a>- 200 <a href="DATABASE_README.html">BASE_README</a> document. 201 202 <b>btree</b> A sorted, balanced tree structure. Available on systems 203 with support for Berkeley DB databases. 204 205 <b>cdb</b> A read-optimized structure with no support for incremen- 206 tal updates. Available on systems with support for CDB 207 databases. 208 209 <b>cidr</b> A table that associates values with Classless Inter- 210 Domain Routing (CIDR) patterns. This is described in 211 <a href="cidr_table.5.html"><b>cidr_table</b>(5)</a>. 212 213 <b>dbm</b> An indexed file type based on hashing. Available on sys- 214 tems with support for DBM databases. 215 216 <b>environ</b> 217 The UNIX process environment array. The lookup key is the 218 variable name. Originally implemented for testing, some- 219 one may find this useful someday. 220 221 <b>fail</b> A table that reliably fails all requests. The lookup ta- 222 ble name is used for logging. This table exists to sim- 223 plify Postfix error tests. 224 225 <b>hash</b> An indexed file type based on hashing. Available on sys- 226 tems with support for Berkeley DB databases. 227 228 <b>internal</b> 229 A non-shared, in-memory hash table. Its content are lost 230 when a process terminates. 231 232 <b>lmdb</b> OpenLDAP LMDB database (a memory-mapped, persistent 233 file). Available on systems with support for LMDB data- 234 bases. This is described in <a href="lmdb_table.5.html"><b>lmdb_table</b>(5)</a>. 235 236 <b>ldap</b> (read-only) 237 LDAP database client. This is described in <a href="ldap_table.5.html"><b>ldap_table</b>(5)</a>. 238 239 <b>memcache</b> 240 Memcache database client. This is described in <a href="memcache_table.5.html"><b>mem-</b></a> 241 <a href="memcache_table.5.html"><b>cache_table</b>(5)</a>. 242 243 <b>mysql</b> (read-only) 244 MySQL database client. Available on systems with support 245 for MySQL databases. This is described in <a href="mysql_table.5.html"><b>mysql_ta-</b></a> 246 <a href="mysql_table.5.html"><b>ble</b>(5)</a>. 247 248 <b>pcre</b> (read-only) 249 A lookup table based on Perl Compatible Regular Expres- 250 sions. The file format is described in <a href="pcre_table.5.html"><b>pcre_table</b>(5)</a>. 251 252 <b>pgsql</b> (read-only) 253 PostgreSQL database client. This is described in 254 <a href="pgsql_table.5.html"><b>pgsql_table</b>(5)</a>. 255 256 <b>proxy</b> Postfix <a href="proxymap.8.html"><b>proxymap</b>(8)</a> client for shared access to Postfix 257 databases. The table name syntax is <i>type</i><b>:</b><i>name</i>. 258 259 <b>regexp</b> (read-only) 260 A lookup table based on regular expressions. The file 261 format is described in <a href="regexp_table.5.html"><b>regexp_table</b>(5)</a>. 262 263 <b>sdbm</b> An indexed file type based on hashing. Available on sys- 264 tems with support for SDBM databases. 265 266 <b>socketmap</b> (read-only) 267 Sendmail-style socketmap client. The table name is 268 <b>inet</b>:<i>host</i>:<i>port</i>:<i>name</i> for a TCP/IP server, or <b>unix</b>:<i>path-</i> 269 <i>name</i>:<i>name</i> for a UNIX-domain server. This is described in 270 <a href="socketmap_table.5.html"><b>socketmap_table</b>(5)</a>. 271 272 <b>sqlite</b> (read-only) 273 SQLite database. This is described in <a href="sqlite_table.5.html"><b>sqlite_table</b>(5)</a>. 274 275 <b>static</b> (read-only) 276 A table that always returns its name as lookup result. 277 For example, <b><a href="DATABASE_README.html#types">static</a>:foobar</b> always returns the string <b>foo-</b> 278 <b>bar</b> as lookup result. 279 280 <b>tcp</b> (read-only) 281 TCP/IP client. The protocol is described in <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>. 282 283 <b>texthash</b> (read-only) 284 Produces similar results as <a href="DATABASE_README.html#types">hash</a>: files, except that you 285 don't need to run the <a href="postmap.1.html"><b>postmap</b>(1)</a> command before you can 286 use the file, and that it does not detect changes after 287 the file is read. 288 289 <b>unix</b> (read-only) 290 A limited view of the UNIX authentication database. The 291 following tables are implemented: 292 293 <b>unix:passwd.byname</b> 294 The table is the UNIX password database. The key 295 is a login name. The result is a password file 296 entry in <b>passwd</b>(5) format. 297 298 <b>unix:group.byname</b> 299 The table is the UNIX group database. The key is a 300 group name. The result is a group file entry in 301 <b>group</b>(5) format. 302 303 Other table types may exist depending on how Postfix was built. 304 305 <b>-M</b> Show <a href="master.5.html"><b>master.cf</b></a> file contents instead of <a href="postconf.5.html"><b>main.cf</b></a> file contents. 306 Specify <b>-Mf</b> to fold long lines for human readability. 307 308 Specify zero or more arguments, each with a <i>service-name</i> or <i>ser-</i> 309 <i>vice-name/service-type</i> pair, where <i>service-name</i> is the first 310 field of a <a href="master.5.html">master.cf</a> entry and <i>service-type</i> is one of (<b>inet</b>, 311 <b>unix</b>, <b>fifo</b>, or <b>pass</b>). 312 313 If <i>service-name</i> or <i>service-name/service-type</i> is specified, only 314 the matching <a href="master.5.html">master.cf</a> entries will be output. For example, 315 "<b>postconf -Mf smtp</b>" will output all services named "smtp", and 316 "<b>postconf -Mf smtp/inet</b>" will output only the smtp service that 317 listens on the network. Trailing service type fields that are 318 omitted will be handled as "*" wildcard fields. 319 320 This feature is available with Postfix 2.9 and later. The syntax 321 was changed from "<i>name.type</i>" to "<i>name/type</i>", and "*" wildcard 322 support was added with Postfix 2.11. 323 324 <b>-n</b> Show only configuration parameters that have explicit <i>name=value</i> 325 settings in <a href="postconf.5.html"><b>main.cf</b></a>. Specify <b>-nf</b> to fold long lines for human 326 readability (Postfix 2.9 and later). 327 328 <b>-o</b> <i>name=value</i> 329 Override <a href="postconf.5.html"><b>main.cf</b></a> parameter settings. 330 331 This feature is available with Postfix 2.10 and later. 332 333 <b>-p</b> Show <a href="postconf.5.html"><b>main.cf</b></a> parameter settings. This is the default. 334 335 This feature is available with Postfix 2.11 and later. 336 337 <b>-P</b> Show <a href="master.5.html"><b>master.cf</b></a> service parameter settings (by default all ser- 338 vices and all parameters). formatted as one "<i>ser-</i> 339 <i>vice/type/parameter=value</i>" per line. Specify <b>-Pf</b> to fold long 340 lines. 341 342 Specify one or more "<i>service/type/parameter</i>" instances on the 343 <a href="postconf.1.html"><b>postconf</b>(1)</a> command line to limit the output to parameters of 344 interest. Trailing parameter name or service type fields that 345 are omitted will be handled as "*" wildcard fields. 346 347 This feature is available with Postfix 2.11 and later. 348 349 <b>-t</b> [<i>template</i><b>_</b><i>file</i>] 350 Display the templates for text that appears at the beginning of 351 delivery status notification (DSN) messages, without expanding 352 $<b>name</b> expressions. 353 354 To override the built-in templates, specify a template file name 355 at the end of the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line, or specify a file 356 name in <a href="postconf.5.html"><b>main.cf</b></a> with the <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a></b> parameter. 357 358 To force selection of the built-in templates, specify an empty 359 template file name on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line (in shell 360 language: ""). 361 362 This feature is available with Postfix 2.3 and later. 363 364 <b>-v</b> Enable verbose logging for debugging purposes. Multiple <b>-v</b> 365 options make the software increasingly verbose. 366 367 <b>-x</b> Expand <i>$name</i> in <a href="postconf.5.html"><b>main.cf</b></a> or <a href="master.5.html"><b>master.cf</b></a> parameter values. The 368 expansion is recursive. 369 370 This feature is available with Postfix 2.10 and later. 371 372 <b>-X</b> Edit the <a href="postconf.5.html"><b>main.cf</b></a> configuration file, and remove the parameters 373 named on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. Specify a list of param- 374 eter names, not "<i>name=value</i>" pairs. 375 376 With <b>-M</b>, edit the <a href="master.5.html"><b>master.cf</b></a> configuration file, and remove one 377 or more service entries as specified with "<i>service/type</i>" on the 378 <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. 379 380 With <b>-P</b>, edit the <a href="master.5.html"><b>master.cf</b></a> configuration file, and remove one 381 or more service parameter settings (-o parameter=value settings) 382 as specied with "<i>service/type/parameter</i>" on the <a href="postconf.1.html"><b>postconf</b>(1)</a> com- 383 mand line. 384 385 In all cases the file is copied to a temporary file then renamed 386 into place. Specify quotes to protect special characters on the 387 <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. 388 389 There is no <a href="postconf.1.html"><b>postconf</b>(1)</a> command to perform the reverse opera- 390 tion. 391 392 This feature is available with Postfix 2.10 and later. Support 393 for -M and -P was added with Postfix 2.11. 394 395 <b>-#</b> Edit the <a href="postconf.5.html"><b>main.cf</b></a> configuration file, and comment out the parame- 396 ters named on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line, so that those param- 397 eters revert to their default values. Specify a list of parame- 398 ter names, not "<i>name=value</i>" pairs. 399 400 With <b>-M</b>, edit the <a href="master.5.html"><b>master.cf</b></a> configuration file, and comment out 401 one or more service entries as specified with "<i>service/type</i>" on 402 the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. 403 404 In all cases the file is copied to a temporary file then renamed 405 into place. Specify quotes to protect special characters on the 406 <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. 407 408 There is no <a href="postconf.1.html"><b>postconf</b>(1)</a> command to perform the reverse opera- 409 tion. 410 411 This feature is available with Postfix 2.6 and later. Support 412 for -M was added with Postfix 2.11. 413 414<b>DIAGNOSTICS</b> 415 Problems are reported to the standard error stream. 416 417<b>ENVIRONMENT</b> 418 <b>MAIL_CONFIG</b> 419 Directory with Postfix configuration files. 420 421<b>CONFIGURATION PARAMETERS</b> 422 The following <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant to this pro- 423 gram. 424 425 The text below provides only a parameter summary. See <a href="postconf.5.html"><b>postconf</b>(5)</a> for 426 more details including examples. 427 428 <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b> 429 The default location of the Postfix <a href="postconf.5.html">main.cf</a> and <a href="master.5.html">master.cf</a> con- 430 figuration files. 431 432 <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a> (empty)</b> 433 Pathname of a configuration file with bounce message templates. 434 435<b>FILES</b> 436 /etc/postfix/<a href="postconf.5.html">main.cf</a>, Postfix configuration parameters 437 /etc/postfix/<a href="master.5.html">master.cf</a>, Postfix master daemon configuration 438 439<b>SEE ALSO</b> 440 <a href="bounce.5.html">bounce(5)</a>, bounce template file format <a href="master.5.html">master(5)</a>, <a href="master.5.html">master.cf</a> 441 configuration file syntax <a href="postconf.5.html">postconf(5)</a>, <a href="postconf.5.html">main.cf</a> configuration 442 file syntax 443 444<b>README FILES</b> 445 <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview 446 447<b>LICENSE</b> 448 The Secure Mailer license must be distributed with this software. 449 450<b>AUTHOR(S)</b> 451 Wietse Venema 452 IBM T.J. Watson Research 453 P.O. Box 704 454 Yorktown Heights, NY 10598, USA 455 456 POSTCONF(1) 457</pre> </body> </html> 458