NetBSD/gnu/dist/postfix/man/man8/master.8

173 lines
5.8 KiB
Groff
Raw Normal View History

2005-08-19 01:00:20 +04:00
.\" $NetBSD: master.8,v 1.1.1.7 2005/08/18 21:04:19 rpaulo Exp $
2004-05-31 04:23:53 +04:00
.\"
.TH MASTER 8
.ad
.fi
.SH NAME
master
\-
Postfix master process
2004-04-27 08:12:43 +04:00
.SH "SYNOPSIS"
.na
.nf
2005-08-19 01:00:20 +04:00
\fBmaster\fR [\fB-Dtv\fR] [\fB-c \fIconfig_dir\fR] [\fB-e \fIexit_time\fR]
.SH DESCRIPTION
.ad
.fi
2005-08-19 01:00:20 +04:00
The \fBmaster\fR(8) daemon is the resident process that runs Postfix
daemons on demand: daemons to send or receive messages via the
network, daemons to deliver mail locally, etc. These daemons are
created on demand up to a configurable maximum number per service.
Postfix daemons terminate voluntarily, either after being idle for
a configurable amount of time, or after having serviced a
2004-04-27 08:12:43 +04:00
configurable number of requests. Exceptions to this rule are the
2005-08-19 01:00:20 +04:00
resident queue manager, address verification server, and the TLS
session cache and pseudo-random number server.
2005-08-19 01:00:20 +04:00
The behavior of the \fBmaster\fR(8) daemon is controlled by the
\fBmaster.cf\fR configuration file, as described in \fBmaster\fR(5).
Options:
.IP "\fB-c \fIconfig_dir\fR"
Read the \fBmain.cf\fR and \fBmaster.cf\fR configuration files in
2001-03-13 20:45:02 +03:00
the named directory instead of the default configuration directory.
2005-08-19 01:00:20 +04:00
This also overrides the configuration files for other Postfix
daemon processes.
2001-05-08 08:55:29 +04:00
.IP "\fB-e \fIexit_time\fR"
Terminate the master process after \fIexit_time\fR seconds. Child
processes terminate at their convenience.
.IP \fB-D\fR
After initialization, run a debugger on the master process. The
debugging command is specified with the \fBdebugger_command\fR in
the \fBmain.cf\fR global configuration file.
.IP \fB-t\fR
Test mode. Return a zero exit status when the \fBmaster.pid\fR lock
file does not exist or when that file is not locked. This is evidence
2005-08-19 01:00:20 +04:00
that the \fBmaster\fR(8) daemon is not running.
.IP \fB-v\fR
Enable verbose logging for debugging purposes. This option
is passed on to child processes. Multiple \fB-v\fR options
make the software increasingly verbose.
.PP
Signals:
.IP \fBSIGHUP\fR
2005-08-19 01:00:20 +04:00
Upon receipt of a \fBHUP\fR signal (e.g., after "\fBpostfix reload\fR"),
the master process re-reads its configuration files. If a service has
been removed from the \fBmaster.cf\fR file, its running processes
are terminated immediately.
Otherwise, running processes are allowed to terminate as soon
as is convenient, so that changes in configuration settings
affect only new service requests.
.IP \fBSIGTERM\fR
2005-08-19 01:00:20 +04:00
Upon receipt of a \fBTERM\fR signal (e.g., after "\fBpostfix abort\fR"),
the master process passes the signal on to its child processes and
terminates.
This is useful for an emergency shutdown. Normally one would
2005-08-19 01:00:20 +04:00
terminate only the master ("\fBpostfix stop\fR") and allow running
processes to finish what they are doing.
.SH DIAGNOSTICS
.ad
.fi
Problems are reported to \fBsyslogd\fR(8).
2004-04-27 08:12:43 +04:00
.SH "ENVIRONMENT"
.na
.nf
.ad
.fi
.IP \fBMAIL_DEBUG\fR
After initialization, start a debugger as specified with the
\fBdebugger_command\fR configuration parameter in the \fBmain.cf\fR
configuration file.
.IP \fBMAIL_CONFIG\fR
Directory with Postfix configuration files.
2004-04-27 08:12:43 +04:00
.SH "CONFIGURATION PARAMETERS"
.na
.nf
.ad
.fi
2005-08-19 01:00:20 +04:00
Unlike most Postfix daemon processes, the \fBmaster\fR(8) server does
2004-04-27 08:12:43 +04:00
not automatically pick up changes to \fBmain.cf\fR. Changes
to \fBmaster.cf\fR are never picked up automatically.
2005-08-19 01:00:20 +04:00
Use the "\fBpostfix reload\fR" command after a configuration change.
2004-04-27 08:12:43 +04:00
.SH "RESOURCE AND RATE CONTROLS"
.na
.nf
.ad
.fi
2004-04-27 08:12:43 +04:00
.IP "\fBdefault_process_limit (100)\fR"
The default maximal number of Postfix child processes that provide
a given service.
.IP "\fBmax_idle (100s)\fR"
The maximum amount of time that an idle Postfix daemon process
waits for the next service request before exiting.
.IP "\fBmax_use (100)\fR"
The maximal number of connection requests before a Postfix daemon
process terminates.
.IP "\fBservice_throttle_time (60s)\fR"
2005-08-19 01:00:20 +04:00
How long the Postfix \fBmaster\fR(8) waits before forking a server that
2004-04-27 08:12:43 +04:00
appears to be malfunctioning.
.SH "MISCELLANEOUS CONTROLS"
.na
.nf
.ad
.fi
2004-04-27 08:12:43 +04:00
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
The default location of the Postfix main.cf and master.cf
configuration files.
.IP "\fBdaemon_directory (see 'postconf -d' output)\fR"
The directory with Postfix support programs and daemon programs.
.IP "\fBdebugger_command (empty)\fR"
The external command to execute when a Postfix daemon program is
invoked with the -D option.
.IP "\fBinet_interfaces (all)\fR"
2005-08-19 01:00:20 +04:00
The network interface addresses that this mail system receives
mail on.
.IP "\fBinet_protocols (ipv4)\fR"
The Internet protocols Postfix will attempt to use when making
or accepting connections.
2004-04-27 08:12:43 +04:00
.IP "\fBimport_environment (see 'postconf -d' output)\fR"
The list of environment parameters that a Postfix process will
import from a non-Postfix parent process.
.IP "\fBmail_owner (postfix)\fR"
The UNIX system account that owns the Postfix queue and most Postfix
daemon processes.
.IP "\fBprocess_id (read-only)\fR"
The process ID of a Postfix command or daemon process.
.IP "\fBprocess_name (read-only)\fR"
The process name of a Postfix command or daemon process.
.IP "\fBqueue_directory (see 'postconf -d' output)\fR"
The location of the Postfix top-level queue directory.
.IP "\fBsyslog_facility (mail)\fR"
The syslog facility of Postfix logging.
.IP "\fBsyslog_name (postfix)\fR"
The mail system name that is prepended to the process name in syslog
records, so that "smtpd" becomes, for example, "postfix/smtpd".
.SH "FILES"
.na
.nf
2004-04-27 08:12:43 +04:00
/etc/postfix/main.cf, global configuration file.
/etc/postfix/master.cf, master server configuration file.
/var/spool/postfix/pid/master.pid, master lock file.
.SH "SEE ALSO"
.na
.nf
2004-04-27 08:12:43 +04:00
qmgr(8), queue manager
verify(8), address verification
2005-08-19 01:00:20 +04:00
master(5), master.cf configuration file syntax
postconf(5), main.cf configuration parameter syntax
2004-04-27 08:12:43 +04:00
syslogd(8), system logging
.SH "LICENSE"
.na
.nf
.ad
.fi
The Secure Mailer license must be distributed with this software.
2004-04-27 08:12:43 +04:00
.SH "AUTHOR(S)"
.na
.nf
Wietse Venema
IBM T.J. Watson Research
P.O. Box 704
Yorktown Heights, NY 10598, USA