xref: /original-bsd/usr.sbin/sendmail/READ_ME (revision edc2ab72)
1/*-
2 *	@(#)READ_ME	8.6 (Berkeley) 12/01/93
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
69
70+--------------+
71| RELATED RFCS |
72+--------------+
73
74There are several related RFCs that you may wish to read -- they are
75available via anonymous FTP to several sites, including nic.ddn.mil
76(directory rfc), ftp.nisc.sri.com (rfc), nis.nsf.net (RFC),
77nisc.jvnc.net (rfc), venera.isi.edu (in-notes), and wuarchive.wustl.edu
78(info/rfc).  They can also be retrieved via electronic mail by sending
79email to one of:
80
81	mail-server@nisc.sri.com
82		Put "send rfcNNN" in message body
83	nis-info@nis.nsf.net
84		Put "send RFCnnn.TXT-1" in message body
85	sendrfc@jvnc.net
86		Put "RFCnnn" as Subject: line
87
88Important RFCs for electronic mail are:
89
90	RFC821	SMTP protocol
91	RFC822	Mail header format
92	RFC974	MX routing
93	RFC976	UUCP mail format
94	RFC1123	Host requirements (modifies 821, 822, and 974)
95	RFC1413	Identification server
96	RFC1341	MIME: Multipurpose Internet Mail Extensions
97	RFC1344	Implications of MIME for Internet Mail Gateways
98
99Other standards that may be of interest (but which are less directly
100relevant to sendmail) are:
101
102	RFC987	Mapping between RFC822 and X.400
103	RFC1049	Content-Type header field (extension to RFC822)
104
105Unfortunately, for a variety of reasons the Makefiles are for the new
106Berkeley "make" and will not work on the old, traditional make.  I urge
107you to get this make from Net2 (available on many public FTP archives).
108Failing that, some directories have a "Makefile.dist" that will work on
109older versions of make (but don't have the niceties included).
110
111
112+-------------------+
113| DATABASE ROUTINES |
114+-------------------+
115
116IF YOU WANT TO RUN THE NEW BERKELEY DB SOFTWARE:  ****  DO NOT  ****
117use the version that was on the Net2 tape -- it has a number of
118nefarious bugs that were bad enough when I got them; you shouldn't have
119to go through the same thing.  Instead, get a new version via public
120FTP from ftp.CS.Berkeley.EDU, file ucb/4bsd/db.tar.Z.  This software
121is highly recommended; it gets rid of several stupid limits, it's much
122faster, and the interface is nicer to animals and plants.  You will
123also probably find that you have to add -I/where/you/put/db/include
124to the sendmail makefile to get db.h to work properly.
125
126
127+---------------------+
128| DIRECTORY STRUCTURE |
129+---------------------+
130
131The structure of this directory tree is:
132
133cf		Source for Berkeley configuration files.  These are
134		different than what you've seen before.  They are a
135		fairly dramatic rewrite, requiring the new sendmail
136		(since they use new features).
137contrib		Some contributed tools to help with sendmail.  THESE
138		ARE NOT SUPPORTED by Berkeley -- contact the original
139		authors if you have problems.  (This directory is not
140		on the 4.4BSD tape.)
141doc		Documentation.  If you are getting source, read
142		op.me -- it's long, but worth it.
143mailstats	Statistics printing program.  It has the pathname of
144		sendmail.st compiled in, so if you've changed that,
145		beware.  This isn't all that useful.
146makemap		A program that creates the keyed maps used by the $( ... $)
147		construct in sendmail.  It is primitive but effective.
148		It takes a very simple input format, so you will probably
149		expect to preprocess must human-convenient formats
150		using sed scripts before this program will like them.
151		But it should be functionally complete.
152praliases	A program to print the DBM version of the aliases file.
153		It hasn't been converted to understand the new Berkeley
154		DB format (which we are using).
155rmail		Source for rmail(8).  This is used as a delivery
156		agent for for UUCP, and could presumably be used by
157		other non-socket oriented mailers.  Older versions of
158		rmail are probably deficient.
159src		Source for the sendmail program itself.
160test		Some test scripts (currently only for compilation aids).
161