xref: /csrg-svn/usr.sbin/sendmail/src/READ_ME (revision 66843)
135062Sbostic# Copyright (c) 1983 Eric P. Allman
248582Sbostic# Copyright (c) 1988 The Regents of the University of California.
333728Sbostic# All rights reserved.
433728Sbostic#
548582Sbostic# %sccs.include.redist.sh%
633728Sbostic#
7*66843Seric#	@(#)READ_ME	8.61 (Berkeley) 04/17/94
833728Sbostic#
948582Sbostic
109881SericThis directory contains the source files for sendmail.
115369Seric
1260565SericFor detailed instructions, please read the document ../doc/op.me:
135369Seric
1460565Seric	eqn ../doc/op.me | pic | ditroff -me
155369Seric
1665366SericThe Makefile is for the new (4.4BSD) Berkeley make and uses syntax
1765366Sericthat is not recognized by older makes.  It also has assumptions
1865366Sericabout the 4.4 file system layout built in.  See below for details
1965366Sericabout other Makefiles.
2057418Seric
2164501SericThere is also a Makefile.dist which is much less clever, but works on
2264501Sericthe old traditional make.  You can use this using:
2364501Seric
2457418Seric	make -f Makefile.dist
2557418Seric
2665366Seric**************************************************
2765366Seric**  Read below for more details of Makefiles.	**
2865366Seric**************************************************
2957943Seric
3064272SericThere is also a shell script (makesendmail) that tries to be clever
3164272Sericabout using object subdirectories.  It's pretty straightforward, and
3264272Sericmay help if you share a source tree among different architectures.
3364035Seric
3465000Seric**************************************************************************
3565000Seric**  IMPORTANT:  DO NOT USE OPTIMIZATION (``-O'') IF YOU ARE RUNNING	**
3665000Seric**  GCC 2.4.x or 2.5.x.  THERE IS A BUG IN THE GCC OPTIMIZER THAT	**
3765000Seric**  CAUSES SENDMAIL COMPILES TO FAIL MISERABLY.				**
3865000Seric**************************************************************************
3964272Seric
4065000SericJim Wilson of Cygnus believes he has found the problem -- it will
4165000Sericprobably be fixed in GCC 2.5.6 -- but until this is verified, be
4265000Sericvery suspicious of gcc -O.
4364701Seric
4465000Seric**************************************************************************
4565000Seric**  IMPORTANT:  Read the appropriate paragraphs in the section on	**
4665000Seric**  ``Operating System and Compile Quirks''.				**
4765000Seric**************************************************************************
4864718Seric
4965000Seric
5065366Seric+-----------+
5165366Seric| MAKEFILES |
5265366Seric+-----------+
5365366Seric
5465366SericThe "Makefile"s in these directories are from 4.4 BSD, and hence
5565366Sericreally only work properly if you are on a 4.4 system.  In particular,
5665366Sericthey use new syntax that will not be recognized on old make programs,
5765366Sericand some of them do things like ``.include ../../Makefile.inc'' to
5865366Sericpick up some system defines.  If you are getting sendmail separately,
5965366Sericthese files won't be included in the distribution, as they are
6065366Sericoutside of the sendmail tree.
6165366Seric
6265366SericInstead, you should use one of the other Makefiles, such as
6365366SericMakefile.SunOS for a SunOS system, and so forth.  These should
6465366Sericwork with the version of make that is appropriate for that
6565366Sericsystem.
6665366Seric
6765366SericThere are a bunch of other Makefiles for other systems with names
6865366Sericlike Makefile.HPUX for an HP-UX system.  They use the version of
6965366Sericmake that is native for that system.  These are the Makefiles that
7065366SericI use, and they have "Berkeley quirks" in them.  I can't guarantee
7165366Sericthat they will work unmodified in your environment.  Many of them
7265366Sericinclude -I/usr/sww/include/db and -L/usr/sww/lib -- this is Berkeley's
7365366Sericlocation (the ``Software Warehouse'') for the new database libraries,
7465366Sericdescribed below.  You don't have to remove these definitions if you
7565366Sericdon't have these directories.
7665366Seric
7765366SericPlease look for an appropriate Makefile before you start trying to
7865366Sericcompile with Makefile or Makefile.dist.
7965366Seric
8065366SericIf you want to port the new Berkeley make, you can get it from
8165366Sericftp.uu.net in the directory /systems/unix/bsd-sources/usr.bin/make.
8265366SericDiffs and instructions for building this version of make under
8365366SericSunOS 4.1.x are available on ftp.css.itd.umich.edu in
8465366Seric/pub/systems/sun/Net2-make.sun4.diff.Z.  Diffs and instructions
8565366Sericfor building this version of make under IBM AIX 3.2.4 are available
8665366Sericon ftp.uni-stuttgart.de in /sw/src/patches/bsd-make-rus-patches.
8765366SericPaul Southworth <pauls@umich.edu> published a description of porting
8865366Sericthis make in comp.unix.bsd.
8965366Seric
9065366SericThe complete text of the Makefile.inc that is in the parent of the
9165366Sericsendmail directory is:
9265366Seric
9365366Seric	#	@(#)Makefile.inc	8.1 (Berkeley) 6/6/93
9465366Seric
9565366Seric	BINDIR?=	/usr/sbin
9665366Seric
9765366Seric
9864250Seric+----------------------+
9964250Seric| DATABASE DEFINITIONS |
10064250Seric+----------------------+
10164250Seric
10264250SericThere are several database formats that can be used for the alias files
10364250Sericand for general maps.  When used for alias files they interact in an
10464250Sericattempt to be back compatible.
10564250Seric
10664250SericThe three options are NEWDB (the new Berkeley DB package), NDBM (the
10764250Sericolder DBM implementation -- the very old V7 implementation is no
10864250Sericlonger supported), and NIS (Network Information Services).  Used alone
10964376Sericthese just include the support they indicate.  [If you are using NEWDB,
11064376Sericget the latest version from FTP.CS.Berkeley.EDU in /ucb/4bsd.  DO NOT
11165000Sericuse the version from the Net2 distribution!  However, if you are on
11265000SericBSD/386 or 386BSD-based systems, use the one that already exists
113*66843Sericon your system.  You may need to #define OLD_NEWDB 1 to do this.]
11464250Seric
11565910Seric[NOTE WELL: it is CRITICAL that you remove ndbm.o from libdb.a and
11665910Sericndbm.h from the appropriate include directories if you want to get
11765910Sericndbm support.  These files OVERRIDE calls to ndbm routines -- in
11865910Sericparticular, if you leave ndbm.h in, you can find yourself using
11965910Sericthe new db package even if you don't define NEWDB.]
12065910Seric
12164250SericIf NEWDB and NDBM are defined (but not NIS), then sendmail will read
12264250SericNDBM format alias files, but the next time a newaliases is run the
12364250Sericformat will be converted to NEWDB; that format will be used forever
12464250Sericmore.  This is intended as a transition feature.  [Note however that
12564250Sericthe NEWDB library also catches and maps NDBM calls; you will have to
12664250Sericback out this feature to get this to work.  See ``Quirks'' section
12764250Sericbelow for details.]
12864250Seric
12964250SericIf all three are defined, sendmail operates as described above, and also
13064250Sericlooks for the file /var/yp/Makefile.  If it exists, newaliases will
13164250Sericbuild BOTH the NEWDB and NDBM format alias files.  However, it will
13264250Sericonly use the NEWDB file; the NDBM format file is used only by the
13364250SericNIS subsystem.
13464250Seric
13564250SericIf NDBM and NIS are defined (regardless of the definition of NEWDB
13664250Sericor the existance of /var/yp/Makefile), sendmail adds the special
13764250Serictokens "YP_LAST_MODIFIED" and "YP_MASTER_NAME", both of which are
13864250Sericrequired if the NDBM file is to be used as an NIS map.
13964250Seric
14064250SericAll of -DNEWDB, -DNDBM, and -DNIS are normally defined in the DBMDEF
14164250Sericline in the Makefile.
14264250Seric
14364250Seric
14464035Seric+---------------+
14564035Seric| COMPILE FLAGS |
14664035Seric+---------------+
14764035Seric
14860565SericWhereever possible, I try to make sendmail pull in the correct
14960584Sericcompilation options needed to compile on various environments based on
15060584Sericautomatically defined symbols.  Some machines don't seem to have useful
15160584Sericsymbols availble, requiring the following compilation flags in the
15260584SericMakefile:
15360565Seric
15460565SericSOLARIS		Define this if you are running Solaris 2.0 or higher.
15565000SericSOLARIS_2_3	Define this if you are running Solaris 2.3 or higher.
15665108SericSUNOS403	Define this if you are running SunOS 4.0.3.
15764077SericNeXT		Define this if you are on a NeXT box.  (This one may
15864072Seric		be pre-defined for you.)  There are other hacks you
15964072Seric		have to make -- see below.
16060565Seric_AIX3		Define this if you are IBM AIX 3.x.
16163965SericRISCOS		Define this if you are running RISC/os from MIPS.
16266335SericIRIX		Define this if you are running IRIX from SGI.
16364501Seric_SCO_unix_	Define this if you are on SCO UNIX.
16465095Seric_SCO_unix_4_2	Define this if you are on SCO Open Server 3.2v4.
16560565Seric
16660584SericIf you are a system that sendmail has already been ported to, you
16760584Sericprobably won't have to touch these.  But if you are porting, you may
16863962Serichave to tweak the following compilation flags in conf.h in order to
16963962Sericget it to compile and link properly:
17060565Seric
17165195SericSYSTEM5		Adjust for System V (not necessarily Release 4).
17264035SericSYS5SIGNALS	Use System V signal semantics -- the signal handler
17364035Seric		is automatically dropped when the signal is caught.
17464035Seric		If this is not set, use POSIX/BSD semantics, where the
17564035Seric		signal handler stays in force until an exec or an
17664035Seric		explicit delete.  Implied by SYSTEM5.
17764706SericSYS5SETPGRP	Use System V setpgrp() semantics.  Implied by SYSTEM5.
17864035SericHASFLOCK	Set this if you prefer to use the flock(2) system call
17964035Seric		rather than using fcntl-based locking.  Fcntl locking
18064035Seric		has some semantic gotchas, but many vendor systems
18164035Seric		also interface it to lockd(8) to do NFS-style locking.
18264035Seric		For this reason, this should not be set unless you
18364035Seric		don't have an alternative.
18460565SericHASUNAME	Set if you have the "uname" system call.  Implied by
18560565Seric		SYSTEM5.
18663962SericHASUNSETENV	Define this if your system library has the "unsetenv"
18763962Seric		subroutine.
18860565SericHASSETSID	Define this if you have the setsid(2) system call.  This
18960565Seric		is implied if your system appears to be POSIX compliant.
19060565SericHASINITGROUPS	Define this if you have the initgroups(3) routine.
19163753SericHASSETVBUF	Define this if you have the setvbuf(3) library call.
19263753Seric		If you don't, setlinebuf will be used instead.  This
19363753Seric		defaults on if your compiler defines __STDC__.
19463902SericHASSETREUID	Define this if you have setreuid(2) ***AND*** root can
19563902Seric		use setreuid to change to an arbitrary user.  This second
19663902Seric		condition is not satisfied on AIX 3.x.  You may find that
19763902Seric		your system has setresuid(2), (for example, on HP-UX) in
19863902Seric		which case you will also have to #define setreuid(r, e)
19963902Seric		to be the appropriate call.  Some systems (such as Solaris)
20065000Seric		have a compatibility routine that doesn't work properly,
20165000Seric		but may have "saved user ids" properly implemented so you
20265000Seric		can ``#define setreuid(r, e) seteuid(e)'' and have it work.
20363902Seric		The important thing is that you have a call that will set
20465000Seric		the effective uid independently of the real or saved uid
20565000Seric		and be able to set the effective uid back again when done.
20665000Seric		There's a test program in ../test/t_setreuid.c that will
20765000Seric		try things on your system.  Setting this improves the
20865000Seric		security, since sendmail doesn't have to read .forward
20965000Seric		and :include: files as root.  There are certain attacks
21065000Seric		that may be unpreventable without this call.
21165000SericHASLSTAT	Define this if you have symbolic links (and thus the
21265000Seric		lstat(2) system call).  This improves security.  Unlike
21365000Seric		most other options, this one is on by default, so you
21465000Seric		need to #undef it in conf.h if you don't have symbolic
21565000Seric		links (these days everyone does).
21665206SericNEEDGETOPT	Define this if you need a reimplementation of getopt(3).
21765206Seric		On some systems, getopt does very odd things if called
21865206Seric		to scan the arguments twice.  This flag will ask sendmail
21965206Seric		to compile in a local version of getopt that works
22065206Seric		properly.
22165206SericNEEDSTRTOL	Define this if your standard C library does not define
22265206Seric		strtol(3).  This will compile in a local version.
22365206SericNEEDVPRINTF	Define this if your standard C library does not define
22465206Seric		vprintf(3).  Note that the resulting fake implementation
22565206Seric		is not very elegant and may not even work on some
22665206Seric		architectures.
22766792SericNEEDFSYNC	Define this if your standard C library does not define
22866792Seric		fsync(2).  This will try to simulate the operation using
22966792Seric		fcntl(2); if that is not available it does nothing, which
23066792Seric		isn't great, but at least it compiles and runs.
23165211SericHASGETUSERSHELL	Define this to 1 if you have getusershell(3) in your
23265211Seric		standard C library.  If this is not defined, or is defined
23365211Seric		to be 0, sendmail will scan the /etc/shells file (no
23465211Seric		NIS-style support, defaults to /bin/sh and /bin/csh if
23565211Seric		that file does not exist) to get a list of unrestricted
23665211Seric		user shells.  This is used to determine whether users
23765211Seric		are allowed to forward their mail to a program or a file.
23863937SericGIDSET_T	The type of entries in a gidset passed as the second
23963937Seric		argument to getgroups(2).  Historically this has been an
24063937Seric		int, so this is the default, but some systems (such as
24163937Seric		IRIX) pass it as a gid_t, which is an unsigned short.
24263937Seric		This will make a difference, so it is important to get
24363937Seric		this right!  However, it is only an issue if you have
24463937Seric		group sets.
24563968SericSLEEP_T		The type returned by the system sleep() function.
24663968Seric		Defaults to "unsigned int".  Don't worry about this
24763968Seric		if you don't have compilation problems.
24863974SericARBPTR_T	The type of an arbitrary pointer -- defaults to "void *".
24963974Seric		If you are an very old compiler you may need to define
25063974Seric		this to be "char *".
25160584SericLA_TYPE		The type of load average your kernel supports.  These
25266301Seric		can be one of:
25366301Seric		LA_ZERO (1) -- it always returns the load average as
25466301Seric			"zero" (and does so on all architectures).
25566301Seric		LA_SUBR (4) if you have the getloadavg(3) routine,
25664376Seric		LA_MACH (5) to use MACH-style load averages (calls
25766301Seric			processor_set_info()),
25866301Seric		LA_PROCSTR (7) to read /proc/loadavg and interpret it
25966301Seric			as a string representing a floating-point
26066301Seric			number (Linux-style),
26166301Seric		LA_FLOAT (3) if you read kmem and interpret the value
26266301Seric			as a floating point number,
26366301Seric		LA_INT (2) to interpret as a long integer,
26466301Seric		LA_SHORT (6) to interpret as a short integer.
26566301Seric		These last three have several other parameters that they
26666301Seric		try to divine: the name of your kernel, the name of the
26766301Seric		variable in the kernel to examine, the number of bits of
26866301Seric		precision in a fixed point load average, and so forth.
26966301Seric		In desperation, use LA_ZERO.  The actual code is in
27066301Seric		conf.c -- it can be tweaked if you are brave.
27165752SericSFS_TYPE	Encodes how your kernel can locate the amount of free
27265752Seric		space on a disk partition.  This can be set to SFS_NONE
27365752Seric		(0) if you have no way of getting this information,
27465752Seric		SFS_USTAT (1) if you have the ustat(2) system call,
27565752Seric		SFS_4ARGS (2) if you have a four-argument statfs(2)
27665752Seric		system call (and the include file is <sys/statfs.h>),
27766755Seric		and SFS_VFS (3), SFS_MOUNT (4), SFS_STATFS (5) or
27866755Seric		SFS_STATVFS (6) if you have the two-argument statfs(2)
27966755Seric		system call, with includes in <sys/vfs.h>, <sys/mount.h>,
28066755Seric		<sys/statfs.h>, or <sys/statvfs.h> respectively.  The
28166755Seric		default if nothing is defined is SFS_NONE.
28263962SericERRLIST_PREDEFINED
28363962Seric		If set, assumes that some header file defines sys_errlist.
28463962Seric		This may be needed if you get type conflicts on this
28563962Seric		variable -- otherwise don't worry about it.
28664562SericWAITUNION	The wait(2) routine takes a "union wait" argument instead
28764562Seric		of an integer argument.  This is for compatibility with
28864562Seric		old versions of BSD.
28965000SericSCANF		You can set this to extend the F command to accept a
29065000Seric		scanf string -- this gives you a primitive parser for
29165000Seric		class definitions -- BUT it can make you vulnerable to
29265000Seric		core dumps if the target file is poorly formed.
29365095SericSYSLOG_BUFSIZE	You can define this to be the size of the buffer that
29465095Seric		syslog accepts.  If it is not defined, it assumes a
29565095Seric		1024-byte buffer.  If the buffer is very small (under
29665095Seric		256 bytes) the log message format changes -- each
29765095Seric		e-mail message will log many more messages, since it
29865095Seric		will log each piece of information as a separate line
29965095Seric		in syslog.
30066318SericBROKEN_RES_SEARCH
30166318Seric		On Ultrix (and maybe other systems?) if you use the
30266318Seric		res_search routine with an unknown host name, it returns
30366318Seric		-1 but sets h_errno to 0 instead of HOST_NOT_FOUND.  If
30466318Seric		you set this, sendmail considers 0 to be the same as
30566318Seric		HOST_NOT_FOUND.
30660565Seric
30764035Seric
30864035Seric+-----------------------+
30964035Seric| COMPILE-TIME FEATURES |
31064035Seric+-----------------------+
31164035Seric
31260584SericThere are a bunch of features that you can decide to compile in, such
31360584Sericas selecting various database packages and special protocol support.
31460584SericSeveral are assumed based on other compilation flags -- if you want to
31560584Seric"un-assume" something, you probably need to edit conf.h.  Compilation
31660584Sericflags that add support for special features include:
31760565Seric
31860565SericNDBM		Include support for "new" DBM library for aliases and maps.
31964250Seric		Normally defined in the Makefile.
32060565SericNEWDB		Include support for Berkeley "db" package (hash & btree)
32164250Seric		for aliases and maps.  Normally defined in the Makefile.
322*66843SericOLD_NEWDB	If non-zero, the version of NEWDB you have is the old
323*66843Seric		one that does not include the "fd" call.  This call was
324*66843Seric		added in version 1.5 of the Berkeley DB code.  If you
325*66843Seric		use -DOLD_NEWDB=0 it forces you to use the new interface.
32660565SericNIS		Define this to get NIS (YP) support for aliases and maps.
32764250Seric		Normally defined in the Makefile.
32860565SericUSERDB		Include support for the User Information Database.  Implied
32964250Seric		by NEWDB in conf.h.
33065000SericIDENTPROTO	Define this as 1 to get IDENT (RFC 1413) protocol support.
33160565Seric		This is assumed unless you are running on Ultrix or
33260565Seric		HP-UX, both of which have a problem in the UDP
33365000Seric		implementation.  You can define it to be 0 to explicitly
33465000Seric		turn off IDENT protocol support.
33560565SericMIME		Include support for MIME-encapsulated error messages.
33660565SericLOG		Set this to get syslog(3) support.  Defined by default
33760584Seric		in conf.h.  You want this if at all possible.
33860565SericNETINET		Set this to get TCP/IP support.  Defined by default
33960584Seric		in conf.h.  You probably want this.
34060565SericNETISO		Define this to get ISO networking support.
34160565SericSMTP		Define this to get the SMTP code.  Implied by NETINET
34260565Seric		or NETISO.
34360565SericNAMED_BIND	Define this to get DNS (name daemon) support, including
34460565Seric		MX support.  The specs you must use this if you run
34560565Seric		SMTP.  Defined by default in conf.h.
34660565SericQUEUE		Define this to get queueing code.  Implied by NETINET
34760584Seric		or NETISO; required by SMTP.  This gives you other good
34860584Seric		stuff -- it should be on.
34960565SericDAEMON		Define this to get general network support.  Implied by
35060584Seric		NETINET or NETISO.  Defined by default in conf.h.  You
35160584Seric		almost certainly want it on.
35260565SericMATCHGECOS	Permit fuzzy matching of user names against the full
35360565Seric		name (GECOS) field in the /etc/passwd file.  This should
35460565Seric		probably be on, since you can disable it from the config
35560584Seric		file if you want to.  Defined by default in conf.h.
35660565SericSETPROCTITLE	Try to set the string printed by "ps" to something
35760584Seric		informative about what sendmail is doing.  Defined by
35860584Seric		default in conf.h.
35960565Seric
36064035Seric
36165000Seric+---------------------+
36265000Seric| DNS/RESOLVER ISSUES |
36365000Seric+---------------------+
36465000Seric
36565000SericMany systems have old versions of the resolver library.  At a minimum,
36665000Sericyou should be running BIND 4.8.3; older versions may compile, but they
36765000Serichave known bugs that should give you pause.
36865000Seric
36965000SericCommon problems in old versions include "undefined" errors for
37065000Sericdn_skipname.
37165000Seric
37265000SericSome people have had a problem with BIND 4.9; it uses some routines
37365000Sericthat it expects to be externally defined such as strerror().  It may
37465000Serichelp to link with "-l44bsd" to solve this problem.
37565000Seric
37665095Seric!PLEASE! be sure to link with the same version of the resolver as
37765095Sericthe header files you used -- some people have used the 4.9 headers
37865095Sericand linked with BIND 4.8 or vice versa, and it doesn't work.
37965095SericUnfortunately, it doesn't fail in an obvious way -- things just
38065954Sericsubtly don't work.
38165000Seric
38265095Seric
38364035Seric+-------------------------------------+
38464035Seric| OPERATING SYSTEM AND COMPILE QUIRKS |
38564035Seric+-------------------------------------+
38664035Seric
38765095SericGCC 2.5.x problems  *** IMPORTANT ***
38865095Seric	Date: Mon, 29 Nov 93 19:08:44 PST
38965095Seric	From: wilson@cygnus.com (Jim Wilson)
39065095Seric	Message-Id: <9311300308.AA04608@cygnus.com>
39165095Seric	To: kenner@vlsi1.ultra.nyu.edu
39265095Seric	Subject: [cattelan@thebarn.com: gcc 2.5.4-2.5.5 -O bug]
39365095Seric	Cc: cattelan@thebarn.com, rms@gnu.ai.mit.edu, sendmail@cs.berkeley.edu
39465095Seric
39565095Seric	This fixes a problem that occurs when gcc 2.5.5 is used to compile
39665095Seric	sendmail 8.6.4 with optimization on a sparc.
39765095Seric
39865095Seric	Mon Nov 29 19:00:14 1993  Jim Wilson  (wilson@sphagnum.cygnus.com)
39965095Seric
40065095Seric		* reload.c (find_reloads_toplev): Replace obsolete reference to
40165095Seric		BYTE_LOADS_*_EXTEND with LOAD_EXTEND_OP.
40265095Seric
40365095Seric	*** clean-ss-931128/reload.c    Sun Nov 14 16:20:01 1993
40465095Seric	--- ss-931128/reload.c  Mon Nov 29 18:52:55 1993
40565095Seric	*************** find_reloads_toplev (x, opnum, type, ind
40665095Seric	*** 3888,3894 ****
40765095Seric		 force a reload in that case.  So we should not do anything here.  */
40865095Seric
40965095Seric		else if (regno >= FIRST_PSEUDO_REGISTER
41065095Seric	! #if defined(BYTE_LOADS_ZERO_EXTEND) || defined(BYTE_LOADS_SIGN_EXTEND)
41165095Seric		       && (GET_MODE_SIZE (GET_MODE (x))
41265095Seric			   <= GET_MODE_SIZE (GET_MODE (SUBREG_REG (x))))
41365095Seric	  #endif
41465095Seric	--- 3888,3894 ----
41565095Seric		 force a reload in that case.  So we should not do anything here.  */
41665095Seric
41765095Seric		else if (regno >= FIRST_PSEUDO_REGISTER
41865095Seric	! #ifdef LOAD_EXTEND_OP
41965095Seric		       && (GET_MODE_SIZE (GET_MODE (x))
42065095Seric			   <= GET_MODE_SIZE (GET_MODE (SUBREG_REG (x))))
42165095Seric	  #endif
42265095Seric
42365095Seric
42464376SericSunOS 4.x (Solaris 1.x)
42564376Seric	You may have to use -lresolv on SunOS.  However, beware that
42664376Seric	this links in a new version of gethostbyname that does not
42764376Seric	understand NIS, so you must have all of your hosts in DNS.
42864035Seric
42964798Seric	Some people have reported problems with the SunOS version of
43064798Seric	-lresolv and/or in.named, and suggest that you get a newer
43164798Seric	version.  The symptoms are delays when you connect to the
43265000Seric	SMTP server on a SunOS machine or having your domain added to
43365000Seric	addresses inappropriately.  There is a version of BIND
43464798Seric	version 4.9 on gatekeeper.DEC.COM in pub/BSD/bind/4.9.
43564798Seric
43664400Seric	There is substantial disagreement about whether you can make
43764400Seric	this work with resolv+, which allows you to specify a search-path
43864400Seric	of services.  Some people report that it works fine, others
43964400Seric	claim it doesn't work at all (including causing sendmail to
44064400Seric	drop core when it tries to do multiple resolv+ lookups for a
44164400Seric	single job).  I haven't tried resolv+, as we use DNS exclusively.
44264400Seric
44364400Seric	Should you want to try resolv+, it is on ftp.uu.net in
44464400Seric	/networking/ip/dns.
44564400Seric
44664376SericSolaris 2.x (SunOS 5.x)
44764376Seric	To compile for Solaris, be sure you use -DSOLARIS.
44864376Seric
44966329Seric	To the best of my knowledge, Solaris does not have the
45066329Seric	gethostbyname problem described above.  However, it does
45166329Seric	have another one:
45266329Seric
45364364Seric	From a correspondent:
45464364Seric
45564364Seric	   For solaris 2.2, I have
45664364Seric
45764364Seric		hosts:      files dns
45864364Seric
45964364Seric	   in /etc/nsswitch.conf and /etc/hosts has to have the fully
46064364Seric	   qualified host name. I think "files" has to be before "dns"
46164364Seric	   in /etc/nsswitch.conf during bootup.
46264364Seric
46366329Seric	From another correspondent:
46464376Seric
46566329Seric	   When running sendmail under Solaris, the gethostbyname()
46666329Seric	   hack in conf.c which should perform proper canonicalization
46766329Seric	   of host names could fail.  Result: the host name is not
46866329Seric	   canonicalized despite the hack, and you'll have to define $j
46966329Seric	   and $m in sendmail.cf somewhere.
47066329Seric
47166329Seric	   The reason could be that /etc/nsswitch.conf is improperly
47266329Seric	   configured (at least from sendmail's point of view).  For
47366329Seric	   example, the line
47466329Seric
47566329Seric		hosts:      files nisplus dns
47666329Seric
47766329Seric	   will make gethostbyname() look in /etc/hosts first, then ask
47866329Seric	   nisplus, then dns.  However, if /etc/hosts does not contain
47966329Seric	   the full canonicalized hostname, then no amount of
48066329Seric	   gethostbyname()s will work.
48166329Seric
48266329Seric	   Solution (or rather, a workaround): Ask nisplus first, then
48366329Seric	   dns, then local files:
48466329Seric
48566329Seric		hosts:      nisplus dns [NOTFOUND=return] files
48666329Seric
48764385Seric	The Solaris "syslog" function is apparently limited to something
48864385Seric	about 90 characters because of a kernel limitation.  If you have
48966023Seric	source code, you can probably up this number.  You can get patches
49066023Seric	that fix this problem: the patch ids are:
49164385Seric
49266023Seric		Solaris 2.1	100834
49366023Seric		Solaris 2.2	100999
49466024Seric		Solaris 2.3	101318
49566023Seric
49666023Seric	Be sure you have the appropriate patch installed or you won't
49766023Seric	see system logging.
49866023Seric
49964250SericOSF/1
50065000Seric	If you are compiling on OSF/1 (DEC Alpha), you must use
50165616Seric	-L/usr/shlib (otherwise it core dumps on startup).  You may also
50265000Seric	need -mld to get the nlist() function, although some versions
50365000Seric	apparently don't need this.
50465000Seric
50565000Seric	Also, the enclosed makefile removed /usr/sbin/smtpd; if you need
50665000Seric	it, just create the link to the sendmail binary.
50757977Seric
50866335SericIRIX
50966335Seric	The header files on SGI IRIX are completely prototyped, and as
51066335Seric	a result you can sometimes get some warning messages during
51166335Seric	compilation.  These can be ignored.  There are two errors in
51266335Seric	deliver only if you are using gcc, both of the form ``warning:
51366335Seric	passing arg N of `execve' from incompatible pointer type''.
51466335Seric	Also, if you compile with -DNIS, you will get a complaint
51566335Seric	about a declaration of struct dom_binding in a prototype
51666335Seric	when compiling map.c; this is not important because the
51766335Seric	function being prototyped is not used in that file.
51866335Seric
51964250SericNeXT
52064250Seric	If you are compiling on NeXT, you will have to create an empty
52164250Seric	file "unistd.h" and create a file "dirent.h" containing:
52263753Seric
52364250Seric		#include <sys/dir.h>
52464250Seric		#define dirent	direct
52564035Seric
52664250Seric	(The Makefile.NeXT should try to do both of these for you.)
52764077Seric
52864364Seric	Apparently, there is a bug in getservbyname on Nextstep 3.0
52964364Seric	that causes it to fail under some circumstances with the
53064364Seric	message "SYSERR: service "smtp" unknown" logged.  You should
53164364Seric	be able to work around this by including the line:
53264364Seric
53364670Seric		OOPort=25
53464364Seric
53564364Seric	in your .cf file.
53664364Seric
53764376Seric	You may have to use -DNeXT.
53864376Seric
53965000SericBSDI (BSD/386) 1.0, NetBSD 0.9, FreeBSD 1.0
54065000Seric	The "m4" from BSDI won't handle the config files properly.
54165000Seric	I haven't had a chance to test this myself.
54257943Seric
54365000Seric	The M4 shipped in FreeBSD and NetBSD 0.9 don't handle the config
54465000Seric	files properly. One must use either GNU m4 1.1 or the PD-M4
54565000Seric	recently posted in comp.os.386bsd.bugs (and maybe others).
54665000Seric	NetBSD-current includes the PD-M4 (as stated in the NetBSD file
54765000Seric	CHANGES).
54865000Seric
54965000Seric	FreeBSD 1.0 RELEASE has uname(2) now. Use -DUSEUNAME in order to
55065000Seric	use it (look into Makefile.FreeBSD). NetBSD-current may have
55165000Seric	it too but it has not been verified.
55265000Seric
55365000Seric	You cannot port the latest version of the Berkeley db library
55465000Seric	and use it with sendmail without recompiling the world.  This
55565000Seric	is because C library routines use the older version which have
55665000Seric	incompatible header files -- the result is that it can't read
55765000Seric	other system files, such as /etc/passwd, unless you use the
55865000Seric	new db format throughout your system.  You should normally just
55965000Seric	use the version of db supplied in your release.  You may need
560*66843Seric	to use -DOLD_NEWDB=1 to make this work -- this turns off some
56165000Seric	new interface calls (for file locking) that are not in older
56265000Seric	versions of db.  You'll get compile errors if you need this
56365000Seric	flag and don't have it set.
56465000Seric
56564364Seric4.3BSD
56664364Seric	If you are running a "virgin" version of 4.3BSD, you'll have
56764364Seric	a very old resolver and be missing some header files.  The
56864364Seric	header files are simple -- create empty versions and everything
56964364Seric	will work fine.  For the resolver you should really port a new
57064364Seric	version (4.8.3 or later) of the resolver; 4.9 is available on
57164364Seric	gatekeeper.DEC.COM in pub/BSD/bind/4.9.  If you are really
57264364Seric	determined to continue to use your old, buggy version (or as
57364364Seric	a shortcut to get sendmail working -- I'm sure you have the
57464364Seric	best intentions to port a modern version of BIND), you can
57564364Seric	copy ../contrib/oldbind.compat.c into src and add
57664364Seric	oldbind.compat.o to OBJADD in the Makefile.
57764364Seric
57864718SericA/UX
57964718Seric	Date: Tue, 12 Oct 1993 18:28:28 -0400 (EDT)
58064718Seric	From: "Eric C. Hagberg" <hagberg@med.cornell.edu>
58164718Seric	Subject: Fix for A/UX ndbm
58264718Seric
58364718Seric	I guess this isn't really a sendmail bug, however, it is something
58464718Seric	that A/UX users should be aware of when compiling sendmail 8.6.
58564718Seric
58664718Seric	Apparently, the calls that sendmail is using to the ndbm routines
58764718Seric	in A/UX 3.0.x contain calls to "broken" routines, in that the
58864718Seric	aliases database will break when it gets "just a little big"
58964718Seric	(sorry I don't have exact numbers here, but it broke somewhere
59064718Seric	around 20-25 aliases for me.), making all aliases non-functional
59164718Seric	after exceeding this point.
59264718Seric
59364718Seric	What I did was to get the gnu-dbm-1.6 package, compile it, and
59464718Seric	then re-compile sendmail with "-lgdbm", "-DNDBM", and using the
59564718Seric	ndbm.h header file that comes with the gnu-package. This makes
59664718Seric	things behave properly.
59764718Seric
59864718Seric	I suppose porting the New Berkeley db package is another route,
59964718Seric	however, I made a quick attempt at it, and found it difficult
60064718Seric	(not easy at least); the gnu-dbm package "configured" and
60164718Seric	compiled easily.
60264718Seric
60364718SericDG/UX
60464718Seric	Apparently, /bin/mail doesn't work properly for delivery on
60564718Seric	DG/UX -- the person who has this working, Douglas Anderson
60664718Seric	<dlander@afterlife.ncsc.mil>, used procmail instead.
60764718Seric
60865820SericApollo DomainOS
60965820Seric	If you are compiling on Apollo, you will have to create an empty
61065820Seric	file "unistd.h" and create a file "dirent.h" containing:
61165820Seric
61265820Seric		#include <sys/dir.h>
61365820Seric		#define dirent	direct
61465820Seric
61565820Seric	(The Makefile.DomainOS will attempt to do both of these for you.)
61665820Seric
61765910SericHP-UX 8.00
61865910Seric	Date: Mon, 24 Jan 1994 13:25:45 +0200
61965910Seric	From: Kimmo Suominen <Kimmo.Suominen@lut.fi>
62065910Seric	Subject: 8.6.5 w/ HP-UX 8.00 on s300
62165910Seric
62265910Seric	Just compiled and fought with sendmail 8.6.5 on a HP9000/360 (ie. a
62365910Seric	series 300 machine) running HP-UX 8.00.
62465910Seric
62565910Seric	I was getting segmentation fault when delivering to a local user.
62665910Seric	With debugging I saw it was faulting when doing _free@libc... *sigh*
62765910Seric	It seems the new implementation of malloc on s300 is buggy as of 8.0,
62865910Seric	so I tried out the one in -lmalloc (malloc(3X)).  With that it seems
62965910Seric	to work just dandy.
63065910Seric
63165910Seric	When linking, you will get the following error:
63265910Seric
63365910Seric	ld: multiply defined symbol _freespace in file /usr/lib/libmalloc.a
63465910Seric
63565910Seric	but you can just ignore it.  You might want to add this info to the
63665910Seric	README file for the future...
63765910Seric
63865910SericLinux
63965910Seric	Something broke between versions 0.99.13 and 0.99.14 of Linux:
64065910Seric	the flock() system call gives errors.  If you are running .14,
64165910Seric	you must not use flock.  You can do this with -DHASFLOCK=0.
64265910Seric
64365910SericAIX
64465910Seric	This version of sendmail does not support MB, MG, and MR resource
64565910Seric	records, which are supported by AIX sendmail.
64665910Seric
64766335SericRISC/os
64866335Seric	RISC/os from MIPS is a merged AT&T/Berkeley system.  When you
64966335Seric	compile on that platform you will get duplicate definitions
65066335Seric	on many files.  You can ignore these.
65166335Seric
65265195SericSystem V Release 4 Based Systems
65365195Seric	There is a single Makefile that is intended for all SVR4-based
65465195Seric	systems (called Makefile.SVR4).  It defines __svr4__, which is
65565195Seric	predefined by some compilers.  If your compiler already defines
65665195Seric	this compile variable, you can delete the definition from the
65765195Seric	Makefile.
65865195Seric
65965195Seric	It's been tested on Dell Issue 2.2.
66065195Seric
66165095SericDELL SVR4
66265095Seric	Date:      Mon, 06 Dec 1993 10:42:29 EST
66365095Seric	From: "Kimmo Suominen" <kim@grendel.lut.fi>
66465095Seric	Message-ID: <2d0352f9.lento29@lento29.UUCP>
66565095Seric	To: eric@cs.berkeley.edu
66665166Seric	Cc: sendmail@cs.berkeley.edu
66765095Seric	Subject:   Notes for DELL SVR4
66865095Seric
66965095Seric	Eric,
67065095Seric
67165095Seric	Here are some notes for compiling Sendmail 8.6.4 on DELL SVR4.  I ran
67265095Seric	across these things when helping out some people who contacted me by
67365095Seric	e-mail.
67465095Seric
67565095Seric	1) Use gcc 2.4.5 (or later?).  Dell distributes gcc 2.1 with their
67665095Seric	   Issue 2.2 Unix.  It is too old, and gives you problems with
67765095Seric	   clock.c, because sigset_t won't get defined in <sys/signal.h>.
67865095Seric	   This is due to a problematic protection rule in there, and is
67965095Seric	   fixed with gcc 2.4.5.
68065095Seric
68165095Seric	2) If you don't use the new Berkeley DB (-DNEWDB), then you need
68265095Seric	   to add "-lc -lucb" to the libraries to link with.  This is because
68365095Seric	   the -ldbm distributed by Dell needs the bcopy, bcmp and bzero
68465095Seric	   functions.  It is important that you specify both libraries in
68565095Seric	   the given order to be sure you only get the BSTRING functions
68665095Seric	   from the UCB library (and not the signal routines etc.).
68765095Seric
68865095Seric	3) Don't leave out "-lelf" even if compiling with "-lc -lucb".
68965095Seric	   The UCB library also has another copy of the nlist routines,
69065095Seric	   but we do want the ones from "-lelf".
69165095Seric
69265095Seric	If anyone needs a compiled gcc 2.4.5 and/or a ported DB library, they
69365095Seric	can use anonymous ftp to fetch them from lut.fi in the /kim directory.
69465095Seric	They are copies of what I use on grendel.lut.fi, and offering them
69565095Seric	does not imply that I would also support them.  I have sent the DB
69665095Seric	port for SVR4 back to Keith Bostic for inclusion in the official
69765095Seric	distribution, but I haven't heard anything from him as of today.
69865095Seric
69965095Seric	- gcc-2.4.5-svr4.tar.gz	(gcc 2.4.5 and the corresponding libg++)
70065095Seric	- db-1.72.tar.gz	(with source, objects and a installed copy)
70165095Seric
70265095Seric	Cheers
70365095Seric	+ Kim
70465095Seric	--
70565095Seric	 *  Kimmo.Suominen@lut.fi  *  SysVr4 enthusiast at GRENDEL.LUT.FI  *
70665095Seric	*    KIM@FINFILES.BITNET   *  Postmaster and Hostmaster at LUT.FI   *
70765095Seric	 *    + 358 200 865 718    *  Unix area moderator at NIC.FUNET.FI  *
70865095Seric
70965095Seric
71064718SericNon-DNS based sites
71164718Seric	This version of sendmail always tries to connect to the Domain
71264718Seric	Name System (DNS) to resolve names, regardless of the setting
71364718Seric	of the `I' option.  On most systems that are not running DNS,
71464718Seric	this will fail quickly and sendmail will continue, but on some
71564718Seric	systems it has a long timeout.  If you have this problem, you
71664718Seric	will have to recompile without NAMED_BIND.  Some people have
71764718Seric	claimed that they have successfully used "OI+USEVC" to force
71864718Seric	sendmail to use a virtual circuit -- this will always time out
71964718Seric	quickly, but also tells sendmail that a failed connection
72064718Seric	should requeue the message (probably not what you intended).
72164718Seric	A future release of sendmail will correct this problem.
72264718Seric
72364250SericBoth NEWDB and NDBM
72464250Seric	If you use both -DNDBM and -DNEWDB, you must delete the module
72564250Seric	ndbm.o from libdb.a and delete the file "ndbm.h" from the files
72664250Seric	that get installed (that is, use the OLD ndbm.h, not the new
72764250Seric	ndbm.h).  This compatibility module maps ndbm calls into DB
72864250Seric	calls, and breaks things rather badly.
72958709Seric
73064559SericGNU getopt
73164559Seric	I'm told that GNU getopt has a problem in that it gets confused
73264559Seric	by the double call.  Use the version in conf.c instead.
73364250Seric
73466350SericBIND 4.9.2 and Ultrix
73566350Seric	If you are running on Ultrix, be sure you read the conf/Info.Ultrix
73666350Seric	carefully -- there is information in there that you need to know
73766350Seric	in order to avoid errors of the form:
73864559Seric
73966350Seric		/lib/libc.a(gethostent.o): sethostent: multiply defined
74066350Seric		/lib/libc.a(gethostent.o): endhostent: multiply defined
74166350Seric		/lib/libc.a(gethostent.o): gethostbyname: multiply defined
74266350Seric		/lib/libc.a(gethostent.o): gethostbyaddr: multiply defined
74366350Seric
74466350Seric	during the link stage.
74566350Seric
74666350Seric
74764820Seric+--------------+
74864820Seric| MANUAL PAGES |
74964820Seric+--------------+
75064820Seric
75164820SericThe manual pages have been written against the -mandoc macros
75264820Sericinstead of the -man macros.  The latest version of groff has them
75364820Sericincluded.  You can also get a copy from FTP.UU.NET in directory
75464820Seric/systems/unix/bsd-sources/share/tmac.
75564820Seric
75664820Seric
75765151Seric+-----------------+
75865151Seric| DEBUGGING HOOKS |
75965151Seric+-----------------+
76065151Seric
76165151SericAs of 8.6.5, sendmail daemons will catch a SIGUSR1 signal and log
76265151Sericsome debugging output (logged at LOG_DEBUG severity).  The
76365151Sericinformation dumped is:
76465151Seric
76565151Seric * The value of the $j macro.
76665151Seric * A warning if $j is not in the set $=w.
76765151Seric * A list of the open file descriptors.
76865151Seric * The contents of the connection cache.
76965151Seric * If ruleset 89 is defined, it is evaluated and the results printed.
77065151Seric
77165151SericThis allows you to get information regarding the runtime state of the
77265151Sericdaemon on the fly.  This should not be done too frequently, since
77365151Sericthe process of rewriting may lose memory which will not be recovered.
77465151SericAlso, ruleset 89 may call non-reentrant routines, so there is a small
77565151Sericnon-zero probability that this will cause other problems.  It is
77665151Sericreally only for debugging serious problems.
77765151Seric
77865151SericA typical formulation of ruleset 89 would be:
77965151Seric
78065151Seric	R$*		$@ $>0 some test address
78165151Seric
78265151Seric
78364035Seric+-----------------------------+
78464035Seric| DESCRIPTION OF SOURCE FILES |
78564035Seric+-----------------------------+
78664035Seric
7879881SericThe following list describes the files in this directory:
7885369Seric
78957418SericMakefile	The makefile used here; this version only works with
79057418Seric		the new Berkeley make.
79157418SericMakefile.dist	A trimmed down version of the makefile that works with
79257418Seric		the old make.
7935369SericREAD_ME		This file.
79460565SericTRACEFLAGS	My own personal list of the trace flags -- not guaranteed
79560565Seric		to be particularly up to date.
7965369Sericalias.c		Does name aliasing in all forms.
7979881Sericarpadate.c	A subroutine which creates ARPANET standard dates.
7989881Sericclock.c		Routines to implement real-time oriented functions
7999881Seric		in sendmail -- e.g., timeouts.
8005369Sericcollect.c	The routine that actually reads the mail into a temp
8015369Seric		file.  It also does a certain amount of parsing of
8025369Seric		the header, etc.
8035369Sericconf.c		The configuration file.  This contains information
8045369Seric		that is presumed to be quite static and non-
8055369Seric		controversial, or code compiled in for efficiency
8065369Seric		reasons.  Most of the configuration is in sendmail.cf.
8079881Sericconf.h		Configuration that must be known everywhere.
8085369Sericconvtime.c	A routine to sanely process times.
8099881Sericdaemon.c	Routines to implement daemon mode.  This version is
8109881Seric		specifically for Berkeley 4.1 IPC.
8115369Sericdeliver.c	Routines to deliver mail.
81260565Sericdomain.c	Routines that interface with DNS (the Domain Name
81360565Seric		System).
8145369Sericerr.c		Routines to print error messages.
8159881Sericenvelope.c	Routines to manipulate the envelope structure.
8165369Sericheaders.c	Routines to process message headers.
8175369Sericmacro.c		The macro expander.  This is used internally to
8185369Seric		insert information from the configuration file.
8195369Sericmain.c		The main routine to sendmail.  This file also
8205369Seric		contains some miscellaneous routines.
82160565Sericmap.c		Support for database maps.
82260565Sericmci.c		Routines that handle mail connection information caching.
8239881Sericparseaddr.c	The routines which do address parsing.
8245369Sericqueue.c		Routines to implement message queueing.
8255369Sericreadcf.c	The routine that reads the configuration file and
8265369Seric		translates it to internal form.
8279881Sericrecipient.c	Routines that manipulate the recipient list.
8285369Sericsavemail.c	Routines which save the letter on processing errors.
8295369Sericsendmail.h	Main header file for sendmail.
8305369Sericsrvrsmtp.c	Routines to implement server SMTP.
8315369Sericstab.c		Routines to manage the symbol table.
8325369Sericstats.c		Routines to collect and post the statistics.
8335369Sericsysexits.c	List of error messages associated with error codes
8345369Seric		in sysexits.h.
8359881Serictrace.c		The trace package.  These routines allow setting and
8369881Seric		testing of trace flags with a high granularity.
83760565Sericudb.c		The user database interface module.
8385369Sericusersmtp.c	Routines to implement user SMTP.
8395369Sericutil.c		Some general purpose routines used by sendmail.
84060565Sericversion.c	The version number and information about this
84160565Seric		version of sendmail.  Theoretically, this gets
84260565Seric		modified on every change.
8435369Seric
8445369SericEric Allman
8455369Seric
846*66843Seric(Version 8.61, last update 04/17/94 07:05:49)
847