8212 manpages contain obsolete references
[unleashed.git] / usr / src / man / man4 / sendmail.4
blob917bd8d5c455b581be7b19220fbee269e61bae14
1 '\" te
2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH SENDMAIL 4 "May 13, 2017"
7 .SH NAME
8 sendmail, sendmail.cf, submit.cf \- sendmail configuration files
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/etc/mail/sendmail.cf\fR
13 .fi
15 .LP
16 .nf
17 \fB/etc/mail/submit.cf\fR
18 .fi
20 .SH DESCRIPTION
21 .LP
22 The \fBsendmail.cf\fR and \fBsubmit.cf\fR files are the configuration files for
23 \fBsendmail\fR(1M). Starting with version 8.12 of \fBsendmail\fR, which was
24 shipped with version 9 of the Solaris operating system, two configuration files
25 are used for submission and transmission of mail, instead of only
26 \fBsendmail.cf\fR, as before. These are:
27 .sp
28 .ne 2
29 .na
30 \fB\fBsendmail.cf\fR\fR
31 .ad
32 .RS 15n
33 Remains the principal \fBsendmail\fR configuration file. Used for the Mail
34 Transmission Agent (MTA).
35 .RE
37 .sp
38 .ne 2
39 .na
40 \fB\fBsubmit.cf\fR\fR
41 .ad
42 .RS 15n
43 Used for the Mail Submission Program (MSP). The MSP is used to submit mail
44 messages. Unlike the MTA, it does not run as an SMTP daemon.
45 .RE
47 .sp
48 .LP
49 The MSP does not require root privileges, thus the two-file model provides
50 better security than the pre-\fBsendmail\fR 8.12 model, in which the MSP ran as
51 a daemon and required root privileges.
52 .sp
53 .LP
54 In the default \fBsendmail\fR configuration, \fBsendmail\fR uses
55 \fBsubmit.cf\fR, as indicated in \fBps\fR(1) output. In \fBps\fR output, you
56 will observe two \fBsendmail\fR invocations, such as the ones below:
57 .sp
58 .in +2
59 .nf
60 /usr/lib/sendmail -Ac -q15m
61 /usr/lib/sendmail -bd -q15m
62 .fi
63 .in -2
65 .sp
66 .LP
67 The first indicates the use of \fBsubmit.cf\fR, with the client queue
68 (\fB/var/spool/clientmqueue\fR) being checked\(emand, if needed,
69 flushed\(emevery 15 minutes. The second invocation runs \fBsendmail\fR as a
70 daemon, waiting for incoming SMTP connections.
71 .sp
72 .LP
73 As shipped, \fBsendmail.cf\fR and, in particular, \fBsubmit.cf\fR, are
74 appropriate for most environments. Where a knowledgeable system administrator
75 needs to make a change, he should use the following procedures.
76 .sp
77 .LP
78 For \fBsendmail.cf\fR:
79 .RS +4
80 .TP
82 Change directories to the directory that contains the source files for the
83 configuration files.
84 .sp
85 .in +2
86 .nf
87 # \fBcd /etc/mail/cf/cf\fR
88 .fi
89 .in -2
90 .sp
92 .RE
93 .RS +4
94 .TP
96 Create a copy of the \fBsendmail\fR file for your system.
97 .sp
98 .in +2
99 .nf
100 # \fBcp sendmail.mc `hostname`.mc\fR
102 .in -2
106 .RS +4
109 Edit \fB`hostname`.mc\fR. Make changes suitable for your system and
110 environment.
112 .RS +4
115 Run \fBmake\fR to generate the configuration file.
117 .in +2
119 # \fB/usr/bin/make `hostname`.cf\fR
121 .in -2
125 .RS +4
128 Copy the newly generated file to its correct location.
130 .in +2
132 # \fBcp `hostname`.cf /etc/mail/sendmail.cf\fR
134 .in -2
138 .RS +4
141 Restart the \fBsendmail\fR service.
143 .in +2
145 # \fBsvcadm restart sendmail\fR
147 .in -2
153 You must restart \fBsendmail\fR for \fBsendmail.cf\fR file changes to take
154 effect, as indicated in step 6. Steps 4 - 6 can be automated. See \fBAutomated
155 Rebuilding of Configuration Files\fR below.
158 For \fBsubmit.cf\fR:
159 .RS +4
162 Change directories to the directory that contains the source files for the
163 configuration files.
165 .in +2
167 # \fBcd /etc/mail/cf/cf\fR
169 .in -2
173 .RS +4
176 Create a copy of the \fBsubmit\fR file for your system.
178 .in +2
180 # \fBcp submit.mc submit-`hostname`.mc\fR
182 .in -2
186 .RS +4
189 Edit \fBsubmit-`hostname`.mc\fR. Make changes suitable for your system and
190 environment.
192 .RS +4
195 Run \fBmake\fR to generate the configuration file.
197 .in +2
199 # \fB/usr/bin/make submit-`hostname`.cf\fR
201 .in -2
205 .RS +4
208 Copy the newly generated file to its correct location.
210 .in +2
212 # \fBcp submit-`hostname`.cf /etc/mail/submit.cf\fR
214 .in -2
220 You do not need to restart \fBsendmail\fR for changes to \fBsubmit.cf\fR to
221 take effect.  Steps 4 and 5 can be automated. See \fBAutomated Rebuilding of
222 Configuration Files\fR below.
223 .SS "Enabling Access to Remote Clients"
225 The \fBsendmail\fR(1M) man page describes how the \fBconfig/local_only\fR
226 property can be set to \fBtrue\fR or \fBfalse\fR to disallow or allow,
227 respectively, access to remote clients for unmodified systems.
230 Setting values for the following properties for the service instance
231 \fBsvc:/network/smtp:sendmail\fR results in automated (re)building of
232 configuration files:
234 .in +2
236 path_to_sendmail_mc
237 path_to_submit_mc
239 .in -2
244 The values for these properties should be strings which represent the path name
245 of the \fB\&.mc\fR files referred to in steps 2 and 3 of both procedures above.
246 Recommended values are:
248 .in +2
250 /etc/mail/cf/cf/`hostname`.mc
251 /etc/mail/cf/cf/submit-`hostname`.mc
253 .in -2
258 Each property, if set, results in the corresponding \fB\&.mc\fR file being used
259 to (re)build the matching \fB\&.cf\fR file when the service is started.
262 These properties persist across updates. To prevent an update
263 from clobbering your \fB\&.cf\fR file, or renaming it to
264 \fB\&.cf.old\fR, you can set the desired properties instead.
265 .SH FILES
266 .ne 2
268 \fB\fB/etc/mail/cf/README\fR\fR
270 .RS 23n
271 Describes \fBsendmail\fR configuration files.
274 .SH ATTRIBUTES
276 See \fBattributes\fR(5) for descriptions of the following attributes:
281 box;
282 c | c
283 l | l .
284 ATTRIBUTE TYPE  ATTRIBUTE VALUE
286 Interface Stability     Committed
289 .SH SEE ALSO
291 \fBmake\fR(1S), \fBps\fR(1), \fBsendmail\fR(1M), \fBsvcadm\fR(1M),
292 \fBattributes\fR(5)
295 \fISystem Administration Guide: Network Services\fR