xref: /csrg-svn/usr.sbin/sendmail/src/READ_ME (revision 58709)
135062Sbostic# Copyright (c) 1983 Eric P. Allman
248582Sbostic# Copyright (c) 1988 The Regents of the University of California.
333728Sbostic# All rights reserved.
433728Sbostic#
548582Sbostic# %sccs.include.redist.sh%
633728Sbostic#
7*58709Seric#	@(#)READ_ME	6.5 (Berkeley) 03/18/93
833728Sbostic#
948582Sbostic
109881SericThis directory contains the source files for sendmail.
115369Seric
129881SericFor installation instructions, please read the document ../doc/op.me:
135369Seric
149881Seric	nroff -me ../doc/op.me
155369Seric
1657418SericThe Makefile is for the new Berkeley make, available from ftp.uu.net
1757418Sericin the directory /systems/unix/bsd-sources/usr.bin/make.  There is
1857418Sericalso a Makefile.dist which is much less clever, but works on the old
1957418Serictraditional make.  You can use this using:
2057418Seric
2157418Seric	make -f Makefile.dist
2257418Seric
2357943SericIf you are compiling on SunOS, you must use -Bstatic -- if you do not,
2457943Sericfrozen configuration files fail in bizarre ways and you will open up
2557943Sericseveral security holes.
2657943Seric
2757977SericIf you are compiling on OSF/1 (DEC Alpha), you must use -lmld.
2857977Seric
29*58709SericIf you use both -DNDBM and -DNEWDB, you must delete the module ndbm.o
3057943Sericfrom libdb.a.  This compatibility module maps ndbm calls into DB
3157943Sericcalls, and breaks things rather badly.
3257943Seric
33*58709SericYou probably want to look over the compilation options in conf.h
34*58709Sericbefore you compile.  These are intended to be per-site information.
35*58709Seric
369881SericThe following list describes the files in this directory:
375369Seric
3857418SericMakefile	The makefile used here; this version only works with
3957418Seric		the new Berkeley make.
4057418SericMakefile.dist	A trimmed down version of the makefile that works with
4157418Seric		the old make.
425369SericREAD_ME		This file.
435369SericTODO		New features to be put in (maybe) at some time.
445369SericVersion.c	The version number and information about this
455369Seric		version of sendmail.  Theoretically, this gets
465369Seric		modified on every change.
475369Sericalias.c		Does name aliasing in all forms.
489881Sericarpadate.c	A subroutine which creates ARPANET standard dates.
499881Sericclock.c		Routines to implement real-time oriented functions
509881Seric		in sendmail -- e.g., timeouts.
515369Sericcollect.c	The routine that actually reads the mail into a temp
525369Seric		file.  It also does a certain amount of parsing of
535369Seric		the header, etc.
545369Sericconf.c		The configuration file.  This contains information
555369Seric		that is presumed to be quite static and non-
565369Seric		controversial, or code compiled in for efficiency
575369Seric		reasons.  Most of the configuration is in sendmail.cf.
589881Sericconf.h		Configuration that must be known everywhere.
595369Sericconvtime.c	A routine to sanely process times.
609881Sericdaemon.c	Routines to implement daemon mode.  This version is
619881Seric		specifically for Berkeley 4.1 IPC.
625369Sericdeliver.c	Routines to deliver mail.
635369Sericerr.c		Routines to print error messages.
649881Sericenvelope.c	Routines to manipulate the envelope structure.
655369Sericheaders.c	Routines to process message headers.
665369Sericmacro.c		The macro expander.  This is used internally to
675369Seric		insert information from the configuration file.
685369Sericmain.c		The main routine to sendmail.  This file also
695369Seric		contains some miscellaneous routines.
709881Sericparseaddr.c	The routines which do address parsing.
715369Sericqueue.c		Routines to implement message queueing.
725369Sericreadcf.c	The routine that reads the configuration file and
735369Seric		translates it to internal form.
749881Sericrecipient.c	Routines that manipulate the recipient list.
755369Sericsavemail.c	Routines which save the letter on processing errors.
765369Sericsendmail.h	Main header file for sendmail.
775369Sericsrvrsmtp.c	Routines to implement server SMTP.
785369Sericstab.c		Routines to manage the symbol table.
795369Sericstats.c		Routines to collect and post the statistics.
805369Sericsysexits.c	List of error messages associated with error codes
815369Seric		in sysexits.h.
829881Serictrace.c		The trace package.  These routines allow setting and
839881Seric		testing of trace flags with a high granularity.
849881Serictrace.h		Definitions needed for the trace package.
855369Sericusersmtp.c	Routines to implement user SMTP.
865369Sericutil.c		Some general purpose routines used by sendmail.
875369Sericversion.c	A master file for Version.c -- it may not exist in
885369Seric		your distribution.
895369Seric
905369SericEric Allman
915369Seric
92*58709Seric(Version 6.5, last update 03/18/93 11:54:06)
93