xref: /original-bsd/usr.sbin/sendmail/cf/README (revision 948d00a2)
1
2
3		NEW SENDMAIL CONFIGURATION FILES
4
5		Eric Allman <eric@CS.Berkeley.EDU>
6
7		@(#)README	8.40 (Berkeley) 11/20/94
8
9
10This document describes the sendmail configuration files being used
11at Berkeley.  These use features in the new (R8) sendmail; they will
12not work on other versions.
13
14These configuration files are probably not as general as previous
15versions, and don't handle as many of the weird cases automagically.
16I was able to simplify by them for two reasons.  First, the network
17has become more consistent -- for example, at this point, everyone
18on the internet is supposed to be running a name server, so hacks to
19handle NIC-registered hosts can go away.  Second, I assumed that a
20subdomain would be running SMTP internally -- UUCP is presumed to be
21a long-haul protocol.  I realize that this is not universal, but it
22does describe the vast majority of sites with which I am familiar,
23including those outside the US.
24
25Of course, the downside of this is that if you do live in a weird
26world, things are going to get weirder for you.  I'm sorry about that,
27but at the time we at Berkeley had a problem, and it seemed like the
28right thing to do.
29
30This package requires a post-V7 version of m4; if you are running the
314.2bsd, SysV.2, or 7th Edition version, I suggest finding a friend with
32a newer version.  You can m4-expand on their system, then run locally.
33SunOS's /usr/5bin/m4 or BSD-Net/2's m4 both work.  GNU m4 version 1.1
34also works.  Unfortunately, I'm told that the M4 on BSDI 1.0 doesn't
35work -- you'll have to use a Net/2 or GNU version.
36
37IF YOU DON'T HAVE A BERKELEY MAKE, don't despair!  Just run
38"m4 foo.mc > foo.cf" -- that should be all you need.  There is also
39a fairly crude (but functional) Makefile.dist that works on the
40old version of make.
41
42To get started, you may want to look at tcpproto.mc (for TCP-only
43sites), uucpproto.mc (for UUCP-only sites), and clientproto.mc (for
44clusters of clients using a single mail host).  Others are versions
45that we use at Berkeley, although not all are in current use.  For
46example, ucbarpa has gone away, but I've left ucbarpa.mc in because
47it demonstrates some interesting techniques.
48
49I'm not pretending that this README describes everything that these
50configuration files can do; clever people can probably tweak them
51to great effect.  But it should get you started.
52
53*******************************************************************
54***  BE SURE YOU CUSTOMIZE THESE FILES!  They have some		***
55***  Berkeley-specific assumptions built in, such as the name	***
56***  of our UUCP-relay.  You'll want to create your own domain	***
57***  description, and use that in place of domain/Berkeley.m4.	***
58*******************************************************************
59
60
61+--------------------------+
62| INTRODUCTION AND EXAMPLE |
63+--------------------------+
64
65Configuration files are contained in the subdirectory "cf", with a
66suffix ".mc".  They must be run through "m4" to produce a ".cf" file.
67
68Let's examine a typical .mc file (cf/cs-exposed.mc):
69
70	divert(-1)
71	#
72	# Copyright (c) 1983 Eric P. Allman
73	# Copyright (c) 1988 The Regents of the University of California.
74	# All rights reserved.
75	#
76	# Redistribution and use in source and binary forms are permitted
77	# provided that the above copyright notice and this paragraph are
78	# duplicated in all such forms and that any documentation,
79	# advertising materials, and other materials related to such
80	# distribution and use acknowledge that the software was developed
81	# by the University of California, Berkeley.  The name of the
82	# University may not be used to endorse or promote products derived
83	# from this software without specific prior written permission.
84	# THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
85	# IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
86	# WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
87	#
88
89The divert(-1) will delete the crud in the resulting output file.
90The copyright notice is what your lawyers require.  Our lawyers require
91the one that I've included in my files. A copyleft is a copyright by
92another name.
93
94The next line MUST be
95
96	include(`../m4/cf.m4')
97
98This will pull in the M4 macros you will need to make sense of
99everything else.  As the saying goes, don't think about it, just
100do it.  If you don't do it, don't bother reading the rest of this
101file.
102
103	VERSIONID(`<SCCS or RCS version id>')
104
105VERSIONID is a macro that stuffs the version information into the
106resulting file.  We use SCCS; you could use RCS, something else, or
107omit it completely.  This is not the same as the version id included
108in SMTP greeting messages -- this is defined in m4/version.m4.
109
110	DOMAIN(cs.exposed)
111
112This example exposes the host inside of the CS subdomain -- that is,
113it doesn't try to hide the name of the workstation to the outside
114world.  Changing this to DOMAIN(cs.hidden) would have made outgoing
115messages refer to "<username>@CS.Berkeley.EDU" instead of using the
116local hostname.  Internally this is effected by using
117"MASQUERADE_AS(CS.Berkeley.EDU)".
118
119	MAILER(smtp)
120
121These describe the mailers used at the default CS site site.  The
122local mailer is always included automatically.
123
124
125+--------+
126| OSTYPE |
127+--------+
128
129Note that cf/cs-exposed.mc omits an OSTYPE macro -- this assumes
130default Computer Science Division environment.  There are several
131explicit environments available: bsd4.3, bsd4.4, hpux, irix, osf1,
132riscos4.5, sunos3.5, sunos4.1, and ultrix4.1.  These change things
133like the location of the alias file and queue directory.  Some of
134these files are identical to one another.
135
136Operating system definitions are easy to write.  They may define
137the following variables (everything defaults, so an ostype file
138may be empty).
139
140ALIAS_FILE		[/etc/aliases] The location of the text version
141			of the alias file(s).  It can be a comma-separated
142			list of names (but be sure you quote values with
143			comments in them -- for example, use
144				define(`ALIAS_FILE', `a,b')
145			to get "a" and "b" both listed as alias files;
146			otherwise the define() primitive only sees "a").
147HELP_FILE		[/usr/lib/sendmail.hf] The name of the file
148			containing information printed in response to
149			the SMTP HELP command.
150QUEUE_DIR		[/var/spool/mqueue] The directory containing
151			queue files.
152STATUS_FILE		[/etc/sendmail.st] The file containing status
153			information.
154LOCAL_MAILER_PATH	[/bin/mail] The program used to deliver local mail.
155LOCAL_MAILER_FLAGS	[rmn] The flags used by the local mailer.  The
156			flags lsDFM are always included.
157LOCAL_MAILER_ARGS	[mail -d $u] The arguments passed to deliver local
158			mail.
159LOCAL_SHELL_PATH	[/bin/sh] The shell used to deliver piped email.
160LOCAL_SHELL_FLAGS	[eu] The flags used by the shell mailer.  The
161			flags lsDFM are always included.
162LOCAL_SHELL_ARGS	[sh -c $u] The arguments passed to deliver "prog"
163			mail.
164USENET_MAILER_PATH	[/usr/lib/news/inews] The name of the program
165			used to submit news.
166USENET_MAILER_FLAGS	[rlsDFMmn] The mailer flags for the usenet mailer.
167USENET_MAILER_ARGS	[-m -h -n] The command line arguments for the
168			usenet mailer.
169USENET_MAILER_MAX	[100000] The maximum size of messages that will
170			be accepted by the usenet mailer.
171SMTP_MAILER_FLAGS	[undefined] Flags added to SMTP mailer.  Default
172			flags are `mDFMUX' for all SMTP-based mailers; the
173			"esmtp" mailer adds `a' and "smtp8" adds `8'.
174SMTP_MAILER_MAX		[undefined] The maximum size of messages that will
175			be transported using the smtp, smtp8, or esmtp
176			mailers.
177SMTP_MAILER_ARGS	[IPC $h] The arguments passed to the smtp mailer.
178			About the only reason you would want to change this
179			would be to change the default port.
180ESMTP_MAILER_ARGS	[IPC $h] The arguments passed to the esmtp mailer.
181SMTP8_MAILER_ARGS	[IPC $h] The arguments passed to the smtp8 mailer.
182RELAY_MAILER_ARGS	[IPC $h] The arguments passed to the relay mailer.
183UUCP_MAILER_FLAGS	[undefined] Flags added to UUCP mailer.  Default
184			flags are `DFMhuU' (and `m' for suucp mailer, minus
185			`U' for uucp-dom mailer).
186UUCP_MAILER_ARGS	[uux - -r -z -a$f -gC $h!rmail ($u)] The arguments
187			passed to the UUCP mailer.
188UUCP_MAX_SIZE		[100000] The maximum size message accepted for
189			transmission by the UUCP mailers.
190FAX_MAILER_PATH		[/usr/local/lib/fax/mailfax] The program used to
191			submit FAX messages.
192FAX_MAILER_MAX		[100000] The maximum size message accepted for
193			transmission by FAX.
194POP_MAILER_PATH		[/usr/lib/mh/spop] The pathname of the POP mailer.
195POP_MAILER_FLAGS	[Penu] Flags added to POP mailer.  Flags "lsDFM"
196			are always added.
197POP_MAILER_ARGS		[pop $u] The arguments passed to the POP mailer.
198PROCMAIL_MAILER_FLAGS	[Shu] Flags added to Procmail mailer.  Flags
199			``DFMmn'' are always set.
200PROCMAIL_MAILER_ARGS	[procmail -m $h $f $u] The arguments passed to
201			the Procmail mailer.
202
203+---------+
204| DOMAINS |
205+---------+
206
207You will probably want to collect domain-dependent defines into one
208file, referenced by the DOMAIN macro.  For example, our Berkeley
209domain file includes definitions for several internal distinguished
210hosts:
211
212UUCP_RELAY	The host that will forward UUCP-addressed email.
213		If not defined, all UUCP sites must be directly
214		connected.
215BITNET_RELAY	The host that will forward BITNET-addressed email.
216		If not defined, the .BITNET pseudo-domain won't work.
217LOCAL_RELAY	The site that will handle unqualified names -- that
218		is, names with out an @domain extension.  If not set,
219		they are assumed to belong on this machine.  This
220		allows you to have a central site to store a
221		company- or department-wide alias database.  This
222		only works at small sites, and there are better
223		methods.
224LUSER_RELAY	The site that will handle lusers -- that is, apparently
225		local names that aren't local accounts or aliases.
226
227Any of these can be either ``mailer:hostname'' (in which case the
228mailer is the internal mailer name, such as ``suucp'' and the hostname
229is the name of the host as appropriate for that mailer) or just a
230``hostname'', in which case a default mailer type (usually ``relay'',
231a variant on SMTP) is used.  WARNING: if you have a wildcard MX
232record matching your domain, you probably want to define these to
233have a trailing dot so that you won't get the mail diverted back
234to yourself.
235
236The domain file can also be used to define a domain name, if needed
237(using "DD<domain>") and set certain site-wide features.  If all hosts
238at your site masquerade behind one email name, you could also use
239MASQUERADE_AS here.
240
241You do not have to define a domain -- in particular, if you are a
242single machine sitting off somewhere, it is probably more work than
243it's worth.  This is just a mechanism for combining "domain dependent
244knowledge" into one place.
245
246+---------+
247| MAILERS |
248+---------+
249
250There are fewer mailers supported in this version than the previous
251version, owing mostly to a simpler world.
252
253local		The local and prog mailers.  You will almost always
254		need these; the only exception is if you relay ALL
255		your mail to another site.  This mailer is included
256		automatically.
257
258smtp		The Simple Mail Transport Protocol mailer.  This does
259		not hide hosts behind a gateway or another other
260		such hack; it assumes a world where everyone is
261		running the name server.  This file actually defines
262		four mailers: "smtp" for regular (old-style) SMTP to
263		other servers, "esmtp" for extended SMTP to other
264		servers, "smtp8" to do SMTP to other servers without
265		converting 8-bit data to MIME (essentially, this is
266		your statement that you know the other end is 8-bit
267		clean even if it doesn't say so), and "relay" for
268		transmission to our RELAY_HOST, LUSER_RELAY, or
269		MAILER_HUB.
270
271uucp		The Unix-to-Unix Copy Program mailer.  Actually, this
272		defines two mailers, "uucp-old" (a.k.a. "uucp") and
273		"uucp-new" (a.k.a. "suucp").  The latter is for when you
274		know that the UUCP mailer at the other end can handle
275		multiple recipients in one transfer.  If the smtp mailer
276		is also included in your configuration, two other mailers
277		("uucp-dom" and "uucp-uudom") are also defined.  When you
278		include the uucp mailer, sendmail looks for all names in
279		the $=U class and sends them to the uucp-old mailer; all
280		names in the $=Y class are sent to uucp-new; and all
281		names in the $=Z class are sent to uucp-uudom.  Note that
282		this is a function of what version of rmail runs on
283		the receiving end, and hence may be out of your control.
284		See the section below describing UUCP mailers in more
285		detail.
286
287usenet		Usenet (network news) delivery.  If this is specified,
288		an extra rule is added to ruleset 0 that forwards all
289		local email for users named ``group.usenet'' to the
290		``inews'' program.  Note that this works for all groups,
291		and may be considered a security problem.
292
293fax		Facsimile transmission.  This is experimental and based
294		on Sam Leffler's FlexFAX software.  For more information,
295		see below.
296
297pop		Post Office Protocol.
298
299procmail	An interface to procmail (does not come with sendmail).
300		This is designed to be used in mailertables.  For example,
301		a common question is "how do I forward all mail for a given
302		domain to a single person?".  If you have this mailer
303		defined, you could set up a mailertable reading:
304
305			host.com	procmail:/etc/procmailrcs/host.com
306
307		with the file /etc/procmailrcs/host.com reading:
308
309			:0	# forward mail for host.com
310			! -oi -f $1 person@other.host
311
312		This would arrange for (anything)@host.com to be sent
313		to person@other.host.  Within the procmail script, $1 is
314		the name of the sender and $2 is the name of the recipient.
315		If you use this with FEATURE(local_procmail), the FEATURE
316		should be listed first.
317
318The local mailer accepts addresses of the form "user+detail", where
319the "+detail" is not used for mailbox matching but is available
320to certain local mail programs (in particular, see FEATURE(local_procmail)).
321For example, "eric", "eric+sendmail", and "eric+sww" all indicate
322the same user, but additional arguments <null>, "sendmail", and "sww"
323may be provided for use in sorting mail.
324
325
326+----------+
327| FEATURES |
328+----------+
329
330Special features can be requested using the "FEATURE" macro.  For
331example, the .mc line:
332
333	FEATURE(use_cw_file)
334
335tells sendmail that you want to have it read an /etc/sendmail.cw
336file to get values for class $=w.  The FEATURE may contain a single
337optional parameter -- for example:
338
339	FEATURE(mailertable, dbm /usr/lib/mailertable)
340
341Available features are:
342
343use_cw_file	Read the file /etc/sendmail.cw file to get alternate
344		names for this host.  This might be used if you were
345		on a host that MXed for a dynamic set of other
346		hosts.  If the set is static, just including the line
347		"Cw<name1> <name2> ..." is probably superior.
348		The actual filename can be overridden by redefining
349		confCW_FILE.
350
351redirect	Reject all mail addressed to "address.REDIRECT" with
352		a ``551 User not local; please try <address>'' message.
353		If this is set, you can alias people who have left
354		to their new address with ".REDIRECT" appended.
355
356nouucp		Don't do anything special with UUCP addresses at all.
357
358nocanonify	Don't pass addresses to $[ ... $] for canonification.
359		This would generally only be used by sites that only
360		act as mail gateways or which have user agents that do
361		full canonification themselves.  You may also want to
362		use "define(`confBIND_OPTS',`-DNSRCH -DEFNAMES')" to
363		turn off the usual resolver options that do a similar
364		thing.
365
366stickyhost	If set, email sent to "user@local.host" are marked
367		as "sticky" -- that is, the local addresses aren't
368		matched against UDB and don't go through ruleset 5.
369		This is used if you want a set up where "user" is
370		not necessarily the same as "user@local.host", e.g.,
371		to make a distinct domain-wide namespace.  Prior to
372		8.7 this was the default, and notsticky was used to
373		turn this off.
374
375mailertable	Include a "mailer table" which can be used to override
376		routing for particular domains.  The argument of the
377		FEATURE may be the key definition.  If none is specified,
378		the definition used is:
379			hash -o /etc/mailertable
380		Keys in this database are fully qualified domain names
381		or partial domains preceded by a dot -- for example,
382		"vangogh.CS.Berkeley.EDU" or ".CS.Berkeley.EDU".
383		Values must be of the form:
384			mailer:domain
385		where "mailer" is the internal mailer name, and "domain"
386		is where to send the message.  These maps are not
387		reflected into the message header.
388
389domaintable	Include a "domain table" which can be used to provide
390		domain name mapping.  Use of this should really be
391		limited to your own domains.  It may be useful if you
392		change names (e.g., your company changes names from
393		oldname.com to newname.com).  The argument of the
394		FEATURE may be the key definition.  If none is specified,
395		the definition used is:
396			hash -o /etc/domaintable
397		The key in this table is the domain name; the value is
398		the new (fully qualified) domain.  Anything in the
399		domaintable is reflected into headers; that is, this
400		is done in ruleset 3.
401
402bitdomain	Look up bitnet hosts in a table to try to turn them into
403		internet addresses.  The table can be built using the
404		bitdomain program contributed by John Gardiner Myers.
405		The argument of the FEATURE may be the key definition; if
406		none is specified, the definition used is:
407			hash -o /etc/bitdomain.db
408		Keys are the bitnet hostname; values are the corresponding
409		internet hostname.
410
411uucpdomain	Similar feature for UUCP hosts.  The default map definition
412		is:
413			hash -o /etc/uudomain.db
414		At the moment there is no automagic tool to build this
415		database.
416
417always_add_domain
418		Include the local host domain even on locally delivered
419		mail.  Normally it is not added unless it is already
420		present.
421
422allmasquerade	If masquerading is enabled (using MASQUERADE_AS), this
423		feature will cause recipient addresses to also masquerade
424		as being from the masquerade host.  Normally they get
425		the local hostname.  Although this may be right for
426		ordinary users, it can break local aliases.  For example,
427		if you send to "localalias", the originating sendmail will
428		find that alias and send to all members, but send the
429		message with "To: localalias@masqueradehost".  Since that
430		alias likely does not exist, replies will fail.  Use this
431		feature ONLY if you can guarantee that the ENTIRE
432		namespace on your masquerade host supersets all the
433		local entries.
434
435nodns		We aren't running DNS at our site (for example,
436		we are UUCP-only connected).  It's hard to consider
437		this a "feature", but hey, it had to go somewhere.
438
439nullclient	This is a special case -- it creates a stripped down
440		configuration file containing nothing but support for
441		forwarding all mail to a central hub via a local
442		SMTP-based network.  The argument is the name of that
443		hub.
444
445		The only other feature that should be used in conjunction
446		with this one is "nocanonify" (this causes addresses to
447		be sent unqualified via the SMTP connection; normally
448		they are qualifed with the masquerade name, which
449		defaults to the name of the hub machine).  No mailers
450		should be defined.  No aliasing or forwarding is done.
451
452local_procmail	Use procmail as the local mailer.  This mailer can
453		make use of the "user+indicator@local.host" syntax;
454		normally the +indicator is just tossed, but by default
455		it is passed as the -a argument to procmail.  The
456		argument to this feature is the pathname of procmail,
457		which defaults to /usr/local/bin/procmail.
458
459
460+-------+
461| HACKS |
462+-------+
463
464Some things just can't be called features.  To make this clear,
465they go in the hack subdirectory and are referenced using the HACK
466macro.  These will tend to be site-dependent.  The release
467includes the Berkeley-dependent "cssubdomain" hack (that makes
468sendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU;
469this is intended as a short-term aid while we move hosts into
470subdomains.
471
472
473+--------------------+
474| SITE CONFIGURATION |
475+--------------------+
476
477Complex sites will need more local configuration information, such as
478lists of UUCP hosts they speak with directly.  This can get a bit more
479tricky.  For an example of a "complex" site, see cf/ucbvax.mc.
480
481If your host is known by several different names, you need to augment
482the $=w class.  This is a list of names by which you are known, and
483anything sent to an address using a host name in this list will be
484treated as local mail.  You can do this in two ways: either create
485the file /etc/sendmail.cw containing a list of your aliases (one per
486line), and use ``FEATURE(use_cw_file)'' in the .mc file, or add the
487line:
488
489	Cw alias.host.name
490
491at the end of that file.  See the ``vangogh.mc'' file for an example.
492Be sure you use the fully-qualified name of the host, rather than a
493short name.
494
495The SITECONFIG macro allows you to indirectly reference site-dependent
496configuration information stored in the siteconfig subdirectory.  For
497example, the line
498
499	SITECONFIG(uucp.ucbvax, ucbvax, U)
500
501reads the file uucp.ucbvax for local connection information.  The
502second parameter is the local name (in this case just "ucbvax" since
503it is locally connected, and hence a UUCP hostname).  The third
504parameter is the name of both a macro to store the local name (in
505this case, $U) and the name of the class (e.g., $=U) in which to store
506the host information read from the file.  Another SITECONFIG line reads
507
508	SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W)
509
510This says that the file uucp.ucbarpa contains the list of UUCP sites
511connected to ucbarpa.Berkeley.EDU.  The $=W class will be used to
512store this list, and $W is defined to be ucbarpa.Berkeley.EDU, that
513is, the name of the relay to which the hosts listed in uucp.ucbarpa
514are connected.  [The machine ucbarpa is gone now, but I've left
515this out-of-date configuration file around to demonstrate how you
516might do this.]
517
518Note that the case of SITECONFIG with a third parameter of ``U'' is
519special; the second parameter is assumed to be the UUCP name of the
520local site, rather than the name of a remote site, and the UUCP name
521is entered into $=w (the list of local hostnames) as $U.UUCP.
522
523The siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing
524more than a sequence of SITE macros describing connectivity.  For
525example:
526
527	SITE(cnmat)
528	SITE(sgi olympus)
529
530The second example demonstrates that you can use two names on the
531same line; these are usually aliases for the same host (or are at
532least in the same company).
533
534
535+--------------------+
536| USING UUCP MAILERS |
537+--------------------+
538
539It's hard to get UUCP mailers right because of the extremely ad hoc
540nature of UUCP addressing.  These config files are really designed
541for domain-based addressing, even for UUCP sites.
542
543There are four UUCP mailers available.  The choice of which one to
544use is partly a matter of local preferences and what is running at
545the other end of your UUCP connection.  Unlike good protocols that
546define what will go over the wire, UUCP uses the policy that you
547should do what is right for the other end; if they change, you have
548to change.  This makes it hard to do the right thing, and discourages
549people from updating their software.  In general, if you can avoid
550UUCP, please do.
551
552The major choice is whether to go for a domainized scheme or a
553non-domainized scheme.  This depends entirely on what the other
554end will recognize.  If at all possible, you should encourage the
555other end to go to a domain-based system -- non-domainized addresses
556don't work entirely properly.
557
558The four mailers are:
559
560    uucp-old (obsolete name: "uucp")
561	This is the oldest, the worst (but the closest to UUCP) way of
562	sending messages accros UUCP connections.  It does bangify
563	everything and prepends $U (your UUCP name) to the sender's
564	address (which can already be a bang path itself).  It can
565	only send to one address at a time, so it spends a lot of
566	time copying duplicates of messages.  Avoid this if at all
567	possible.
568
569    uucp-new (obsolete name: "suucp")
570	The same as above, except that it assumes that in one rmail
571	command you can specify several recipients.  It still has a
572	lot of other problems.
573
574    uucp-dom
575	This UUCP mailer keeps everything as domain addresses.
576	Basically, it uses the SMTP mailer rewriting rules.  This mailer
577	is only included if MAILER(smtp) is also specified.
578
579	Unfortunately, a lot of UUCP mailer transport agents require
580	bangified addresses in the envelope, although you can use
581	domain-based addresses in the message header.  (The envelope
582	shows up as the From_ line on UNIX mail.)  So....
583
584    uucp-uudom
585	This is a cross between uucp-new (for the envelope addresses)
586	and uucp-dom (for the header addresses).  It bangifies the
587	envelope sender (From_ line in messages) without adding the
588	local hostname, unless there is no host name on the address
589	at all (e.g., "wolf") or the host component is a UUCP host name
590	instead of a domain name ("somehost!wolf" instead of
591	"some.dom.ain!wolf").  This is also included only if MAILER(smtp)
592	is also specified.
593
594Examples:
595
596We are on host grasp.insa-lyon.fr (UUCP host name "grasp").  The
597following summarizes the sender rewriting for various mailers.
598
599Mailer          sender		rewriting in the envelope
600------		------		-------------------------
601uucp-{old,new}	wolf		grasp!wolf
602uucp-dom	wolf		wolf@grasp.insa-lyon.fr
603uucp-uudom	wolf		grasp.insa-lyon.fr!wolf
604
605uucp-{old,new}	wolf@fr.net	grasp!fr.net!wolf
606uucp-dom	wolf@fr.net	wolf@fr.net
607uucp-uudom	wolf@fr.net	fr.net!wolf
608
609uucp-{old,new}	somehost!wolf	grasp!somehost!wolf
610uucp-dom	somehost!wolf	somehost!wolf@grasp.insa-lyon.fr
611uucp-uudom	somehost!wolf	grasp.insa-lyon.fr!somehost!wolf
612
613If you are using one of the domainized UUCP mailers, you really want
614to convert all UUCP addresses to domain format -- otherwise, it will
615do it for you (and probably not the way you expected).  For example,
616if you have the address foo!bar!baz (and you are not sending to foo),
617the heuristics will add the @uucp.relay.name or @local.host.name to
618this address.  However, if you map foo to foo.host.name first, it
619will not add the local hostname.  You can do this using the uucpdomain
620feature.
621
622
623+-------------------+
624| TWEAKING RULESETS |
625+-------------------+
626
627For more complex configurations, you can define special rules.
628The macro LOCAL_RULE_3 introduces rules that are used in canonicalizing
629the names.  Any modifications made here are reflected in the header.
630
631A common use is to convert old UUCP addreses to SMTP addresses using
632the UUCPSMTP macro.  For example:
633
634	LOCAL_RULE_3
635	UUCPSMTP(decvax,	decvax.dec.com)
636	UUCPSMTP(research,	research.att.com)
637
638will cause addresses of the form "decvax!user" and "research!user"
639to be converted to "user@decvax.dec.com" and "user@research.att.com"
640respectively.
641
642This could also be used to look up hosts in a database map:
643
644	LOCAL_RULE_3
645	R$* < @ $+ > $*		$: $1 < @ $(hostmap $2 $) > $3
646
647This map would be defined in the LOCAL_CONFIG portion, as shown below.
648
649Similarly, LOCAL_RULE_0 can be used to introduce new parsing rules.
650For example, new rules are needed to parse hostnames that you accept
651via MX records.  For example, you might have:
652
653	LOCAL_RULE_0
654	R$+ <@ host.dom.ain.>	$#uucp $@ cnmat $: $1 < @ host.dom.ain.>
655
656You would use this if you had installed an MX record for cnmat.Berkeley.EDU
657pointing at this host; this rule catches the message and forwards it on
658using UUCP.
659
660You can also tweak rulesets 1 and 2 using LOCAL_RULE_1 and LOCAL_RULE_2.
661These rulesets are normally empty.
662
663A similar macro is LOCAL_CONFIG.  This introduces lines added after the
664boilerplate option setting but before rulesets, and can be used to
665declare local database maps or whatever.  For example:
666
667	LOCAL_CONFIG
668	Khostmap hash /etc/hostmap.db
669	Kyplocal nis -m hosts.byname
670
671
672+---------------------------+
673| MASQUERADING AND RELAYING |
674+---------------------------+
675
676You can have your host masquerade as another using
677
678	MASQUERADE_AS(host.domain)
679
680This causes outgoing SMTP mail to be labeled as coming from the
681indicated domain, rather than $j.  One normally masquerades as one
682of one's own subdomains (for example, it's unlikely that I would
683choose to masquerade as an MIT site).
684
685The masquerade name is not normally canonified, so it is important
686that it be your One True Name, that is, fully qualified and not a
687CNAME.
688
689there are always users that need to be "exposed" -- that is, their
690internal site name should be displayed instead of the masquerade name.
691Root is an example.  You can add users to this list using
692
693	EXPOSED_USER(usernames)
694
695This adds users to class E; you could also use something like
696
697	FE/etc/sendmail.cE
698
699You can also arrange to relay all unqualified names (that is, names
700without @host) to a relay host.  For example, if you have a central
701email server, you might relay to that host so that users don't have
702to have .forward files or aliases.  You can do this using
703
704	define(`LOCAL_RELAY', mailer:hostname)
705
706The ``mailer:'' can be omitted, in which case the mailer defaults to
707"smtp".  There are some user names that you don't want relayed, perhaps
708because of local aliases.  A common example is root, which may be
709locally aliased.  You can add entries to this list using
710
711	LOCAL_USER(usernames)
712
713This adds users to class L; you could also use something like
714
715	FL/etc/sendmail.cL
716
717If you want all incoming mail sent to a centralized hub, as for a
718shared /var/spool/mail scheme, use
719
720	define(`MAIL_HUB', mailer:hostname)
721
722Again, ``mailer:'' defaults to "smtp".  If you define both LOCAL_RELAY
723and MAIL_HUB, unqualified names will be sent to the LOCAL_RELAY and
724other local names will be sent to MAIL_HUB.  Names in $=L will be
725delivered locally, so you MUST have aliases or .forward files for them.
726
727For example, if are on machine mastodon.CS.Berkeley.EDU, the following
728combinations of settings will have the indicated effects:
729
730email sent to....	eric			  eric@mastodon.CS.Berkeley.EDU
731
732LOCAL_RELAY set to	mail.CS.Berkeley.EDU	  (delivered locally)
733mail.CS.Berkeley.EDU
734
735MAIL_HUB set to		mammoth.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
736mammoth.CS.Berkeley.EDU
737
738Both LOCAL_RELAY and	mail.CS.Berkeley.EDU	  mammoth.CS.Berkeley.EDU
739MAIL_HUB set as above
740
741If you want all outgoing mail to go to a central relay site, define
742SMART_HOST as well.  Briefly:
743
744	LOCAL_RELAY applies to unqualifed names (e.g., "eric").
745	MAIL_HUB applies to names qualified with the name of the
746		local host (e.g., "eric@mastodon.CS.Berkeley.EDU").
747	SMART_HOST applies to names qualified with other hosts.
748
749However, beware that other relays (e.g., UUCP_RELAY, BITNET_RELAY, and
750FAX_RELAY) take precedence over SMART_HOST, so if you really want
751absolutely everything to go to a single central site you will need to
752unset all the other relays -- or better yet, find or build a minimal
753config file that does this.
754
755
756+-------------------------------+
757| NON-SMTP BASED CONFIGURATIONS |
758+-------------------------------+
759
760These configuration files are designed primarily for use by SMTP-based
761sites.  I don't pretend that they are well tuned for UUCP-only or
762UUCP-primarily nodes (the latter is defined as a small local net
763connected to the rest of the world via UUCP).  However, there is one
764hook to handle some special cases.
765
766You can define a ``smart host'' that understands a richer address syntax
767using:
768
769	define(`SMART_HOST', mailer:hostname)
770
771In this case, the ``mailer:'' defaults to "relay".  Any messages that
772can't be handled using the usual UUCP rules are passed to this host.
773
774If you are on a local SMTP-based net that connects to the outside
775world via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules.
776For example:
777
778	define(`SMART_HOST', suucp:uunet)
779	LOCAL_NET_CONFIG
780	R$* < @ $* .$m. > $*	$#smtp $@ $2.$m. $: $1 < @ $2.$m. > $3
781
782This will cause all names that end in your domain name ($m) via
783SMTP; anything else will be sent via suucp (smart UUCP) to uunet.
784If you have FEATURE(nocanonify), you may need to omit the dots after
785the $m.  If you are running a local DNS inside your domain which is
786not otherwise connected to the outside world, you probably want to
787use:
788
789	define(`SMART_HOST', smtp:fire.wall.com)
790	LOCAL_NET_CONFIG
791	R$* < @ $* . > $*	$#smtp $@ $2. $: $1 < @ $2. > $3
792
793That is, send directly only to things you found in your DNS lookup;
794anything else goes through SMART_HOST.
795
796If you are not running DNS at all, it is important to use
797FEATURE(nodns) to avoid having sendmail queue everything waiting
798for the name server to come up.
799
800
801+-----------+
802| WHO AM I? |
803+-----------+
804
805Normally, the $j macro is automatically defined to be your fully
806qualified domain name (FQDN).  Sendmail does this by getting your
807host name using gethostname and then calling gethostbyname on the
808result.  For example, in some environments gethostname returns
809only the root of the host name (such as "foo"); gethostbyname is
810supposed to return the FQDN ("foo.bar.com").  In some (fairly rare)
811cases, gethostbyname may fail to return the FQDN.  In this case
812you MUST define confDOMAIN_NAME to be your fully qualified domain
813name.  This is usually done using:
814
815	Dmbar.com
816	define(`confDOMAIN_NAME', `$w.$m')dnl
817
818
819+--------------------+
820| USING MAILERTABLES |
821+--------------------+
822
823To use FEATURE(mailertable), you will have to create an external
824database containing the routing information for various domains.
825For example, a mailertable file in text format might be:
826
827	.my.domain		xnet:%1.my.domain
828	uuhost1.my.domain	suucp:uuhost1
829	.bitnet			smtp:relay.bit.net
830
831This should normally be stored in /etc/mailertable.  The actual
832database version of the mailertable is built using:
833
834	makemap hash /etc/mailertable.db < /etc/mailertable
835
836The semantics are simple.  Any LHS entry that does not begin with
837a dot matches the full host name indicated.  LHS entries beginning
838with a dot match anything ending with that domain name -- that is,
839they can be thought of as having a leading "*" wildcard.  Matching
840is done in order of most-to-least qualified -- for example, even
841though ".my.domain" is listed first in the above example, an entry
842of "uuhost1.my.domain" will match the second entry since it is
843more explicit.
844
845The RHS should always be a "mailer:host" pair.  The mailer is the
846configuration name of a mailer (that is, an `M' line in the
847sendmail.cf file).  The "host" will be the hostname passed to
848that mailer.  In domain-based matches (that is, those with leading
849dots) the "%1" may be used to interpolate the wildcarded part of
850the host name.  For example, the first line above sends everything
851addressed to "anything.my.domain" to that same host name, but using
852the (presumably experimental) xnet mailer.
853
854In some cases you may want to temporarily turn off MX records,
855particularly on gateways.  For example, you may want to MX
856everything in a domain to one machine that then forwards it
857directly.  To do this, you might use the DNS configuration:
858
859	*.domain.	IN	MX	0	relay.machine
860
861and on relay.machine use the mailertable:
862
863	.domain		smtp:[gateway.domain]
864
865The [square brackets] turn off MX records for this host only.
866If you didn't do this, the mailertable would use the MX record
867again, which would give you an MX loop.
868
869
870+--------------------------------+
871| USING USERDB TO MAP FULL NAMES |
872+--------------------------------+
873
874The user database was not originally intended for mapping full names
875to login names (e.g., Eric.Allman => eric), but some people are using
876it that way.  (I would recommend that you set up aliases for this
877purpose instead -- since you can specify multiple alias files, this
878is fairly easy.)  The intent was to locate the default maildrop at
879a site, but allow you to override this by sending to a specific host.
880
881If you decide to set up the user database in this fashion, it is
882imperative that you not use FEATURE(stickyhost) -- otherwise,
883e-mail sent to Full.Name@local.host.name will be rejected.
884
885To build the internal form of the user database, use:
886
887	makemap btree /usr/data/base.db < /usr/data/base.txt
888
889
890+--------------------------------+
891| MISCELLANEOUS SPECIAL FEATURES |
892+--------------------------------+
893
894DOTTED_USER(name)
895	Sometimes it is convenient to merge configuration on a
896	centralized mail machine, for example, to forward all
897	root mail to a mail server.  In this case it might be
898	useful to be able to treat the root addresses as a class
899	of addresses with subtle differences.  You can do this
900	using dotted users.  For example, a client might include
901	the alias:
902
903		root:  root.client1@server
904
905	On the server, the mail configuration would include:
906
907		DOTTED_USER(root)
908
909	Aliases on the server that would match this address would
910	be "root.client", "root.*", and "root", tried in that
911	order.  You can specify multiple addresses either by
912	joining them in one DOTTTED_USER macro or by having
913	multiple macros:
914
915		DOTTED_USER(root)
916		DOTTED_USER(postmaster mailer-daemon)
917
918	defines three dotted users.
919
920
921+------------------+
922| FlexFAX SOFTWARE |
923+------------------+
924
925Sam Leffler's FlexFAX software is still in beta test -- but he expects a
926public version out "later this week" [as of 3/1/93].  The following
927blurb is direct from Sam:
928
929	$Header: /usr/people/sam/fax/RCS/HOWTO,v 1.14 93/05/24 11:42:16 sam Exp $
930
931	How To Obtain This Software (in case all you get is this file)
932	--------------------------------------------------------------
933	The source code is available for public ftp on
934	    sgi.com			sgi/fax/v2.1.src.tar.Z
935		(192.48.153.1)
936
937	You can also obtain inst'able images for Silicon Graphics machines from
938	    sgi.com			sgi/fax/v2.1.inst.tar
939		(192.48.153.1)
940
941	For example,
942	    % ftp -n sgi.com
943	    ....
944	    ftp> user anonymous
945	    ... <type in password>
946	    ftp> cd sgi/fax
947	    ftp> binary
948	    ftp> get v2.1.src.tar.Z
949
950	In general, the latest version of the 2.1 release of the software is
951	always available as "v2.1.src.tar.Z" or "v2.1.inst.tar" in the ftp
952	directory.  This file is a link to the appropriate released version (so
953	don't waste your time retrieving the linked file as well!) Any files of
954	the form v2.1.*.patch are shell scripts that can be used to patch older
955	versions of the source code.  For example, the file v2.1.0.patch would
956	contain patches to update v2.1.0.tar.Z.  (Note to beta testers: this is
957	different than the naming conventions used during beta testing.) Patch
958	files only work to go between consecutive versions, so if you are
959	multiple versions behind the latest release, you will need to apply
960	each patch file between your current version and the latest.
961
962
963	Obtaining the Software by Electronic Mail
964	-----------------------------------------
965	Do not send me requests for the software; they will be ignored (without
966	response).  If you cannot use FTP at all, there is a service called
967	"ftpmail" available from gatekeeper.dec.com:  you can send e-mail to
968	this machine and it will use FTP to retrieve files for you and send you
969	the files back again via e-mail.  To find out more about the ftpmail
970	service, send a message to "ftpmail@gatekeeper.dec.com" whose body
971	consists of the single line "help".
972
973
974	Obtaining the Software Within Silicon Graphics
975	----------------------------------------------
976	Internal to Silicon Graphics there are inst'able images on the host
977	flake.asd in the directory /usr/dist.  Thus you can do something like:
978
979	    % inst -f flake.asd.sgi.com:/usr/dist/flexfax
980
981	to install the latest version of the software on your machine.
982
983
984	What to do Once You've Retrieved Stuff
985	--------------------------------------
986	The external distributions come in a compressed or uncompressed tar
987	file.  To extract the source distribution:
988
989	    % zcat v2.1.src.tar.Z | tar xf -
990
991	(uncompress and extract individual files in current directory).  To
992	unpack and install the client portion of the inst'able distribution:
993
994	    % mkdir dist
995	    % cd dist; tar xf ../v2.1.inst.tar; cd ..
996	    % inst -f dist/flexfax
997	    ...
998	    inst> go
999
1000	(Note, the dist subdirectory is because some versions of inst fail if
1001	the files are in the current directory.) Server binaries are also
1002	included in the inst'able images as flexfax.server.*.  They are not
1003	installed by default, so to get them also you need to do:
1004
1005	    % inst -f flexfax
1006	    ...
1007	    inst> install flexfax.server.*
1008	    inst> go
1009
1010	The SGI binaries were built for Version 4.0.5H of the IRIX operating
1011	system.  They should work w/o problem on earlier versions of the
1012	system, but I have not fully tested this.  Also, note that to install a
1013	server on an SGI machine, you need to have installed the Display
1014	PostScript execution environment product (dps_eoe).  Otherwise, the fax
1015	server will not be able to convert PostScript to facsimile for
1016	transmission.
1017
1018	If you are working from the source distribution, look at the file
1019	README in the top of the source tree.  If you are working from the inst
1020	images, the subsystem flexfax.man.readme contains the README file and
1021	other useful pieces of information--the installed files are placed in
1022	the directory /usr/local/doc/flexfax).  Basically you will need to run
1023	the faxaddmodem script to setup and configure your fax modem.  Consult
1024	the README file and the manual page for faxaddmodem for information.
1025
1026
1027	FlexFAX Mail List
1028	-----------------
1029	A mailing list for users of this software is located on sgi.com.
1030	If you want to join this mailing list or have a list-related request
1031	such as getting your name removed from it, send a request to
1032
1033	    majordomo@whizzer.wpd.sgi.com
1034
1035	For example, to subscribe, send the line "subscribe flexfax" in
1036	the body of your message.  The line "help" will return a list of
1037	the commands understood by the mailing list management software.
1038
1039	Submissions (including bug reports) should be directed to:
1040
1041	    flexfax@sgi.com
1042
1043	When corresponding about this software please always specify what
1044	version you have, what system you're running on, and, if the problem is
1045	specific to your modem, identify the modem and firmware revision.
1046
1047
1048+--------------------------------+
1049| TWEAKING CONFIGURATION OPTIONS |
1050+--------------------------------+
1051
1052There are a large number of configuration options that don't normally
1053need to be changed.  However, if you feel you need to tweak them, you
1054can define the following M4 variables.  This list is shown in four
1055columns:  the name you define, the default value for that definition,
1056the option or macro that is affected (either Ox for an option or Dx
1057for a macro), and a brief description.  Greater detail of the semantics
1058can be found in the Installation and Operations Guide.
1059
1060Some options are likely to be deprecated in future versions -- that is,
1061the option is only included to provide back-compatibility.  These are
1062marked with "*".
1063
1064Remember that these options are M4 variables, and hence may need to
1065be quoted.  In particular, arguments with commas will usually have to
1066be ``double quoted, like this phrase'' to avoid having the comma
1067confuse things.  This is common for alias file definitions and for
1068the read timeout.
1069
1070M4 Variable Name	Default		Mac/Opt	Description
1071================	=======		=======	===========
1072confMAILER_NAME		MAILER-DAEMON	Dn	The sender name used for
1073						internally generated
1074						outgoing messages.
1075confFROM_LINE		From $g  $d	Dl	The From_ line used when
1076						sending to files or programs.
1077confFROM_HEADER		$?x$x <$g>$|$g$.	The format of an internally
1078					Dq	generated From: address.
1079confOPERATORS		.:%@!^/[]+	Do	Address operator characters.
1080confSMTP_LOGIN_MSG	$j Sendmail $v/$Z ready at $b
1081					De	The initial (spontaneous)
1082						SMTP greeting message.
1083confRECEIVED_HEADER	$?sfrom $s $.$?_($?s$|from $.$_) $.by $j ($v/$Z)$?r with $r$. id $i$?u for $u$.; $b
1084					HReceived
1085						The format of the Received:
1086						header in messages passed
1087						through this host.  It is
1088						unwise to try to change this.
1089confSEVEN_BIT_INPUT	False		O7	Force input to seven bits?
1090confEIGHT_BIT_HANDLING	pass8		O8	8-bit data handling
1091confALIAS_WAIT		10		Oa	Wait (in minutes) for alias
1092						file rebuild.
1093confMIN_FREE_BLOCKS	4		Ob	Minimum number of free blocks
1094						on queue filesystem to accept
1095						SMTP mail.
1096confBLANK_SUB		.		OB	Blank (space) substitution
1097						character.
1098confCON_EXPENSIVE	False		Oc	Avoid connecting immediately
1099						to mailers marked expensive?
1100confCHECKPOINT_INTERVAL	10		OC	Checkpoint queue files
1101						every N recipients.
1102confDELIVERY_MODE	background	Od	Default delivery mode.
1103confAUTO_REBUILD	False		OD	Automatically rebuild
1104						alias file if needed.
1105confERROR_MODE		(undefined)	Oe	Error message mode.
1106confERROR_MESSAGE	(undefined)	OE	Error message header/file.
1107confSAVE_FROM_LINES	False		Of	Save extra leading
1108						From_ lines.
1109confTEMP_FILE_MODE	0600		OF	Temporary file mode.
1110confDEF_GROUP_ID	1		Og	Default group id.
1111confMATCH_GECOS		False		OG	Match GECOS field.
1112confMAX_HOP		17		Oh	Maximum hop count.
1113confIGNORE_DOTS		False		Oi *	Ignore dot as terminator
1114						for incoming messages?
1115confBIND_OPTS		(empty)		OI	Default options for BIND.
1116confMIME_FORMAT_ERRORS	True		Oj *	Send error messages as MIME-
1117						encapsulated messages per
1118						RFC 1344.
1119confFORWARD_PATH	(undefined)	OJ	The colon-separated list of
1120						places to search for .forward
1121						files.
1122confMCI_CACHE_SIZE	2		Ok	Size of open connection cache.
1123confMCI_CACHE_TIMEOUT	5m		OK	Open connection cache timeout.
1124confUSE_ERRORS_TO	False		Ol *	Use the Errors-To: header to
1125						deliver error messages.  This
1126						should not be necessary because
1127						of general acceptance of the
1128						envelope/header distinction.
1129confLOG_LEVEL		9		OL	Log level.
1130confME_TOO		False		Om	Include sender in group
1131						expansions.
1132confCHECK_ALIASES	True		On	Check RHS of aliases when
1133						running newaliases.
1134confOLD_STYLE_HEADERS	True		Oo *	Assume that headers without
1135						special chars are old style.
1136confDAEMON_OPTIONS	(undefined)	OO	SMTP daemon options.
1137confPRIVACY_FLAGS	authwarnings	Op	Privacy flags.
1138confCOPY_ERRORS_TO	(undefined)	OP	Address for additional copies
1139						of all error messages.
1140confQUEUE_FACTOR	(undefined)	Oq	Slope of queue-only function
1141confREAD_TIMEOUT	(undefined)	Or	SMTP read timeouts.
1142confDONT_PRUNE_ROUTES	False		OR	Don't prune down route-addr
1143						syntax addresses to the
1144						minimum possible.
1145confSAFE_QUEUE		True		Os *	Commit all messages to disk
1146						before forking.
1147confMESSAGE_TIMEOUT	5d/4h		OT	Timeout for messages before
1148						sending error/warning message.
1149confTIME_ZONE		USE_SYSTEM	Ot	Time zone info -- can be
1150						USE_SYSTEM to use the system's
1151						idea, USE_TZ to use the user's
1152						TZ envariable, or something
1153						else to force that value.
1154confDEF_USER_ID		1		Ou	Default user id.
1155confUSERDB_SPEC		(undefined)	OU	User database specification.
1156confFALLBACK_MX		(undefined)	OV	Fallback MX host.
1157confTRY_NULL_MX_LIST	False		Ow	If we are the best MX for a
1158						host and haven't made other
1159						arrangements, try connecting
1160						to the host directly; normally
1161						this would be a config error.
1162confQUEUE_LA		8		Ox	Load average at which queue-only
1163						function kicks in.
1164confREFUSE_LA		12		OX	Load average at which incoming
1165						SMTP connections are refused.
1166confWORK_RECIPIENT_FACTOR
1167			(undefined)	Oy	Cost of each recipient.
1168confSEPARATE_PROC	False		OY	Run all deliveries in a
1169						separate process.
1170confWORK_CLASS_FACTOR	(undefined)	Oz	Priority multiplier for class.
1171confWORK_TIME_FACTOR	(undefined)	OZ	Cost of each delivery attempt.
1172confCW_FILE		/etc/sendmail.cw	Name of file used to get the
1173					Fw	local additions to the $=w
1174						class.
1175confSMTP_MAILER		smtp		-	The mailer name used when
1176						SMTP connectivity is required.
1177						One of "smtp", "smtp8", or
1178						"esmtp".
1179confLOCAL_MAILER	local		-	The mailer name used when
1180						local connectivity is required.
1181						Almost always "local".
1182confRELAY_MAILER	relay		-	The default mailer name used
1183						for relaying any mail (e.g.,
1184						to a BITNET_RELAY, a
1185						SMART_HOST, or whatever).
1186						This can reasonably be "suucp"
1187						if you are on a UUCP-connected
1188						site.
1189confDOMAIN_NAME		(undefined)	Dj	If defined, sets $j.
1190
1191
1192+-----------+
1193| HIERARCHY |
1194+-----------+
1195
1196Within this directory are several subdirectories, to wit:
1197
1198m4		General support routines.  These are typically
1199		very important and should not be changed without
1200		very careful consideration.
1201
1202cf		The configuration files themselves.  They have
1203		".mc" suffixes, and must be run through m4 to
1204		become complete.  The resulting output should
1205		have a ".cf" suffix.
1206
1207ostype		Definitions describing a particular operating
1208		system type.  These should always be referenced
1209		using the OSTYPE macro in the .mc file.  Examples
1210		include "bsd4.3", "bsd4.4", "sunos3.5", and
1211		"sunos4.1".
1212
1213domain		Definitions describing a particular domain, referenced
1214		using the DOMAIN macro in the .mc file.  These are
1215		site dependent; for example, we contribute "cs.exposed.m4"
1216		and "cs.hidden.m4" which both describe hosts in the
1217		CS.Berkeley.EDU subdomain; the former displays the local
1218		hostname (e.g., mammoth.CS.Berkeley.EDU), whereas the
1219		latter does its best to hide the identity of the local
1220		workstation inside the CS subdomain.
1221
1222mailer		Descriptions of mailers.   These are referenced using
1223		the MAILER macro in the .mc file.
1224
1225sh		Shell files used when building the .cf file from the
1226		.mc file in the cf subdirectory.
1227
1228feature		These hold special orthogonal features that you might
1229		want to include.  They should be referenced using
1230		the FEATURE macro.
1231
1232hack		Local hacks.  These can be referenced using the HACK
1233		macro.  They shouldn't be of more than voyeuristic
1234		interest outside the .Berkeley.EDU domain, but who knows?
1235		We've all got our own peccadillos.
1236
1237siteconfig	Site configuration -- e.g., tables of locally connected
1238		UUCP sites.
1239
1240
1241+------------------------+
1242| ADMINISTRATIVE DETAILS |
1243+------------------------+
1244
1245The following sections detail usage of certain internal parts of the
1246sendmail.cf file.  Read them carefully if you are trying to modify
1247the current model.  If you find the above descriptions adequate, these
1248should be {boring, confusing, tedious, ridiculous} (pick one or more).
1249
1250RULESETS (* means built in to sendmail)
1251
1252   0 *	Parsing
1253   1 *	Sender rewriting
1254   2 *	Recipient rewriting
1255   3 *	Canonicalization
1256   4 *	Post cleanup
1257   5 *	Local address rewrite (after aliasing)
1258  1x	mailer rules (sender qualification)
1259  2x	mailer rules (recipient qualification)
1260  3x	mailer rules (sender header qualification)
1261  4x	mailer rules (recipient header qualification)
1262  5x	mailer subroutines (general)
1263  6x	mailer subroutines (general)
1264  7x	mailer subroutines (general)
1265  8x	reserved
1266  90	Mailertable host stripping
1267  96	Bottom half of Ruleset 3 (ruleset 6 in old sendmail)
1268  97	Hook for recursive ruleset 0 call (ruleset 7 in old sendmail)
1269  98	Local part of ruleset 0 (ruleset 8 in old sendmail)
1270
1271
1272MAILERS
1273
1274   0	local, prog	local and program mailers
1275   1	[e]smtp, relay	SMTP channel
1276   2	uucp-*		UNIX-to-UNIX Copy Program
1277   3	netnews		Network News delivery
1278   4	fax		Sam Leffler's FlexFAX software
1279
1280
1281MACROS
1282
1283   A
1284   B	Bitnet Relay
1285   C
1286   D	The local domain -- usually not needed
1287   E
1288   F	FAX Relay
1289   G
1290   H	mail Hub (for mail clusters)
1291   I
1292   J
1293   K
1294   L	Luser Relay
1295   M	Masquerade (who I claim to be)
1296   N
1297   O
1298   P
1299   Q
1300   R	Relay (for unqualified names)
1301   S	Smart Host
1302   T
1303   U	my UUCP name (if I have a UUCP connection)
1304   V	UUCP Relay (class V hosts)
1305   W	UUCP Relay (class W hosts)
1306   X	UUCP Relay (class X hosts)
1307   Y	UUCP Relay (all other hosts)
1308   Z	Version number
1309
1310
1311CLASSES
1312
1313   A
1314   B
1315   C
1316   D	"dotted" users
1317   E	addresses that should not seem to come from $M
1318   F	hosts we forward for
1319   G
1320   H
1321   I
1322   J
1323   K
1324   L	addresses that should not be forwarded to $R
1325   M
1326   N
1327   O	operators that indicate network operations (cannot be in local names)
1328   P	top level pseudo-domains: BITNET, FAX, UUCP, etc.
1329   Q
1330   R
1331   S
1332   T
1333   U	locally connected UUCP hosts
1334   V	UUCP hosts connected to relay $V
1335   W	UUCP hosts connected to relay $W
1336   X	UUCP hosts connected to relay $X
1337   Y	locally connected smart UUCP hosts
1338   Z	locally connected domain-ized UUCP hosts
1339   .	the class containing only a dot
1340
1341
1342M4 DIVERSIONS
1343
1344   1	Local host detection and resolution
1345   2	Local Ruleset 3 additions
1346   3	Local Ruleset 0 additions
1347   4	UUCP Ruleset 0 additions
1348   5	locally interpreted names (overrides $R)
1349   6	local configuration (at top of file)
1350   7	mailer definitions
1351   8
1352   9	special local rulesets (1 and 2)
1353