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 - postfix(1) </title> 6</head> <body> <pre> 7POSTFIX(1) POSTFIX(1) 8 9<b>NAME</b> 10 postfix - Postfix control program 11 12<b>SYNOPSIS</b> 13 <b>postfix</b> [<b>-Dv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>command</i> 14 15<b>DESCRIPTION</b> 16 This command is reserved for the superuser. To submit mail, use the 17 Postfix <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command. 18 19 The <a href="postfix.1.html"><b>postfix</b>(1)</a> command controls the operation of the Postfix mail sys- 20 tem: start or stop the <a href="master.8.html"><b>master</b>(8)</a> daemon, do a health check, and other 21 maintenance. 22 23 By default, the <a href="postfix.1.html"><b>postfix</b>(1)</a> command sets up a standardized environment 24 and runs the <b>postfix-script</b> shell script to do the actual work. 25 26 However, when support for multiple Postfix instances is configured, 27 <a href="postfix.1.html"><b>postfix</b>(1)</a> executes the command specified with the <b><a href="postconf.5.html#multi_instance_wrapper">multi_instance_wrap</a>-</b> 28 <b><a href="postconf.5.html#multi_instance_wrapper">per</a></b> configuration parameter. This command will execute the <i>command</i> for 29 each applicable Postfix instance. 30 31 The following commands are implemented: 32 33 <b>check</b> Warn about bad directory/file ownership or permissions, and cre- 34 ate missing directories. 35 36 <b>start</b> Start the Postfix mail system. This also runs the configuration 37 check described above. 38 39 <b>stop</b> Stop the Postfix mail system in an orderly fashion. If possible, 40 running processes are allowed to terminate at their earliest 41 convenience. 42 43 Note: in order to refresh the Postfix mail system after a con- 44 figuration change, do not use the <b>start</b> and <b>stop</b> commands in 45 succession. Use the <b>reload</b> command instead. 46 47 <b>abort</b> Stop the Postfix mail system abruptly. Running processes are 48 signaled to stop immediately. 49 50 <b>flush</b> Force delivery: attempt to deliver every message in the deferred 51 mail queue. Normally, attempts to deliver delayed mail happen at 52 regular intervals, the interval doubling after each failed 53 attempt. 54 55 Warning: flushing undeliverable mail frequently will result in 56 poor delivery performance of all other mail. 57 58 <b>reload</b> Re-read configuration files. Running processes terminate at 59 their earliest convenience. 60 61 <b>status</b> Indicate if the Postfix mail system is currently running. 62 63 <b>set-permissions</b> [<i>name</i>=<i>value ...</i>] 64 Set the ownership and permissions of Postfix related files and 65 directories, as specified in the <b>postfix-files</b> file. 66 67 Specify <i>name</i>=<i>value</i> to override and update specific <a href="postconf.5.html">main.cf</a> con- 68 figuration parameters. Use this, for example, to change the 69 <b><a href="postconf.5.html#mail_owner">mail_owner</a></b> or <b><a href="postconf.5.html#setgid_group">setgid_group</a></b> setting for an already installed 70 Postfix system. 71 72 This feature is available in Postfix 2.1 and later. With Post- 73 fix 2.0 and earlier, use "<b>$<a href="postconf.5.html#config_directory">config_directory</a>/post-install</b> 74 <b>set-permissions</b>". 75 76 <b>tls</b> <i>subcommand</i> 77 Enable opportunistic TLS in the Postfix SMTP client or server, 78 and manage Postfix SMTP server TLS private keys and certifi- 79 cates. See <a href="postfix-tls.1.html">postfix-tls(1)</a> for documentation. 80 81 This feature is available in Postfix 3.1 and later. 82 83 <b>upgrade-configuration</b> [<i>name</i>=<i>value ...</i>] 84 Update the <a href="postconf.5.html"><b>main.cf</b></a> and <a href="master.5.html"><b>master.cf</b></a> files with information that 85 Postfix needs in order to run: add or update services, and add 86 or update configuration parameter settings. 87 88 Specify <i>name</i>=<i>value</i> to override and update specific <a href="postconf.5.html">main.cf</a> con- 89 figuration parameters. 90 91 This feature is available in Postfix 2.1 and later. With Post- 92 fix 2.0 and earlier, use "<b>$<a href="postconf.5.html#config_directory">config_directory</a>/post-install</b> 93 <b>upgrade-configuration</b>". 94 95 The following options are implemented: 96 97 <b>-c</b> <i>config</i><b>_</b><i>dir</i> 98 Read the <a href="postconf.5.html"><b>main.cf</b></a> and <a href="master.5.html"><b>master.cf</b></a> configuration files in the named 99 directory instead of the default configuration directory. Use 100 this to distinguish between multiple Postfix instances on the 101 same host. 102 103 With Postfix 2.6 and later, this option forces the <a href="postfix.1.html">postfix(1)</a> 104 command to operate on the specified Postfix instance only. This 105 behavior is inherited by <a href="postfix.1.html">postfix(1)</a> commands that run as a 106 descendant of the current process. 107 108 <b>-D</b> (with <b>postfix start</b> only) 109 Run each Postfix daemon under control of a debugger as specified 110 via the <b><a href="postconf.5.html#debugger_command">debugger_command</a></b> configuration parameter. 111 112 <b>-v</b> Enable verbose logging for debugging purposes. Multiple <b>-v</b> 113 options make the software increasingly verbose. 114 115<b>ENVIRONMENT</b> 116 The <a href="postfix.1.html"><b>postfix</b>(1)</a> command exports the following environment variables 117 before executing the <b>postfix-script</b> file: 118 119 <b>MAIL_CONFIG</b> 120 This is set when the -c command-line option is present. 121 122 With Postfix 2.6 and later, this environment variable forces the 123 <a href="postfix.1.html">postfix(1)</a> command to operate on the specified Postfix instance 124 only. This behavior is inherited by <a href="postfix.1.html">postfix(1)</a> commands that 125 run as a descendant of the current process. 126 127 <b>MAIL_VERBOSE</b> 128 This is set when the -v command-line option is present. 129 130 <b>MAIL_DEBUG</b> 131 This is set when the -D command-line option is present. 132 133<b>CONFIGURATION PARAMETERS</b> 134 The following <a href="postconf.5.html"><b>main.cf</b></a> configuration parameters are exported as environ- 135 ment variables with the same names: 136 137 <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b> 138 The default location of the Postfix <a href="postconf.5.html">main.cf</a> and <a href="master.5.html">master.cf</a> con- 139 figuration files. 140 141 <b><a href="postconf.5.html#command_directory">command_directory</a> (see 'postconf -d' output)</b> 142 The location of all postfix administrative commands. 143 144 <b><a href="postconf.5.html#daemon_directory">daemon_directory</a> (see 'postconf -d' output)</b> 145 The directory with Postfix support programs and daemon programs. 146 147 <b><a href="postconf.5.html#html_directory">html_directory</a> (see 'postconf -d' output)</b> 148 The location of Postfix HTML files that describe how to build, 149 configure or operate a specific Postfix subsystem or feature. 150 151 <b><a href="postconf.5.html#mail_owner">mail_owner</a> (postfix)</b> 152 The UNIX system account that owns the Postfix queue and most 153 Postfix daemon processes. 154 155 <b><a href="postconf.5.html#mailq_path">mailq_path</a> (see 'postconf -d' output)</b> 156 Sendmail compatibility feature that specifies where the Postfix 157 <a href="mailq.1.html"><b>mailq</b>(1)</a> command is installed. 158 159 <b><a href="postconf.5.html#manpage_directory">manpage_directory</a> (see 'postconf -d' output)</b> 160 Where the Postfix manual pages are installed. 161 162 <b><a href="postconf.5.html#newaliases_path">newaliases_path</a> (see 'postconf -d' output)</b> 163 Sendmail compatibility feature that specifies the location of 164 the <a href="newaliases.1.html"><b>newaliases</b>(1)</a> command. 165 166 <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b> 167 The location of the Postfix top-level queue directory. 168 169 <b><a href="postconf.5.html#readme_directory">readme_directory</a> (see 'postconf -d' output)</b> 170 The location of Postfix README files that describe how to build, 171 configure or operate a specific Postfix subsystem or feature. 172 173 <b><a href="postconf.5.html#sendmail_path">sendmail_path</a> (see 'postconf -d' output)</b> 174 A Sendmail compatibility feature that specifies the location of 175 the Postfix <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command. 176 177 <b><a href="postconf.5.html#setgid_group">setgid_group</a> (postdrop)</b> 178 The group ownership of set-gid Postfix commands and of 179 group-writable Postfix directories. 180 181 Available in Postfix version 2.5 and later: 182 183 <b><a href="postconf.5.html#data_directory">data_directory</a> (see 'postconf -d' output)</b> 184 The directory with Postfix-writable data files (for example: 185 caches, pseudo-random numbers). 186 187 Available in Postfix version 3.0 and later: 188 189 <b><a href="postconf.5.html#meta_directory">meta_directory</a> (see 'postconf -d' output)</b> 190 The location of non-executable files that are shared among mul- 191 tiple Postfix instances, such as postfix-files, dynamicmaps.cf, 192 and the multi-instance template files <a href="postconf.5.html">main.cf</a>.proto and <a href="master.5.html">mas- 193 ter.cf</a>.proto. 194 195 <b><a href="postconf.5.html#shlib_directory">shlib_directory</a> (see 'postconf -d' output)</b> 196 The location of Postfix dynamically-linked libraries (libpost- 197 fix-*.so), and the default location of Postfix database plugins 198 (postfix-*.so) that have a relative pathname in the dynam- 199 icmaps.cf file. 200 201 Available in Postfix version 3.1 and later: 202 203 <b><a href="postconf.5.html#openssl_path">openssl_path</a> (openssl)</b> 204 The location of the OpenSSL command line program <b>openssl</b>(1). 205 206 Other configuration parameters: 207 208 <b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b> 209 The list of environment parameters that a Postfix process will 210 import from a non-Postfix parent process. 211 212 <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b> 213 The syslog facility of Postfix logging. 214 215 <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b> 216 The mail system name that is prepended to the process name in 217 syslog records, so that "smtpd" becomes, for example, "post- 218 fix/smtpd". 219 220 Available in Postfix version 2.6 and later: 221 222 <b><a href="postconf.5.html#multi_instance_directories">multi_instance_directories</a> (empty)</b> 223 An optional list of non-default Postfix configuration directo- 224 ries; these directories belong to additional Postfix instances 225 that share the Postfix executable files and documentation with 226 the default Postfix instance, and that are started, stopped, 227 etc., together with the default Postfix instance. 228 229 <b><a href="postconf.5.html#multi_instance_wrapper">multi_instance_wrapper</a> (empty)</b> 230 The pathname of a multi-instance manager command that the <a href="postfix.1.html"><b>post-</b></a> 231 <a href="postfix.1.html"><b>fix</b>(1)</a> command invokes when the <a href="postconf.5.html#multi_instance_directories">multi_instance_directories</a> 232 parameter value is non-empty. 233 234 <b><a href="postconf.5.html#multi_instance_group">multi_instance_group</a> (empty)</b> 235 The optional instance group name of this Postfix instance. 236 237 <b><a href="postconf.5.html#multi_instance_name">multi_instance_name</a> (empty)</b> 238 The optional instance name of this Postfix instance. 239 240 <b><a href="postconf.5.html#multi_instance_enable">multi_instance_enable</a> (no)</b> 241 Allow this Postfix instance to be started, stopped, etc., by a 242 multi-instance manager. 243 244<b>FILES</b> 245 Prior to Postfix version 2.6, all of the following files were in <b>$<a href="postconf.5.html#config_directory">con</a>-</b> 246 <b><a href="postconf.5.html#config_directory">fig_directory</a></b>. Some files are now in <b>$<a href="postconf.5.html#daemon_directory">daemon_directory</a></b> so that they can 247 be shared among multiple instances that run the same Postfix version. 248 249 Use the command "<b>postconf <a href="postconf.5.html#config_directory">config_directory</a></b>" or "<b>postconf <a href="postconf.5.html#daemon_directory">daemon_direc</a>-</b> 250 <b><a href="postconf.5.html#daemon_directory">tory</a></b>" to expand the names into their actual values. 251 252 $<a href="postconf.5.html#config_directory">config_directory</a>/<a href="postconf.5.html">main.cf</a>, Postfix configuration parameters 253 $<a href="postconf.5.html#config_directory">config_directory</a>/<a href="master.5.html">master.cf</a>, Postfix daemon processes 254 $<a href="postconf.5.html#daemon_directory">daemon_directory</a>/postfix-files, file/directory permissions 255 $<a href="postconf.5.html#daemon_directory">daemon_directory</a>/postfix-script, administrative commands 256 $<a href="postconf.5.html#daemon_directory">daemon_directory</a>/post-install, post-installation configuration 257 $<a href="postconf.5.html#daemon_directory">daemon_directory</a>/dynamicmaps.cf, plug-in database clients 258 259<b>SEE ALSO</b> 260 Commands: 261 <a href="postalias.1.html">postalias(1)</a>, create/update/query alias database 262 <a href="postcat.1.html">postcat(1)</a>, examine Postfix queue file 263 <a href="postconf.1.html">postconf(1)</a>, Postfix configuration utility 264 <a href="postfix.1.html">postfix(1)</a>, Postfix control program 265 <a href="postfix-tls.1.html">postfix-tls(1)</a>, Postfix TLS management 266 <a href="postkick.1.html">postkick(1)</a>, trigger Postfix daemon 267 <a href="postlock.1.html">postlock(1)</a>, Postfix-compatible locking 268 <a href="postlog.1.html">postlog(1)</a>, Postfix-compatible logging 269 <a href="postmap.1.html">postmap(1)</a>, Postfix lookup table manager 270 <a href="postmulti.1.html">postmulti(1)</a>, Postfix multi-instance manager 271 <a href="postqueue.1.html">postqueue(1)</a>, Postfix mail queue control 272 <a href="postsuper.1.html">postsuper(1)</a>, Postfix housekeeping 273 <a href="mailq.1.html">mailq(1)</a>, Sendmail compatibility interface 274 <a href="newaliases.1.html">newaliases(1)</a>, Sendmail compatibility interface 275 <a href="sendmail.1.html">sendmail(1)</a>, Sendmail compatibility interface 276 277 Postfix configuration: 278 <a href="bounce.5.html">bounce(5)</a>, Postfix bounce message templates 279 <a href="master.5.html">master(5)</a>, Postfix <a href="master.5.html">master.cf</a> file syntax 280 <a href="postconf.5.html">postconf(5)</a>, Postfix <a href="postconf.5.html">main.cf</a> file syntax 281 <a href="postfix-wrapper.5.html">postfix-wrapper(5)</a>, Postfix multi-instance API 282 283 Table-driven mechanisms: 284 <a href="access.5.html">access(5)</a>, Postfix SMTP access control table 285 <a href="aliases.5.html">aliases(5)</a>, Postfix alias database 286 <a href="canonical.5.html">canonical(5)</a>, Postfix input address rewriting 287 <a href="generic.5.html">generic(5)</a>, Postfix output address rewriting 288 <a href="header_checks.5.html">header_checks(5)</a>, <a href="header_checks.5.html">body_checks(5)</a>, Postfix content inspection 289 <a href="relocated.5.html">relocated(5)</a>, Users that have moved 290 <a href="transport.5.html">transport(5)</a>, Postfix routing table 291 <a href="virtual.5.html">virtual(5)</a>, Postfix virtual aliasing 292 293 Table lookup mechanisms: 294 <a href="cidr_table.5.html">cidr_table(5)</a>, Associate CIDR pattern with value 295 <a href="ldap_table.5.html">ldap_table(5)</a>, Postfix LDAP client 296 <a href="lmdb_table.5.html">lmdb_table(5)</a>, Postfix LMDB database driver 297 <a href="memcache_table.5.html">memcache_table(5)</a>, Postfix memcache client 298 <a href="mysql_table.5.html">mysql_table(5)</a>, Postfix MYSQL client 299 <a href="nisplus_table.5.html">nisplus_table(5)</a>, Postfix NIS+ client 300 <a href="pcre_table.5.html">pcre_table(5)</a>, Associate PCRE pattern with value 301 <a href="pgsql_table.5.html">pgsql_table(5)</a>, Postfix PostgreSQL client 302 <a href="regexp_table.5.html">regexp_table(5)</a>, Associate POSIX regexp pattern with value 303 <a href="socketmap_table.5.html">socketmap_table(5)</a>, Postfix socketmap client 304 <a href="sqlite_table.5.html">sqlite_table(5)</a>, Postfix SQLite database driver 305 <a href="tcp_table.5.html">tcp_table(5)</a>, Postfix client-server table lookup 306 307 Daemon processes: 308 <a href="anvil.8.html">anvil(8)</a>, Postfix connection/rate limiting 309 <a href="bounce.8.html">bounce(8)</a>, <a href="defer.8.html">defer(8)</a>, <a href="trace.8.html">trace(8)</a>, Delivery status reports 310 <a href="cleanup.8.html">cleanup(8)</a>, canonicalize and enqueue message 311 <a href="discard.8.html">discard(8)</a>, Postfix discard delivery agent 312 <a href="dnsblog.8.html">dnsblog(8)</a>, DNS black/whitelist logger 313 <a href="error.8.html">error(8)</a>, Postfix error delivery agent 314 <a href="flush.8.html">flush(8)</a>, Postfix fast ETRN service 315 <a href="local.8.html">local(8)</a>, Postfix local delivery agent 316 <a href="master.8.html">master(8)</a>, Postfix master daemon 317 <a href="qmgr.8.html">oqmgr(8)</a>, old Postfix queue manager 318 <a href="pickup.8.html">pickup(8)</a>, Postfix local mail pickup 319 <a href="pipe.8.html">pipe(8)</a>, deliver mail to non-Postfix command 320 <a href="postscreen.8.html">postscreen(8)</a>, Postfix zombie blocker 321 <a href="proxymap.8.html">proxymap(8)</a>, Postfix lookup table proxy server 322 <a href="qmgr.8.html">qmgr(8)</a>, Postfix queue manager 323 <a href="qmqpd.8.html">qmqpd(8)</a>, Postfix QMQP server 324 <a href="scache.8.html">scache(8)</a>, Postfix connection cache manager 325 <a href="showq.8.html">showq(8)</a>, list Postfix mail queue 326 <a href="smtp.8.html">smtp(8)</a>, <a href="lmtp.8.html">lmtp(8)</a>, Postfix SMTP+LMTP client 327 <a href="smtpd.8.html">smtpd(8)</a>, Postfix SMTP server 328 <a href="spawn.8.html">spawn(8)</a>, run non-Postfix server 329 <a href="tlsmgr.8.html">tlsmgr(8)</a>, Postfix TLS cache and randomness manager 330 <a href="tlsproxy.8.html">tlsproxy(8)</a>, Postfix TLS proxy server 331 <a href="trivial-rewrite.8.html">trivial-rewrite(8)</a>, Postfix address rewriting 332 <a href="verify.8.html">verify(8)</a>, Postfix address verification 333 <a href="virtual.8.html">virtual(8)</a>, Postfix virtual delivery agent 334 335 Other: 336 syslogd(8), system logging 337 338<b>README FILES</b> 339 <a href="OVERVIEW.html">OVERVIEW</a>, overview of Postfix commands and processes 340 <a href="BASIC_CONFIGURATION_README.html">BASIC_CONFIGURATION_README</a>, Postfix basic configuration 341 <a href="ADDRESS_REWRITING_README.html">ADDRESS_REWRITING_README</a>, Postfix address rewriting 342 <a href="SMTPD_ACCESS_README.html">SMTPD_ACCESS_README</a>, SMTP relay/access control 343 <a href="CONTENT_INSPECTION_README.html">CONTENT_INSPECTION_README</a>, Postfix content inspection 344 <a href="QSHAPE_README.html">QSHAPE_README</a>, Postfix queue analysis 345 346<b>LICENSE</b> 347 The Secure Mailer license must be distributed with this software. 348 349<b>AUTHOR(S)</b> 350 Wietse Venema 351 IBM T.J. Watson Research 352 P.O. Box 704 353 Yorktown Heights, NY 10598, USA 354 355 Wietse Venema 356 Google, Inc. 357 111 8th Avenue 358 New York, NY 10011, USA 359 360 TLS support by: 361 Lutz Jaenicke 362 Brandenburg University of Technology 363 Cottbus, Germany 364 365 Victor Duchovni 366 Morgan Stanley 367 368 SASL support originally by: 369 Till Franke 370 SuSE Rhein/Main AG 371 65760 Eschborn, Germany 372 373 LMTP support originally by: 374 Philip A. Prindeville 375 Mirapoint, Inc. 376 USA. 377 378 Amos Gouaux 379 University of Texas at Dallas 380 P.O. Box 830688, MC34 381 Richardson, TX 75083, USA 382 383 IPv6 support originally by: 384 Mark Huizer, Eindhoven University, The Netherlands 385 Jun-ichiro 'itojun' Hagino, KAME project, Japan 386 The Linux PLD project 387 Dean Strik, Eindhoven University, The Netherlands 388 389 POSTFIX(1) 390</pre> </body> </html> 391