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