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

   1 .\"     $NetBSD$
   2 .\"
   3 .TH SPAWN 8
   4 .ad
   5 .fi
   6 .SH NAME
   7 spawn
   8 \-
   9 Postfix external command spawner
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 \fBspawn\fR [generic Postfix daemon options] command_attributes...
  14 .SH DESCRIPTION
  15 .ad
  16 .fi
  17 The \fBspawn\fR(8) daemon provides the Postfix equivalent
  18 of \fBinetd\fR.
  19 It listens on a port as specified in the Postfix \fBmaster.cf\fR file
  20 and spawns an external command whenever a connection is established.
  21 The connection can be made over local IPC (such as UNIX-domain
  22 sockets) or over non-local IPC (such as TCP sockets).
  23 The command\'s standard input, output and error streams are connected
  24 directly to the communication endpoint.
  25
  26 This daemon expects to be run from the \fBmaster\fR(8) process
  27 manager.
  28 .SH "COMMAND ATTRIBUTE SYNTAX"
  29 .na
  30 .nf
  31 .ad
  32 .fi
  33 The external command attributes are given in the \fBmaster.cf\fR
  34 file at the end of a service definition.  The syntax is as follows:
  35 .IP "\fBuser\fR=\fIusername\fR (required)"
  36 .IP "\fBuser\fR=\fIusername\fR:\fIgroupname\fR"
  37 The external command is executed with the rights of the
  38 specified \fIusername\fR.  The software refuses to execute
  39 commands with root privileges, or with the privileges of the
  40 mail system owner. If \fIgroupname\fR is specified, the
  41 corresponding group ID is used instead of the group ID
  42 of \fIusername\fR.
  43 .IP "\fBargv\fR=\fIcommand\fR... (required)"
  44 The command to be executed. This must be specified as the
  45 last command attribute.
  46 The command is executed directly, i.e. without interpretation of
  47 shell meta characters by a shell command interpreter.
  48 .SH BUGS
  49 .ad
  50 .fi
  51 In order to enforce standard Postfix process resource controls,
  52 the \fBspawn\fR(8) daemon runs only one external command at a time.
  53 As such, it presents a noticeable overhead by wasting precious
  54 process resources. The \fBspawn\fR(8) daemon is expected to be
  55 replaced by a more structural solution.
  56 .SH DIAGNOSTICS
  57 .ad
  58 .fi
  59 The \fBspawn\fR(8) daemon reports abnormal child exits.
  60 Problems are logged to \fBsyslogd\fR(8).
  61 .SH "SECURITY"
  62 .na
  63 .nf
  64 .fi
  65 .ad
  66 This program needs root privilege in order to execute external
  67 commands as the specified user. It is therefore security sensitive.
  68 However the \fBspawn\fR(8) daemon does not talk to the external command
  69 and thus is not vulnerable to data-driven attacks.
  70 .SH "CONFIGURATION PARAMETERS"
  71 .na
  72 .nf
  73 .ad
  74 .fi
  75 Changes to \fBmain.cf\fR are picked up automatically as \fBspawn\fR(8)
  76 processes run for only a limited amount of time. Use the command
  77 "\fBpostfix reload\fR" to speed up a change.
  78
  79 The text below provides only a parameter summary. See
  80 \fBpostconf\fR(5) for more details including examples.
  81
  82 In the text below, \fItransport\fR is the first field of the entry
  83 in the \fBmaster.cf\fR file.
  84 .SH "RESOURCE AND RATE CONTROL"
  85 .na
  86 .nf
  87 .ad
  88 .fi
  89 .IP "\fItransport\fB_time_limit ($command_time_limit)\fR"
  90 The amount of time the command is allowed to run before it is
  91 terminated.
  92
  93 Postfix 2.4 and later support a suffix that specifies the
  94 time unit: s (seconds), m (minutes), h (hours), d (days),
  95 w (weeks). The default time unit is seconds.
  96 .SH "MISCELLANEOUS"
  97 .na
  98 .nf
  99 .ad
 100 .fi
 101 .IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 102 The default location of the Postfix main.cf and master.cf
 103 configuration files.
 104 .IP "\fBdaemon_timeout (18000s)\fR"
 105 How much time a Postfix daemon process may take to handle a
 106 request before it is terminated by a built-in watchdog timer.
 107 .IP "\fBexport_environment (see 'postconf -d' output)\fR"
 108 The list of environment variables that a Postfix process will export
 109 to non-Postfix processes.
 110 .IP "\fBipc_timeout (3600s)\fR"
 111 The time limit for sending or receiving information over an internal
 112 communication channel.
 113 .IP "\fBmail_owner (postfix)\fR"
 114 The UNIX system account that owns the Postfix queue and most Postfix
 115 daemon processes.
 116 .IP "\fBmax_idle (100s)\fR"
 117 The maximum amount of time that an idle Postfix daemon process waits
 118 for an incoming connection before terminating voluntarily.
 119 .IP "\fBmax_use (100)\fR"
 120 The maximal number of incoming connections that a Postfix daemon
 121 process will service before terminating voluntarily.
 122 .IP "\fBprocess_id (read-only)\fR"
 123 The process ID of a Postfix command or daemon process.
 124 .IP "\fBprocess_name (read-only)\fR"
 125 The process name of a Postfix command or daemon process.
 126 .IP "\fBqueue_directory (see 'postconf -d' output)\fR"
 127 The location of the Postfix top-level queue directory.
 128 .IP "\fBsyslog_facility (mail)\fR"
 129 The syslog facility of Postfix logging.
 130 .IP "\fBsyslog_name (see 'postconf -d' output)\fR"
 131 The mail system name that is prepended to the process name in syslog
 132 records, so that "smtpd" becomes, for example, "postfix/smtpd".
 133 .SH "SEE ALSO"
 134 .na
 135 .nf
 136 postconf(5), configuration parameters
 137 master(8), process manager
 138 syslogd(8), system logging
 139 .SH "LICENSE"
 140 .na
 141 .nf
 142 .ad
 143 .fi
 144 The Secure Mailer license must be distributed with this software.
 145 .SH "AUTHOR(S)"
 146 .na
 147 .nf
 148 Wietse Venema
 149 IBM T.J. Watson Research
 150 P.O. Box 704
 151 Yorktown Heights, NY 10598, USA