Sync em(4) manpage with the one in Intel em 6.2.9
[dragonfly.git] / 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.3 2005/07/25 00:24:32 gshapiro 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 affect 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 Li YES ,
108 run the
109 .Xr sendmail 8
110 daemon at system boot time.
111 If set to
112 .Dq Li NO ,
113 do not run a
114 .Xr sendmail 8
115 daemon to listen for incoming network mail.
116 This does not preclude a
117 .Xr sendmail 8
118 daemon listening on the SMTP port of the loopback interface.
119 The
120 .Dq Li NONE
121 option is deprecated and should not be used.
122 It will be removed in a future release.
123 .It Va sendmail_flags
124 .Pq Vt str
125 If
126 .Va sendmail_enable
127 is set to
128 .Dq Li YES ,
129 these are the flags to pass to the
130 .Xr sendmail 8
131 daemon.
132 .It Va sendmail_submit_enable
133 .Pq Vt bool
134 If set to
135 .Dq Li YES
136 and
137 .Va sendmail_enable
138 is set to
139 .Dq Li NO ,
140 run
141 .Xr sendmail 8
142 using
143 .Va sendmail_submit_flags
144 instead of
145 .Va sendmail_flags .
146 This is intended to allow local mail submission via
147 a localhost-only listening SMTP service required for running
148 .Xr sendmail 8
149 as a non-set-user-ID binary.
150 Note that this does not work inside
151 .Xr jail 2
152 systems, as jails do not allow binding to just the localhost interface.
153 .It Va sendmail_submit_flags
154 .Pq Vt str
155 If
156 .Va sendmail_enable
157 is set to
158 .Dq Li NO
159 and
160 .Va sendmail_submit_enable
161 is set to
162 .Dq Li YES ,
163 these are the flags to pass to the
164 .Xr sendmail 8
165 daemon.
166 .It Va sendmail_outbound_enable
167 .Pq Vt bool
168 If set to
169 .Dq Li YES
170 and both
171 .Va sendmail_enable
172 and
173 .Va sendmail_submit_enable
174 are set to
175 .Dq Li NO ,
176 run
177 .Xr sendmail 8
178 using
179 .Va sendmail_outbound_flags
180 instead of
181 .Va sendmail_flags .
182 This is intended to allow local mail queue management
183 for systems that do not offer a listening SMTP service.
184 .It Va sendmail_outbound_flags
185 .Pq Vt str
186 If both
187 .Va sendmail_enable
188 and
189 .Va sendmail_submit_enable
190 are set to
191 .Dq Li NO
192 and
193 .Va sendmail_outbound_enable
194 is set to
195 .Dq Li YES ,
196 these are the flags to pass to the
197 .Xr sendmail 8
198 daemon.
199 .It Va sendmail_msp_queue_enable
200 .Pq Vt bool
201 If set to
202 .Dq Li YES ,
203 start a client (MSP) queue runner
204 .Xr sendmail 8
205 daemon at system boot time.
206 As of sendmail 8.12, a separate queue is used for command line
207 submissions.
208 The client queue runner ensures that nothing is
209 left behind in the submission queue.
210 .It Va sendmail_msp_queue_flags
211 .Pq Vt str
212 If
213 .Va sendmail_msp_queue_enable
214 is set to
215 .Dq Li YES ,
216 these are the flags to pass to the
217 .Xr sendmail 8
218 daemon.
219 .El
220 .Pp
221 These variables are used to determine how the
222 .Xr sendmail 8
223 daemons are started:
224 .Pp
225 .Bd -literal -offset indent
226 # MTA
227 if (${sendmail_enable} == NONE)
228         # Do nothing
229 else if (${sendmail_enable} == YES)
230         start sendmail with ${sendmail_flags}
231 else if (${sendmail_submit_enable} == YES)
232         start sendmail with ${sendmail_submit_flags}
233 else if (${sendmail_outbound_enable} == YES)
234         start sendmail with ${sendmail_outbound_flags}
235 endif
236
237 # MSP Queue Runner
238 if (${sendmail_enable} != NONE &&
239     [ -r /etc/mail/submit.cf] &&
240     ${sendmail_msp_queue_enable} == YES)
241         start sendmail with ${sendmail_msp_queue_flags}
242 endif
243 .Ed
244 .Pp
245 To completely prevent any
246 .Xr sendmail 8
247 daemons from starting, you must
248 set the following variables in
249 .Pa /etc/rc.conf :
250 .Bd -literal -offset indent
251 sendmail_enable="NO"
252 sendmail_submit_enable="NO"
253 sendmail_outbound_enable="NO"
254 sendmail_msp_queue_enable="NO"
255 .Ed
256 .Sh SEE ALSO
257 .Xr rc.conf 5 ,
258 .Xr rc 8 ,
259 .Xr sendmail 8
260 .Sh HISTORY
261 The
262 .Nm
263 file appeared in
264 .Fx 4.6 .