xref: /original-bsd/usr.sbin/sendmail/READ_ME (revision 63099315)
1/*-
2 *	@(#)READ_ME	8.12 (Berkeley) 11/13/94
3 */
4
5			SENDMAIL RELEASE 8
6
7This directory has the latest sendmail software from Berkeley.  See
8doc/op/op.me for a summary of changes since 5.67.
9
10Report any bugs to sendmail@CS.Berkeley.EDU.
11
12The latest version of sendmail is kept on FTP.CS.Berkeley.EDU, directory
13/ucb/sendmail; check there for the latest revision.
14
15
16+--------------+
17| MANUAL PAGES |
18+--------------+
19
20The sendmail manual pages use contemporary Berkeley troff macros.  If
21your system does not process these manual pages, you can pick up the
22new macros in a BSD Net/2 FTP site (e.g.  on FTP.UU.NET, the files
23/systems/unix/bsd-sources/share/tmac/me/strip.sed and
24/systems/unix/bsd-sources/share/tmac/*).
25
26The strip.sed file is only used in installation.
27
28After installation, edit tmac.doc and tmac.andoc to reflect the
29installation path of the tmac files.  Those files contain pointers to
30/usr/share/tmac/, and those pointers are not changed by the `make
31install` process.
32
33Rename the existing tmac.an to be tmac.an.old, and rename tmac.andoc
34to be tmac.an.
35
36tmac.an will choose between tmac.an.old, your old macros, or tmac.doc,
37which are the new macros, so that both the new man pages and the
38existing man pages will be translated properly.
39
40I'm also told that the groff distribution from MIT has a tmac.doc
41macro set that is compatible with these macros.
42
43
44+-----------------------+
45| RELATED DOCUMENTATION |
46+-----------------------+
47
48There are other files you should read.  Rooted in this directory are:
49
50  CHANGES-R5-R8
51	Describes changes between Release 5 and Release 8 of sendmail.
52	There are some things that may behave somewhat differently.
53	For example, the rules governing when :include: files will
54	be read have been tightened up for security reasons.
55  FAQ
56	Answers to Frequently Asked Questions.
57  KNOWNBUGS
58	Known bugs in the current release.  I try to keep this up
59	to date -- get the latest version from FTP.CS.Berkeley.EDU
60	in /ucb/sendmail/KNOWNBUGS.
61  RELEASE_NOTES
62	A detailed description of the changes in each version.  This
63	is quite long, but informative.
64  src/READ_ME
65	Details on compiling and installing sendmail.
66  cf/README
67	Details on configuring sendmail.
68  doc/op/op.me
69	The sendmail Installation & Operations Guide.  Be warned: if
70	you are running this off on SunOS or some other system with an
71	old version of -me, you need to add the following macro to the
72	macros:
73
74		.de sm
75		\s-1\\$1\\s0\\$2
76		..
77
78	This sets a word in a smaller pointsize.
79
80
81+--------------+
82| RELATED RFCS |
83+--------------+
84
85There are several related RFCs that you may wish to read -- they are
86available via anonymous FTP to several sites, including nic.ddn.mil
87(directory rfc), ftp.nisc.sri.com (rfc), nis.nsf.net (RFC),
88nisc.jvnc.net (rfc), venera.isi.edu (in-notes), and wuarchive.wustl.edu
89(info/rfc).  They can also be retrieved via electronic mail by sending
90email to one of:
91
92	mail-server@nisc.sri.com
93		Put "send rfcNNN" in message body
94	nis-info@nis.nsf.net
95		Put "send RFCnnn.TXT-1" in message body
96	sendrfc@jvnc.net
97		Put "RFCnnn" as Subject: line
98
99Important RFCs for electronic mail are:
100
101	RFC821	SMTP protocol
102	RFC822	Mail header format
103	RFC974	MX routing
104	RFC976	UUCP mail format
105	RFC1123	Host requirements (modifies 821, 822, and 974)
106	RFC1413	Identification server
107	RFC1425	SMTP Service Extensions (ESMTP spec)
108	RFC1426	SMTP Service Extension for 8bit-MIMEtransport
109	RFC1427	SMTP Service Extension for Message Size Declaration
110	RFC1521	MIME: Multipurpose Internet Mail Extensions
111	RFC1344	Implications of MIME for Internet Mail Gateways
112	RFC1428	Transation of Internet Mail from Just-Send-8 to
113		8-bit SMTP/MIME
114
115Other standards that may be of interest (but which are less directly
116relevant to sendmail) are:
117
118	RFC987	Mapping between RFC822 and X.400
119	RFC1049	Content-Type header field (extension to RFC822)
120
121Warning to AIX users: this version of sendmail does not implement
122MB, MR, or MG DNS resource records, as defined as experiments in
123RFC883.
124
125
126+-------------------+
127| DATABASE ROUTINES |
128+-------------------+
129
130IF YOU WANT TO RUN THE NEW BERKELEY DB SOFTWARE:  ****  DO NOT  ****
131use the version that was on the Net2 tape -- it has a number of
132nefarious bugs that were bad enough when I got them; you shouldn't have
133to go through the same thing.  Instead, get a new version via public
134FTP from ftp.CS.Berkeley.EDU, file ucb/4bsd/db.tar.Z.  This software
135is highly recommended; it gets rid of several stupid limits, it's much
136faster, and the interface is nicer to animals and plants.  You will
137also probably find that you have to add -I/where/you/put/db/include
138to the sendmail makefile to get db.h to work properly.
139
140Be sure you remove ndbm.h and ndbm.o from the db distribution.  These
141will cause problems with sendmail because sendmail already understands
142about NEWDB and NDBM coexisting.
143
144
145+--------------------+
146| Host Name Services |
147+--------------------+
148
149If you compile with NAMED_BIND (the default) sendmail will use
150DNS (the Domain Name System) for most host name lookups.  If
151you do not have DNS running at your site you may have to turn
152this off to cause sendmail to use NIS and/or the /etc/hosts file.
153In particular, on SunOS you have to choose to use DNS (which
154you should do if you are attached to the Internet, otherwise
155you lose MX records, which are required) or NIS -- there is no
156way to try both.
157
158If you are using NIS and /etc/hosts, it is critical that you
159list the long (fully qualified) name first in the /etc/hosts file
160used to build the NIS database.  For example, the line should read
161
162	128.32.149.68   mastodon.CS.Berkeley.EDU mastodon
163
164**** NOT ****
165
166	128.32.149.68   mastodon mastodon.CS.Berkeley.EDU
167
168If you use the wrong order, sendmail will conclude that your
169canonical name is the short version and use that in messages.
170The name "mastodon" doesn't mean much outside of Berkeley,
171and so this creates incorrect and unreplyable messages.
172
173
174+-------------+
175| USE WITH MH |
176+-------------+
177
178This version of sendmail notices and reports certain kinds of SMTP
179protocol violations that were ignored by older versions.  If you
180are running MH you may wish to install the patch in contrib/mh.patch
181that will prevent these warning reports.  This patch also works
182with the old version of sendmail, so it's safe to go ahead and
183install it.
184
185
186+-----------+
187| MAKEFILES |
188+-----------+
189
190The Makefiles in this release use the new Berkeley "make" that is
191available in BSD Net/2 and 4.4BSD.  If you are using this version
192of make, you may notice one or two places where the Makefile includes
193"../../Makefile.inc".  This file is not included with the sendmail
194distribution because it's not part of sendmail.  However, it is,
195in toto:
196
197	#	@(#)Makefile.inc	8.1 (Berkeley) 6/6/93
198
199	BINDIR?=	/usr/sbin
200
201The other directories should all have Makefile.dist files that work
202on the old make, albeit without all the niceties included.
203
204You can also get a new Berkeley make from the Net2 release (available
205on many public FTP archives).  This version should also interpret old
206Makefiles, so you could drop it in as your default make.
207
208For more details, see src/READ_ME.
209
210
211+---------------------+
212| DIRECTORY STRUCTURE |
213+---------------------+
214
215The structure of this directory tree is:
216
217cf		Source for Berkeley configuration files.  These are
218		different than what you've seen before.  They are a
219		fairly dramatic rewrite, requiring the new sendmail
220		(since they use new features).
221contrib		Some contributed tools to help with sendmail.  THESE
222		ARE NOT SUPPORTED by Berkeley -- contact the original
223		authors if you have problems.  (This directory is not
224		on the 4.4BSD tape.)
225doc		Documentation.  If you are getting source, read
226		op.me -- it's long, but worth it.
227mail.local	The source for the local delivery agent used for 4.4BSD.
228		THIS IS NOT PART OF SENDMAIL! and may not compile
229		everywhere, since it depends on some 4.4-isms.  Warning:
230		it does mailbox locking differently than other systems.
231mailstats	Statistics printing program.  It has the pathname of
232		sendmail.st compiled in, so if you've changed that,
233		beware.  This isn't all that useful.
234makemap		A program that creates the keyed maps used by the $( ... $)
235		construct in sendmail.  It is primitive but effective.
236		It takes a very simple input format, so you will probably
237		expect to preprocess must human-convenient formats
238		using sed scripts before this program will like them.
239		But it should be functionally complete.
240praliases	A program to print the DBM version of the aliases file.
241		It hasn't been converted to understand the new Berkeley
242		DB format (which we are using).
243rmail		Source for rmail(8).  This is used as a delivery
244		agent for for UUCP, and could presumably be used by
245		other non-socket oriented mailers.  Older versions of
246		rmail are probably deficient.  RMAIL IS NOT PART OF
247		SENDMAIL!!!  The 4.4BSD source is included for you to
248		look at or try to port to your system.  I know it doesn't
249		compile on {SunOS, HP-UX, OSF/1, other} (pick one).
250smrsh		The "sendmail restricted shell", which can be used as
251		a replacement for /bin/mail in the prog mailer to provide
252		increased security control.  NOT PART OF SENDMAIL!
253src		Source for the sendmail program itself.
254test		Some test scripts (currently only for compilation aids).
255