xref: /csrg-svn/usr.sbin/sendmail/src/READ_ME (revision 57418)
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*57418Seric#	@(#)READ_ME	6.2 (Berkeley) 01/05/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
16*57418SericThe Makefile is for the new Berkeley make, available from ftp.uu.net
17*57418Sericin the directory /systems/unix/bsd-sources/usr.bin/make.  There is
18*57418Sericalso a Makefile.dist which is much less clever, but works on the old
19*57418Serictraditional make.  You can use this using:
20*57418Seric
21*57418Seric	make -f Makefile.dist
22*57418Seric
239881SericThe following list describes the files in this directory:
245369Seric
25*57418SericMakefile	The makefile used here; this version only works with
26*57418Seric		the new Berkeley make.
27*57418SericMakefile.dist	A trimmed down version of the makefile that works with
28*57418Seric		the old make.
295369SericREAD_ME		This file.
305369SericTODO		New features to be put in (maybe) at some time.
315369SericVersion.c	The version number and information about this
325369Seric		version of sendmail.  Theoretically, this gets
335369Seric		modified on every change.
345369Sericalias.c		Does name aliasing in all forms.
359881Sericarpadate.c	A subroutine which creates ARPANET standard dates.
369881Sericclock.c		Routines to implement real-time oriented functions
379881Seric		in sendmail -- e.g., timeouts.
385369Sericcollect.c	The routine that actually reads the mail into a temp
395369Seric		file.  It also does a certain amount of parsing of
405369Seric		the header, etc.
415369Sericconf.c		The configuration file.  This contains information
425369Seric		that is presumed to be quite static and non-
435369Seric		controversial, or code compiled in for efficiency
445369Seric		reasons.  Most of the configuration is in sendmail.cf.
459881Sericconf.h		Configuration that must be known everywhere.
465369Sericconvtime.c	A routine to sanely process times.
479881Sericdaemon.c	Routines to implement daemon mode.  This version is
489881Seric		specifically for Berkeley 4.1 IPC.
495369Sericdeliver.c	Routines to deliver mail.
505369Sericerr.c		Routines to print error messages.
519881Sericenvelope.c	Routines to manipulate the envelope structure.
525369Sericheaders.c	Routines to process message headers.
535369Sericmacro.c		The macro expander.  This is used internally to
545369Seric		insert information from the configuration file.
555369Sericmain.c		The main routine to sendmail.  This file also
565369Seric		contains some miscellaneous routines.
579881Sericparseaddr.c	The routines which do address parsing.
585369Sericqueue.c		Routines to implement message queueing.
595369Sericreadcf.c	The routine that reads the configuration file and
605369Seric		translates it to internal form.
619881Sericrecipient.c	Routines that manipulate the recipient list.
625369Sericsavemail.c	Routines which save the letter on processing errors.
635369Sericsendmail.h	Main header file for sendmail.
645369Sericsrvrsmtp.c	Routines to implement server SMTP.
655369Sericstab.c		Routines to manage the symbol table.
665369Sericstats.c		Routines to collect and post the statistics.
675369Sericsysexits.c	List of error messages associated with error codes
685369Seric		in sysexits.h.
699881Serictrace.c		The trace package.  These routines allow setting and
709881Seric		testing of trace flags with a high granularity.
719881Serictrace.h		Definitions needed for the trace package.
725369Sericusersmtp.c	Routines to implement user SMTP.
735369Sericutil.c		Some general purpose routines used by sendmail.
745369Sericversion.c	A master file for Version.c -- it may not exist in
755369Seric		your distribution.
765369Seric
775369SericEric Allman
785369Seric
79*57418Seric(Version 6.2, last update 01/05/93 08:24:56)
80