xref: /csrg-svn/usr.sbin/sendmail/cf/README (revision 58363)
151220Seric
251220Seric
357246Seric		NEW SENDMAIL CONFIGURATION FILES
451220Seric
557246Seric		Eric Allman <eric@CS.Berkeley.EDU>
651220Seric
7*58363Seric		@(#)README	6.9 (Berkeley) 03/02/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
20257246Seric+---------+
20357246Seric| MAILERS |
20457246Seric+---------+
20557246Seric
20651220SericThere are fewer mailers supported in this version than the previous
20751220Sericversion, owing mostly to a simpler world.
20851220Seric
20951220Sericlocal		The local and prog mailers.  You will almost always
21051220Seric		need these; the only exception is if you relay ALL
21157247Seric		your mail to another site.  This mailer is included
21257247Seric		automatically.
21351220Seric
21451220Sericsmtp		The Simple Mail Transport Protocol mailer.  This does
21551220Seric		not hide hosts behind a gateway or another other
21651220Seric		such hack; it assumes a world where everyone is
21751220Seric		running the name server.
21851220Seric
21951220Sericuucp		The Unix-to-Unix Copy Program mailer.  Actually, this
22051220Seric		defines two mailers, "uucp" and "suucp".  The latter
22151220Seric		is for when you know that the UUCP mailer at the other
22251220Seric		end can handle multiple recipients in one transfer.
22357246Seric		When you invoke this, sendmail looks for all names in
22457246Seric		the $=U class and sends them to the uucp mailer; all
22557246Seric		names in the $=Y class are sent to suucp.  Note that
22657246Seric		this is a function of what version of rmail runs on
22757246Seric		the receiving end, and hence may be out of your control.
22851220Seric
22958087Sericusenet		Usenet (network news) delivery.  If this is specified,
23058087Seric		an extra rule is added to ruleset 0 that forwards all
23158087Seric		local email for users named ``group.usenet'' to the
23258087Seric		``inews'' program.  Note that this works for all groups,
23358087Seric		and may be considered a security problem.
23458087Seric
235*58363Sericfax		Facsimile transmission.  This is experimental and based
236*58363Seric		on Sam Leffler's FlexFAX software.  For more information,
237*58363Seric		see below.
23858087Seric
239*58363Seric
24057246Seric+----------+
24157246Seric| FEATURES |
24257246Seric+----------+
24351268Seric
24457246SericSpecial features can be requested using the "FEATURE" macro.  For
24557246Sericexample, the .mc line:
24657246Seric
24757246Seric	FEATURE(use_cw_file)
24857246Seric
24957246Serictells sendmail that you want to have it read an /etc/sendmail.cw
25057246Sericfile to get values for class $=w.  Available features are:
25157246Seric
25257246Sericuse_cw_file	Read the file /etc/sendmail.cw file to get alternate
25357246Seric		names for this host.  This might be used if you were
25457246Seric		on a host that MXed for a dynamic set of other
25557246Seric		hosts.  If the set is static, just including the line
25657246Seric		"Cw<name1> <name2> ..." is probably superior.
25758087Sericredirect	Reject all mail addressed to "address.REDIRECT" with
25858087Seric		a ``551 User not local; please try <address>'' message.
25958087Seric		If this is set, you can alias people who have left
26058087Seric		to their new address with ".REDIRECT" appended.
26158284Sericnouucp		Don't do anything special with UUCP addresses at all.
26257246Seric
26357246SericOther FEATUREs should be defined, but I was trying to keep these
26457246Sericconfig files fairly lean and mean.
26557246Seric
26658087Seric
26757246Seric+-------+
26857246Seric| HACKS |
26957246Seric+-------+
27057246Seric
27157246SericSome things just can't be called features.  To make this clear,
27257247Sericthey go in the hack subdirectory and are referenced using the HACK
27357246Sericmacro.  These will tend to be site-dependent.  The release
27457246Sericincludes the Berkeley-dependent "cssubdomain" hack (that makes
27557246Sericsendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU;
27657246Sericthis is intended as a short-term aid while we move hosts into
27757246Sericsubdomains.
27857246Seric
27958087Seric
28057246Seric+--------------------+
28157246Seric| SITE CONFIGURATION |
28257246Seric+--------------------+
28357246Seric
28457246SericComplex sites will need more local configuration information, such as
28557246Sericlists of UUCP hosts they speak with directly.  This can get a bit more
28657246Serictricky.  For an example of a "complex" site, see cf/ucbvax.mc.
28757246Seric
28857246SericThe SITECONFIG macro allows you to indirectly reference site-dependent
28957246Sericconfiguration information stored in the siteconfig subdirectory.  For
29057246Sericexample, the line
29157246Seric
29257246Seric	SITECONFIG(uucp.ucbvax, ucbvax, U)
29357246Seric
29457246Sericreads the file uucp.ucbvax for local connection information.  The
29557246Sericsecond parameter is the local name (in this case just "ucbvax" since
29657246Sericit is locally connected, and hence a UUCP hostname) and the name of
29757246Sericthe class in which to store the host information.  Another SITECONFIG
29857246Sericline reads
29957246Seric
30057246Seric	SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W)
30157246Seric
30257246SericThis says that the file uucp.ucbarpa contains the list of UUCP sites
30357246Sericconnected to ucbarpa.Berkeley.EDU.  The $=W class will be used to
30457246Sericstore this list.  [The machine ucbarpa is gone now, but I've left
30557246Sericthis out-of-date configuration file around to demonstrate how you
30657246Sericmight do this.]
30757246Seric
30857246SericThe siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing
30957246Sericmore than a sequence of SITE macros describing connectivity.  For
31057246Sericexample:
31157246Seric
31257246Seric	SITE(cnmat)
31357246Seric	SITE(sgi olympus)
31457246Seric
31557246SericThe second example demonstrates that you can use two names on the
31657246Sericsame line; these are usually aliases for the same host (or are at
31757246Sericleast in the same company).
31857246Seric
31958087Seric
32057246Seric+-------------------+
32157246Seric| TWEAKING RULESETS |
32257246Seric+-------------------+
32357246Seric
32451268SericFor more complex configurations, you can define special rules.
32551268SericThe macro LOCAL_RULE_3 introduces rules that are used in canonicalizing
32651268Sericthe names.  Any modifications made here are reflected in the header.
32751268Seric
32851268SericA common use is to convert old UUCP addreses to SMTP addresses using
32951268Sericthe UUCPSMTP macro.  For example:
33051268Seric
33151268Seric	LOCAL_RULE_3
33251268Seric	UUCPSMTP(decvax,	decvax.dec.com)
33351268Seric	UUCPSMTP(research,	research.att.com)
33451268Seric
33551268Sericwill cause addresses of the form "decvax!user" and "research!user"
33651268Sericto be converted to "user@decvax.dec.com" and "user@research.att.com"
33751268Sericrespectively.
33851268Seric
33957246SericThis could also be used to look hosts in a database map:
34057246Seric
34157246Seric	LOCAL_RULE_3
34257246Seric	R$* < @ $+ > $*		$: $1 < @ $(hostmap $2 $) > $3
34357246Seric
34457246SericThis map would be defined in the LOCAL_CONFIG portion, as shown below.
34557246Seric
34651268SericSimilarly, LOCAL_RULE_0 can be used to introduce new parsing rules.
34751268SericFor example, new rules are needed to parse hostnames that you accept
34851309Sericvia MX records.  For example, you might have:
34951268Seric
35051309Seric	LOCAL_RULE_0
35151309Seric	R$+ < @ cnmat.Berkeley.EDU >	$#uucp $@ cnmat $: $1
35251309Seric
35351309SericYou would use this if you had installed an MX record for cnmat.Berkeley.EDU
35451309Sericpointing at this host; this rule catches the message and forwards it on
35551309Sericusing UUCP.
35651309Seric
35757246SericA similar macro is LOCAL_CONFIG.  This introduces lines added after the
35857246Sericboilerplate option setting but before rulesets, and can be used to
35957945Sericdeclare local database maps or whatever.  For example:
36051268Seric
36157246Seric	LOCAL_CONFIG
36257246Seric	Khostmap hash /etc/hostmap.db
36357246Seric	Kyplocal nis -m hosts.byname
36451220Seric
36558087Seric
36657246Seric+---------------------------+
36757246Seric| MASQUERADING AND RELAYING |
36857246Seric+---------------------------+
36957246Seric
37057246SericYou can have your host masquerade as another using
37157246Seric
37257246Seric	MASQUERADE_AS(host.domain)
37357246Seric
37457246SericThis causes outgoing SMTP mail to be labelled as coming from the
37557246Sericindicated domain, rather than $j.  One normally masquerades as one
37657246Sericof your own subdomains (for example, it's unlikely that I would
37757246Sericchoose to masquerade as an MIT site).
37857246Seric
37957246Sericthere are always users that need to be "exposed" -- that is, their
38057246Sericinternal site name should be displayed instead of the masquerade name.
38157246SericRoot is an example.  You can add users to this list using
38257246Seric
38357246Seric	EXPOSED_USER(usernames)
38457246Seric
38557246SericThis adds users to class E; you could also use something like
38657246Seric
38757246Seric	FE/etc/sendmail.cE
38857246Seric
38957246SericYou can also arrange to relay all unqualified names (that is, names
39057246Sericwithout @host) to a relay host.  For example, if you have a central
39157246Sericemail server, you might relay to that host so that users don't have
39257246Sericto have .forward files or aliases.  You can do this using
39357246Seric
39458071Seric	define(`LOCAL_RELAY', mailer:hostname)
39557246Seric
39658071SericThe ``mailer:'' can be omitted, in which case the mailer defaults to
39758071Seric"smtp".  There are some user names that you don't want relayed, perhaps
39858071Sericbecause of local aliases.  A common example is root, which may be
39958071Sericlocally aliased.  You can add entries to this list using
40057246Seric
40157246Seric	LOCAL_USER(usernames)
40257246Seric
40357246SericThis adds users to class L; you could also use something like
40457246Seric
40557246Seric	FL/etc/sendmail.cL
40657246Seric
40757591SericIf you want all mail sent to a centralized hub, as for a shared
40857591Seric/var/spool/mail scheme, use
40957591Seric
41058071Seric	define(`MAIL_HUB', mailer:hostname)
41157591Seric
41258071SericAgain, ``mailer:'' defaults to "smtp".  If you define both LOCAL_RELAY
41358071Sericand MAIL_HUB, unqualified names and names in class L will be sent to
41458071Sericthe LOCAL_RELAY and other local names will be sent to MAIL_HUB.  For
41558071Sericexample, if are on machine mastodon.CS.Berkeley.EDU, the following
41658071Sericcombinations of settings will have the indicated effects:
41757591Seric
41857591Sericemail sent to....	eric			  eric@mastodon.CS.Berkeley.EDU
41957591Seric
42057591SericLOCAL_RELAY set to	mail.CS.Berkeley.EDU	  (delivered locally)
42157591Sericmail.CS.Berkeley.EDU
42257591Seric
42357591SericMAIL_HUB set to		mammoth.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
42457591Sericmammoth.CS.Berkeley.EDU
42557591Seric
42657591SericBoth LOCAL_RELAY and	mail.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
42757591SericMAIL_HUB set as above
42857591Seric
42958071Seric
43058071Seric+-------------------------------+
43158071Seric| NON-SMTP BASED CONFIGURATIONS |
43258071Seric+-------------------------------+
43358071Seric
43458071SericThese configuration files are designed primarily for use by SMTP-based
43558071Sericsites.  I don't pretend that they are well tuned for UUCP-only or
43658071SericUUCP-primarily nodes (the latter is defined as a small local net
43758071Sericconnected to the rest of the world via UUCP).  However, there is one
43858071Serichook to handle some special cases.
43958071Seric
44058071SericYou can define a ``smart host'' that understands a richer address syntax
44158071Sericusing:
44258071Seric
44358071Seric	define(`SMART_HOST', mailer:hostname)
44458071Seric
44558071SericIn this case, the ``mailer:'' defaults to "suucp".  Any messages that
44658071Sericcan't be handled using the usual UUCP rules are passed to this host.
44758071Seric
44858071SericIf you are on a local SMTP-based net that connects to the outside
44958071Sericworld via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules.
45058071SericFor example:
45158071Seric
45258071Seric	define(`SMART_HOST', suucp:uunet)
45358071Seric	LOCAL_NET_CONFIG
45458071Seric	R$* < @ $* .$m > $*	$#smtp $@ $2.$m $: $1 < @ $2.$m > $3
45558071Seric
45658071SericThis will cause all names that end in your domain name ($m) via
45758071SericSMTP; anything else will be sent via suucp (smart UUCP) to uunet.
45858071Seric
45958071Seric
460*58363Seric+------------------+
461*58363Seric| FlexFAX SOFTWARE |
462*58363Seric+------------------+
463*58363Seric
464*58363SericSam Leffler's FlexFAX software is still in beta test -- but he expects a
465*58363Sericpublic version out "later this week" [as of 3/1/93].  The following
466*58363Sericblurb is direct from Sam:
467*58363Seric
468*58363Seric	$Header: /usr/people/sam/fax/RCS/HOWTO,v 1.7 93/02/08 09:00:55 sam Exp $
469*58363Seric
470*58363Seric	How To Obtain This Software (in case all you get is this file)
471*58363Seric
472*58363Seric	The source code is available for public ftp on
473*58363Seric	    sgi.com			sgi/fax/v2.1beta.tar.Z
474*58363Seric		(192.48.153.1)
475*58363Seric
476*58363Seric	You can also obtain inst'able images for Silicon Graphics machines from
477*58363Seric	    sgi.com			sgi/fax/v2.1beta.inst.tar
478*58363Seric		(192.48.153.1)
479*58363Seric
480*58363Seric	For example,
481*58363Seric	    % ftp -n sgi.com
482*58363Seric	    ....
483*58363Seric	    ftp> user anonymous
484*58363Seric	    ... <type in password>
485*58363Seric	    ftp> cd sgi/fax
486*58363Seric	    ftp> binary
487*58363Seric	    ftp> get v2.1beta.tar.Z
488*58363Seric
489*58363Seric	If you cannot use FTP at all, there is a service called "ftpmail"
490*58363Seric	available from gateekeeper.dec.com:  you can send e-mail to this
491*58363Seric	machine and it will use FTP to retrieve files for you and send you the
492*58363Seric	files back again via e-mail.  To find out more about the ftpmail
493*58363Seric	service, send a message to "ftpmail@gatekeeper.dec.com" whose body
494*58363Seric	consists of the single line "help".
495*58363Seric
496*58363Seric	Internal to Silicon Graphics there are inst'able images on the host
497*58363Seric	flake.asd in the directory /d/dist.  Thus you can do something like:
498*58363Seric
499*58363Seric	    % inst -f flake.asd.sgi.com:/d/dist/flexfax
500*58363Seric
501*58363Seric	to install the software on your machine.
502*58363Seric
503*58363Seric	The external distributions come in a compressed or uncompressed tar
504*58363Seric	file.  To extract the source distribution:
505*58363Seric
506*58363Seric	    % zcat v2.1beta.tar.Z | tar xf -
507*58363Seric
508*58363Seric	(uncompress and extract individual files in current directory).  To
509*58363Seric	unpack and install the client portion of the inst'able distribution:
510*58363Seric
511*58363Seric	    % mkdir dist
512*58363Seric	    % cd dist; tar xf ../v2.1beta.inst.tar; cd ..
513*58363Seric	    % inst -f dist/flexfax
514*58363Seric	    ...
515*58363Seric	    inst> go
516*58363Seric
517*58363Seric	(Note, the dist subdirectory is because some versions of inst fail if
518*58363Seric	the files are in the current directory.) Server binaries is also
519*58363Seric	included in the inst'able images as flexfax.server.*.  It is not
520*58363Seric	installed by default, so to get it also you need to extract the do:
521*58363Seric
522*58363Seric	    % inst -f flexfax
523*58363Seric	    ...
524*58363Seric	    inst> install flexfax.server.*
525*58363Seric	    inst> go
526*58363Seric
527*58363Seric	The SGI binaries were built for Version 4.0.5 of the IRIX operating
528*58363Seric	system.  They should work w/o problem on earlier versions of the
529*58363Seric	system, but I have not fully tested this.  Also, note that to install a
530*58363Seric	server on an SGI machine, you need to have installed the Display
531*58363Seric	PostScript execution environment product (dps_eoe).  Otherwise, the fax
532*58363Seric	server will not be able to convert PostScript to facsimile for
533*58363Seric	transmission.
534*58363Seric
535*58363Seric	If you are working from the source distribution, look at the file README
536*58363Seric	in the top of the source tree.  If you are working from the inst images,
537*58363Seric	you need to run faxaddmodem to setup and configure your fax modem.  Do
538*58363Seric	man faxaddmodem for more information.
539*58363Seric
540*58363SericAlso from Sam:
541*58363Seric
542*58363Seric	A mailing list for users of this software is located on sgi.com.
543*58363Seric	If you want to join this mailing list or have a list-related request
544*58363Seric	such as getting your name removed from it, send a request to
545*58363Seric
546*58363Seric	    flexfax-request@sgi.com
547*58363Seric
548*58363Seric	Submissions (including bug reports) should be directed to:
549*58363Seric
550*58363Seric	    flexfax@sgi.com
551*58363Seric
552*58363Seric
55357945Seric+--------------------------------+
55457945Seric| TWEAKING CONFIGURATION OPTIONS |
55557945Seric+--------------------------------+
55657945Seric
55757945SericThere are a large number of configuration options that don't normally
55857945Sericneed to be changed.  However, if you feel you need to tweak them, you
55957945Sericcan define the following M4 variables.  This list is shown in four
56057945Sericcolumns:  the name you define, the default value for that definition,
56157945Sericthe option or macro that is affected (either Ox for an option or Dx
56257945Sericfor a macro), and a brief description.  Greater detail of the semantics
56357945Sericcan be found in the Installation and Operations Guide.
56457945Seric
56557945SericM4 Variable Name	Default		Mac/Opt	Description
56657945SericconfMAILER_NAME		MAILER-DAEMON	Dn	The sender name used for
56757945Seric						internally generated
56857945Seric						outgoing messages.
56957945SericconfFROM_LINE		From $?<$<$|$g$.  $d	The From_ line used when
57057945Seric					Dl	sending to files or programs.
57157945SericconfFROM_HEADER		$?x$x <$g>$|$g$.	The format of an internally
57257945Seric					Dq	generated From: address.
57357945SericconfOPERATORS		.:%@!^/[]	Do	Address operator characters.
57457945SericconfSTMP_LOGIN_MSG	$j Sendmail $v/$Z ready at $b
57557945Seric					De	The initial (spontaneous)
57657945Seric						SMTP greeting message.
57757945SericconfEIGHT_BIT_INPUT	False		O8	Use 8-bit input?
57857945SericconfALIAS_WAIT		10		Oa	Wait (in minutes) for alias
57957945Seric						file rebuild.
58058087SericconfMIN_FREE_BLOCKS	4		Ob	Minimum number of free blocks
58158087Seric						on queue filesystem to accept
58258087Seric						SMTP mail.
58357945SericconfBLANK_SUB		.		OB	Blank (space) substitution
58457945Seric						character.
58557945SericconfCON_EXPENSIVE	False		Oc	Connect immediately to
58657945Seric						mailers marked expensive?
58757945SericconfCHECKPOINT_INTERVAL	10		OC	Checkpoint queue files
58857945Seric						every N recipients.
58957945SericconfDELIVERY_MODE	background	Od	Default delivery mode.
59057945SericconfAUTO_REBUILD	False		OD	Automatically rebuild
59157945Seric						alias file if needed.
59257945SericconfERROR_MODE		(undefined)	Oe	Error message mode.
59357945SericconfERROR_MESSAGE	(undefined)	OE	Error message header/file.
59457945SericconfSAVE_FROM_LINES	False		Of	Save extra leading
59557945Seric						From_ lines.
59657945SericconfTEMP_FILE_MODE	0600		OF	Temporary file mode.
59757945SericconfDEF_GROUP_ID	1		Og	Default group id.
59857945SericconfMATCH_GECOS		False		OG	Match GECOS field.
59957945SericconfMAX_HOP		17		Oh	Maximum hop count.
60057945SericconfIGNORE_DOTS		False		Oi	Ignore dot as terminator
60157945Seric						for incoming messages?
60257945SericconfBIND_OPTS		(empty)		OI	Default options for BIND.
60357945SericconfMCI_CACHE_SIZE	2		Ok	Size of open connection cache.
60457945SericconfMCI_CACHE_TIMEOUT	5m		OK	Open connection cache timeout.
60557945SericconfLOG_LEVEL		9		OL	Log level.
60657945SericconfME_TOO		False		Om	Include sender in group
60757945Seric						expansions.
60857945SericconfCHECK_ALIASES	True		On	Check RHS of aliases when
60957945Seric						running newaliases.
61057945SericconfOLD_STYLE_HEADERS	True		Oo	Assume that headers without
61157945Seric						special chars are old style.
61258087SericconfPRIVACY_FLAGS	public		Op	Privacy flags.
61357945SericconfCOPY_ERRORS_TO	(undefined)	OP	Address for additional copies
61457945Seric						of all error messages.
61557945SericconfQUEUE_FACTOR	(undefined)	Oq	Slope of queue-only function
61658116SericconfREAD_TIMEOUT	(undefined)	Or	SMTP read timeouts.
61757945SericconfSAFE_QUEUE		True		Os	Commit all messages to disk
61857945Seric						before forking.
61957945SericconfMESSAGE_TIMEOUT	3d		OT	Timeout for messages before
62057945Seric						sending error message.
62157945SericconfTIME_ZONE		USE_SYSTEM	Oz	Time zone info -- can be
62257945Seric						USE_SYSTEM to use the system's
62357945Seric						idea, USE_TZ to use the user's
62457945Seric						TZ envariable, or something
62557945Seric						else to force that value.
62657945SericconfDEF_USER_ID		1		Ou	Default user id.
62757945SericconfNO_WILDCARD_MX	False		Ow	No wildcard MX records matches
62857945Seric						our domain.
62957945SericconfQUEUE_LA		8		Ox	Load average at which queue-only
63057945Seric						function kicks in.
63157945SericconfREFUSE_LA		12		OX	Load average at which incoming
63257945Seric						SMTP connections are refused.
63357945SericconfSEPARATE_PROC	False		Oy	Run all deliveries in a
63457945Seric						separate process.
63557945SericconfWORK_RECIPIENT_FACTOR
63657945Seric			(undefined)	OY	Cost of each recipient.
63757945SericconfWORK_CLASS_FACTOR	(undefined)	Oz	Priority multiplier for class.
63857945SericconfWORK_TIME_FACTOR	(undefined)	OZ	Cost of each delivery attempt.
63957945Seric
64058087Seric
64157246Seric+-----------+
64257246Seric| HIERARCHY |
64357246Seric+-----------+
64457246Seric
64551220SericWithin this directory are several subdirectories, to wit:
64651220Seric
64751220Sericm4		General support routines.  These are typically
64851220Seric		very important and should not be changed without
64957247Seric		very careful consideration.
65051220Seric
65151220Sericcf		The configuration files themselves.  They have
65251220Seric		".mc" suffixes, and must be run through m4 to
65351220Seric		become complete.  The resulting output should
65451220Seric		have a ".cf" suffix.
65551220Seric
65651220Sericostype		Definitions describing a particular operating
65751220Seric		system type.  These should always be referenced
65851220Seric		using the OSTYPE macro in the .mc file.  Examples
65951220Seric		include "bsd4.3", "bsd4.4", "sunos3.5", and
66051220Seric		"sunos4.1".
66151220Seric
66251220Sericdomain		Definitions describing a particular domain, referenced
66351220Seric		using the DOMAIN macro in the .mc file.  These are
66451220Seric		site dependent; for example, we contribute "cs.exposed.m4"
66551220Seric		and "cs.hidden.m4" which both describe hosts in the
66651220Seric		CS.Berkeley.EDU subdomain; the former displays the local
66751220Seric		hostname (e.g., mammoth.CS.Berkeley.EDU), whereas the
66851220Seric		latter does its best to hide the identity of the local
66951220Seric		workstation inside the CS subdomain.
67051220Seric
67151220Sericmailer		Descriptions of mailers.   These are referenced using
67251220Seric		the MAILER macro in the .mc file.
67351220Seric
67451220Sericsh		Shell files used when building the .cf file from the
67551220Seric		.mc file in the cf subdirectory.
67651220Seric
67751220Sericfeature		These hold special orthogonal features that you might
67851220Seric		want to include.  They should be referenced using
67951220Seric		the FEATURE macro.
68051220Seric
68151220Serichack		Local hacks.  These can be referenced using the HACK
68251220Seric		macro.  They shouldn't be of more than voyeuristic
68351220Seric		interest outside the .Berkeley.EDU domain, but who knows?
68451220Seric		We've all got our own peccadilloes.
68551220Seric
68651268Sericsiteconfig	Site configuration -- e.g., tables of locally connected
68751268Seric		UUCP sites.
68851220Seric
68951268Seric
69057246Seric+------------------------+
69157246Seric| ADMINISTRATIVE DETAILS |
69257246Seric+------------------------+
69351220Seric
69451220SericThe following sections detail usage of certain internal parts of the
69551220Sericsendmail.cf file.  Read them carefully if you are trying to modify
69651220Sericthe current model.  If you find the above descriptions adequate, these
69751220Sericshould be {boring, confusing, tedious, ridiculous} (pick one or more).
69851220Seric
69951220SericRULESETS (* means built in to sendmail)
70051220Seric
70151220Seric   0 *	Parsing
70251220Seric   1 *	Sender rewriting
70351220Seric   2 *	Recipient rewriting
70451220Seric   3 *	Canonicalization
70551220Seric   4 *	Post cleanup
70654839Seric   5 *	Local address rewrite (after aliasing)
70751220Seric   6	Bottom half of Ruleset 3
70857247Seric   7	Hook for recursive ruleset 0 call
70957247Seric   8
71057247Seric   9
71151220Seric
71251220Seric
71351220SericMAILERS
71451220Seric
71551220Seric   0	local, prog	local and program mailers
71651220Seric   1	smtp		SMTP channel
71758087Seric   2	uucp		UNIX-to-UNIX Copy Program
71858087Seric   3	netnews		Network News delivery
719*58363Seric   4	fax		Sam Leffler's FlexFAX software
72051220Seric
72151220Seric
72251220SericMACROS
72351220Seric
72451220Seric   A
72551220Seric   B	Bitnet Relay
72651220Seric   C	CSNET Relay
72754839Seric   D	The local domain -- usually not needed
72851220Seric   E
729*58363Seric   F	FAX Relay
73051220Seric   G
73157591Seric   H	mail Hub (for mail clusters)
73251220Seric   I
73351220Seric   J
73451220Seric   K
73551220Seric   L
73651220Seric   M	Masquerade (who I claim to be)
73751220Seric   N
73851220Seric   O
73951220Seric   P
74051220Seric   Q
74151220Seric   R	Relay (for unqualified names)
74258071Seric   S	Smart Host
74351220Seric   T
74451309Seric   U	my UUCP name (if I have a UUCP connection)
74551309Seric   V	UUCP Relay (class V hosts)
74651220Seric   W	UUCP Relay (class W hosts)
74751220Seric   X	UUCP Relay (class X hosts)
74851309Seric   Y	UUCP Relay (all other hosts)
74951220Seric   Z	Version number
75051220Seric
75151220Seric
75251220SericCLASSES
75351220Seric
75451220Seric   A
75551220Seric   B
75651220Seric   C
75751220Seric   D
75857246Seric   E	addresses that should not seem to come from $M
75954839Seric   F	hosts we forward for
76051220Seric   G
76151220Seric   H
76251220Seric   I
76351220Seric   J
76451220Seric   K
76551220Seric   L	addresses that should not be forwarded to $R
76651220Seric   M
76751220Seric   N
76851220Seric   O	operators that indicate network operations (cannot be in local names)
76951220Seric   P
77051220Seric   Q
77151220Seric   R
77251220Seric   S
77351220Seric   T
77451220Seric   U	locally connected UUCP hosts
77551309Seric   V	UUCP hosts connected to relay $V
77651309Seric   W	UUCP hosts connected to relay $W
77751309Seric   X	UUCP hosts connected to relay $X
77851309Seric   Y	locally connected smart UUCP hosts
77951220Seric   Z
78054839Seric   .	the class containing only a dot
78151220Seric
78251220Seric
78351220SericM4 DIVERSIONS
78451220Seric
78558071Seric   1	Local host detection and resolution
78658071Seric   2	Local Ruleset 3 additions
78758071Seric   3	Local Ruleset 0 additions
78851268Seric   4	UUCP Ruleset 0 additions
78951309Seric   5	locally interpreted names (overrides $R)
79054839Seric   6	local configuration (at top of file)
79151220Seric   7	mailer definitions
79254839Seric   8	special local name recognition (late in ruleset 3)
79358087Seric   9	special local name recognition (late in ruleset 0)
794