xref: /csrg-svn/usr.sbin/sendmail/src/READ_ME (revision 35062)
122820Smiriam#
2*35062Sbostic# Copyright (c) 1983 Eric P. Allman
333728Sbostic# Copyright (c) 1988 Regents of the University of California.
433728Sbostic# All rights reserved.
533728Sbostic#
633728Sbostic# Redistribution and use in source and binary forms are permitted
7*35062Sbostic# provided that the above copyright notice and this paragraph are
8*35062Sbostic# duplicated in all such forms and that any documentation,
9*35062Sbostic# advertising materials, and other materials related to such
10*35062Sbostic# distribution and use acknowledge that the software was developed
11*35062Sbostic# by the University of California, Berkeley.  The name of the
12*35062Sbostic# University may not be used to endorse or promote products derived
13*35062Sbostic# from this software without specific prior written permission.
14*35062Sbostic# THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
15*35062Sbostic# IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
16*35062Sbostic# WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
1733728Sbostic#
18*35062Sbostic#	@(#)READ_ME	4.5 (Berkeley) 07/10/88
1933728Sbostic#
209881SericThis directory contains the source files for sendmail.
215369Seric
229881SericFor installation instructions, please read the document ../doc/op.me:
235369Seric
249881Seric	nroff -me ../doc/op.me
255369Seric
269881SericThe following list describes the files in this directory:
275369Seric
289881SericMakefile	The makefile used here; this is created from
299881Seric		makefile.m4.
309881SericMakefile.m4	A makefile template.
315369SericREAD_ME		This file.
325369SericTODO		New features to be put in (maybe) at some time.
335369SericVersion.c	The version number and information about this
345369Seric		version of sendmail.  Theoretically, this gets
355369Seric		modified on every change.
365369Sericalias.c		Does name aliasing in all forms.
379881Sericarpadate.c	A subroutine which creates ARPANET standard dates.
389881Sericclock.c		Routines to implement real-time oriented functions
399881Seric		in sendmail -- e.g., timeouts.
405369Sericcollect.c	The routine that actually reads the mail into a temp
415369Seric		file.  It also does a certain amount of parsing of
425369Seric		the header, etc.
435369Sericconf.c		The configuration file.  This contains information
445369Seric		that is presumed to be quite static and non-
455369Seric		controversial, or code compiled in for efficiency
465369Seric		reasons.  Most of the configuration is in sendmail.cf.
479881Sericconf.h		Configuration that must be known everywhere.
485369Sericconvtime.c	A routine to sanely process times.
499881Sericdaemon.c	Routines to implement daemon mode.  This version is
509881Seric		specifically for Berkeley 4.1 IPC.
515369Sericdeliver.c	Routines to deliver mail.
525369Sericerr.c		Routines to print error messages.
539881Sericenvelope.c	Routines to manipulate the envelope structure.
545369Sericheaders.c	Routines to process message headers.
555369Sericmacro.c		The macro expander.  This is used internally to
565369Seric		insert information from the configuration file.
575369Sericmain.c		The main routine to sendmail.  This file also
585369Seric		contains some miscellaneous routines.
599881Sericparseaddr.c	The routines which do address parsing.
605369Sericqueue.c		Routines to implement message queueing.
615369Sericreadcf.c	The routine that reads the configuration file and
625369Seric		translates it to internal form.
639881Sericrecipient.c	Routines that manipulate the recipient list.
645369Sericsavemail.c	Routines which save the letter on processing errors.
655369Sericsendmail.h	Main header file for sendmail.
665369Sericsrvrsmtp.c	Routines to implement server SMTP.
675369Sericstab.c		Routines to manage the symbol table.
685369Sericstats.c		Routines to collect and post the statistics.
695369Sericsysexits.c	List of error messages associated with error codes
705369Seric		in sysexits.h.
719881Serictrace.c		The trace package.  These routines allow setting and
729881Seric		testing of trace flags with a high granularity.
739881Serictrace.h		Definitions needed for the trace package.
745369Sericusersmtp.c	Routines to implement user SMTP.
755369Sericutil.c		Some general purpose routines used by sendmail.
765369Sericversion.c	A master file for Version.c -- it may not exist in
775369Seric		your distribution.
785369Seric
795369SericEric Allman
805369Seric
81*35062Sbostic(Version 4.5, last update 07/10/88 12:43:25)
82