xref: /illumos-gate/usr/src/cmd/sendmail/src/READ_ME (revision 7c478bd9)

#
# Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License, Version 1.0 only
# (the "License").  You may not use this file except in compliance
# with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#
#ident	"%Z%%M%	%I%	%E% SMI"

This directory contains the source files for sendmail.

The following list describes the files in this directory:

Makefile	The makefile used here.
READ_ME		This file.
alias.c		Does name aliasing in all forms.
arpadate.c	A subroutine which creates ARPANET standard dates.
bf.c		Routines to implement memory-buffered file system using
		hooks provided by libsm now.
bf.h		Buffered file I/O function declarations and
		data structure and function declarations for bf.c.
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.
control.c	Code for sendmail's daemon control socket.
convtime.c	A routine to sanely process times.
daemon.c	Routines to implement daemon mode.
deliver.c	Routines to deliver mail.
domain.c	Routines that interface with DNS (the Domain Name System).
envelope.c	Routines to manipulate the envelope structure.
err.c		Routines to print error messages.
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.
map.c		Key database map routines.
mci.c		Routines that handle mail connection information caching.
milter.c	MTA portions of the mail filter API.
mime.c		Multipurpose Internet Mail Extensions conversion 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.
sm_resolve.c	Routines for DNS lookups (for DNS map type).
sm_resolve.h	Header file for sm_resolve.c.
srvrsmtp.c	Routines to implement server SMTP.
stab.c		Routines to manage the symbol table.
stats.c		Routines to collect and post the statistics.
statusd_shm.h	Data structure and function declarations for shmticklib.c.
sun_compat.c	Lots of hacks, mostly for backwards compatibility.
sysexits.c	List of error messages associated with error codes
		in sysexits.h.
sysexits.h	List of error codes for systems that lack their own.
timers.h	Header file for timer stuff.
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.
udb.c		The user database interface module.
usersmtp.c	Routines to implement user SMTP.
util.c		Some general purpose routines used by sendmail.
version.c	The current version of sendmail.

Eric Allman

(Version %I%, last update %E%)