xref: /csrg-svn/usr.sbin/sendmail/cf/README (revision 68749)
151220Seric
251220Seric
357246Seric		NEW SENDMAIL CONFIGURATION FILES
451220Seric
557246Seric		Eric Allman <eric@CS.Berkeley.EDU>
651220Seric
7*68749Seric		@(#)README	8.51 (Berkeley) 04/08/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
6851220SericLet's examine a typical .mc file (cf/cs-exposed.mc):
6951220Seric
7051220Seric	divert(-1)
7151220Seric	#
7251220Seric	# Copyright (c) 1983 Eric P. Allman
7351220Seric	# Copyright (c) 1988 The Regents of the University of California.
7451220Seric	# All rights reserved.
7551220Seric	#
7651220Seric	# Redistribution and use in source and binary forms are permitted
7751220Seric	# provided that the above copyright notice and this paragraph are
7851220Seric	# duplicated in all such forms and that any documentation,
7951220Seric	# advertising materials, and other materials related to such
8051220Seric	# distribution and use acknowledge that the software was developed
8151220Seric	# by the University of California, Berkeley.  The name of the
8251220Seric	# University may not be used to endorse or promote products derived
8351220Seric	# from this software without specific prior written permission.
8451220Seric	# THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
8551220Seric	# IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
8651220Seric	# WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
8751220Seric	#
8851220Seric
8957246SericThe divert(-1) will delete the crud in the resulting output file.
9057247SericThe copyright notice is what your lawyers require.  Our lawyers require
9157246Sericthe one that I've included in my files. A copyleft is a copyright by
9257246Sericanother name.
9351220Seric
9457246SericThe next line MUST be
9557246Seric
9651220Seric	include(`../m4/cf.m4')
9751220Seric
9857246SericThis will pull in the M4 macros you will need to make sense of
9957246Sericeverything else.  As the saying goes, don't think about it, just
10057246Sericdo it.  If you don't do it, don't bother reading the rest of this
10157246Sericfile.
10251220Seric
10356778Seric	VERSIONID(`<SCCS or RCS version id>')
10451220Seric
10551220SericVERSIONID is a macro that stuffs the version information into the
10651220Sericresulting file.  We use SCCS; you could use RCS, something else, or
10757246Sericomit it completely.  This is not the same as the version id included
10857246Sericin SMTP greeting messages -- this is defined in m4/version.m4.
10951220Seric
11051268Seric	DOMAIN(cs.exposed)
11151220Seric
11251220SericThis example exposes the host inside of the CS subdomain -- that is,
11351220Sericit doesn't try to hide the name of the workstation to the outside
11451220Sericworld.  Changing this to DOMAIN(cs.hidden) would have made outgoing
11551220Sericmessages refer to "<username>@CS.Berkeley.EDU" instead of using the
11663857Sericlocal hostname.  Internally this is effected by using
11757246Seric"MASQUERADE_AS(CS.Berkeley.EDU)".
11851220Seric
11951268Seric	MAILER(smtp)
12051220Seric
12151309SericThese describe the mailers used at the default CS site site.  The
12251309Sericlocal mailer is always included automatically.
12351220Seric
12458087Seric
12557246Seric+--------+
12657246Seric| OSTYPE |
12757246Seric+--------+
12857246Seric
12951220SericNote that cf/cs-exposed.mc omits an OSTYPE macro -- this assumes
13051220Sericdefault Computer Science Division environment.  There are several
13157247Sericexplicit environments available: bsd4.3, bsd4.4, hpux, irix, osf1,
13257247Sericriscos4.5, sunos3.5, sunos4.1, and ultrix4.1.  These change things
13357247Sericlike the location of the alias file and queue directory.  Some of
13457247Sericthese files are identical to one another.
13551220Seric
13657246SericOperating system definitions are easy to write.  They may define
13757246Sericthe following variables (everything defaults, so an ostype file
13857246Sericmay be empty).
13951220Seric
14057246SericALIAS_FILE		[/etc/aliases] The location of the text version
14159761Seric			of the alias file(s).  It can be a comma-separated
14266790Seric			list of names (but be sure you quote values with
14368452Seric			commas in them -- for example, use
14466790Seric				define(`ALIAS_FILE', `a,b')
14566790Seric			to get "a" and "b" both listed as alias files;
14666790Seric			otherwise the define() primitive only sees "a").
14757246SericHELP_FILE		[/usr/lib/sendmail.hf] The name of the file
14857246Seric			containing information printed in response to
14957246Seric			the SMTP HELP command.
15057246SericQUEUE_DIR		[/var/spool/mqueue] The directory containing
15157246Seric			queue files.
15257246SericSTATUS_FILE		[/etc/sendmail.st] The file containing status
15357246Seric			information.
15458087SericLOCAL_MAILER_PATH	[/bin/mail] The program used to deliver local mail.
15564153SericLOCAL_MAILER_FLAGS	[rmn] The flags used by the local mailer.  The
15664153Seric			flags lsDFM are always included.
15763761SericLOCAL_MAILER_ARGS	[mail -d $u] The arguments passed to deliver local
15863761Seric			mail.
15968340SericLOCAL_MAILER_MAX	[undefined] If defined, the maximum size of local
16068340Seric			mail that you are willing to accept.
16158087SericLOCAL_SHELL_PATH	[/bin/sh] The shell used to deliver piped email.
16263791SericLOCAL_SHELL_FLAGS	[eu] The flags used by the shell mailer.  The
16363791Seric			flags lsDFM are always included.
16463791SericLOCAL_SHELL_ARGS	[sh -c $u] The arguments passed to deliver "prog"
16563791Seric			mail.
16667989SericLOCAL_SHELL_DIR		[$z:/] The directory search path in which the
16767989Seric			shell should run.
16858087SericUSENET_MAILER_PATH	[/usr/lib/news/inews] The name of the program
16958087Seric			used to submit news.
17058087SericUSENET_MAILER_FLAGS	[rlsDFMmn] The mailer flags for the usenet mailer.
17158087SericUSENET_MAILER_ARGS	[-m -h -n] The command line arguments for the
17258087Seric			usenet mailer.
17365911SericUSENET_MAILER_MAX	[100000] The maximum size of messages that will
17465911Seric			be accepted by the usenet mailer.
17563857SericSMTP_MAILER_FLAGS	[undefined] Flags added to SMTP mailer.  Default
17667915Seric			flags are `mDFMUX' for all SMTP-based mailers; the
17767915Seric			"esmtp" mailer adds `a' and "smtp8" adds `8'.
17865911SericSMTP_MAILER_MAX		[undefined] The maximum size of messages that will
17967915Seric			be transported using the smtp, smtp8, or esmtp
18067915Seric			mailers.
18167915SericSMTP_MAILER_ARGS	[IPC $h] The arguments passed to the smtp mailer.
18267915Seric			About the only reason you would want to change this
18367915Seric			would be to change the default port.
18467915SericESMTP_MAILER_ARGS	[IPC $h] The arguments passed to the esmtp mailer.
18567915SericSMTP8_MAILER_ARGS	[IPC $h] The arguments passed to the smtp8 mailer.
18667915SericRELAY_MAILER_ARGS	[IPC $h] The arguments passed to the relay mailer.
18763857SericUUCP_MAILER_FLAGS	[undefined] Flags added to UUCP mailer.  Default
18868694Seric			flags are `DFMhuU' (and `m' for uucp-new mailer,
18968694Seric			minus `U' for uucp-dom mailer).
19068057SericUUCP_MAILER_ARGS	[uux - -r -z -a$g -gC $h!rmail ($u)] The arguments
19163761Seric			passed to the UUCP mailer.
19263791SericUUCP_MAX_SIZE		[100000] The maximum size message accepted for
19363791Seric			transmission by the UUCP mailers.
19465911SericFAX_MAILER_PATH		[/usr/local/lib/fax/mailfax] The program used to
19565911Seric			submit FAX messages.
19665911SericFAX_MAILER_MAX		[100000] The maximum size message accepted for
19765911Seric			transmission by FAX.
19867934SericPOP_MAILER_PATH		[/usr/lib/mh/spop] The pathname of the POP mailer.
19967934SericPOP_MAILER_FLAGS	[Penu] Flags added to POP mailer.  Flags "lsDFM"
20067934Seric			are always added.
20167934SericPOP_MAILER_ARGS		[pop $u] The arguments passed to the POP mailer.
20267942SericPROCMAIL_MAILER_FLAGS	[Shu] Flags added to Procmail mailer.  Flags
20367942Seric			``DFMmn'' are always set.
20467942SericPROCMAIL_MAILER_ARGS	[procmail -m $h $f $u] The arguments passed to
20567942Seric			the Procmail mailer.
20668340SericPROCMAIL_MAILER_MAX	[undefined] If set, the maximum size message that
20768340Seric			will be accepted by the procmail mailer.
20857246Seric
20957246Seric+---------+
21057246Seric| DOMAINS |
21157246Seric+---------+
21257246Seric
21357246SericYou will probably want to collect domain-dependent defines into one
21457246Sericfile, referenced by the DOMAIN macro.  For example, our Berkeley
21557246Sericdomain file includes definitions for several internal distinguished
21657246Serichosts:
21757246Seric
21857246SericUUCP_RELAY	The host that will forward UUCP-addressed email.
21957246Seric		If not defined, all UUCP sites must be directly
22064028Seric		connected.
22157246SericBITNET_RELAY	The host that will forward BITNET-addressed email.
22257246Seric		If not defined, the .BITNET pseudo-domain won't work.
22368697SericLOCAL_RELAY	DEPRECATED.  The site that will handle unqualified
22468697Seric		names -- that is, names with out an @domain extension.
22568697Seric		If not set, they are assumed to belong on this machine.
22668697Seric		This allows you to have a central site to store a
22757246Seric		company- or department-wide alias database.  This
22868697Seric		only works at small sites, and only with some user
22968697Seric		agents.
23067915SericLUSER_RELAY	The site that will handle lusers -- that is, apparently
23167915Seric		local names that aren't local accounts or aliases.
23257246Seric
23367915SericAny of these can be either ``mailer:hostname'' (in which case the
23468694Sericmailer is the internal mailer name, such as ``uucp-new'' and the hostname
23564028Sericis the name of the host as appropriate for that mailer) or just a
23664028Seric``hostname'', in which case a default mailer type (usually ``relay'',
23764153Serica variant on SMTP) is used.  WARNING: if you have a wildcard MX
23864153Sericrecord matching your domain, you probably want to define these to
23964153Serichave a trailing dot so that you won't get the mail diverted back
24064153Sericto yourself.
24164028Seric
24257246SericThe domain file can also be used to define a domain name, if needed
24357982Seric(using "DD<domain>") and set certain site-wide features.  If all hosts
24457982Sericat your site masquerade behind one email name, you could also use
24557982SericMASQUERADE_AS here.
24657246Seric
24758408SericYou do not have to define a domain -- in particular, if you are a
24858408Sericsingle machine sitting off somewhere, it is probably more work than
24958408Sericit's worth.  This is just a mechanism for combining "domain dependent
25058408Sericknowledge" into one place.
25158408Seric
25257246Seric+---------+
25357246Seric| MAILERS |
25457246Seric+---------+
25557246Seric
25651220SericThere are fewer mailers supported in this version than the previous
25751220Sericversion, owing mostly to a simpler world.
25851220Seric
25951220Sericlocal		The local and prog mailers.  You will almost always
26051220Seric		need these; the only exception is if you relay ALL
26157247Seric		your mail to another site.  This mailer is included
26257247Seric		automatically.
26351220Seric
26451220Sericsmtp		The Simple Mail Transport Protocol mailer.  This does
26551220Seric		not hide hosts behind a gateway or another other
26651220Seric		such hack; it assumes a world where everyone is
26763761Seric		running the name server.  This file actually defines
26867915Seric		four mailers: "smtp" for regular (old-style) SMTP to
26963761Seric		other servers, "esmtp" for extended SMTP to other
27067915Seric		servers, "smtp8" to do SMTP to other servers without
27167915Seric		converting 8-bit data to MIME (essentially, this is
27267915Seric		your statement that you know the other end is 8-bit
27367915Seric		clean even if it doesn't say so), and "relay" for
27467915Seric		transmission to our RELAY_HOST, LUSER_RELAY, or
27567915Seric		MAILER_HUB.
27651220Seric
27751220Sericuucp		The Unix-to-Unix Copy Program mailer.  Actually, this
27867471Seric		defines two mailers, "uucp-old" (a.k.a. "uucp") and
27967471Seric		"uucp-new" (a.k.a. "suucp").  The latter is for when you
28067471Seric		know that the UUCP mailer at the other end can handle
28167471Seric		multiple recipients in one transfer.  If the smtp mailer
28267471Seric		is also included in your configuration, two other mailers
28368694Seric		("uucp-dom" and "uucp-uudom") are also defined [warning:
28468694Seric		you MUST specify MAILER(smtp) before MAILER(uucp)].  When you
28567471Seric		include the uucp mailer, sendmail looks for all names in
28665218Seric		the $=U class and sends them to the uucp-old mailer; all
28765218Seric		names in the $=Y class are sent to uucp-new; and all
28865218Seric		names in the $=Z class are sent to uucp-uudom.  Note that
28957246Seric		this is a function of what version of rmail runs on
29057246Seric		the receiving end, and hence may be out of your control.
29165218Seric		See the section below describing UUCP mailers in more
29265218Seric		detail.
29351220Seric
29458087Sericusenet		Usenet (network news) delivery.  If this is specified,
29558087Seric		an extra rule is added to ruleset 0 that forwards all
29658087Seric		local email for users named ``group.usenet'' to the
29758087Seric		``inews'' program.  Note that this works for all groups,
29858087Seric		and may be considered a security problem.
29958087Seric
30058363Sericfax		Facsimile transmission.  This is experimental and based
30158363Seric		on Sam Leffler's FlexFAX software.  For more information,
30258363Seric		see below.
30358087Seric
30465148Sericpop		Post Office Protocol.
30558363Seric
30667942Sericprocmail	An interface to procmail (does not come with sendmail).
30767942Seric		This is designed to be used in mailertables.  For example,
30867942Seric		a common question is "how do I forward all mail for a given
30967942Seric		domain to a single person?".  If you have this mailer
31067942Seric		defined, you could set up a mailertable reading:
31167942Seric
31267942Seric			host.com	procmail:/etc/procmailrcs/host.com
31367942Seric
31467942Seric		with the file /etc/procmailrcs/host.com reading:
31567942Seric
31667942Seric			:0	# forward mail for host.com
31767942Seric			! -oi -f $1 person@other.host
31867942Seric
31967942Seric		This would arrange for (anything)@host.com to be sent
32067942Seric		to person@other.host.  Within the procmail script, $1 is
32167942Seric		the name of the sender and $2 is the name of the recipient.
32267942Seric		If you use this with FEATURE(local_procmail), the FEATURE
32367942Seric		should be listed first.
32467942Seric
32567929SericThe local mailer accepts addresses of the form "user+detail", where
32667929Sericthe "+detail" is not used for mailbox matching but is available
32767942Sericto certain local mail programs (in particular, see FEATURE(local_procmail)).
32867929SericFor example, "eric", "eric+sendmail", and "eric+sww" all indicate
32967929Sericthe same user, but additional arguments <null>, "sendmail", and "sww"
33067929Sericmay be provided for use in sorting mail.
33165148Seric
33267929Seric
33357246Seric+----------+
33457246Seric| FEATURES |
33557246Seric+----------+
33651268Seric
33757246SericSpecial features can be requested using the "FEATURE" macro.  For
33857246Sericexample, the .mc line:
33957246Seric
34057246Seric	FEATURE(use_cw_file)
34157246Seric
34257246Serictells sendmail that you want to have it read an /etc/sendmail.cw
34358782Sericfile to get values for class $=w.  The FEATURE may contain a single
34458782Sericoptional parameter -- for example:
34557246Seric
34658782Seric	FEATURE(mailertable, dbm /usr/lib/mailertable)
34758782Seric
34858782SericAvailable features are:
34958782Seric
35057246Sericuse_cw_file	Read the file /etc/sendmail.cw file to get alternate
35157246Seric		names for this host.  This might be used if you were
35257246Seric		on a host that MXed for a dynamic set of other
35357246Seric		hosts.  If the set is static, just including the line
35457246Seric		"Cw<name1> <name2> ..." is probably superior.
35558408Seric		The actual filename can be overridden by redefining
35658408Seric		confCW_FILE.
35764324Seric
35858087Sericredirect	Reject all mail addressed to "address.REDIRECT" with
35958087Seric		a ``551 User not local; please try <address>'' message.
36058087Seric		If this is set, you can alias people who have left
36158087Seric		to their new address with ".REDIRECT" appended.
36264324Seric
36358284Sericnouucp		Don't do anything special with UUCP addresses at all.
36464324Seric
36559080Sericnocanonify	Don't pass addresses to $[ ... $] for canonification.
36659080Seric		This would generally only be used by sites that only
36759080Seric		act as mail gateways or which have user agents that do
36864028Seric		full canonification themselves.  You may also want to
36964028Seric		use "define(`confBIND_OPTS',`-DNSRCH -DEFNAMES')" to
37064028Seric		turn off the usual resolver options that do a similar
37164028Seric		thing.
37264324Seric
37367917Sericstickyhost	If set, email sent to "user@local.host" are marked
37458526Seric		as "sticky" -- that is, the local addresses aren't
37558526Seric		matched against UDB and don't go through ruleset 5.
37667915Seric		This is used if you want a set up where "user" is
37767915Seric		not necessarily the same as "user@local.host", e.g.,
37867915Seric		to make a distinct domain-wide namespace.  Prior to
37967915Seric		8.7 this was the default, and notsticky was used to
38067915Seric		turn this off.
38164324Seric
38258782Sericmailertable	Include a "mailer table" which can be used to override
38358782Seric		routing for particular domains.  The argument of the
38458782Seric		FEATURE may be the key definition.  If none is specified,
38558782Seric		the definition used is:
38664164Seric			hash -o /etc/mailertable
38763761Seric		Keys in this database are fully qualified domain names
38863761Seric		or partial domains preceded by a dot -- for example,
38963761Seric		"vangogh.CS.Berkeley.EDU" or ".CS.Berkeley.EDU".
39063761Seric		Values must be of the form:
39158782Seric			mailer:domain
39263761Seric		where "mailer" is the internal mailer name, and "domain"
39363761Seric		is where to send the message.  These maps are not
39463761Seric		reflected into the message header.
39564324Seric
39663761Sericdomaintable	Include a "domain table" which can be used to provide
39767451Seric		domain name mapping.  Use of this should really be
39867451Seric		limited to your own domains.  It may be useful if you
39967451Seric		change names (e.g., your company changes names from
40067451Seric		oldname.com to newname.com).  The argument of the
40167451Seric		FEATURE may be the key definition.  If none is specified,
40267451Seric		the definition used is:
40364164Seric			hash -o /etc/domaintable
40467451Seric		The key in this table is the domain name; the value is
40567451Seric		the new (fully qualified) domain.  Anything in the
40663761Seric		domaintable is reflected into headers; that is, this
40763761Seric		is done in ruleset 3.
40864324Seric
40959034Sericbitdomain	Look up bitnet hosts in a table to try to turn them into
41059034Seric		internet addresses.  The table can be built using the
41164153Seric		bitdomain program contributed by John Gardiner Myers.
41259034Seric		The argument of the FEATURE may be the key definition; if
41359034Seric		none is specified, the definition used is:
41464164Seric			hash -o /etc/bitdomain.db
41559034Seric		Keys are the bitnet hostname; values are the corresponding
41659034Seric		internet hostname.
41764324Seric
41859037Sericuucpdomain	Similar feature for UUCP hosts.  The default map definition
41959037Seric		is:
42064164Seric			hash -o /etc/uudomain.db
42159037Seric		At the moment there is no automagic tool to build this
42259037Seric		database.
42364324Seric
42460263Sericalways_add_domain
42560263Seric		Include the local host domain even on locally delivered
42660263Seric		mail.  Normally it is not added unless it is already
42760263Seric		present.
42864324Seric
42963761Sericallmasquerade	If masquerading is enabled (using MASQUERADE_AS), this
43063761Seric		feature will cause recipient addresses to also masquerade
43163761Seric		as being from the masquerade host.  Normally they get
43263761Seric		the local hostname.  Although this may be right for
43363761Seric		ordinary users, it can break local aliases.  For example,
43463761Seric		if you send to "localalias", the originating sendmail will
43563761Seric		find that alias and send to all members, but send the
43663761Seric		message with "To: localalias@masqueradehost".  Since that
43763761Seric		alias likely does not exist, replies will fail.  Use this
43863761Seric		feature ONLY if you can guarantee that the ENTIRE
43963761Seric		namespace on your masquerade host supersets all the
44063761Seric		local entries.
44164324Seric
44264153Sericnodns		We aren't running DNS at our site (for example,
44364153Seric		we are UUCP-only connected).  It's hard to consider
44464153Seric		this a "feature", but hey, it had to go somewhere.
44557246Seric
44664324Sericnullclient	This is a special case -- it creates a stripped down
44764324Seric		configuration file containing nothing but support for
44864394Seric		forwarding all mail to a central hub via a local
44964394Seric		SMTP-based network.  The argument is the name of that
45064394Seric		hub.
45164394Seric
45264394Seric		The only other feature that should be used in conjunction
45364394Seric		with this one is "nocanonify" (this causes addresses to
45464394Seric		be sent unqualified via the SMTP connection; normally
45564394Seric		they are qualifed with the masquerade name, which
45664394Seric		defaults to the name of the hub machine).  No mailers
45764394Seric		should be defined.  No aliasing or forwarding is done.
45857246Seric
45967942Sericlocal_procmail	Use procmail as the local mailer.  This mailer can
46067929Seric		make use of the "user+indicator@local.host" syntax;
46167929Seric		normally the +indicator is just tossed, but by default
46267929Seric		it is passed as the -a argument to procmail.  The
46367929Seric		argument to this feature is the pathname of procmail,
46467929Seric		which defaults to /usr/local/bin/procmail.
46564324Seric
46668206Sericbestmx_is_local	Accept mail as though locally addressed for any host that
46768206Seric		lists us as the best possible MX record.  This generates
46868206Seric		additional DNS traffic, but should be OK for low to
46968206Seric		medium traffic hosts.
47067929Seric
47168216Sericsmrsh		Use the SendMail Restricted SHell (smrsh) provided
47268216Seric		with the distribution instead of /bin/sh for mailing
47368216Seric		to programs.  This improves the ability of the local
47468216Seric		system administrator to control what gets run via
47568216Seric		e-mail.  If an argument is provided it is used as the
47668216Seric		pathname to smrsh; otherwise, /usr/local/etc/smrsh is
47768216Seric		assumed.
47868206Seric
47968216Seric
48057246Seric+-------+
48157246Seric| HACKS |
48257246Seric+-------+
48357246Seric
48457246SericSome things just can't be called features.  To make this clear,
48557247Sericthey go in the hack subdirectory and are referenced using the HACK
48657246Sericmacro.  These will tend to be site-dependent.  The release
48757246Sericincludes the Berkeley-dependent "cssubdomain" hack (that makes
48857246Sericsendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU;
48957246Sericthis is intended as a short-term aid while we move hosts into
49057246Sericsubdomains.
49157246Seric
49258087Seric
49357246Seric+--------------------+
49457246Seric| SITE CONFIGURATION |
49557246Seric+--------------------+
49657246Seric
49768057Seric    *****************************************************
49868057Seric    * This section is really obsolete, and is preserved	*
49968057Seric    * only for back compatibility.  You should plan on	*
50068057Seric    * using mailertables for new installations.	  In	*
50168057Seric    * particular, it doesn't work for the newer forms	*
50268057Seric    * of UUCP mailers, such as uucp-uudom.		*
50368057Seric    *****************************************************
50468057Seric
50557246SericComplex sites will need more local configuration information, such as
50657246Sericlists of UUCP hosts they speak with directly.  This can get a bit more
50757246Serictricky.  For an example of a "complex" site, see cf/ucbvax.mc.
50857246Seric
50966336SericIf your host is known by several different names, you need to augment
51066336Sericthe $=w class.  This is a list of names by which you are known, and
51166336Sericanything sent to an address using a host name in this list will be
51266336Serictreated as local mail.  You can do this in two ways: either create
51366336Sericthe file /etc/sendmail.cw containing a list of your aliases (one per
51466336Sericline), and use ``FEATURE(use_cw_file)'' in the .mc file, or add the
51566336Sericline:
51666336Seric
51766336Seric	Cw alias.host.name
51866336Seric
51966336Sericat the end of that file.  See the ``vangogh.mc'' file for an example.
52066336SericBe sure you use the fully-qualified name of the host, rather than a
52166336Sericshort name.
52266336Seric
52357246SericThe SITECONFIG macro allows you to indirectly reference site-dependent
52457246Sericconfiguration information stored in the siteconfig subdirectory.  For
52557246Sericexample, the line
52657246Seric
52757246Seric	SITECONFIG(uucp.ucbvax, ucbvax, U)
52857246Seric
52957246Sericreads the file uucp.ucbvax for local connection information.  The
53057246Sericsecond parameter is the local name (in this case just "ucbvax" since
53166336Sericit is locally connected, and hence a UUCP hostname).  The third
53266336Sericparameter is the name of both a macro to store the local name (in
53366336Sericthis case, $U) and the name of the class (e.g., $=U) in which to store
53466336Sericthe host information read from the file.  Another SITECONFIG line reads
53557246Seric
53657246Seric	SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W)
53757246Seric
53857246SericThis says that the file uucp.ucbarpa contains the list of UUCP sites
53957246Sericconnected to ucbarpa.Berkeley.EDU.  The $=W class will be used to
54066336Sericstore this list, and $W is defined to be ucbarpa.Berkeley.EDU, that
54166336Sericis, the name of the relay to which the hosts listed in uucp.ucbarpa
54266336Sericare connected.  [The machine ucbarpa is gone now, but I've left
54357246Sericthis out-of-date configuration file around to demonstrate how you
54457246Sericmight do this.]
54557246Seric
54666336SericNote that the case of SITECONFIG with a third parameter of ``U'' is
54766336Sericspecial; the second parameter is assumed to be the UUCP name of the
54866336Sericlocal site, rather than the name of a remote site, and the UUCP name
54966336Sericis entered into $=w (the list of local hostnames) as $U.UUCP.
55066336Seric
55157246SericThe siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing
55257246Sericmore than a sequence of SITE macros describing connectivity.  For
55357246Sericexample:
55457246Seric
55557246Seric	SITE(cnmat)
55657246Seric	SITE(sgi olympus)
55757246Seric
55857246SericThe second example demonstrates that you can use two names on the
55957246Sericsame line; these are usually aliases for the same host (or are at
56057246Sericleast in the same company).
56157246Seric
56258087Seric
56365218Seric+--------------------+
56465218Seric| USING UUCP MAILERS |
56565218Seric+--------------------+
56665218Seric
56765218SericIt's hard to get UUCP mailers right because of the extremely ad hoc
56865218Sericnature of UUCP addressing.  These config files are really designed
56965218Sericfor domain-based addressing, even for UUCP sites.
57065218Seric
57165218SericThere are four UUCP mailers available.  The choice of which one to
57265218Sericuse is partly a matter of local preferences and what is running at
57365218Sericthe other end of your UUCP connection.  Unlike good protocols that
57465218Sericdefine what will go over the wire, UUCP uses the policy that you
57565218Sericshould do what is right for the other end; if they change, you have
57665218Sericto change.  This makes it hard to do the right thing, and discourages
57765218Sericpeople from updating their software.  In general, if you can avoid
57865218SericUUCP, please do.
57965218Seric
58065218SericThe major choice is whether to go for a domainized scheme or a
58165218Sericnon-domainized scheme.  This depends entirely on what the other
58265218Sericend will recognize.  If at all possible, you should encourage the
58365218Sericother end to go to a domain-based system -- non-domainized addresses
58465218Sericdon't work entirely properly.
58565218Seric
58665218SericThe four mailers are:
58765218Seric
58865218Seric    uucp-old (obsolete name: "uucp")
58965218Seric	This is the oldest, the worst (but the closest to UUCP) way of
59065218Seric	sending messages accros UUCP connections.  It does bangify
59165218Seric	everything and prepends $U (your UUCP name) to the sender's
59265218Seric	address (which can already be a bang path itself).  It can
59365218Seric	only send to one address at a time, so it spends a lot of
59465218Seric	time copying duplicates of messages.  Avoid this if at all
59565218Seric	possible.
59665218Seric
59765218Seric    uucp-new (obsolete name: "suucp")
59865218Seric	The same as above, except that it assumes that in one rmail
59965218Seric	command you can specify several recipients.  It still has a
60065218Seric	lot of other problems.
60165218Seric
60265218Seric    uucp-dom
60365218Seric	This UUCP mailer keeps everything as domain addresses.
60467471Seric	Basically, it uses the SMTP mailer rewriting rules.  This mailer
60567471Seric	is only included if MAILER(smtp) is also specified.
60665218Seric
60765218Seric	Unfortunately, a lot of UUCP mailer transport agents require
60865218Seric	bangified addresses in the envelope, although you can use
60965218Seric	domain-based addresses in the message header.  (The envelope
61065218Seric	shows up as the From_ line on UNIX mail.)  So....
61165218Seric
61265218Seric    uucp-uudom
61365218Seric	This is a cross between uucp-new (for the envelope addresses)
61465218Seric	and uucp-dom (for the header addresses).  It bangifies the
61565218Seric	envelope sender (From_ line in messages) without adding the
61665218Seric	local hostname, unless there is no host name on the address
61765218Seric	at all (e.g., "wolf") or the host component is a UUCP host name
61865218Seric	instead of a domain name ("somehost!wolf" instead of
61967471Seric	"some.dom.ain!wolf").  This is also included only if MAILER(smtp)
62067471Seric	is also specified.
62165218Seric
62265218SericExamples:
62365218Seric
62465218SericWe are on host grasp.insa-lyon.fr (UUCP host name "grasp").  The
62565218Sericfollowing summarizes the sender rewriting for various mailers.
62665218Seric
62765218SericMailer          sender		rewriting in the envelope
62865218Seric------		------		-------------------------
62965218Sericuucp-{old,new}	wolf		grasp!wolf
63065218Sericuucp-dom	wolf		wolf@grasp.insa-lyon.fr
63165218Sericuucp-uudom	wolf		grasp.insa-lyon.fr!wolf
63265218Seric
63365218Sericuucp-{old,new}	wolf@fr.net	grasp!fr.net!wolf
63465218Sericuucp-dom	wolf@fr.net	wolf@fr.net
63565218Sericuucp-uudom	wolf@fr.net	fr.net!wolf
63665218Seric
63765218Sericuucp-{old,new}	somehost!wolf	grasp!somehost!wolf
63865218Sericuucp-dom	somehost!wolf	somehost!wolf@grasp.insa-lyon.fr
63965218Sericuucp-uudom	somehost!wolf	grasp.insa-lyon.fr!somehost!wolf
64065218Seric
64165218SericIf you are using one of the domainized UUCP mailers, you really want
64265218Sericto convert all UUCP addresses to domain format -- otherwise, it will
64365218Sericdo it for you (and probably not the way you expected).  For example,
64465218Sericif you have the address foo!bar!baz (and you are not sending to foo),
64565218Sericthe heuristics will add the @uucp.relay.name or @local.host.name to
64665218Sericthis address.  However, if you map foo to foo.host.name first, it
64765218Sericwill not add the local hostname.  You can do this using the uucpdomain
64865218Sericfeature.
64965218Seric
65065218Seric
65157246Seric+-------------------+
65257246Seric| TWEAKING RULESETS |
65357246Seric+-------------------+
65457246Seric
65551268SericFor more complex configurations, you can define special rules.
65651268SericThe macro LOCAL_RULE_3 introduces rules that are used in canonicalizing
65751268Sericthe names.  Any modifications made here are reflected in the header.
65851268Seric
65951268SericA common use is to convert old UUCP addreses to SMTP addresses using
66051268Sericthe UUCPSMTP macro.  For example:
66151268Seric
66251268Seric	LOCAL_RULE_3
66351268Seric	UUCPSMTP(decvax,	decvax.dec.com)
66451268Seric	UUCPSMTP(research,	research.att.com)
66551268Seric
66651268Sericwill cause addresses of the form "decvax!user" and "research!user"
66751268Sericto be converted to "user@decvax.dec.com" and "user@research.att.com"
66851268Sericrespectively.
66951268Seric
67065957SericThis could also be used to look up hosts in a database map:
67157246Seric
67257246Seric	LOCAL_RULE_3
67357246Seric	R$* < @ $+ > $*		$: $1 < @ $(hostmap $2 $) > $3
67457246Seric
67557246SericThis map would be defined in the LOCAL_CONFIG portion, as shown below.
67657246Seric
67751268SericSimilarly, LOCAL_RULE_0 can be used to introduce new parsing rules.
67851268SericFor example, new rules are needed to parse hostnames that you accept
67951309Sericvia MX records.  For example, you might have:
68051268Seric
68151309Seric	LOCAL_RULE_0
68265986Seric	R$+ <@ host.dom.ain.>	$#uucp $@ cnmat $: $1 < @ host.dom.ain.>
68351309Seric
68451309SericYou would use this if you had installed an MX record for cnmat.Berkeley.EDU
68551309Sericpointing at this host; this rule catches the message and forwards it on
68651309Sericusing UUCP.
68751309Seric
68858681SericYou can also tweak rulesets 1 and 2 using LOCAL_RULE_1 and LOCAL_RULE_2.
68958681SericThese rulesets are normally empty.
69058681Seric
69157246SericA similar macro is LOCAL_CONFIG.  This introduces lines added after the
69257246Sericboilerplate option setting but before rulesets, and can be used to
69357945Sericdeclare local database maps or whatever.  For example:
69451268Seric
69557246Seric	LOCAL_CONFIG
69657246Seric	Khostmap hash /etc/hostmap.db
69757246Seric	Kyplocal nis -m hosts.byname
69851220Seric
69958087Seric
70057246Seric+---------------------------+
70157246Seric| MASQUERADING AND RELAYING |
70257246Seric+---------------------------+
70357246Seric
70457246SericYou can have your host masquerade as another using
70557246Seric
70657246Seric	MASQUERADE_AS(host.domain)
70757246Seric
70865957SericThis causes outgoing SMTP mail to be labeled as coming from the
70957246Sericindicated domain, rather than $j.  One normally masquerades as one
71065957Sericof one's own subdomains (for example, it's unlikely that I would
71157246Sericchoose to masquerade as an MIT site).
71257246Seric
71364153SericThe masquerade name is not normally canonified, so it is important
71464153Sericthat it be your One True Name, that is, fully qualified and not a
71564153SericCNAME.
71664153Seric
71757246Sericthere are always users that need to be "exposed" -- that is, their
71857246Sericinternal site name should be displayed instead of the masquerade name.
71957246SericRoot is an example.  You can add users to this list using
72057246Seric
72157246Seric	EXPOSED_USER(usernames)
72257246Seric
72357246SericThis adds users to class E; you could also use something like
72457246Seric
72557246Seric	FE/etc/sendmail.cE
72657246Seric
72757246SericYou can also arrange to relay all unqualified names (that is, names
72857246Sericwithout @host) to a relay host.  For example, if you have a central
72957246Sericemail server, you might relay to that host so that users don't have
73057246Sericto have .forward files or aliases.  You can do this using
73157246Seric
73258071Seric	define(`LOCAL_RELAY', mailer:hostname)
73357246Seric
73458071SericThe ``mailer:'' can be omitted, in which case the mailer defaults to
73558071Seric"smtp".  There are some user names that you don't want relayed, perhaps
73658071Sericbecause of local aliases.  A common example is root, which may be
73758071Sericlocally aliased.  You can add entries to this list using
73857246Seric
73957246Seric	LOCAL_USER(usernames)
74057246Seric
74157246SericThis adds users to class L; you could also use something like
74257246Seric
74357246Seric	FL/etc/sendmail.cL
74457246Seric
74564153SericIf you want all incoming mail sent to a centralized hub, as for a
74664153Sericshared /var/spool/mail scheme, use
74757591Seric
74858071Seric	define(`MAIL_HUB', mailer:hostname)
74957591Seric
75058071SericAgain, ``mailer:'' defaults to "smtp".  If you define both LOCAL_RELAY
75168697Sericand MAIL_HUB _AND_ you have FEATURE(stickyhost), unqualified names will
75268697Sericbe sent to the LOCAL_RELAY and other local names will be sent to MAIL_HUB.
75368697SericNames in $=L will be delivered locally, so you MUST have aliases or
75468697Seric.forward files for them.
75566047Seric
75668697SericFor example, if are on machine mastodon.CS.Berkeley.EDU and you have
75768697SericFEATURE(stickyhost), the following combinations of settings will have the
75868697Sericindicated effects:
75957591Seric
76057591Sericemail sent to....	eric			  eric@mastodon.CS.Berkeley.EDU
76157591Seric
76257591SericLOCAL_RELAY set to	mail.CS.Berkeley.EDU	  (delivered locally)
76368697Sericmail.CS.Berkeley.EDU	  (no local aliasing)	    (aliasing done)
76457591Seric
76557591SericMAIL_HUB set to		mammoth.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
76668697Sericmammoth.CS.Berkeley.EDU	  (aliasing done)	    (aliasing done)
76757591Seric
76857591SericBoth LOCAL_RELAY and	mail.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
76968697SericMAIL_HUB set as above	  (no local aliasing)	    (aliasing done)
77057591Seric
77168697SericIf you do not have FEATURE(stickyhost) set, then LOCAL_RELAY and
77268697SericMAIL_HUB act identically, with MAIL_HUB taking precedence.
77368697Seric
77464153SericIf you want all outgoing mail to go to a central relay site, define
77564153SericSMART_HOST as well.  Briefly:
77658071Seric
77764153Seric	LOCAL_RELAY applies to unqualifed names (e.g., "eric").
77864153Seric	MAIL_HUB applies to names qualified with the name of the
77964153Seric		local host (e.g., "eric@mastodon.CS.Berkeley.EDU").
78064153Seric	SMART_HOST applies to names qualified with other hosts.
78164153Seric
78264153SericHowever, beware that other relays (e.g., UUCP_RELAY, BITNET_RELAY, and
78364153SericFAX_RELAY) take precedence over SMART_HOST, so if you really want
78464153Sericabsolutely everything to go to a single central site you will need to
78564153Sericunset all the other relays -- or better yet, find or build a minimal
78664153Sericconfig file that does this.
78764153Seric
78864153Seric
78958071Seric+-------------------------------+
79058071Seric| NON-SMTP BASED CONFIGURATIONS |
79158071Seric+-------------------------------+
79258071Seric
79358071SericThese configuration files are designed primarily for use by SMTP-based
79458071Sericsites.  I don't pretend that they are well tuned for UUCP-only or
79558071SericUUCP-primarily nodes (the latter is defined as a small local net
79658071Sericconnected to the rest of the world via UUCP).  However, there is one
79758071Serichook to handle some special cases.
79858071Seric
79958071SericYou can define a ``smart host'' that understands a richer address syntax
80058071Sericusing:
80158071Seric
80258071Seric	define(`SMART_HOST', mailer:hostname)
80358071Seric
80464028SericIn this case, the ``mailer:'' defaults to "relay".  Any messages that
80558071Sericcan't be handled using the usual UUCP rules are passed to this host.
80658071Seric
80758071SericIf you are on a local SMTP-based net that connects to the outside
80858071Sericworld via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules.
80958071SericFor example:
81058071Seric
81158071Seric	define(`SMART_HOST', suucp:uunet)
81258071Seric	LOCAL_NET_CONFIG
81363761Seric	R$* < @ $* .$m. > $*	$#smtp $@ $2.$m. $: $1 < @ $2.$m. > $3
81458071Seric
81558071SericThis will cause all names that end in your domain name ($m) via
81658071SericSMTP; anything else will be sent via suucp (smart UUCP) to uunet.
81763761SericIf you have FEATURE(nocanonify), you may need to omit the dots after
81863761Sericthe $m.  If you are running a local DNS inside your domain which is
81963761Sericnot otherwise connected to the outside world, you probably want to
82063761Sericuse:
82158071Seric
82263761Seric	define(`SMART_HOST', smtp:fire.wall.com)
82363761Seric	LOCAL_NET_CONFIG
82463761Seric	R$* < @ $* . > $*	$#smtp $@ $2. $: $1 < @ $2. > $3
82558071Seric
82663761SericThat is, send directly only to things you found in your DNS lookup;
82763761Sericanything else goes through SMART_HOST.
82863761Seric
82964153SericIf you are not running DNS at all, it is important to use
83064153SericFEATURE(nodns) to avoid having sendmail queue everything waiting
83164153Sericfor the name server to come up.
83263761Seric
83364153Seric
83464259Seric+-----------+
83564259Seric| WHO AM I? |
83664259Seric+-----------+
83764259Seric
83864259SericNormally, the $j macro is automatically defined to be your fully
83964259Sericqualified domain name (FQDN).  Sendmail does this by getting your
84064259Serichost name using gethostname and then calling gethostbyname on the
84164259Sericresult.  For example, in some environments gethostname returns
84264259Sericonly the root of the host name (such as "foo"); gethostbyname is
84364259Sericsupposed to return the FQDN ("foo.bar.com").  In some (fairly rare)
84464259Sericcases, gethostbyname may fail to return the FQDN.  In this case
84564259Sericyou MUST define confDOMAIN_NAME to be your fully qualified domain
84664259Sericname.  This is usually done using:
84764259Seric
84864259Seric	Dmbar.com
84964259Seric	define(`confDOMAIN_NAME', `$w.$m')dnl
85064259Seric
85164259Seric
85264028Seric+--------------------+
85364028Seric| USING MAILERTABLES |
85464028Seric+--------------------+
85564028Seric
85664028SericTo use FEATURE(mailertable), you will have to create an external
85764028Sericdatabase containing the routing information for various domains.
85864028SericFor example, a mailertable file in text format might be:
85964028Seric
86064028Seric	.my.domain		xnet:%1.my.domain
86164028Seric	uuhost1.my.domain	suucp:uuhost1
86264028Seric	.bitnet			smtp:relay.bit.net
86364028Seric
86464028SericThis should normally be stored in /etc/mailertable.  The actual
86564028Sericdatabase version of the mailertable is built using:
86664028Seric
86764028Seric	makemap hash /etc/mailertable.db < /etc/mailertable
86864028Seric
86964028SericThe semantics are simple.  Any LHS entry that does not begin with
87064028Serica dot matches the full host name indicated.  LHS entries beginning
87164028Sericwith a dot match anything ending with that domain name -- that is,
87264028Sericthey can be thought of as having a leading "*" wildcard.  Matching
87364028Sericis done in order of most-to-least qualified -- for example, even
87464028Sericthough ".my.domain" is listed first in the above example, an entry
87564028Sericof "uuhost1.my.domain" will match the second entry since it is
87664028Sericmore explicit.
87764028Seric
87864028SericThe RHS should always be a "mailer:host" pair.  The mailer is the
87964028Sericconfiguration name of a mailer (that is, an `M' line in the
88064028Sericsendmail.cf file).  The "host" will be the hostname passed to
88164028Sericthat mailer.  In domain-based matches (that is, those with leading
88264028Sericdots) the "%1" may be used to interpolate the wildcarded part of
88364028Sericthe host name.  For example, the first line above sends everything
88464028Sericaddressed to "anything.my.domain" to that same host name, but using
88564028Sericthe (presumably experimental) xnet mailer.
88664028Seric
88767915SericIn some cases you may want to temporarily turn off MX records,
88867915Sericparticularly on gateways.  For example, you may want to MX
88967915Sericeverything in a domain to one machine that then forwards it
89067915Sericdirectly.  To do this, you might use the DNS configuration:
89164028Seric
89267915Seric	*.domain.	IN	MX	0	relay.machine
89367915Seric
89467915Sericand on relay.machine use the mailertable:
89567915Seric
89667915Seric	.domain		smtp:[gateway.domain]
89767915Seric
89867915SericThe [square brackets] turn off MX records for this host only.
89967915SericIf you didn't do this, the mailertable would use the MX record
90067915Sericagain, which would give you an MX loop.
90167915Seric
90267915Seric
90364153Seric+--------------------------------+
90464153Seric| USING USERDB TO MAP FULL NAMES |
90564153Seric+--------------------------------+
90664153Seric
90764153SericThe user database was not originally intended for mapping full names
90864153Sericto login names (e.g., Eric.Allman => eric), but some people are using
90964153Sericit that way.  (I would recommend that you set up aliases for this
91064153Sericpurpose instead -- since you can specify multiple alias files, this
91164153Sericis fairly easy.)  The intent was to locate the default maildrop at
91264153Serica site, but allow you to override this by sending to a specific host.
91364153Seric
91464153SericIf you decide to set up the user database in this fashion, it is
91567917Sericimperative that you not use FEATURE(stickyhost) -- otherwise,
91664153Serice-mail sent to Full.Name@local.host.name will be rejected.
91764153Seric
91867917SericTo build the internal form of the user database, use:
91964153Seric
92064259Seric	makemap btree /usr/data/base.db < /usr/data/base.txt
92164259Seric
92264259Seric
92367539Seric+--------------------------------+
92467539Seric| MISCELLANEOUS SPECIAL FEATURES |
92567539Seric+--------------------------------+
92667539Seric
92767539SericDOTTED_USER(name)
92867539Seric	Sometimes it is convenient to merge configuration on a
92967539Seric	centralized mail machine, for example, to forward all
93067539Seric	root mail to a mail server.  In this case it might be
93167539Seric	useful to be able to treat the root addresses as a class
93267539Seric	of addresses with subtle differences.  You can do this
93367539Seric	using dotted users.  For example, a client might include
93467539Seric	the alias:
93567539Seric
93667539Seric		root:  root.client1@server
93767539Seric
93867539Seric	On the server, the mail configuration would include:
93967539Seric
94067539Seric		DOTTED_USER(root)
94167539Seric
94267539Seric	Aliases on the server that would match this address would
94367539Seric	be "root.client", "root.*", and "root", tried in that
94467539Seric	order.  You can specify multiple addresses either by
94567539Seric	joining them in one DOTTTED_USER macro or by having
94667539Seric	multiple macros:
94767539Seric
94867539Seric		DOTTED_USER(root)
94967539Seric		DOTTED_USER(postmaster mailer-daemon)
95067539Seric
95167539Seric	defines three dotted users.
95267539Seric
95367539Seric
95467960Seric+----------------+
95567960Seric| SECURITY NOTES |
95667960Seric+----------------+
95767960Seric
95867960SericA lot of sendmail security comes down to you.  Sendmail 8 is much
95967960Sericmore careful about checking for security problems than previous
96067960Sericversions, but there are some things that you still need to watch
96167960Sericfor.  In particular:
96267960Seric
96367960Seric* Make sure the aliases file isn't writable except by trusted
96467960Seric  system personnel.  This includes both the text and database
96567960Seric  version.
96667960Seric
96767960Seric* Make sure that other files that sendmail reads, such as the
96867960Seric  mailertable, is only writable by trusted system personnel.
96967960Seric
97067960Seric* The queue directory should not be world writable PARTICULARLY
97167960Seric  if your system allows "file giveaways" (that is, if a non-root
97267960Seric  user can chown any file they own to any other user).
97367960Seric
97467960Seric* If your system allows file giveaways, DO NOT create a publically
97567960Seric  writable directory for forward files.  This will allow anyone
97667960Seric  to steal anyone else's e-mail.  Instead, create a script that
97767960Seric  copies the .forward file from users' home directories once a
97867960Seric  night (if you want the non-NFS-mounted forward directory).
97967960Seric
98067960Seric* If your system allows file giveaways, you'll find that
98167960Seric  sendmail is much less trusting of :include: files -- in
98267960Seric  particular, you'll have to have /SENDMAIL/ANY/SHELL/ in
98367960Seric  /etc/shells before they will be trusted (that is, before
98467960Seric  files and programs listed in them will be honored).
98567960Seric
98667960SericIn general, file giveaways are a mistake -- if you can turn them
98767960Sericoff I recommend you do so.
98867960Seric
98967960Seric
99058363Seric+------------------+
99158363Seric| FlexFAX SOFTWARE |
99258363Seric+------------------+
99358363Seric
99458363SericSam Leffler's FlexFAX software is still in beta test -- but he expects a
99558363Sericpublic version out "later this week" [as of 3/1/93].  The following
99658363Sericblurb is direct from Sam:
99758363Seric
99864498Seric	$Header: /usr/people/sam/fax/RCS/HOWTO,v 1.14 93/05/24 11:42:16 sam Exp $
99958363Seric
100058363Seric	How To Obtain This Software (in case all you get is this file)
100164498Seric	--------------------------------------------------------------
100258363Seric	The source code is available for public ftp on
100364498Seric	    sgi.com			sgi/fax/v2.1.src.tar.Z
100458363Seric		(192.48.153.1)
100558363Seric
100658363Seric	You can also obtain inst'able images for Silicon Graphics machines from
100764498Seric	    sgi.com			sgi/fax/v2.1.inst.tar
100858363Seric		(192.48.153.1)
100958363Seric
101058363Seric	For example,
101158363Seric	    % ftp -n sgi.com
101258363Seric	    ....
101358363Seric	    ftp> user anonymous
101458363Seric	    ... <type in password>
101558363Seric	    ftp> cd sgi/fax
101658363Seric	    ftp> binary
101764498Seric	    ftp> get v2.1.src.tar.Z
101858363Seric
101964498Seric	In general, the latest version of the 2.1 release of the software is
102064498Seric	always available as "v2.1.src.tar.Z" or "v2.1.inst.tar" in the ftp
102164498Seric	directory.  This file is a link to the appropriate released version (so
102264498Seric	don't waste your time retrieving the linked file as well!) Any files of
102364498Seric	the form v2.1.*.patch are shell scripts that can be used to patch older
102464498Seric	versions of the source code.  For example, the file v2.1.0.patch would
102564498Seric	contain patches to update v2.1.0.tar.Z.  (Note to beta testers: this is
102664498Seric	different than the naming conventions used during beta testing.) Patch
102764498Seric	files only work to go between consecutive versions, so if you are
102864498Seric	multiple versions behind the latest release, you will need to apply
102964498Seric	each patch file between your current version and the latest.
103064498Seric
103164498Seric
103264498Seric	Obtaining the Software by Electronic Mail
103364498Seric	-----------------------------------------
103464498Seric	Do not send me requests for the software; they will be ignored (without
103564498Seric	response).  If you cannot use FTP at all, there is a service called
103664498Seric	"ftpmail" available from gatekeeper.dec.com:  you can send e-mail to
103764498Seric	this machine and it will use FTP to retrieve files for you and send you
103864498Seric	the files back again via e-mail.  To find out more about the ftpmail
103958363Seric	service, send a message to "ftpmail@gatekeeper.dec.com" whose body
104058363Seric	consists of the single line "help".
104158363Seric
104264498Seric
104364498Seric	Obtaining the Software Within Silicon Graphics
104464498Seric	----------------------------------------------
104558363Seric	Internal to Silicon Graphics there are inst'able images on the host
104664498Seric	flake.asd in the directory /usr/dist.  Thus you can do something like:
104758363Seric
104864498Seric	    % inst -f flake.asd.sgi.com:/usr/dist/flexfax
104958363Seric
105064498Seric	to install the latest version of the software on your machine.
105158363Seric
105264498Seric
105364498Seric	What to do Once You've Retrieved Stuff
105464498Seric	--------------------------------------
105558363Seric	The external distributions come in a compressed or uncompressed tar
105658363Seric	file.  To extract the source distribution:
105758363Seric
105864498Seric	    % zcat v2.1.src.tar.Z | tar xf -
105958363Seric
106058363Seric	(uncompress and extract individual files in current directory).  To
106158363Seric	unpack and install the client portion of the inst'able distribution:
106258363Seric
106358363Seric	    % mkdir dist
106464498Seric	    % cd dist; tar xf ../v2.1.inst.tar; cd ..
106558363Seric	    % inst -f dist/flexfax
106658363Seric	    ...
106758363Seric	    inst> go
106858363Seric
106958363Seric	(Note, the dist subdirectory is because some versions of inst fail if
107064498Seric	the files are in the current directory.) Server binaries are also
107164498Seric	included in the inst'able images as flexfax.server.*.  They are not
107264498Seric	installed by default, so to get them also you need to do:
107358363Seric
107458363Seric	    % inst -f flexfax
107558363Seric	    ...
107658363Seric	    inst> install flexfax.server.*
107758363Seric	    inst> go
107858363Seric
107964498Seric	The SGI binaries were built for Version 4.0.5H of the IRIX operating
108058363Seric	system.  They should work w/o problem on earlier versions of the
108158363Seric	system, but I have not fully tested this.  Also, note that to install a
108258363Seric	server on an SGI machine, you need to have installed the Display
108358363Seric	PostScript execution environment product (dps_eoe).  Otherwise, the fax
108458363Seric	server will not be able to convert PostScript to facsimile for
108558363Seric	transmission.
108658363Seric
108764498Seric	If you are working from the source distribution, look at the file
108864498Seric	README in the top of the source tree.  If you are working from the inst
108964498Seric	images, the subsystem flexfax.man.readme contains the README file and
109064498Seric	other useful pieces of information--the installed files are placed in
109164498Seric	the directory /usr/local/doc/flexfax).  Basically you will need to run
109264498Seric	the faxaddmodem script to setup and configure your fax modem.  Consult
109364498Seric	the README file and the manual page for faxaddmodem for information.
109458363Seric
109558363Seric
109664498Seric	FlexFAX Mail List
109764498Seric	-----------------
109858363Seric	A mailing list for users of this software is located on sgi.com.
109958363Seric	If you want to join this mailing list or have a list-related request
110058363Seric	such as getting your name removed from it, send a request to
110158363Seric
110264498Seric	    majordomo@whizzer.wpd.sgi.com
110358363Seric
110464498Seric	For example, to subscribe, send the line "subscribe flexfax" in
110564498Seric	the body of your message.  The line "help" will return a list of
110664498Seric	the commands understood by the mailing list management software.
110764498Seric
110858363Seric	Submissions (including bug reports) should be directed to:
110958363Seric
111058363Seric	    flexfax@sgi.com
111158363Seric
111264498Seric	When corresponding about this software please always specify what
111364498Seric	version you have, what system you're running on, and, if the problem is
111464498Seric	specific to your modem, identify the modem and firmware revision.
111558363Seric
111664498Seric
111757945Seric+--------------------------------+
111857945Seric| TWEAKING CONFIGURATION OPTIONS |
111957945Seric+--------------------------------+
112057945Seric
112157945SericThere are a large number of configuration options that don't normally
112257945Sericneed to be changed.  However, if you feel you need to tweak them, you
112357945Sericcan define the following M4 variables.  This list is shown in four
112457945Sericcolumns:  the name you define, the default value for that definition,
112557945Sericthe option or macro that is affected (either Ox for an option or Dx
112657945Sericfor a macro), and a brief description.  Greater detail of the semantics
112757945Sericcan be found in the Installation and Operations Guide.
112857945Seric
112963582SericSome options are likely to be deprecated in future versions -- that is,
113063582Sericthe option is only included to provide back-compatibility.  These are
113163582Sericmarked with "*".
113263582Seric
113365002SericRemember that these options are M4 variables, and hence may need to
113465002Sericbe quoted.  In particular, arguments with commas will usually have to
113565002Sericbe ``double quoted, like this phrase'' to avoid having the comma
113665002Sericconfuse things.  This is common for alias file definitions and for
113765002Sericthe read timeout.
113865002Seric
113968694SericM4 Variable Name	Configuration	Description & [Default]
114068694Seric================	=============	=======================
114168694SericconfMAILER_NAME		$n macro	[MAILER-DAEMON] The sender name used
114268694Seric					for internally generated outgoing
114368694Seric					messages.
114468694SericconfFROM_LINE		$l macro	[From $g  $d] The From_ line used
114568694Seric					when sending to files or programs.
114668694SericconfFROM_HEADER		$q macro	[$?x$x <$g>$|$g$.] The format of an
114768694Seric					internally generated From: address.
114868694SericconfOPERATORS		$o macro	[.:%@!^/[]+] Address operator
114968694Seric					characters.
115068694SericconfSMTP_LOGIN_MSG	$e macro	[$j Sendmail $v/$Z ready at $b]
115168694Seric					The initial (spontaneous) SMTP
115268694Seric					greeting message.
115368694SericconfDOMAIN_NAME		$j macro	If defined, sets $j.  This should
115468694Seric					only be done if your system cannot
115568694Seric					determine your local domain name,
115668694Seric					and then it should be set to
115768694Seric					$w.Foo.COM, where Foo.COM is your
115868694Seric					domain name.
115968694SericconfRECEIVED_HEADER	Received:
116068694Seric      [.$?_($?s$|from $.$_) $.by $j ($v/$Z)$?r with $r$. id $i$?u for $u$.; $b]
116168694Seric					The format of the Received: header
116268694Seric					in messages passed through this host.
116368694Seric					It is unwise to try to change this.
116468694SericconfCW_FILE		Fw class	[/etc/sendmail.cw] Name of file used
116568694Seric					to get the local additions to the $=w
116668694Seric					class.
116768694SericconfSMTP_MAILER		-		[smtp] The mailer name used when
116868694Seric					SMTP connectivity is required.
116968694Seric					One of "smtp", "smtp8", or "esmtp".
117068694SericconfLOCAL_MAILER	-		[local] The mailer name used when
117168694Seric					local connectivity is required.
117268694Seric					Almost always "local".
117368694SericconfRELAY_MAILER	-		[relay] The default mailer name used
117468694Seric					for relaying any mail (e.g., to a
117568694Seric					BITNET_RELAY, a SMART_HOST, or
117668694Seric					whatever).  This can reasonably be
117768694Seric					"uucp-new" if you are on a
117868694Seric					UUCP-connected site.
117968694SericconfSEVEN_BIT_INPUT	SevenBitInput	[False] Force input to seven bits?
118068694SericconfEIGHT_BIT_HANDLING	EightBitMode	[pass8] 8-bit data handling
118168694SericconfALIAS_WAIT		AliasWait	[10m] Time to wait for alias file
118268694Seric					rebuild until you get bored and
118368694Seric					decide that the apparently pending
118468694Seric					rebuild failed.
118568694SericconfMIN_FREE_BLOCKS	MinFreeBlocks	[100] Minimum number of free blocks on
118668694Seric					queue filesystem to accept SMTP mail.
1187*68749Seric					(Prior to 8.7 this was minfree/maxsize,
1188*68749Seric					where minfree was the number of free
1189*68749Seric					blocks and maxsize was the maximum
1190*68749Seric					message size.  Use confMAX_MESSAGE_SIZE
1191*68749Seric					for the second value now.)
1192*68749SericconfMAX_MESSAGE_SIZE	MaxMessageSize	The maximum size of messages that will
1193*68749Seric					be accepted (in bytes).
119468694SericconfBLANK_SUB		BlankSub	[.] Blank (space) substitution
119568694Seric					character.
119668694SericconfCON_EXPENSIVE	HoldExpensive	[False] Avoid connecting immediately
119768694Seric					to mailers marked expensive?
119868694SericconfCHECKPOINT_INTERVAL	CheckpointInterval
119968694Seric					Checkpoint queue files every N
120068694Seric					recipients.
120168694SericconfDELIVERY_MODE	DeliveryMode	[background] Default delivery mode.
120268694SericconfAUTO_REBUILD	AutoRebuildAliases
120368694Seric					Automatically rebuild alias
120468694Seric					file if needed.
120568694SericconfERROR_MODE		ErrorMode	Error message mode.
120668694SericconfERROR_MESSAGE	ErrorHeader	Error message header/file.
120768694SericconfSAVE_FROM_LINES	SafeFromLine	Save extra leading From_ lines.
120868694SericconfTEMP_FILE_MODE	TempFileMode	[0600] Temporary file mode.
120968694SericconfMATCH_GECOS		MatchGECOS	Match GECOS field.
121068694SericconfMAX_HOP		MaxHopCount	Maximum hop count.
121168694SericconfIGNORE_DOTS*	IgnoreDots	Ignore dot as terminator for incoming
121268694Seric					messages?
121368694SericconfBIND_OPTS		ResolverOptions	Default options for DNS resolver.
121468694SericconfMIME_FORMAT_ERRORS*	SendMimeErrors	[True] Send error messages as MIME-
121568694Seric					encapsulated messages per RFC 1344.
121668694SericconfFORWARD_PATH	ForwardPath	[$z/.forward.$w:$z/.forward]
121768694Seric					The colon-separated list of places to
121868694Seric					search for .forward files.  N.B.: see
121968694Seric					the Security Notes section.
122068694SericconfMCI_CACHE_SIZE	ConnectionCacheSize
122168694Seric					[2] Size of open connection cache.
122268694SericconfMCI_CACHE_TIMEOUT	ConnectionCacheTimeout
122368694Seric					[5m] Open connection cache timeout.
122468694SericconfUSE_ERRORS_TO*	UserErrorsTo	[False] Use the Errors-To: header to deliver
122568694Seric					error messages.  This should not be
122668694Seric					necessary because of general acceptance
122768694Seric					of the envelope/header distinction.
122868694SericconfLOG_LEVEL		LogLevel	[9] Log level.
122968694SericconfME_TOO		MeToo		Include sender in group expansions.
123068694SericconfCHECK_ALIASES	CheckAliases	[True] Check RHS of aliases when
123168694Seric					running newaliases.
123268694SericconfOLD_STYLE_HEADERS*	OldStyleHeaders	[True] Assume that headers without
123368694Seric					special chars are old style.
123468694SericconfDAEMON_OPTIONS	DaemonPortOptions
123568694Seric					SMTP daemon options.
123668694SericconfPRIVACY_FLAGS	PrivacyOptions	[authwarnings] Privacy flags.
123768694SericconfCOPY_ERRORS_TO	PostmasterCopy	Address for additional copies of all
123868694Seric					error messages.
123968694SericconfQUEUE_FACTOR	QueueFactor	Slope of queue-only function.
124068694SericconfDONT_PRUNE_ROUTES	DontPruneRoutes	Don't prune down route-addr syntax
124168694Seric					addresses to the minimum possible.
124268694SericconfSAFE_QUEUE*		SuperSafe	[True] Commit all messages to disk
124368694Seric					before forking.
124468694SericconfTIME_ZONE		TimeZoneSpec	[USE_SYSTEM] Time zone info -- can be
124568694Seric					USE_SYSTEM to use the system's idea,
124668694Seric					USE_TZ to use the user's TZ envariable,
124768694Seric					or something else to force that value.
124868694SericconfDEF_USER_ID		DefaultUser	[1:1] Default user id.
124968694SericconfUSERDB_SPEC		UserDatabaseSpec
125068694Seric					User database specification.
125168694SericconfFALLBACK_MX		FallbackMXhost	Fallback MX host.
125268694SericconfTRY_NULL_MX_LIST	TryNullMXList	If we are the best MX for a host and
125368694Seric					haven't made other arrangements, try
125468694Seric					connecting to the host directly;
125568694Seric					normally this would be a config error.
125668694SericconfQUEUE_LA		QueueLA		Load average at which queue-only
125768694Seric					function kicks in.
125868694SericconfREFUSE_LA		RefuseLA	Load average at which incoming
125968694Seric					SMTP connections are refused.
126063582SericconfWORK_RECIPIENT_FACTOR
126168694Seric			RecipientFactor	Cost of each recipient.
126268694SericconfSEPARATE_PROC	ForkEachJob	Run all deliveries in a separate
126368694Seric					process.
126468694SericconfWORK_CLASS_FACTOR	ClassFactor	Priority multiplier for class.
126568694SericconfWORK_TIME_FACTOR	RetryFactor	Cost of each delivery attempt.
126668694SericconfQUEUE_SORT_ORDER	QueueSortOrder	Queue sort algorithm: Priority or Host.
126768694SericconfBROKEN_SMTP_PEERS	BrokenSmtpPeers	Set this to prevent two-line greeting
126868694Seric					messages that confuse some (mostly
126968694Seric					PC-based) clients.
127068694SericconfMIN_QUEUE_AGE	MinQueueAge	The minimum amount of time a job
127168694Seric					must sit in the queue between queue
127268694Seric					runs.  This allows you to set the
127368694Seric					queue run interval low for better
127468694Seric					resposiveness without trying all
127568694Seric					jobs in each run.
127668694SericconfDEF_CHAR_SET	DefaultCharSet	When converting unlabelled 8 bit
127768694Seric					input to MIME, the character set to
127868694Seric					use by default.
127968694SericconfSERVICE_SWITCH_FILE	ServiceSwitchFile
128068694Seric					The file to use for the service switch
128168694Seric					on systems that do not have a system-
128268694Seric					defined switch.
128368694SericconfDIAL_DELAY		DialDelay	If a connection fails, wait this long
128468694Seric					and try again.  This is to allow
128568694Seric					"dial on demand" connections to have
128668694Seric					enough time to complete a connection.
128768694SericconfNO_RCPT_ACTION	NoRecipientAction
128868694Seric					What to do if there are no legal
128968694Seric					recipient fields (To:, Cc: or Bcc:)
129068694Seric					in the message.  Legal values can
129168694Seric					be "none" to just leave the
129268694Seric					nonconforming message as is, "add-to"
129368694Seric					to add a To: header with all the
129468694Seric					known recipients (which may expose
129568694Seric					blind recipients), "add-apparently-to"
129668694Seric					to do the same but use Apparently-To:
129768694Seric					instead of To:, "add-bcc" to add an
129868694Seric					empty Bcc: header, or
129968694Seric					"add-to-undisclosed" to add the header
130068694Seric					``To: undisclosed-recipients:;''.
130168694Seric					Default is "none".
130268694SericconfSAFE_FILE_ENV	SafeFileEnvironment
130368694Seric					If set, sendmail will do a chroot()
130468694Seric					into this directory before writing
130568694Seric					files.
130657945Seric
130758087Seric
130857246Seric+-----------+
130957246Seric| HIERARCHY |
131057246Seric+-----------+
131157246Seric
131251220SericWithin this directory are several subdirectories, to wit:
131351220Seric
131451220Sericm4		General support routines.  These are typically
131551220Seric		very important and should not be changed without
131657247Seric		very careful consideration.
131751220Seric
131851220Sericcf		The configuration files themselves.  They have
131951220Seric		".mc" suffixes, and must be run through m4 to
132051220Seric		become complete.  The resulting output should
132151220Seric		have a ".cf" suffix.
132251220Seric
132351220Sericostype		Definitions describing a particular operating
132451220Seric		system type.  These should always be referenced
132551220Seric		using the OSTYPE macro in the .mc file.  Examples
132651220Seric		include "bsd4.3", "bsd4.4", "sunos3.5", and
132751220Seric		"sunos4.1".
132851220Seric
132951220Sericdomain		Definitions describing a particular domain, referenced
133051220Seric		using the DOMAIN macro in the .mc file.  These are
133151220Seric		site dependent; for example, we contribute "cs.exposed.m4"
133251220Seric		and "cs.hidden.m4" which both describe hosts in the
133351220Seric		CS.Berkeley.EDU subdomain; the former displays the local
133451220Seric		hostname (e.g., mammoth.CS.Berkeley.EDU), whereas the
133551220Seric		latter does its best to hide the identity of the local
133651220Seric		workstation inside the CS subdomain.
133751220Seric
133851220Sericmailer		Descriptions of mailers.   These are referenced using
133951220Seric		the MAILER macro in the .mc file.
134051220Seric
134151220Sericsh		Shell files used when building the .cf file from the
134251220Seric		.mc file in the cf subdirectory.
134351220Seric
134451220Sericfeature		These hold special orthogonal features that you might
134551220Seric		want to include.  They should be referenced using
134651220Seric		the FEATURE macro.
134751220Seric
134851220Serichack		Local hacks.  These can be referenced using the HACK
134951220Seric		macro.  They shouldn't be of more than voyeuristic
135051220Seric		interest outside the .Berkeley.EDU domain, but who knows?
135165957Seric		We've all got our own peccadillos.
135251220Seric
135351268Sericsiteconfig	Site configuration -- e.g., tables of locally connected
135451268Seric		UUCP sites.
135551220Seric
135651268Seric
135757246Seric+------------------------+
135857246Seric| ADMINISTRATIVE DETAILS |
135957246Seric+------------------------+
136051220Seric
136151220SericThe following sections detail usage of certain internal parts of the
136251220Sericsendmail.cf file.  Read them carefully if you are trying to modify
136351220Sericthe current model.  If you find the above descriptions adequate, these
136451220Sericshould be {boring, confusing, tedious, ridiculous} (pick one or more).
136551220Seric
136651220SericRULESETS (* means built in to sendmail)
136751220Seric
136851220Seric   0 *	Parsing
136951220Seric   1 *	Sender rewriting
137051220Seric   2 *	Recipient rewriting
137151220Seric   3 *	Canonicalization
137251220Seric   4 *	Post cleanup
137354839Seric   5 *	Local address rewrite (after aliasing)
137460539Seric  1x	mailer rules (sender qualification)
137560539Seric  2x	mailer rules (recipient qualification)
137664801Seric  3x	mailer rules (sender header qualification)
137764801Seric  4x	mailer rules (recipient header qualification)
137864801Seric  5x	mailer subroutines (general)
137964801Seric  6x	mailer subroutines (general)
138064801Seric  7x	mailer subroutines (general)
138164801Seric  8x	reserved
138260539Seric  90	Mailertable host stripping
138360892Seric  96	Bottom half of Ruleset 3 (ruleset 6 in old sendmail)
138460892Seric  97	Hook for recursive ruleset 0 call (ruleset 7 in old sendmail)
138563857Seric  98	Local part of ruleset 0 (ruleset 8 in old sendmail)
138651220Seric
138751220Seric
138851220SericMAILERS
138951220Seric
139051220Seric   0	local, prog	local and program mailers
139165218Seric   1	[e]smtp, relay	SMTP channel
139265218Seric   2	uucp-*		UNIX-to-UNIX Copy Program
139358087Seric   3	netnews		Network News delivery
139458363Seric   4	fax		Sam Leffler's FlexFAX software
139551220Seric
139651220Seric
139751220SericMACROS
139851220Seric
139951220Seric   A
140051220Seric   B	Bitnet Relay
140165182Seric   C
140254839Seric   D	The local domain -- usually not needed
140351220Seric   E
140458363Seric   F	FAX Relay
140551220Seric   G
140657591Seric   H	mail Hub (for mail clusters)
140751220Seric   I
140851220Seric   J
140951220Seric   K
141067915Seric   L	Luser Relay
141151220Seric   M	Masquerade (who I claim to be)
141251220Seric   N
141351220Seric   O
141451220Seric   P
141551220Seric   Q
141651220Seric   R	Relay (for unqualified names)
141758071Seric   S	Smart Host
141851220Seric   T
141951309Seric   U	my UUCP name (if I have a UUCP connection)
142051309Seric   V	UUCP Relay (class V hosts)
142151220Seric   W	UUCP Relay (class W hosts)
142251220Seric   X	UUCP Relay (class X hosts)
142351309Seric   Y	UUCP Relay (all other hosts)
142451220Seric   Z	Version number
142551220Seric
142651220Seric
142751220SericCLASSES
142851220Seric
142951220Seric   A
143051220Seric   B
143151220Seric   C
143267539Seric   D	"dotted" users
143357246Seric   E	addresses that should not seem to come from $M
143454839Seric   F	hosts we forward for
143551220Seric   G
143651220Seric   H
143751220Seric   I
143851220Seric   J
143951220Seric   K
144051220Seric   L	addresses that should not be forwarded to $R
144151220Seric   M
144251220Seric   N
144351220Seric   O	operators that indicate network operations (cannot be in local names)
144460211Seric   P	top level pseudo-domains: BITNET, FAX, UUCP, etc.
144551220Seric   Q
144651220Seric   R
144751220Seric   S
144851220Seric   T
144951220Seric   U	locally connected UUCP hosts
145051309Seric   V	UUCP hosts connected to relay $V
145151309Seric   W	UUCP hosts connected to relay $W
145251309Seric   X	UUCP hosts connected to relay $X
145351309Seric   Y	locally connected smart UUCP hosts
145464153Seric   Z	locally connected domain-ized UUCP hosts
145554839Seric   .	the class containing only a dot
145651220Seric
145751220Seric
145851220SericM4 DIVERSIONS
145951220Seric
146058071Seric   1	Local host detection and resolution
146158071Seric   2	Local Ruleset 3 additions
146258071Seric   3	Local Ruleset 0 additions
146351268Seric   4	UUCP Ruleset 0 additions
146451309Seric   5	locally interpreted names (overrides $R)
146554839Seric   6	local configuration (at top of file)
146651220Seric   7	mailer definitions
146766099Seric   8
146858681Seric   9	special local rulesets (1 and 2)
1469