xref: /csrg-svn/usr.sbin/sendmail/src/READ_ME (revision 22820)
1#
2#  Sendmail
3#  Copyright (c) 1983  Eric P. Allman
4#  Berkeley, California
5#
6#  Copyright (c) 1983 Regents of the University of California.
7#  All rights reserved.  The Berkeley software License Agreement
8#  specifies the terms and conditions for redistribution.
9#
10#	@(#)READ_ME	4.2 (Berkeley) 06/07/85
11#
12This directory contains the source files for sendmail.
13
14For installation instructions, please read the document ../doc/op.me:
15
16	nroff -me ../doc/op.me
17
18The following list describes the files in this directory:
19
20Makefile	The makefile used here; this is created from
21		makefile.m4.
22Makefile.m4	A makefile template.
23READ_ME		This file.
24TODO		New features to be put in (maybe) at some time.
25Version.c	The version number and information about this
26		version of sendmail.  Theoretically, this gets
27		modified on every change.
28alias.c		Does name aliasing in all forms.
29arpadate.c	A subroutine which creates ARPANET standard dates.
30bmove.c		A core-to-core move.  This is in a separate file
31		because it can easily be replaced by a blindingly
32		efficient version on Vaxes.
33bmove.*.s	Versions of bmove optimized for specific processors.
34clock.c		Routines to implement real-time oriented functions
35		in sendmail -- e.g., timeouts.
36collect.c	The routine that actually reads the mail into a temp
37		file.  It also does a certain amount of parsing of
38		the header, etc.
39conf.c		The configuration file.  This contains information
40		that is presumed to be quite static and non-
41		controversial, or code compiled in for efficiency
42		reasons.  Most of the configuration is in sendmail.cf.
43conf.h		Configuration that must be known everywhere.
44convtime.c	A routine to sanely process times.
45daemon.c	Routines to implement daemon mode.  This version is
46		specifically for Berkeley 4.1 IPC.
47deliver.c	Routines to deliver mail.
48err.c		Routines to print error messages.
49envelope.c	Routines to manipulate the envelope structure.
50headers.c	Routines to process message headers.
51macro.c		The macro expander.  This is used internally to
52		insert information from the configuration file.
53main.c		The main routine to sendmail.  This file also
54		contains some miscellaneous routines.
55parseaddr.c	The routines which do address parsing.
56queue.c		Routines to implement message queueing.
57readcf.c	The routine that reads the configuration file and
58		translates it to internal form.
59recipient.c	Routines that manipulate the recipient list.
60savemail.c	Routines which save the letter on processing errors.
61sendmail.h	Main header file for sendmail.
62srvrsmtp.c	Routines to implement server SMTP.
63stab.c		Routines to manage the symbol table.
64stats.c		Routines to collect and post the statistics.
65sysexits.c	List of error messages associated with error codes
66		in sysexits.h.
67trace.c		The trace package.  These routines allow setting and
68		testing of trace flags with a high granularity.
69trace.h		Definitions needed for the trace package.
70usersmtp.c	Routines to implement user SMTP.
71util.c		Some general purpose routines used by sendmail.
72version.c	A master file for Version.c -- it may not exist in
73		your distribution.
74
75Eric Allman
76
77(Version 4.2, last update 06/07/85 21:34:51)
78