xref: /original-bsd/usr.sbin/sendmail/src/READ_ME (revision 4a884f8b)
1# Copyright (c) 1983 Eric P. Allman
2# Copyright (c) 1988 The Regents of the University of California.
3# All rights reserved.
4#
5# %sccs.include.redist.sh%
6#
7#	@(#)READ_ME	6.4 (Berkeley) 02/14/93
8#
9
10This directory contains the source files for sendmail.
11
12For installation instructions, please read the document ../doc/op.me:
13
14	nroff -me ../doc/op.me
15
16The Makefile is for the new Berkeley make, available from ftp.uu.net
17in the directory /systems/unix/bsd-sources/usr.bin/make.  There is
18also a Makefile.dist which is much less clever, but works on the old
19traditional make.  You can use this using:
20
21	make -f Makefile.dist
22
23If you are compiling on SunOS, you must use -Bstatic -- if you do not,
24frozen configuration files fail in bizarre ways and you will open up
25several security holes.
26
27If you are compiling on OSF/1 (DEC Alpha), you must use -lmld.
28
29If you use both -DDBM and -DNEWDB, you must delete the module ndbm.o
30from libdb.a.  This compatibility module maps ndbm calls into DB
31calls, and breaks things rather badly.
32
33The following list describes the files in this directory:
34
35Makefile	The makefile used here; this version only works with
36		the new Berkeley make.
37Makefile.dist	A trimmed down version of the makefile that works with
38		the old make.
39READ_ME		This file.
40TODO		New features to be put in (maybe) at some time.
41Version.c	The version number and information about this
42		version of sendmail.  Theoretically, this gets
43		modified on every change.
44alias.c		Does name aliasing in all forms.
45arpadate.c	A subroutine which creates ARPANET standard dates.
46clock.c		Routines to implement real-time oriented functions
47		in sendmail -- e.g., timeouts.
48collect.c	The routine that actually reads the mail into a temp
49		file.  It also does a certain amount of parsing of
50		the header, etc.
51conf.c		The configuration file.  This contains information
52		that is presumed to be quite static and non-
53		controversial, or code compiled in for efficiency
54		reasons.  Most of the configuration is in sendmail.cf.
55conf.h		Configuration that must be known everywhere.
56convtime.c	A routine to sanely process times.
57daemon.c	Routines to implement daemon mode.  This version is
58		specifically for Berkeley 4.1 IPC.
59deliver.c	Routines to deliver mail.
60err.c		Routines to print error messages.
61envelope.c	Routines to manipulate the envelope structure.
62headers.c	Routines to process message headers.
63macro.c		The macro expander.  This is used internally to
64		insert information from the configuration file.
65main.c		The main routine to sendmail.  This file also
66		contains some miscellaneous routines.
67parseaddr.c	The routines which do address parsing.
68queue.c		Routines to implement message queueing.
69readcf.c	The routine that reads the configuration file and
70		translates it to internal form.
71recipient.c	Routines that manipulate the recipient list.
72savemail.c	Routines which save the letter on processing errors.
73sendmail.h	Main header file for sendmail.
74srvrsmtp.c	Routines to implement server SMTP.
75stab.c		Routines to manage the symbol table.
76stats.c		Routines to collect and post the statistics.
77sysexits.c	List of error messages associated with error codes
78		in sysexits.h.
79trace.c		The trace package.  These routines allow setting and
80		testing of trace flags with a high granularity.
81trace.h		Definitions needed for the trace package.
82usersmtp.c	Routines to implement user SMTP.
83util.c		Some general purpose routines used by sendmail.
84version.c	A master file for Version.c -- it may not exist in
85		your distribution.
86
87Eric Allman
88
89(Version 6.4, last update 02/14/93 14:41:27)
90