xref: /original-bsd/usr.sbin/sendmail/src/READ_ME (revision 2b80b74c)
1# Copyright (c) 1983 Eric P. Allman
2# Copyright (c) 1988 The Regents of the University of California.
3# All rights reserved.
4#
5# %sccs.include.redist.sh%
6#
7#	@(#)READ_ME	8.64 (Berkeley) 05/29/94
8#
9
10This directory contains the source files for sendmail.
11
12For detailed instructions, please read the document ../doc/op.me:
13
14	eqn ../doc/op.me | pic | ditroff -me
15
16The Makefile is for the new (4.4BSD) Berkeley make and uses syntax
17that is not recognized by older makes.  It also has assumptions
18about the 4.4 file system layout built in.  See below for details
19about other Makefiles.
20
21There is also a Makefile.dist which is much less clever, but works on
22the old traditional make.  You can use this using:
23
24	make -f Makefile.dist
25
26**************************************************
27**  Read below for more details of Makefiles.	**
28**************************************************
29
30There is also a shell script (makesendmail) that tries to be clever
31about using object subdirectories.  It's pretty straightforward, and
32may help if you share a source tree among different architectures.
33
34**************************************************************************
35**  IMPORTANT:  DO NOT USE OPTIMIZATION (``-O'') IF YOU ARE RUNNING	**
36**  GCC 2.4.x or 2.5.x.  THERE IS A BUG IN THE GCC OPTIMIZER THAT	**
37**  CAUSES SENDMAIL COMPILES TO FAIL MISERABLY.				**
38**************************************************************************
39
40Jim Wilson of Cygnus believes he has found the problem -- it will
41probably be fixed in GCC 2.5.6 -- but until this is verified, be
42very suspicious of gcc -O.
43
44**************************************************************************
45**  IMPORTANT:  Read the appropriate paragraphs in the section on	**
46**  ``Operating System and Compile Quirks''.				**
47**************************************************************************
48
49
50+-----------+
51| MAKEFILES |
52+-----------+
53
54The "Makefile"s in these directories are from 4.4 BSD, and hence
55really only work properly if you are on a 4.4 system.  In particular,
56they use new syntax that will not be recognized on old make programs,
57and some of them do things like ``.include ../../Makefile.inc'' to
58pick up some system defines.  If you are getting sendmail separately,
59these files won't be included in the distribution, as they are
60outside of the sendmail tree.
61
62Instead, you should use one of the other Makefiles, such as
63Makefile.SunOS for a SunOS system, and so forth.  These should
64work with the version of make that is appropriate for that
65system.
66
67There are a bunch of other Makefiles for other systems with names
68like Makefile.HPUX for an HP-UX system.  They use the version of
69make that is native for that system.  These are the Makefiles that
70I use, and they have "Berkeley quirks" in them.  I can't guarantee
71that they will work unmodified in your environment.  Many of them
72include -I/usr/sww/include/db and -L/usr/sww/lib -- this is Berkeley's
73location (the ``Software Warehouse'') for the new database libraries,
74described below.  You don't have to remove these definitions if you
75don't have these directories.
76
77Please look for an appropriate Makefile before you start trying to
78compile with Makefile or Makefile.dist.
79
80If you want to port the new Berkeley make, you can get it from
81ftp.uu.net in the directory /systems/unix/bsd-sources/usr.bin/make.
82Diffs and instructions for building this version of make under
83SunOS 4.1.x are available on ftp.css.itd.umich.edu in
84/pub/systems/sun/Net2-make.sun4.diff.Z.  Diffs and instructions
85for building this version of make under IBM AIX 3.2.4 are available
86on ftp.uni-stuttgart.de in /sw/src/patches/bsd-make-rus-patches.
87Paul Southworth <pauls@umich.edu> published a description of porting
88this make in comp.unix.bsd.
89
90The complete text of the Makefile.inc that is in the parent of the
91sendmail directory is:
92
93	#	@(#)Makefile.inc	8.1 (Berkeley) 6/6/93
94
95	BINDIR?=	/usr/sbin
96
97
98+----------------------+
99| DATABASE DEFINITIONS |
100+----------------------+
101
102There are several database formats that can be used for the alias files
103and for general maps.  When used for alias files they interact in an
104attempt to be back compatible.
105
106The three options are NEWDB (the new Berkeley DB package), NDBM (the
107older DBM implementation -- the very old V7 implementation is no
108longer supported), and NIS (Network Information Services).  Used alone
109these just include the support they indicate.  [If you are using NEWDB,
110get the latest version from FTP.CS.Berkeley.EDU in /ucb/4bsd.  DO NOT
111use the version from the Net2 distribution!  However, if you are on
112BSD/386 or 386BSD-based systems, use the one that already exists
113on your system.  You may need to #define OLD_NEWDB 1 to do this.]
114
115[NOTE WELL: it is CRITICAL that you remove ndbm.o from libdb.a and
116ndbm.h from the appropriate include directories if you want to get
117ndbm support.  These files OVERRIDE calls to ndbm routines -- in
118particular, if you leave ndbm.h in, you can find yourself using
119the new db package even if you don't define NEWDB.]
120
121If NEWDB and NDBM are defined (but not NIS), then sendmail will read
122NDBM format alias files, but the next time a newaliases is run the
123format will be converted to NEWDB; that format will be used forever
124more.  This is intended as a transition feature.  [Note however that
125the NEWDB library also catches and maps NDBM calls; you will have to
126back out this feature to get this to work.  See ``Quirks'' section
127below for details.]
128
129If all three are defined, sendmail operates as described above, and also
130looks for the file /var/yp/Makefile.  If it exists, newaliases will
131build BOTH the NEWDB and NDBM format alias files.  However, it will
132only use the NEWDB file; the NDBM format file is used only by the
133NIS subsystem.
134
135If NDBM and NIS are defined (regardless of the definition of NEWDB
136or the existance of /var/yp/Makefile), sendmail adds the special
137tokens "YP_LAST_MODIFIED" and "YP_MASTER_NAME", both of which are
138required if the NDBM file is to be used as an NIS map.
139
140All of -DNEWDB, -DNDBM, and -DNIS are normally defined in the DBMDEF
141line in the Makefile.
142
143
144+---------------+
145| COMPILE FLAGS |
146+---------------+
147
148Whereever possible, I try to make sendmail pull in the correct
149compilation options needed to compile on various environments based on
150automatically defined symbols.  Some machines don't seem to have useful
151symbols availble, requiring the following compilation flags in the
152Makefile:
153
154SOLARIS		Define this if you are running Solaris 2.0 or higher.
155SOLARIS_2_3	Define this if you are running Solaris 2.3 or higher.
156SUNOS403	Define this if you are running SunOS 4.0.3.
157NeXT		Define this if you are on a NeXT box.  (This one may
158		be pre-defined for you.)  There are other hacks you
159		have to make -- see below.
160_AIX3		Define this if you are IBM AIX 3.x.
161RISCOS		Define this if you are running RISC/os from MIPS.
162IRIX		Define this if you are running IRIX from SGI.
163_SCO_unix_	Define this if you are on SCO UNIX.
164_SCO_unix_4_2	Define this if you are on SCO Open Server 3.2v4.
165
166If you are a system that sendmail has already been ported to, you
167probably won't have to touch these.  But if you are porting, you may
168have to tweak the following compilation flags in conf.h in order to
169get it to compile and link properly:
170
171SYSTEM5		Adjust for System V (not necessarily Release 4).
172SYS5SIGNALS	Use System V signal semantics -- the signal handler
173		is automatically dropped when the signal is caught.
174		If this is not set, use POSIX/BSD semantics, where the
175		signal handler stays in force until an exec or an
176		explicit delete.  Implied by SYSTEM5.
177SYS5SETPGRP	Use System V setpgrp() semantics.  Implied by SYSTEM5.
178HASFLOCK	Set this if you prefer to use the flock(2) system call
179		rather than using fcntl-based locking.  Fcntl locking
180		has some semantic gotchas, but many vendor systems
181		also interface it to lockd(8) to do NFS-style locking.
182		For this reason, this should not be set unless you
183		don't have an alternative.
184HASUNAME	Set if you have the "uname" system call.  Implied by
185		SYSTEM5.
186HASUNSETENV	Define this if your system library has the "unsetenv"
187		subroutine.
188HASSETSID	Define this if you have the setsid(2) system call.  This
189		is implied if your system appears to be POSIX compliant.
190HASINITGROUPS	Define this if you have the initgroups(3) routine.
191HASSETVBUF	Define this if you have the setvbuf(3) library call.
192		If you don't, setlinebuf will be used instead.  This
193		defaults on if your compiler defines __STDC__.
194HASSETREUID	Define this if you have setreuid(2) ***AND*** root can
195		use setreuid to change to an arbitrary user.  This second
196		condition is not satisfied on AIX 3.x.  You may find that
197		your system has setresuid(2), (for example, on HP-UX) in
198		which case you will also have to #define setreuid(r, e)
199		to be the appropriate call.  Some systems (such as Solaris)
200		have a compatibility routine that doesn't work properly,
201		but may have "saved user ids" properly implemented so you
202		can ``#define setreuid(r, e) seteuid(e)'' and have it work.
203		The important thing is that you have a call that will set
204		the effective uid independently of the real or saved uid
205		and be able to set the effective uid back again when done.
206		There's a test program in ../test/t_setreuid.c that will
207		try things on your system.  Setting this improves the
208		security, since sendmail doesn't have to read .forward
209		and :include: files as root.  There are certain attacks
210		that may be unpreventable without this call.
211HASLSTAT	Define this if you have symbolic links (and thus the
212		lstat(2) system call).  This improves security.  Unlike
213		most other options, this one is on by default, so you
214		need to #undef it in conf.h if you don't have symbolic
215		links (these days everyone does).
216NEEDGETOPT	Define this if you need a reimplementation of getopt(3).
217		On some systems, getopt does very odd things if called
218		to scan the arguments twice.  This flag will ask sendmail
219		to compile in a local version of getopt that works
220		properly.
221NEEDSTRTOL	Define this if your standard C library does not define
222		strtol(3).  This will compile in a local version.
223NEEDVPRINTF	Define this if your standard C library does not define
224		vprintf(3).  Note that the resulting fake implementation
225		is not very elegant and may not even work on some
226		architectures.
227NEEDFSYNC	Define this if your standard C library does not define
228		fsync(2).  This will try to simulate the operation using
229		fcntl(2); if that is not available it does nothing, which
230		isn't great, but at least it compiles and runs.
231HASGETUSERSHELL	Define this to 1 if you have getusershell(3) in your
232		standard C library.  If this is not defined, or is defined
233		to be 0, sendmail will scan the /etc/shells file (no
234		NIS-style support, defaults to /bin/sh and /bin/csh if
235		that file does not exist) to get a list of unrestricted
236		user shells.  This is used to determine whether users
237		are allowed to forward their mail to a program or a file.
238GIDSET_T	The type of entries in a gidset passed as the second
239		argument to getgroups(2).  Historically this has been an
240		int, so this is the default, but some systems (such as
241		IRIX) pass it as a gid_t, which is an unsigned short.
242		This will make a difference, so it is important to get
243		this right!  However, it is only an issue if you have
244		group sets.
245SLEEP_T		The type returned by the system sleep() function.
246		Defaults to "unsigned int".  Don't worry about this
247		if you don't have compilation problems.
248ARBPTR_T	The type of an arbitrary pointer -- defaults to "void *".
249		If you are an very old compiler you may need to define
250		this to be "char *".
251LA_TYPE		The type of load average your kernel supports.  These
252		can be one of:
253		LA_ZERO (1) -- it always returns the load average as
254			"zero" (and does so on all architectures).
255		LA_SUBR (4) if you have the getloadavg(3) routine,
256		LA_MACH (5) to use MACH-style load averages (calls
257			processor_set_info()),
258		LA_PROCSTR (7) to read /proc/loadavg and interpret it
259			as a string representing a floating-point
260			number (Linux-style),
261		LA_FLOAT (3) if you read kmem and interpret the value
262			as a floating point number,
263		LA_INT (2) to interpret as a long integer,
264		LA_SHORT (6) to interpret as a short integer.
265		These last three have several other parameters that they
266		try to divine: the name of your kernel, the name of the
267		variable in the kernel to examine, the number of bits of
268		precision in a fixed point load average, and so forth.
269		In desperation, use LA_ZERO.  The actual code is in
270		conf.c -- it can be tweaked if you are brave.
271SFS_TYPE	Encodes how your kernel can locate the amount of free
272		space on a disk partition.  This can be set to SFS_NONE
273		(0) if you have no way of getting this information,
274		SFS_USTAT (1) if you have the ustat(2) system call,
275		SFS_4ARGS (2) if you have a four-argument statfs(2)
276		system call (and the include file is <sys/statfs.h>),
277		SFS_VFS (3), SFS_MOUNT (4), SFS_STATFS (5) if you have
278		the two-argument statfs(2) system call with includes in
279		<sys/vfs.h>, <sys/mount.h>, or <sys/statfs.h> respectively,
280		or SFS_STATVFS (6) if you have the two-argument statvfs(2)
281		call.  The default if nothing is defined is SFS_NONE.
282ERRLIST_PREDEFINED
283		If set, assumes that some header file defines sys_errlist.
284		This may be needed if you get type conflicts on this
285		variable -- otherwise don't worry about it.
286WAITUNION	The wait(2) routine takes a "union wait" argument instead
287		of an integer argument.  This is for compatibility with
288		old versions of BSD.
289SCANF		You can set this to extend the F command to accept a
290		scanf string -- this gives you a primitive parser for
291		class definitions -- BUT it can make you vulnerable to
292		core dumps if the target file is poorly formed.
293SYSLOG_BUFSIZE	You can define this to be the size of the buffer that
294		syslog accepts.  If it is not defined, it assumes a
295		1024-byte buffer.  If the buffer is very small (under
296		256 bytes) the log message format changes -- each
297		e-mail message will log many more messages, since it
298		will log each piece of information as a separate line
299		in syslog.
300BROKEN_RES_SEARCH
301		On Ultrix (and maybe other systems?) if you use the
302		res_search routine with an unknown host name, it returns
303		-1 but sets h_errno to 0 instead of HOST_NOT_FOUND.  If
304		you set this, sendmail considers 0 to be the same as
305		HOST_NOT_FOUND.
306
307
308+-----------------------+
309| COMPILE-TIME FEATURES |
310+-----------------------+
311
312There are a bunch of features that you can decide to compile in, such
313as selecting various database packages and special protocol support.
314Several are assumed based on other compilation flags -- if you want to
315"un-assume" something, you probably need to edit conf.h.  Compilation
316flags that add support for special features include:
317
318NDBM		Include support for "new" DBM library for aliases and maps.
319		Normally defined in the Makefile.
320NEWDB		Include support for Berkeley "db" package (hash & btree)
321		for aliases and maps.  Normally defined in the Makefile.
322OLD_NEWDB	If non-zero, the version of NEWDB you have is the old
323		one that does not include the "fd" call.  This call was
324		added in version 1.5 of the Berkeley DB code.  If you
325		use -DOLD_NEWDB=0 it forces you to use the new interface.
326NIS		Define this to get NIS (YP) support for aliases and maps.
327		Normally defined in the Makefile.
328USERDB		Include support for the User Information Database.  Implied
329		by NEWDB in conf.h.
330IDENTPROTO	Define this as 1 to get IDENT (RFC 1413) protocol support.
331		This is assumed unless you are running on Ultrix or
332		HP-UX, both of which have a problem in the UDP
333		implementation.  You can define it to be 0 to explicitly
334		turn off IDENT protocol support.
335MIME		Include support for MIME-encapsulated error messages.
336LOG		Set this to get syslog(3) support.  Defined by default
337		in conf.h.  You want this if at all possible.
338NETINET		Set this to get TCP/IP support.  Defined by default
339		in conf.h.  You probably want this.
340NETISO		Define this to get ISO networking support.
341SMTP		Define this to get the SMTP code.  Implied by NETINET
342		or NETISO.
343NAMED_BIND	Define this to get DNS (name daemon) support, including
344		MX support.  The specs you must use this if you run
345		SMTP.  Defined by default in conf.h.
346QUEUE		Define this to get queueing code.  Implied by NETINET
347		or NETISO; required by SMTP.  This gives you other good
348		stuff -- it should be on.
349DAEMON		Define this to get general network support.  Implied by
350		NETINET or NETISO.  Defined by default in conf.h.  You
351		almost certainly want it on.
352MATCHGECOS	Permit fuzzy matching of user names against the full
353		name (GECOS) field in the /etc/passwd file.  This should
354		probably be on, since you can disable it from the config
355		file if you want to.  Defined by default in conf.h.
356SETPROCTITLE	Try to set the string printed by "ps" to something
357		informative about what sendmail is doing.  Defined by
358		default in conf.h.
359
360
361+---------------------+
362| DNS/RESOLVER ISSUES |
363+---------------------+
364
365Many systems have old versions of the resolver library.  At a minimum,
366you should be running BIND 4.8.3; older versions may compile, but they
367have known bugs that should give you pause.
368
369Common problems in old versions include "undefined" errors for
370dn_skipname.
371
372Some people have had a problem with BIND 4.9; it uses some routines
373that it expects to be externally defined such as strerror().  It may
374help to link with "-l44bsd" to solve this problem.
375
376!PLEASE! be sure to link with the same version of the resolver as
377the header files you used -- some people have used the 4.9 headers
378and linked with BIND 4.8 or vice versa, and it doesn't work.
379Unfortunately, it doesn't fail in an obvious way -- things just
380subtly don't work.
381
382
383+-------------------------------------+
384| OPERATING SYSTEM AND COMPILE QUIRKS |
385+-------------------------------------+
386
387GCC 2.5.x problems  *** IMPORTANT ***
388	Date: Mon, 29 Nov 93 19:08:44 PST
389	From: wilson@cygnus.com (Jim Wilson)
390	Message-Id: <9311300308.AA04608@cygnus.com>
391	To: kenner@vlsi1.ultra.nyu.edu
392	Subject: [cattelan@thebarn.com: gcc 2.5.4-2.5.5 -O bug]
393	Cc: cattelan@thebarn.com, rms@gnu.ai.mit.edu, sendmail@cs.berkeley.edu
394
395	This fixes a problem that occurs when gcc 2.5.5 is used to compile
396	sendmail 8.6.4 with optimization on a sparc.
397
398	Mon Nov 29 19:00:14 1993  Jim Wilson  (wilson@sphagnum.cygnus.com)
399
400		* reload.c (find_reloads_toplev): Replace obsolete reference to
401		BYTE_LOADS_*_EXTEND with LOAD_EXTEND_OP.
402
403	*** clean-ss-931128/reload.c    Sun Nov 14 16:20:01 1993
404	--- ss-931128/reload.c  Mon Nov 29 18:52:55 1993
405	*************** find_reloads_toplev (x, opnum, type, ind
406	*** 3888,3894 ****
407		 force a reload in that case.  So we should not do anything here.  */
408
409		else if (regno >= FIRST_PSEUDO_REGISTER
410	! #if defined(BYTE_LOADS_ZERO_EXTEND) || defined(BYTE_LOADS_SIGN_EXTEND)
411		       && (GET_MODE_SIZE (GET_MODE (x))
412			   <= GET_MODE_SIZE (GET_MODE (SUBREG_REG (x))))
413	  #endif
414	--- 3888,3894 ----
415		 force a reload in that case.  So we should not do anything here.  */
416
417		else if (regno >= FIRST_PSEUDO_REGISTER
418	! #ifdef LOAD_EXTEND_OP
419		       && (GET_MODE_SIZE (GET_MODE (x))
420			   <= GET_MODE_SIZE (GET_MODE (SUBREG_REG (x))))
421	  #endif
422
423
424SunOS 4.x (Solaris 1.x)
425	You may have to use -lresolv on SunOS.  However, beware that
426	this links in a new version of gethostbyname that does not
427	understand NIS, so you must have all of your hosts in DNS.
428
429	Some people have reported problems with the SunOS version of
430	-lresolv and/or in.named, and suggest that you get a newer
431	version.  The symptoms are delays when you connect to the
432	SMTP server on a SunOS machine or having your domain added to
433	addresses inappropriately.  There is a version of BIND
434	version 4.9 on gatekeeper.DEC.COM in pub/BSD/bind/4.9.
435
436	There is substantial disagreement about whether you can make
437	this work with resolv+, which allows you to specify a search-path
438	of services.  Some people report that it works fine, others
439	claim it doesn't work at all (including causing sendmail to
440	drop core when it tries to do multiple resolv+ lookups for a
441	single job).  I haven't tried resolv+, as we use DNS exclusively.
442
443	Should you want to try resolv+, it is on ftp.uu.net in
444	/networking/ip/dns.
445
446	Apparently getservbyname() can fail under moderate to high
447	load under some circumstances.  This will exhibit itself as
448	the message ``554 makeconnection: service "smtp" unknown''.
449	The problem has been traced to one or more blank lines in
450	/etc/services on the NIS server machine.  Delete these
451	and it should work.  This info is thanks to Brian Bartholomew
452	<bb@math.ufl.edu> of I-Kinetics, Inc.
453
454Solaris 2.x (SunOS 5.x)
455	To compile for Solaris, be sure you use -DSOLARIS.
456
457	To the best of my knowledge, Solaris does not have the
458	gethostbyname problem described above.  However, it does
459	have another one:
460
461	From a correspondent:
462
463	   For solaris 2.2, I have
464
465		hosts:      files dns
466
467	   in /etc/nsswitch.conf and /etc/hosts has to have the fully
468	   qualified host name. I think "files" has to be before "dns"
469	   in /etc/nsswitch.conf during bootup.
470
471	From another correspondent:
472
473	   When running sendmail under Solaris, the gethostbyname()
474	   hack in conf.c which should perform proper canonicalization
475	   of host names could fail.  Result: the host name is not
476	   canonicalized despite the hack, and you'll have to define $j
477	   and $m in sendmail.cf somewhere.
478
479	   The reason could be that /etc/nsswitch.conf is improperly
480	   configured (at least from sendmail's point of view).  For
481	   example, the line
482
483		hosts:      files nisplus dns
484
485	   will make gethostbyname() look in /etc/hosts first, then ask
486	   nisplus, then dns.  However, if /etc/hosts does not contain
487	   the full canonicalized hostname, then no amount of
488	   gethostbyname()s will work.
489
490	   Solution (or rather, a workaround): Ask nisplus first, then
491	   dns, then local files:
492
493		hosts:      nisplus dns [NOTFOUND=return] files
494
495	The Solaris "syslog" function is apparently limited to something
496	about 90 characters because of a kernel limitation.  If you have
497	source code, you can probably up this number.  You can get patches
498	that fix this problem: the patch ids are:
499
500		Solaris 2.1	100834
501		Solaris 2.2	100999
502		Solaris 2.3	101318
503
504	Be sure you have the appropriate patch installed or you won't
505	see system logging.
506
507OSF/1
508	If you are compiling on OSF/1 (DEC Alpha), you must use
509	-L/usr/shlib (otherwise it core dumps on startup).  You may also
510	need -mld to get the nlist() function, although some versions
511	apparently don't need this.
512
513	Also, the enclosed makefile removed /usr/sbin/smtpd; if you need
514	it, just create the link to the sendmail binary.
515
516IRIX
517	The header files on SGI IRIX are completely prototyped, and as
518	a result you can sometimes get some warning messages during
519	compilation.  These can be ignored.  There are two errors in
520	deliver only if you are using gcc, both of the form ``warning:
521	passing arg N of `execve' from incompatible pointer type''.
522	Also, if you compile with -DNIS, you will get a complaint
523	about a declaration of struct dom_binding in a prototype
524	when compiling map.c; this is not important because the
525	function being prototyped is not used in that file.
526
527NeXT
528	If you are compiling on NeXT, you will have to create an empty
529	file "unistd.h" and create a file "dirent.h" containing:
530
531		#include <sys/dir.h>
532		#define dirent	direct
533
534	(The Makefile.NeXT should try to do both of these for you.)
535
536	Apparently, there is a bug in getservbyname on Nextstep 3.0
537	that causes it to fail under some circumstances with the
538	message "SYSERR: service "smtp" unknown" logged.  You should
539	be able to work around this by including the line:
540
541		OOPort=25
542
543	in your .cf file.
544
545	You may have to use -DNeXT.
546
547BSDI (BSD/386) 1.0, NetBSD 0.9, FreeBSD 1.0
548	The "m4" from BSDI won't handle the config files properly.
549	I haven't had a chance to test this myself.
550
551	The M4 shipped in FreeBSD and NetBSD 0.9 don't handle the config
552	files properly. One must use either GNU m4 1.1 or the PD-M4
553	recently posted in comp.os.386bsd.bugs (and maybe others).
554	NetBSD-current includes the PD-M4 (as stated in the NetBSD file
555	CHANGES).
556
557	FreeBSD 1.0 RELEASE has uname(2) now. Use -DUSEUNAME in order to
558	use it (look into Makefile.FreeBSD). NetBSD-current may have
559	it too but it has not been verified.
560
561	You cannot port the latest version of the Berkeley db library
562	and use it with sendmail without recompiling the world.  This
563	is because C library routines use the older version which have
564	incompatible header files -- the result is that it can't read
565	other system files, such as /etc/passwd, unless you use the
566	new db format throughout your system.  You should normally just
567	use the version of db supplied in your release.  You may need
568	to use -DOLD_NEWDB=1 to make this work -- this turns off some
569	new interface calls (for file locking) that are not in older
570	versions of db.  You'll get compile errors if you need this
571	flag and don't have it set.
572
5734.3BSD
574	If you are running a "virgin" version of 4.3BSD, you'll have
575	a very old resolver and be missing some header files.  The
576	header files are simple -- create empty versions and everything
577	will work fine.  For the resolver you should really port a new
578	version (4.8.3 or later) of the resolver; 4.9 is available on
579	gatekeeper.DEC.COM in pub/BSD/bind/4.9.  If you are really
580	determined to continue to use your old, buggy version (or as
581	a shortcut to get sendmail working -- I'm sure you have the
582	best intentions to port a modern version of BIND), you can
583	copy ../contrib/oldbind.compat.c into src and add
584	oldbind.compat.o to OBJADD in the Makefile.
585
586A/UX
587	Date: Tue, 12 Oct 1993 18:28:28 -0400 (EDT)
588	From: "Eric C. Hagberg" <hagberg@med.cornell.edu>
589	Subject: Fix for A/UX ndbm
590
591	I guess this isn't really a sendmail bug, however, it is something
592	that A/UX users should be aware of when compiling sendmail 8.6.
593
594	Apparently, the calls that sendmail is using to the ndbm routines
595	in A/UX 3.0.x contain calls to "broken" routines, in that the
596	aliases database will break when it gets "just a little big"
597	(sorry I don't have exact numbers here, but it broke somewhere
598	around 20-25 aliases for me.), making all aliases non-functional
599	after exceeding this point.
600
601	What I did was to get the gnu-dbm-1.6 package, compile it, and
602	then re-compile sendmail with "-lgdbm", "-DNDBM", and using the
603	ndbm.h header file that comes with the gnu-package. This makes
604	things behave properly.
605
606	I suppose porting the New Berkeley db package is another route,
607	however, I made a quick attempt at it, and found it difficult
608	(not easy at least); the gnu-dbm package "configured" and
609	compiled easily.
610
611DG/UX
612	Apparently, /bin/mail doesn't work properly for delivery on
613	DG/UX -- the person who has this working, Douglas Anderson
614	<dlander@afterlife.ncsc.mil>, used procmail instead.
615
616Apollo DomainOS
617	If you are compiling on Apollo, you will have to create an empty
618	file "unistd.h" and create a file "dirent.h" containing:
619
620		#include <sys/dir.h>
621		#define dirent	direct
622
623	(The Makefile.DomainOS will attempt to do both of these for you.)
624
625HP-UX 8.00
626	Date: Mon, 24 Jan 1994 13:25:45 +0200
627	From: Kimmo Suominen <Kimmo.Suominen@lut.fi>
628	Subject: 8.6.5 w/ HP-UX 8.00 on s300
629
630	Just compiled and fought with sendmail 8.6.5 on a HP9000/360 (ie. a
631	series 300 machine) running HP-UX 8.00.
632
633	I was getting segmentation fault when delivering to a local user.
634	With debugging I saw it was faulting when doing _free@libc... *sigh*
635	It seems the new implementation of malloc on s300 is buggy as of 8.0,
636	so I tried out the one in -lmalloc (malloc(3X)).  With that it seems
637	to work just dandy.
638
639	When linking, you will get the following error:
640
641	ld: multiply defined symbol _freespace in file /usr/lib/libmalloc.a
642
643	but you can just ignore it.  You might want to add this info to the
644	README file for the future...
645
646Linux
647	Something broke between versions 0.99.13 and 0.99.14 of Linux:
648	the flock() system call gives errors.  If you are running .14,
649	you must not use flock.  You can do this with -DHASFLOCK=0.
650
651AIX
652	This version of sendmail does not support MB, MG, and MR resource
653	records, which are supported by AIX sendmail.
654
655RISC/os
656	RISC/os from MIPS is a merged AT&T/Berkeley system.  When you
657	compile on that platform you will get duplicate definitions
658	on many files.  You can ignore these.
659
660System V Release 4 Based Systems
661	There is a single Makefile that is intended for all SVR4-based
662	systems (called Makefile.SVR4).  It defines __svr4__, which is
663	predefined by some compilers.  If your compiler already defines
664	this compile variable, you can delete the definition from the
665	Makefile.
666
667	It's been tested on Dell Issue 2.2.
668
669DELL SVR4
670	Date:      Mon, 06 Dec 1993 10:42:29 EST
671	From: "Kimmo Suominen" <kim@grendel.lut.fi>
672	Message-ID: <2d0352f9.lento29@lento29.UUCP>
673	To: eric@cs.berkeley.edu
674	Cc: sendmail@cs.berkeley.edu
675	Subject:   Notes for DELL SVR4
676
677	Eric,
678
679	Here are some notes for compiling Sendmail 8.6.4 on DELL SVR4.  I ran
680	across these things when helping out some people who contacted me by
681	e-mail.
682
683	1) Use gcc 2.4.5 (or later?).  Dell distributes gcc 2.1 with their
684	   Issue 2.2 Unix.  It is too old, and gives you problems with
685	   clock.c, because sigset_t won't get defined in <sys/signal.h>.
686	   This is due to a problematic protection rule in there, and is
687	   fixed with gcc 2.4.5.
688
689	2) If you don't use the new Berkeley DB (-DNEWDB), then you need
690	   to add "-lc -lucb" to the libraries to link with.  This is because
691	   the -ldbm distributed by Dell needs the bcopy, bcmp and bzero
692	   functions.  It is important that you specify both libraries in
693	   the given order to be sure you only get the BSTRING functions
694	   from the UCB library (and not the signal routines etc.).
695
696	3) Don't leave out "-lelf" even if compiling with "-lc -lucb".
697	   The UCB library also has another copy of the nlist routines,
698	   but we do want the ones from "-lelf".
699
700	If anyone needs a compiled gcc 2.4.5 and/or a ported DB library, they
701	can use anonymous ftp to fetch them from lut.fi in the /kim directory.
702	They are copies of what I use on grendel.lut.fi, and offering them
703	does not imply that I would also support them.  I have sent the DB
704	port for SVR4 back to Keith Bostic for inclusion in the official
705	distribution, but I haven't heard anything from him as of today.
706
707	- gcc-2.4.5-svr4.tar.gz	(gcc 2.4.5 and the corresponding libg++)
708	- db-1.72.tar.gz	(with source, objects and a installed copy)
709
710	Cheers
711	+ Kim
712	--
713	 *  Kimmo.Suominen@lut.fi  *  SysVr4 enthusiast at GRENDEL.LUT.FI  *
714	*    KIM@FINFILES.BITNET   *  Postmaster and Hostmaster at LUT.FI   *
715	 *    + 358 200 865 718    *  Unix area moderator at NIC.FUNET.FI  *
716
717ConvexOS 10.1 and below
718	In order to use the name server, you must create the file
719	/etc/use_nameserver.  If this file does not exist, the call
720	to res_init() will fail and you will have absolutely no
721	access to DNS, including MX records.
722
723Non-DNS based sites
724	This version of sendmail always tries to connect to the Domain
725	Name System (DNS) to resolve names, regardless of the setting
726	of the `I' option.  On most systems that are not running DNS,
727	this will fail quickly and sendmail will continue, but on some
728	systems it has a long timeout.  If you have this problem, you
729	will have to recompile without NAMED_BIND.  Some people have
730	claimed that they have successfully used "OI+USEVC" to force
731	sendmail to use a virtual circuit -- this will always time out
732	quickly, but also tells sendmail that a failed connection
733	should requeue the message (probably not what you intended).
734	A future release of sendmail will correct this problem.
735
736Both NEWDB and NDBM
737	If you use both -DNDBM and -DNEWDB, you must delete the module
738	ndbm.o from libdb.a and delete the file "ndbm.h" from the files
739	that get installed (that is, use the OLD ndbm.h, not the new
740	ndbm.h).  This compatibility module maps ndbm calls into DB
741	calls, and breaks things rather badly.
742
743GNU getopt
744	I'm told that GNU getopt has a problem in that it gets confused
745	by the double call.  Use the version in conf.c instead.
746
747BIND 4.9.2 and Ultrix
748	If you are running on Ultrix, be sure you read conf/Info.Ultrix
749	in the BIND distribution very carefully -- there is information
750	in there that you need to know in order to avoid errors of the
751	form:
752
753		/lib/libc.a(gethostent.o): sethostent: multiply defined
754		/lib/libc.a(gethostent.o): endhostent: multiply defined
755		/lib/libc.a(gethostent.o): gethostbyname: multiply defined
756		/lib/libc.a(gethostent.o): gethostbyaddr: multiply defined
757
758	during the link stage.
759
760
761+--------------+
762| MANUAL PAGES |
763+--------------+
764
765The manual pages have been written against the -mandoc macros
766instead of the -man macros.  The latest version of groff has them
767included.  You can also get a copy from FTP.UU.NET in directory
768/systems/unix/bsd-sources/share/tmac.
769
770
771+-----------------+
772| DEBUGGING HOOKS |
773+-----------------+
774
775As of 8.6.5, sendmail daemons will catch a SIGUSR1 signal and log
776some debugging output (logged at LOG_DEBUG severity).  The
777information dumped is:
778
779 * The value of the $j macro.
780 * A warning if $j is not in the set $=w.
781 * A list of the open file descriptors.
782 * The contents of the connection cache.
783 * If ruleset 89 is defined, it is evaluated and the results printed.
784
785This allows you to get information regarding the runtime state of the
786daemon on the fly.  This should not be done too frequently, since
787the process of rewriting may lose memory which will not be recovered.
788Also, ruleset 89 may call non-reentrant routines, so there is a small
789non-zero probability that this will cause other problems.  It is
790really only for debugging serious problems.
791
792A typical formulation of ruleset 89 would be:
793
794	R$*		$@ $>0 some test address
795
796
797+-----------------------------+
798| DESCRIPTION OF SOURCE FILES |
799+-----------------------------+
800
801The following list describes the files in this directory:
802
803Makefile	The makefile used here; this version only works with
804		the new Berkeley make.
805Makefile.dist	A trimmed down version of the makefile that works with
806		the old make.
807READ_ME		This file.
808TRACEFLAGS	My own personal list of the trace flags -- not guaranteed
809		to be particularly up to date.
810alias.c		Does name aliasing in all forms.
811arpadate.c	A subroutine which creates ARPANET standard dates.
812clock.c		Routines to implement real-time oriented functions
813		in sendmail -- e.g., timeouts.
814collect.c	The routine that actually reads the mail into a temp
815		file.  It also does a certain amount of parsing of
816		the header, etc.
817conf.c		The configuration file.  This contains information
818		that is presumed to be quite static and non-
819		controversial, or code compiled in for efficiency
820		reasons.  Most of the configuration is in sendmail.cf.
821conf.h		Configuration that must be known everywhere.
822convtime.c	A routine to sanely process times.
823daemon.c	Routines to implement daemon mode.  This version is
824		specifically for Berkeley 4.1 IPC.
825deliver.c	Routines to deliver mail.
826domain.c	Routines that interface with DNS (the Domain Name
827		System).
828err.c		Routines to print error messages.
829envelope.c	Routines to manipulate the envelope structure.
830headers.c	Routines to process message headers.
831macro.c		The macro expander.  This is used internally to
832		insert information from the configuration file.
833main.c		The main routine to sendmail.  This file also
834		contains some miscellaneous routines.
835map.c		Support for database maps.
836mci.c		Routines that handle mail connection information caching.
837parseaddr.c	The routines which do address parsing.
838queue.c		Routines to implement message queueing.
839readcf.c	The routine that reads the configuration file and
840		translates it to internal form.
841recipient.c	Routines that manipulate the recipient list.
842savemail.c	Routines which save the letter on processing errors.
843sendmail.h	Main header file for sendmail.
844srvrsmtp.c	Routines to implement server SMTP.
845stab.c		Routines to manage the symbol table.
846stats.c		Routines to collect and post the statistics.
847sysexits.c	List of error messages associated with error codes
848		in sysexits.h.
849trace.c		The trace package.  These routines allow setting and
850		testing of trace flags with a high granularity.
851udb.c		The user database interface module.
852usersmtp.c	Routines to implement user SMTP.
853util.c		Some general purpose routines used by sendmail.
854version.c	The version number and information about this
855		version of sendmail.  Theoretically, this gets
856		modified on every change.
857
858Eric Allman
859
860(Version 8.64, last update 05/29/94 13:08:35)
861