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