xref: /netbsd-src/external/ibm-public/postfix/dist/html/master.8.html (revision 8585484ef87f5a04d32332313cdb799625f4faf8)
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 - master(8) </title>
6</head> <body> <pre>
7MASTER(8)                                                            MASTER(8)
8
9<b>NAME</b>
10       master - Postfix master process
11
12<b>SYNOPSIS</b>
13       <b>master</b> [<b>-Ddtvw</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<b>-e</b> <i>exit</i><b>_</b><i>time</i>]
14
15<b>DESCRIPTION</b>
16       The  <a href="master.8.html"><b>master</b>(8)</a>  daemon  is  the resident process that runs
17       Postfix daemons on demand: daemons to send or receive mes-
18       sages  via  the  network, daemons to deliver mail locally,
19       etc.  These daemons are created on demand up to a  config-
20       urable maximum number per service.
21
22       Postfix  daemons terminate voluntarily, either after being
23       idle for a configurable amount of time,  or  after  having
24       serviced  a configurable number of requests. Exceptions to
25       this rule are the resident queue manager, address  verifi-
26       cation server, and the TLS session cache and pseudo-random
27       number server.
28
29       The behavior of the <a href="master.8.html"><b>master</b>(8)</a> daemon is controlled by  the
30       <a href="master.5.html"><b>master.cf</b></a> configuration file, as described in <a href="master.5.html"><b>master</b>(5)</a>.
31
32       Options:
33
34       <b>-c</b> <i>config</i><b>_</b><i>dir</i>
35              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
36              in the named directory instead of the default  con-
37              figuration directory.  This also overrides the con-
38              figuration files  for  other  Postfix  daemon  pro-
39              cesses.
40
41       <b>-D</b>     After  initialization, run a debugger on the master
42              process. The debugging command  is  specified  with
43              the <b><a href="postconf.5.html#debugger_command">debugger_command</a></b> in the <a href="postconf.5.html"><b>main.cf</b></a> global configu-
44              ration file.
45
46       <b>-d</b>     Do  not  redirect  stdin,  stdout  or   stderr   to
47              /dev/null,  and do not discard the controlling ter-
48              minal. This must be used for debugging only.
49
50       <b>-e</b> <i>exit</i><b>_</b><i>time</i>
51              Terminate the master process after  <i>exit</i><b>_</b><i>time</i>  sec-
52              onds.  Child  processes  terminate  at their conve-
53              nience.
54
55       <b>-t</b>     Test mode. Return a zero exit status when the  <b>mas-</b>
56              <b>ter.pid</b>  lock file does not exist or when that file
57              is not locked.  This is evidence that the <a href="master.8.html"><b>master</b>(8)</a>
58              daemon is not running.
59
60       <b>-v</b>     Enable verbose logging for debugging purposes. This
61              option is passed on to child processes. Multiple <b>-v</b>
62              options make the software increasingly verbose.
63
64       <b>-w</b>     Wait  in a dummy foreground process, while the real
65              master daemon initializes in a background  process.
66              The  dummy  foreground  process returns a zero exit
67              status only if the master daemon initialization  is
68              successful,  and  if  it  completes in a reasonable
69              amount of time.
70
71              This feature  is  available  in  Postfix  2.10  and
72              later.
73
74       Signals:
75
76       <b>SIGHUP</b> Upon  receipt of a <b>HUP</b> signal (e.g., after "<b>postfix</b>
77              <b>reload</b>"), the master process re-reads its  configu-
78              ration  files.  If  a service has been removed from
79              the <a href="master.5.html"><b>master.cf</b></a> file, its running processes are  ter-
80              minated  immediately.  Otherwise, running processes
81              are allowed to terminate as soon as is  convenient,
82              so  that  changes  in configuration settings affect
83              only new service requests.
84
85       <b>SIGTERM</b>
86              Upon receipt of a <b>TERM</b> signal (e.g., after "<b>postfix</b>
87              <b>abort</b>"), the master process passes the signal on to
88              its child processes and terminates.  This is useful
89              for  an emergency shutdown. Normally one would ter-
90              minate only the master ("<b>postfix stop</b>")  and  allow
91              running processes to finish what they are doing.
92
93<b>DIAGNOSTICS</b>
94       Problems  are  reported  to <b>syslogd</b>(8). The exit status is
95       non-zero in case of  problems,  including  problems  while
96       initializing as a master daemon process in the background.
97
98<b>ENVIRONMENT</b>
99       <b>MAIL_DEBUG</b>
100              After initialization, start a debugger as specified
101              with  the  <b><a href="postconf.5.html#debugger_command">debugger_command</a></b> configuration parameter
102              in the <a href="postconf.5.html"><b>main.cf</b></a> configuration file.
103
104       <b>MAIL_CONFIG</b>
105              Directory with Postfix configuration files.
106
107<b>CONFIGURATION PARAMETERS</b>
108       Unlike most Postfix daemon processes, the <a href="master.8.html"><b>master</b>(8)</a> server
109       does not automatically pick up changes to <a href="postconf.5.html"><b>main.cf</b></a>. Changes
110       to <a href="master.5.html"><b>master.cf</b></a> are never picked up automatically.   Use  the
111       "<b>postfix reload</b>" command after a configuration change.
112
113<b>RESOURCE AND RATE CONTROLS</b>
114       <b><a href="postconf.5.html#default_process_limit">default_process_limit</a> (100)</b>
115              The  default  maximal  number of Postfix child pro-
116              cesses that provide a given service.
117
118       <b><a href="postconf.5.html#max_idle">max_idle</a> (100s)</b>
119              The maximum amount of time  that  an  idle  Postfix
120              daemon  process  waits  for  an incoming connection
121              before terminating voluntarily.
122
123       <b><a href="postconf.5.html#max_use">max_use</a> (100)</b>
124              The maximal number of incoming connections  that  a
125              Postfix  daemon  process will service before termi-
126              nating voluntarily.
127
128       <b><a href="postconf.5.html#service_throttle_time">service_throttle_time</a> (60s)</b>
129              How long the Postfix <a href="master.8.html"><b>master</b>(8)</a> waits before forking
130              a server that appears to be malfunctioning.
131
132       Available in Postfix version 2.6 and later:
133
134       <b><a href="postconf.5.html#master_service_disable">master_service_disable</a> (empty)</b>
135              Selectively  disable  <a href="master.8.html"><b>master</b>(8)</a>  listener  ports by
136              service type or by service name and type.
137
138<b>MISCELLANEOUS CONTROLS</b>
139       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
140              The default location of  the  Postfix  <a href="postconf.5.html">main.cf</a>  and
141              <a href="master.5.html">master.cf</a> configuration files.
142
143       <b><a href="postconf.5.html#daemon_directory">daemon_directory</a> (see 'postconf -d' output)</b>
144              The  directory  with  Postfix  support programs and
145              daemon programs.
146
147       <b><a href="postconf.5.html#debugger_command">debugger_command</a> (empty)</b>
148              The external command to execute when a Postfix dae-
149              mon program is invoked with the -D option.
150
151       <b><a href="postconf.5.html#inet_interfaces">inet_interfaces</a> (all)</b>
152              The network interface addresses that this mail sys-
153              tem receives mail on.
154
155       <b><a href="postconf.5.html#inet_protocols">inet_protocols</a> (all)</b>
156              The Internet protocols Postfix will attempt to  use
157              when making or accepting connections.
158
159       <b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b>
160              The  list  of environment parameters that a Postfix
161              process  will  import  from  a  non-Postfix  parent
162              process.
163
164       <b><a href="postconf.5.html#mail_owner">mail_owner</a> (postfix)</b>
165              The UNIX system account that owns the Postfix queue
166              and most Postfix daemon processes.
167
168       <b><a href="postconf.5.html#process_id">process_id</a> (read-only)</b>
169              The process ID  of  a  Postfix  command  or  daemon
170              process.
171
172       <b><a href="postconf.5.html#process_name">process_name</a> (read-only)</b>
173              The  process  name  of  a Postfix command or daemon
174              process.
175
176       <b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
177              The location of the Postfix top-level queue  direc-
178              tory.
179
180       <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
181              The syslog facility of Postfix logging.
182
183       <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
184              The  mail  system  name  that  is  prepended to the
185              process name in syslog  records,  so  that  "smtpd"
186              becomes, for example, "postfix/smtpd".
187
188<b>FILES</b>
189       To expand the directory names below into their actual val-
190       ues, use the command "<b>postconf <a href="postconf.5.html#config_directory">config_directory</a></b>" etc.
191
192       $<a href="postconf.5.html#config_directory">config_directory</a>/<a href="postconf.5.html">main.cf</a>, global configuration file.
193       $<a href="postconf.5.html#config_directory">config_directory</a>/<a href="master.5.html">master.cf</a>, master server configuration file.
194       $<a href="postconf.5.html#queue_directory">queue_directory</a>/pid/master.pid, master lock file.
195       $<a href="postconf.5.html#data_directory">data_directory</a>/master.lock, master lock file.
196
197<b>SEE ALSO</b>
198       <a href="qmgr.8.html">qmgr(8)</a>, queue manager
199       <a href="verify.8.html">verify(8)</a>, address verification
200       <a href="master.5.html">master(5)</a>, <a href="master.5.html">master.cf</a> configuration file syntax
201       <a href="postconf.5.html">postconf(5)</a>, <a href="postconf.5.html">main.cf</a> configuration file syntax
202       syslogd(8), system logging
203
204<b>LICENSE</b>
205       The Secure Mailer license must be  distributed  with  this
206       software.
207
208<b>AUTHOR(S)</b>
209       Wietse Venema
210       IBM T.J. Watson Research
211       P.O. Box 704
212       Yorktown Heights, NY 10598, USA
213
214                                                                     MASTER(8)
215</pre> </body> </html>
216