xref: /original-bsd/usr.sbin/sendmail/READ_ME (revision 2a44b01a)
1/*-
2 *	@(#)READ_ME	8.11 (Berkeley) 05/19/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	RFC1341	MIME: Multipurpose Internet Mail Extensions
108	RFC1344	Implications of MIME for Internet Mail Gateways
109
110Other standards that may be of interest (but which are less directly
111relevant to sendmail) are:
112
113	RFC987	Mapping between RFC822 and X.400
114	RFC1049	Content-Type header field (extension to RFC822)
115
116Warning to AIX users: this version of sendmail does not implement
117MB, MR, or MG DNS resource records, as defined as experiments in
118RFC883.
119
120
121+-------------------+
122| DATABASE ROUTINES |
123+-------------------+
124
125IF YOU WANT TO RUN THE NEW BERKELEY DB SOFTWARE:  ****  DO NOT  ****
126use the version that was on the Net2 tape -- it has a number of
127nefarious bugs that were bad enough when I got them; you shouldn't have
128to go through the same thing.  Instead, get a new version via public
129FTP from ftp.CS.Berkeley.EDU, file ucb/4bsd/db.tar.Z.  This software
130is highly recommended; it gets rid of several stupid limits, it's much
131faster, and the interface is nicer to animals and plants.  You will
132also probably find that you have to add -I/where/you/put/db/include
133to the sendmail makefile to get db.h to work properly.
134
135Be sure you remove ndbm.h and ndbm.o from the db distribution.  These
136will cause problems with sendmail because sendmail already understands
137about NEWDB and NDBM coexisting.
138
139
140+--------------------+
141| Host Name Services |
142+--------------------+
143
144If you compile with NAMED_BIND (the default) sendmail will use
145DNS (the Domain Name System) for most host name lookups.  If
146you do not have DNS running at your site you may have to turn
147this off to cause sendmail to use NIS and/or the /etc/hosts file.
148In particular, on SunOS you have to choose to use DNS (which
149you should do if you are attached to the Internet, otherwise
150you lose MX records, which are required) or NIS -- there is no
151way to try both.
152
153If you are using NIS and /etc/hosts, it is critical that you
154list the long (fully qualified) name first in the /etc/hosts file
155used to build the NIS database.  For example, the line should read
156
157	128.32.149.68   mastodon.CS.Berkeley.EDU mastodon
158
159**** NOT ****
160
161	128.32.149.68   mastodon mastodon.CS.Berkeley.EDU
162
163If you use the wrong order, sendmail will conclude that your
164canonical name is the short version and use that in messages.
165The name "mastodon" doesn't mean much outside of Berkeley,
166and so this creates incorrect and unreplyable messages.
167
168
169+-------------+
170| USE WITH MH |
171+-------------+
172
173This version of sendmail notices and reports certain kinds of SMTP
174protocol violations that were ignored by older versions.  If you
175are running MH you may wish to install the patch in contrib/mh.patch
176that will prevent these warning reports.  This patch also works
177with the old version of sendmail, so it's safe to go ahead and
178install it.
179
180
181+-----------+
182| MAKEFILES |
183+-----------+
184
185The Makefiles in this release use the new Berkeley "make" that is
186available in BSD Net/2 and 4.4BSD.  If you are using this version
187of make, you may notice one or two places where the Makefile includes
188"../../Makefile.inc".  This file is not included with the sendmail
189distribution because it's not part of sendmail.  However, it is,
190in toto:
191
192	#	@(#)Makefile.inc	8.1 (Berkeley) 6/6/93
193
194	BINDIR?=	/usr/sbin
195
196The other directories should all have Makefile.dist files that work
197on the old make, albeit without all the niceties included.
198
199You can also get a new Berkeley make from the Net2 release (available
200on many public FTP archives).  This version should also interpret old
201Makefiles, so you could drop it in as your default make.
202
203For more details, see src/READ_ME.
204
205
206+---------------------+
207| DIRECTORY STRUCTURE |
208+---------------------+
209
210The structure of this directory tree is:
211
212cf		Source for Berkeley configuration files.  These are
213		different than what you've seen before.  They are a
214		fairly dramatic rewrite, requiring the new sendmail
215		(since they use new features).
216contrib		Some contributed tools to help with sendmail.  THESE
217		ARE NOT SUPPORTED by Berkeley -- contact the original
218		authors if you have problems.  (This directory is not
219		on the 4.4BSD tape.)
220doc		Documentation.  If you are getting source, read
221		op.me -- it's long, but worth it.
222mailstats	Statistics printing program.  It has the pathname of
223		sendmail.st compiled in, so if you've changed that,
224		beware.  This isn't all that useful.
225makemap		A program that creates the keyed maps used by the $( ... $)
226		construct in sendmail.  It is primitive but effective.
227		It takes a very simple input format, so you will probably
228		expect to preprocess must human-convenient formats
229		using sed scripts before this program will like them.
230		But it should be functionally complete.
231praliases	A program to print the DBM version of the aliases file.
232		It hasn't been converted to understand the new Berkeley
233		DB format (which we are using).
234rmail		Source for rmail(8).  This is used as a delivery
235		agent for for UUCP, and could presumably be used by
236		other non-socket oriented mailers.  Older versions of
237		rmail are probably deficient.  RMAIL IS NOT PART OF
238		SENDMAIL!!!  The 4.4BSD source is included for you to
239		look at or try to port to your system.  I know it doesn't
240		compile on {SunOS, HP-UX, OSF/1, other} (pick one).
241src		Source for the sendmail program itself.
242test		Some test scripts (currently only for compilation aids).
243