external/ibm-public/postfix/dist/man/man8/master.8

   1 .\"     $NetBSD$
   2 .\"
   3 .TH MASTER 8
   4 .ad
   5 .fi
   6 .SH NAME
   7 master
   8 \-
   9 Postfix master process
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 \fBmaster\fR [\fB-Ddtv\fR] [\fB-c \fIconfig_dir\fR] [\fB-e \fIexit_time\fR]
  14 .SH DESCRIPTION
  15 .ad
  16 .fi
  17 The \fBmaster\fR(8) daemon is the resident process that runs Postfix
  18 daemons on demand: daemons to send or receive messages via the
  19 network, daemons to deliver mail locally, etc.  These daemons are
  20 created on demand up to a configurable maximum number per service.
  21
  22 Postfix daemons terminate voluntarily, either after being idle for
  23 a configurable amount of time, or after having serviced a
  24 configurable number of requests. Exceptions to this rule are the
  25 resident queue manager, address verification server, and the TLS
  26 session cache and pseudo-random number server.
  27
  28 The behavior of the \fBmaster\fR(8) daemon is controlled by the
  29 \fBmaster.cf\fR configuration file, as described in \fBmaster\fR(5).
  30
  31 Options:
  32 .IP "\fB-c \fIconfig_dir\fR"
  33 Read the \fBmain.cf\fR and \fBmaster.cf\fR configuration files in
  34 the named directory instead of the default configuration directory.
  35 This also overrides the configuration files for other Postfix
  36 daemon processes.
  37 .IP \fB-D\fR
  38 After initialization, run a debugger on the master process. The
  39 debugging command is specified with the \fBdebugger_command\fR in
  40 the \fBmain.cf\fR global configuration file.
  41 .IP \fB-d\fR
  42 Do not redirect stdin, stdout or stderr to /dev/null, and
  43 do not discard the controlling terminal. This must be used
  44 for debugging only.
  45 .IP "\fB-e \fIexit_time\fR"
  46 Terminate the master process after \fIexit_time\fR seconds. Child
  47 processes terminate at their convenience.
  48 .IP \fB-t\fR
  49 Test mode. Return a zero exit status when the \fBmaster.pid\fR lock
  50 file does not exist or when that file is not locked.  This is evidence
  51 that the \fBmaster\fR(8) daemon is not running.
  52 .IP \fB-v\fR
  53 Enable verbose logging for debugging purposes. This option
  54 is passed on to child processes. Multiple \fB-v\fR options
  55 make the software increasingly verbose.
  56 .PP
  57 Signals:
  58 .IP \fBSIGHUP\fR
  59 Upon receipt of a \fBHUP\fR signal (e.g., after "\fBpostfix reload\fR"),
  60 the master process re-reads its configuration files. If a service has
  61 been removed from the \fBmaster.cf\fR file, its running processes
  62 are terminated immediately.
  63 Otherwise, running processes are allowed to terminate as soon
  64 as is convenient, so that changes in configuration settings
  65 affect only new service requests.
  66 .IP \fBSIGTERM\fR
  67 Upon receipt of a \fBTERM\fR signal (e.g., after "\fBpostfix abort\fR"),
  68 the master process passes the signal on to its child processes and
  69 terminates.
  70 This is useful for an emergency shutdown. Normally one would
  71 terminate only the master ("\fBpostfix stop\fR") and allow running
  72 processes to finish what they are doing.
  73 .SH DIAGNOSTICS
  74 .ad
  75 .fi
  76 Problems are reported to \fBsyslogd\fR(8).
  77 .SH "ENVIRONMENT"
  78 .na
  79 .nf
  80 .ad
  81 .fi
  82 .IP \fBMAIL_DEBUG\fR
  83 After initialization, start a debugger as specified with the
  84 \fBdebugger_command\fR configuration parameter in the \fBmain.cf\fR
  85 configuration file.
  86 .IP \fBMAIL_CONFIG\fR
  87 Directory with Postfix configuration files.
  88 .SH "CONFIGURATION PARAMETERS"
  89 .na
  90 .nf
  91 .ad
  92 .fi
  93 Unlike most Postfix daemon processes, the \fBmaster\fR(8) server does
  94 not automatically pick up changes to \fBmain.cf\fR. Changes
  95 to \fBmaster.cf\fR are never picked up automatically.
  96 Use the "\fBpostfix reload\fR" command after a configuration change.
  97 .SH "RESOURCE AND RATE CONTROLS"
  98 .na
  99 .nf
 100 .ad
 101 .fi
 102 .IP "\fBdefault_process_limit (100)\fR"
 103 The default maximal number of Postfix child processes that provide
 104 a given service.
 105 .IP "\fBmax_idle (100s)\fR"
 106 The maximum amount of time that an idle Postfix daemon process waits
 107 for an incoming connection before terminating voluntarily.
 108 .IP "\fBmax_use (100)\fR"
 109 The maximal number of incoming connections that a Postfix daemon
 110 process will service before terminating voluntarily.
 111 .IP "\fBservice_throttle_time (60s)\fR"
 112 How long the Postfix \fBmaster\fR(8) waits before forking a server that
 113 appears to be malfunctioning.
 114 .PP
 115 Available in Postfix version 2.6 and later:
 116 .IP "\fBmaster_service_disable (empty)\fR"
 117 Selectively disable \fBmaster\fR(8) listener ports by service type
 118 or by service name and type.
 119 .SH "MISCELLANEOUS CONTROLS"
 120 .na
 121 .nf
 122 .ad
 123 .fi
 124 .IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 125 The default location of the Postfix main.cf and master.cf
 126 configuration files.
 127 .IP "\fBdaemon_directory (see 'postconf -d' output)\fR"
 128 The directory with Postfix support programs and daemon programs.
 129 .IP "\fBdebugger_command (empty)\fR"
 130 The external command to execute when a Postfix daemon program is
 131 invoked with the -D option.
 132 .IP "\fBinet_interfaces (all)\fR"
 133 The network interface addresses that this mail system receives
 134 mail on.
 135 .IP "\fBinet_protocols (ipv4)\fR"
 136 The Internet protocols Postfix will attempt to use when making
 137 or accepting connections.
 138 .IP "\fBimport_environment (see 'postconf -d' output)\fR"
 139 The list of environment parameters that a Postfix process will
 140 import from a non-Postfix parent process.
 141 .IP "\fBmail_owner (postfix)\fR"
 142 The UNIX system account that owns the Postfix queue and most Postfix
 143 daemon processes.
 144 .IP "\fBprocess_id (read-only)\fR"
 145 The process ID of a Postfix command or daemon process.
 146 .IP "\fBprocess_name (read-only)\fR"
 147 The process name of a Postfix command or daemon process.
 148 .IP "\fBqueue_directory (see 'postconf -d' output)\fR"
 149 The location of the Postfix top-level queue directory.
 150 .IP "\fBsyslog_facility (mail)\fR"
 151 The syslog facility of Postfix logging.
 152 .IP "\fBsyslog_name (see 'postconf -d' output)\fR"
 153 The mail system name that is prepended to the process name in syslog
 154 records, so that "smtpd" becomes, for example, "postfix/smtpd".
 155 .SH "FILES"
 156 .na
 157 .nf
 158 .ad
 159 .fi
 160 To expand the directory names below into their actual values,
 161 use the command "\fBpostconf config_directory\fR" etc.
 162 .na
 163 .nf
 164
 165 $config_directory/main.cf, global configuration file.
 166 $config_directory/master.cf, master server configuration file.
 167 $queue_directory/pid/master.pid, master lock file.
 168 $data_directory/master.lock, master lock file.
 169 .SH "SEE ALSO"
 170 .na
 171 .nf
 172 qmgr(8), queue manager
 173 verify(8), address verification
 174 master(5), master.cf configuration file syntax
 175 postconf(5), main.cf configuration parameter syntax
 176 syslogd(8), system logging
 177 .SH "LICENSE"
 178 .na
 179 .nf
 180 .ad
 181 .fi
 182 The Secure Mailer license must be distributed with this software.
 183 .SH "AUTHOR(S)"
 184 .na
 185 .nf
 186 Wietse Venema
 187 IBM T.J. Watson Research
 188 P.O. Box 704
 189 Yorktown Heights, NY 10598, USA