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 6.6 (Berkeley) 05/21/93 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 Makefile is for the new Berkeley make, available from ftp.uu.net 17in the directory /systems/unix/bsd-sources/usr.bin/make. There is 18also a Makefile.dist which is much less clever, but works on the old 19traditional make. You can use this using: 20 21 make -f Makefile.dist 22 23If you are compiling on SunOS, you must use -Bstatic -- if you do not, 24frozen configuration files fail in bizarre ways and you will open up 25several security holes. 26 27If you are compiling on OSF/1 (DEC Alpha), you must use -lmld. 28 29If you use both -DNDBM and -DNEWDB, you must delete the module ndbm.o 30from libdb.a and delete the file "ndbm.h" from the files that get 31installed (that is, use the OLD ndbm.h, not the new ndbm.h). This 32compatibility module maps ndbm calls into DB calls, and breaks things 33rather badly. 34 35You probably want to look over the compilation options in conf.h 36before you compile. These are intended to be per-site information. 37 38The following list describes the files in this directory: 39 40Makefile The makefile used here; this version only works with 41 the new Berkeley make. 42Makefile.dist A trimmed down version of the makefile that works with 43 the old make. 44READ_ME This file. 45TODO New features to be put in (maybe) at some time. 46Version.c The version number and information about this 47 version of sendmail. Theoretically, this gets 48 modified on every change. 49alias.c Does name aliasing in all forms. 50arpadate.c A subroutine which creates ARPANET standard dates. 51clock.c Routines to implement real-time oriented functions 52 in sendmail -- e.g., timeouts. 53collect.c The routine that actually reads the mail into a temp 54 file. It also does a certain amount of parsing of 55 the header, etc. 56conf.c The configuration file. This contains information 57 that is presumed to be quite static and non- 58 controversial, or code compiled in for efficiency 59 reasons. Most of the configuration is in sendmail.cf. 60conf.h Configuration that must be known everywhere. 61convtime.c A routine to sanely process times. 62daemon.c Routines to implement daemon mode. This version is 63 specifically for Berkeley 4.1 IPC. 64deliver.c Routines to deliver mail. 65err.c Routines to print error messages. 66envelope.c Routines to manipulate the envelope structure. 67headers.c Routines to process message headers. 68macro.c The macro expander. This is used internally to 69 insert information from the configuration file. 70main.c The main routine to sendmail. This file also 71 contains some miscellaneous routines. 72parseaddr.c The routines which do address parsing. 73queue.c Routines to implement message queueing. 74readcf.c The routine that reads the configuration file and 75 translates it to internal form. 76recipient.c Routines that manipulate the recipient list. 77savemail.c Routines which save the letter on processing errors. 78sendmail.h Main header file for sendmail. 79srvrsmtp.c Routines to implement server SMTP. 80stab.c Routines to manage the symbol table. 81stats.c Routines to collect and post the statistics. 82sysexits.c List of error messages associated with error codes 83 in sysexits.h. 84trace.c The trace package. These routines allow setting and 85 testing of trace flags with a high granularity. 86trace.h Definitions needed for the trace package. 87usersmtp.c Routines to implement user SMTP. 88util.c Some general purpose routines used by sendmail. 89version.c A master file for Version.c -- it may not exist in 90 your distribution. 91 92Eric Allman 93 94(Version 6.6, last update 05/21/93 07:06:31) 95