xref: /csrg-svn/usr.sbin/sendmail/cf/README (revision 59037)
151220Seric
251220Seric
357246Seric		NEW SENDMAIL CONFIGURATION FILES
451220Seric
557246Seric		Eric Allman <eric@CS.Berkeley.EDU>
651220Seric
7*59037Seric		@(#)README	6.20 (Berkeley) 04/10/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
13357246Seric			of the alias file.
13457246SericHELP_FILE		[/usr/lib/sendmail.hf] The name of the file
13557246Seric			containing information printed in response to
13657246Seric			the SMTP HELP command.
13757246SericQUEUE_DIR		[/var/spool/mqueue] The directory containing
13857246Seric			queue files.
13957246SericSTATUS_FILE		[/etc/sendmail.st] The file containing status
14057246Seric			information.
14158087SericLOCAL_MAILER_PATH	[/bin/mail] The program used to deliver local mail.
14257246SericLOCAL_MAILER_FLAGS	[rn] The flags used by the local mailer.  The
14357246Seric			flags lsDFMm are always included.
14458087SericLOCAL_SHELL_PATH	[/bin/sh] The shell used to deliver piped email.
14558087SericUSENET_MAILER_PATH	[/usr/lib/news/inews] The name of the program
14658087Seric			used to submit news.
14758087SericUSENET_MAILER_FLAGS	[rlsDFMmn] The mailer flags for the usenet mailer.
14858087SericUSENET_MAILER_ARGS	[-m -h -n] The command line arguments for the
14958087Seric			usenet mailer.
15057246SericHOSTMAP_SPEC		[dbm -o /etc/hostmap] The value for the builtin
15157246Seric			hostmap key definition.  You can redefine this
15257246Seric			to change the class, flags, and filename of
15357246Seric			the hostmap.  The default flag (-o) makes this
15457246Seric			map optional.
15557246Seric
15657246SericIn addition, the following boolean flags may be defined -- the value
15757246Sericis ignored.
15857246Seric
15957246SericNEED_DOMAIN		If set, the $j macro is defined as $w.$D.
16057246Seric			If not set, $j is defined as $w.  If this is
16157246Seric			set, the domain must be defined using the line
16257246Seric			DD<domainname> (probably in the domain file,
16357246Seric			but possibly in the .mc file).  You will only
16457246Seric			need this if you define your system hostname
16557246Seric			without a domain (type "hostname" -- if it
16658087Seric			has no dots in the output, you qualify) AND
16758087Seric			if you are not running the nameserver AND if
16858087Seric			the first (canonical) name in /etc/hosts for
16958087Seric			your machine has no domain -- OR if you are
17058087Seric			running Ultrix or OSF/1 sendmail.  Either of
17158087Seric			these is probably a mistake.
17257246Seric
17357246Seric+---------+
17457246Seric| DOMAINS |
17557246Seric+---------+
17657246Seric
17757246SericYou will probably want to collect domain-dependent defines into one
17857246Sericfile, referenced by the DOMAIN macro.  For example, our Berkeley
17957246Sericdomain file includes definitions for several internal distinguished
18057246Serichosts:
18157246Seric
18257246SericUUCP_RELAY	The host that will forward UUCP-addressed email.
18357246Seric		If not defined, all UUCP sites must be directly
18457246Seric		connected.
18557246SericBITNET_RELAY	The host that will forward BITNET-addressed email.
18657246Seric		If not defined, the .BITNET pseudo-domain won't work.
18757246SericCSNET_RELAY	The host that will forward CSNET-addressed email.
18857246Seric		If not defined, the .CSNET pseudo-domain won't work.
18957246SericLOCAL_RELAY	The site that will handle unqualified names -- that
19057246Seric		is, names with out an @domain extension.  If not set,
19157246Seric		they are assumed to belong on this machine.  This
19257246Seric		allows you to have a central site to store a
19357246Seric		company- or department-wide alias database.  This
19457246Seric		only works at small sites, and there are better
19557246Seric		methods.
19657246Seric
19757246SericThe domain file can also be used to define a domain name, if needed
19857982Seric(using "DD<domain>") and set certain site-wide features.  If all hosts
19957982Sericat your site masquerade behind one email name, you could also use
20057982SericMASQUERADE_AS here.
20157246Seric
20258408SericYou do not have to define a domain -- in particular, if you are a
20358408Sericsingle machine sitting off somewhere, it is probably more work than
20458408Sericit's worth.  This is just a mechanism for combining "domain dependent
20558408Sericknowledge" into one place.
20658408Seric
20757246Seric+---------+
20857246Seric| MAILERS |
20957246Seric+---------+
21057246Seric
21151220SericThere are fewer mailers supported in this version than the previous
21251220Sericversion, owing mostly to a simpler world.
21351220Seric
21451220Sericlocal		The local and prog mailers.  You will almost always
21551220Seric		need these; the only exception is if you relay ALL
21657247Seric		your mail to another site.  This mailer is included
21757247Seric		automatically.
21851220Seric
21951220Sericsmtp		The Simple Mail Transport Protocol mailer.  This does
22051220Seric		not hide hosts behind a gateway or another other
22151220Seric		such hack; it assumes a world where everyone is
22251220Seric		running the name server.
22351220Seric
22451220Sericuucp		The Unix-to-Unix Copy Program mailer.  Actually, this
22551220Seric		defines two mailers, "uucp" and "suucp".  The latter
22651220Seric		is for when you know that the UUCP mailer at the other
22751220Seric		end can handle multiple recipients in one transfer.
22857246Seric		When you invoke this, sendmail looks for all names in
22957246Seric		the $=U class and sends them to the uucp mailer; all
23057246Seric		names in the $=Y class are sent to suucp.  Note that
23157246Seric		this is a function of what version of rmail runs on
23257246Seric		the receiving end, and hence may be out of your control.
23351220Seric
23458087Sericusenet		Usenet (network news) delivery.  If this is specified,
23558087Seric		an extra rule is added to ruleset 0 that forwards all
23658087Seric		local email for users named ``group.usenet'' to the
23758087Seric		``inews'' program.  Note that this works for all groups,
23858087Seric		and may be considered a security problem.
23958087Seric
24058363Sericfax		Facsimile transmission.  This is experimental and based
24158363Seric		on Sam Leffler's FlexFAX software.  For more information,
24258363Seric		see below.
24358087Seric
24458363Seric
24557246Seric+----------+
24657246Seric| FEATURES |
24757246Seric+----------+
24851268Seric
24957246SericSpecial features can be requested using the "FEATURE" macro.  For
25057246Sericexample, the .mc line:
25157246Seric
25257246Seric	FEATURE(use_cw_file)
25357246Seric
25457246Serictells sendmail that you want to have it read an /etc/sendmail.cw
25558782Sericfile to get values for class $=w.  The FEATURE may contain a single
25658782Sericoptional parameter -- for example:
25757246Seric
25858782Seric	FEATURE(mailertable, dbm /usr/lib/mailertable)
25958782Seric
26058782SericAvailable features are:
26158782Seric
26257246Sericuse_cw_file	Read the file /etc/sendmail.cw file to get alternate
26357246Seric		names for this host.  This might be used if you were
26457246Seric		on a host that MXed for a dynamic set of other
26557246Seric		hosts.  If the set is static, just including the line
26657246Seric		"Cw<name1> <name2> ..." is probably superior.
26758408Seric		The actual filename can be overridden by redefining
26858408Seric		confCW_FILE.
26958087Sericredirect	Reject all mail addressed to "address.REDIRECT" with
27058087Seric		a ``551 User not local; please try <address>'' message.
27158087Seric		If this is set, you can alias people who have left
27258087Seric		to their new address with ".REDIRECT" appended.
27358284Sericnouucp		Don't do anything special with UUCP addresses at all.
27458526Sericnotsticky	By default, email sent to "user@local.host" are marked
27558526Seric		as "sticky" -- that is, the local addresses aren't
27658526Seric		matched against UDB and don't go through ruleset 5.
27758526Seric		This features disables this treatment.  It would
27858526Seric		normally be used on network gateway machines.
27958782Sericmailertable	Include a "mailer table" which can be used to override
28058782Seric		routing for particular domains.  The argument of the
28158782Seric		FEATURE may be the key definition.  If none is specified,
28258782Seric		the definition used is:
28358782Seric			hash /etc/mailertable.db -o
28458782Seric		Keys in this database must be of the form:
28558782Seric			mailer:domain
28659034Sericbitdomain	Look up bitnet hosts in a table to try to turn them into
28759034Seric		internet addresses.  The table can be built using the
28859034Seric		bitdomain program contributed by John Gardiner Meyers.
28959034Seric		The argument of the FEATURE may be the key definition; if
29059034Seric		none is specified, the definition used is:
29159034Seric			hash /etc/bitdomain.db -o
29259034Seric		Keys are the bitnet hostname; values are the corresponding
29359034Seric		internet hostname.
294*59037Sericuucpdomain	Similar feature for UUCP hosts.  The default map definition
295*59037Seric		is:
296*59037Seric			hash /etc/uudomain.db -o
297*59037Seric		At the moment there is no automagic tool to build this
298*59037Seric		database.
29957246Seric
30057246SericOther FEATUREs should be defined, but I was trying to keep these
30157246Sericconfig files fairly lean and mean.
30257246Seric
30358087Seric
30457246Seric+-------+
30557246Seric| HACKS |
30657246Seric+-------+
30757246Seric
30857246SericSome things just can't be called features.  To make this clear,
30957247Sericthey go in the hack subdirectory and are referenced using the HACK
31057246Sericmacro.  These will tend to be site-dependent.  The release
31157246Sericincludes the Berkeley-dependent "cssubdomain" hack (that makes
31257246Sericsendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU;
31357246Sericthis is intended as a short-term aid while we move hosts into
31457246Sericsubdomains.
31557246Seric
31658087Seric
31757246Seric+--------------------+
31857246Seric| SITE CONFIGURATION |
31957246Seric+--------------------+
32057246Seric
32157246SericComplex sites will need more local configuration information, such as
32257246Sericlists of UUCP hosts they speak with directly.  This can get a bit more
32357246Serictricky.  For an example of a "complex" site, see cf/ucbvax.mc.
32457246Seric
32557246SericThe SITECONFIG macro allows you to indirectly reference site-dependent
32657246Sericconfiguration information stored in the siteconfig subdirectory.  For
32757246Sericexample, the line
32857246Seric
32957246Seric	SITECONFIG(uucp.ucbvax, ucbvax, U)
33057246Seric
33157246Sericreads the file uucp.ucbvax for local connection information.  The
33257246Sericsecond parameter is the local name (in this case just "ucbvax" since
33357246Sericit is locally connected, and hence a UUCP hostname) and the name of
33457246Sericthe class in which to store the host information.  Another SITECONFIG
33557246Sericline reads
33657246Seric
33757246Seric	SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W)
33857246Seric
33957246SericThis says that the file uucp.ucbarpa contains the list of UUCP sites
34057246Sericconnected to ucbarpa.Berkeley.EDU.  The $=W class will be used to
34157246Sericstore this list.  [The machine ucbarpa is gone now, but I've left
34257246Sericthis out-of-date configuration file around to demonstrate how you
34357246Sericmight do this.]
34457246Seric
34557246SericThe siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing
34657246Sericmore than a sequence of SITE macros describing connectivity.  For
34757246Sericexample:
34857246Seric
34957246Seric	SITE(cnmat)
35057246Seric	SITE(sgi olympus)
35157246Seric
35257246SericThe second example demonstrates that you can use two names on the
35357246Sericsame line; these are usually aliases for the same host (or are at
35457246Sericleast in the same company).
35557246Seric
35658087Seric
35757246Seric+-------------------+
35857246Seric| TWEAKING RULESETS |
35957246Seric+-------------------+
36057246Seric
36151268SericFor more complex configurations, you can define special rules.
36251268SericThe macro LOCAL_RULE_3 introduces rules that are used in canonicalizing
36351268Sericthe names.  Any modifications made here are reflected in the header.
36451268Seric
36551268SericA common use is to convert old UUCP addreses to SMTP addresses using
36651268Sericthe UUCPSMTP macro.  For example:
36751268Seric
36851268Seric	LOCAL_RULE_3
36951268Seric	UUCPSMTP(decvax,	decvax.dec.com)
37051268Seric	UUCPSMTP(research,	research.att.com)
37151268Seric
37251268Sericwill cause addresses of the form "decvax!user" and "research!user"
37351268Sericto be converted to "user@decvax.dec.com" and "user@research.att.com"
37451268Sericrespectively.
37551268Seric
37657246SericThis could also be used to look hosts in a database map:
37757246Seric
37857246Seric	LOCAL_RULE_3
37957246Seric	R$* < @ $+ > $*		$: $1 < @ $(hostmap $2 $) > $3
38057246Seric
38157246SericThis map would be defined in the LOCAL_CONFIG portion, as shown below.
38257246Seric
38351268SericSimilarly, LOCAL_RULE_0 can be used to introduce new parsing rules.
38451268SericFor example, new rules are needed to parse hostnames that you accept
38551309Sericvia MX records.  For example, you might have:
38651268Seric
38751309Seric	LOCAL_RULE_0
38851309Seric	R$+ < @ cnmat.Berkeley.EDU >	$#uucp $@ cnmat $: $1
38951309Seric
39051309SericYou would use this if you had installed an MX record for cnmat.Berkeley.EDU
39151309Sericpointing at this host; this rule catches the message and forwards it on
39251309Sericusing UUCP.
39351309Seric
39458681SericYou can also tweak rulesets 1 and 2 using LOCAL_RULE_1 and LOCAL_RULE_2.
39558681SericThese rulesets are normally empty.
39658681Seric
39757246SericA similar macro is LOCAL_CONFIG.  This introduces lines added after the
39857246Sericboilerplate option setting but before rulesets, and can be used to
39957945Sericdeclare local database maps or whatever.  For example:
40051268Seric
40157246Seric	LOCAL_CONFIG
40257246Seric	Khostmap hash /etc/hostmap.db
40357246Seric	Kyplocal nis -m hosts.byname
40451220Seric
40558087Seric
40657246Seric+---------------------------+
40757246Seric| MASQUERADING AND RELAYING |
40857246Seric+---------------------------+
40957246Seric
41057246SericYou can have your host masquerade as another using
41157246Seric
41257246Seric	MASQUERADE_AS(host.domain)
41357246Seric
41457246SericThis causes outgoing SMTP mail to be labelled as coming from the
41557246Sericindicated domain, rather than $j.  One normally masquerades as one
41657246Sericof your own subdomains (for example, it's unlikely that I would
41757246Sericchoose to masquerade as an MIT site).
41857246Seric
41957246Sericthere are always users that need to be "exposed" -- that is, their
42057246Sericinternal site name should be displayed instead of the masquerade name.
42157246SericRoot is an example.  You can add users to this list using
42257246Seric
42357246Seric	EXPOSED_USER(usernames)
42457246Seric
42557246SericThis adds users to class E; you could also use something like
42657246Seric
42757246Seric	FE/etc/sendmail.cE
42857246Seric
42957246SericYou can also arrange to relay all unqualified names (that is, names
43057246Sericwithout @host) to a relay host.  For example, if you have a central
43157246Sericemail server, you might relay to that host so that users don't have
43257246Sericto have .forward files or aliases.  You can do this using
43357246Seric
43458071Seric	define(`LOCAL_RELAY', mailer:hostname)
43557246Seric
43658071SericThe ``mailer:'' can be omitted, in which case the mailer defaults to
43758071Seric"smtp".  There are some user names that you don't want relayed, perhaps
43858071Sericbecause of local aliases.  A common example is root, which may be
43958071Sericlocally aliased.  You can add entries to this list using
44057246Seric
44157246Seric	LOCAL_USER(usernames)
44257246Seric
44357246SericThis adds users to class L; you could also use something like
44457246Seric
44557246Seric	FL/etc/sendmail.cL
44657246Seric
44757591SericIf you want all mail sent to a centralized hub, as for a shared
44857591Seric/var/spool/mail scheme, use
44957591Seric
45058071Seric	define(`MAIL_HUB', mailer:hostname)
45157591Seric
45258071SericAgain, ``mailer:'' defaults to "smtp".  If you define both LOCAL_RELAY
45358071Sericand MAIL_HUB, unqualified names and names in class L will be sent to
45458071Sericthe LOCAL_RELAY and other local names will be sent to MAIL_HUB.  For
45558071Sericexample, if are on machine mastodon.CS.Berkeley.EDU, the following
45658071Sericcombinations of settings will have the indicated effects:
45757591Seric
45857591Sericemail sent to....	eric			  eric@mastodon.CS.Berkeley.EDU
45957591Seric
46057591SericLOCAL_RELAY set to	mail.CS.Berkeley.EDU	  (delivered locally)
46157591Sericmail.CS.Berkeley.EDU
46257591Seric
46357591SericMAIL_HUB set to		mammoth.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
46457591Sericmammoth.CS.Berkeley.EDU
46557591Seric
46657591SericBoth LOCAL_RELAY and	mail.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
46757591SericMAIL_HUB set as above
46857591Seric
46958071Seric
47058071Seric+-------------------------------+
47158071Seric| NON-SMTP BASED CONFIGURATIONS |
47258071Seric+-------------------------------+
47358071Seric
47458071SericThese configuration files are designed primarily for use by SMTP-based
47558071Sericsites.  I don't pretend that they are well tuned for UUCP-only or
47658071SericUUCP-primarily nodes (the latter is defined as a small local net
47758071Sericconnected to the rest of the world via UUCP).  However, there is one
47858071Serichook to handle some special cases.
47958071Seric
48058071SericYou can define a ``smart host'' that understands a richer address syntax
48158071Sericusing:
48258071Seric
48358071Seric	define(`SMART_HOST', mailer:hostname)
48458071Seric
48558071SericIn this case, the ``mailer:'' defaults to "suucp".  Any messages that
48658071Sericcan't be handled using the usual UUCP rules are passed to this host.
48758071Seric
48858071SericIf you are on a local SMTP-based net that connects to the outside
48958071Sericworld via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules.
49058071SericFor example:
49158071Seric
49258071Seric	define(`SMART_HOST', suucp:uunet)
49358071Seric	LOCAL_NET_CONFIG
49458071Seric	R$* < @ $* .$m > $*	$#smtp $@ $2.$m $: $1 < @ $2.$m > $3
49558071Seric
49658071SericThis will cause all names that end in your domain name ($m) via
49758071SericSMTP; anything else will be sent via suucp (smart UUCP) to uunet.
49858071Seric
49958071Seric
50058363Seric+------------------+
50158363Seric| FlexFAX SOFTWARE |
50258363Seric+------------------+
50358363Seric
50458363SericSam Leffler's FlexFAX software is still in beta test -- but he expects a
50558363Sericpublic version out "later this week" [as of 3/1/93].  The following
50658363Sericblurb is direct from Sam:
50758363Seric
50858363Seric	$Header: /usr/people/sam/fax/RCS/HOWTO,v 1.7 93/02/08 09:00:55 sam Exp $
50958363Seric
51058363Seric	How To Obtain This Software (in case all you get is this file)
51158363Seric
51258363Seric	The source code is available for public ftp on
51358363Seric	    sgi.com			sgi/fax/v2.1beta.tar.Z
51458363Seric		(192.48.153.1)
51558363Seric
51658363Seric	You can also obtain inst'able images for Silicon Graphics machines from
51758363Seric	    sgi.com			sgi/fax/v2.1beta.inst.tar
51858363Seric		(192.48.153.1)
51958363Seric
52058363Seric	For example,
52158363Seric	    % ftp -n sgi.com
52258363Seric	    ....
52358363Seric	    ftp> user anonymous
52458363Seric	    ... <type in password>
52558363Seric	    ftp> cd sgi/fax
52658363Seric	    ftp> binary
52758363Seric	    ftp> get v2.1beta.tar.Z
52858363Seric
52958363Seric	If you cannot use FTP at all, there is a service called "ftpmail"
53058363Seric	available from gateekeeper.dec.com:  you can send e-mail to this
53158363Seric	machine and it will use FTP to retrieve files for you and send you the
53258363Seric	files back again via e-mail.  To find out more about the ftpmail
53358363Seric	service, send a message to "ftpmail@gatekeeper.dec.com" whose body
53458363Seric	consists of the single line "help".
53558363Seric
53658363Seric	Internal to Silicon Graphics there are inst'able images on the host
53758363Seric	flake.asd in the directory /d/dist.  Thus you can do something like:
53858363Seric
53958363Seric	    % inst -f flake.asd.sgi.com:/d/dist/flexfax
54058363Seric
54158363Seric	to install the software on your machine.
54258363Seric
54358363Seric	The external distributions come in a compressed or uncompressed tar
54458363Seric	file.  To extract the source distribution:
54558363Seric
54658363Seric	    % zcat v2.1beta.tar.Z | tar xf -
54758363Seric
54858363Seric	(uncompress and extract individual files in current directory).  To
54958363Seric	unpack and install the client portion of the inst'able distribution:
55058363Seric
55158363Seric	    % mkdir dist
55258363Seric	    % cd dist; tar xf ../v2.1beta.inst.tar; cd ..
55358363Seric	    % inst -f dist/flexfax
55458363Seric	    ...
55558363Seric	    inst> go
55658363Seric
55758363Seric	(Note, the dist subdirectory is because some versions of inst fail if
55858363Seric	the files are in the current directory.) Server binaries is also
55958363Seric	included in the inst'able images as flexfax.server.*.  It is not
56058363Seric	installed by default, so to get it also you need to extract the do:
56158363Seric
56258363Seric	    % inst -f flexfax
56358363Seric	    ...
56458363Seric	    inst> install flexfax.server.*
56558363Seric	    inst> go
56658363Seric
56758363Seric	The SGI binaries were built for Version 4.0.5 of the IRIX operating
56858363Seric	system.  They should work w/o problem on earlier versions of the
56958363Seric	system, but I have not fully tested this.  Also, note that to install a
57058363Seric	server on an SGI machine, you need to have installed the Display
57158363Seric	PostScript execution environment product (dps_eoe).  Otherwise, the fax
57258363Seric	server will not be able to convert PostScript to facsimile for
57358363Seric	transmission.
57458363Seric
57558363Seric	If you are working from the source distribution, look at the file README
57658363Seric	in the top of the source tree.  If you are working from the inst images,
57758363Seric	you need to run faxaddmodem to setup and configure your fax modem.  Do
57858363Seric	man faxaddmodem for more information.
57958363Seric
58058363SericAlso from Sam:
58158363Seric
58258363Seric	A mailing list for users of this software is located on sgi.com.
58358363Seric	If you want to join this mailing list or have a list-related request
58458363Seric	such as getting your name removed from it, send a request to
58558363Seric
58658363Seric	    flexfax-request@sgi.com
58758363Seric
58858363Seric	Submissions (including bug reports) should be directed to:
58958363Seric
59058363Seric	    flexfax@sgi.com
59158363Seric
59258363Seric
59357945Seric+--------------------------------+
59457945Seric| TWEAKING CONFIGURATION OPTIONS |
59557945Seric+--------------------------------+
59657945Seric
59757945SericThere are a large number of configuration options that don't normally
59857945Sericneed to be changed.  However, if you feel you need to tweak them, you
59957945Sericcan define the following M4 variables.  This list is shown in four
60057945Sericcolumns:  the name you define, the default value for that definition,
60157945Sericthe option or macro that is affected (either Ox for an option or Dx
60257945Sericfor a macro), and a brief description.  Greater detail of the semantics
60357945Sericcan be found in the Installation and Operations Guide.
60457945Seric
60557945SericM4 Variable Name	Default		Mac/Opt	Description
60657945SericconfMAILER_NAME		MAILER-DAEMON	Dn	The sender name used for
60757945Seric						internally generated
60857945Seric						outgoing messages.
60958681SericconfFROM_LINE		From $g  $d	Dl	The From_ line used when
61058681Seric						sending to files or programs.
61157945SericconfFROM_HEADER		$?x$x <$g>$|$g$.	The format of an internally
61257945Seric					Dq	generated From: address.
61357945SericconfOPERATORS		.:%@!^/[]	Do	Address operator characters.
61457945SericconfSTMP_LOGIN_MSG	$j Sendmail $v/$Z ready at $b
61557945Seric					De	The initial (spontaneous)
61657945Seric						SMTP greeting message.
61758806SericconfEIGHT_BIT_INPUT	True		O8	Use 8-bit input?
61857945SericconfALIAS_WAIT		10		Oa	Wait (in minutes) for alias
61957945Seric						file rebuild.
62058087SericconfMIN_FREE_BLOCKS	4		Ob	Minimum number of free blocks
62158087Seric						on queue filesystem to accept
62258087Seric						SMTP mail.
62357945SericconfBLANK_SUB		.		OB	Blank (space) substitution
62457945Seric						character.
62557945SericconfCON_EXPENSIVE	False		Oc	Connect immediately to
62657945Seric						mailers marked expensive?
62757945SericconfCHECKPOINT_INTERVAL	10		OC	Checkpoint queue files
62857945Seric						every N recipients.
62957945SericconfDELIVERY_MODE	background	Od	Default delivery mode.
63057945SericconfAUTO_REBUILD	False		OD	Automatically rebuild
63157945Seric						alias file if needed.
63257945SericconfERROR_MODE		(undefined)	Oe	Error message mode.
63357945SericconfERROR_MESSAGE	(undefined)	OE	Error message header/file.
63457945SericconfSAVE_FROM_LINES	False		Of	Save extra leading
63557945Seric						From_ lines.
63657945SericconfTEMP_FILE_MODE	0600		OF	Temporary file mode.
63757945SericconfDEF_GROUP_ID	1		Og	Default group id.
63857945SericconfMATCH_GECOS		False		OG	Match GECOS field.
63957945SericconfMAX_HOP		17		Oh	Maximum hop count.
64057945SericconfIGNORE_DOTS		False		Oi	Ignore dot as terminator
64157945Seric						for incoming messages?
64257945SericconfBIND_OPTS		(empty)		OI	Default options for BIND.
64357945SericconfMCI_CACHE_SIZE	2		Ok	Size of open connection cache.
64457945SericconfMCI_CACHE_TIMEOUT	5m		OK	Open connection cache timeout.
64557945SericconfLOG_LEVEL		9		OL	Log level.
64657945SericconfME_TOO		False		Om	Include sender in group
64757945Seric						expansions.
64857945SericconfCHECK_ALIASES	True		On	Check RHS of aliases when
64957945Seric						running newaliases.
65057945SericconfOLD_STYLE_HEADERS	True		Oo	Assume that headers without
65157945Seric						special chars are old style.
65258859SericconfDAEMON_OPTIONS	(undefined)	OO	SMTP daemon options.
65358806SericconfPRIVACY_FLAGS	authwarnings	Op	Privacy flags.
65457945SericconfCOPY_ERRORS_TO	(undefined)	OP	Address for additional copies
65557945Seric						of all error messages.
65657945SericconfQUEUE_FACTOR	(undefined)	Oq	Slope of queue-only function
65758116SericconfREAD_TIMEOUT	(undefined)	Or	SMTP read timeouts.
65857945SericconfSAFE_QUEUE		True		Os	Commit all messages to disk
65957945Seric						before forking.
66058806SericconfMESSAGE_TIMEOUT	5d/4h		OT	Timeout for messages before
66158806Seric						sending error/warning message.
66257945SericconfTIME_ZONE		USE_SYSTEM	Oz	Time zone info -- can be
66357945Seric						USE_SYSTEM to use the system's
66457945Seric						idea, USE_TZ to use the user's
66557945Seric						TZ envariable, or something
66657945Seric						else to force that value.
66757945SericconfDEF_USER_ID		1		Ou	Default user id.
66858718SericconfUSERDB_SPEC		(undefined)	OU	User database specification.
66958859SericconfFALLBACK_MX		(undefined)	OV	Fallback MX host.
67057945SericconfNO_WILDCARD_MX	False		Ow	No wildcard MX records matches
67157945Seric						our domain.
67257945SericconfQUEUE_LA		8		Ox	Load average at which queue-only
67357945Seric						function kicks in.
67457945SericconfREFUSE_LA		12		OX	Load average at which incoming
67557945Seric						SMTP connections are refused.
67657945SericconfSEPARATE_PROC	False		Oy	Run all deliveries in a
67757945Seric						separate process.
67857945SericconfWORK_RECIPIENT_FACTOR
67957945Seric			(undefined)	OY	Cost of each recipient.
68057945SericconfWORK_CLASS_FACTOR	(undefined)	Oz	Priority multiplier for class.
68157945SericconfWORK_TIME_FACTOR	(undefined)	OZ	Cost of each delivery attempt.
68258408SericconfCW_FILE		/etc/sendmail.cw	Name of file used to get the
68358408Seric					Fw	local additions to the $=w
68458408Seric						class.
68557945Seric
68658087Seric
68757246Seric+-----------+
68857246Seric| HIERARCHY |
68957246Seric+-----------+
69057246Seric
69151220SericWithin this directory are several subdirectories, to wit:
69251220Seric
69351220Sericm4		General support routines.  These are typically
69451220Seric		very important and should not be changed without
69557247Seric		very careful consideration.
69651220Seric
69751220Sericcf		The configuration files themselves.  They have
69851220Seric		".mc" suffixes, and must be run through m4 to
69951220Seric		become complete.  The resulting output should
70051220Seric		have a ".cf" suffix.
70151220Seric
70251220Sericostype		Definitions describing a particular operating
70351220Seric		system type.  These should always be referenced
70451220Seric		using the OSTYPE macro in the .mc file.  Examples
70551220Seric		include "bsd4.3", "bsd4.4", "sunos3.5", and
70651220Seric		"sunos4.1".
70751220Seric
70851220Sericdomain		Definitions describing a particular domain, referenced
70951220Seric		using the DOMAIN macro in the .mc file.  These are
71051220Seric		site dependent; for example, we contribute "cs.exposed.m4"
71151220Seric		and "cs.hidden.m4" which both describe hosts in the
71251220Seric		CS.Berkeley.EDU subdomain; the former displays the local
71351220Seric		hostname (e.g., mammoth.CS.Berkeley.EDU), whereas the
71451220Seric		latter does its best to hide the identity of the local
71551220Seric		workstation inside the CS subdomain.
71651220Seric
71751220Sericmailer		Descriptions of mailers.   These are referenced using
71851220Seric		the MAILER macro in the .mc file.
71951220Seric
72051220Sericsh		Shell files used when building the .cf file from the
72151220Seric		.mc file in the cf subdirectory.
72251220Seric
72351220Sericfeature		These hold special orthogonal features that you might
72451220Seric		want to include.  They should be referenced using
72551220Seric		the FEATURE macro.
72651220Seric
72751220Serichack		Local hacks.  These can be referenced using the HACK
72851220Seric		macro.  They shouldn't be of more than voyeuristic
72951220Seric		interest outside the .Berkeley.EDU domain, but who knows?
73051220Seric		We've all got our own peccadilloes.
73151220Seric
73251268Sericsiteconfig	Site configuration -- e.g., tables of locally connected
73351268Seric		UUCP sites.
73451220Seric
73551268Seric
73657246Seric+------------------------+
73757246Seric| ADMINISTRATIVE DETAILS |
73857246Seric+------------------------+
73951220Seric
74051220SericThe following sections detail usage of certain internal parts of the
74151220Sericsendmail.cf file.  Read them carefully if you are trying to modify
74251220Sericthe current model.  If you find the above descriptions adequate, these
74351220Sericshould be {boring, confusing, tedious, ridiculous} (pick one or more).
74451220Seric
74551220SericRULESETS (* means built in to sendmail)
74651220Seric
74751220Seric   0 *	Parsing
74851220Seric   1 *	Sender rewriting
74951220Seric   2 *	Recipient rewriting
75051220Seric   3 *	Canonicalization
75151220Seric   4 *	Post cleanup
75254839Seric   5 *	Local address rewrite (after aliasing)
75351220Seric   6	Bottom half of Ruleset 3
75457247Seric   7	Hook for recursive ruleset 0 call
75557247Seric   8
75657247Seric   9
75751220Seric
75851220Seric
75951220SericMAILERS
76051220Seric
76151220Seric   0	local, prog	local and program mailers
76251220Seric   1	smtp		SMTP channel
76358087Seric   2	uucp		UNIX-to-UNIX Copy Program
76458087Seric   3	netnews		Network News delivery
76558363Seric   4	fax		Sam Leffler's FlexFAX software
76651220Seric
76751220Seric
76851220SericMACROS
76951220Seric
77051220Seric   A
77151220Seric   B	Bitnet Relay
77251220Seric   C	CSNET Relay
77354839Seric   D	The local domain -- usually not needed
77451220Seric   E
77558363Seric   F	FAX Relay
77651220Seric   G
77757591Seric   H	mail Hub (for mail clusters)
77851220Seric   I
77951220Seric   J
78051220Seric   K
78151220Seric   L
78251220Seric   M	Masquerade (who I claim to be)
78351220Seric   N
78451220Seric   O
78551220Seric   P
78651220Seric   Q
78751220Seric   R	Relay (for unqualified names)
78858071Seric   S	Smart Host
78951220Seric   T
79051309Seric   U	my UUCP name (if I have a UUCP connection)
79151309Seric   V	UUCP Relay (class V hosts)
79251220Seric   W	UUCP Relay (class W hosts)
79351220Seric   X	UUCP Relay (class X hosts)
79451309Seric   Y	UUCP Relay (all other hosts)
79551220Seric   Z	Version number
79651220Seric
79751220Seric
79851220SericCLASSES
79951220Seric
80051220Seric   A
80151220Seric   B
80251220Seric   C
80351220Seric   D
80457246Seric   E	addresses that should not seem to come from $M
80554839Seric   F	hosts we forward for
80651220Seric   G
80751220Seric   H
80851220Seric   I
80951220Seric   J
81051220Seric   K
81151220Seric   L	addresses that should not be forwarded to $R
81251220Seric   M
81351220Seric   N
81451220Seric   O	operators that indicate network operations (cannot be in local names)
81551220Seric   P
81651220Seric   Q
81751220Seric   R
81851220Seric   S
81951220Seric   T
82051220Seric   U	locally connected UUCP hosts
82151309Seric   V	UUCP hosts connected to relay $V
82251309Seric   W	UUCP hosts connected to relay $W
82351309Seric   X	UUCP hosts connected to relay $X
82451309Seric   Y	locally connected smart UUCP hosts
82551220Seric   Z
82654839Seric   .	the class containing only a dot
82751220Seric
82851220Seric
82951220SericM4 DIVERSIONS
83051220Seric
83158071Seric   1	Local host detection and resolution
83258071Seric   2	Local Ruleset 3 additions
83358071Seric   3	Local Ruleset 0 additions
83451268Seric   4	UUCP Ruleset 0 additions
83551309Seric   5	locally interpreted names (overrides $R)
83654839Seric   6	local configuration (at top of file)
83751220Seric   7	mailer definitions
83854839Seric   8	special local name recognition (late in ruleset 3)
83958681Seric   9	special local rulesets (1 and 2)
840