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