xref: /original-bsd/usr.sbin/sendmail/READ_ME (revision 333da485)
1/*-
2 *	@(#)READ_ME	8.8 (Berkeley) 01/04/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
116Unfortunately, for a variety of reasons the Makefiles are for the new
117Berkeley "make" and will not work on the old, traditional make.  I urge
118you to get this make from Net2 (available on many public FTP archives).
119Failing that, some directories have a "Makefile.dist" that will work on
120older versions of make (but don't have the niceties included).
121
122
123+-------------------+
124| DATABASE ROUTINES |
125+-------------------+
126
127IF YOU WANT TO RUN THE NEW BERKELEY DB SOFTWARE:  ****  DO NOT  ****
128use the version that was on the Net2 tape -- it has a number of
129nefarious bugs that were bad enough when I got them; you shouldn't have
130to go through the same thing.  Instead, get a new version via public
131FTP from ftp.CS.Berkeley.EDU, file ucb/4bsd/db.tar.Z.  This software
132is highly recommended; it gets rid of several stupid limits, it's much
133faster, and the interface is nicer to animals and plants.  You will
134also probably find that you have to add -I/where/you/put/db/include
135to the sendmail makefile to get db.h to work properly.
136
137
138+-------------+
139| USE WITH MH |
140+-------------+
141
142This version of sendmail notices and reports certain kinds of SMTP
143protocol violations that were ignored by older versions.  If you
144are running MH you may wish to install the patch in contrib/mh.patch
145that will prevent these warning reports.  This patch also works
146with the old version of sendmail, so it's safe to go ahead and
147install it.
148
149
150+-----------+
151| MAKEFILES |
152+-----------+
153
154The Makefiles in this release use the new Berkeley "make" that is
155available in BSD Net/2 and 4.4BSD.  If you are using this version
156of make, you may notice one or two places where the Makefile includes
157"../../Makefile.inc".  This file is not included with the sendmail
158distribution because it's not part of sendmail.  However, it is,
159in toto:
160
161	#	@(#)Makefile.inc	8.1 (Berkeley) 6/6/93
162
163	BINDIR?=	/usr/sbin
164
165The other directories should all have Makefile.dist files that work
166on the old make.  For more details, see src/READ_ME.
167
168
169+---------------------+
170| DIRECTORY STRUCTURE |
171+---------------------+
172
173The structure of this directory tree is:
174
175cf		Source for Berkeley configuration files.  These are
176		different than what you've seen before.  They are a
177		fairly dramatic rewrite, requiring the new sendmail
178		(since they use new features).
179contrib		Some contributed tools to help with sendmail.  THESE
180		ARE NOT SUPPORTED by Berkeley -- contact the original
181		authors if you have problems.  (This directory is not
182		on the 4.4BSD tape.)
183doc		Documentation.  If you are getting source, read
184		op.me -- it's long, but worth it.
185mailstats	Statistics printing program.  It has the pathname of
186		sendmail.st compiled in, so if you've changed that,
187		beware.  This isn't all that useful.
188makemap		A program that creates the keyed maps used by the $( ... $)
189		construct in sendmail.  It is primitive but effective.
190		It takes a very simple input format, so you will probably
191		expect to preprocess must human-convenient formats
192		using sed scripts before this program will like them.
193		But it should be functionally complete.
194praliases	A program to print the DBM version of the aliases file.
195		It hasn't been converted to understand the new Berkeley
196		DB format (which we are using).
197rmail		Source for rmail(8).  This is used as a delivery
198		agent for for UUCP, and could presumably be used by
199		other non-socket oriented mailers.  Older versions of
200		rmail are probably deficient.
201src		Source for the sendmail program itself.
202test		Some test scripts (currently only for compilation aids).
203