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