[unix-history] / usr.sbin / sendmail / READ_ME

/*-
 *	@(#)READ_ME	8.9 (Berkeley) 1/26/94
 */

			SENDMAIL RELEASE 8

This directory has the latest sendmail software from Berkeley.  See
doc/op/op.me for a summary of changes since 5.67.

Report any bugs to sendmail@CS.Berkeley.EDU.

The latest version of sendmail is kept on FTP.CS.Berkeley.EDU, directory
/ucb/sendmail; check there for the latest revision.


+--------------+
| MANUAL PAGES |
+--------------+

The sendmail manual pages use contemporary Berkeley troff macros.  If
your system does not process these manual pages, you can pick up the
new macros in a BSD Net/2 FTP site (e.g.  on FTP.UU.NET, the files
/systems/unix/bsd-sources/share/tmac/me/strip.sed and
/systems/unix/bsd-sources/share/tmac/*).

The strip.sed file is only used in installation.

After installation, edit tmac.doc and tmac.andoc to reflect the
installation path of the tmac files.  Those files contain pointers to
/usr/share/tmac/, and those pointers are not changed by the `make
install` process.

Rename the existing tmac.an to be tmac.an.old, and rename tmac.andoc
to be tmac.an.

tmac.an will choose between tmac.an.old, your old macros, or tmac.doc,
which are the new macros, so that both the new man pages and the
existing man pages will be translated properly.

I'm also told that the groff distribution from MIT has a tmac.doc
macro set that is compatible with these macros.


+-----------------------+
| RELATED DOCUMENTATION |
+-----------------------+

There are other files you should read.  Rooted in this directory are:

  CHANGES-R5-R8
	Describes changes between Release 5 and Release 8 of sendmail.
	There are some things that may behave somewhat differently.
	For example, the rules governing when :include: files will
	be read have been tightened up for security reasons.
  FAQ
	Answers to Frequently Asked Questions.
  KNOWNBUGS
	Known bugs in the current release.  I try to keep this up
	to date -- get the latest version from FTP.CS.Berkeley.EDU
	in /ucb/sendmail/KNOWNBUGS.
  RELEASE_NOTES
	A detailed description of the changes in each version.  This
	is quite long, but informative.
  src/READ_ME
	Details on compiling and installing sendmail.
  cf/README
	Details on configuring sendmail.
  doc/op/op.me
	The sendmail Installation & Operations Guide.  Be warned: if
	you are running this off on SunOS or some other system with an
	old version of -me, you need to add the following macro to the
	macros:

		.de sm
		\s-1\\$1\\s0\\$2
		..

	This sets a word in a smaller pointsize.


+--------------+
| RELATED RFCS |
+--------------+

There are several related RFCs that you may wish to read -- they are
available via anonymous FTP to several sites, including nic.ddn.mil
(directory rfc), ftp.nisc.sri.com (rfc), nis.nsf.net (RFC),
nisc.jvnc.net (rfc), venera.isi.edu (in-notes), and wuarchive.wustl.edu
(info/rfc).  They can also be retrieved via electronic mail by sending
email to one of:

	mail-server@nisc.sri.com
		Put "send rfcNNN" in message body
	nis-info@nis.nsf.net
		Put "send RFCnnn.TXT-1" in message body
	sendrfc@jvnc.net
		Put "RFCnnn" as Subject: line

Important RFCs for electronic mail are:

	RFC821	SMTP protocol
	RFC822	Mail header format
	RFC974	MX routing
	RFC976	UUCP mail format
	RFC1123	Host requirements (modifies 821, 822, and 974)
	RFC1413	Identification server
	RFC1341	MIME: Multipurpose Internet Mail Extensions
	RFC1344	Implications of MIME for Internet Mail Gateways

Other standards that may be of interest (but which are less directly
relevant to sendmail) are:

	RFC987	Mapping between RFC822 and X.400
	RFC1049	Content-Type header field (extension to RFC822)

Warning to AIX users: this version of sendmail does not implement
MB, MR, or MG DNS resource records, as defined as experiments in
RFC883.


+-------------------+
| DATABASE ROUTINES |
+-------------------+

IF YOU WANT TO RUN THE NEW BERKELEY DB SOFTWARE:  ****  DO NOT  ****
use the version that was on the Net2 tape -- it has a number of
nefarious bugs that were bad enough when I got them; you shouldn't have
to go through the same thing.  Instead, get a new version via public
FTP from ftp.CS.Berkeley.EDU, file ucb/4bsd/db.tar.Z.  This software
is highly recommended; it gets rid of several stupid limits, it's much
faster, and the interface is nicer to animals and plants.  You will
also probably find that you have to add -I/where/you/put/db/include
to the sendmail makefile to get db.h to work properly.

Be sure you remove ndbm.h and ndbm.o from the db distribution.  These
will cause problems with sendmail because sendmail already understands
about NEWDB and NDBM coexisting.


+-------------+
| USE WITH MH |
+-------------+

This version of sendmail notices and reports certain kinds of SMTP
protocol violations that were ignored by older versions.  If you
are running MH you may wish to install the patch in contrib/mh.patch
that will prevent these warning reports.  This patch also works
with the old version of sendmail, so it's safe to go ahead and
install it.


+-----------+
| MAKEFILES |
+-----------+

The Makefiles in this release use the new Berkeley "make" that is
available in BSD Net/2 and 4.4BSD.  If you are using this version
of make, you may notice one or two places where the Makefile includes
"../../Makefile.inc".  This file is not included with the sendmail
distribution because it's not part of sendmail.  However, it is,
in toto:

	#	@(#)Makefile.inc	8.1 (Berkeley) 6/6/93

	BINDIR?=	/usr/sbin

The other directories should all have Makefile.dist files that work
on the old make, albeit without all the niceties included.

You can also get a new Berkeley make from the Net2 release (available
on many public FTP archives).  This version should also interpret old
Makefiles, so you could drop it in as your default make.

For more details, see src/READ_ME.


+---------------------+
| DIRECTORY STRUCTURE |
+---------------------+

The structure of this directory tree is:

cf		Source for Berkeley configuration files.  These are
		different than what you've seen before.  They are a
		fairly dramatic rewrite, requiring the new sendmail
		(since they use new features).
contrib		Some contributed tools to help with sendmail.  THESE
		ARE NOT SUPPORTED by Berkeley -- contact the original
		authors if you have problems.  (This directory is not
		on the 4.4BSD tape.)
doc		Documentation.  If you are getting source, read
		op.me -- it's long, but worth it.
mailstats	Statistics printing program.  It has the pathname of
		sendmail.st compiled in, so if you've changed that,
		beware.  This isn't all that useful.
makemap		A program that creates the keyed maps used by the $( ... $)
		construct in sendmail.  It is primitive but effective.
		It takes a very simple input format, so you will probably
		expect to preprocess must human-convenient formats
		using sed scripts before this program will like them.
		But it should be functionally complete.
praliases	A program to print the DBM version of the aliases file.
		It hasn't been converted to understand the new Berkeley
		DB format (which we are using).
rmail		Source for rmail(8).  This is used as a delivery
		agent for for UUCP, and could presumably be used by
		other non-socket oriented mailers.  Older versions of
		rmail are probably deficient.
src		Source for the sendmail program itself.
test		Some test scripts (currently only for compilation aids).
Commit	Line	Data
15637ed4	1	/*-
d7c7bc4c	2	* @(#)READ_ME 8.9 (Berkeley) 1/26/94
15637ed4 RG	3	*/
15637ed4 RG	4
6f14531a RG	5	SENDMAIL RELEASE 8
	6
	7	This directory has the latest sendmail software from Berkeley. See
	8	doc/op/op.me for a summary of changes since 5.67.
	9
	10	Report any bugs to sendmail@CS.Berkeley.EDU.
	11
	12	The latest version of sendmail is kept on FTP.CS.Berkeley.EDU, directory
	13	/ucb/sendmail; check there for the latest revision.
	14
d747e748 JH	15
	16	+--------------+
	17	\| MANUAL PAGES \|
	18	+--------------+
	19
	20	The sendmail manual pages use contemporary Berkeley troff macros. If
	21	your system does not process these manual pages, you can pick up the
	22	new 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
	26	The strip.sed file is only used in installation.
	27
	28	After installation, edit tmac.doc and tmac.andoc to reflect the
	29	installation path of the tmac files. Those files contain pointers to
	30	/usr/share/tmac/, and those pointers are not changed by the `make
	31	install` process.
	32
	33	Rename the existing tmac.an to be tmac.an.old, and rename tmac.andoc
	34	to be tmac.an.
	35
	36	tmac.an will choose between tmac.an.old, your old macros, or tmac.doc,
	37	which are the new macros, so that both the new man pages and the
	38	existing man pages will be translated properly.
	39
	40	I'm also told that the groff distribution from MIT has a tmac.doc
	41	macro set that is compatible with these macros.
	42
	43
042b8fbf AM	44	+-----------------------+
	45	\| RELATED DOCUMENTATION \|
	46	+-----------------------+
	47
	48	There 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
d747e748 JH	81	+--------------+
	82	\| RELATED RFCS \|
	83	+--------------+
	84
6f14531a RG	85	There are several related RFCs that you may wish to read -- they are
	86	available via anonymous FTP to several sites, including nic.ddn.mil
	87	(directory rfc), ftp.nisc.sri.com (rfc), nis.nsf.net (RFC),
	88	nisc.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
	90	email 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
	99	Important 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
	110	Other standards that may be of interest (but which are less directly
	111	relevant to sendmail) are:
	112
	113	RFC987 Mapping between RFC822 and X.400
	114	RFC1049 Content-Type header field (extension to RFC822)
	115
d7c7bc4c AM	116	Warning to AIX users: this version of sendmail does not implement
	117	MB, MR, or MG DNS resource records, as defined as experiments in
	118	RFC883.
6f14531a	119
d747e748 JH	120
	121	+-------------------+
	122	\| DATABASE ROUTINES \|
	123	+-------------------+
6f14531a RG	124
	125	IF YOU WANT TO RUN THE NEW BERKELEY DB SOFTWARE: ** DO NOT **
	126	use the version that was on the Net2 tape -- it has a number of
	127	nefarious bugs that were bad enough when I got them; you shouldn't have
	128	to go through the same thing. Instead, get a new version via public
	129	FTP from ftp.CS.Berkeley.EDU, file ucb/4bsd/db.tar.Z. This software
	130	is highly recommended; it gets rid of several stupid limits, it's much
	131	faster, and the interface is nicer to animals and plants. You will
	132	also probably find that you have to add -I/where/you/put/db/include
	133	to the sendmail makefile to get db.h to work properly.
	134
d7c7bc4c AM	135	Be sure you remove ndbm.h and ndbm.o from the db distribution. These
	136	will cause problems with sendmail because sendmail already understands
	137	about NEWDB and NDBM coexisting.
	138
d747e748	139
042b8fbf AM	140	+-------------+
	141	\| USE WITH MH \|
	142	+-------------+
	143
	144	This version of sendmail notices and reports certain kinds of SMTP
	145	protocol violations that were ignored by older versions. If you
	146	are running MH you may wish to install the patch in contrib/mh.patch
	147	that will prevent these warning reports. This patch also works
	148	with the old version of sendmail, so it's safe to go ahead and
	149	install it.
	150
	151
	152	+-----------+
	153	\| MAKEFILES \|
	154	+-----------+
	155
	156	The Makefiles in this release use the new Berkeley "make" that is
	157	available in BSD Net/2 and 4.4BSD. If you are using this version
	158	of make, you may notice one or two places where the Makefile includes
	159	"../../Makefile.inc". This file is not included with the sendmail
	160	distribution because it's not part of sendmail. However, it is,
	161	in toto:
	162
	163	# @(#)Makefile.inc 8.1 (Berkeley) 6/6/93
	164
	165	BINDIR?= /usr/sbin
	166
	167	The other directories should all have Makefile.dist files that work
d7c7bc4c AM	168	on the old make, albeit without all the niceties included.
	169
	170	You can also get a new Berkeley make from the Net2 release (available
	171	on many public FTP archives). This version should also interpret old
	172	Makefiles, so you could drop it in as your default make.
	173
	174	For more details, see src/READ_ME.
042b8fbf AM	175
042b8fbf AM	176
d747e748 JH	177	+---------------------+
	178	\| DIRECTORY STRUCTURE \|
	179	+---------------------+
	180
6f14531a RG	181	The structure of this directory tree is:
	182
	183	cf Source for Berkeley configuration files. These are
	184	different than what you've seen before. They are a
	185	fairly dramatic rewrite, requiring the new sendmail
	186	(since they use new features).
	187	contrib Some contributed tools to help with sendmail. THESE
	188	ARE NOT SUPPORTED by Berkeley -- contact the original
	189	authors if you have problems. (This directory is not
	190	on the 4.4BSD tape.)
	191	doc Documentation. If you are getting source, read
	192	op.me -- it's long, but worth it.
	193	mailstats Statistics printing program. It has the pathname of
	194	sendmail.st compiled in, so if you've changed that,
	195	beware. This isn't all that useful.
	196	makemap A program that creates the keyed maps used by the $( ... $)
	197	construct in sendmail. It is primitive but effective.
	198	It takes a very simple input format, so you will probably
	199	expect to preprocess must human-convenient formats
	200	using sed scripts before this program will like them.
	201	But it should be functionally complete.
	202	praliases A program to print the DBM version of the aliases file.
	203	It hasn't been converted to understand the new Berkeley
	204	DB format (which we are using).
	205	rmail Source for rmail(8). This is used as a delivery
	206	agent for for UUCP, and could presumably be used by
	207	other non-socket oriented mailers. Older versions of
	208	rmail are probably deficient.
15637ed4	209	src Source for the sendmail program itself.
d747e748	210	test Some test scripts (currently only for compilation aids).