xref: /csrg-svn/usr.sbin/sendmail/cf/README (revision 58408)
151220Seric
251220Seric
357246Seric		NEW SENDMAIL CONFIGURATION FILES
451220Seric
557246Seric		Eric Allman <eric@CS.Berkeley.EDU>
651220Seric
7*58408Seric		@(#)README	6.10 (Berkeley) 03/03/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
202*58408SericYou do not have to define a domain -- in particular, if you are a
203*58408Sericsingle machine sitting off somewhere, it is probably more work than
204*58408Sericit's worth.  This is just a mechanism for combining "domain dependent
205*58408Sericknowledge" into one place.
206*58408Seric
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
25557246Sericfile to get values for class $=w.  Available features are:
25657246Seric
25757246Sericuse_cw_file	Read the file /etc/sendmail.cw file to get alternate
25857246Seric		names for this host.  This might be used if you were
25957246Seric		on a host that MXed for a dynamic set of other
26057246Seric		hosts.  If the set is static, just including the line
26157246Seric		"Cw<name1> <name2> ..." is probably superior.
262*58408Seric		The actual filename can be overridden by redefining
263*58408Seric		confCW_FILE.
26458087Sericredirect	Reject all mail addressed to "address.REDIRECT" with
26558087Seric		a ``551 User not local; please try <address>'' message.
26658087Seric		If this is set, you can alias people who have left
26758087Seric		to their new address with ".REDIRECT" appended.
26858284Sericnouucp		Don't do anything special with UUCP addresses at all.
26957246Seric
27057246SericOther FEATUREs should be defined, but I was trying to keep these
27157246Sericconfig files fairly lean and mean.
27257246Seric
27358087Seric
27457246Seric+-------+
27557246Seric| HACKS |
27657246Seric+-------+
27757246Seric
27857246SericSome things just can't be called features.  To make this clear,
27957247Sericthey go in the hack subdirectory and are referenced using the HACK
28057246Sericmacro.  These will tend to be site-dependent.  The release
28157246Sericincludes the Berkeley-dependent "cssubdomain" hack (that makes
28257246Sericsendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU;
28357246Sericthis is intended as a short-term aid while we move hosts into
28457246Sericsubdomains.
28557246Seric
28658087Seric
28757246Seric+--------------------+
28857246Seric| SITE CONFIGURATION |
28957246Seric+--------------------+
29057246Seric
29157246SericComplex sites will need more local configuration information, such as
29257246Sericlists of UUCP hosts they speak with directly.  This can get a bit more
29357246Serictricky.  For an example of a "complex" site, see cf/ucbvax.mc.
29457246Seric
29557246SericThe SITECONFIG macro allows you to indirectly reference site-dependent
29657246Sericconfiguration information stored in the siteconfig subdirectory.  For
29757246Sericexample, the line
29857246Seric
29957246Seric	SITECONFIG(uucp.ucbvax, ucbvax, U)
30057246Seric
30157246Sericreads the file uucp.ucbvax for local connection information.  The
30257246Sericsecond parameter is the local name (in this case just "ucbvax" since
30357246Sericit is locally connected, and hence a UUCP hostname) and the name of
30457246Sericthe class in which to store the host information.  Another SITECONFIG
30557246Sericline reads
30657246Seric
30757246Seric	SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W)
30857246Seric
30957246SericThis says that the file uucp.ucbarpa contains the list of UUCP sites
31057246Sericconnected to ucbarpa.Berkeley.EDU.  The $=W class will be used to
31157246Sericstore this list.  [The machine ucbarpa is gone now, but I've left
31257246Sericthis out-of-date configuration file around to demonstrate how you
31357246Sericmight do this.]
31457246Seric
31557246SericThe siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing
31657246Sericmore than a sequence of SITE macros describing connectivity.  For
31757246Sericexample:
31857246Seric
31957246Seric	SITE(cnmat)
32057246Seric	SITE(sgi olympus)
32157246Seric
32257246SericThe second example demonstrates that you can use two names on the
32357246Sericsame line; these are usually aliases for the same host (or are at
32457246Sericleast in the same company).
32557246Seric
32658087Seric
32757246Seric+-------------------+
32857246Seric| TWEAKING RULESETS |
32957246Seric+-------------------+
33057246Seric
33151268SericFor more complex configurations, you can define special rules.
33251268SericThe macro LOCAL_RULE_3 introduces rules that are used in canonicalizing
33351268Sericthe names.  Any modifications made here are reflected in the header.
33451268Seric
33551268SericA common use is to convert old UUCP addreses to SMTP addresses using
33651268Sericthe UUCPSMTP macro.  For example:
33751268Seric
33851268Seric	LOCAL_RULE_3
33951268Seric	UUCPSMTP(decvax,	decvax.dec.com)
34051268Seric	UUCPSMTP(research,	research.att.com)
34151268Seric
34251268Sericwill cause addresses of the form "decvax!user" and "research!user"
34351268Sericto be converted to "user@decvax.dec.com" and "user@research.att.com"
34451268Sericrespectively.
34551268Seric
34657246SericThis could also be used to look hosts in a database map:
34757246Seric
34857246Seric	LOCAL_RULE_3
34957246Seric	R$* < @ $+ > $*		$: $1 < @ $(hostmap $2 $) > $3
35057246Seric
35157246SericThis map would be defined in the LOCAL_CONFIG portion, as shown below.
35257246Seric
35351268SericSimilarly, LOCAL_RULE_0 can be used to introduce new parsing rules.
35451268SericFor example, new rules are needed to parse hostnames that you accept
35551309Sericvia MX records.  For example, you might have:
35651268Seric
35751309Seric	LOCAL_RULE_0
35851309Seric	R$+ < @ cnmat.Berkeley.EDU >	$#uucp $@ cnmat $: $1
35951309Seric
36051309SericYou would use this if you had installed an MX record for cnmat.Berkeley.EDU
36151309Sericpointing at this host; this rule catches the message and forwards it on
36251309Sericusing UUCP.
36351309Seric
36457246SericA similar macro is LOCAL_CONFIG.  This introduces lines added after the
36557246Sericboilerplate option setting but before rulesets, and can be used to
36657945Sericdeclare local database maps or whatever.  For example:
36751268Seric
36857246Seric	LOCAL_CONFIG
36957246Seric	Khostmap hash /etc/hostmap.db
37057246Seric	Kyplocal nis -m hosts.byname
37151220Seric
37258087Seric
37357246Seric+---------------------------+
37457246Seric| MASQUERADING AND RELAYING |
37557246Seric+---------------------------+
37657246Seric
37757246SericYou can have your host masquerade as another using
37857246Seric
37957246Seric	MASQUERADE_AS(host.domain)
38057246Seric
38157246SericThis causes outgoing SMTP mail to be labelled as coming from the
38257246Sericindicated domain, rather than $j.  One normally masquerades as one
38357246Sericof your own subdomains (for example, it's unlikely that I would
38457246Sericchoose to masquerade as an MIT site).
38557246Seric
38657246Sericthere are always users that need to be "exposed" -- that is, their
38757246Sericinternal site name should be displayed instead of the masquerade name.
38857246SericRoot is an example.  You can add users to this list using
38957246Seric
39057246Seric	EXPOSED_USER(usernames)
39157246Seric
39257246SericThis adds users to class E; you could also use something like
39357246Seric
39457246Seric	FE/etc/sendmail.cE
39557246Seric
39657246SericYou can also arrange to relay all unqualified names (that is, names
39757246Sericwithout @host) to a relay host.  For example, if you have a central
39857246Sericemail server, you might relay to that host so that users don't have
39957246Sericto have .forward files or aliases.  You can do this using
40057246Seric
40158071Seric	define(`LOCAL_RELAY', mailer:hostname)
40257246Seric
40358071SericThe ``mailer:'' can be omitted, in which case the mailer defaults to
40458071Seric"smtp".  There are some user names that you don't want relayed, perhaps
40558071Sericbecause of local aliases.  A common example is root, which may be
40658071Sericlocally aliased.  You can add entries to this list using
40757246Seric
40857246Seric	LOCAL_USER(usernames)
40957246Seric
41057246SericThis adds users to class L; you could also use something like
41157246Seric
41257246Seric	FL/etc/sendmail.cL
41357246Seric
41457591SericIf you want all mail sent to a centralized hub, as for a shared
41557591Seric/var/spool/mail scheme, use
41657591Seric
41758071Seric	define(`MAIL_HUB', mailer:hostname)
41857591Seric
41958071SericAgain, ``mailer:'' defaults to "smtp".  If you define both LOCAL_RELAY
42058071Sericand MAIL_HUB, unqualified names and names in class L will be sent to
42158071Sericthe LOCAL_RELAY and other local names will be sent to MAIL_HUB.  For
42258071Sericexample, if are on machine mastodon.CS.Berkeley.EDU, the following
42358071Sericcombinations of settings will have the indicated effects:
42457591Seric
42557591Sericemail sent to....	eric			  eric@mastodon.CS.Berkeley.EDU
42657591Seric
42757591SericLOCAL_RELAY set to	mail.CS.Berkeley.EDU	  (delivered locally)
42857591Sericmail.CS.Berkeley.EDU
42957591Seric
43057591SericMAIL_HUB set to		mammoth.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
43157591Sericmammoth.CS.Berkeley.EDU
43257591Seric
43357591SericBoth LOCAL_RELAY and	mail.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
43457591SericMAIL_HUB set as above
43557591Seric
43658071Seric
43758071Seric+-------------------------------+
43858071Seric| NON-SMTP BASED CONFIGURATIONS |
43958071Seric+-------------------------------+
44058071Seric
44158071SericThese configuration files are designed primarily for use by SMTP-based
44258071Sericsites.  I don't pretend that they are well tuned for UUCP-only or
44358071SericUUCP-primarily nodes (the latter is defined as a small local net
44458071Sericconnected to the rest of the world via UUCP).  However, there is one
44558071Serichook to handle some special cases.
44658071Seric
44758071SericYou can define a ``smart host'' that understands a richer address syntax
44858071Sericusing:
44958071Seric
45058071Seric	define(`SMART_HOST', mailer:hostname)
45158071Seric
45258071SericIn this case, the ``mailer:'' defaults to "suucp".  Any messages that
45358071Sericcan't be handled using the usual UUCP rules are passed to this host.
45458071Seric
45558071SericIf you are on a local SMTP-based net that connects to the outside
45658071Sericworld via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules.
45758071SericFor example:
45858071Seric
45958071Seric	define(`SMART_HOST', suucp:uunet)
46058071Seric	LOCAL_NET_CONFIG
46158071Seric	R$* < @ $* .$m > $*	$#smtp $@ $2.$m $: $1 < @ $2.$m > $3
46258071Seric
46358071SericThis will cause all names that end in your domain name ($m) via
46458071SericSMTP; anything else will be sent via suucp (smart UUCP) to uunet.
46558071Seric
46658071Seric
46758363Seric+------------------+
46858363Seric| FlexFAX SOFTWARE |
46958363Seric+------------------+
47058363Seric
47158363SericSam Leffler's FlexFAX software is still in beta test -- but he expects a
47258363Sericpublic version out "later this week" [as of 3/1/93].  The following
47358363Sericblurb is direct from Sam:
47458363Seric
47558363Seric	$Header: /usr/people/sam/fax/RCS/HOWTO,v 1.7 93/02/08 09:00:55 sam Exp $
47658363Seric
47758363Seric	How To Obtain This Software (in case all you get is this file)
47858363Seric
47958363Seric	The source code is available for public ftp on
48058363Seric	    sgi.com			sgi/fax/v2.1beta.tar.Z
48158363Seric		(192.48.153.1)
48258363Seric
48358363Seric	You can also obtain inst'able images for Silicon Graphics machines from
48458363Seric	    sgi.com			sgi/fax/v2.1beta.inst.tar
48558363Seric		(192.48.153.1)
48658363Seric
48758363Seric	For example,
48858363Seric	    % ftp -n sgi.com
48958363Seric	    ....
49058363Seric	    ftp> user anonymous
49158363Seric	    ... <type in password>
49258363Seric	    ftp> cd sgi/fax
49358363Seric	    ftp> binary
49458363Seric	    ftp> get v2.1beta.tar.Z
49558363Seric
49658363Seric	If you cannot use FTP at all, there is a service called "ftpmail"
49758363Seric	available from gateekeeper.dec.com:  you can send e-mail to this
49858363Seric	machine and it will use FTP to retrieve files for you and send you the
49958363Seric	files back again via e-mail.  To find out more about the ftpmail
50058363Seric	service, send a message to "ftpmail@gatekeeper.dec.com" whose body
50158363Seric	consists of the single line "help".
50258363Seric
50358363Seric	Internal to Silicon Graphics there are inst'able images on the host
50458363Seric	flake.asd in the directory /d/dist.  Thus you can do something like:
50558363Seric
50658363Seric	    % inst -f flake.asd.sgi.com:/d/dist/flexfax
50758363Seric
50858363Seric	to install the software on your machine.
50958363Seric
51058363Seric	The external distributions come in a compressed or uncompressed tar
51158363Seric	file.  To extract the source distribution:
51258363Seric
51358363Seric	    % zcat v2.1beta.tar.Z | tar xf -
51458363Seric
51558363Seric	(uncompress and extract individual files in current directory).  To
51658363Seric	unpack and install the client portion of the inst'able distribution:
51758363Seric
51858363Seric	    % mkdir dist
51958363Seric	    % cd dist; tar xf ../v2.1beta.inst.tar; cd ..
52058363Seric	    % inst -f dist/flexfax
52158363Seric	    ...
52258363Seric	    inst> go
52358363Seric
52458363Seric	(Note, the dist subdirectory is because some versions of inst fail if
52558363Seric	the files are in the current directory.) Server binaries is also
52658363Seric	included in the inst'able images as flexfax.server.*.  It is not
52758363Seric	installed by default, so to get it also you need to extract the do:
52858363Seric
52958363Seric	    % inst -f flexfax
53058363Seric	    ...
53158363Seric	    inst> install flexfax.server.*
53258363Seric	    inst> go
53358363Seric
53458363Seric	The SGI binaries were built for Version 4.0.5 of the IRIX operating
53558363Seric	system.  They should work w/o problem on earlier versions of the
53658363Seric	system, but I have not fully tested this.  Also, note that to install a
53758363Seric	server on an SGI machine, you need to have installed the Display
53858363Seric	PostScript execution environment product (dps_eoe).  Otherwise, the fax
53958363Seric	server will not be able to convert PostScript to facsimile for
54058363Seric	transmission.
54158363Seric
54258363Seric	If you are working from the source distribution, look at the file README
54358363Seric	in the top of the source tree.  If you are working from the inst images,
54458363Seric	you need to run faxaddmodem to setup and configure your fax modem.  Do
54558363Seric	man faxaddmodem for more information.
54658363Seric
54758363SericAlso from Sam:
54858363Seric
54958363Seric	A mailing list for users of this software is located on sgi.com.
55058363Seric	If you want to join this mailing list or have a list-related request
55158363Seric	such as getting your name removed from it, send a request to
55258363Seric
55358363Seric	    flexfax-request@sgi.com
55458363Seric
55558363Seric	Submissions (including bug reports) should be directed to:
55658363Seric
55758363Seric	    flexfax@sgi.com
55858363Seric
55958363Seric
56057945Seric+--------------------------------+
56157945Seric| TWEAKING CONFIGURATION OPTIONS |
56257945Seric+--------------------------------+
56357945Seric
56457945SericThere are a large number of configuration options that don't normally
56557945Sericneed to be changed.  However, if you feel you need to tweak them, you
56657945Sericcan define the following M4 variables.  This list is shown in four
56757945Sericcolumns:  the name you define, the default value for that definition,
56857945Sericthe option or macro that is affected (either Ox for an option or Dx
56957945Sericfor a macro), and a brief description.  Greater detail of the semantics
57057945Sericcan be found in the Installation and Operations Guide.
57157945Seric
57257945SericM4 Variable Name	Default		Mac/Opt	Description
57357945SericconfMAILER_NAME		MAILER-DAEMON	Dn	The sender name used for
57457945Seric						internally generated
57557945Seric						outgoing messages.
57657945SericconfFROM_LINE		From $?<$<$|$g$.  $d	The From_ line used when
57757945Seric					Dl	sending to files or programs.
57857945SericconfFROM_HEADER		$?x$x <$g>$|$g$.	The format of an internally
57957945Seric					Dq	generated From: address.
58057945SericconfOPERATORS		.:%@!^/[]	Do	Address operator characters.
58157945SericconfSTMP_LOGIN_MSG	$j Sendmail $v/$Z ready at $b
58257945Seric					De	The initial (spontaneous)
58357945Seric						SMTP greeting message.
58457945SericconfEIGHT_BIT_INPUT	False		O8	Use 8-bit input?
58557945SericconfALIAS_WAIT		10		Oa	Wait (in minutes) for alias
58657945Seric						file rebuild.
58758087SericconfMIN_FREE_BLOCKS	4		Ob	Minimum number of free blocks
58858087Seric						on queue filesystem to accept
58958087Seric						SMTP mail.
59057945SericconfBLANK_SUB		.		OB	Blank (space) substitution
59157945Seric						character.
59257945SericconfCON_EXPENSIVE	False		Oc	Connect immediately to
59357945Seric						mailers marked expensive?
59457945SericconfCHECKPOINT_INTERVAL	10		OC	Checkpoint queue files
59557945Seric						every N recipients.
59657945SericconfDELIVERY_MODE	background	Od	Default delivery mode.
59757945SericconfAUTO_REBUILD	False		OD	Automatically rebuild
59857945Seric						alias file if needed.
59957945SericconfERROR_MODE		(undefined)	Oe	Error message mode.
60057945SericconfERROR_MESSAGE	(undefined)	OE	Error message header/file.
60157945SericconfSAVE_FROM_LINES	False		Of	Save extra leading
60257945Seric						From_ lines.
60357945SericconfTEMP_FILE_MODE	0600		OF	Temporary file mode.
60457945SericconfDEF_GROUP_ID	1		Og	Default group id.
60557945SericconfMATCH_GECOS		False		OG	Match GECOS field.
60657945SericconfMAX_HOP		17		Oh	Maximum hop count.
60757945SericconfIGNORE_DOTS		False		Oi	Ignore dot as terminator
60857945Seric						for incoming messages?
60957945SericconfBIND_OPTS		(empty)		OI	Default options for BIND.
61057945SericconfMCI_CACHE_SIZE	2		Ok	Size of open connection cache.
61157945SericconfMCI_CACHE_TIMEOUT	5m		OK	Open connection cache timeout.
61257945SericconfLOG_LEVEL		9		OL	Log level.
61357945SericconfME_TOO		False		Om	Include sender in group
61457945Seric						expansions.
61557945SericconfCHECK_ALIASES	True		On	Check RHS of aliases when
61657945Seric						running newaliases.
61757945SericconfOLD_STYLE_HEADERS	True		Oo	Assume that headers without
61857945Seric						special chars are old style.
61958087SericconfPRIVACY_FLAGS	public		Op	Privacy flags.
62057945SericconfCOPY_ERRORS_TO	(undefined)	OP	Address for additional copies
62157945Seric						of all error messages.
62257945SericconfQUEUE_FACTOR	(undefined)	Oq	Slope of queue-only function
62358116SericconfREAD_TIMEOUT	(undefined)	Or	SMTP read timeouts.
62457945SericconfSAFE_QUEUE		True		Os	Commit all messages to disk
62557945Seric						before forking.
62657945SericconfMESSAGE_TIMEOUT	3d		OT	Timeout for messages before
62757945Seric						sending error message.
62857945SericconfTIME_ZONE		USE_SYSTEM	Oz	Time zone info -- can be
62957945Seric						USE_SYSTEM to use the system's
63057945Seric						idea, USE_TZ to use the user's
63157945Seric						TZ envariable, or something
63257945Seric						else to force that value.
63357945SericconfDEF_USER_ID		1		Ou	Default user id.
63457945SericconfNO_WILDCARD_MX	False		Ow	No wildcard MX records matches
63557945Seric						our domain.
63657945SericconfQUEUE_LA		8		Ox	Load average at which queue-only
63757945Seric						function kicks in.
63857945SericconfREFUSE_LA		12		OX	Load average at which incoming
63957945Seric						SMTP connections are refused.
64057945SericconfSEPARATE_PROC	False		Oy	Run all deliveries in a
64157945Seric						separate process.
64257945SericconfWORK_RECIPIENT_FACTOR
64357945Seric			(undefined)	OY	Cost of each recipient.
64457945SericconfWORK_CLASS_FACTOR	(undefined)	Oz	Priority multiplier for class.
64557945SericconfWORK_TIME_FACTOR	(undefined)	OZ	Cost of each delivery attempt.
646*58408SericconfCW_FILE		/etc/sendmail.cw	Name of file used to get the
647*58408Seric					Fw	local additions to the $=w
648*58408Seric						class.
64957945Seric
65058087Seric
65157246Seric+-----------+
65257246Seric| HIERARCHY |
65357246Seric+-----------+
65457246Seric
65551220SericWithin this directory are several subdirectories, to wit:
65651220Seric
65751220Sericm4		General support routines.  These are typically
65851220Seric		very important and should not be changed without
65957247Seric		very careful consideration.
66051220Seric
66151220Sericcf		The configuration files themselves.  They have
66251220Seric		".mc" suffixes, and must be run through m4 to
66351220Seric		become complete.  The resulting output should
66451220Seric		have a ".cf" suffix.
66551220Seric
66651220Sericostype		Definitions describing a particular operating
66751220Seric		system type.  These should always be referenced
66851220Seric		using the OSTYPE macro in the .mc file.  Examples
66951220Seric		include "bsd4.3", "bsd4.4", "sunos3.5", and
67051220Seric		"sunos4.1".
67151220Seric
67251220Sericdomain		Definitions describing a particular domain, referenced
67351220Seric		using the DOMAIN macro in the .mc file.  These are
67451220Seric		site dependent; for example, we contribute "cs.exposed.m4"
67551220Seric		and "cs.hidden.m4" which both describe hosts in the
67651220Seric		CS.Berkeley.EDU subdomain; the former displays the local
67751220Seric		hostname (e.g., mammoth.CS.Berkeley.EDU), whereas the
67851220Seric		latter does its best to hide the identity of the local
67951220Seric		workstation inside the CS subdomain.
68051220Seric
68151220Sericmailer		Descriptions of mailers.   These are referenced using
68251220Seric		the MAILER macro in the .mc file.
68351220Seric
68451220Sericsh		Shell files used when building the .cf file from the
68551220Seric		.mc file in the cf subdirectory.
68651220Seric
68751220Sericfeature		These hold special orthogonal features that you might
68851220Seric		want to include.  They should be referenced using
68951220Seric		the FEATURE macro.
69051220Seric
69151220Serichack		Local hacks.  These can be referenced using the HACK
69251220Seric		macro.  They shouldn't be of more than voyeuristic
69351220Seric		interest outside the .Berkeley.EDU domain, but who knows?
69451220Seric		We've all got our own peccadilloes.
69551220Seric
69651268Sericsiteconfig	Site configuration -- e.g., tables of locally connected
69751268Seric		UUCP sites.
69851220Seric
69951268Seric
70057246Seric+------------------------+
70157246Seric| ADMINISTRATIVE DETAILS |
70257246Seric+------------------------+
70351220Seric
70451220SericThe following sections detail usage of certain internal parts of the
70551220Sericsendmail.cf file.  Read them carefully if you are trying to modify
70651220Sericthe current model.  If you find the above descriptions adequate, these
70751220Sericshould be {boring, confusing, tedious, ridiculous} (pick one or more).
70851220Seric
70951220SericRULESETS (* means built in to sendmail)
71051220Seric
71151220Seric   0 *	Parsing
71251220Seric   1 *	Sender rewriting
71351220Seric   2 *	Recipient rewriting
71451220Seric   3 *	Canonicalization
71551220Seric   4 *	Post cleanup
71654839Seric   5 *	Local address rewrite (after aliasing)
71751220Seric   6	Bottom half of Ruleset 3
71857247Seric   7	Hook for recursive ruleset 0 call
71957247Seric   8
72057247Seric   9
72151220Seric
72251220Seric
72351220SericMAILERS
72451220Seric
72551220Seric   0	local, prog	local and program mailers
72651220Seric   1	smtp		SMTP channel
72758087Seric   2	uucp		UNIX-to-UNIX Copy Program
72858087Seric   3	netnews		Network News delivery
72958363Seric   4	fax		Sam Leffler's FlexFAX software
73051220Seric
73151220Seric
73251220SericMACROS
73351220Seric
73451220Seric   A
73551220Seric   B	Bitnet Relay
73651220Seric   C	CSNET Relay
73754839Seric   D	The local domain -- usually not needed
73851220Seric   E
73958363Seric   F	FAX Relay
74051220Seric   G
74157591Seric   H	mail Hub (for mail clusters)
74251220Seric   I
74351220Seric   J
74451220Seric   K
74551220Seric   L
74651220Seric   M	Masquerade (who I claim to be)
74751220Seric   N
74851220Seric   O
74951220Seric   P
75051220Seric   Q
75151220Seric   R	Relay (for unqualified names)
75258071Seric   S	Smart Host
75351220Seric   T
75451309Seric   U	my UUCP name (if I have a UUCP connection)
75551309Seric   V	UUCP Relay (class V hosts)
75651220Seric   W	UUCP Relay (class W hosts)
75751220Seric   X	UUCP Relay (class X hosts)
75851309Seric   Y	UUCP Relay (all other hosts)
75951220Seric   Z	Version number
76051220Seric
76151220Seric
76251220SericCLASSES
76351220Seric
76451220Seric   A
76551220Seric   B
76651220Seric   C
76751220Seric   D
76857246Seric   E	addresses that should not seem to come from $M
76954839Seric   F	hosts we forward for
77051220Seric   G
77151220Seric   H
77251220Seric   I
77351220Seric   J
77451220Seric   K
77551220Seric   L	addresses that should not be forwarded to $R
77651220Seric   M
77751220Seric   N
77851220Seric   O	operators that indicate network operations (cannot be in local names)
77951220Seric   P
78051220Seric   Q
78151220Seric   R
78251220Seric   S
78351220Seric   T
78451220Seric   U	locally connected UUCP hosts
78551309Seric   V	UUCP hosts connected to relay $V
78651309Seric   W	UUCP hosts connected to relay $W
78751309Seric   X	UUCP hosts connected to relay $X
78851309Seric   Y	locally connected smart UUCP hosts
78951220Seric   Z
79054839Seric   .	the class containing only a dot
79151220Seric
79251220Seric
79351220SericM4 DIVERSIONS
79451220Seric
79558071Seric   1	Local host detection and resolution
79658071Seric   2	Local Ruleset 3 additions
79758071Seric   3	Local Ruleset 0 additions
79851268Seric   4	UUCP Ruleset 0 additions
79951309Seric   5	locally interpreted names (overrides $R)
80054839Seric   6	local configuration (at top of file)
80151220Seric   7	mailer definitions
80254839Seric   8	special local name recognition (late in ruleset 3)
80358087Seric   9	special local name recognition (late in ruleset 0)
804