xref: /csrg-svn/usr.sbin/sendmail/src/READ_ME (revision 48582)
135062Sbostic# Copyright (c) 1983 Eric P. Allman
2*48582Sbostic# Copyright (c) 1988 The Regents of the University of California.
333728Sbostic# All rights reserved.
433728Sbostic#
5*48582Sbostic# %sccs.include.redist.sh%
633728Sbostic#
7*48582Sbostic#	@(#)READ_ME	4.6 (Berkeley) 04/23/91
833728Sbostic#
9*48582Sbostic
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
169881SericThe following list describes the files in this directory:
175369Seric
189881SericMakefile	The makefile used here; this is created from
199881Seric		makefile.m4.
209881SericMakefile.m4	A makefile template.
215369SericREAD_ME		This file.
225369SericTODO		New features to be put in (maybe) at some time.
235369SericVersion.c	The version number and information about this
245369Seric		version of sendmail.  Theoretically, this gets
255369Seric		modified on every change.
265369Sericalias.c		Does name aliasing in all forms.
279881Sericarpadate.c	A subroutine which creates ARPANET standard dates.
289881Sericclock.c		Routines to implement real-time oriented functions
299881Seric		in sendmail -- e.g., timeouts.
305369Sericcollect.c	The routine that actually reads the mail into a temp
315369Seric		file.  It also does a certain amount of parsing of
325369Seric		the header, etc.
335369Sericconf.c		The configuration file.  This contains information
345369Seric		that is presumed to be quite static and non-
355369Seric		controversial, or code compiled in for efficiency
365369Seric		reasons.  Most of the configuration is in sendmail.cf.
379881Sericconf.h		Configuration that must be known everywhere.
385369Sericconvtime.c	A routine to sanely process times.
399881Sericdaemon.c	Routines to implement daemon mode.  This version is
409881Seric		specifically for Berkeley 4.1 IPC.
415369Sericdeliver.c	Routines to deliver mail.
425369Sericerr.c		Routines to print error messages.
439881Sericenvelope.c	Routines to manipulate the envelope structure.
445369Sericheaders.c	Routines to process message headers.
455369Sericmacro.c		The macro expander.  This is used internally to
465369Seric		insert information from the configuration file.
475369Sericmain.c		The main routine to sendmail.  This file also
485369Seric		contains some miscellaneous routines.
499881Sericparseaddr.c	The routines which do address parsing.
505369Sericqueue.c		Routines to implement message queueing.
515369Sericreadcf.c	The routine that reads the configuration file and
525369Seric		translates it to internal form.
539881Sericrecipient.c	Routines that manipulate the recipient list.
545369Sericsavemail.c	Routines which save the letter on processing errors.
555369Sericsendmail.h	Main header file for sendmail.
565369Sericsrvrsmtp.c	Routines to implement server SMTP.
575369Sericstab.c		Routines to manage the symbol table.
585369Sericstats.c		Routines to collect and post the statistics.
595369Sericsysexits.c	List of error messages associated with error codes
605369Seric		in sysexits.h.
619881Serictrace.c		The trace package.  These routines allow setting and
629881Seric		testing of trace flags with a high granularity.
639881Serictrace.h		Definitions needed for the trace package.
645369Sericusersmtp.c	Routines to implement user SMTP.
655369Sericutil.c		Some general purpose routines used by sendmail.
665369Sericversion.c	A master file for Version.c -- it may not exist in
675369Seric		your distribution.
685369Seric
695369SericEric Allman
705369Seric
71*48582Sbostic(Version 4.6, last update 04/23/91 19:52:41)
72