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