share/man/man8/rc.sendmail.8

   1 .\" Copyright (c) 1995
   2 .\"     Jordan K. Hubbard
   3 .\" Copyright (c) 2002 The FreeBSD Project
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man8/rc.sendmail.8,v 1.1.2.2 2002/05/22 17:01:33 gshapiro Exp $
  28 .\" $DragonFly: src/share/man/man8/rc.sendmail.8,v 1.2 2003/06/17 04:37:01 dillon Exp $
  29 .\"
  30 .Dd March 30, 2002
  31 .Dt RC.SENDMAIL 8
  32 .Os
  33 .Sh NAME
  34 .Nm rc.sendmail
  35 .Nd
  36 .Xr sendmail 8
  37 startup script
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 script is used by
  42 .Pa /etc/rc
  43 at boot time to start
  44 .Xr sendmail 8 .
  45 It is meant to be
  46 .Xr sendmail 8
  47 specific and not a generic script for all MTAs.
  48 It is only called by
  49 .Pa /etc/rc
  50 if the
  51 .Xr rc.conf 5
  52 .Va mta_start_script
  53 variable is set to
  54 .Pa /etc/rc.sendmail .
  55 .Pp
  56 The
  57 .Nm
  58 script can take an optional argument specifying the action to
  59 perform.
  60 The available actions are:
  61 .Bl -tag -width ".Cm restart-mspq"
  62 .It Cm start
  63 Starts both the MTA and the MSP queue runner.
  64 .It Cm stop
  65 Stops both the MTA and the MSP queue runner.
  66 .It Cm restart
  67 Restarts both the MTA and the MSP queue runner.
  68 .It Cm start-mta
  69 Starts just the MTA.
  70 .It Cm stop-mta
  71 Stops just the MTA.
  72 .It Cm restart-mta
  73 Restarts just the MTA.
  74 .It Cm start-mspq
  75 Starts just the MSP queue runner.
  76 .It Cm stop-mspq
  77 Stops just the MSP queue runner.
  78 .It Cm restart-mspq
  79 Restarts just the MSP queue runner.
  80 .El
  81 .Pp
  82 If no action is specified,
  83 .Cm start
  84 is assumed.
  85 .Pp
  86 The
  87 .Nm
  88 script is also used by
  89 .Pa /etc/mail/Makefile
  90 to enable the
  91 .Pa Makefile Ns 's
  92 .Cm start , stop ,
  93 and
  94 .Cm restart
  95 targets.
  96 .Sh RC.CONF VARIABLES
  97 The following variables effect the behavior of
  98 .Nm .
  99 They are defined in
 100 .Pa /etc/defaults/rc.conf
 101 and can be changed in
 102 .Pa /etc/rc.conf .
 103 .Bl -tag -width indent
 104 .It Va sendmail_enable
 105 .Pq Vt str
 106 If set to
 107 .Dq YES ,
 108 run the
 109 .Xr sendmail 8
 110 daemon at system boot time.
 111 If set to
 112 .Dq NONE ,
 113 do not run any
 114 .Xr sendmail 8
 115 daemons at system boot time.
 116 .It Va sendmail_flags
 117 .Pq Vt str
 118 If
 119 .Va sendmail_enable
 120 is set to
 121 .Dq YES ,
 122 these are the flags to pass to the
 123 .Xr sendmail 8
 124 daemon.
 125 .It Va sendmail_submit_enable
 126 .Pq Vt bool
 127 If set to
 128 .Dq YES
 129 and
 130 .Va sendmail_enable
 131 is set to
 132 .Dq NO ,
 133 run
 134 .Xr sendmail 8
 135 using
 136 .Va sendmail_submit_flags
 137 instead of
 138 .Va sendmail_flags .
 139 This is intended to allow local mail submission via
 140 a localhost-only listening SMTP service required for running
 141 .Xr sendmail 8
 142 as a non-set-user-ID binary.
 143 Note that this does not work inside
 144 .Xr jail 2
 145 systems as jails do not allow binding to just the localhost interface.
 146 .It Va sendmail_submit_flags
 147 .Pq Vt str
 148 If
 149 .Va sendmail_enable
 150 is set to
 151 .Dq NO
 152 and
 153 .Va sendmail_submit_enable
 154 is set to
 155 .Dq YES ,
 156 these are the flags to pass to the
 157 .Xr sendmail 8
 158 daemon.
 159 .It Va sendmail_outbound_enable
 160 .Pq Vt bool
 161 If set to
 162 .Dq YES
 163 and both
 164 .Va sendmail_enable
 165 and
 166 .Va sendmail_submit_enable
 167 are set to
 168 .Dq NO ,
 169 run
 170 .Xr sendmail 8
 171 using
 172 .Va sendmail_outbound_flags
 173 instead of
 174 .Va sendmail_flags .
 175 This is intended to allow local mail queue management
 176 for systems that do not offer a listening SMTP service.
 177 .It Va sendmail_outbound_flags
 178 .Pq Vt str
 179 If both
 180 .Va sendmail_enable
 181 and
 182 .Va sendmail_submit_enable
 183 are set to
 184 .Dq NO
 185 and
 186 .Va sendmail_outbound_enable
 187 is set to
 188 .Dq YES ,
 189 these are the flags to pass to the
 190 .Xr sendmail 8
 191 daemon.
 192 .It Va sendmail_msp_queue_enable
 193 .Pq Vt bool
 194 If set to
 195 .Dq YES ,
 196 start a client (MSP) queue runner
 197 .Xr sendmail 8
 198 daemon at system boot time.
 199 As of sendmail 8.12, a separate queue is used for command line
 200 submissions.
 201 The client queue runner assures that nothing is
 202 left behind in the submission queue.
 203 .It Va sendmail_msp_queue_flags
 204 .Pq Vt str
 205 If
 206 .Va sendmail_msp_queue_enable
 207 is set to
 208 .Dq YES ,
 209 these are the flags to pass to the
 210 .Xr sendmail 8
 211 daemon.
 212 .El
 213 .Pp
 214 These variables are used to determine how the
 215 .Xr sendmail 8
 216 daemons are started:
 217 .Pp
 218 .Bd -literal -offset indent
 219 # MTA
 220 if (${sendmail_enable} == NONE)
 221         # Do nothing
 222 else if (${sendmail_enable} == YES)
 223         start sendmail with ${sendmail_flags}
 224 else if (${sendmail_submit_enable} == YES)
 225         start sendmail with ${sendmail_submit_flags}
 226 else if (${sendmail_outbound_enable} == YES)
 227         start sendmail with ${sendmail_outbound_flags}
 228 endif
 229
 230 # MSP Queue Runner
 231 if (${sendmail_enable} != NONE &&
 232     [ -r /etc/mail/submit.cf] &&
 233     ${sendmail_msp_queue_enable} == YES)
 234         start sendmail with ${sendmail_msp_queue_flags}
 235 endif
 236 .Ed
 237 .Sh SEE ALSO
 238 .Xr rc.conf 5 ,
 239 .Xr rc 8 ,
 240 .Xr sendmail 8
 241 .Sh HISTORY
 242 The
 243 .Nm
 244 file appeared in
 245 .Fx 4.6 .