diff options
Diffstat (limited to '')
| -rw-r--r-- | html/postfix.1.html | 453 |
1 files changed, 453 insertions, 0 deletions
diff --git a/html/postfix.1.html b/html/postfix.1.html new file mode 100644 index 0000000..d69e1ec --- /dev/null +++ b/html/postfix.1.html @@ -0,0 +1,453 @@ +<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" + "http://www.w3.org/TR/html4/loose.dtd"> +<html> <head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title> Postfix manual - postfix(1) </title> +</head> <body> <pre> +POSTFIX(1) POSTFIX(1) + +<b>NAME</b> + postfix - Postfix control program + +<b>SYNOPSIS</b> + <b>postfix</b> [<b>-Dv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>command</i> + +<b>DESCRIPTION</b> + This command is reserved for the superuser. To submit mail, use the + Postfix <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command. + + The <a href="postfix.1.html"><b>postfix</b>(1)</a> command controls the operation of the Postfix mail sys- + tem: start or stop the <a href="master.8.html"><b>master</b>(8)</a> daemon, do a health check, and other + maintenance. + + By default, the <a href="postfix.1.html"><b>postfix</b>(1)</a> command sets up a standardized environment + and runs the <b>postfix-script</b> shell script to do the actual work. + + However, when support for multiple Postfix instances is configured, + <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> + <b><a href="postconf.5.html#multi_instance_wrapper">per</a></b> configuration parameter. This command will execute the <i>command</i> for + each applicable Postfix instance. + + The following commands are implemented: + + <b>check</b> Warn about bad directory/file ownership or permissions, and cre- + ate missing directories. + + <b>start</b> Start the Postfix mail system. This also runs the configuration + check described above. + + <b>start-fg</b> + Like <b>start</b>, but keep the <a href="master.8.html"><b>master</b>(8)</a> daemon running in the fore- + ground, and enable <a href="master.8.html"><b>master</b>(8)</a> "init" mode when running as PID 1. + This command requires that multi-instance support is disabled + (i.e. the <a href="postconf.5.html#multi_instance_directories">multi_instance_directories</a> parameter value must be + empty). + + When running Postfix inside a container, see <a href="MAILLOG_README.html">MAILLOG_README</a> for + logging to stdout. Postfix logs to syslog by default, which + requires a) running a syslogd process inside the container, or + b) mounting the container host's /dev/log socket inside the con- + tainer (example: "docker run -v /dev/log:/dev/log ..."), and c) + a distinct Postfix "<a href="postconf.5.html#syslog_name">syslog_name</a>" prefix that identifies logging + from the Postfix instance. + + <b>stop</b> Stop the Postfix mail system in an orderly fashion. If possible, + running processes are allowed to terminate at their earliest + convenience. + + Note: in order to refresh the Postfix mail system after a con- + figuration change, do not use the <b>start</b> and <b>stop</b> commands in + succession. Use the <b>reload</b> command instead. + + <b>abort</b> Stop the Postfix mail system abruptly. Running processes are + signaled to stop immediately. + + <b>flush</b> Force delivery: attempt to deliver every message in the deferred + mail queue. Normally, attempts to deliver delayed mail happen at + regular intervals, the interval doubling after each failed + attempt. + + Warning: flushing undeliverable mail frequently will result in + poor delivery performance of all other mail. + + <b>reload</b> Re-read configuration files. Running processes terminate at + their earliest convenience. + + <b>status</b> Indicate if the Postfix mail system is currently running. + + <b>set-permissions</b> [<i>name</i>=<i>value ...</i>] + Set the ownership and permissions of Postfix related files and + directories, as specified in the <b>postfix-files</b> file. + + Specify <i>name</i>=<i>value</i> to override and update specific <a href="postconf.5.html">main.cf</a> con- + figuration parameters. Use this, for example, to change the + <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 + Postfix system. + + This feature is available in Postfix 2.1 and later. With Post- + fix 2.0 and earlier, use "<b>$<a href="postconf.5.html#config_directory">config_directory</a>/post-install</b> + <b>set-permissions</b>". + + <b>logrotate</b> + Rotate the logfile specified with $<a href="postconf.5.html#maillog_file">maillog_file</a>, by appending a + time-stamp suffix that is formatted according to $<a href="postconf.5.html#maillog_file_rotate_suffix">mail</a>- + <a href="postconf.5.html#maillog_file_rotate_suffix">log_file_rotate_suffix</a>, and by compressing the file with the + command specified with $<a href="postconf.5.html#maillog_file_compressor">maillog_file_compressor</a>. This will not + rotate /dev/* files. + + This feature is available in Postfix 3.4 and later. + + <b>tls</b> <i>subcommand</i> + Enable opportunistic TLS in the Postfix SMTP client or server, + and manage Postfix SMTP server TLS private keys and certifi- + cates. See <a href="postfix-tls.1.html">postfix-tls(1)</a> for documentation. + + This feature is available in Postfix 3.1 and later. + + <b>upgrade-configuration</b> [<i>name</i>=<i>value ...</i>] + 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 + Postfix needs in order to run: add or update services, and add + or update configuration parameter settings. + + Specify <i>name</i>=<i>value</i> to override and update specific <a href="postconf.5.html">main.cf</a> con- + figuration parameters. + + This feature is available in Postfix 2.1 and later. With Post- + fix 2.0 and earlier, use "<b>$<a href="postconf.5.html#config_directory">config_directory</a>/post-install</b> + <b>upgrade-configuration</b>". + + The following options are implemented: + + <b>-c</b> <i>config</i><b>_</b><i>dir</i> + 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 + directory instead of the default configuration directory. Use + this to distinguish between multiple Postfix instances on the + same host. + + With Postfix 2.6 and later, this option forces the <a href="postfix.1.html">postfix(1)</a> + command to operate on the specified Postfix instance only. This + behavior is inherited by <a href="postfix.1.html">postfix(1)</a> commands that run as a + descendant of the current process. + + <b>-D</b> (with <b>postfix start</b> only) + Run each Postfix daemon under control of a debugger as specified + via the <b><a href="postconf.5.html#debugger_command">debugger_command</a></b> configuration parameter. + + <b>-v</b> Enable verbose logging for debugging purposes. Multiple <b>-v</b> + options make the software increasingly verbose. + +<b>ENVIRONMENT</b> + The <a href="postfix.1.html"><b>postfix</b>(1)</a> command exports the following environment variables + before executing the <b>postfix-script</b> file: + + <b>MAIL_CONFIG</b> + This is set when the -c command-line option is present. + + With Postfix 2.6 and later, this environment variable forces the + <a href="postfix.1.html">postfix(1)</a> command to operate on the specified Postfix instance + only. This behavior is inherited by <a href="postfix.1.html">postfix(1)</a> commands that + run as a descendant of the current process. + + <b>MAIL_VERBOSE</b> + This is set when the -v command-line option is present. + + <b>MAIL_DEBUG</b> + This is set when the -D command-line option is present. + + When the internal logging service is enabled (by setting a non-empty + <a href="postconf.5.html#maillog_file">maillog_file</a> parameter value) the <a href="postfix.1.html">postfix(1)</a> command exports settings + that are used by child processes before they have processed <a href="postconf.5.html">main.cf</a> or + command-line settings. + + <b>POSTLOG_SERVICE</b> + The name of the public postlog service endpoint. + + <b>POSTLOG_HOSTNAME</b> + The hostname to prepend to internal logging. + +<b>CONFIGURATION PARAMETERS</b> + The following <a href="postconf.5.html"><b>main.cf</b></a> configuration parameters are exported as environ- + ment variables with the same names: + + <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b> + The default location of the Postfix <a href="postconf.5.html">main.cf</a> and <a href="master.5.html">master.cf</a> con- + figuration files. + + <b><a href="postconf.5.html#command_directory">command_directory</a> (see 'postconf -d' output)</b> + The location of all postfix administrative commands. + + <b><a href="postconf.5.html#daemon_directory">daemon_directory</a> (see 'postconf -d' output)</b> + The directory with Postfix support programs and daemon programs. + + <b><a href="postconf.5.html#html_directory">html_directory</a> (see 'postconf -d' output)</b> + The location of Postfix HTML files that describe how to build, + configure or operate a specific Postfix subsystem or feature. + + <b><a href="postconf.5.html#mail_owner">mail_owner</a> (postfix)</b> + The UNIX system account that owns the Postfix queue and most + Postfix daemon processes. + + <b><a href="postconf.5.html#mailq_path">mailq_path</a> (see 'postconf -d' output)</b> + Sendmail compatibility feature that specifies where the Postfix + <a href="mailq.1.html"><b>mailq</b>(1)</a> command is installed. + + <b><a href="postconf.5.html#manpage_directory">manpage_directory</a> (see 'postconf -d' output)</b> + Where the Postfix manual pages are installed. + + <b><a href="postconf.5.html#newaliases_path">newaliases_path</a> (see 'postconf -d' output)</b> + Sendmail compatibility feature that specifies the location of + the <a href="newaliases.1.html"><b>newaliases</b>(1)</a> command. + + <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b> + The location of the Postfix top-level queue directory. + + <b><a href="postconf.5.html#readme_directory">readme_directory</a> (see 'postconf -d' output)</b> + The location of Postfix README files that describe how to build, + configure or operate a specific Postfix subsystem or feature. + + <b><a href="postconf.5.html#sendmail_path">sendmail_path</a> (see 'postconf -d' output)</b> + A Sendmail compatibility feature that specifies the location of + the Postfix <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command. + + <b><a href="postconf.5.html#setgid_group">setgid_group</a> (postdrop)</b> + The group ownership of set-gid Postfix commands and of + group-writable Postfix directories. + + Available in Postfix version 2.5 and later: + + <b><a href="postconf.5.html#data_directory">data_directory</a> (see 'postconf -d' output)</b> + The directory with Postfix-writable data files (for example: + caches, pseudo-random numbers). + + Available in Postfix version 3.0 and later: + + <b><a href="postconf.5.html#compatibility_level">compatibility_level</a> (0)</b> + A safety net that causes Postfix to run with backwards-compati- + ble default settings after an upgrade to a newer Postfix ver- + sion. + + <b><a href="postconf.5.html#meta_directory">meta_directory</a> (see 'postconf -d' output)</b> + The location of non-executable files that are shared among mul- + tiple Postfix instances, such as postfix-files, dynamicmaps.cf, + and the multi-instance template files <a href="postconf.5.html">main.cf</a>.proto and <a href="master.5.html">mas- + ter.cf</a>.proto. + + <b><a href="postconf.5.html#shlib_directory">shlib_directory</a> (see 'postconf -d' output)</b> + The location of Postfix dynamically-linked libraries (libpost- + fix-*.so), and the default location of Postfix database plugins + (postfix-*.so) that have a relative pathname in the dynam- + icmaps.cf file. + + Available in Postfix version 3.1 and later: + + <b><a href="postconf.5.html#openssl_path">openssl_path</a> (openssl)</b> + The location of the OpenSSL command line program <b>openssl</b>(1). + + Other configuration parameters: + + <b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b> + The list of environment variables that a privileged Postfix + process will import from a non-Postfix parent process, or + name=value environment overrides. + + <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b> + The syslog facility of Postfix logging. + + <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b> + A prefix that is prepended to the process name in syslog + records, so that, for example, "smtpd" becomes "prefix/smtpd". + + Available in Postfix version 2.6 and later: + + <b><a href="postconf.5.html#multi_instance_directories">multi_instance_directories</a> (empty)</b> + An optional list of non-default Postfix configuration directo- + ries; these directories belong to additional Postfix instances + that share the Postfix executable files and documentation with + the default Postfix instance, and that are started, stopped, + etc., together with the default Postfix instance. + + <b><a href="postconf.5.html#multi_instance_wrapper">multi_instance_wrapper</a> (empty)</b> + The pathname of a multi-instance manager command that the <a href="postfix.1.html"><b>post-</b></a> + <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> + parameter value is non-empty. + + <b><a href="postconf.5.html#multi_instance_group">multi_instance_group</a> (empty)</b> + The optional instance group name of this Postfix instance. + + <b><a href="postconf.5.html#multi_instance_name">multi_instance_name</a> (empty)</b> + The optional instance name of this Postfix instance. + + <b><a href="postconf.5.html#multi_instance_enable">multi_instance_enable</a> (no)</b> + Allow this Postfix instance to be started, stopped, etc., by a + multi-instance manager. + + Available in Postfix version 3.4 and later: + + <b><a href="postconf.5.html#maillog_file">maillog_file</a> (empty)</b> + The name of an optional logfile that is written by the Postfix + <a href="postlogd.8.html"><b>postlogd</b>(8)</a> service. + + <b><a href="postconf.5.html#maillog_file_compressor">maillog_file_compressor</a> (gzip)</b> + The program to run after rotating $<a href="postconf.5.html#maillog_file">maillog_file</a> with "postfix + logrotate". + + <b><a href="postconf.5.html#maillog_file_prefixes">maillog_file_prefixes</a> (/var, /dev/stdout)</b> + A list of allowed prefixes for a <a href="postconf.5.html#maillog_file">maillog_file</a> value. + + <b><a href="postconf.5.html#maillog_file_rotate_suffix">maillog_file_rotate_suffix</a> (%Y%m%d-%H%M%S)</b> + The format of the suffix to append to $<a href="postconf.5.html#maillog_file">maillog_file</a> while rotat- + ing the file with "postfix logrotate". + + <b><a href="postconf.5.html#postlog_service_name">postlog_service_name</a> (postlog)</b> + The name of the <a href="postlogd.8.html"><b>postlogd</b>(8)</a> service entry in <a href="master.5.html">master.cf</a>. + +<b>FILES</b> + Prior to Postfix version 2.6, all of the following files were in <b>$<a href="postconf.5.html#config_directory">con</a>-</b> + <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> or <b>$meta_direc-</b> + <b>tory</b> so that they can be shared among multiple instances that run the + same Postfix version. + + 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> + <b><a href="postconf.5.html#daemon_directory">tory</a></b>" to expand the names into their actual values. + + $<a href="postconf.5.html#config_directory">config_directory</a>/<a href="postconf.5.html">main.cf</a>, Postfix configuration parameters + $<a href="postconf.5.html#config_directory">config_directory</a>/<a href="master.5.html">master.cf</a>, Postfix daemon processes + $<a href="postconf.5.html#daemon_directory">daemon_directory</a>/postfix-script, administrative commands + $<a href="postconf.5.html#daemon_directory">daemon_directory</a>/post-install, post-installation configuration + $<a href="postconf.5.html#meta_directory">meta_directory</a>/dynamicmaps.cf, plug-in database clients + $<a href="postconf.5.html#meta_directory">meta_directory</a>/postfix-files, file/directory permissions + +<b>SEE ALSO</b> + Commands: + <a href="postalias.1.html">postalias(1)</a>, create/update/query alias database + <a href="postcat.1.html">postcat(1)</a>, examine Postfix queue file + <a href="postconf.1.html">postconf(1)</a>, Postfix configuration utility + <a href="postdrop.1.html">postdrop(1)</a>, Postfix mail posting utility + <a href="postfix.1.html">postfix(1)</a>, Postfix control program + <a href="postfix-tls.1.html">postfix-tls(1)</a>, Postfix TLS management + <a href="postkick.1.html">postkick(1)</a>, trigger Postfix daemon + <a href="postlock.1.html">postlock(1)</a>, Postfix-compatible locking + <a href="postlog.1.html">postlog(1)</a>, Postfix-compatible logging + <a href="postmap.1.html">postmap(1)</a>, Postfix lookup table manager + <a href="postmulti.1.html">postmulti(1)</a>, Postfix multi-instance manager + <a href="postqueue.1.html">postqueue(1)</a>, Postfix mail queue control + <a href="postsuper.1.html">postsuper(1)</a>, Postfix housekeeping + <a href="mailq.1.html">mailq(1)</a>, Sendmail compatibility interface + <a href="newaliases.1.html">newaliases(1)</a>, Sendmail compatibility interface + <a href="sendmail.1.html">sendmail(1)</a>, Sendmail compatibility interface + + Postfix configuration: + <a href="bounce.5.html">bounce(5)</a>, Postfix bounce message templates + <a href="master.5.html">master(5)</a>, Postfix <a href="master.5.html">master.cf</a> file syntax + <a href="postconf.5.html">postconf(5)</a>, Postfix <a href="postconf.5.html">main.cf</a> file syntax + <a href="postfix-wrapper.5.html">postfix-wrapper(5)</a>, Postfix multi-instance API + + Table-driven mechanisms: + <a href="access.5.html">access(5)</a>, Postfix SMTP access control table + <a href="aliases.5.html">aliases(5)</a>, Postfix alias database + <a href="canonical.5.html">canonical(5)</a>, Postfix input address rewriting + <a href="generic.5.html">generic(5)</a>, Postfix output address rewriting + <a href="header_checks.5.html">header_checks(5)</a>, <a href="header_checks.5.html">body_checks(5)</a>, Postfix content inspection + <a href="relocated.5.html">relocated(5)</a>, Users that have moved + <a href="transport.5.html">transport(5)</a>, Postfix routing table + <a href="virtual.5.html">virtual(5)</a>, Postfix virtual aliasing + + Table lookup mechanisms: + <a href="cidr_table.5.html">cidr_table(5)</a>, Associate CIDR pattern with value + <a href="ldap_table.5.html">ldap_table(5)</a>, Postfix LDAP client + <a href="lmdb_table.5.html">lmdb_table(5)</a>, Postfix LMDB database driver + <a href="memcache_table.5.html">memcache_table(5)</a>, Postfix memcache client + <a href="mysql_table.5.html">mysql_table(5)</a>, Postfix MYSQL client + <a href="nisplus_table.5.html">nisplus_table(5)</a>, Postfix NIS+ client + <a href="pcre_table.5.html">pcre_table(5)</a>, Associate PCRE pattern with value + <a href="pgsql_table.5.html">pgsql_table(5)</a>, Postfix PostgreSQL client + <a href="regexp_table.5.html">regexp_table(5)</a>, Associate POSIX regexp pattern with value + <a href="socketmap_table.5.html">socketmap_table(5)</a>, Postfix socketmap client + <a href="sqlite_table.5.html">sqlite_table(5)</a>, Postfix SQLite database driver + <a href="tcp_table.5.html">tcp_table(5)</a>, Postfix client-server table lookup + + Daemon processes: + <a href="anvil.8.html">anvil(8)</a>, Postfix connection/rate limiting + <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 + <a href="cleanup.8.html">cleanup(8)</a>, canonicalize and enqueue message + <a href="discard.8.html">discard(8)</a>, Postfix discard delivery agent + <a href="dnsblog.8.html">dnsblog(8)</a>, DNS allow/denylist logger + <a href="error.8.html">error(8)</a>, Postfix error delivery agent + <a href="flush.8.html">flush(8)</a>, Postfix fast ETRN service + <a href="local.8.html">local(8)</a>, Postfix local delivery agent + <a href="master.8.html">master(8)</a>, Postfix master daemon + <a href="qmgr.8.html">oqmgr(8)</a>, old Postfix queue manager + <a href="pickup.8.html">pickup(8)</a>, Postfix local mail pickup + <a href="pipe.8.html">pipe(8)</a>, deliver mail to non-Postfix command + <a href="postlogd.8.html">postlogd(8)</a>, Postfix internal logging service + <a href="postscreen.8.html">postscreen(8)</a>, Postfix zombie blocker + <a href="proxymap.8.html">proxymap(8)</a>, Postfix lookup table proxy server + <a href="qmgr.8.html">qmgr(8)</a>, Postfix queue manager + <a href="qmqpd.8.html">qmqpd(8)</a>, Postfix QMQP server + <a href="scache.8.html">scache(8)</a>, Postfix connection cache manager + <a href="showq.8.html">showq(8)</a>, list Postfix mail queue + <a href="smtp.8.html">smtp(8)</a>, <a href="lmtp.8.html">lmtp(8)</a>, Postfix SMTP+LMTP client + <a href="smtpd.8.html">smtpd(8)</a>, Postfix SMTP server + <a href="spawn.8.html">spawn(8)</a>, run non-Postfix server + <a href="tlsmgr.8.html">tlsmgr(8)</a>, Postfix TLS cache and randomness manager + <a href="tlsproxy.8.html">tlsproxy(8)</a>, Postfix TLS proxy server + <a href="trivial-rewrite.8.html">trivial-rewrite(8)</a>, Postfix address rewriting + <a href="verify.8.html">verify(8)</a>, Postfix address verification + <a href="virtual.8.html">virtual(8)</a>, Postfix virtual delivery agent + + Other: + syslogd(8), system logging + +<b>README FILES</b> + <a href="OVERVIEW.html">OVERVIEW</a>, overview of Postfix commands and processes + <a href="BASIC_CONFIGURATION_README.html">BASIC_CONFIGURATION_README</a>, Postfix basic configuration + <a href="ADDRESS_REWRITING_README.html">ADDRESS_REWRITING_README</a>, Postfix address rewriting + <a href="SMTPD_ACCESS_README.html">SMTPD_ACCESS_README</a>, SMTP relay/access control + <a href="CONTENT_INSPECTION_README.html">CONTENT_INSPECTION_README</a>, Postfix content inspection + <a href="QSHAPE_README.html">QSHAPE_README</a>, Postfix queue analysis + +<b>LICENSE</b> + The Secure Mailer license must be distributed with this software. + +<b>AUTHOR(S)</b> + Wietse Venema + IBM T.J. Watson Research + P.O. Box 704 + Yorktown Heights, NY 10598, USA + + Wietse Venema + Google, Inc. + 111 8th Avenue + New York, NY 10011, USA + + TLS support by: + Lutz Jaenicke + Brandenburg University of Technology + Cottbus, Germany + + Victor Duchovni + Morgan Stanley + + SASL support originally by: + Till Franke + SuSE Rhein/Main AG + 65760 Eschborn, Germany + + LMTP support originally by: + Philip A. Prindeville + Mirapoint, Inc. + USA. + + Amos Gouaux + University of Texas at Dallas + P.O. Box 830688, MC34 + Richardson, TX 75083, USA + + IPv6 support originally by: + Mark Huizer, Eindhoven University, The Netherlands + Jun-ichiro 'itojun' Hagino, KAME project, Japan + The Linux PLD project + Dean Strik, Eindhoven University, The Netherlands + + POSTFIX(1) +</pre> </body> </html> |