xref: /csrg-svn/usr.sbin/sendmail/cf/README (revision 68845)
151220Seric
251220Seric
357246Seric		NEW SENDMAIL CONFIGURATION FILES
451220Seric
557246Seric		Eric Allman <eric@CS.Berkeley.EDU>
651220Seric
7*68845Seric		@(#)README	8.54 (Berkeley) 04/21/95
851220Seric
951220Seric
1057246SericThis document describes the sendmail configuration files being used
1167469Sericat Berkeley.  These use features in the new (R8) sendmail; they will
1267469Sericnot work on other versions.
1351220Seric
1457246SericThese configuration files are probably not as general as previous
1565957Sericversions, and don't handle as many of the weird cases automagically.
1657246SericI was able to simplify by them for two reasons.  First, the network
1757246Serichas become more consistent -- for example, at this point, everyone
1857246Sericon the internet is supposed to be running a name server, so hacks to
1957246Serichandle NIC-registered hosts can go away.  Second, I assumed that a
2057246Sericsubdomain would be running SMTP internally -- UUCP is presumed to be
2157246Serica long-haul protocol.  I realize that this is not universal, but it
2257246Sericdoes describe the vast majority of sites with which I am familiar,
2357246Sericincluding those outside the US.
2451220Seric
2565957SericOf course, the downside of this is that if you do live in a weird
2665957Sericworld, things are going to get weirder for you.  I'm sorry about that,
2757246Sericbut at the time we at Berkeley had a problem, and it seemed like the
2857246Sericright thing to do.
2951220Seric
3057247SericThis package requires a post-V7 version of m4; if you are running the
3157247Seric4.2bsd, SysV.2, or 7th Edition version, I suggest finding a friend with
3257247Serica newer version.  You can m4-expand on their system, then run locally.
3365002SericSunOS's /usr/5bin/m4 or BSD-Net/2's m4 both work.  GNU m4 version 1.1
3465002Sericalso works.  Unfortunately, I'm told that the M4 on BSDI 1.0 doesn't
3565002Sericwork -- you'll have to use a Net/2 or GNU version.
3651220Seric
3758284SericIF YOU DON'T HAVE A BERKELEY MAKE, don't despair!  Just run
3864371Seric"m4 foo.mc > foo.cf" -- that should be all you need.  There is also
3964371Serica fairly crude (but functional) Makefile.dist that works on the
4064371Sericold version of make.
4158284Seric
4258284SericTo get started, you may want to look at tcpproto.mc (for TCP-only
4364324Sericsites), uucpproto.mc (for UUCP-only sites), and clientproto.mc (for
4464324Sericclusters of clients using a single mail host).  Others are versions
4558284Sericthat we use at Berkeley, although not all are in current use.  For
4658284Sericexample, ucbarpa has gone away, but I've left ucbarpa.mc in because
4758284Sericit demonstrates some interesting techniques.
4858284Seric
4957246SericI'm not pretending that this README describes everything that these
5057246Sericconfiguration files can do; clever people can probably tweak them
5157246Sericto great effect.  But it should get you started.
5257246Seric
5365509Seric*******************************************************************
5465509Seric***  BE SURE YOU CUSTOMIZE THESE FILES!  They have some		***
5565509Seric***  Berkeley-specific assumptions built in, such as the name	***
5665509Seric***  of our UUCP-relay.  You'll want to create your own domain	***
5765509Seric***  description, and use that in place of domain/Berkeley.m4.	***
5865509Seric*******************************************************************
5958087Seric
6065509Seric
6157246Seric+--------------------------+
6257246Seric| INTRODUCTION AND EXAMPLE |
6357246Seric+--------------------------+
6457246Seric
6557246SericConfiguration files are contained in the subdirectory "cf", with a
6657246Sericsuffix ".mc".  They must be run through "m4" to produce a ".cf" file.
6757246Seric
68*68845SericLet's examine a typical .mc file (cf/cs-hpux9.mc):
6951220Seric
7051220Seric	divert(-1)
7151220Seric	#
7251220Seric	# Copyright (c) 1983 Eric P. Allman
73*68845Seric	# Copyright (c) 1988, 1993
74*68845Seric	#	The Regents of the University of California.  All rights reserved.
7551220Seric	#
76*68845Seric	# Redistribution and use in source and binary forms, with or without
77*68845Seric	# modification, are permitted provided that the following conditions
78*68845Seric	# are met:
79*68845Seric	# 1. Redistributions of source code must retain the above copyright
80*68845Seric	#    notice, this list of conditions and the following disclaimer.
81*68845Seric	# 2. Redistributions in binary form must reproduce the above copyright
82*68845Seric	#    notice, this list of conditions and the following disclaimer in
83*68845Seric	#    the documentation and/or other materials provided with the
84*68845Seric	#    distribution.
85*68845Seric	# 3. All advertising materials mentioning features or use of this
86*68845Seric	#    software #    must display the following acknowledgement:
87*68845Seric	#	This product includes software developed by the University of
88*68845Seric	#	California, Berkeley and its contributors.
89*68845Seric	# 4. Neither the name of the University nor the names of its
90*68845Seric	#    contributors may be used to endorse or promote products derived
91*68845Seric	#    from this software without specific prior written permission.
9251220Seric	#
93*68845Seric	# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS''
94*68845Seric	# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
95*68845Seric	# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
96*68845Seric	# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS
97*68845Seric	# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
98*68845Seric	# OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
99*68845Seric	# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
100*68845Seric	# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
101*68845Seric	# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
102*68845Seric	# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
103*68845Seric	# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
104*68845Seric	#
10551220Seric
106*68845Seric	#
107*68845Seric	#  This is a Berkeley-specific configuration file for HP-UX 9.x.
108*68845Seric	#  It applies only the the Computer Science Division at Berkeley,
109*68845Seric	#  and should not be used elsewhere.   It is provided on the sendmail
110*68845Seric	#  distribution as a sample only.  To create your own configuration
111*68845Seric	#  file, create an appropriate domain file in ../domain, change the
112*68845Seric	#  `DOMAIN' macro below to reference that file, and copy the result
113*68845Seric	#  to a name of your own choosing.
114*68845Seric	#
115*68845Seric
11657246SericThe divert(-1) will delete the crud in the resulting output file.
117*68845SericThe copyright notice can be replace by whatever your lawyers require;
118*68845Sericour lawyers require the one that I've included in my files.  A copyleft
119*68845Sericis a copyright by another name.
12051220Seric
12157246SericThe next line MUST be
12257246Seric
12351220Seric	include(`../m4/cf.m4')
12451220Seric
12557246SericThis will pull in the M4 macros you will need to make sense of
12657246Sericeverything else.  As the saying goes, don't think about it, just
12757246Sericdo it.  If you don't do it, don't bother reading the rest of this
12857246Sericfile.
12951220Seric
13056778Seric	VERSIONID(`<SCCS or RCS version id>')
13151220Seric
13251220SericVERSIONID is a macro that stuffs the version information into the
13351220Sericresulting file.  We use SCCS; you could use RCS, something else, or
13457246Sericomit it completely.  This is not the same as the version id included
13557246Sericin SMTP greeting messages -- this is defined in m4/version.m4.
13651220Seric
137*68845Seric	OSTYPE(hpux9)dnl
13851220Seric
139*68845SericYou must specify an OSTYPE to properly configure things such as the
140*68845Sericpathname of the help and status files, the flags needed for the local
141*68845Sericmailer, and other important things.  If you omit it, you will get an
142*68845Sericerror when you try to build the configuration.  Look at the ostype
143*68845Sericdirectory for the list of known operating system types.
14451220Seric
145*68845Seric	DOMAIN(CS.Berkeley.EDU)dnl
146*68845Seric
147*68845SericThis example is specific to the Computer Science Division at Berkeley.
148*68845SericYou can use "DOMAIN(generic)" to get a sufficiently bland definition
149*68845Sericthat may well work for you, or you can create a customized domain
150*68845Sericdefinition appropriate for your environment.
151*68845Seric
152*68845Seric	MAILER(local)
15351268Seric	MAILER(smtp)
15451220Seric
15551309SericThese describe the mailers used at the default CS site site.  The
15651309Sericlocal mailer is always included automatically.
15751220Seric
15858087Seric
15957246Seric+--------+
16057246Seric| OSTYPE |
16157246Seric+--------+
16257246Seric
163*68845SericYou MUST define an operating system environment, or the configuration
164*68845Sericfile build will puke.  There are several environments available; look
165*68845Sericat the "ostype" directory for the current list.  This macro changes
166*68845Sericthings like the location of the alias file and queue directory.  Some
167*68845Sericof these files are identical to one another.
16851220Seric
169*68845SericOperating system definitions are usually easy to write.  They may define
170*68845Sericthe following variables (everything defaults, so an ostype file may be
171*68845Sericempty).  Unfortunately, the list of configuration-supported systems is
172*68845Sericnot as broad as the list of source-supported systems, since many of
173*68845Sericthe source contributors do not include corresponding ostype files.
17451220Seric
17557246SericALIAS_FILE		[/etc/aliases] The location of the text version
17659761Seric			of the alias file(s).  It can be a comma-separated
17766790Seric			list of names (but be sure you quote values with
17868452Seric			commas in them -- for example, use
17966790Seric				define(`ALIAS_FILE', `a,b')
18066790Seric			to get "a" and "b" both listed as alias files;
18166790Seric			otherwise the define() primitive only sees "a").
18257246SericHELP_FILE		[/usr/lib/sendmail.hf] The name of the file
18357246Seric			containing information printed in response to
18457246Seric			the SMTP HELP command.
18557246SericQUEUE_DIR		[/var/spool/mqueue] The directory containing
18657246Seric			queue files.
18757246SericSTATUS_FILE		[/etc/sendmail.st] The file containing status
18857246Seric			information.
18958087SericLOCAL_MAILER_PATH	[/bin/mail] The program used to deliver local mail.
19064153SericLOCAL_MAILER_FLAGS	[rmn] The flags used by the local mailer.  The
19164153Seric			flags lsDFM are always included.
19263761SericLOCAL_MAILER_ARGS	[mail -d $u] The arguments passed to deliver local
19363761Seric			mail.
19468340SericLOCAL_MAILER_MAX	[undefined] If defined, the maximum size of local
19568340Seric			mail that you are willing to accept.
19658087SericLOCAL_SHELL_PATH	[/bin/sh] The shell used to deliver piped email.
19763791SericLOCAL_SHELL_FLAGS	[eu] The flags used by the shell mailer.  The
19863791Seric			flags lsDFM are always included.
19963791SericLOCAL_SHELL_ARGS	[sh -c $u] The arguments passed to deliver "prog"
20063791Seric			mail.
20167989SericLOCAL_SHELL_DIR		[$z:/] The directory search path in which the
20267989Seric			shell should run.
20358087SericUSENET_MAILER_PATH	[/usr/lib/news/inews] The name of the program
20458087Seric			used to submit news.
20558087SericUSENET_MAILER_FLAGS	[rlsDFMmn] The mailer flags for the usenet mailer.
20658087SericUSENET_MAILER_ARGS	[-m -h -n] The command line arguments for the
20758087Seric			usenet mailer.
20865911SericUSENET_MAILER_MAX	[100000] The maximum size of messages that will
20965911Seric			be accepted by the usenet mailer.
21063857SericSMTP_MAILER_FLAGS	[undefined] Flags added to SMTP mailer.  Default
21167915Seric			flags are `mDFMUX' for all SMTP-based mailers; the
21267915Seric			"esmtp" mailer adds `a' and "smtp8" adds `8'.
21365911SericSMTP_MAILER_MAX		[undefined] The maximum size of messages that will
21467915Seric			be transported using the smtp, smtp8, or esmtp
21567915Seric			mailers.
21667915SericSMTP_MAILER_ARGS	[IPC $h] The arguments passed to the smtp mailer.
21767915Seric			About the only reason you would want to change this
21867915Seric			would be to change the default port.
21967915SericESMTP_MAILER_ARGS	[IPC $h] The arguments passed to the esmtp mailer.
22067915SericSMTP8_MAILER_ARGS	[IPC $h] The arguments passed to the smtp8 mailer.
22167915SericRELAY_MAILER_ARGS	[IPC $h] The arguments passed to the relay mailer.
22263857SericUUCP_MAILER_FLAGS	[undefined] Flags added to UUCP mailer.  Default
22368694Seric			flags are `DFMhuU' (and `m' for uucp-new mailer,
22468694Seric			minus `U' for uucp-dom mailer).
22568057SericUUCP_MAILER_ARGS	[uux - -r -z -a$g -gC $h!rmail ($u)] The arguments
22663761Seric			passed to the UUCP mailer.
22763791SericUUCP_MAX_SIZE		[100000] The maximum size message accepted for
22863791Seric			transmission by the UUCP mailers.
22965911SericFAX_MAILER_PATH		[/usr/local/lib/fax/mailfax] The program used to
23065911Seric			submit FAX messages.
23165911SericFAX_MAILER_MAX		[100000] The maximum size message accepted for
23265911Seric			transmission by FAX.
23367934SericPOP_MAILER_PATH		[/usr/lib/mh/spop] The pathname of the POP mailer.
23467934SericPOP_MAILER_FLAGS	[Penu] Flags added to POP mailer.  Flags "lsDFM"
23567934Seric			are always added.
23667934SericPOP_MAILER_ARGS		[pop $u] The arguments passed to the POP mailer.
23767942SericPROCMAIL_MAILER_FLAGS	[Shu] Flags added to Procmail mailer.  Flags
23867942Seric			``DFMmn'' are always set.
23967942SericPROCMAIL_MAILER_ARGS	[procmail -m $h $f $u] The arguments passed to
24067942Seric			the Procmail mailer.
24168340SericPROCMAIL_MAILER_MAX	[undefined] If set, the maximum size message that
24268340Seric			will be accepted by the procmail mailer.
24357246Seric
24457246Seric+---------+
24557246Seric| DOMAINS |
24657246Seric+---------+
24757246Seric
24857246SericYou will probably want to collect domain-dependent defines into one
24957246Sericfile, referenced by the DOMAIN macro.  For example, our Berkeley
25057246Sericdomain file includes definitions for several internal distinguished
25157246Serichosts:
25257246Seric
25357246SericUUCP_RELAY	The host that will forward UUCP-addressed email.
25457246Seric		If not defined, all UUCP sites must be directly
25564028Seric		connected.
25657246SericBITNET_RELAY	The host that will forward BITNET-addressed email.
25757246Seric		If not defined, the .BITNET pseudo-domain won't work.
25868697SericLOCAL_RELAY	DEPRECATED.  The site that will handle unqualified
25968697Seric		names -- that is, names with out an @domain extension.
26068697Seric		If not set, they are assumed to belong on this machine.
26168697Seric		This allows you to have a central site to store a
26257246Seric		company- or department-wide alias database.  This
26368697Seric		only works at small sites, and only with some user
26468697Seric		agents.
26567915SericLUSER_RELAY	The site that will handle lusers -- that is, apparently
26667915Seric		local names that aren't local accounts or aliases.
26757246Seric
26867915SericAny of these can be either ``mailer:hostname'' (in which case the
26968694Sericmailer is the internal mailer name, such as ``uucp-new'' and the hostname
27064028Sericis the name of the host as appropriate for that mailer) or just a
27164028Seric``hostname'', in which case a default mailer type (usually ``relay'',
27264153Serica variant on SMTP) is used.  WARNING: if you have a wildcard MX
27364153Sericrecord matching your domain, you probably want to define these to
27464153Serichave a trailing dot so that you won't get the mail diverted back
27564153Sericto yourself.
27664028Seric
27757246SericThe domain file can also be used to define a domain name, if needed
27857982Seric(using "DD<domain>") and set certain site-wide features.  If all hosts
27957982Sericat your site masquerade behind one email name, you could also use
28057982SericMASQUERADE_AS here.
28157246Seric
28258408SericYou do not have to define a domain -- in particular, if you are a
28358408Sericsingle machine sitting off somewhere, it is probably more work than
28458408Sericit's worth.  This is just a mechanism for combining "domain dependent
28558408Sericknowledge" into one place.
28658408Seric
28757246Seric+---------+
28857246Seric| MAILERS |
28957246Seric+---------+
29057246Seric
29151220SericThere are fewer mailers supported in this version than the previous
29251220Sericversion, owing mostly to a simpler world.
29351220Seric
29451220Sericlocal		The local and prog mailers.  You will almost always
29551220Seric		need these; the only exception is if you relay ALL
29657247Seric		your mail to another site.  This mailer is included
29757247Seric		automatically.
29851220Seric
29951220Sericsmtp		The Simple Mail Transport Protocol mailer.  This does
30051220Seric		not hide hosts behind a gateway or another other
30151220Seric		such hack; it assumes a world where everyone is
30263761Seric		running the name server.  This file actually defines
30367915Seric		four mailers: "smtp" for regular (old-style) SMTP to
30463761Seric		other servers, "esmtp" for extended SMTP to other
30567915Seric		servers, "smtp8" to do SMTP to other servers without
30667915Seric		converting 8-bit data to MIME (essentially, this is
30767915Seric		your statement that you know the other end is 8-bit
30867915Seric		clean even if it doesn't say so), and "relay" for
30967915Seric		transmission to our RELAY_HOST, LUSER_RELAY, or
31067915Seric		MAILER_HUB.
31151220Seric
31251220Sericuucp		The Unix-to-Unix Copy Program mailer.  Actually, this
31367471Seric		defines two mailers, "uucp-old" (a.k.a. "uucp") and
31467471Seric		"uucp-new" (a.k.a. "suucp").  The latter is for when you
31567471Seric		know that the UUCP mailer at the other end can handle
31667471Seric		multiple recipients in one transfer.  If the smtp mailer
31767471Seric		is also included in your configuration, two other mailers
31868694Seric		("uucp-dom" and "uucp-uudom") are also defined [warning:
31968694Seric		you MUST specify MAILER(smtp) before MAILER(uucp)].  When you
32067471Seric		include the uucp mailer, sendmail looks for all names in
32165218Seric		the $=U class and sends them to the uucp-old mailer; all
32265218Seric		names in the $=Y class are sent to uucp-new; and all
32365218Seric		names in the $=Z class are sent to uucp-uudom.  Note that
32457246Seric		this is a function of what version of rmail runs on
32557246Seric		the receiving end, and hence may be out of your control.
32665218Seric		See the section below describing UUCP mailers in more
32765218Seric		detail.
32851220Seric
32958087Sericusenet		Usenet (network news) delivery.  If this is specified,
33058087Seric		an extra rule is added to ruleset 0 that forwards all
33158087Seric		local email for users named ``group.usenet'' to the
33258087Seric		``inews'' program.  Note that this works for all groups,
33358087Seric		and may be considered a security problem.
33458087Seric
33558363Sericfax		Facsimile transmission.  This is experimental and based
33658363Seric		on Sam Leffler's FlexFAX software.  For more information,
33758363Seric		see below.
33858087Seric
33965148Sericpop		Post Office Protocol.
34058363Seric
34167942Sericprocmail	An interface to procmail (does not come with sendmail).
34267942Seric		This is designed to be used in mailertables.  For example,
34367942Seric		a common question is "how do I forward all mail for a given
34467942Seric		domain to a single person?".  If you have this mailer
34567942Seric		defined, you could set up a mailertable reading:
34667942Seric
34767942Seric			host.com	procmail:/etc/procmailrcs/host.com
34867942Seric
34967942Seric		with the file /etc/procmailrcs/host.com reading:
35067942Seric
35167942Seric			:0	# forward mail for host.com
35267942Seric			! -oi -f $1 person@other.host
35367942Seric
35467942Seric		This would arrange for (anything)@host.com to be sent
35567942Seric		to person@other.host.  Within the procmail script, $1 is
35667942Seric		the name of the sender and $2 is the name of the recipient.
35767942Seric		If you use this with FEATURE(local_procmail), the FEATURE
35867942Seric		should be listed first.
35967942Seric
36067929SericThe local mailer accepts addresses of the form "user+detail", where
36167929Sericthe "+detail" is not used for mailbox matching but is available
36267942Sericto certain local mail programs (in particular, see FEATURE(local_procmail)).
36367929SericFor example, "eric", "eric+sendmail", and "eric+sww" all indicate
36467929Sericthe same user, but additional arguments <null>, "sendmail", and "sww"
36567929Sericmay be provided for use in sorting mail.
36665148Seric
36767929Seric
36857246Seric+----------+
36957246Seric| FEATURES |
37057246Seric+----------+
37151268Seric
37257246SericSpecial features can be requested using the "FEATURE" macro.  For
37357246Sericexample, the .mc line:
37457246Seric
37557246Seric	FEATURE(use_cw_file)
37657246Seric
37757246Serictells sendmail that you want to have it read an /etc/sendmail.cw
37858782Sericfile to get values for class $=w.  The FEATURE may contain a single
37958782Sericoptional parameter -- for example:
38057246Seric
38158782Seric	FEATURE(mailertable, dbm /usr/lib/mailertable)
38258782Seric
38358782SericAvailable features are:
38458782Seric
38557246Sericuse_cw_file	Read the file /etc/sendmail.cw file to get alternate
38657246Seric		names for this host.  This might be used if you were
38757246Seric		on a host that MXed for a dynamic set of other
38857246Seric		hosts.  If the set is static, just including the line
38957246Seric		"Cw<name1> <name2> ..." is probably superior.
39058408Seric		The actual filename can be overridden by redefining
39158408Seric		confCW_FILE.
39264324Seric
39358087Sericredirect	Reject all mail addressed to "address.REDIRECT" with
39458087Seric		a ``551 User not local; please try <address>'' message.
39558087Seric		If this is set, you can alias people who have left
39658087Seric		to their new address with ".REDIRECT" appended.
39764324Seric
39858284Sericnouucp		Don't do anything special with UUCP addresses at all.
39964324Seric
40059080Sericnocanonify	Don't pass addresses to $[ ... $] for canonification.
40159080Seric		This would generally only be used by sites that only
40259080Seric		act as mail gateways or which have user agents that do
40364028Seric		full canonification themselves.  You may also want to
40464028Seric		use "define(`confBIND_OPTS',`-DNSRCH -DEFNAMES')" to
40564028Seric		turn off the usual resolver options that do a similar
40664028Seric		thing.
40764324Seric
40867917Sericstickyhost	If set, email sent to "user@local.host" are marked
40958526Seric		as "sticky" -- that is, the local addresses aren't
41058526Seric		matched against UDB and don't go through ruleset 5.
41167915Seric		This is used if you want a set up where "user" is
41267915Seric		not necessarily the same as "user@local.host", e.g.,
41367915Seric		to make a distinct domain-wide namespace.  Prior to
41467915Seric		8.7 this was the default, and notsticky was used to
41567915Seric		turn this off.
41664324Seric
41758782Sericmailertable	Include a "mailer table" which can be used to override
41858782Seric		routing for particular domains.  The argument of the
41958782Seric		FEATURE may be the key definition.  If none is specified,
42058782Seric		the definition used is:
42164164Seric			hash -o /etc/mailertable
42263761Seric		Keys in this database are fully qualified domain names
42363761Seric		or partial domains preceded by a dot -- for example,
42463761Seric		"vangogh.CS.Berkeley.EDU" or ".CS.Berkeley.EDU".
42563761Seric		Values must be of the form:
42658782Seric			mailer:domain
42763761Seric		where "mailer" is the internal mailer name, and "domain"
42863761Seric		is where to send the message.  These maps are not
42963761Seric		reflected into the message header.
43064324Seric
43163761Sericdomaintable	Include a "domain table" which can be used to provide
43267451Seric		domain name mapping.  Use of this should really be
43367451Seric		limited to your own domains.  It may be useful if you
43467451Seric		change names (e.g., your company changes names from
43567451Seric		oldname.com to newname.com).  The argument of the
43667451Seric		FEATURE may be the key definition.  If none is specified,
43767451Seric		the definition used is:
43864164Seric			hash -o /etc/domaintable
43967451Seric		The key in this table is the domain name; the value is
44067451Seric		the new (fully qualified) domain.  Anything in the
44163761Seric		domaintable is reflected into headers; that is, this
44263761Seric		is done in ruleset 3.
44364324Seric
44459034Sericbitdomain	Look up bitnet hosts in a table to try to turn them into
44559034Seric		internet addresses.  The table can be built using the
44664153Seric		bitdomain program contributed by John Gardiner Myers.
44759034Seric		The argument of the FEATURE may be the key definition; if
44859034Seric		none is specified, the definition used is:
44964164Seric			hash -o /etc/bitdomain.db
45059034Seric		Keys are the bitnet hostname; values are the corresponding
45159034Seric		internet hostname.
45264324Seric
45359037Sericuucpdomain	Similar feature for UUCP hosts.  The default map definition
45459037Seric		is:
45564164Seric			hash -o /etc/uudomain.db
45659037Seric		At the moment there is no automagic tool to build this
45759037Seric		database.
45864324Seric
45960263Sericalways_add_domain
46060263Seric		Include the local host domain even on locally delivered
46160263Seric		mail.  Normally it is not added unless it is already
46260263Seric		present.
46364324Seric
46463761Sericallmasquerade	If masquerading is enabled (using MASQUERADE_AS), this
46563761Seric		feature will cause recipient addresses to also masquerade
46663761Seric		as being from the masquerade host.  Normally they get
46763761Seric		the local hostname.  Although this may be right for
46863761Seric		ordinary users, it can break local aliases.  For example,
46963761Seric		if you send to "localalias", the originating sendmail will
47063761Seric		find that alias and send to all members, but send the
47163761Seric		message with "To: localalias@masqueradehost".  Since that
47263761Seric		alias likely does not exist, replies will fail.  Use this
47363761Seric		feature ONLY if you can guarantee that the ENTIRE
47463761Seric		namespace on your masquerade host supersets all the
47563761Seric		local entries.
47664324Seric
47764153Sericnodns		We aren't running DNS at our site (for example,
47864153Seric		we are UUCP-only connected).  It's hard to consider
47964153Seric		this a "feature", but hey, it had to go somewhere.
48057246Seric
48164324Sericnullclient	This is a special case -- it creates a stripped down
48264324Seric		configuration file containing nothing but support for
48364394Seric		forwarding all mail to a central hub via a local
48464394Seric		SMTP-based network.  The argument is the name of that
48564394Seric		hub.
48664394Seric
48764394Seric		The only other feature that should be used in conjunction
48864394Seric		with this one is "nocanonify" (this causes addresses to
48964394Seric		be sent unqualified via the SMTP connection; normally
49064394Seric		they are qualifed with the masquerade name, which
49164394Seric		defaults to the name of the hub machine).  No mailers
49264394Seric		should be defined.  No aliasing or forwarding is done.
49357246Seric
49467942Sericlocal_procmail	Use procmail as the local mailer.  This mailer can
49567929Seric		make use of the "user+indicator@local.host" syntax;
49667929Seric		normally the +indicator is just tossed, but by default
49767929Seric		it is passed as the -a argument to procmail.  The
49867929Seric		argument to this feature is the pathname of procmail,
49967929Seric		which defaults to /usr/local/bin/procmail.
50064324Seric
50168206Sericbestmx_is_local	Accept mail as though locally addressed for any host that
50268206Seric		lists us as the best possible MX record.  This generates
50368206Seric		additional DNS traffic, but should be OK for low to
50468206Seric		medium traffic hosts.
50567929Seric
50668216Sericsmrsh		Use the SendMail Restricted SHell (smrsh) provided
50768216Seric		with the distribution instead of /bin/sh for mailing
50868216Seric		to programs.  This improves the ability of the local
50968216Seric		system administrator to control what gets run via
51068216Seric		e-mail.  If an argument is provided it is used as the
51168216Seric		pathname to smrsh; otherwise, /usr/local/etc/smrsh is
51268216Seric		assumed.
51368206Seric
51468216Seric
51557246Seric+-------+
51657246Seric| HACKS |
51757246Seric+-------+
51857246Seric
51957246SericSome things just can't be called features.  To make this clear,
52057247Sericthey go in the hack subdirectory and are referenced using the HACK
52157246Sericmacro.  These will tend to be site-dependent.  The release
52257246Sericincludes the Berkeley-dependent "cssubdomain" hack (that makes
52357246Sericsendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU;
52457246Sericthis is intended as a short-term aid while we move hosts into
52557246Sericsubdomains.
52657246Seric
52758087Seric
52857246Seric+--------------------+
52957246Seric| SITE CONFIGURATION |
53057246Seric+--------------------+
53157246Seric
53268057Seric    *****************************************************
53368057Seric    * This section is really obsolete, and is preserved	*
53468057Seric    * only for back compatibility.  You should plan on	*
53568057Seric    * using mailertables for new installations.	  In	*
53668057Seric    * particular, it doesn't work for the newer forms	*
53768057Seric    * of UUCP mailers, such as uucp-uudom.		*
53868057Seric    *****************************************************
53968057Seric
54057246SericComplex sites will need more local configuration information, such as
54157246Sericlists of UUCP hosts they speak with directly.  This can get a bit more
54257246Serictricky.  For an example of a "complex" site, see cf/ucbvax.mc.
54357246Seric
54466336SericIf your host is known by several different names, you need to augment
54566336Sericthe $=w class.  This is a list of names by which you are known, and
54666336Sericanything sent to an address using a host name in this list will be
54766336Serictreated as local mail.  You can do this in two ways: either create
54866336Sericthe file /etc/sendmail.cw containing a list of your aliases (one per
54966336Sericline), and use ``FEATURE(use_cw_file)'' in the .mc file, or add the
55066336Sericline:
55166336Seric
55266336Seric	Cw alias.host.name
55366336Seric
55466336Sericat the end of that file.  See the ``vangogh.mc'' file for an example.
55566336SericBe sure you use the fully-qualified name of the host, rather than a
55666336Sericshort name.
55766336Seric
55857246SericThe SITECONFIG macro allows you to indirectly reference site-dependent
55957246Sericconfiguration information stored in the siteconfig subdirectory.  For
56057246Sericexample, the line
56157246Seric
56257246Seric	SITECONFIG(uucp.ucbvax, ucbvax, U)
56357246Seric
56457246Sericreads the file uucp.ucbvax for local connection information.  The
56557246Sericsecond parameter is the local name (in this case just "ucbvax" since
56666336Sericit is locally connected, and hence a UUCP hostname).  The third
56766336Sericparameter is the name of both a macro to store the local name (in
56866336Sericthis case, $U) and the name of the class (e.g., $=U) in which to store
56966336Sericthe host information read from the file.  Another SITECONFIG line reads
57057246Seric
57157246Seric	SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W)
57257246Seric
57357246SericThis says that the file uucp.ucbarpa contains the list of UUCP sites
57457246Sericconnected to ucbarpa.Berkeley.EDU.  The $=W class will be used to
57566336Sericstore this list, and $W is defined to be ucbarpa.Berkeley.EDU, that
57666336Sericis, the name of the relay to which the hosts listed in uucp.ucbarpa
57766336Sericare connected.  [The machine ucbarpa is gone now, but I've left
57857246Sericthis out-of-date configuration file around to demonstrate how you
57957246Sericmight do this.]
58057246Seric
58166336SericNote that the case of SITECONFIG with a third parameter of ``U'' is
58266336Sericspecial; the second parameter is assumed to be the UUCP name of the
58366336Sericlocal site, rather than the name of a remote site, and the UUCP name
58466336Sericis entered into $=w (the list of local hostnames) as $U.UUCP.
58566336Seric
58657246SericThe siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing
58757246Sericmore than a sequence of SITE macros describing connectivity.  For
58857246Sericexample:
58957246Seric
59057246Seric	SITE(cnmat)
59157246Seric	SITE(sgi olympus)
59257246Seric
59357246SericThe second example demonstrates that you can use two names on the
59457246Sericsame line; these are usually aliases for the same host (or are at
59557246Sericleast in the same company).
59657246Seric
59758087Seric
59865218Seric+--------------------+
59965218Seric| USING UUCP MAILERS |
60065218Seric+--------------------+
60165218Seric
60265218SericIt's hard to get UUCP mailers right because of the extremely ad hoc
60365218Sericnature of UUCP addressing.  These config files are really designed
60465218Sericfor domain-based addressing, even for UUCP sites.
60565218Seric
60665218SericThere are four UUCP mailers available.  The choice of which one to
60765218Sericuse is partly a matter of local preferences and what is running at
60865218Sericthe other end of your UUCP connection.  Unlike good protocols that
60965218Sericdefine what will go over the wire, UUCP uses the policy that you
61065218Sericshould do what is right for the other end; if they change, you have
61165218Sericto change.  This makes it hard to do the right thing, and discourages
61265218Sericpeople from updating their software.  In general, if you can avoid
61365218SericUUCP, please do.
61465218Seric
61565218SericThe major choice is whether to go for a domainized scheme or a
61665218Sericnon-domainized scheme.  This depends entirely on what the other
61765218Sericend will recognize.  If at all possible, you should encourage the
61865218Sericother end to go to a domain-based system -- non-domainized addresses
61965218Sericdon't work entirely properly.
62065218Seric
62165218SericThe four mailers are:
62265218Seric
62365218Seric    uucp-old (obsolete name: "uucp")
62465218Seric	This is the oldest, the worst (but the closest to UUCP) way of
62565218Seric	sending messages accros UUCP connections.  It does bangify
62665218Seric	everything and prepends $U (your UUCP name) to the sender's
62765218Seric	address (which can already be a bang path itself).  It can
62865218Seric	only send to one address at a time, so it spends a lot of
62965218Seric	time copying duplicates of messages.  Avoid this if at all
63065218Seric	possible.
63165218Seric
63265218Seric    uucp-new (obsolete name: "suucp")
63365218Seric	The same as above, except that it assumes that in one rmail
63465218Seric	command you can specify several recipients.  It still has a
63565218Seric	lot of other problems.
63665218Seric
63765218Seric    uucp-dom
63865218Seric	This UUCP mailer keeps everything as domain addresses.
63967471Seric	Basically, it uses the SMTP mailer rewriting rules.  This mailer
64067471Seric	is only included if MAILER(smtp) is also specified.
64165218Seric
64265218Seric	Unfortunately, a lot of UUCP mailer transport agents require
64365218Seric	bangified addresses in the envelope, although you can use
64465218Seric	domain-based addresses in the message header.  (The envelope
64565218Seric	shows up as the From_ line on UNIX mail.)  So....
64665218Seric
64765218Seric    uucp-uudom
64865218Seric	This is a cross between uucp-new (for the envelope addresses)
64965218Seric	and uucp-dom (for the header addresses).  It bangifies the
65065218Seric	envelope sender (From_ line in messages) without adding the
65165218Seric	local hostname, unless there is no host name on the address
65265218Seric	at all (e.g., "wolf") or the host component is a UUCP host name
65365218Seric	instead of a domain name ("somehost!wolf" instead of
65467471Seric	"some.dom.ain!wolf").  This is also included only if MAILER(smtp)
65567471Seric	is also specified.
65665218Seric
65765218SericExamples:
65865218Seric
65965218SericWe are on host grasp.insa-lyon.fr (UUCP host name "grasp").  The
66065218Sericfollowing summarizes the sender rewriting for various mailers.
66165218Seric
66265218SericMailer          sender		rewriting in the envelope
66365218Seric------		------		-------------------------
66465218Sericuucp-{old,new}	wolf		grasp!wolf
66565218Sericuucp-dom	wolf		wolf@grasp.insa-lyon.fr
66665218Sericuucp-uudom	wolf		grasp.insa-lyon.fr!wolf
66765218Seric
66865218Sericuucp-{old,new}	wolf@fr.net	grasp!fr.net!wolf
66965218Sericuucp-dom	wolf@fr.net	wolf@fr.net
67065218Sericuucp-uudom	wolf@fr.net	fr.net!wolf
67165218Seric
67265218Sericuucp-{old,new}	somehost!wolf	grasp!somehost!wolf
67365218Sericuucp-dom	somehost!wolf	somehost!wolf@grasp.insa-lyon.fr
67465218Sericuucp-uudom	somehost!wolf	grasp.insa-lyon.fr!somehost!wolf
67565218Seric
67665218SericIf you are using one of the domainized UUCP mailers, you really want
67765218Sericto convert all UUCP addresses to domain format -- otherwise, it will
67865218Sericdo it for you (and probably not the way you expected).  For example,
67965218Sericif you have the address foo!bar!baz (and you are not sending to foo),
68065218Sericthe heuristics will add the @uucp.relay.name or @local.host.name to
68165218Sericthis address.  However, if you map foo to foo.host.name first, it
68265218Sericwill not add the local hostname.  You can do this using the uucpdomain
68365218Sericfeature.
68465218Seric
68565218Seric
68657246Seric+-------------------+
68757246Seric| TWEAKING RULESETS |
68857246Seric+-------------------+
68957246Seric
69051268SericFor more complex configurations, you can define special rules.
69151268SericThe macro LOCAL_RULE_3 introduces rules that are used in canonicalizing
69251268Sericthe names.  Any modifications made here are reflected in the header.
69351268Seric
69451268SericA common use is to convert old UUCP addreses to SMTP addresses using
69551268Sericthe UUCPSMTP macro.  For example:
69651268Seric
69751268Seric	LOCAL_RULE_3
69851268Seric	UUCPSMTP(decvax,	decvax.dec.com)
69951268Seric	UUCPSMTP(research,	research.att.com)
70051268Seric
70151268Sericwill cause addresses of the form "decvax!user" and "research!user"
70251268Sericto be converted to "user@decvax.dec.com" and "user@research.att.com"
70351268Sericrespectively.
70451268Seric
70565957SericThis could also be used to look up hosts in a database map:
70657246Seric
70757246Seric	LOCAL_RULE_3
70857246Seric	R$* < @ $+ > $*		$: $1 < @ $(hostmap $2 $) > $3
70957246Seric
71057246SericThis map would be defined in the LOCAL_CONFIG portion, as shown below.
71157246Seric
71251268SericSimilarly, LOCAL_RULE_0 can be used to introduce new parsing rules.
71351268SericFor example, new rules are needed to parse hostnames that you accept
71451309Sericvia MX records.  For example, you might have:
71551268Seric
71651309Seric	LOCAL_RULE_0
71765986Seric	R$+ <@ host.dom.ain.>	$#uucp $@ cnmat $: $1 < @ host.dom.ain.>
71851309Seric
71951309SericYou would use this if you had installed an MX record for cnmat.Berkeley.EDU
72051309Sericpointing at this host; this rule catches the message and forwards it on
72151309Sericusing UUCP.
72251309Seric
72358681SericYou can also tweak rulesets 1 and 2 using LOCAL_RULE_1 and LOCAL_RULE_2.
72458681SericThese rulesets are normally empty.
72558681Seric
72657246SericA similar macro is LOCAL_CONFIG.  This introduces lines added after the
72757246Sericboilerplate option setting but before rulesets, and can be used to
72857945Sericdeclare local database maps or whatever.  For example:
72951268Seric
73057246Seric	LOCAL_CONFIG
73157246Seric	Khostmap hash /etc/hostmap.db
73257246Seric	Kyplocal nis -m hosts.byname
73351220Seric
73458087Seric
73557246Seric+---------------------------+
73657246Seric| MASQUERADING AND RELAYING |
73757246Seric+---------------------------+
73857246Seric
73957246SericYou can have your host masquerade as another using
74057246Seric
74157246Seric	MASQUERADE_AS(host.domain)
74257246Seric
74365957SericThis causes outgoing SMTP mail to be labeled as coming from the
74457246Sericindicated domain, rather than $j.  One normally masquerades as one
74565957Sericof one's own subdomains (for example, it's unlikely that I would
74657246Sericchoose to masquerade as an MIT site).
74757246Seric
74864153SericThe masquerade name is not normally canonified, so it is important
74964153Sericthat it be your One True Name, that is, fully qualified and not a
75064153SericCNAME.
75164153Seric
75257246Sericthere are always users that need to be "exposed" -- that is, their
75357246Sericinternal site name should be displayed instead of the masquerade name.
75457246SericRoot is an example.  You can add users to this list using
75557246Seric
75657246Seric	EXPOSED_USER(usernames)
75757246Seric
75857246SericThis adds users to class E; you could also use something like
75957246Seric
76057246Seric	FE/etc/sendmail.cE
76157246Seric
76257246SericYou can also arrange to relay all unqualified names (that is, names
76357246Sericwithout @host) to a relay host.  For example, if you have a central
76457246Sericemail server, you might relay to that host so that users don't have
76557246Sericto have .forward files or aliases.  You can do this using
76657246Seric
76758071Seric	define(`LOCAL_RELAY', mailer:hostname)
76857246Seric
76958071SericThe ``mailer:'' can be omitted, in which case the mailer defaults to
77058071Seric"smtp".  There are some user names that you don't want relayed, perhaps
77158071Sericbecause of local aliases.  A common example is root, which may be
77258071Sericlocally aliased.  You can add entries to this list using
77357246Seric
77457246Seric	LOCAL_USER(usernames)
77557246Seric
77657246SericThis adds users to class L; you could also use something like
77757246Seric
77857246Seric	FL/etc/sendmail.cL
77957246Seric
78064153SericIf you want all incoming mail sent to a centralized hub, as for a
78164153Sericshared /var/spool/mail scheme, use
78257591Seric
78358071Seric	define(`MAIL_HUB', mailer:hostname)
78457591Seric
78558071SericAgain, ``mailer:'' defaults to "smtp".  If you define both LOCAL_RELAY
78668697Sericand MAIL_HUB _AND_ you have FEATURE(stickyhost), unqualified names will
78768697Sericbe sent to the LOCAL_RELAY and other local names will be sent to MAIL_HUB.
78868697SericNames in $=L will be delivered locally, so you MUST have aliases or
78968697Seric.forward files for them.
79066047Seric
79168697SericFor example, if are on machine mastodon.CS.Berkeley.EDU and you have
79268697SericFEATURE(stickyhost), the following combinations of settings will have the
79368697Sericindicated effects:
79457591Seric
79557591Sericemail sent to....	eric			  eric@mastodon.CS.Berkeley.EDU
79657591Seric
79757591SericLOCAL_RELAY set to	mail.CS.Berkeley.EDU	  (delivered locally)
79868697Sericmail.CS.Berkeley.EDU	  (no local aliasing)	    (aliasing done)
79957591Seric
80057591SericMAIL_HUB set to		mammoth.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
80168697Sericmammoth.CS.Berkeley.EDU	  (aliasing done)	    (aliasing done)
80257591Seric
80357591SericBoth LOCAL_RELAY and	mail.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
80468697SericMAIL_HUB set as above	  (no local aliasing)	    (aliasing done)
80557591Seric
80668697SericIf you do not have FEATURE(stickyhost) set, then LOCAL_RELAY and
80768697SericMAIL_HUB act identically, with MAIL_HUB taking precedence.
80868697Seric
80964153SericIf you want all outgoing mail to go to a central relay site, define
81064153SericSMART_HOST as well.  Briefly:
81158071Seric
81264153Seric	LOCAL_RELAY applies to unqualifed names (e.g., "eric").
81364153Seric	MAIL_HUB applies to names qualified with the name of the
81464153Seric		local host (e.g., "eric@mastodon.CS.Berkeley.EDU").
81564153Seric	SMART_HOST applies to names qualified with other hosts.
81664153Seric
81764153SericHowever, beware that other relays (e.g., UUCP_RELAY, BITNET_RELAY, and
81864153SericFAX_RELAY) take precedence over SMART_HOST, so if you really want
81964153Sericabsolutely everything to go to a single central site you will need to
82064153Sericunset all the other relays -- or better yet, find or build a minimal
82164153Sericconfig file that does this.
82264153Seric
82364153Seric
82458071Seric+-------------------------------+
82558071Seric| NON-SMTP BASED CONFIGURATIONS |
82658071Seric+-------------------------------+
82758071Seric
82858071SericThese configuration files are designed primarily for use by SMTP-based
82958071Sericsites.  I don't pretend that they are well tuned for UUCP-only or
83058071SericUUCP-primarily nodes (the latter is defined as a small local net
83158071Sericconnected to the rest of the world via UUCP).  However, there is one
83258071Serichook to handle some special cases.
83358071Seric
83458071SericYou can define a ``smart host'' that understands a richer address syntax
83558071Sericusing:
83658071Seric
83758071Seric	define(`SMART_HOST', mailer:hostname)
83858071Seric
83964028SericIn this case, the ``mailer:'' defaults to "relay".  Any messages that
84058071Sericcan't be handled using the usual UUCP rules are passed to this host.
84158071Seric
84258071SericIf you are on a local SMTP-based net that connects to the outside
84358071Sericworld via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules.
84458071SericFor example:
84558071Seric
84658071Seric	define(`SMART_HOST', suucp:uunet)
84758071Seric	LOCAL_NET_CONFIG
84863761Seric	R$* < @ $* .$m. > $*	$#smtp $@ $2.$m. $: $1 < @ $2.$m. > $3
84958071Seric
85058071SericThis will cause all names that end in your domain name ($m) via
85158071SericSMTP; anything else will be sent via suucp (smart UUCP) to uunet.
85263761SericIf you have FEATURE(nocanonify), you may need to omit the dots after
85363761Sericthe $m.  If you are running a local DNS inside your domain which is
85463761Sericnot otherwise connected to the outside world, you probably want to
85563761Sericuse:
85658071Seric
85763761Seric	define(`SMART_HOST', smtp:fire.wall.com)
85863761Seric	LOCAL_NET_CONFIG
85963761Seric	R$* < @ $* . > $*	$#smtp $@ $2. $: $1 < @ $2. > $3
86058071Seric
86163761SericThat is, send directly only to things you found in your DNS lookup;
86263761Sericanything else goes through SMART_HOST.
86363761Seric
86464153SericIf you are not running DNS at all, it is important to use
86564153SericFEATURE(nodns) to avoid having sendmail queue everything waiting
86664153Sericfor the name server to come up.
86763761Seric
86864153Seric
86964259Seric+-----------+
87064259Seric| WHO AM I? |
87164259Seric+-----------+
87264259Seric
87364259SericNormally, the $j macro is automatically defined to be your fully
87464259Sericqualified domain name (FQDN).  Sendmail does this by getting your
87564259Serichost name using gethostname and then calling gethostbyname on the
87664259Sericresult.  For example, in some environments gethostname returns
87764259Sericonly the root of the host name (such as "foo"); gethostbyname is
87864259Sericsupposed to return the FQDN ("foo.bar.com").  In some (fairly rare)
87964259Sericcases, gethostbyname may fail to return the FQDN.  In this case
88064259Sericyou MUST define confDOMAIN_NAME to be your fully qualified domain
88164259Sericname.  This is usually done using:
88264259Seric
88364259Seric	Dmbar.com
88464259Seric	define(`confDOMAIN_NAME', `$w.$m')dnl
88564259Seric
88664259Seric
88764028Seric+--------------------+
88864028Seric| USING MAILERTABLES |
88964028Seric+--------------------+
89064028Seric
89164028SericTo use FEATURE(mailertable), you will have to create an external
89264028Sericdatabase containing the routing information for various domains.
89364028SericFor example, a mailertable file in text format might be:
89464028Seric
89564028Seric	.my.domain		xnet:%1.my.domain
89664028Seric	uuhost1.my.domain	suucp:uuhost1
89764028Seric	.bitnet			smtp:relay.bit.net
89864028Seric
89964028SericThis should normally be stored in /etc/mailertable.  The actual
90064028Sericdatabase version of the mailertable is built using:
90164028Seric
90264028Seric	makemap hash /etc/mailertable.db < /etc/mailertable
90364028Seric
90464028SericThe semantics are simple.  Any LHS entry that does not begin with
90564028Serica dot matches the full host name indicated.  LHS entries beginning
90664028Sericwith a dot match anything ending with that domain name -- that is,
90764028Sericthey can be thought of as having a leading "*" wildcard.  Matching
90864028Sericis done in order of most-to-least qualified -- for example, even
90964028Sericthough ".my.domain" is listed first in the above example, an entry
91064028Sericof "uuhost1.my.domain" will match the second entry since it is
91164028Sericmore explicit.
91264028Seric
91364028SericThe RHS should always be a "mailer:host" pair.  The mailer is the
91464028Sericconfiguration name of a mailer (that is, an `M' line in the
91564028Sericsendmail.cf file).  The "host" will be the hostname passed to
91664028Sericthat mailer.  In domain-based matches (that is, those with leading
91764028Sericdots) the "%1" may be used to interpolate the wildcarded part of
91864028Sericthe host name.  For example, the first line above sends everything
91964028Sericaddressed to "anything.my.domain" to that same host name, but using
92064028Sericthe (presumably experimental) xnet mailer.
92164028Seric
92267915SericIn some cases you may want to temporarily turn off MX records,
92367915Sericparticularly on gateways.  For example, you may want to MX
92467915Sericeverything in a domain to one machine that then forwards it
92567915Sericdirectly.  To do this, you might use the DNS configuration:
92664028Seric
92767915Seric	*.domain.	IN	MX	0	relay.machine
92867915Seric
92967915Sericand on relay.machine use the mailertable:
93067915Seric
93167915Seric	.domain		smtp:[gateway.domain]
93267915Seric
93367915SericThe [square brackets] turn off MX records for this host only.
93467915SericIf you didn't do this, the mailertable would use the MX record
93567915Sericagain, which would give you an MX loop.
93667915Seric
93767915Seric
93864153Seric+--------------------------------+
93964153Seric| USING USERDB TO MAP FULL NAMES |
94064153Seric+--------------------------------+
94164153Seric
94264153SericThe user database was not originally intended for mapping full names
94364153Sericto login names (e.g., Eric.Allman => eric), but some people are using
94464153Sericit that way.  (I would recommend that you set up aliases for this
94564153Sericpurpose instead -- since you can specify multiple alias files, this
94664153Sericis fairly easy.)  The intent was to locate the default maildrop at
94764153Serica site, but allow you to override this by sending to a specific host.
94864153Seric
94964153SericIf you decide to set up the user database in this fashion, it is
95067917Sericimperative that you not use FEATURE(stickyhost) -- otherwise,
95164153Serice-mail sent to Full.Name@local.host.name will be rejected.
95264153Seric
95367917SericTo build the internal form of the user database, use:
95464153Seric
95564259Seric	makemap btree /usr/data/base.db < /usr/data/base.txt
95664259Seric
95764259Seric
95867539Seric+--------------------------------+
95967539Seric| MISCELLANEOUS SPECIAL FEATURES |
96067539Seric+--------------------------------+
96167539Seric
96267539SericDOTTED_USER(name)
96367539Seric	Sometimes it is convenient to merge configuration on a
96467539Seric	centralized mail machine, for example, to forward all
96567539Seric	root mail to a mail server.  In this case it might be
96667539Seric	useful to be able to treat the root addresses as a class
96767539Seric	of addresses with subtle differences.  You can do this
96867539Seric	using dotted users.  For example, a client might include
96967539Seric	the alias:
97067539Seric
97167539Seric		root:  root.client1@server
97267539Seric
97367539Seric	On the server, the mail configuration would include:
97467539Seric
97567539Seric		DOTTED_USER(root)
97667539Seric
97767539Seric	Aliases on the server that would match this address would
97867539Seric	be "root.client", "root.*", and "root", tried in that
97967539Seric	order.  You can specify multiple addresses either by
98067539Seric	joining them in one DOTTTED_USER macro or by having
98167539Seric	multiple macros:
98267539Seric
98367539Seric		DOTTED_USER(root)
98467539Seric		DOTTED_USER(postmaster mailer-daemon)
98567539Seric
98667539Seric	defines three dotted users.
98767539Seric
98867539Seric
98967960Seric+----------------+
99067960Seric| SECURITY NOTES |
99167960Seric+----------------+
99267960Seric
99367960SericA lot of sendmail security comes down to you.  Sendmail 8 is much
99467960Sericmore careful about checking for security problems than previous
99567960Sericversions, but there are some things that you still need to watch
99667960Sericfor.  In particular:
99767960Seric
99867960Seric* Make sure the aliases file isn't writable except by trusted
99967960Seric  system personnel.  This includes both the text and database
100067960Seric  version.
100167960Seric
100267960Seric* Make sure that other files that sendmail reads, such as the
100367960Seric  mailertable, is only writable by trusted system personnel.
100467960Seric
100567960Seric* The queue directory should not be world writable PARTICULARLY
100667960Seric  if your system allows "file giveaways" (that is, if a non-root
100767960Seric  user can chown any file they own to any other user).
100867960Seric
100967960Seric* If your system allows file giveaways, DO NOT create a publically
101067960Seric  writable directory for forward files.  This will allow anyone
101167960Seric  to steal anyone else's e-mail.  Instead, create a script that
101267960Seric  copies the .forward file from users' home directories once a
101367960Seric  night (if you want the non-NFS-mounted forward directory).
101467960Seric
101567960Seric* If your system allows file giveaways, you'll find that
101667960Seric  sendmail is much less trusting of :include: files -- in
101767960Seric  particular, you'll have to have /SENDMAIL/ANY/SHELL/ in
101867960Seric  /etc/shells before they will be trusted (that is, before
101967960Seric  files and programs listed in them will be honored).
102067960Seric
102167960SericIn general, file giveaways are a mistake -- if you can turn them
102267960Sericoff I recommend you do so.
102367960Seric
102467960Seric
102558363Seric+------------------+
102658363Seric| FlexFAX SOFTWARE |
102758363Seric+------------------+
102858363Seric
102958363SericSam Leffler's FlexFAX software is still in beta test -- but he expects a
103058363Sericpublic version out "later this week" [as of 3/1/93].  The following
103158363Sericblurb is direct from Sam:
103258363Seric
103364498Seric	$Header: /usr/people/sam/fax/RCS/HOWTO,v 1.14 93/05/24 11:42:16 sam Exp $
103458363Seric
103558363Seric	How To Obtain This Software (in case all you get is this file)
103664498Seric	--------------------------------------------------------------
103758363Seric	The source code is available for public ftp on
103864498Seric	    sgi.com			sgi/fax/v2.1.src.tar.Z
103958363Seric		(192.48.153.1)
104058363Seric
104158363Seric	You can also obtain inst'able images for Silicon Graphics machines from
104264498Seric	    sgi.com			sgi/fax/v2.1.inst.tar
104358363Seric		(192.48.153.1)
104458363Seric
104558363Seric	For example,
104658363Seric	    % ftp -n sgi.com
104758363Seric	    ....
104858363Seric	    ftp> user anonymous
104958363Seric	    ... <type in password>
105058363Seric	    ftp> cd sgi/fax
105158363Seric	    ftp> binary
105264498Seric	    ftp> get v2.1.src.tar.Z
105358363Seric
105464498Seric	In general, the latest version of the 2.1 release of the software is
105564498Seric	always available as "v2.1.src.tar.Z" or "v2.1.inst.tar" in the ftp
105664498Seric	directory.  This file is a link to the appropriate released version (so
105764498Seric	don't waste your time retrieving the linked file as well!) Any files of
105864498Seric	the form v2.1.*.patch are shell scripts that can be used to patch older
105964498Seric	versions of the source code.  For example, the file v2.1.0.patch would
106064498Seric	contain patches to update v2.1.0.tar.Z.  (Note to beta testers: this is
106164498Seric	different than the naming conventions used during beta testing.) Patch
106264498Seric	files only work to go between consecutive versions, so if you are
106364498Seric	multiple versions behind the latest release, you will need to apply
106464498Seric	each patch file between your current version and the latest.
106564498Seric
106664498Seric
106764498Seric	Obtaining the Software by Electronic Mail
106864498Seric	-----------------------------------------
106964498Seric	Do not send me requests for the software; they will be ignored (without
107064498Seric	response).  If you cannot use FTP at all, there is a service called
107164498Seric	"ftpmail" available from gatekeeper.dec.com:  you can send e-mail to
107264498Seric	this machine and it will use FTP to retrieve files for you and send you
107364498Seric	the files back again via e-mail.  To find out more about the ftpmail
107458363Seric	service, send a message to "ftpmail@gatekeeper.dec.com" whose body
107558363Seric	consists of the single line "help".
107658363Seric
107764498Seric
107864498Seric	Obtaining the Software Within Silicon Graphics
107964498Seric	----------------------------------------------
108058363Seric	Internal to Silicon Graphics there are inst'able images on the host
108164498Seric	flake.asd in the directory /usr/dist.  Thus you can do something like:
108258363Seric
108364498Seric	    % inst -f flake.asd.sgi.com:/usr/dist/flexfax
108458363Seric
108564498Seric	to install the latest version of the software on your machine.
108658363Seric
108764498Seric
108864498Seric	What to do Once You've Retrieved Stuff
108964498Seric	--------------------------------------
109058363Seric	The external distributions come in a compressed or uncompressed tar
109158363Seric	file.  To extract the source distribution:
109258363Seric
109364498Seric	    % zcat v2.1.src.tar.Z | tar xf -
109458363Seric
109558363Seric	(uncompress and extract individual files in current directory).  To
109658363Seric	unpack and install the client portion of the inst'able distribution:
109758363Seric
109858363Seric	    % mkdir dist
109964498Seric	    % cd dist; tar xf ../v2.1.inst.tar; cd ..
110058363Seric	    % inst -f dist/flexfax
110158363Seric	    ...
110258363Seric	    inst> go
110358363Seric
110458363Seric	(Note, the dist subdirectory is because some versions of inst fail if
110564498Seric	the files are in the current directory.) Server binaries are also
110664498Seric	included in the inst'able images as flexfax.server.*.  They are not
110764498Seric	installed by default, so to get them also you need to do:
110858363Seric
110958363Seric	    % inst -f flexfax
111058363Seric	    ...
111158363Seric	    inst> install flexfax.server.*
111258363Seric	    inst> go
111358363Seric
111464498Seric	The SGI binaries were built for Version 4.0.5H of the IRIX operating
111558363Seric	system.  They should work w/o problem on earlier versions of the
111658363Seric	system, but I have not fully tested this.  Also, note that to install a
111758363Seric	server on an SGI machine, you need to have installed the Display
111858363Seric	PostScript execution environment product (dps_eoe).  Otherwise, the fax
111958363Seric	server will not be able to convert PostScript to facsimile for
112058363Seric	transmission.
112158363Seric
112264498Seric	If you are working from the source distribution, look at the file
112364498Seric	README in the top of the source tree.  If you are working from the inst
112464498Seric	images, the subsystem flexfax.man.readme contains the README file and
112564498Seric	other useful pieces of information--the installed files are placed in
112664498Seric	the directory /usr/local/doc/flexfax).  Basically you will need to run
112764498Seric	the faxaddmodem script to setup and configure your fax modem.  Consult
112864498Seric	the README file and the manual page for faxaddmodem for information.
112958363Seric
113058363Seric
113164498Seric	FlexFAX Mail List
113264498Seric	-----------------
113358363Seric	A mailing list for users of this software is located on sgi.com.
113458363Seric	If you want to join this mailing list or have a list-related request
113558363Seric	such as getting your name removed from it, send a request to
113658363Seric
113764498Seric	    majordomo@whizzer.wpd.sgi.com
113858363Seric
113964498Seric	For example, to subscribe, send the line "subscribe flexfax" in
114064498Seric	the body of your message.  The line "help" will return a list of
114164498Seric	the commands understood by the mailing list management software.
114264498Seric
114358363Seric	Submissions (including bug reports) should be directed to:
114458363Seric
114558363Seric	    flexfax@sgi.com
114658363Seric
114764498Seric	When corresponding about this software please always specify what
114864498Seric	version you have, what system you're running on, and, if the problem is
114964498Seric	specific to your modem, identify the modem and firmware revision.
115058363Seric
115164498Seric
115257945Seric+--------------------------------+
115357945Seric| TWEAKING CONFIGURATION OPTIONS |
115457945Seric+--------------------------------+
115557945Seric
115657945SericThere are a large number of configuration options that don't normally
115757945Sericneed to be changed.  However, if you feel you need to tweak them, you
115857945Sericcan define the following M4 variables.  This list is shown in four
115957945Sericcolumns:  the name you define, the default value for that definition,
116057945Sericthe option or macro that is affected (either Ox for an option or Dx
116157945Sericfor a macro), and a brief description.  Greater detail of the semantics
116257945Sericcan be found in the Installation and Operations Guide.
116357945Seric
116463582SericSome options are likely to be deprecated in future versions -- that is,
116563582Sericthe option is only included to provide back-compatibility.  These are
116663582Sericmarked with "*".
116763582Seric
116865002SericRemember that these options are M4 variables, and hence may need to
116965002Sericbe quoted.  In particular, arguments with commas will usually have to
117065002Sericbe ``double quoted, like this phrase'' to avoid having the comma
117165002Sericconfuse things.  This is common for alias file definitions and for
117265002Sericthe read timeout.
117365002Seric
117468694SericM4 Variable Name	Configuration	Description & [Default]
117568694Seric================	=============	=======================
117668694SericconfMAILER_NAME		$n macro	[MAILER-DAEMON] The sender name used
117768694Seric					for internally generated outgoing
117868694Seric					messages.
117968694SericconfFROM_LINE		$l macro	[From $g  $d] The From_ line used
118068694Seric					when sending to files or programs.
118168694SericconfFROM_HEADER		$q macro	[$?x$x <$g>$|$g$.] The format of an
118268694Seric					internally generated From: address.
118368694SericconfOPERATORS		$o macro	[.:%@!^/[]+] Address operator
118468694Seric					characters.
118568767SericconfSMTP_LOGIN_MSG	$e macro	[$j Sendmail $v/$Z; $b]
118668694Seric					The initial (spontaneous) SMTP
118768767Seric					greeting message.  The word "ESMTP"
118868767Seric					will be inserted between the first and
118968767Seric					second words to convince other
119068767Seric					sendmails to try to speak ESMTP.
119168694SericconfDOMAIN_NAME		$j macro	If defined, sets $j.  This should
119268694Seric					only be done if your system cannot
119368694Seric					determine your local domain name,
119468694Seric					and then it should be set to
119568694Seric					$w.Foo.COM, where Foo.COM is your
119668694Seric					domain name.
119768694SericconfRECEIVED_HEADER	Received:
119868694Seric      [.$?_($?s$|from $.$_) $.by $j ($v/$Z)$?r with $r$. id $i$?u for $u$.; $b]
119968694Seric					The format of the Received: header
120068694Seric					in messages passed through this host.
120168694Seric					It is unwise to try to change this.
120268694SericconfCW_FILE		Fw class	[/etc/sendmail.cw] Name of file used
120368694Seric					to get the local additions to the $=w
120468694Seric					class.
120568694SericconfSMTP_MAILER		-		[smtp] The mailer name used when
120668694Seric					SMTP connectivity is required.
120768694Seric					One of "smtp", "smtp8", or "esmtp".
120868694SericconfLOCAL_MAILER	-		[local] The mailer name used when
120968694Seric					local connectivity is required.
121068694Seric					Almost always "local".
121168694SericconfRELAY_MAILER	-		[relay] The default mailer name used
121268694Seric					for relaying any mail (e.g., to a
121368694Seric					BITNET_RELAY, a SMART_HOST, or
121468694Seric					whatever).  This can reasonably be
121568694Seric					"uucp-new" if you are on a
121668694Seric					UUCP-connected site.
121768694SericconfSEVEN_BIT_INPUT	SevenBitInput	[False] Force input to seven bits?
121868694SericconfEIGHT_BIT_HANDLING	EightBitMode	[pass8] 8-bit data handling
121968694SericconfALIAS_WAIT		AliasWait	[10m] Time to wait for alias file
122068694Seric					rebuild until you get bored and
122168694Seric					decide that the apparently pending
122268694Seric					rebuild failed.
122368694SericconfMIN_FREE_BLOCKS	MinFreeBlocks	[100] Minimum number of free blocks on
122468694Seric					queue filesystem to accept SMTP mail.
122568749Seric					(Prior to 8.7 this was minfree/maxsize,
122668749Seric					where minfree was the number of free
122768749Seric					blocks and maxsize was the maximum
122868749Seric					message size.  Use confMAX_MESSAGE_SIZE
122968749Seric					for the second value now.)
123068749SericconfMAX_MESSAGE_SIZE	MaxMessageSize	The maximum size of messages that will
123168749Seric					be accepted (in bytes).
123268694SericconfBLANK_SUB		BlankSub	[.] Blank (space) substitution
123368694Seric					character.
123468694SericconfCON_EXPENSIVE	HoldExpensive	[False] Avoid connecting immediately
123568694Seric					to mailers marked expensive?
123668694SericconfCHECKPOINT_INTERVAL	CheckpointInterval
123768694Seric					Checkpoint queue files every N
123868694Seric					recipients.
123968694SericconfDELIVERY_MODE	DeliveryMode	[background] Default delivery mode.
124068694SericconfAUTO_REBUILD	AutoRebuildAliases
124168694Seric					Automatically rebuild alias
124268694Seric					file if needed.
124368694SericconfERROR_MODE		ErrorMode	Error message mode.
124468694SericconfERROR_MESSAGE	ErrorHeader	Error message header/file.
124568694SericconfSAVE_FROM_LINES	SafeFromLine	Save extra leading From_ lines.
124668694SericconfTEMP_FILE_MODE	TempFileMode	[0600] Temporary file mode.
124768694SericconfMATCH_GECOS		MatchGECOS	Match GECOS field.
124868694SericconfMAX_HOP		MaxHopCount	Maximum hop count.
124968694SericconfIGNORE_DOTS*	IgnoreDots	Ignore dot as terminator for incoming
125068694Seric					messages?
125168694SericconfBIND_OPTS		ResolverOptions	Default options for DNS resolver.
125268694SericconfMIME_FORMAT_ERRORS*	SendMimeErrors	[True] Send error messages as MIME-
125368694Seric					encapsulated messages per RFC 1344.
125468694SericconfFORWARD_PATH	ForwardPath	[$z/.forward.$w:$z/.forward]
125568694Seric					The colon-separated list of places to
125668694Seric					search for .forward files.  N.B.: see
125768694Seric					the Security Notes section.
125868694SericconfMCI_CACHE_SIZE	ConnectionCacheSize
125968694Seric					[2] Size of open connection cache.
126068694SericconfMCI_CACHE_TIMEOUT	ConnectionCacheTimeout
126168694Seric					[5m] Open connection cache timeout.
126268694SericconfUSE_ERRORS_TO*	UserErrorsTo	[False] Use the Errors-To: header to deliver
126368694Seric					error messages.  This should not be
126468694Seric					necessary because of general acceptance
126568694Seric					of the envelope/header distinction.
126668694SericconfLOG_LEVEL		LogLevel	[9] Log level.
126768694SericconfME_TOO		MeToo		Include sender in group expansions.
126868694SericconfCHECK_ALIASES	CheckAliases	[True] Check RHS of aliases when
126968694Seric					running newaliases.
127068694SericconfOLD_STYLE_HEADERS*	OldStyleHeaders	[True] Assume that headers without
127168694Seric					special chars are old style.
127268694SericconfDAEMON_OPTIONS	DaemonPortOptions
127368694Seric					SMTP daemon options.
127468694SericconfPRIVACY_FLAGS	PrivacyOptions	[authwarnings] Privacy flags.
127568694SericconfCOPY_ERRORS_TO	PostmasterCopy	Address for additional copies of all
127668694Seric					error messages.
127768694SericconfQUEUE_FACTOR	QueueFactor	Slope of queue-only function.
127868694SericconfDONT_PRUNE_ROUTES	DontPruneRoutes	Don't prune down route-addr syntax
127968694Seric					addresses to the minimum possible.
128068694SericconfSAFE_QUEUE*		SuperSafe	[True] Commit all messages to disk
128168694Seric					before forking.
128268694SericconfTIME_ZONE		TimeZoneSpec	[USE_SYSTEM] Time zone info -- can be
128368694Seric					USE_SYSTEM to use the system's idea,
128468694Seric					USE_TZ to use the user's TZ envariable,
128568694Seric					or something else to force that value.
128668694SericconfDEF_USER_ID		DefaultUser	[1:1] Default user id.
128768694SericconfUSERDB_SPEC		UserDatabaseSpec
128868694Seric					User database specification.
128968694SericconfFALLBACK_MX		FallbackMXhost	Fallback MX host.
129068694SericconfTRY_NULL_MX_LIST	TryNullMXList	If we are the best MX for a host and
129168694Seric					haven't made other arrangements, try
129268694Seric					connecting to the host directly;
129368694Seric					normally this would be a config error.
129468694SericconfQUEUE_LA		QueueLA		Load average at which queue-only
129568694Seric					function kicks in.
129668694SericconfREFUSE_LA		RefuseLA	Load average at which incoming
129768694Seric					SMTP connections are refused.
129863582SericconfWORK_RECIPIENT_FACTOR
129968694Seric			RecipientFactor	Cost of each recipient.
130068694SericconfSEPARATE_PROC	ForkEachJob	Run all deliveries in a separate
130168694Seric					process.
130268694SericconfWORK_CLASS_FACTOR	ClassFactor	Priority multiplier for class.
130368694SericconfWORK_TIME_FACTOR	RetryFactor	Cost of each delivery attempt.
130468694SericconfQUEUE_SORT_ORDER	QueueSortOrder	Queue sort algorithm: Priority or Host.
130568694SericconfMIN_QUEUE_AGE	MinQueueAge	The minimum amount of time a job
130668694Seric					must sit in the queue between queue
130768694Seric					runs.  This allows you to set the
130868694Seric					queue run interval low for better
130968694Seric					resposiveness without trying all
131068694Seric					jobs in each run.
131168694SericconfDEF_CHAR_SET	DefaultCharSet	When converting unlabelled 8 bit
131268694Seric					input to MIME, the character set to
131368694Seric					use by default.
131468694SericconfSERVICE_SWITCH_FILE	ServiceSwitchFile
131568694Seric					The file to use for the service switch
131668694Seric					on systems that do not have a system-
131768694Seric					defined switch.
131868694SericconfDIAL_DELAY		DialDelay	If a connection fails, wait this long
131968694Seric					and try again.  This is to allow
132068694Seric					"dial on demand" connections to have
132168694Seric					enough time to complete a connection.
132268694SericconfNO_RCPT_ACTION	NoRecipientAction
132368694Seric					What to do if there are no legal
132468694Seric					recipient fields (To:, Cc: or Bcc:)
132568694Seric					in the message.  Legal values can
132668694Seric					be "none" to just leave the
132768694Seric					nonconforming message as is, "add-to"
132868694Seric					to add a To: header with all the
132968694Seric					known recipients (which may expose
133068694Seric					blind recipients), "add-apparently-to"
133168694Seric					to do the same but use Apparently-To:
133268694Seric					instead of To:, "add-bcc" to add an
133368694Seric					empty Bcc: header, or
133468694Seric					"add-to-undisclosed" to add the header
133568694Seric					``To: undisclosed-recipients:;''.
133668694Seric					Default is "none".
133768694SericconfSAFE_FILE_ENV	SafeFileEnvironment
133868694Seric					If set, sendmail will do a chroot()
133968694Seric					into this directory before writing
134068694Seric					files.
134168807SericconfCOLON_OK_IN_ADDR	ColonOkInAddr	If set, colons are treated as a regular
134268807Seric					character in addresses.  If not set,
134368807Seric					they are treated as the introducer to
134468807Seric					the RFC 822 "group" syntax.  Colons are
134568807Seric					handled properly in route-addrs.  This
134668807Seric					option defaults on for V5 and lower
134768807Seric					configuration files.
134857945Seric
134958087Seric
135057246Seric+-----------+
135157246Seric| HIERARCHY |
135257246Seric+-----------+
135357246Seric
135451220SericWithin this directory are several subdirectories, to wit:
135551220Seric
135651220Sericm4		General support routines.  These are typically
135751220Seric		very important and should not be changed without
135857247Seric		very careful consideration.
135951220Seric
136051220Sericcf		The configuration files themselves.  They have
136151220Seric		".mc" suffixes, and must be run through m4 to
136251220Seric		become complete.  The resulting output should
136351220Seric		have a ".cf" suffix.
136451220Seric
136551220Sericostype		Definitions describing a particular operating
136651220Seric		system type.  These should always be referenced
136751220Seric		using the OSTYPE macro in the .mc file.  Examples
136851220Seric		include "bsd4.3", "bsd4.4", "sunos3.5", and
136951220Seric		"sunos4.1".
137051220Seric
137151220Sericdomain		Definitions describing a particular domain, referenced
137251220Seric		using the DOMAIN macro in the .mc file.  These are
1373*68845Seric		site dependent; for example, "CS.Berkeley.EDU.m4"
1374*68845Seric		describes hosts in the CS.Berkeley.EDU subdomain.
137551220Seric
137651220Sericmailer		Descriptions of mailers.   These are referenced using
137751220Seric		the MAILER macro in the .mc file.
137851220Seric
137951220Sericsh		Shell files used when building the .cf file from the
138051220Seric		.mc file in the cf subdirectory.
138151220Seric
138251220Sericfeature		These hold special orthogonal features that you might
138351220Seric		want to include.  They should be referenced using
138451220Seric		the FEATURE macro.
138551220Seric
138651220Serichack		Local hacks.  These can be referenced using the HACK
138751220Seric		macro.  They shouldn't be of more than voyeuristic
138851220Seric		interest outside the .Berkeley.EDU domain, but who knows?
138965957Seric		We've all got our own peccadillos.
139051220Seric
139151268Sericsiteconfig	Site configuration -- e.g., tables of locally connected
139251268Seric		UUCP sites.
139351220Seric
139451268Seric
139557246Seric+------------------------+
139657246Seric| ADMINISTRATIVE DETAILS |
139757246Seric+------------------------+
139851220Seric
139951220SericThe following sections detail usage of certain internal parts of the
140051220Sericsendmail.cf file.  Read them carefully if you are trying to modify
140151220Sericthe current model.  If you find the above descriptions adequate, these
140251220Sericshould be {boring, confusing, tedious, ridiculous} (pick one or more).
140351220Seric
140451220SericRULESETS (* means built in to sendmail)
140551220Seric
140651220Seric   0 *	Parsing
140751220Seric   1 *	Sender rewriting
140851220Seric   2 *	Recipient rewriting
140951220Seric   3 *	Canonicalization
141051220Seric   4 *	Post cleanup
141154839Seric   5 *	Local address rewrite (after aliasing)
141260539Seric  1x	mailer rules (sender qualification)
141360539Seric  2x	mailer rules (recipient qualification)
141464801Seric  3x	mailer rules (sender header qualification)
141564801Seric  4x	mailer rules (recipient header qualification)
141664801Seric  5x	mailer subroutines (general)
141764801Seric  6x	mailer subroutines (general)
141864801Seric  7x	mailer subroutines (general)
141964801Seric  8x	reserved
142060539Seric  90	Mailertable host stripping
142160892Seric  96	Bottom half of Ruleset 3 (ruleset 6 in old sendmail)
142260892Seric  97	Hook for recursive ruleset 0 call (ruleset 7 in old sendmail)
142363857Seric  98	Local part of ruleset 0 (ruleset 8 in old sendmail)
142451220Seric
142551220Seric
142651220SericMAILERS
142751220Seric
142851220Seric   0	local, prog	local and program mailers
142965218Seric   1	[e]smtp, relay	SMTP channel
143065218Seric   2	uucp-*		UNIX-to-UNIX Copy Program
143158087Seric   3	netnews		Network News delivery
143258363Seric   4	fax		Sam Leffler's FlexFAX software
143351220Seric
143451220Seric
143551220SericMACROS
143651220Seric
143751220Seric   A
143851220Seric   B	Bitnet Relay
143965182Seric   C
144054839Seric   D	The local domain -- usually not needed
144151220Seric   E
144258363Seric   F	FAX Relay
144351220Seric   G
144457591Seric   H	mail Hub (for mail clusters)
144551220Seric   I
144651220Seric   J
144751220Seric   K
144867915Seric   L	Luser Relay
144951220Seric   M	Masquerade (who I claim to be)
145051220Seric   N
145151220Seric   O
145251220Seric   P
145351220Seric   Q
145451220Seric   R	Relay (for unqualified names)
145558071Seric   S	Smart Host
145651220Seric   T
145751309Seric   U	my UUCP name (if I have a UUCP connection)
145851309Seric   V	UUCP Relay (class V hosts)
145951220Seric   W	UUCP Relay (class W hosts)
146051220Seric   X	UUCP Relay (class X hosts)
146151309Seric   Y	UUCP Relay (all other hosts)
146251220Seric   Z	Version number
146351220Seric
146451220Seric
146551220SericCLASSES
146651220Seric
146751220Seric   A
146851220Seric   B
146951220Seric   C
147067539Seric   D	"dotted" users
147157246Seric   E	addresses that should not seem to come from $M
147254839Seric   F	hosts we forward for
147351220Seric   G
147451220Seric   H
147551220Seric   I
147651220Seric   J
147751220Seric   K
147851220Seric   L	addresses that should not be forwarded to $R
147951220Seric   M
148051220Seric   N
148151220Seric   O	operators that indicate network operations (cannot be in local names)
148260211Seric   P	top level pseudo-domains: BITNET, FAX, UUCP, etc.
148351220Seric   Q
148451220Seric   R
148551220Seric   S
148651220Seric   T
148751220Seric   U	locally connected UUCP hosts
148851309Seric   V	UUCP hosts connected to relay $V
148951309Seric   W	UUCP hosts connected to relay $W
149051309Seric   X	UUCP hosts connected to relay $X
149151309Seric   Y	locally connected smart UUCP hosts
149264153Seric   Z	locally connected domain-ized UUCP hosts
149354839Seric   .	the class containing only a dot
149451220Seric
149551220Seric
149651220SericM4 DIVERSIONS
149751220Seric
149858071Seric   1	Local host detection and resolution
149958071Seric   2	Local Ruleset 3 additions
150058071Seric   3	Local Ruleset 0 additions
150151268Seric   4	UUCP Ruleset 0 additions
150251309Seric   5	locally interpreted names (overrides $R)
150354839Seric   6	local configuration (at top of file)
150451220Seric   7	mailer definitions
150566099Seric   8
150658681Seric   9	special local rulesets (1 and 2)
1507