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