[unix-history] / usr / src / usr.sbin / sendmail / src / READ_ME

# Copyright (c) 1983 Eric P. Allman
# Copyright (c) 1988 The Regents of the University of California.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
# 3. All advertising materials mentioning features or use of this software
#    must display the following acknowledgement:
#	This product includes software developed by the University of
#	California, Berkeley and its contributors.
# 4. Neither the name of the University nor the names of its contributors
#    may be used to endorse or promote products derived from this software
#    without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
#	@(#)READ_ME	4.6 (Berkeley) 4/23/91
#

This directory contains the source files for sendmail.

For installation instructions, please read the document ../doc/op.me:

	nroff -me ../doc/op.me

The following list describes the files in this directory:

Makefile	The makefile used here; this is created from
		makefile.m4.
Makefile.m4	A makefile template.
READ_ME		This file.
TODO		New features to be put in (maybe) at some time.
Version.c	The version number and information about this
		version of sendmail.  Theoretically, this gets
		modified on every change.
alias.c		Does name aliasing in all forms.
arpadate.c	A subroutine which creates ARPANET standard dates.
clock.c		Routines to implement real-time oriented functions
		in sendmail -- e.g., timeouts.
collect.c	The routine that actually reads the mail into a temp
		file.  It also does a certain amount of parsing of
		the header, etc.
conf.c		The configuration file.  This contains information
		that is presumed to be quite static and non-
		controversial, or code compiled in for efficiency
		reasons.  Most of the configuration is in sendmail.cf.
conf.h		Configuration that must be known everywhere.
convtime.c	A routine to sanely process times.
daemon.c	Routines to implement daemon mode.  This version is
		specifically for Berkeley 4.1 IPC.
deliver.c	Routines to deliver mail.
err.c		Routines to print error messages.
envelope.c	Routines to manipulate the envelope structure.
headers.c	Routines to process message headers.
macro.c		The macro expander.  This is used internally to
		insert information from the configuration file.
main.c		The main routine to sendmail.  This file also
		contains some miscellaneous routines.
parseaddr.c	The routines which do address parsing.
queue.c		Routines to implement message queueing.
readcf.c	The routine that reads the configuration file and
		translates it to internal form.
recipient.c	Routines that manipulate the recipient list.
savemail.c	Routines which save the letter on processing errors.
sendmail.h	Main header file for sendmail.
srvrsmtp.c	Routines to implement server SMTP.
stab.c		Routines to manage the symbol table.
stats.c		Routines to collect and post the statistics.
sysexits.c	List of error messages associated with error codes
		in sysexits.h.
trace.c		The trace package.  These routines allow setting and
		testing of trace flags with a high granularity.
trace.h		Definitions needed for the trace package.
usersmtp.c	Routines to implement user SMTP.
util.c		Some general purpose routines used by sendmail.
version.c	A master file for Version.c -- it may not exist in
		your distribution.

Eric Allman

(Version 4.6, last update 4/23/91 19:52:27)
Commit	Line	Data
a29ae0a3	1	# Copyright (c) 1983 Eric P. Allman
af359dea	2	# Copyright (c) 1988 The Regents of the University of California.
bee79b64 KB	3	# All rights reserved.
bee79b64 KB	4	#
af359dea C	5	# Redistribution and use in source and binary forms, with or without
	6	# modification, are permitted provided that the following conditions
	7	# are met:
	8	# 1. Redistributions of source code must retain the above copyright
	9	# notice, this list of conditions and the following disclaimer.
	10	# 2. Redistributions in binary form must reproduce the above copyright
	11	# notice, this list of conditions and the following disclaimer in the
	12	# documentation and/or other materials provided with the distribution.
	13	# 3. All advertising materials mentioning features or use of this software
	14	# must display the following acknowledgement:
	15	# This product includes software developed by the University of
	16	# California, Berkeley and its contributors.
	17	# 4. Neither the name of the University nor the names of its contributors
	18	# may be used to endorse or promote products derived from this software
	19	# without specific prior written permission.
	20	#
	21	# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	22	# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	23	# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	24	# ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	25	# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	26	# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	27	# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	28	# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	29	# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	30	# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	31	# SUCH DAMAGE.
bee79b64	32	#
af359dea	33	# @(#)READ_ME 4.6 (Berkeley) 4/23/91
aac2beaf	34	#
af359dea	35
bd144236	36	This directory contains the source files for sendmail.
2a9def67	37
bd144236	38	For installation instructions, please read the document ../doc/op.me:
2a9def67	39
bd144236	40	nroff -me ../doc/op.me
2a9def67	41
bd144236	42	The following list describes the files in this directory:
2a9def67	43
bd144236 EA	44	Makefile The makefile used here; this is created from
	45	makefile.m4.
	46	Makefile.m4 A makefile template.
2a9def67 EA	47	READ_ME This file.
	48	TODO New features to be put in (maybe) at some time.
	49	Version.c The version number and information about this
	50	version of sendmail. Theoretically, this gets
	51	modified on every change.
	52	alias.c Does name aliasing in all forms.
bd144236	53	arpadate.c A subroutine which creates ARPANET standard dates.
bd144236 EA	54	clock.c Routines to implement real-time oriented functions
bd144236 EA	55	in sendmail -- e.g., timeouts.
2a9def67 EA	56	collect.c The routine that actually reads the mail into a temp
	57	file. It also does a certain amount of parsing of
	58	the header, etc.
	59	conf.c The configuration file. This contains information
	60	that is presumed to be quite static and non-
	61	controversial, or code compiled in for efficiency
	62	reasons. Most of the configuration is in sendmail.cf.
bd144236	63	conf.h Configuration that must be known everywhere.
2a9def67	64	convtime.c A routine to sanely process times.
bd144236 EA	65	daemon.c Routines to implement daemon mode. This version is
bd144236 EA	66	specifically for Berkeley 4.1 IPC.
2a9def67 EA	67	deliver.c Routines to deliver mail.
2a9def67 EA	68	err.c Routines to print error messages.
bd144236	69	envelope.c Routines to manipulate the envelope structure.
2a9def67 EA	70	headers.c Routines to process message headers.
	71	macro.c The macro expander. This is used internally to
	72	insert information from the configuration file.
2a9def67 EA	73	main.c The main routine to sendmail. This file also
2a9def67 EA	74	contains some miscellaneous routines.
bd144236	75	parseaddr.c The routines which do address parsing.
2a9def67 EA	76	queue.c Routines to implement message queueing.
	77	readcf.c The routine that reads the configuration file and
	78	translates it to internal form.
bd144236	79	recipient.c Routines that manipulate the recipient list.
2a9def67	80	savemail.c Routines which save the letter on processing errors.
2a9def67	81	sendmail.h Main header file for sendmail.
2a9def67 EA	82	srvrsmtp.c Routines to implement server SMTP.
	83	stab.c Routines to manage the symbol table.
	84	stats.c Routines to collect and post the statistics.
	85	sysexits.c List of error messages associated with error codes
	86	in sysexits.h.
bd144236 EA	87	trace.c The trace package. These routines allow setting and
	88	testing of trace flags with a high granularity.
	89	trace.h Definitions needed for the trace package.
2a9def67 EA	90	usersmtp.c Routines to implement user SMTP.
2a9def67 EA	91	util.c Some general purpose routines used by sendmail.
2a9def67 EA	92	version.c A master file for Version.c -- it may not exist in
2a9def67 EA	93	your distribution.
2a9def67 EA	94
	95	Eric Allman
	96
af359dea	97	(Version 4.6, last update 4/23/91 19:52:27)