xref: /csrg-svn/usr.sbin/sendmail/src/READ_ME (revision 67427)
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*67427Seric#	@(#)READ_ME	8.65 (Berkeley) 06/19/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
11366843Sericon 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.
165*67427SericDGUX		Define this if you are on DG/UX 5.4.3 or later
166*67427SericDGUX_5_4_2	Define this if you are on DG/UX systems prior to 5.4.3.
16760565Seric
16860584SericIf you are a system that sendmail has already been ported to, you
16960584Sericprobably won't have to touch these.  But if you are porting, you may
17063962Serichave to tweak the following compilation flags in conf.h in order to
17163962Sericget it to compile and link properly:
17260565Seric
17365195SericSYSTEM5		Adjust for System V (not necessarily Release 4).
17464035SericSYS5SIGNALS	Use System V signal semantics -- the signal handler
17564035Seric		is automatically dropped when the signal is caught.
17664035Seric		If this is not set, use POSIX/BSD semantics, where the
17764035Seric		signal handler stays in force until an exec or an
17864035Seric		explicit delete.  Implied by SYSTEM5.
17964706SericSYS5SETPGRP	Use System V setpgrp() semantics.  Implied by SYSTEM5.
18064035SericHASFLOCK	Set this if you prefer to use the flock(2) system call
18164035Seric		rather than using fcntl-based locking.  Fcntl locking
18264035Seric		has some semantic gotchas, but many vendor systems
18364035Seric		also interface it to lockd(8) to do NFS-style locking.
18464035Seric		For this reason, this should not be set unless you
18564035Seric		don't have an alternative.
18660565SericHASUNAME	Set if you have the "uname" system call.  Implied by
18760565Seric		SYSTEM5.
18863962SericHASUNSETENV	Define this if your system library has the "unsetenv"
18963962Seric		subroutine.
19060565SericHASSETSID	Define this if you have the setsid(2) system call.  This
19160565Seric		is implied if your system appears to be POSIX compliant.
19260565SericHASINITGROUPS	Define this if you have the initgroups(3) routine.
19363753SericHASSETVBUF	Define this if you have the setvbuf(3) library call.
19463753Seric		If you don't, setlinebuf will be used instead.  This
19563753Seric		defaults on if your compiler defines __STDC__.
19663902SericHASSETREUID	Define this if you have setreuid(2) ***AND*** root can
19763902Seric		use setreuid to change to an arbitrary user.  This second
19863902Seric		condition is not satisfied on AIX 3.x.  You may find that
19963902Seric		your system has setresuid(2), (for example, on HP-UX) in
20063902Seric		which case you will also have to #define setreuid(r, e)
20163902Seric		to be the appropriate call.  Some systems (such as Solaris)
20265000Seric		have a compatibility routine that doesn't work properly,
20365000Seric		but may have "saved user ids" properly implemented so you
20465000Seric		can ``#define setreuid(r, e) seteuid(e)'' and have it work.
20563902Seric		The important thing is that you have a call that will set
20665000Seric		the effective uid independently of the real or saved uid
20765000Seric		and be able to set the effective uid back again when done.
20865000Seric		There's a test program in ../test/t_setreuid.c that will
20965000Seric		try things on your system.  Setting this improves the
21065000Seric		security, since sendmail doesn't have to read .forward
21165000Seric		and :include: files as root.  There are certain attacks
21265000Seric		that may be unpreventable without this call.
21365000SericHASLSTAT	Define this if you have symbolic links (and thus the
21465000Seric		lstat(2) system call).  This improves security.  Unlike
21565000Seric		most other options, this one is on by default, so you
21665000Seric		need to #undef it in conf.h if you don't have symbolic
21765000Seric		links (these days everyone does).
21865206SericNEEDGETOPT	Define this if you need a reimplementation of getopt(3).
21965206Seric		On some systems, getopt does very odd things if called
22065206Seric		to scan the arguments twice.  This flag will ask sendmail
22165206Seric		to compile in a local version of getopt that works
22265206Seric		properly.
22365206SericNEEDSTRTOL	Define this if your standard C library does not define
22465206Seric		strtol(3).  This will compile in a local version.
22565206SericNEEDVPRINTF	Define this if your standard C library does not define
22665206Seric		vprintf(3).  Note that the resulting fake implementation
22765206Seric		is not very elegant and may not even work on some
22865206Seric		architectures.
22966792SericNEEDFSYNC	Define this if your standard C library does not define
23066792Seric		fsync(2).  This will try to simulate the operation using
23166792Seric		fcntl(2); if that is not available it does nothing, which
23266792Seric		isn't great, but at least it compiles and runs.
23365211SericHASGETUSERSHELL	Define this to 1 if you have getusershell(3) in your
23465211Seric		standard C library.  If this is not defined, or is defined
23565211Seric		to be 0, sendmail will scan the /etc/shells file (no
23665211Seric		NIS-style support, defaults to /bin/sh and /bin/csh if
23765211Seric		that file does not exist) to get a list of unrestricted
23865211Seric		user shells.  This is used to determine whether users
23965211Seric		are allowed to forward their mail to a program or a file.
24063937SericGIDSET_T	The type of entries in a gidset passed as the second
24163937Seric		argument to getgroups(2).  Historically this has been an
24263937Seric		int, so this is the default, but some systems (such as
24363937Seric		IRIX) pass it as a gid_t, which is an unsigned short.
24463937Seric		This will make a difference, so it is important to get
24563937Seric		this right!  However, it is only an issue if you have
24663937Seric		group sets.
24763968SericSLEEP_T		The type returned by the system sleep() function.
24863968Seric		Defaults to "unsigned int".  Don't worry about this
24963968Seric		if you don't have compilation problems.
25063974SericARBPTR_T	The type of an arbitrary pointer -- defaults to "void *".
25163974Seric		If you are an very old compiler you may need to define
25263974Seric		this to be "char *".
25360584SericLA_TYPE		The type of load average your kernel supports.  These
25466301Seric		can be one of:
25566301Seric		LA_ZERO (1) -- it always returns the load average as
25666301Seric			"zero" (and does so on all architectures).
25766301Seric		LA_SUBR (4) if you have the getloadavg(3) routine,
25864376Seric		LA_MACH (5) to use MACH-style load averages (calls
25966301Seric			processor_set_info()),
26066301Seric		LA_PROCSTR (7) to read /proc/loadavg and interpret it
26166301Seric			as a string representing a floating-point
26266301Seric			number (Linux-style),
26366301Seric		LA_FLOAT (3) if you read kmem and interpret the value
26466301Seric			as a floating point number,
26566301Seric		LA_INT (2) to interpret as a long integer,
26666301Seric		LA_SHORT (6) to interpret as a short integer.
26766301Seric		These last three have several other parameters that they
26866301Seric		try to divine: the name of your kernel, the name of the
26966301Seric		variable in the kernel to examine, the number of bits of
27066301Seric		precision in a fixed point load average, and so forth.
27166301Seric		In desperation, use LA_ZERO.  The actual code is in
27266301Seric		conf.c -- it can be tweaked if you are brave.
27365752SericSFS_TYPE	Encodes how your kernel can locate the amount of free
27465752Seric		space on a disk partition.  This can be set to SFS_NONE
27565752Seric		(0) if you have no way of getting this information,
27665752Seric		SFS_USTAT (1) if you have the ustat(2) system call,
27765752Seric		SFS_4ARGS (2) if you have a four-argument statfs(2)
27865752Seric		system call (and the include file is <sys/statfs.h>),
27967161Seric		SFS_VFS (3), SFS_MOUNT (4), SFS_STATFS (5) if you have
28067161Seric		the two-argument statfs(2) system call with includes in
28167161Seric		<sys/vfs.h>, <sys/mount.h>, or <sys/statfs.h> respectively,
28267161Seric		or SFS_STATVFS (6) if you have the two-argument statvfs(2)
28367161Seric		call.  The default if nothing is defined is SFS_NONE.
28463962SericERRLIST_PREDEFINED
28563962Seric		If set, assumes that some header file defines sys_errlist.
28663962Seric		This may be needed if you get type conflicts on this
28763962Seric		variable -- otherwise don't worry about it.
28864562SericWAITUNION	The wait(2) routine takes a "union wait" argument instead
28964562Seric		of an integer argument.  This is for compatibility with
29064562Seric		old versions of BSD.
29165000SericSCANF		You can set this to extend the F command to accept a
29265000Seric		scanf string -- this gives you a primitive parser for
29365000Seric		class definitions -- BUT it can make you vulnerable to
29465000Seric		core dumps if the target file is poorly formed.
29565095SericSYSLOG_BUFSIZE	You can define this to be the size of the buffer that
29665095Seric		syslog accepts.  If it is not defined, it assumes a
29765095Seric		1024-byte buffer.  If the buffer is very small (under
29865095Seric		256 bytes) the log message format changes -- each
29965095Seric		e-mail message will log many more messages, since it
30065095Seric		will log each piece of information as a separate line
30165095Seric		in syslog.
30266318SericBROKEN_RES_SEARCH
30366318Seric		On Ultrix (and maybe other systems?) if you use the
30466318Seric		res_search routine with an unknown host name, it returns
30566318Seric		-1 but sets h_errno to 0 instead of HOST_NOT_FOUND.  If
30666318Seric		you set this, sendmail considers 0 to be the same as
30766318Seric		HOST_NOT_FOUND.
30860565Seric
30964035Seric
31064035Seric+-----------------------+
31164035Seric| COMPILE-TIME FEATURES |
31264035Seric+-----------------------+
31364035Seric
31460584SericThere are a bunch of features that you can decide to compile in, such
31560584Sericas selecting various database packages and special protocol support.
31660584SericSeveral are assumed based on other compilation flags -- if you want to
31760584Seric"un-assume" something, you probably need to edit conf.h.  Compilation
31860584Sericflags that add support for special features include:
31960565Seric
32060565SericNDBM		Include support for "new" DBM library for aliases and maps.
32164250Seric		Normally defined in the Makefile.
32260565SericNEWDB		Include support for Berkeley "db" package (hash & btree)
32364250Seric		for aliases and maps.  Normally defined in the Makefile.
32466843SericOLD_NEWDB	If non-zero, the version of NEWDB you have is the old
32566843Seric		one that does not include the "fd" call.  This call was
32666843Seric		added in version 1.5 of the Berkeley DB code.  If you
32766843Seric		use -DOLD_NEWDB=0 it forces you to use the new interface.
32860565SericNIS		Define this to get NIS (YP) support for aliases and maps.
32964250Seric		Normally defined in the Makefile.
33060565SericUSERDB		Include support for the User Information Database.  Implied
33164250Seric		by NEWDB in conf.h.
33265000SericIDENTPROTO	Define this as 1 to get IDENT (RFC 1413) protocol support.
33360565Seric		This is assumed unless you are running on Ultrix or
33460565Seric		HP-UX, both of which have a problem in the UDP
33565000Seric		implementation.  You can define it to be 0 to explicitly
33665000Seric		turn off IDENT protocol support.
33760565SericMIME		Include support for MIME-encapsulated error messages.
33860565SericLOG		Set this to get syslog(3) support.  Defined by default
33960584Seric		in conf.h.  You want this if at all possible.
34060565SericNETINET		Set this to get TCP/IP support.  Defined by default
34160584Seric		in conf.h.  You probably want this.
34260565SericNETISO		Define this to get ISO networking support.
34360565SericSMTP		Define this to get the SMTP code.  Implied by NETINET
34460565Seric		or NETISO.
34560565SericNAMED_BIND	Define this to get DNS (name daemon) support, including
34660565Seric		MX support.  The specs you must use this if you run
34760565Seric		SMTP.  Defined by default in conf.h.
34860565SericQUEUE		Define this to get queueing code.  Implied by NETINET
34960584Seric		or NETISO; required by SMTP.  This gives you other good
35060584Seric		stuff -- it should be on.
35160565SericDAEMON		Define this to get general network support.  Implied by
35260584Seric		NETINET or NETISO.  Defined by default in conf.h.  You
35360584Seric		almost certainly want it on.
35460565SericMATCHGECOS	Permit fuzzy matching of user names against the full
35560565Seric		name (GECOS) field in the /etc/passwd file.  This should
35660565Seric		probably be on, since you can disable it from the config
35760584Seric		file if you want to.  Defined by default in conf.h.
35860565SericSETPROCTITLE	Try to set the string printed by "ps" to something
35960584Seric		informative about what sendmail is doing.  Defined by
36060584Seric		default in conf.h.
36160565Seric
36264035Seric
36365000Seric+---------------------+
36465000Seric| DNS/RESOLVER ISSUES |
36565000Seric+---------------------+
36665000Seric
36765000SericMany systems have old versions of the resolver library.  At a minimum,
36865000Sericyou should be running BIND 4.8.3; older versions may compile, but they
36965000Serichave known bugs that should give you pause.
37065000Seric
37165000SericCommon problems in old versions include "undefined" errors for
37265000Sericdn_skipname.
37365000Seric
37465000SericSome people have had a problem with BIND 4.9; it uses some routines
37565000Sericthat it expects to be externally defined such as strerror().  It may
37665000Serichelp to link with "-l44bsd" to solve this problem.
37765000Seric
37865095Seric!PLEASE! be sure to link with the same version of the resolver as
37965095Sericthe header files you used -- some people have used the 4.9 headers
38065095Sericand linked with BIND 4.8 or vice versa, and it doesn't work.
38165095SericUnfortunately, it doesn't fail in an obvious way -- things just
38265954Sericsubtly don't work.
38365000Seric
38465095Seric
38564035Seric+-------------------------------------+
38664035Seric| OPERATING SYSTEM AND COMPILE QUIRKS |
38764035Seric+-------------------------------------+
38864035Seric
38965095SericGCC 2.5.x problems  *** IMPORTANT ***
39065095Seric	Date: Mon, 29 Nov 93 19:08:44 PST
39165095Seric	From: wilson@cygnus.com (Jim Wilson)
39265095Seric	Message-Id: <9311300308.AA04608@cygnus.com>
39365095Seric	To: kenner@vlsi1.ultra.nyu.edu
39465095Seric	Subject: [cattelan@thebarn.com: gcc 2.5.4-2.5.5 -O bug]
39565095Seric	Cc: cattelan@thebarn.com, rms@gnu.ai.mit.edu, sendmail@cs.berkeley.edu
39665095Seric
39765095Seric	This fixes a problem that occurs when gcc 2.5.5 is used to compile
39865095Seric	sendmail 8.6.4 with optimization on a sparc.
39965095Seric
40065095Seric	Mon Nov 29 19:00:14 1993  Jim Wilson  (wilson@sphagnum.cygnus.com)
40165095Seric
40265095Seric		* reload.c (find_reloads_toplev): Replace obsolete reference to
40365095Seric		BYTE_LOADS_*_EXTEND with LOAD_EXTEND_OP.
40465095Seric
40565095Seric	*** clean-ss-931128/reload.c    Sun Nov 14 16:20:01 1993
40665095Seric	--- ss-931128/reload.c  Mon Nov 29 18:52:55 1993
40765095Seric	*************** find_reloads_toplev (x, opnum, type, ind
40865095Seric	*** 3888,3894 ****
40965095Seric		 force a reload in that case.  So we should not do anything here.  */
41065095Seric
41165095Seric		else if (regno >= FIRST_PSEUDO_REGISTER
41265095Seric	! #if defined(BYTE_LOADS_ZERO_EXTEND) || defined(BYTE_LOADS_SIGN_EXTEND)
41365095Seric		       && (GET_MODE_SIZE (GET_MODE (x))
41465095Seric			   <= GET_MODE_SIZE (GET_MODE (SUBREG_REG (x))))
41565095Seric	  #endif
41665095Seric	--- 3888,3894 ----
41765095Seric		 force a reload in that case.  So we should not do anything here.  */
41865095Seric
41965095Seric		else if (regno >= FIRST_PSEUDO_REGISTER
42065095Seric	! #ifdef LOAD_EXTEND_OP
42165095Seric		       && (GET_MODE_SIZE (GET_MODE (x))
42265095Seric			   <= GET_MODE_SIZE (GET_MODE (SUBREG_REG (x))))
42365095Seric	  #endif
42465095Seric
42565095Seric
42664376SericSunOS 4.x (Solaris 1.x)
42764376Seric	You may have to use -lresolv on SunOS.  However, beware that
42864376Seric	this links in a new version of gethostbyname that does not
42964376Seric	understand NIS, so you must have all of your hosts in DNS.
43064035Seric
43164798Seric	Some people have reported problems with the SunOS version of
43264798Seric	-lresolv and/or in.named, and suggest that you get a newer
43364798Seric	version.  The symptoms are delays when you connect to the
43465000Seric	SMTP server on a SunOS machine or having your domain added to
43565000Seric	addresses inappropriately.  There is a version of BIND
43664798Seric	version 4.9 on gatekeeper.DEC.COM in pub/BSD/bind/4.9.
43764798Seric
43864400Seric	There is substantial disagreement about whether you can make
43964400Seric	this work with resolv+, which allows you to specify a search-path
44064400Seric	of services.  Some people report that it works fine, others
44164400Seric	claim it doesn't work at all (including causing sendmail to
44264400Seric	drop core when it tries to do multiple resolv+ lookups for a
44364400Seric	single job).  I haven't tried resolv+, as we use DNS exclusively.
44464400Seric
44564400Seric	Should you want to try resolv+, it is on ftp.uu.net in
44664400Seric	/networking/ip/dns.
44764400Seric
44867161Seric	Apparently getservbyname() can fail under moderate to high
44967161Seric	load under some circumstances.  This will exhibit itself as
45067161Seric	the message ``554 makeconnection: service "smtp" unknown''.
45167161Seric	The problem has been traced to one or more blank lines in
45267161Seric	/etc/services on the NIS server machine.  Delete these
45367161Seric	and it should work.  This info is thanks to Brian Bartholomew
45467161Seric	<bb@math.ufl.edu> of I-Kinetics, Inc.
45567161Seric
45664376SericSolaris 2.x (SunOS 5.x)
45764376Seric	To compile for Solaris, be sure you use -DSOLARIS.
45864376Seric
45966329Seric	To the best of my knowledge, Solaris does not have the
46066329Seric	gethostbyname problem described above.  However, it does
46166329Seric	have another one:
46266329Seric
46364364Seric	From a correspondent:
46464364Seric
46564364Seric	   For solaris 2.2, I have
46664364Seric
46764364Seric		hosts:      files dns
46864364Seric
46964364Seric	   in /etc/nsswitch.conf and /etc/hosts has to have the fully
47064364Seric	   qualified host name. I think "files" has to be before "dns"
47164364Seric	   in /etc/nsswitch.conf during bootup.
47264364Seric
47366329Seric	From another correspondent:
47464376Seric
47566329Seric	   When running sendmail under Solaris, the gethostbyname()
47666329Seric	   hack in conf.c which should perform proper canonicalization
47766329Seric	   of host names could fail.  Result: the host name is not
47866329Seric	   canonicalized despite the hack, and you'll have to define $j
47966329Seric	   and $m in sendmail.cf somewhere.
48066329Seric
48166329Seric	   The reason could be that /etc/nsswitch.conf is improperly
48266329Seric	   configured (at least from sendmail's point of view).  For
48366329Seric	   example, the line
48466329Seric
48566329Seric		hosts:      files nisplus dns
48666329Seric
48766329Seric	   will make gethostbyname() look in /etc/hosts first, then ask
48866329Seric	   nisplus, then dns.  However, if /etc/hosts does not contain
48966329Seric	   the full canonicalized hostname, then no amount of
49066329Seric	   gethostbyname()s will work.
49166329Seric
49266329Seric	   Solution (or rather, a workaround): Ask nisplus first, then
49366329Seric	   dns, then local files:
49466329Seric
49566329Seric		hosts:      nisplus dns [NOTFOUND=return] files
49666329Seric
49764385Seric	The Solaris "syslog" function is apparently limited to something
49864385Seric	about 90 characters because of a kernel limitation.  If you have
49966023Seric	source code, you can probably up this number.  You can get patches
50066023Seric	that fix this problem: the patch ids are:
50164385Seric
50266023Seric		Solaris 2.1	100834
50366023Seric		Solaris 2.2	100999
50466024Seric		Solaris 2.3	101318
50566023Seric
50666023Seric	Be sure you have the appropriate patch installed or you won't
50766023Seric	see system logging.
50866023Seric
50964250SericOSF/1
51065000Seric	If you are compiling on OSF/1 (DEC Alpha), you must use
51165616Seric	-L/usr/shlib (otherwise it core dumps on startup).  You may also
51265000Seric	need -mld to get the nlist() function, although some versions
51365000Seric	apparently don't need this.
51465000Seric
51565000Seric	Also, the enclosed makefile removed /usr/sbin/smtpd; if you need
51665000Seric	it, just create the link to the sendmail binary.
51757977Seric
51866335SericIRIX
51966335Seric	The header files on SGI IRIX are completely prototyped, and as
52066335Seric	a result you can sometimes get some warning messages during
52166335Seric	compilation.  These can be ignored.  There are two errors in
52266335Seric	deliver only if you are using gcc, both of the form ``warning:
52366335Seric	passing arg N of `execve' from incompatible pointer type''.
52466335Seric	Also, if you compile with -DNIS, you will get a complaint
52566335Seric	about a declaration of struct dom_binding in a prototype
52666335Seric	when compiling map.c; this is not important because the
52766335Seric	function being prototyped is not used in that file.
52866335Seric
52964250SericNeXT
53064250Seric	If you are compiling on NeXT, you will have to create an empty
53164250Seric	file "unistd.h" and create a file "dirent.h" containing:
53263753Seric
53364250Seric		#include <sys/dir.h>
53464250Seric		#define dirent	direct
53564035Seric
53664250Seric	(The Makefile.NeXT should try to do both of these for you.)
53764077Seric
53864364Seric	Apparently, there is a bug in getservbyname on Nextstep 3.0
53964364Seric	that causes it to fail under some circumstances with the
54064364Seric	message "SYSERR: service "smtp" unknown" logged.  You should
54164364Seric	be able to work around this by including the line:
54264364Seric
54364670Seric		OOPort=25
54464364Seric
54564364Seric	in your .cf file.
54664364Seric
54764376Seric	You may have to use -DNeXT.
54864376Seric
54965000SericBSDI (BSD/386) 1.0, NetBSD 0.9, FreeBSD 1.0
55065000Seric	The "m4" from BSDI won't handle the config files properly.
55165000Seric	I haven't had a chance to test this myself.
55257943Seric
55365000Seric	The M4 shipped in FreeBSD and NetBSD 0.9 don't handle the config
55465000Seric	files properly. One must use either GNU m4 1.1 or the PD-M4
55565000Seric	recently posted in comp.os.386bsd.bugs (and maybe others).
55665000Seric	NetBSD-current includes the PD-M4 (as stated in the NetBSD file
55765000Seric	CHANGES).
55865000Seric
55965000Seric	FreeBSD 1.0 RELEASE has uname(2) now. Use -DUSEUNAME in order to
56065000Seric	use it (look into Makefile.FreeBSD). NetBSD-current may have
56165000Seric	it too but it has not been verified.
56265000Seric
56365000Seric	You cannot port the latest version of the Berkeley db library
56465000Seric	and use it with sendmail without recompiling the world.  This
56565000Seric	is because C library routines use the older version which have
56665000Seric	incompatible header files -- the result is that it can't read
56765000Seric	other system files, such as /etc/passwd, unless you use the
56865000Seric	new db format throughout your system.  You should normally just
56965000Seric	use the version of db supplied in your release.  You may need
57066843Seric	to use -DOLD_NEWDB=1 to make this work -- this turns off some
57165000Seric	new interface calls (for file locking) that are not in older
57265000Seric	versions of db.  You'll get compile errors if you need this
57365000Seric	flag and don't have it set.
57465000Seric
57564364Seric4.3BSD
57664364Seric	If you are running a "virgin" version of 4.3BSD, you'll have
57764364Seric	a very old resolver and be missing some header files.  The
57864364Seric	header files are simple -- create empty versions and everything
57964364Seric	will work fine.  For the resolver you should really port a new
58064364Seric	version (4.8.3 or later) of the resolver; 4.9 is available on
58164364Seric	gatekeeper.DEC.COM in pub/BSD/bind/4.9.  If you are really
58264364Seric	determined to continue to use your old, buggy version (or as
58364364Seric	a shortcut to get sendmail working -- I'm sure you have the
58464364Seric	best intentions to port a modern version of BIND), you can
58564364Seric	copy ../contrib/oldbind.compat.c into src and add
58664364Seric	oldbind.compat.o to OBJADD in the Makefile.
58764364Seric
58864718SericA/UX
58964718Seric	Date: Tue, 12 Oct 1993 18:28:28 -0400 (EDT)
59064718Seric	From: "Eric C. Hagberg" <hagberg@med.cornell.edu>
59164718Seric	Subject: Fix for A/UX ndbm
59264718Seric
59364718Seric	I guess this isn't really a sendmail bug, however, it is something
59464718Seric	that A/UX users should be aware of when compiling sendmail 8.6.
59564718Seric
59664718Seric	Apparently, the calls that sendmail is using to the ndbm routines
59764718Seric	in A/UX 3.0.x contain calls to "broken" routines, in that the
59864718Seric	aliases database will break when it gets "just a little big"
59964718Seric	(sorry I don't have exact numbers here, but it broke somewhere
60064718Seric	around 20-25 aliases for me.), making all aliases non-functional
60164718Seric	after exceeding this point.
60264718Seric
60364718Seric	What I did was to get the gnu-dbm-1.6 package, compile it, and
60464718Seric	then re-compile sendmail with "-lgdbm", "-DNDBM", and using the
60564718Seric	ndbm.h header file that comes with the gnu-package. This makes
60664718Seric	things behave properly.
60764718Seric
60864718Seric	I suppose porting the New Berkeley db package is another route,
60964718Seric	however, I made a quick attempt at it, and found it difficult
61064718Seric	(not easy at least); the gnu-dbm package "configured" and
61164718Seric	compiled easily.
61264718Seric
61364718SericDG/UX
61464718Seric	Apparently, /bin/mail doesn't work properly for delivery on
61564718Seric	DG/UX -- the person who has this working, Douglas Anderson
616*67427Seric	<dlander@afterlife.ncsc.mil>, used procmail instead.  The
617*67427Seric	problem is that DG/UX /bin/mail requires that an environment
618*67427Seric	variable be set (_FORCE_MAIL_LOCAL_=yes); sendmail has no
619*67427Seric	mechanism for this.  Several people report that procmail works
620*67427Seric	beautifully.
62164718Seric
62265820SericApollo DomainOS
62365820Seric	If you are compiling on Apollo, you will have to create an empty
62465820Seric	file "unistd.h" and create a file "dirent.h" containing:
62565820Seric
62665820Seric		#include <sys/dir.h>
62765820Seric		#define dirent	direct
62865820Seric
62965820Seric	(The Makefile.DomainOS will attempt to do both of these for you.)
63065820Seric
63165910SericHP-UX 8.00
63265910Seric	Date: Mon, 24 Jan 1994 13:25:45 +0200
63365910Seric	From: Kimmo Suominen <Kimmo.Suominen@lut.fi>
63465910Seric	Subject: 8.6.5 w/ HP-UX 8.00 on s300
63565910Seric
63665910Seric	Just compiled and fought with sendmail 8.6.5 on a HP9000/360 (ie. a
63765910Seric	series 300 machine) running HP-UX 8.00.
63865910Seric
63965910Seric	I was getting segmentation fault when delivering to a local user.
64065910Seric	With debugging I saw it was faulting when doing _free@libc... *sigh*
64165910Seric	It seems the new implementation of malloc on s300 is buggy as of 8.0,
64265910Seric	so I tried out the one in -lmalloc (malloc(3X)).  With that it seems
64365910Seric	to work just dandy.
64465910Seric
64565910Seric	When linking, you will get the following error:
64665910Seric
64765910Seric	ld: multiply defined symbol _freespace in file /usr/lib/libmalloc.a
64865910Seric
64965910Seric	but you can just ignore it.  You might want to add this info to the
65065910Seric	README file for the future...
65165910Seric
65265910SericLinux
65365910Seric	Something broke between versions 0.99.13 and 0.99.14 of Linux:
65465910Seric	the flock() system call gives errors.  If you are running .14,
65565910Seric	you must not use flock.  You can do this with -DHASFLOCK=0.
65665910Seric
65765910SericAIX
65865910Seric	This version of sendmail does not support MB, MG, and MR resource
65965910Seric	records, which are supported by AIX sendmail.
66065910Seric
66166335SericRISC/os
66266335Seric	RISC/os from MIPS is a merged AT&T/Berkeley system.  When you
66366335Seric	compile on that platform you will get duplicate definitions
66466335Seric	on many files.  You can ignore these.
66566335Seric
66665195SericSystem V Release 4 Based Systems
66765195Seric	There is a single Makefile that is intended for all SVR4-based
66865195Seric	systems (called Makefile.SVR4).  It defines __svr4__, which is
66965195Seric	predefined by some compilers.  If your compiler already defines
67065195Seric	this compile variable, you can delete the definition from the
67165195Seric	Makefile.
67265195Seric
67365195Seric	It's been tested on Dell Issue 2.2.
67465195Seric
67565095SericDELL SVR4
67665095Seric	Date:      Mon, 06 Dec 1993 10:42:29 EST
67765095Seric	From: "Kimmo Suominen" <kim@grendel.lut.fi>
67865095Seric	Message-ID: <2d0352f9.lento29@lento29.UUCP>
67965095Seric	To: eric@cs.berkeley.edu
68065166Seric	Cc: sendmail@cs.berkeley.edu
68165095Seric	Subject:   Notes for DELL SVR4
68265095Seric
68365095Seric	Eric,
68465095Seric
68565095Seric	Here are some notes for compiling Sendmail 8.6.4 on DELL SVR4.  I ran
68665095Seric	across these things when helping out some people who contacted me by
68765095Seric	e-mail.
68865095Seric
68965095Seric	1) Use gcc 2.4.5 (or later?).  Dell distributes gcc 2.1 with their
69065095Seric	   Issue 2.2 Unix.  It is too old, and gives you problems with
69165095Seric	   clock.c, because sigset_t won't get defined in <sys/signal.h>.
69265095Seric	   This is due to a problematic protection rule in there, and is
69365095Seric	   fixed with gcc 2.4.5.
69465095Seric
69565095Seric	2) If you don't use the new Berkeley DB (-DNEWDB), then you need
69665095Seric	   to add "-lc -lucb" to the libraries to link with.  This is because
69765095Seric	   the -ldbm distributed by Dell needs the bcopy, bcmp and bzero
69865095Seric	   functions.  It is important that you specify both libraries in
69965095Seric	   the given order to be sure you only get the BSTRING functions
70065095Seric	   from the UCB library (and not the signal routines etc.).
70165095Seric
70265095Seric	3) Don't leave out "-lelf" even if compiling with "-lc -lucb".
70365095Seric	   The UCB library also has another copy of the nlist routines,
70465095Seric	   but we do want the ones from "-lelf".
70565095Seric
70665095Seric	If anyone needs a compiled gcc 2.4.5 and/or a ported DB library, they
70765095Seric	can use anonymous ftp to fetch them from lut.fi in the /kim directory.
70865095Seric	They are copies of what I use on grendel.lut.fi, and offering them
70965095Seric	does not imply that I would also support them.  I have sent the DB
71065095Seric	port for SVR4 back to Keith Bostic for inclusion in the official
71165095Seric	distribution, but I haven't heard anything from him as of today.
71265095Seric
71365095Seric	- gcc-2.4.5-svr4.tar.gz	(gcc 2.4.5 and the corresponding libg++)
71465095Seric	- db-1.72.tar.gz	(with source, objects and a installed copy)
71565095Seric
71665095Seric	Cheers
71765095Seric	+ Kim
71865095Seric	--
71965095Seric	 *  Kimmo.Suominen@lut.fi  *  SysVr4 enthusiast at GRENDEL.LUT.FI  *
72065095Seric	*    KIM@FINFILES.BITNET   *  Postmaster and Hostmaster at LUT.FI   *
72165095Seric	 *    + 358 200 865 718    *  Unix area moderator at NIC.FUNET.FI  *
72265095Seric
72367267SericConvexOS 10.1 and below
72467267Seric	In order to use the name server, you must create the file
72567267Seric	/etc/use_nameserver.  If this file does not exist, the call
72667267Seric	to res_init() will fail and you will have absolutely no
72767267Seric	access to DNS, including MX records.
72865095Seric
72964718SericNon-DNS based sites
73064718Seric	This version of sendmail always tries to connect to the Domain
73164718Seric	Name System (DNS) to resolve names, regardless of the setting
73264718Seric	of the `I' option.  On most systems that are not running DNS,
73364718Seric	this will fail quickly and sendmail will continue, but on some
73464718Seric	systems it has a long timeout.  If you have this problem, you
73564718Seric	will have to recompile without NAMED_BIND.  Some people have
73664718Seric	claimed that they have successfully used "OI+USEVC" to force
73764718Seric	sendmail to use a virtual circuit -- this will always time out
73864718Seric	quickly, but also tells sendmail that a failed connection
73964718Seric	should requeue the message (probably not what you intended).
74064718Seric	A future release of sendmail will correct this problem.
74164718Seric
74264250SericBoth NEWDB and NDBM
74364250Seric	If you use both -DNDBM and -DNEWDB, you must delete the module
74464250Seric	ndbm.o from libdb.a and delete the file "ndbm.h" from the files
74564250Seric	that get installed (that is, use the OLD ndbm.h, not the new
74664250Seric	ndbm.h).  This compatibility module maps ndbm calls into DB
74764250Seric	calls, and breaks things rather badly.
74858709Seric
74964559SericGNU getopt
75064559Seric	I'm told that GNU getopt has a problem in that it gets confused
75164559Seric	by the double call.  Use the version in conf.c instead.
75264250Seric
75366350SericBIND 4.9.2 and Ultrix
75467206Seric	If you are running on Ultrix, be sure you read conf/Info.Ultrix
75567206Seric	in the BIND distribution very carefully -- there is information
75667206Seric	in there that you need to know in order to avoid errors of the
75767206Seric	form:
75864559Seric
75966350Seric		/lib/libc.a(gethostent.o): sethostent: multiply defined
76066350Seric		/lib/libc.a(gethostent.o): endhostent: multiply defined
76166350Seric		/lib/libc.a(gethostent.o): gethostbyname: multiply defined
76266350Seric		/lib/libc.a(gethostent.o): gethostbyaddr: multiply defined
76366350Seric
76466350Seric	during the link stage.
76566350Seric
76666350Seric
76764820Seric+--------------+
76864820Seric| MANUAL PAGES |
76964820Seric+--------------+
77064820Seric
77164820SericThe manual pages have been written against the -mandoc macros
77264820Sericinstead of the -man macros.  The latest version of groff has them
77364820Sericincluded.  You can also get a copy from FTP.UU.NET in directory
77464820Seric/systems/unix/bsd-sources/share/tmac.
77564820Seric
77664820Seric
77765151Seric+-----------------+
77865151Seric| DEBUGGING HOOKS |
77965151Seric+-----------------+
78065151Seric
78165151SericAs of 8.6.5, sendmail daemons will catch a SIGUSR1 signal and log
78265151Sericsome debugging output (logged at LOG_DEBUG severity).  The
78365151Sericinformation dumped is:
78465151Seric
78565151Seric * The value of the $j macro.
78665151Seric * A warning if $j is not in the set $=w.
78765151Seric * A list of the open file descriptors.
78865151Seric * The contents of the connection cache.
78965151Seric * If ruleset 89 is defined, it is evaluated and the results printed.
79065151Seric
79165151SericThis allows you to get information regarding the runtime state of the
79265151Sericdaemon on the fly.  This should not be done too frequently, since
79365151Sericthe process of rewriting may lose memory which will not be recovered.
79465151SericAlso, ruleset 89 may call non-reentrant routines, so there is a small
79565151Sericnon-zero probability that this will cause other problems.  It is
79665151Sericreally only for debugging serious problems.
79765151Seric
79865151SericA typical formulation of ruleset 89 would be:
79965151Seric
80065151Seric	R$*		$@ $>0 some test address
80165151Seric
80265151Seric
80364035Seric+-----------------------------+
80464035Seric| DESCRIPTION OF SOURCE FILES |
80564035Seric+-----------------------------+
80664035Seric
8079881SericThe following list describes the files in this directory:
8085369Seric
80957418SericMakefile	The makefile used here; this version only works with
81057418Seric		the new Berkeley make.
81157418SericMakefile.dist	A trimmed down version of the makefile that works with
81257418Seric		the old make.
8135369SericREAD_ME		This file.
81460565SericTRACEFLAGS	My own personal list of the trace flags -- not guaranteed
81560565Seric		to be particularly up to date.
8165369Sericalias.c		Does name aliasing in all forms.
8179881Sericarpadate.c	A subroutine which creates ARPANET standard dates.
8189881Sericclock.c		Routines to implement real-time oriented functions
8199881Seric		in sendmail -- e.g., timeouts.
8205369Sericcollect.c	The routine that actually reads the mail into a temp
8215369Seric		file.  It also does a certain amount of parsing of
8225369Seric		the header, etc.
8235369Sericconf.c		The configuration file.  This contains information
8245369Seric		that is presumed to be quite static and non-
8255369Seric		controversial, or code compiled in for efficiency
8265369Seric		reasons.  Most of the configuration is in sendmail.cf.
8279881Sericconf.h		Configuration that must be known everywhere.
8285369Sericconvtime.c	A routine to sanely process times.
8299881Sericdaemon.c	Routines to implement daemon mode.  This version is
8309881Seric		specifically for Berkeley 4.1 IPC.
8315369Sericdeliver.c	Routines to deliver mail.
83260565Sericdomain.c	Routines that interface with DNS (the Domain Name
83360565Seric		System).
8345369Sericerr.c		Routines to print error messages.
8359881Sericenvelope.c	Routines to manipulate the envelope structure.
8365369Sericheaders.c	Routines to process message headers.
8375369Sericmacro.c		The macro expander.  This is used internally to
8385369Seric		insert information from the configuration file.
8395369Sericmain.c		The main routine to sendmail.  This file also
8405369Seric		contains some miscellaneous routines.
84160565Sericmap.c		Support for database maps.
84260565Sericmci.c		Routines that handle mail connection information caching.
8439881Sericparseaddr.c	The routines which do address parsing.
8445369Sericqueue.c		Routines to implement message queueing.
8455369Sericreadcf.c	The routine that reads the configuration file and
8465369Seric		translates it to internal form.
8479881Sericrecipient.c	Routines that manipulate the recipient list.
8485369Sericsavemail.c	Routines which save the letter on processing errors.
8495369Sericsendmail.h	Main header file for sendmail.
8505369Sericsrvrsmtp.c	Routines to implement server SMTP.
8515369Sericstab.c		Routines to manage the symbol table.
8525369Sericstats.c		Routines to collect and post the statistics.
8535369Sericsysexits.c	List of error messages associated with error codes
8545369Seric		in sysexits.h.
8559881Serictrace.c		The trace package.  These routines allow setting and
8569881Seric		testing of trace flags with a high granularity.
85760565Sericudb.c		The user database interface module.
8585369Sericusersmtp.c	Routines to implement user SMTP.
8595369Sericutil.c		Some general purpose routines used by sendmail.
86060565Sericversion.c	The version number and information about this
86160565Seric		version of sendmail.  Theoretically, this gets
86260565Seric		modified on every change.
8635369Seric
8645369SericEric Allman
8655369Seric
866*67427Seric(Version 8.65, last update 06/19/94 06:37:14)
867