xref: /csrg-svn/usr.sbin/sendmail/cf/README (revision 59761)
151220Seric
251220Seric
357246Seric		NEW SENDMAIL CONFIGURATION FILES
451220Seric
557246Seric		Eric Allman <eric@CS.Berkeley.EDU>
651220Seric
7*59761Seric		@(#)README	6.24 (Berkeley) 05/06/93
851220Seric
951220Seric
1057246SericThis document describes the sendmail configuration files being used
1157246Sericat Berkeley.  These use features in the new (R6) sendmail, and although
1257246Sericthere is an ``OLDSENDMAIL'' mode, they haven't really been tested on
1357247Sericold versions of sendmail and cannot be expected to work well.
1451220Seric
1557246SericThese configuration files are probably not as general as previous
1657246Sericversions, and don't handle as many of the wierd cases automagically.
1757246SericI was able to simplify by them for two reasons.  First, the network
1857246Serichas become more consistent -- for example, at this point, everyone
1957246Sericon the internet is supposed to be running a name server, so hacks to
2057246Serichandle NIC-registered hosts can go away.  Second, I assumed that a
2157246Sericsubdomain would be running SMTP internally -- UUCP is presumed to be
2257246Serica long-haul protocol.  I realize that this is not universal, but it
2357246Sericdoes describe the vast majority of sites with which I am familiar,
2457246Sericincluding those outside the US.
2551220Seric
2657246SericOf course, the downside of this is that if you do live in a wierd
2757246Sericworld, things are going to get wierder for you.  I'm sorry about that,
2857246Sericbut at the time we at Berkeley had a problem, and it seemed like the
2957246Sericright thing to do.
3051220Seric
3157247SericThis package requires a post-V7 version of m4; if you are running the
3257247Seric4.2bsd, SysV.2, or 7th Edition version, I suggest finding a friend with
3357247Serica newer version.  You can m4-expand on their system, then run locally.
3457247SericSunOS's /usr/5bin/m4 or BSD-Net/2's m4 both work.  GNU m4 (which is a
3557247Sericlanguage unto itself) also works, but I don't intend to work so hard
3657247Sericto keep this up in the future.  [Note to GNU folks:  the construct
3757246Seric"define(`FOO')" should work without my having to add a null value.]
3851220Seric
3958284SericIF YOU DON'T HAVE A BERKELEY MAKE, don't despair!  Just run
4058284Seric"m4 foo.mc > foo.cf" -- that should be all you need.
4158284Seric
4258284SericTo get started, you may want to look at tcpproto.mc (for TCP-only
4358284Sericsites) and uucpproto.m4 (for UUCP-only sites).  Others are versions
4458284Sericthat we use at Berkeley, although not all are in current use.  For
4558284Sericexample, ucbarpa has gone away, but I've left ucbarpa.mc in because
4658284Sericit demonstrates some interesting techniques.
4758284Seric
4857246SericI'm not pretending that this README describes everything that these
4957246Sericconfiguration files can do; clever people can probably tweak them
5057246Sericto great effect.  But it should get you started.
5157246Seric
5258087Seric
5357246Seric+--------------------------+
5457246Seric| INTRODUCTION AND EXAMPLE |
5557246Seric+--------------------------+
5657246Seric
5757246SericConfiguration files are contained in the subdirectory "cf", with a
5857246Sericsuffix ".mc".  They must be run through "m4" to produce a ".cf" file.
5957246Seric
6051220SericLet's examine a typical .mc file (cf/cs-exposed.mc):
6151220Seric
6251220Seric	divert(-1)
6351220Seric	#
6451220Seric	# Copyright (c) 1983 Eric P. Allman
6551220Seric	# Copyright (c) 1988 The Regents of the University of California.
6651220Seric	# All rights reserved.
6751220Seric	#
6851220Seric	# Redistribution and use in source and binary forms are permitted
6951220Seric	# provided that the above copyright notice and this paragraph are
7051220Seric	# duplicated in all such forms and that any documentation,
7151220Seric	# advertising materials, and other materials related to such
7251220Seric	# distribution and use acknowledge that the software was developed
7351220Seric	# by the University of California, Berkeley.  The name of the
7451220Seric	# University may not be used to endorse or promote products derived
7551220Seric	# from this software without specific prior written permission.
7651220Seric	# THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
7751220Seric	# IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
7851220Seric	# WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
7951220Seric	#
8051220Seric
8157246SericThe divert(-1) will delete the crud in the resulting output file.
8257247SericThe copyright notice is what your lawyers require.  Our lawyers require
8357246Sericthe one that I've included in my files. A copyleft is a copyright by
8457246Sericanother name.
8551220Seric
8657246SericThe next line MUST be
8757246Seric
8851220Seric	include(`../m4/cf.m4')
8951220Seric
9057246SericThis will pull in the M4 macros you will need to make sense of
9157246Sericeverything else.  As the saying goes, don't think about it, just
9257246Sericdo it.  If you don't do it, don't bother reading the rest of this
9357246Sericfile.
9451220Seric
9556778Seric	VERSIONID(`<SCCS or RCS version id>')
9651220Seric
9751220SericVERSIONID is a macro that stuffs the version information into the
9851220Sericresulting file.  We use SCCS; you could use RCS, something else, or
9957246Sericomit it completely.  This is not the same as the version id included
10057246Sericin SMTP greeting messages -- this is defined in m4/version.m4.
10151220Seric
10251268Seric	DOMAIN(cs.exposed)
10351220Seric
10451220SericThis example exposes the host inside of the CS subdomain -- that is,
10551220Sericit doesn't try to hide the name of the workstation to the outside
10651220Sericworld.  Changing this to DOMAIN(cs.hidden) would have made outgoing
10751220Sericmessages refer to "<username>@CS.Berkeley.EDU" instead of using the
10857246Sericlocal hostname.  Internaly this is effected by using
10957246Seric"MASQUERADE_AS(CS.Berkeley.EDU)".
11051220Seric
11151268Seric	MAILER(smtp)
11251220Seric
11351309SericThese describe the mailers used at the default CS site site.  The
11451309Sericlocal mailer is always included automatically.
11551220Seric
11658087Seric
11757246Seric+--------+
11857246Seric| OSTYPE |
11957246Seric+--------+
12057246Seric
12151220SericNote that cf/cs-exposed.mc omits an OSTYPE macro -- this assumes
12251220Sericdefault Computer Science Division environment.  There are several
12357247Sericexplicit environments available: bsd4.3, bsd4.4, hpux, irix, osf1,
12457247Sericriscos4.5, sunos3.5, sunos4.1, and ultrix4.1.  These change things
12557247Sericlike the location of the alias file and queue directory.  Some of
12657247Sericthese files are identical to one another.
12751220Seric
12857246SericOperating system definitions are easy to write.  They may define
12957246Sericthe following variables (everything defaults, so an ostype file
13057246Sericmay be empty).
13151220Seric
13257246SericALIAS_FILE		[/etc/aliases] The location of the text version
133*59761Seric			of the alias file(s).  It can be a comma-separated
134*59761Seric			list of names.
13557246SericHELP_FILE		[/usr/lib/sendmail.hf] The name of the file
13657246Seric			containing information printed in response to
13757246Seric			the SMTP HELP command.
13857246SericQUEUE_DIR		[/var/spool/mqueue] The directory containing
13957246Seric			queue files.
14057246SericSTATUS_FILE		[/etc/sendmail.st] The file containing status
14157246Seric			information.
14258087SericLOCAL_MAILER_PATH	[/bin/mail] The program used to deliver local mail.
14357246SericLOCAL_MAILER_FLAGS	[rn] The flags used by the local mailer.  The
14457246Seric			flags lsDFMm are always included.
14558087SericLOCAL_SHELL_PATH	[/bin/sh] The shell used to deliver piped email.
14658087SericUSENET_MAILER_PATH	[/usr/lib/news/inews] The name of the program
14758087Seric			used to submit news.
14858087SericUSENET_MAILER_FLAGS	[rlsDFMmn] The mailer flags for the usenet mailer.
14958087SericUSENET_MAILER_ARGS	[-m -h -n] The command line arguments for the
15058087Seric			usenet mailer.
15157246SericHOSTMAP_SPEC		[dbm -o /etc/hostmap] The value for the builtin
15257246Seric			hostmap key definition.  You can redefine this
15357246Seric			to change the class, flags, and filename of
15457246Seric			the hostmap.  The default flag (-o) makes this
15557246Seric			map optional.
15657246Seric
15757246SericIn addition, the following boolean flags may be defined -- the value
15857246Sericis ignored.
15957246Seric
16057246SericNEED_DOMAIN		If set, the $j macro is defined as $w.$D.
16157246Seric			If not set, $j is defined as $w.  If this is
16257246Seric			set, the domain must be defined using the line
16357246Seric			DD<domainname> (probably in the domain file,
16457246Seric			but possibly in the .mc file).  You will only
16557246Seric			need this if you define your system hostname
16657246Seric			without a domain (type "hostname" -- if it
16758087Seric			has no dots in the output, you qualify) AND
16858087Seric			if you are not running the nameserver AND if
16958087Seric			the first (canonical) name in /etc/hosts for
17058087Seric			your machine has no domain -- OR if you are
17158087Seric			running Ultrix or OSF/1 sendmail.  Either of
17258087Seric			these is probably a mistake.
17357246Seric
17457246Seric+---------+
17557246Seric| DOMAINS |
17657246Seric+---------+
17757246Seric
17857246SericYou will probably want to collect domain-dependent defines into one
17957246Sericfile, referenced by the DOMAIN macro.  For example, our Berkeley
18057246Sericdomain file includes definitions for several internal distinguished
18157246Serichosts:
18257246Seric
18357246SericUUCP_RELAY	The host that will forward UUCP-addressed email.
18457246Seric		If not defined, all UUCP sites must be directly
18557246Seric		connected.
18657246SericBITNET_RELAY	The host that will forward BITNET-addressed email.
18757246Seric		If not defined, the .BITNET pseudo-domain won't work.
18857246SericCSNET_RELAY	The host that will forward CSNET-addressed email.
18957246Seric		If not defined, the .CSNET pseudo-domain won't work.
19057246SericLOCAL_RELAY	The site that will handle unqualified names -- that
19157246Seric		is, names with out an @domain extension.  If not set,
19257246Seric		they are assumed to belong on this machine.  This
19357246Seric		allows you to have a central site to store a
19457246Seric		company- or department-wide alias database.  This
19557246Seric		only works at small sites, and there are better
19657246Seric		methods.
19757246Seric
19857246SericThe domain file can also be used to define a domain name, if needed
19957982Seric(using "DD<domain>") and set certain site-wide features.  If all hosts
20057982Sericat your site masquerade behind one email name, you could also use
20157982SericMASQUERADE_AS here.
20257246Seric
20358408SericYou do not have to define a domain -- in particular, if you are a
20458408Sericsingle machine sitting off somewhere, it is probably more work than
20558408Sericit's worth.  This is just a mechanism for combining "domain dependent
20658408Sericknowledge" into one place.
20758408Seric
20857246Seric+---------+
20957246Seric| MAILERS |
21057246Seric+---------+
21157246Seric
21251220SericThere are fewer mailers supported in this version than the previous
21351220Sericversion, owing mostly to a simpler world.
21451220Seric
21551220Sericlocal		The local and prog mailers.  You will almost always
21651220Seric		need these; the only exception is if you relay ALL
21757247Seric		your mail to another site.  This mailer is included
21857247Seric		automatically.
21951220Seric
22051220Sericsmtp		The Simple Mail Transport Protocol mailer.  This does
22151220Seric		not hide hosts behind a gateway or another other
22251220Seric		such hack; it assumes a world where everyone is
22351220Seric		running the name server.
22451220Seric
22551220Sericuucp		The Unix-to-Unix Copy Program mailer.  Actually, this
22651220Seric		defines two mailers, "uucp" and "suucp".  The latter
22751220Seric		is for when you know that the UUCP mailer at the other
22851220Seric		end can handle multiple recipients in one transfer.
22957246Seric		When you invoke this, sendmail looks for all names in
23057246Seric		the $=U class and sends them to the uucp mailer; all
23157246Seric		names in the $=Y class are sent to suucp.  Note that
23257246Seric		this is a function of what version of rmail runs on
23357246Seric		the receiving end, and hence may be out of your control.
23451220Seric
23558087Sericusenet		Usenet (network news) delivery.  If this is specified,
23658087Seric		an extra rule is added to ruleset 0 that forwards all
23758087Seric		local email for users named ``group.usenet'' to the
23858087Seric		``inews'' program.  Note that this works for all groups,
23958087Seric		and may be considered a security problem.
24058087Seric
24158363Sericfax		Facsimile transmission.  This is experimental and based
24258363Seric		on Sam Leffler's FlexFAX software.  For more information,
24358363Seric		see below.
24458087Seric
24558363Seric
24657246Seric+----------+
24757246Seric| FEATURES |
24857246Seric+----------+
24951268Seric
25057246SericSpecial features can be requested using the "FEATURE" macro.  For
25157246Sericexample, the .mc line:
25257246Seric
25357246Seric	FEATURE(use_cw_file)
25457246Seric
25557246Serictells sendmail that you want to have it read an /etc/sendmail.cw
25658782Sericfile to get values for class $=w.  The FEATURE may contain a single
25758782Sericoptional parameter -- for example:
25857246Seric
25958782Seric	FEATURE(mailertable, dbm /usr/lib/mailertable)
26058782Seric
26158782SericAvailable features are:
26258782Seric
26357246Sericuse_cw_file	Read the file /etc/sendmail.cw file to get alternate
26457246Seric		names for this host.  This might be used if you were
26557246Seric		on a host that MXed for a dynamic set of other
26657246Seric		hosts.  If the set is static, just including the line
26757246Seric		"Cw<name1> <name2> ..." is probably superior.
26858408Seric		The actual filename can be overridden by redefining
26958408Seric		confCW_FILE.
27058087Sericredirect	Reject all mail addressed to "address.REDIRECT" with
27158087Seric		a ``551 User not local; please try <address>'' message.
27258087Seric		If this is set, you can alias people who have left
27358087Seric		to their new address with ".REDIRECT" appended.
27458284Sericnouucp		Don't do anything special with UUCP addresses at all.
27559080Sericnocanonify	Don't pass addresses to $[ ... $] for canonification.
27659080Seric		This would generally only be used by sites that only
27759080Seric		act as mail gateways or which have user agents that do
27859080Seric		full canonification themselves.
27958526Sericnotsticky	By default, email sent to "user@local.host" are marked
28058526Seric		as "sticky" -- that is, the local addresses aren't
28158526Seric		matched against UDB and don't go through ruleset 5.
28258526Seric		This features disables this treatment.  It would
28358526Seric		normally be used on network gateway machines.
28458782Sericmailertable	Include a "mailer table" which can be used to override
28558782Seric		routing for particular domains.  The argument of the
28658782Seric		FEATURE may be the key definition.  If none is specified,
28758782Seric		the definition used is:
28858782Seric			hash /etc/mailertable.db -o
28958782Seric		Keys in this database must be of the form:
29058782Seric			mailer:domain
29159034Sericbitdomain	Look up bitnet hosts in a table to try to turn them into
29259034Seric		internet addresses.  The table can be built using the
29359034Seric		bitdomain program contributed by John Gardiner Meyers.
29459034Seric		The argument of the FEATURE may be the key definition; if
29559034Seric		none is specified, the definition used is:
29659034Seric			hash /etc/bitdomain.db -o
29759034Seric		Keys are the bitnet hostname; values are the corresponding
29859034Seric		internet hostname.
29959037Sericuucpdomain	Similar feature for UUCP hosts.  The default map definition
30059037Seric		is:
30159037Seric			hash /etc/uudomain.db -o
30259037Seric		At the moment there is no automagic tool to build this
30359037Seric		database.
30457246Seric
30557246SericOther FEATUREs should be defined, but I was trying to keep these
30657246Sericconfig files fairly lean and mean.
30757246Seric
30858087Seric
30957246Seric+-------+
31057246Seric| HACKS |
31157246Seric+-------+
31257246Seric
31357246SericSome things just can't be called features.  To make this clear,
31457247Sericthey go in the hack subdirectory and are referenced using the HACK
31557246Sericmacro.  These will tend to be site-dependent.  The release
31657246Sericincludes the Berkeley-dependent "cssubdomain" hack (that makes
31757246Sericsendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU;
31857246Sericthis is intended as a short-term aid while we move hosts into
31957246Sericsubdomains.
32057246Seric
32158087Seric
32257246Seric+--------------------+
32357246Seric| SITE CONFIGURATION |
32457246Seric+--------------------+
32557246Seric
32657246SericComplex sites will need more local configuration information, such as
32757246Sericlists of UUCP hosts they speak with directly.  This can get a bit more
32857246Serictricky.  For an example of a "complex" site, see cf/ucbvax.mc.
32957246Seric
33057246SericThe SITECONFIG macro allows you to indirectly reference site-dependent
33157246Sericconfiguration information stored in the siteconfig subdirectory.  For
33257246Sericexample, the line
33357246Seric
33457246Seric	SITECONFIG(uucp.ucbvax, ucbvax, U)
33557246Seric
33657246Sericreads the file uucp.ucbvax for local connection information.  The
33757246Sericsecond parameter is the local name (in this case just "ucbvax" since
33857246Sericit is locally connected, and hence a UUCP hostname) and the name of
33957246Sericthe class in which to store the host information.  Another SITECONFIG
34057246Sericline reads
34157246Seric
34257246Seric	SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W)
34357246Seric
34457246SericThis says that the file uucp.ucbarpa contains the list of UUCP sites
34557246Sericconnected to ucbarpa.Berkeley.EDU.  The $=W class will be used to
34657246Sericstore this list.  [The machine ucbarpa is gone now, but I've left
34757246Sericthis out-of-date configuration file around to demonstrate how you
34857246Sericmight do this.]
34957246Seric
35057246SericThe siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing
35157246Sericmore than a sequence of SITE macros describing connectivity.  For
35257246Sericexample:
35357246Seric
35457246Seric	SITE(cnmat)
35557246Seric	SITE(sgi olympus)
35657246Seric
35757246SericThe second example demonstrates that you can use two names on the
35857246Sericsame line; these are usually aliases for the same host (or are at
35957246Sericleast in the same company).
36057246Seric
36158087Seric
36257246Seric+-------------------+
36357246Seric| TWEAKING RULESETS |
36457246Seric+-------------------+
36557246Seric
36651268SericFor more complex configurations, you can define special rules.
36751268SericThe macro LOCAL_RULE_3 introduces rules that are used in canonicalizing
36851268Sericthe names.  Any modifications made here are reflected in the header.
36951268Seric
37051268SericA common use is to convert old UUCP addreses to SMTP addresses using
37151268Sericthe UUCPSMTP macro.  For example:
37251268Seric
37351268Seric	LOCAL_RULE_3
37451268Seric	UUCPSMTP(decvax,	decvax.dec.com)
37551268Seric	UUCPSMTP(research,	research.att.com)
37651268Seric
37751268Sericwill cause addresses of the form "decvax!user" and "research!user"
37851268Sericto be converted to "user@decvax.dec.com" and "user@research.att.com"
37951268Sericrespectively.
38051268Seric
38157246SericThis could also be used to look hosts in a database map:
38257246Seric
38357246Seric	LOCAL_RULE_3
38457246Seric	R$* < @ $+ > $*		$: $1 < @ $(hostmap $2 $) > $3
38557246Seric
38657246SericThis map would be defined in the LOCAL_CONFIG portion, as shown below.
38757246Seric
38851268SericSimilarly, LOCAL_RULE_0 can be used to introduce new parsing rules.
38951268SericFor example, new rules are needed to parse hostnames that you accept
39051309Sericvia MX records.  For example, you might have:
39151268Seric
39251309Seric	LOCAL_RULE_0
39351309Seric	R$+ < @ cnmat.Berkeley.EDU >	$#uucp $@ cnmat $: $1
39451309Seric
39551309SericYou would use this if you had installed an MX record for cnmat.Berkeley.EDU
39651309Sericpointing at this host; this rule catches the message and forwards it on
39751309Sericusing UUCP.
39851309Seric
39958681SericYou can also tweak rulesets 1 and 2 using LOCAL_RULE_1 and LOCAL_RULE_2.
40058681SericThese rulesets are normally empty.
40158681Seric
40257246SericA similar macro is LOCAL_CONFIG.  This introduces lines added after the
40357246Sericboilerplate option setting but before rulesets, and can be used to
40457945Sericdeclare local database maps or whatever.  For example:
40551268Seric
40657246Seric	LOCAL_CONFIG
40757246Seric	Khostmap hash /etc/hostmap.db
40857246Seric	Kyplocal nis -m hosts.byname
40951220Seric
41058087Seric
41157246Seric+---------------------------+
41257246Seric| MASQUERADING AND RELAYING |
41357246Seric+---------------------------+
41457246Seric
41557246SericYou can have your host masquerade as another using
41657246Seric
41757246Seric	MASQUERADE_AS(host.domain)
41857246Seric
41957246SericThis causes outgoing SMTP mail to be labelled as coming from the
42057246Sericindicated domain, rather than $j.  One normally masquerades as one
42157246Sericof your own subdomains (for example, it's unlikely that I would
42257246Sericchoose to masquerade as an MIT site).
42357246Seric
42457246Sericthere are always users that need to be "exposed" -- that is, their
42557246Sericinternal site name should be displayed instead of the masquerade name.
42657246SericRoot is an example.  You can add users to this list using
42757246Seric
42857246Seric	EXPOSED_USER(usernames)
42957246Seric
43057246SericThis adds users to class E; you could also use something like
43157246Seric
43257246Seric	FE/etc/sendmail.cE
43357246Seric
43457246SericYou can also arrange to relay all unqualified names (that is, names
43557246Sericwithout @host) to a relay host.  For example, if you have a central
43657246Sericemail server, you might relay to that host so that users don't have
43757246Sericto have .forward files or aliases.  You can do this using
43857246Seric
43958071Seric	define(`LOCAL_RELAY', mailer:hostname)
44057246Seric
44158071SericThe ``mailer:'' can be omitted, in which case the mailer defaults to
44258071Seric"smtp".  There are some user names that you don't want relayed, perhaps
44358071Sericbecause of local aliases.  A common example is root, which may be
44458071Sericlocally aliased.  You can add entries to this list using
44557246Seric
44657246Seric	LOCAL_USER(usernames)
44757246Seric
44857246SericThis adds users to class L; you could also use something like
44957246Seric
45057246Seric	FL/etc/sendmail.cL
45157246Seric
45257591SericIf you want all mail sent to a centralized hub, as for a shared
45357591Seric/var/spool/mail scheme, use
45457591Seric
45558071Seric	define(`MAIL_HUB', mailer:hostname)
45657591Seric
45758071SericAgain, ``mailer:'' defaults to "smtp".  If you define both LOCAL_RELAY
45858071Sericand MAIL_HUB, unqualified names and names in class L will be sent to
45958071Sericthe LOCAL_RELAY and other local names will be sent to MAIL_HUB.  For
46058071Sericexample, if are on machine mastodon.CS.Berkeley.EDU, the following
46158071Sericcombinations of settings will have the indicated effects:
46257591Seric
46357591Sericemail sent to....	eric			  eric@mastodon.CS.Berkeley.EDU
46457591Seric
46557591SericLOCAL_RELAY set to	mail.CS.Berkeley.EDU	  (delivered locally)
46657591Sericmail.CS.Berkeley.EDU
46757591Seric
46857591SericMAIL_HUB set to		mammoth.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
46957591Sericmammoth.CS.Berkeley.EDU
47057591Seric
47157591SericBoth LOCAL_RELAY and	mail.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
47257591SericMAIL_HUB set as above
47357591Seric
47458071Seric
47558071Seric+-------------------------------+
47658071Seric| NON-SMTP BASED CONFIGURATIONS |
47758071Seric+-------------------------------+
47858071Seric
47958071SericThese configuration files are designed primarily for use by SMTP-based
48058071Sericsites.  I don't pretend that they are well tuned for UUCP-only or
48158071SericUUCP-primarily nodes (the latter is defined as a small local net
48258071Sericconnected to the rest of the world via UUCP).  However, there is one
48358071Serichook to handle some special cases.
48458071Seric
48558071SericYou can define a ``smart host'' that understands a richer address syntax
48658071Sericusing:
48758071Seric
48858071Seric	define(`SMART_HOST', mailer:hostname)
48958071Seric
49058071SericIn this case, the ``mailer:'' defaults to "suucp".  Any messages that
49158071Sericcan't be handled using the usual UUCP rules are passed to this host.
49258071Seric
49358071SericIf you are on a local SMTP-based net that connects to the outside
49458071Sericworld via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules.
49558071SericFor example:
49658071Seric
49758071Seric	define(`SMART_HOST', suucp:uunet)
49858071Seric	LOCAL_NET_CONFIG
49958071Seric	R$* < @ $* .$m > $*	$#smtp $@ $2.$m $: $1 < @ $2.$m > $3
50058071Seric
50158071SericThis will cause all names that end in your domain name ($m) via
50258071SericSMTP; anything else will be sent via suucp (smart UUCP) to uunet.
50358071Seric
50458071Seric
50558363Seric+------------------+
50658363Seric| FlexFAX SOFTWARE |
50758363Seric+------------------+
50858363Seric
50958363SericSam Leffler's FlexFAX software is still in beta test -- but he expects a
51058363Sericpublic version out "later this week" [as of 3/1/93].  The following
51158363Sericblurb is direct from Sam:
51258363Seric
51358363Seric	$Header: /usr/people/sam/fax/RCS/HOWTO,v 1.7 93/02/08 09:00:55 sam Exp $
51458363Seric
51558363Seric	How To Obtain This Software (in case all you get is this file)
51658363Seric
51758363Seric	The source code is available for public ftp on
51858363Seric	    sgi.com			sgi/fax/v2.1beta.tar.Z
51958363Seric		(192.48.153.1)
52058363Seric
52158363Seric	You can also obtain inst'able images for Silicon Graphics machines from
52258363Seric	    sgi.com			sgi/fax/v2.1beta.inst.tar
52358363Seric		(192.48.153.1)
52458363Seric
52558363Seric	For example,
52658363Seric	    % ftp -n sgi.com
52758363Seric	    ....
52858363Seric	    ftp> user anonymous
52958363Seric	    ... <type in password>
53058363Seric	    ftp> cd sgi/fax
53158363Seric	    ftp> binary
53258363Seric	    ftp> get v2.1beta.tar.Z
53358363Seric
53458363Seric	If you cannot use FTP at all, there is a service called "ftpmail"
53558363Seric	available from gateekeeper.dec.com:  you can send e-mail to this
53658363Seric	machine and it will use FTP to retrieve files for you and send you the
53758363Seric	files back again via e-mail.  To find out more about the ftpmail
53858363Seric	service, send a message to "ftpmail@gatekeeper.dec.com" whose body
53958363Seric	consists of the single line "help".
54058363Seric
54158363Seric	Internal to Silicon Graphics there are inst'able images on the host
54258363Seric	flake.asd in the directory /d/dist.  Thus you can do something like:
54358363Seric
54458363Seric	    % inst -f flake.asd.sgi.com:/d/dist/flexfax
54558363Seric
54658363Seric	to install the software on your machine.
54758363Seric
54858363Seric	The external distributions come in a compressed or uncompressed tar
54958363Seric	file.  To extract the source distribution:
55058363Seric
55158363Seric	    % zcat v2.1beta.tar.Z | tar xf -
55258363Seric
55358363Seric	(uncompress and extract individual files in current directory).  To
55458363Seric	unpack and install the client portion of the inst'able distribution:
55558363Seric
55658363Seric	    % mkdir dist
55758363Seric	    % cd dist; tar xf ../v2.1beta.inst.tar; cd ..
55858363Seric	    % inst -f dist/flexfax
55958363Seric	    ...
56058363Seric	    inst> go
56158363Seric
56258363Seric	(Note, the dist subdirectory is because some versions of inst fail if
56358363Seric	the files are in the current directory.) Server binaries is also
56458363Seric	included in the inst'able images as flexfax.server.*.  It is not
56558363Seric	installed by default, so to get it also you need to extract the do:
56658363Seric
56758363Seric	    % inst -f flexfax
56858363Seric	    ...
56958363Seric	    inst> install flexfax.server.*
57058363Seric	    inst> go
57158363Seric
57258363Seric	The SGI binaries were built for Version 4.0.5 of the IRIX operating
57358363Seric	system.  They should work w/o problem on earlier versions of the
57458363Seric	system, but I have not fully tested this.  Also, note that to install a
57558363Seric	server on an SGI machine, you need to have installed the Display
57658363Seric	PostScript execution environment product (dps_eoe).  Otherwise, the fax
57758363Seric	server will not be able to convert PostScript to facsimile for
57858363Seric	transmission.
57958363Seric
58058363Seric	If you are working from the source distribution, look at the file README
58158363Seric	in the top of the source tree.  If you are working from the inst images,
58258363Seric	you need to run faxaddmodem to setup and configure your fax modem.  Do
58358363Seric	man faxaddmodem for more information.
58458363Seric
58558363SericAlso from Sam:
58658363Seric
58758363Seric	A mailing list for users of this software is located on sgi.com.
58858363Seric	If you want to join this mailing list or have a list-related request
58958363Seric	such as getting your name removed from it, send a request to
59058363Seric
59158363Seric	    flexfax-request@sgi.com
59258363Seric
59358363Seric	Submissions (including bug reports) should be directed to:
59458363Seric
59558363Seric	    flexfax@sgi.com
59658363Seric
59758363Seric
59857945Seric+--------------------------------+
59957945Seric| TWEAKING CONFIGURATION OPTIONS |
60057945Seric+--------------------------------+
60157945Seric
60257945SericThere are a large number of configuration options that don't normally
60357945Sericneed to be changed.  However, if you feel you need to tweak them, you
60457945Sericcan define the following M4 variables.  This list is shown in four
60557945Sericcolumns:  the name you define, the default value for that definition,
60657945Sericthe option or macro that is affected (either Ox for an option or Dx
60757945Sericfor a macro), and a brief description.  Greater detail of the semantics
60857945Sericcan be found in the Installation and Operations Guide.
60957945Seric
61057945SericM4 Variable Name	Default		Mac/Opt	Description
61157945SericconfMAILER_NAME		MAILER-DAEMON	Dn	The sender name used for
61257945Seric						internally generated
61357945Seric						outgoing messages.
61458681SericconfFROM_LINE		From $g  $d	Dl	The From_ line used when
61558681Seric						sending to files or programs.
61657945SericconfFROM_HEADER		$?x$x <$g>$|$g$.	The format of an internally
61757945Seric					Dq	generated From: address.
61857945SericconfOPERATORS		.:%@!^/[]	Do	Address operator characters.
61957945SericconfSTMP_LOGIN_MSG	$j Sendmail $v/$Z ready at $b
62057945Seric					De	The initial (spontaneous)
62157945Seric						SMTP greeting message.
62259743SericconfSEVEN_BIT_INPUT	False		O7	Force input to seven bits?
62357945SericconfALIAS_WAIT		10		Oa	Wait (in minutes) for alias
62457945Seric						file rebuild.
62558087SericconfMIN_FREE_BLOCKS	4		Ob	Minimum number of free blocks
62658087Seric						on queue filesystem to accept
62758087Seric						SMTP mail.
62857945SericconfBLANK_SUB		.		OB	Blank (space) substitution
62957945Seric						character.
63057945SericconfCON_EXPENSIVE	False		Oc	Connect immediately to
63157945Seric						mailers marked expensive?
63257945SericconfCHECKPOINT_INTERVAL	10		OC	Checkpoint queue files
63357945Seric						every N recipients.
63457945SericconfDELIVERY_MODE	background	Od	Default delivery mode.
63557945SericconfAUTO_REBUILD	False		OD	Automatically rebuild
63657945Seric						alias file if needed.
63757945SericconfERROR_MODE		(undefined)	Oe	Error message mode.
63857945SericconfERROR_MESSAGE	(undefined)	OE	Error message header/file.
63957945SericconfSAVE_FROM_LINES	False		Of	Save extra leading
64057945Seric						From_ lines.
64157945SericconfTEMP_FILE_MODE	0600		OF	Temporary file mode.
64257945SericconfDEF_GROUP_ID	1		Og	Default group id.
64357945SericconfMATCH_GECOS		False		OG	Match GECOS field.
64457945SericconfMAX_HOP		17		Oh	Maximum hop count.
64557945SericconfIGNORE_DOTS		False		Oi	Ignore dot as terminator
64657945Seric						for incoming messages?
64757945SericconfBIND_OPTS		(empty)		OI	Default options for BIND.
64859743SericconfMIME_FORMAT_ERRORS	True		Oj	Send error messages as MIME-
64959743Seric						encapsulated messages per
65059743Seric						RFC 1344.
65157945SericconfMCI_CACHE_SIZE	2		Ok	Size of open connection cache.
65257945SericconfMCI_CACHE_TIMEOUT	5m		OK	Open connection cache timeout.
65357945SericconfLOG_LEVEL		9		OL	Log level.
65457945SericconfME_TOO		False		Om	Include sender in group
65557945Seric						expansions.
65657945SericconfCHECK_ALIASES	True		On	Check RHS of aliases when
65757945Seric						running newaliases.
65857945SericconfOLD_STYLE_HEADERS	True		Oo	Assume that headers without
65957945Seric						special chars are old style.
66058859SericconfDAEMON_OPTIONS	(undefined)	OO	SMTP daemon options.
66158806SericconfPRIVACY_FLAGS	authwarnings	Op	Privacy flags.
66257945SericconfCOPY_ERRORS_TO	(undefined)	OP	Address for additional copies
66357945Seric						of all error messages.
66457945SericconfQUEUE_FACTOR	(undefined)	Oq	Slope of queue-only function
66558116SericconfREAD_TIMEOUT	(undefined)	Or	SMTP read timeouts.
66657945SericconfSAFE_QUEUE		True		Os	Commit all messages to disk
66757945Seric						before forking.
66858806SericconfMESSAGE_TIMEOUT	5d/4h		OT	Timeout for messages before
66958806Seric						sending error/warning message.
67059317SericconfTIME_ZONE		USE_SYSTEM	Ot	Time zone info -- can be
67157945Seric						USE_SYSTEM to use the system's
67257945Seric						idea, USE_TZ to use the user's
67357945Seric						TZ envariable, or something
67457945Seric						else to force that value.
67557945SericconfDEF_USER_ID		1		Ou	Default user id.
67658718SericconfUSERDB_SPEC		(undefined)	OU	User database specification.
67758859SericconfFALLBACK_MX		(undefined)	OV	Fallback MX host.
67857945SericconfNO_WILDCARD_MX	False		Ow	No wildcard MX records matches
67957945Seric						our domain.
68057945SericconfQUEUE_LA		8		Ox	Load average at which queue-only
68157945Seric						function kicks in.
68257945SericconfREFUSE_LA		12		OX	Load average at which incoming
68357945Seric						SMTP connections are refused.
68457945SericconfSEPARATE_PROC	False		Oy	Run all deliveries in a
68557945Seric						separate process.
68657945SericconfWORK_RECIPIENT_FACTOR
68757945Seric			(undefined)	OY	Cost of each recipient.
68857945SericconfWORK_CLASS_FACTOR	(undefined)	Oz	Priority multiplier for class.
68957945SericconfWORK_TIME_FACTOR	(undefined)	OZ	Cost of each delivery attempt.
69058408SericconfCW_FILE		/etc/sendmail.cw	Name of file used to get the
69158408Seric					Fw	local additions to the $=w
69258408Seric						class.
69357945Seric
69458087Seric
69557246Seric+-----------+
69657246Seric| HIERARCHY |
69757246Seric+-----------+
69857246Seric
69951220SericWithin this directory are several subdirectories, to wit:
70051220Seric
70151220Sericm4		General support routines.  These are typically
70251220Seric		very important and should not be changed without
70357247Seric		very careful consideration.
70451220Seric
70551220Sericcf		The configuration files themselves.  They have
70651220Seric		".mc" suffixes, and must be run through m4 to
70751220Seric		become complete.  The resulting output should
70851220Seric		have a ".cf" suffix.
70951220Seric
71051220Sericostype		Definitions describing a particular operating
71151220Seric		system type.  These should always be referenced
71251220Seric		using the OSTYPE macro in the .mc file.  Examples
71351220Seric		include "bsd4.3", "bsd4.4", "sunos3.5", and
71451220Seric		"sunos4.1".
71551220Seric
71651220Sericdomain		Definitions describing a particular domain, referenced
71751220Seric		using the DOMAIN macro in the .mc file.  These are
71851220Seric		site dependent; for example, we contribute "cs.exposed.m4"
71951220Seric		and "cs.hidden.m4" which both describe hosts in the
72051220Seric		CS.Berkeley.EDU subdomain; the former displays the local
72151220Seric		hostname (e.g., mammoth.CS.Berkeley.EDU), whereas the
72251220Seric		latter does its best to hide the identity of the local
72351220Seric		workstation inside the CS subdomain.
72451220Seric
72551220Sericmailer		Descriptions of mailers.   These are referenced using
72651220Seric		the MAILER macro in the .mc file.
72751220Seric
72851220Sericsh		Shell files used when building the .cf file from the
72951220Seric		.mc file in the cf subdirectory.
73051220Seric
73151220Sericfeature		These hold special orthogonal features that you might
73251220Seric		want to include.  They should be referenced using
73351220Seric		the FEATURE macro.
73451220Seric
73551220Serichack		Local hacks.  These can be referenced using the HACK
73651220Seric		macro.  They shouldn't be of more than voyeuristic
73751220Seric		interest outside the .Berkeley.EDU domain, but who knows?
73851220Seric		We've all got our own peccadilloes.
73951220Seric
74051268Sericsiteconfig	Site configuration -- e.g., tables of locally connected
74151268Seric		UUCP sites.
74251220Seric
74351268Seric
74457246Seric+------------------------+
74557246Seric| ADMINISTRATIVE DETAILS |
74657246Seric+------------------------+
74751220Seric
74851220SericThe following sections detail usage of certain internal parts of the
74951220Sericsendmail.cf file.  Read them carefully if you are trying to modify
75051220Sericthe current model.  If you find the above descriptions adequate, these
75151220Sericshould be {boring, confusing, tedious, ridiculous} (pick one or more).
75251220Seric
75351220SericRULESETS (* means built in to sendmail)
75451220Seric
75551220Seric   0 *	Parsing
75651220Seric   1 *	Sender rewriting
75751220Seric   2 *	Recipient rewriting
75851220Seric   3 *	Canonicalization
75951220Seric   4 *	Post cleanup
76054839Seric   5 *	Local address rewrite (after aliasing)
76151220Seric   6	Bottom half of Ruleset 3
76257247Seric   7	Hook for recursive ruleset 0 call
76357247Seric   8
76457247Seric   9
76551220Seric
76651220Seric
76751220SericMAILERS
76851220Seric
76951220Seric   0	local, prog	local and program mailers
77051220Seric   1	smtp		SMTP channel
77158087Seric   2	uucp		UNIX-to-UNIX Copy Program
77258087Seric   3	netnews		Network News delivery
77358363Seric   4	fax		Sam Leffler's FlexFAX software
77451220Seric
77551220Seric
77651220SericMACROS
77751220Seric
77851220Seric   A
77951220Seric   B	Bitnet Relay
78051220Seric   C	CSNET Relay
78154839Seric   D	The local domain -- usually not needed
78251220Seric   E
78358363Seric   F	FAX Relay
78451220Seric   G
78557591Seric   H	mail Hub (for mail clusters)
78651220Seric   I
78751220Seric   J
78851220Seric   K
78951220Seric   L
79051220Seric   M	Masquerade (who I claim to be)
79151220Seric   N
79251220Seric   O
79351220Seric   P
79451220Seric   Q
79551220Seric   R	Relay (for unqualified names)
79658071Seric   S	Smart Host
79751220Seric   T
79851309Seric   U	my UUCP name (if I have a UUCP connection)
79951309Seric   V	UUCP Relay (class V hosts)
80051220Seric   W	UUCP Relay (class W hosts)
80151220Seric   X	UUCP Relay (class X hosts)
80251309Seric   Y	UUCP Relay (all other hosts)
80351220Seric   Z	Version number
80451220Seric
80551220Seric
80651220SericCLASSES
80751220Seric
80851220Seric   A
80951220Seric   B
81051220Seric   C
81151220Seric   D
81257246Seric   E	addresses that should not seem to come from $M
81354839Seric   F	hosts we forward for
81451220Seric   G
81551220Seric   H
81651220Seric   I
81751220Seric   J
81851220Seric   K
81951220Seric   L	addresses that should not be forwarded to $R
82051220Seric   M
82151220Seric   N
82251220Seric   O	operators that indicate network operations (cannot be in local names)
82351220Seric   P
82451220Seric   Q
82551220Seric   R
82651220Seric   S
82751220Seric   T
82851220Seric   U	locally connected UUCP hosts
82951309Seric   V	UUCP hosts connected to relay $V
83051309Seric   W	UUCP hosts connected to relay $W
83151309Seric   X	UUCP hosts connected to relay $X
83251309Seric   Y	locally connected smart UUCP hosts
83351220Seric   Z
83454839Seric   .	the class containing only a dot
83551220Seric
83651220Seric
83751220SericM4 DIVERSIONS
83851220Seric
83958071Seric   1	Local host detection and resolution
84058071Seric   2	Local Ruleset 3 additions
84158071Seric   3	Local Ruleset 0 additions
84251268Seric   4	UUCP Ruleset 0 additions
84351309Seric   5	locally interpreted names (overrides $R)
84454839Seric   6	local configuration (at top of file)
84551220Seric   7	mailer definitions
84654839Seric   8	special local name recognition (late in ruleset 3)
84758681Seric   9	special local rulesets (1 and 2)
848