Some tidies to the new edition.
[exim.git] / doc / doc-src / spec.src
1 . $Cambridge: exim/doc/doc-src/spec.src,v 1.7 2005/02/16 16:09:00 ph10 Exp $
2 .
3 .set version "4.50"
4 .set previousversion "4.40"
5 .set versionmonth "February"
6 .set versionyear "2005"
7 .set ACL "ACL"
8
9 . The last of those is to make ACL index entries easier to type. It is put
10 . up here so that it gets picked up by the HTML converter, which otherwise
11 . skips to the first chapter. A longer version is set below for use in the
12 . printed index.
13
14 .set sgcal true
15 .set html  false
16 .set texinfo false
17
18 .if !set style
19 .library "a4ps"
20 .linelength ~~sys.linelength + 0.2in
21 .set newlinelength ~~sys.linelength
22 .emphasis ~~sys.linelength + 0.1in
23 .pagedepth ~~sys.pagedepth - 0.2in
24 .bindfont 51 "atl/Times-Bold" 9
25 .bindfont 52 "atl/Times-Roman" 9
26 .bindfont 53 "atl/Times-Roman" 7
27 .bindfont 54 "atl/Courier" 9
28 .bindfont 55 "atl/Courier-Bold" ~~maintypesize
29 .bindfont 56 "atl/Times-Italic" 7
30 .bindfont 57 "atl/Times-Bold" 7
31 .bindfont 58 "atl/Symbol" 7
32 .set ssspaceb 1.50
33
34 .if ~~sgcal
35 . Used for the "small print" incorporated code stuff. Only rm, it, bf, sp are
36 . actually used at present.
37 .              rm  it  sl  bf  bi  ss  tt  sp  sc
38 .fontgroup 9 = 53  56   0  57   0   0   0  58   0
39 .fi
40 .fi
41
42 .if !~~sys.fancy
43 .fontgroup 9 = 0  0  0  0  0  0  0  0  0
44 .fi
45
46 .include "markup.sg"
47
48 .if ~~sys.fancy
49 .flag $smc{ "$push$g0$f54"
50 .flag $sm{  "$push$g0$f53"
51 .flag $smi{ "$push$g0$f56"
52 .flag $as{  "$push$g0$f52"
53 .flag $ab{  "$push$g0$f51"
54 .flag $cb{  "$push$g0$f55"
55 .
56 .else
57 .flag $smc{ "$push"
58 .flag $sm{  "$push"
59 .flag $smi{ "$push"
60 .flag $cb{  "$push"
61 .fi
62
63 .macro isunderscore "string"
64 .set string "~~1"
65 .set length length "~~1"
66 .undrec 1
67 .endm
68
69 .macro undrec "offset"
70 .if ~~1 > ~~length
71 .set underscore false
72 .else
73 .set sub "~~string"(1,~~1)
74 .if "~~sub" == "_"
75 .set underscore true
76 .else
77 .set next ~~1 + 1
78 .undrec ~~next
79 .fi
80 .fi
81 .endm
82
83 .macro testunderscore "string"
84 .isunderscore "~~1"
85 .newline
86 .endm
87
88 .macro tabs 6
89 .if ~~sys.fancy
90 .tabset ~~1em
91 .else
92 .set temp (~~1 * 5)/4
93 .tabset ~~temp em
94 .fi
95 .endm
96
97 .macro startoptions
98 .newline
99 .push
100 .if ~~sys.fancy
101 .indent 6em
102 .else
103 .indent 7em
104 .fi
105 .endm
106
107 .macro endoptions
108 .newline
109 .pop
110 .endm
111
112 .macro option "option" ""
113 .newpar
114 .index \-~~1-\ option
115 .tempindent 0
116 \-~~1-\~~2#$i
117 .nosep
118 .endm
119
120 .macro startitems
121 .newline
122 .push
123 .indent 3em
124 .endm
125
126 .macro enditems
127 .newline
128 .pop
129 .endm
130
131 .macro item "item" "6"
132 .newpar
133 .if ~~sys.leftonpage < ~~2ld
134 .newpage
135 .fi
136 .tempindent 0
137 \**~~1**\
138 .blank
139 .endm
140
141 .macro startconf ""
142 .set confsection "~~1"
143 .newline
144 .push
145 .if ~~sys.fancy
146 .indent 2em
147 .tabset 9em
148 .else
149 .indent 4em
150 .tabset 13em
151 .fi
152 .endm
153
154 .macro endconf
155 .newline
156 .pop
157 .endm
158
159 .macro conf "option" "type" "default" "6"
160 .newpar
161 .if ~~sys.leftonpage < ~~4ld
162 .newpage
163 .fi
164 .testunderscore "~~1"
165 .if ~~underscore
166 .index \~~1\
167 .else
168 .index \~~1\ option
169 .fi
170 .if "~~confsection" == ""
171 .set inssect ""
172 .else
173 .set inssect "$rm{Use:} $it{~~confsection}###"
174 .fi
175 .tempindent 0
176 \**~~1**\ $c ~~inssect$rm{Type:} $it{~~2} $e $rm{Default:} $it{~~3}
177 .blank
178 .endm
179
180 .set contents true
181 .set figurenumber -1
182 .set displayindent 2em
183
184 .index @$1, @$2, etc. $it{see numerical variables}
185 .index address||rewriting $it{see rewriting}
186 .index CR character $it{see carriage return}
187 .index CRL $it{see certificate revocation list}
188 .index delivery||failure report $it{see bounce message}
189 .index dialup $it{see intermittently connected hosts}
190 .index exiscan $it{see content scanning}
191 .index failover $it{see fallback}
192 .index fallover $it{see fallback}
193 .index filter||Sieve $it{see Sieve filter}
194 .index ident $it{see RFC 1413}
195 .index LF character $it{see linefeed}
196 .index maximum $it{see limit}
197 .index NUL $it{see binary zero}
198 .index passwd file $it{see \(/etc/passwd)\}
199 .index process id $it{see pid}
200 .index RBL $it{see DNS list}
201 .index redirection $it{see address redirection}
202 .index return path||$it{see also envelope sender}
203 .index scanning $it{see content scanning}
204 .index SSL $it{see TLS}
205 .index string||expansion $it{see expansion}
206 .index top bit $it{see 8-bit characters}
207 .index variables $it{see expansion, variables}
208 .index zero, binary $it{see binary zero}
209
210 . This is used for the printed index. See setting above for
211 . the HTML index value.
212
213 .set ACL "access control lists (ACLs)"
214
215 . ======================================================
216
217 .push
218 .disable filling
219 .justify centre
220 .nofoot
221 .space 8ld
222 $chead{University of Cambridge Computing Service}
223 .space 2ld
224 $chead{Specification of the Exim Mail Transfer Agent}
225 .space 3ld
226 by
227 .space 1ld
228 Philip Hazel
229 .space ~~sys.leftonpage - 15*~~sys.linedepth
230 .justify left
231 University Computing Service
232 New Museums Site
233 Pembroke Street
234 Cambridge CB2 3QH
235 United Kingdom
236 .blank
237 .tabs 6
238 $it{phone:} $t +44 1223 334600
239 $it{fax:}   $t +44 1223 334679
240 $it{email:} $t ph10 $it{at} cus.cam.ac.uk
241 .blank
242 Edition for Exim ~~version, ~~versionmonth ~~versionyear
243 .space 2ld
244 .if ~~sgcal
245 .fontgroup 1
246 .fi
247 $c$rm{Copyright (c) University of Cambridge ~~versionyear}
248
249
250 .if ~~sgcal
251 .fontgroup 0
252 .font 0
253 .fi
254
255 .pop
256 .newpage
257
258 . Blank verso for title page
259 .space 1ld
260 .newpage
261
262
263 . Set up for actual text pages
264 .page 1
265 . The first one to prevent a warning from sgfr
266 . set runningfoot "~~chapter"
267 .set runningfoot ""
268
269 .if ~~sys.fancy
270 .footdepth 2ld
271 .foot
272 .if "~~runningfoot" == ""
273 .set rhs ""
274 .else
275 .set rhs "~~runningfoot (~~chapter)"
276 .fi
277 .set lhs "Exim ~~version"
278 .linelength ~~newlinelength
279 $it{~~lhs}$c[~~sys.pagenumber]$e$it{~~rhs}
280 .endfoot
281 .fi
282
283
284
285
286 .
287 .
288 .
289 .
290 . ============================================================================
291 .chapter Introduction
292 .set runningfoot "introduction"
293
294 .if ~~sys.fancy
295 $c$bi{If I have seen further it is by standing on the shoulders of giants.}##(Isaac Newton)
296 .elif !~~html
297 $c"If I have seen further it is by standing on the shoulders of giants."
298 .newline
299 $e (Isaac Newton)
300 .else
301 \*If I have seen further it is by standing on the shoulders of giants.*\
302 (Isaac Newton).
303 .fi
304 .blank 4
305
306 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
307 Unix-like operating systems. It was designed on the assumption that it would be
308 run on hosts that are permanently connected to the Internet. However, it can be
309 used on intermittently connected hosts with suitable configuration adjustments.
310
311 Configuration files currently exist for the following operating systems: AIX,
312 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, FreeBSD, GNU/Hurd, GNU/Linux,
313 HI-OSF (Hitachi), HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD, QNX, SCO, SCO
314 SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4, Tru64-Unix (formerly
315 Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware. Some of these operating
316 systems are no longer current and cannot easily be tested, so the configuration
317 files may no longer work in practice.
318
319 There are also configuration files for compiling Exim in the Cygwin environment
320 that can be installed on systems running Windows. However, this document does
321 not contain any information about running Exim in the Cygwin environment.
322
323 The terms and conditions for the use and distribution of Exim are contained in
324 the file \(NOTICE)\. Exim is distributed under the terms of the GNU General
325 Public Licence, a copy of which may be found in the file \(LICENCE)\.
326
327 The use, supply or promotion of Exim for the purpose of sending bulk,
328 unsolicited electronic mail is incompatible with the basic aims of the program,
329 which revolve around the free provision of a service that enhances the quality
330 of personal communications. The author of Exim regards indiscriminate
331 mass-mailing as an antisocial, irresponsible abuse of the Internet.
332
333 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
334 experience of running and working on the Smail 3 code, I could never have
335 contemplated starting to write a new MTA. Many of the ideas and user interfaces
336 were originally taken from Smail 3, though the actual code of Exim is entirely
337 new, and has developed far beyond the initial concept.
338
339 Many people, both in Cambridge and around the world, have contributed to the
340 development and the testing of Exim, and to porting it to various operating
341 systems. I am grateful to them all. The distribution now contains a file called
342 \(ACKNOWLEDGMENTS)\, in which I have started recording the names of
343 contributors.
344
345
346 .section Exim documentation
347 .index documentation
348 .em
349 This edition of the Exim specification applies to version ~~version of Exim.
350 Substantive changes from the ~~previousversion edition are marked by bars in
351 the right-hand margin in the PostScript, PDF, and plain text versions of the
352 document, and by green text in the HTML version, as shown by this paragraph.
353 Changes are not marked in the Texinfo version, because Texinfo doesn't support
354 change bars. Minor corrections and rewordings are not marked.
355 .nem
356
357 This document is very much a reference manual; it is not a tutorial. The reader
358 is expected to have some familiarity with the SMTP mail transfer protocol and
359 with general Unix system administration. Although there are some discussions
360 and examples in places, the information is mostly organized in a way that makes
361 it easy to look up, rather than in a natural order for sequential reading.
362 Furthermore, the manual aims to cover every aspect of Exim in detail, including
363 a number of rarely-used, special-purpose features that are unlikely to be of
364 very wide interest.
365
366 .index books about Exim
367 An `easier' discussion of Exim which provides more in-depth explanatory,
368 introductory, and tutorial material can be found in a book entitled
369 .if ~~html
370 [(A HREF="http://www.uit.co.uk/exim-book/")]
371 $it{The Exim SMTP Mail Server},
372 [(/A)]
373 published by UIT Cambridge.
374 .else
375 $it{The Exim SMTP Mail Server}, published by UIT Cambridge
376 (\?http://www.uit.co.uk/exim-book/?\).
377 .fi
378
379 This book also contains a chapter that gives a general introduction to SMTP and
380 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
381 with the latest release of Exim. (Note that the earlier book about Exim,
382 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
383
384 .index \(doc/NewStuff)\
385 .index \(doc/ChangeLog)\
386 .index change log
387 As the program develops, there may be features in newer versions that have not
388 yet made it into this document, which is updated only when the most significant
389 digit of the fractional part of the version number changes. Specifications of
390 new features that are not yet in this manual are placed in the file
391 \(doc/NewStuff)\ in the Exim distribution. 
392
393 .em
394 Some features may be classified as `experimental'. These may change
395 incompatibly while they are developing, or even be withdrawn. For this reason,
396 they are not documented in this manual. Information about experimental features 
397 can be found in the file \(doc/experimental.txt)\.
398 .nem
399
400 All changes to the program (whether new features, bug fixes, or other kinds of
401 change) are noted briefly in the file called \(doc/ChangeLog)\.
402
403 .index \(doc/spec.txt)\
404 This specification itself is available as an ASCII file in \(doc/spec.txt)\ so
405 that it can easily be searched with a text editor. Other files in the \(doc)\
406 directory are:
407 .display rm
408 .tabs 18
409 \(OptionLists.txt)\   $t $rm{list of all options in alphabetical order}
410 \(dbm.discuss.txt)\   $t $rm{discussion about DBM libraries}
411 \(exim.8)\            $t $rm{a man page of Exim's command line options}
412 .newline
413 .em
414 \(experimental.txt)\  $t $rm{documentation of experimental features}
415 .nem
416 .newline
417 \(filter.txt)\        $t $rm{specification of the filter language}
418 \(pcrepattern.txt)\   $t $rm{specification of PCRE regular expressions}
419 \(pcretest.txt)\      $t $rm{specification of the PCRE testing program}
420 \(Exim3.upgrade)\     $t $rm{upgrade notes from release 2 to release 3}
421 \(Exim4.upgrade)\     $t $rm{upgrade notes from release 3 to release 4}
422 .endd
423 The main specification and the specification of the filtering language are also
424 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
425 ~~SECTavail below tells you how to get hold of these.
426
427
428 .section FTP and web sites
429 .index web site
430 .index FTP site
431 .em
432 The primary distribution site for Exim is currently the University of 
433 Cambridge's FTP site, whose contents are described in \*Where to find the Exim
434 distribution*\ below. In addition, there is a
435 .if ~~html
436 [(A HREF="http://www.exim.org/")]
437 .fi
438 web site 
439 .if ~~html
440 [(/A)]
441 .fi
442 and an 
443 .if ~~html
444 [(A HREF="ftp://ftp.exim.org/")]
445 .fi
446 FTP site 
447 .if ~~html
448 [(/A)]
449 .fi
450 at \exim.org\. These are now also hosted at the University of Cambridge. 
451 The \exim.org\ site was previously hosted for a number of years by Energis
452 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
453
454 As well as Exim distribution tar files, the Exim web site contains a number of 
455 differently formatted versions of the documentation, including the
456 .index FAQ
457 .if ~~html
458 [(A HREF="FAQ.html")]
459 .fi
460 FAQ
461 .if ~~html
462 [(/A)]
463 .fi
464 in both text and HTML formats. The HTML version comes with a keyword-in-context
465 index. A recent addition to the online information is the
466 .index wiki
467 .if ~~html
468 [(A HREF="http://www.exim.org/eximwiki/")]
469 Exim wiki.
470 [(/A)]
471 .else
472 Exim wiki (\?http://www.exim.org/eximwiki/?\).
473 .fi
474 We hope that this will make it easier for Exim users to contribute examples, 
475 tips, and know-how for the benefit of others.
476 .nem
477
478 .section Mailing lists
479 .index mailing lists||for Exim users
480 The following are the two main Exim mailing lists:
481 .display rm
482 .tabs 28
483 $it{exim-users@@exim.org}          $t general discussion list
484 $it{exim-announce@@exim.org}       $t moderated, low volume announcements list
485 .endd
486 You can subscribe to these lists, change your existing subscriptions, and view
487 or search the archives via the
488 .if ~~html
489 [(A HREF="http://www.exim.org/maillist.html")]
490 .fi
491 mailing lists
492 .if ~~html
493 [(/A)]
494 .fi
495 link on the Exim home page. The $it{exim-users} mailing list is also forwarded
496 to \?http://www.egroups.com/list/exim-users?\, an archiving system with
497 searching capabilities.
498
499 .section Exim training
500 .index training courses
501 From time to time (approximately annually at the time of writing),
502 lecture-based training courses are run by the author of Exim in Cambridge, UK.
503 Details can be found on the web site
504 .if ~~html
505 [(A HREF="http://www-tus.csx.cam.ac.uk/courses/exim/")]
506 .fi
507 \?http://www-tus@.csx@.cam@.ac.uk/courses/exim/?\.
508 .if ~~html
509 [(/A)]
510 .fi
511
512 .section Bug reports
513 .index bug reports
514 .index reporting bugs
515 Reports of obvious bugs should be emailed to \*bugs@@exim.org*\. However, if
516 you are unsure whether some behaviour is a bug or not, the best thing to do is
517 to post a message to the $it{exim-users} mailing list and have it discussed.
518
519
520 .em
521 .section Where to find the Exim distribution
522 .rset SECTavail "~~chapter.~~section"
523 .index FTP site
524 .index distribution||ftp site
525 The master ftp site for the Exim distribution is
526 .display rm
527 .if ! ~~sys.fancy
528 .indent 0
529 .fi
530 \?ftp://ftp.csx.cam.ac.uk/pub/software/email/exim?\
531 .endd
532 This is mirrored by
533 .display rm
534 .if ! ~~sys.fancy
535 .indent 0
536 .fi
537 \?ftp://ftp.exim.org/pub/exim?\
538 .endd
539 The file references that follow are relative to the \(exim)\ directories at
540 these sites.
541
542 There are now quite a number of independent mirror sites around the world.
543 Those that I know about are listed in the file called \(Mirrors)\.
544
545 Within the \(exim)\ directory there are subdirectories called \(exim3)\ (for
546 previous Exim 3 distributions), \(exim4)\ (for the latest Exim 4
547 distributions), and \(Testing)\ for testing versions. In the \(exim4)\
548 subdirectory, the current release can always be found in files called
549 .display rm
550 \(exim-$it{n.nn}.tar.gz)\
551 \(exim-$it{n.nn}.tar.bz2)\
552 .endd
553 where $it{n.nn} is the highest such version number in the directory. The two
554 files contain identical data; the only difference is the type of compression.
555 The \(.bz2)\ file is usually a lot smaller than the \(.gz)\ file.
556 .index distribution||signing details
557 .index distribution||public key
558 .index public key for signed distribution
559 The distributions are currently signed with Philip Hazel's GPG key. The
560 corresponding public key is available from a number of keyservers, and there is
561 also a copy in the file \(Public-Key)\. The signatures for the tar bundles are
562 in:
563 .display rm
564 \(exim-$it{n.nn}.tar.gz.sig)\
565 \(exim-$it{n.nn}.tar.bz2.sig)\
566 .endd
567 For each released version, the log of changes is made separately available in a
568 separate file in the directory \(ChangeLogs)\ so that it is possible to
569 find out what has changed without having to download the entire distribution.
570
571 .index documentation||available formats
572 The main distribution contains ASCII versions of this specification and other
573 documentation; other formats of the documents are available in separate files
574 inside the \(exim4)\ directory of the FTP site:
575 .display rm
576 \(exim-html-$it{n.nn}.tar.gz)\
577 \(exim-pdf-$it{n.nn}.tar.gz)\
578 \(exim-postscript-$it{n.nn}.tar.gz)\
579 \(exim-texinfo-$it{n.nn}.tar.gz)\
580 .endd
581 These tar files contain only the \(doc)\ directory, not the complete
582 distribution, and are also available in \(.bz2)\ as well as \(.gz)\ forms.
583
584 .index FAQ
585 The FAQ is available for downloading in two different formats in these files:
586 .display rm
587 \(exim4/FAQ.txt.gz)\
588 \(exim4/FAQ.html.tar.gz)\
589 .endd
590 The first of these is a single ASCII file that can be searched with a text
591 editor. The second is a directory of HTML files, normally accessed by starting
592 at \(index.html)\. The HTML version of the FAQ (which is also included in the
593 HTML documentation tarbundle) includes a keyword-in-context index, which is
594 often the most convenient way of finding your way around.
595
596 .section Wish list
597 .index wish list
598 A wish list is maintained, containing ideas for new features that have been
599 submitted. From time to time the file is exported to the ftp site into the file
600 \(exim4/WishList)\. Items are removed from the list if they get implemented.
601
602
603 .section Contributed material
604 .index contributed material
605 At the ftp site, there is a directory called \(Contrib)\ that contains
606 miscellaneous files contributed to the Exim community by Exim users. There is
607 also a collection of contributed configuration examples in
608 \(exim4/config.samples.tar.gz)\. These samples are referenced from the FAQ.
609 .nem
610
611 .section Limitations
612 .index limitations of Exim
613 .numberpars $.
614 Exim is designed for use as an Internet MTA, and therefore handles addresses
615 in RFC 2822 domain format only.
616 .index bang paths||not handled by Exim
617 It cannot handle UUCP `bang paths', though simple two-component bang paths can
618 be converted by a straightforward rewriting configuration. This restriction
619 does not prevent Exim from being interfaced to UUCP as a transport mechanism,
620 provided that domain addresses are used.
621 .nextp
622 .index domainless addresses
623 .index address||without domain
624 Exim insists that every address it handles has a domain attached. For incoming
625 local messages, domainless addresses are automatically qualified with a
626 configured domain value. Configuration options specify from which remote
627 systems unqualified addresses are acceptable. These are then qualified on
628 arrival.
629 .nextp
630 .index transport||external
631 .index external transports
632 The only external transport currently implemented is an SMTP transport over a
633 TCP/IP network (using sockets, including support for IPv6). However, a pipe
634 transport is available, and there are facilities for writing messages to files
635 and pipes, optionally in \*batched SMTP*\ format; these facilities can be used
636 to send messages to some other transport mechanism such as UUCP, provided it
637 can handle domain-style addresses. Batched SMTP input is also catered for.
638 .nextp
639 Exim is not designed for storing mail for dial-in hosts. When the volumes of
640 such mail are large, it is better to get the messages `delivered' into files
641 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
642 other means.
643 .nextp
644 .em
645 Although Exim does have basic facilities for scanning incoming messages, these
646 are not comprehensive enough to do full virus or spam scanning. Such operations
647 are best carried out using additional specialized software packages. If you 
648 compile Exim with the content-scanning extension, straightforward interfaces to 
649 a number of common scanners are provided.
650 .nem
651 .endp
652
653
654
655 .section Run time configuration
656 Exim's run time configuration is held in a single text file that is divided
657 into a number of sections. The entries in this file consist of keywords and
658 values, in the style of Smail 3 configuration files. A default configuration
659 file which is suitable for simple online installations is provided in the
660 distribution, and is described in chapter ~~CHAPdefconfil below.
661
662
663 .section Calling interface
664 .index Sendmail compatibility||command line interface
665 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
666 can be a straight replacement for \(/usr/lib/sendmail)\ or
667 \(/usr/sbin/sendmail)\ when sending mail, but you do not need to know anything
668 about Sendmail in order to run Exim. For actions other than sending messages,
669 Sendmail-compatible options also exist, but those that produce output (for
670 example, \-bp-\, which lists the messages on the queue) do so in Exim's own
671 format. There are also some additional options that are compatible with Smail
672 3, and some further options that are new to Exim. Chapter ~~CHAPcommandline
673 documents all Exim's command line options. This information is automatically
674 made into the man page that forms part of the Exim distribution.
675
676 Control of messages on the queue can be done via certain privileged command
677 line options. There is also an optional monitor program called \*eximon*\, which
678 displays current information in an X window, and which contains a menu
679 interface to Exim's command line administration options.
680
681
682 .section Terminology
683 .index terminology definitions
684 .index body of message||definition of
685 The \*body*\ of a message is the actual data that the sender wants to transmit.
686 It is the last part of a message, and is separated from the \*header*\ (see
687 below) by a blank line.
688
689 .index bounce message||definition of
690 When a message cannot be delivered, it is normally returned to the sender in a
691 delivery failure message or a `non-delivery report' (NDR). The term \*bounce*\
692 is commonly used for this action, and the error reports are often called
693 \*bounce messages*\. This is a convenient shorthand for `delivery failure error
694 report'. Such messages have an empty sender address in the message's
695 \*envelope*\ (see below) to ensure that they cannot themselves give rise to
696 further bounce messages.
697
698 The term \*default*\ appears frequently in this manual. It is used to qualify a
699 value which is used in the absence of any setting in the configuration. It may
700 also qualify an action which is taken unless a configuration setting specifies
701 otherwise.
702
703 The term \*defer*\ is used when the delivery of a message to a specific
704 destination cannot immediately take place for some reason (a remote host may be
705 down, or a user's local mailbox may be full). Such deliveries are \*deferred*\
706 until a later time.
707
708 The word \*domain*\ is sometimes used to mean all but the first component of a
709 host's name. It is $it{not} used in that sense here, where it normally
710 refers to the part of an email address following the @@ sign.
711
712 .index envelope, definition of
713 .index sender||definition of
714 A message in transit has an associated \*envelope*\, as well as a header and a
715 body. The envelope contains a sender address (to which bounce messages should
716 be delivered), and any number of recipient addresses. References to the
717 sender or the recipients of a message usually mean the addresses in the
718 envelope. An MTA uses these addresses for delivery, and for returning bounce
719 messages, not the addresses that appear in the header lines.
720
721 .index message||header, definition of
722 .index header section||definition of
723 The \*header*\ of a message is the first part of a message's text, consisting
724 of a number of lines, each of which has a name such as ::From::, ::To::,
725 ::Subject::, etc. Long header lines can be split over several text lines by
726 indenting the continuations. The header is separated from the body by a blank
727 line.
728
729 .index local part||definition of
730 .index domain||definition of
731 The term \*local part*\, which is taken from RFC 2822, is used to refer to that
732 part of an email address that precedes the @@ sign. The part that follows the
733 @@ sign is called the \*domain*\ or \*mail domain*\.
734
735 .index local delivery||definition of
736 .index remote delivery, definition of
737 The terms \*local delivery*\ and \*remote delivery*\ are used to distinguish
738 delivery to a file or a pipe on the local host from delivery by SMTP over
739 TCP/IP to a remote host.
740
741 .index return path||definition of
742 \*Return path*\ is another name that is used for the sender address in a
743 message's envelope.
744
745 .index queue||definition of
746 The term \*queue*\ is used to refer to the set of messages awaiting delivery,
747 because this term is in widespread use in the context of MTAs. However, in
748 Exim's case the reality is more like a pool than a queue, because there is
749 normally no ordering of waiting messages.
750
751 .index queue runner||definition of
752 The term \*queue runner*\ is used to describe a process that scans the queue
753 and attempts to deliver those messages whose retry times have come. This term
754 is used by other MTAs, and also relates to the command \runq\, but in Exim
755 the waiting messages are normally processed in an unpredictable order.
756
757 .index spool directory||definition of
758 The term \*spool directory*\ is used for a directory in which Exim keeps the
759 messages on its queue -- that is, those that it is in the process of
760 delivering. This should not be confused with the directory in which local
761 mailboxes are stored, which is called a `spool directory' by some people. In
762 the Exim documentation, `spool' is always used in the first sense.
763
764
765
766 .
767 .
768 .
769 .
770 . ============================================================================
771 .chapter Incorporated code
772 .set runningfoot "incorporated code"
773 .index incorporated code
774 .index regular expressions||library
775 .index PCRE
776 A number of pieces of external code are included in the Exim distribution.
777 .numberpars $.
778 Regular expressions are supported in the main Exim program and in the Exim
779 monitor using the freely-distributable PCRE library, copyright (c) University
780 of Cambridge. The source is distributed in the directory \(src/pcre)\. However,
781 this is a cut-down version of PCRE. If you want to use the PCRE library in
782 other programs, you should obtain and install the full version from
783 \?ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre?\.
784
785 .space 1ld
786 .nextp
787 .index cdb||acknowledgement
788 Support for the cdb (Constant DataBase) lookup method is provided by code
789 contributed by Nigel Metheringham of (at the time he contributed it) Planet
790 Online Ltd. which contains the following statements:
791 .rule
792 .push
793 .if ~~sgcal
794 .fontgroup 9
795 .font 0
796 .fi
797 Copyright (c) 1998 Nigel Metheringham, Planet Online Ltd
798
799 This program is free software; you can redistribute it and/or modify it under
800 the terms of the GNU General Public License as published by the Free Software
801 Foundation; either version 2 of the License, or (at your option) any later
802 version.
803
804 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
805 the spec and sample code for cdb can be obtained from
806 \?http://www.pobox.com/@~djb/cdb.html?\. This implementation borrows some code
807 from Dan Bernstein's implementation (which has no license restrictions applied
808 to it).
809 .newline
810 .pop
811 .rule
812 The implementation is completely contained within the code of Exim.
813 It does not link against an external cdb library.
814 .space 1ld
815 .nextp
816 .index SPA authentication
817 .index Samba project
818 .index Microsoft Secure Password Authentication
819 Client support for Microsoft's \*Secure Password Authentication*\ is provided
820 by code contributed by Marc Prud'hommeaux. Server support was contributed by
821 Tom Kistner. This includes code taken from the Samba project, which is released
822 under the Gnu GPL.
823
824 .space 1ld
825 .nextp
826 .index Cyrus
827 .index \*pwcheck*\ daemon
828 .index \*pwauthd*\ daemon
829 Support for calling the Cyrus \*pwcheck*\ and \*saslauthd*\ daemons is provided
830 by code taken from the Cyrus-SASL library and adapted by Alexander S.
831 Sabourenkov. The permission notice appears below, in accordance with the
832 conditions expressed therein.
833
834 .rule
835 .push
836 .if ~~sgcal
837 .fontgroup 9
838 .font 0
839 .fi
840 Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.
841
842 Redistribution and use in source and binary forms, with or without
843 modification, are permitted provided that the following conditions
844 are met:
845
846 .if ~~sgcal
847 .cancelflag $npbracket
848 .flag $npbracket "" "."
849 .fi
850 .numberpars
851 Redistributions of source code must retain the above copyright
852 notice, this list of conditions and the following disclaimer.
853 .nextp
854 Redistributions in binary form must reproduce the above copyright
855 notice, this list of conditions and the following disclaimer in
856 the documentation and/or other materials provided with the
857 distribution.
858 .nextp
859 The name `Carnegie Mellon University' must not be used to
860 endorse or promote products derived from this software without
861 prior written permission. For permission or any other legal
862 details, please contact
863 .display rm
864 Office of Technology Transfer
865 Carnegie Mellon University
866 5000 Forbes Avenue
867 Pittsburgh, PA  15213-3890
868 (412) 268-4387, fax: (412) 268-7395
869 tech-transfer@@andrew.cmu.edu
870 .endd
871 .nextp
872 Redistributions of any form whatsoever must retain the following
873 acknowledgment:
874 .newline
875 .push
876 .indent ~~sys.indent + 3em
877 .justify left
878 $it{This product includes software developed by Computing Services
879 at Carnegie Mellon University (\?http://www.cmu.edu/computing/?\).}
880 .newline
881 .pop
882 .endp
883 .if ~~sgcal
884 .cancelflag $npbracket
885 .flag $npbracket "(" ")"
886 .fi
887
888 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
889 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
890 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
891 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
892 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
893 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
894 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
895 .newline
896 .pop
897 .rule
898
899 .space 1ld
900 .nextp
901 .index monitor
902 .index X-windows
903 .index Athena
904 The Exim Monitor program, which is an X-Window application, includes
905 modified versions of the Athena StripChart and TextPop widgets.
906 This code is copyright by DEC and MIT, and their permission notice appears
907 below, in accordance with the conditions expressed therein.
908
909 .rule
910 .push
911 .if ~~sgcal
912 .fontgroup 9
913 .font 0
914 .fi
915 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
916 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
917 .blank
918 $c All Rights Reserved
919 .blank
920 Permission to use, copy, modify, and distribute this software and its
921 documentation for any purpose and without fee is hereby granted,
922 provided that the above copyright notice appear in all copies and that
923 both that copyright notice and this permission notice appear in
924 supporting documentation, and that the names of Digital or MIT not be
925 used in advertising or publicity pertaining to distribution of the
926 software without specific, written prior permission.
927
928 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
929 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
930 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
931 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
932 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
933 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
934 SOFTWARE.
935 .newline
936 .pop
937 .rule
938 .space 1ld
939 .nextp
940 .em
941 Many people have contributed code fragments, some large, some small, that were
942 not covered by any specific licence requirements. It is assumed that the
943 contributors are happy to see their code incoporated into Exim under the GPL.
944 .nem
945 .endp
946
947
948
949 .
950 .
951 .
952 .
953 . ============================================================================
954 .chapter How Exim receives and delivers mail
955 .set runningfoot "receiving & delivering mail"
956
957 .section Overall philosophy
958 .index design philosophy
959 Exim is designed to work efficiently on systems that are permanently connected
960 to the Internet and are handling a general mix of mail. In such circumstances,
961 most messages can be delivered immediately. Consequently, Exim does not
962 maintain independent queues of messages for specific domains or hosts, though
963 it does try to send several messages in a single SMTP connection after a host
964 has been down, and it also maintains per-host retry information.
965
966
967 .section Policy control
968 .index policy control||overview
969 Policy controls are now an important feature of MTAs that are connected to the
970 Internet. Perhaps their most important job is to stop MTAs being abused as
971 `open relays' by misguided individuals who send out vast amounts of unsolicited
972 junk, and want to disguise its source. Exim provides flexible facilities for
973 specifying policy controls on incoming mail:
974 .numberpars $.
975 .index ~~ACL||introduction
976 Exim 4 (unlike previous versions of Exim) implements policy controls on
977 incoming mail by means of \*Access Control Lists*\ (ACLs). Each list is a
978 series of statements that may either grant or deny access. ACLs can be used at
979 several places in the SMTP dialogue while receiving a message from a remote 
980 host. However, the most common places are after each \\RCPT\\ command, and at
981 the very end of the message. The sysadmin can specify conditions for accepting
982 or rejecting individual recipients or the entire message, respectively, at
983 these two points (see chapter ~~CHAPACL). Denial of access results in an SMTP
984 error code.
985 .nextp
986 An ACL is also available for locally generated, non-SMTP messages. In this
987 case, the only available actions are to accept or deny the entire message.
988 .nextp
989 .em
990 When Exim is compiled with the content-scanning extension, facilities are 
991 provided in the ACL mechanism for passing the message to external virus and/or 
992 spam scanning software. The result of such a scan is passed back to the ACL,
993 which can then use it to decide what to do with the message.
994 .nem
995 .nextp
996 When a message has been received, either from a remote host or from the local
997 host, but before the final acknowledgement has been sent, a locally supplied C
998 function called \*local@_scan()*\ can be run to inspect the message and decide
999 whether to accept it or not (see chapter ~~CHAPlocalscan). If the message is
1000 accepted, the list of recipients can be modified by the function.
1001 .nextp
1002 .em
1003 Using the \*local@_scan()*\ mechanism is another way of calling external
1004 scanner software. The \SA-Exim\ add-on package works this way. It does not 
1005 require Exim to be compiled with the content-scanning extension.
1006 .nem
1007 .nextp
1008 After a message has been accepted, a further checking mechanism is available in
1009 the form of the $it{system filter} (see chapter ~~CHAPsystemfilter). This runs
1010 at the start of every delivery process.
1011 .endp
1012
1013 .section User filters
1014 .index filter||introduction
1015 .index Sieve filter
1016 In a conventional Exim configuration, users are able to run private filters by
1017 setting up appropriate \(.forward)\ files in their home directories. See
1018 chapter ~~CHAPredirect (about the \%redirect%\ router) for the configuration
1019 needed to support this, and the separate document entitled
1020 .if ~~html
1021 [(A HREF="filter_toc.html")]
1022 .fi
1023 \*Exim's interfaces to mail filtering*\
1024 .if ~~html
1025 [(/A)]
1026 .fi
1027 for user details. Two different kinds of filtering are available:
1028 .numberpars $.
1029 Sieve filters are written in the standard filtering language that is defined by
1030 RFC 3028.
1031 .nextp
1032 Exim filters are written in a syntax that is unique to Exim, but which is more
1033 powerful than Sieve, which it pre-dates.
1034 .endp
1035 User filters are run as part of the routing process, described below.
1036
1037
1038 .section Message identification
1039 .rset SECTmessiden "~~chapter.~~section"
1040 .index message||ids, details of format
1041 .index format||of message id
1042 .index id of message
1043 .index base62
1044 .index base36
1045 .index Darwin
1046 .index Cygwin
1047 Every message handled by Exim is given a \*message id*\ which is sixteen
1048 characters long. It is divided into three parts, separated by hyphens, for
1049 example \"16VDhn-0001bo-D3"\. Each part is a sequence of letters and digits,
1050 normally encoding numbers in base 62. However, in the Darwin operating
1051 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
1052 (avoiding the use of lower case letters) is used instead, because the message
1053 id is used to construct file names, and the names of files in those systems are
1054 not case-sensitive.
1055
1056 .index pid (process id)||re-use of
1057 The detail of the contents of the message id have changed as Exim has evolved.
1058 Earlier versions relied on the operating system not re-using a process id (pid)
1059 within one second. On modern operating systems, this assumption can no longer
1060 be made, so the algorithm had to be changed. To retain backward compatibility,
1061 the format of the message id was retained, which is why the following rules are
1062 somewhat eccentric:
1063 .numberpars $.
1064 The first six characters of the message id are the time at which the message
1065 started to be received, to a granularity of one second. That is, this field
1066 contains the number of seconds since the start of the epoch (the normal Unix
1067 way of representing the date and time of day).
1068 .nextp
1069 After the first hyphen, the next six characters are the id of the process that
1070 received the message.
1071 .nextp
1072 There are two different possibilities for the final two characters:
1073 .numberpars alpha
1074 .index \localhost@_number\
1075 If \localhost@_number\ is not set, this value is the fractional part of the
1076 time of reception, normally in units of 1/2000 of a second, but for systems
1077 that must use base 36 instead of base 62 (because of case-insensitive file
1078 systems), the units are 1/1000 of a second.
1079 .nextp
1080 If \localhost@_number\ is set, it is multiplied by 200 (100) and added to
1081 the fractional part of the time, which in this case is in units of 1/200
1082 (1/100) of a second.
1083 .endp
1084 .endp
1085 After a message has been received, Exim waits for the clock to tick at the
1086 appropriate resolution before proceeding, so that if another message is
1087 received by the same process, or by another process with the same (re-used)
1088 pid, it is guaranteed that the time will be different. In most cases, the clock
1089 will already have ticked while the message was being received.
1090
1091 .section Receiving mail
1092 .index receiving mail
1093 .index message||reception
1094 The only way Exim can receive mail from a remote host is using SMTP over
1095 TCP/IP, in which case the sender and recipient addresses are tranferred using
1096 SMTP commands. However, from a locally running process (such as a user's MUA),
1097 there are several possibilities:
1098 .numberpars $.
1099 If the process runs Exim with the \-bm-\ option, the message is read
1100 non-interactively (usually via a pipe), with the recipients taken from the
1101 command line, or from the body of the message if \-t-\ is also used.
1102 .nextp
1103 If the process runs Exim with the \-bS-\ option, the message is also read
1104 non-interactively, but in this case the recipients are listed at the start of
1105 the message in a series of SMTP \\RCPT\\ commands, terminated by a \\DATA\\
1106 command. This is so-called `batch SMTP' format,
1107 but it isn't really SMTP. The SMTP commands are just another way of passing
1108 envelope addresses in a non-interactive submission.
1109 .nextp
1110 If the process runs Exim with the \-bs-\ option, the message is read
1111 interactively, using the SMTP protocol. A two-way pipe is normally used for
1112 passing data between the local process and the Exim process.
1113 This is `real' SMTP and is handled in the same way as SMTP over TCP/IP. For
1114 example, the ACLs for SMTP commands are used for this form of submission.
1115 .nextp
1116 A local process may also make a TCP/IP call to the host's loopback address
1117 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1118 does not treat the loopback address specially. It treats all such connections
1119 in the same way as connections from other hosts.
1120 .endp
1121
1122 .index message||sender, constructed by Exim
1123 .index sender||constructed by Exim
1124 In the three cases that do not involve TCP/IP, the sender address is
1125 constructed from the login name of the user that called Exim and a default
1126 qualification domain (which can be set by the \qualify@_domain\ configuration
1127 option). For local or batch SMTP, a sender address that is passed using the
1128 SMTP \\MAIL\\ command is ignored. However, the system administrator may allow
1129 certain users (`trusted users') to specify a different sender address
1130 unconditionally, or all users to specify certain forms of different sender
1131 address. The \-f-\ option or the SMTP \\MAIL\\ command is used to specify these
1132 different addresses. See section ~~SECTtrustedadmin for details of trusted
1133 users, and the \untrusted@_set@_sender\ option for a way of allowing untrusted
1134 users to change sender addresses.
1135
1136 Messages received by either of the non-interactive mechanisms are subject to
1137 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1138 (either over TCP/IP, or interacting with a local process) can be checked by a
1139 number of ACLs that operate at different times during the SMTP session. Either
1140 individual recipients, or the entire message, can be rejected if local policy
1141 requirements are not met. The \*local@_scan()*\ function (see chapter
1142 ~~CHAPlocalscan) is run for all incoming messages.
1143
1144 Exim can be configured not to start a delivery process when a message is
1145 received; this can be unconditional, or depend on the number of incoming SMTP
1146 connections or the system load. In these situations, new messages wait on the
1147 queue until a queue runner process picks them up. However, in standard
1148 configurations under normal conditions, delivery is started as soon as a
1149 message is received.
1150
1151
1152
1153
1154 .section Handling an incoming message
1155 .index spool directory||files that hold a message
1156 .index file||how a message is held
1157 When Exim accepts a message, it writes two files in its spool directory. The
1158 first contains the envelope information, the current status of the message,
1159 and the header lines, and the second contains the body of the message. The
1160 names of the two spool files consist of the message id, followed by $tt{-H} for
1161 the file containing the envelope and header, and $tt{-D} for the data file.
1162
1163 .index spool directory||\(input)\ sub-directory
1164 By default all these message files are held in a single directory called
1165 \(input)\ inside the general Exim spool directory. Some operating systems do
1166 not perform very well if the number of files in a directory gets very large; to
1167 improve performance in such cases, the \split@_spool@_directory\ option can be
1168 used. This causes Exim to split up the input files into 62 sub-directories
1169 whose names are single letters or digits.
1170
1171 The envelope information consists of the address of the message's sender and
1172 the addresses of the recipients. This information is entirely separate from
1173 any addresses contained in the header lines. The status of the message includes
1174 a list of recipients who have already received the message. The format of the
1175 first spool file is described in chapter ~~CHAPspool.
1176
1177 .index rewriting||addresses
1178 Address rewriting that is specified in the rewrite section of the configuration
1179 (see chapter ~~CHAPrewrite) is done once and for all on incoming addresses,
1180 both in the header lines and the envelope, at the time the message is accepted.
1181 If during the course of delivery additional addresses are generated (for
1182 example, via aliasing), these new addresses are rewritten as soon as they are
1183 generated. At the time a message is actually delivered (transported) further
1184 rewriting can take place; because this is a transport option, it can be
1185 different for different forms of delivery. It is also possible to specify the
1186 addition or removal of certain header lines at the time the message is
1187 delivered (see chapters ~~CHAProutergeneric and ~~CHAPtransportgeneric).
1188
1189
1190 .section Life of a message
1191 .index message||life of
1192 .index message||frozen
1193 A message remains in the spool directory until it is completely delivered to
1194 its recipients or to an error address, or until it is deleted by an
1195 administrator or by the user who originally created it. In cases when delivery
1196 cannot proceed -- for example, when a message can neither be delivered to its
1197 recipients nor returned to its sender, the message is marked `frozen' on the
1198 spool, and no more deliveries are attempted.
1199
1200 .index frozen messages||thawing
1201 .index message||thawing frozen
1202 An administrator can `thaw' such messages when the problem has been corrected,
1203 and can also freeze individual messages by hand if necessary. In addition, an
1204 administrator can force a delivery error, causing a bounce message to be sent.
1205
1206 .index \auto@_thaw\
1207 There is an option called \auto@_thaw\, which can be used to cause Exim to
1208 retry frozen messages after a certain time. When this is set, no message will
1209 remain on the queue for ever, because the delivery timeout will eventually be
1210 reached. Delivery failure reports (bounce messages) that reach this timeout are
1211 discarded.
1212 .index \timeout@_frozen@_after\
1213 There is also an option called \timeout@_frozen@_after\, which discards frozen
1214 messages after a certain time.
1215
1216 .index message||log file for
1217 .index log||file for each message
1218 While Exim is working on a message, it writes information about each delivery
1219 attempt to the main log file. This includes successful, unsuccessful, and
1220 delayed deliveries for each recipient (see chapter ~~CHAPlog). The log lines
1221 are also written to a separate $it{message log} file for each message. These
1222 logs are solely for the benefit of the administrator, and are normally deleted
1223 along with the spool files when processing of a message is complete.
1224 The use of individual message logs can be disabled by setting
1225 \no@_message@_logs\; this might give an improvement in performance on very
1226 busy systems.
1227
1228 .index journal file
1229 .index file||journal
1230 All the information Exim itself needs to set up a delivery is kept in the first
1231 spool file, along with the header lines. When a successful delivery occurs, the
1232 address is immediately written at the end of a journal file, whose name is the
1233 message id followed by $tt{-J}. At the end of a delivery run, if there are some
1234 addresses left to be tried again later, the first spool file (the $tt{-H} file)
1235 is updated to indicate which these are, and the journal file is then deleted.
1236 Updating the spool file is done by writing a new file and renaming it, to
1237 minimize the possibility of data loss.
1238
1239 Should the system or the program crash after a successful delivery but before
1240 the spool file has been updated, the journal is left lying around. The next
1241 time Exim attempts to deliver the message, it reads the journal file and
1242 updates the spool file before proceeding. This minimizes the chances of double
1243 deliveries caused by crashes.
1244
1245
1246 .section Processing an address for delivery
1247 .rset SECTprocaddress "~~chapter.~~section"
1248 .index drivers||definition of
1249 .index router||definition of
1250 .index transport||definition of
1251 The main delivery processing elements of Exim are called $it{routers} and
1252 $it{transports}, and collectively these are known as $it{drivers}. Code for a
1253 number of them is provided in the source distribution, and compile-time options
1254 specify which ones are included in the binary. Run time options specify which
1255 ones are actually used for delivering messages.
1256
1257 .index drivers||instance definition
1258 Each driver that is specified in the run time configuration is an \*instance*\
1259 of that particular driver type. Multiple instances are allowed; for example,
1260 you can set up several different \%smtp%\ transports, each with different
1261 option values that might specify different ports or different timeouts. Each
1262 instance has its own identifying name. In what follows we will normally use the
1263 instance name when discussing one particular instance (that is, one specific
1264 configuration of the driver), and the generic driver name when discussing
1265 the driver's features in general.
1266
1267 A $it{router} is a driver that operates on an address, either determining how
1268 its delivery should happen, by routing it to a specific transport, or
1269 converting the address into one or more new addresses (for example, via an
1270 alias file). A router may also explicitly choose to fail an address, causing it
1271 to be bounced.
1272
1273 A $it{transport} is a driver that transmits a copy of the message from Exim's
1274 spool to some destination. There are two kinds of transport: for a $it{local}
1275 transport, the destination is a file or a pipe on the local host, whereas for a
1276 $it{remote} transport the destination is some other host. A message is passed
1277 to a specific transport as a result of successful routing. If a message has
1278 several recipients, it may be passed to a number of different transports.
1279
1280 .index preconditions||definition of
1281 An address is processed by passing it to each configured router instance in
1282 turn, subject to certain preconditions, until a router accepts the address or
1283 specifies that it should be bounced. We will describe this process in more
1284 detail shortly. As a simple example, the diagram below illustrates how each
1285 recipient address in a message is processed in a small configuration of three
1286 routers that are configured in various ways.
1287
1288 .if ~~sys.fancy
1289 .figure "Routing an address" rm
1290 .indent 0
1291 .call aspic -sgcal -nv
1292 centre ~~sys.linelength;
1293 magnify 0.8;
1294 boundingbox 30;
1295     ibox depth 14 "address";
1296 B:  arrow down 44;
1297     textdepth 14;
1298 A:  box width 100 "first router" "conditions ok?";
1299     arrow right "yes";
1300 C:  box width 100 "run" "first router";
1301     arrow down "fail";
1302 D:  ibox depth 20 "address bounces";
1303
1304     arc clockwise from right of C "accept";
1305     arrow down 10;
1306     ibox "queue for" "transport";
1307
1308     arrow down from A align bottom of D plus (0,-20) "no"(-6,20)/r;
1309 E:  box width 100 "second router" "conditions ok?";
1310     arrow right "yes";
1311 F:  box width 100 "run" "second router";
1312     line right 100 "redirect";
1313     line up align middle of B;
1314     arrow left to middle of B "new addresses";
1315
1316     line down 20 from bottom left of F plus (30,0);
1317     arrow left align centre of E "decline";
1318
1319     line down 20 from bottom right of F plus (-30,0);
1320     arrow right "fail";
1321     ibox width 64 "address" "bounces";
1322
1323     arrow down 64 from E "no"(-6,20)/r;
1324 G:  box width 100 "third router" "conditions ok?";
1325     arrow right "yes";
1326 H:  box width 100 "run" "third router";
1327     arc clockwise from right of H "accept";
1328     arrow down 10;
1329     ibox "queue for" "transport";
1330
1331     line down 20 from bottom of H;
1332     arrow left align centre of G "decline";
1333     arrow down 64 from G "no"(-6,20)/r;
1334
1335     ibox "no more routers" "address bounces";
1336 .endcall
1337 .endfigure
1338 .elif !~~html
1339 .display asis
1340
1341        address
1342           |
1343           |<------------- new addresses -----------------------------
1344           V                                                         |
1345   -----------------                -----------------                |
1346   | first router  |----- yes ----->|     run       |--- accept      |
1347   | conditions ok?|                | first router  |      |         |
1348   -----------------                -----------------      |         |
1349           |                                |              V         |
1350        no |                           fail |          queue for     |
1351           |                                V          transport     |
1352           |                         address bounces                 |
1353           |                                                         |
1354           V                                                         |
1355   -----------------                -----------------                |
1356   | second router |----- yes ----->|     run       |----redirect ----
1357   | conditions ok?|                | second router |
1358   -----------------                -----------------
1359           |                            |       |
1360        no |                            |       |
1361           |<-------- decline -----------       --- fail ---> address
1362           |                                                  bounces
1363           V
1364   -----------------                -----------------
1365   | third router  |----- yes ----->|     run       |--- accept
1366   | conditions ok?|                | third router  |      |
1367   -----------------                -----------------      |
1368           |                                |              V
1369        no |                                |          queue for
1370           |<-------- decline ---------------          transport
1371           |
1372           V
1373    no more routers
1374    address bounces
1375 .endd
1376 .else
1377 [(img src="routing.gif" alt="Routing an address")][(br)]
1378 .fi
1379 To make this a more concrete example, we'll describe it in terms of some actual
1380 routers, but remember, this is only an example. You can configure Exim's
1381 routers in many different ways, and there may be any number of routers in a
1382 configuration.
1383
1384 The first router that is specified in a configuration is often one that handles
1385 addresses in domains that are not recognized specially by the local host. These
1386 are typically addresses for arbitrary domains on the Internet. A precondition
1387 is set up which looks for the special domains known to the host (for example,
1388 its own domain name), and the router is run for addresses that do $it{not}
1389 match. Typically, this is a router that looks up domains in the DNS in order to
1390 find the hosts to which this address routes. If it succeeds, the address is
1391 queued for a suitable SMTP transport; if it does not succeed, the router is
1392 configured to fail the address.
1393
1394 The example pictured could be a configuration of this type. The second and
1395 third routers can only be run for addresses for which the preconditions for
1396 the first router are not met. If one of these preconditions checks the
1397 domain, the second and third routers are run only for domains that are somehow
1398 special to the local host.
1399
1400 The second router does redirection -- also known as aliasing and forwarding.
1401 When it generates one or more new addresses from the original, each of them is
1402 routed independently from the start. Otherwise, the router may cause an address
1403 to fail, or it may simply decline to handle the address, in which case the
1404 address is passed to the next router.
1405
1406 The final router in many configurations is one that checks to see if the
1407 address belongs to a local mailbox. The precondition may involve a check to
1408 see if the local part is the name of a login account, or it may look up the
1409 local part in a file or a database. If its preconditions are not met, or if
1410 the router declines, we have reached the end of the routers. When this happens,
1411 the address is bounced.
1412
1413
1414 .section Processing an address for verification
1415 .index router||for verification
1416 .index verifying||address, overview
1417 As well as being used to decide how to deliver to an address, Exim's routers
1418 are also used for \*address verification*\. Verification can be requested as
1419 one of the checks to be performed in an ACL for incoming messages, on both
1420 sender and recipient addresses, and it can be tested using the \-bv-\ and
1421 \-bvs-\ command line options.
1422
1423 When an address is being verified, the routers are run in `verify mode'. This
1424 does not affect the way the routers work, but it is a state that can be
1425 detected. By this means, a router can be skipped or made to behave differently
1426 when verifying. A common example is a configuration in which the first router
1427 sends all messages to a message-scanning program, unless they have been
1428 previously scanned. Thus, the first router accepts all addresses without any
1429 checking, making it useless for verifying. Normally, the \no@_verify\ option
1430 would be set for such a router, causing it to be skipped in verify mode.
1431
1432
1433
1434 .section Running an individual router
1435 .rset SECTrunindrou "~~chapter.~~section"
1436 .index router||running details
1437 .index preconditions||checking
1438 .index router||result of running
1439 As explained in the example above, a number of preconditions are checked before
1440 running a router. If any are not met, the router is skipped, and the address is
1441 passed to the next router. When all the preconditions on a router $it{are} met,
1442 the router is run. What happens next depends on the outcome, which is one of
1443 the following:
1444 .numberpars $.
1445 \*accept*\: The router accepts the address, and either queues it for a
1446 transport, or generates one or more `child' addresses. Processing the original
1447 address ceases,
1448 .index \unseen\ option
1449 unless the \unseen\ option is set on the router. This option
1450 can be used to set up multiple deliveries with different routing (for example,
1451 for keeping archive copies of messages). When \unseen\ is set, the address is
1452 passed to the next router. Normally, however, an \*accept*\ return marks the
1453 end of routing.
1454
1455 .index case of local parts
1456 .index address||duplicate, discarding
1457 If child addresses are generated, Exim checks to see whether they are
1458 duplicates of any existing recipient addresses. During this check, local parts
1459 are treated as case-sensitive. Duplicate addresses are discarded. Each of the
1460 remaining child addresses is then processed independently, starting with the
1461 first router by default. It is possible to change this by setting the
1462 \redirect@_router\ option to specify which router to start at for child
1463 addresses. Unlike \pass@_router\ (see below) the router specified by
1464 \redirect@_router\ may be anywhere in the router configuration.
1465 .nextp
1466 \*pass*\: The router recognizes the address, but cannot handle it itself. It
1467 requests that the address be passed to another router. By default the address
1468 is passed to the next router, but this can be changed by setting the
1469 \pass@_router\ option. However, (unlike \redirect@_router\) the named router
1470 must be below the current router (to avoid loops).
1471 .nextp
1472 \*decline*\: The router declines to accept the address because it does not
1473 recognize it at all. By default, the address is passed to the next router, but
1474 this can be prevented by setting the \no@_more\ option. When \no@_more\ is set,
1475 all the remaining routers are skipped.
1476 .nextp
1477 \*fail*\: The router determines that the address should fail, and queues it for
1478 the generation of a bounce message. There is no further processing of the
1479 original address unless \unseen\ is set on the router.
1480 .nextp
1481 \*defer*\: The router cannot handle the address at the present time. (A database
1482 may be offline, or a DNS lookup may have timed out.) No further processing of
1483 the address happens in this delivery attempt. It is tried again next time the
1484 message is considered for delivery.
1485 .nextp
1486 \*error*\: There is some error in the router (for example, a syntax error in
1487 its configuration). The action is as for defer.
1488 .endp
1489 If an address reaches the end of the routers without having been accepted by
1490 any of them, it is bounced as unrouteable.
1491 The default error message in this situation is `unrouteable address', but you
1492 can set your own message by making use of the \cannot@_route@_message\ option.
1493 This can be set for any router; the value from the last router that `saw'
1494 the address is used.
1495
1496 Sometimes while routing you want to fail a delivery when some conditions are
1497 met but others are not, instead of passing the address on for further routing.
1498 You can do this by having a second router that explicitly fails the delivery
1499 when the relevant conditions are met. The \%redirect%\ router has a `fail'
1500 facility for this purpose.
1501
1502
1503
1504 .section Router preconditions
1505 .rset SECTrouprecon "~~chapter.~~section"
1506 .index router||preconditions, order of processing
1507 .index preconditions||order of processing
1508 The preconditions that are tested for each router are listed below, in the
1509 order in which they are tested. The individual configuration options are
1510 described in more detail in chapter ~~CHAProutergeneric.
1511 .numberpars $.
1512 The \local@_part@_prefix\ and \local@_part@_suffix\ options can specify that
1513 the local parts handled by the router may or must have certain prefixes and/or
1514 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1515 skipped. These conditions are tested first. When an affix is present, it is
1516 removed from the local part before further processing, including the evaluation
1517 of any other conditions.
1518 .nextp
1519 Routers can be designated for use only when not verifying an address, that is,
1520 only when routing it for delivery (or testing its delivery routing). If the
1521 \verify\ option is set false, the router is skipped when Exim is verifying an
1522 address.
1523 Setting the \verify\ option actually sets two options, \verify@_sender\ and
1524 \verify@_recipient\, which independently control the use of the router for
1525 sender and recipient verification. You can set these options directly if
1526 you want a router to be used for only one type of verification.
1527 .nextp
1528 If the \address@_test\ option is set false, the router is skipped when Exim is
1529 run with the \-bt-\ option to test an address routing. This can be helpful when
1530 the first router sends all new messages to a scanner of some sort; it makes it
1531 possible to use \-bt-\ to test subsequent delivery routing without having to
1532 simulate the effect of the scanner.
1533 .nextp
1534 Routers can be designated for use only when verifying an address, as
1535 opposed to routing it for delivery. The \verify@_only\ option controls this.
1536 .nextp
1537 Certain routers can be explicitly skipped when running the routers to check an
1538 address given in the SMTP \\EXPN\\ command (see the \expn\ option).
1539 .nextp
1540 If the \domains\ option is set, the domain of the address must be in the set of
1541 domains that it defines.
1542 .nextp
1543 If the \local@_parts\ option is set, the local part of the address must be in
1544 the set of local parts that it defines. If \local@_part@_prefix\ or
1545 \local@_part@_suffix\ is in use, the prefix or suffix is removed from the local
1546 part before this check. If you want to do precondition tests on local parts
1547 that include affixes, you can do so by using a \condition\ option (see below)
1548 that uses the variables \$local@_part$\, \$local@_part@_prefix$\, and
1549 \$local@_part@_suffix$\ as necessary.
1550 .nextp
1551 If the \check@_local@_user\ option is set, the local part must be the name of
1552 an account on the local host.
1553 If this check succeeds, the uid and gid of the local user are placed in
1554 \$local@_user@_uid$\ and \$local@_user@_gid$\; these values can be used in the
1555 remaining preconditions.
1556 .nextp
1557 If the \router@_home@_directory\ option is set, it is expanded at this point,
1558 because it overrides the value of \$home$\. If this expansion were left till
1559 later, the value of \$home$\ as set by \check@_local@_user\ would be used in
1560 subsequent tests. Having two different values of \$home$\ in the same router
1561 could lead to confusion.
1562 .nextp
1563 If the \senders\ option is set, the envelope sender address must be in the set
1564 of addresses that it defines.
1565 .nextp
1566 If the \require@_files\ option is set, the existence or non-existence of
1567 specified files is tested.
1568 .nextp
1569 .index customizing||precondition
1570 If the \condition\ option is set, it is evaluated and tested. This option uses
1571 an expanded string to allow you to set up your own custom preconditions.
1572 Expanded strings are described in chapter ~~CHAPexpand.
1573 .endp
1574
1575 Note that \require@_files\ comes near the end of the list, so you cannot use it
1576 to check for the existence of a file in which to lookup up a domain, local
1577 part, or sender. However, as these options are all expanded, you can use the
1578 \exists\ expansion condition to make such tests within each condition. The
1579 \require@_files\ option is intended for checking files that the router may be
1580 going to use internally, or which are needed by a specific transport (for
1581 example, \(.procmailrc)\).
1582
1583
1584 .section Delivery in detail
1585 .index delivery||in detail
1586 When a message is to be delivered, the sequence of events is as follows:
1587 .numberpars $.
1588 If a system-wide filter file is specified, the message is passed to it. The
1589 filter may add recipients to the message, replace the recipients, discard the
1590 message, cause a new message to be generated, or cause the message delivery to
1591 fail. The format of the system filter file is the same as for Exim user filter
1592 files, described in the separate document entitled
1593 .if ~~html
1594 [(A HREF="filter.html")]
1595 .fi
1596 \*Exim's interfaces to mail filtering*\.
1597 .if ~~html
1598 [(/A)]
1599 .fi
1600 .index Sieve filter||not available for system filter
1601 (\**Note**\: Sieve cannot be used for system filter files.)
1602 Some additional features are available in system filters -- see chapter
1603 ~~CHAPsystemfilter for details. Note that a message is passed to the system
1604 filter only once per delivery attempt, however many recipients it has. However,
1605 if there are several delivery attempts because one or more addresses could not
1606 be immediately delivered, the system filter is run each time. The filter
1607 condition \first@_delivery\ can be used to detect the first run of the system
1608 filter.
1609 .nextp
1610 Each recipient address is offered to each configured router in turn, subject to
1611 its preconditions, until one is able to handle it. If no router can handle
1612 the address, that is, if they all decline, the address is failed. Because
1613 routers can be targeted at particular domains, several locally handled domains
1614 can be processed entirely independently of each other.
1615 .nextp
1616 .index routing||loops in
1617 .index loop||while routing
1618 A router that accepts an address may set up a local or a remote transport for
1619 it. However, the transport is not run at this time. Instead, the address is
1620 placed on a list for the particular transport, to be run later. Alternatively,
1621 the router may generate one or more new addresses (typically from alias,
1622 forward, or filter files). New addresses are fed back into this process from
1623 the top, but in order to avoid loops, a router ignores any address which has an
1624 identically-named ancestor that was processed by itself.
1625 .nextp
1626 When all the routing has been done, addresses that have been successfully
1627 handled are passed to their assigned transports. When local transports are
1628 doing real local deliveries, they handle only one address at a time, but if a
1629 local transport is being used as a pseudo-remote transport (for example, to
1630 collect batched SMTP messages for transmission by some other means) multiple
1631 addresses can be handled. Remote transports can always handle more than one
1632 address at a time, but can be configured not to do so, or to restrict multiple
1633 addresses to the same domain.
1634 .nextp
1635 Each local delivery to a file or a pipe runs in a separate process under a
1636 non-privileged uid, and these deliveries are run one at a time. Remote
1637 deliveries also run in separate processes, normally under a uid that is private
1638 to Exim (`the Exim user'), but in this case, several remote deliveries can be
1639 run in parallel. The maximum number of simultaneous remote deliveries for any
1640 one message is set by the \remote@_max@_parallel\ option.
1641 The order in which deliveries are done is not defined, except that all local
1642 deliveries happen before any remote deliveries.
1643 .nextp
1644 .index queue runner
1645 When it encounters a local delivery during a queue run, Exim checks its retry
1646 database to see if there has been a previous temporary delivery failure for the
1647 address before running the local transport. If there was a previous failure,
1648 Exim does not attempt a new delivery until the retry time for the address is
1649 reached. However, this happens only for delivery attempts that are part of a
1650 queue run. Local deliveries are always attempted when delivery immediately
1651 follows message reception, even if retry times are set for them. This makes for
1652 better behaviour if one particular message is causing problems (for example,
1653 causing quota overflow, or provoking an error in a filter file).
1654 .nextp
1655 .index delivery||retry in remote transports
1656 Remote transports do their own retry handling, since an address may be
1657 deliverable to one of a number of hosts, each of which may have a different
1658 retry time. If there have been previous temporary failures and no host has
1659 reached its retry time, no delivery is attempted, whether in a queue run or
1660 not. See chapter ~~CHAPretry for details of retry strategies.
1661 .nextp
1662 If there were any permanent errors, a bounce message is returned to an
1663 appropriate address (the sender in the common case), with details of the error
1664 for each failing address. Exim can be configured to send copies of bounce
1665 messages to other addresses.
1666 .nextp
1667 .index delivery||deferral
1668 If one or more addresses suffered a temporary failure, the message is left on
1669 the queue, to be tried again later. Delivery of these addresses is said to be
1670 \*deferred*\.
1671 .nextp
1672 When all the recipient addresses have either been delivered or bounced,
1673 handling of the message is complete. The spool files and message log are
1674 deleted, though the message log can optionally be preserved if required.
1675 .endp
1676
1677
1678 .section Retry mechanism
1679 .index delivery||retry mechanism
1680 .index retry||description of mechanism
1681 .index queue runner
1682 Exim's mechanism for retrying messages that fail to get delivered at the first
1683 attempt is the queue runner process. You must either run an Exim daemon that
1684 uses the \-q-\ option with a time interval to start queue runners at regular
1685 intervals, or use some other means (such as \*cron*\) to start them. If you do
1686 not arrange for queue runners to be run, messages that fail temporarily at the
1687 first attempt will remain on your queue for ever. A queue runner process works
1688 it way through the queue, one message at a time, trying each delivery that has
1689 passed its retry time.
1690 You can run several queue runners at once.
1691
1692 Exim uses a set of configured rules to determine when next to retry the failing
1693 address (see chapter ~~CHAPretry). These rules also specify when Exim should
1694 give up trying to deliver to the address, at which point it generates a bounce
1695 message. If no retry rules are set for a particular host, address, and error
1696 combination, no retries are attempted, and temporary errors are treated as
1697 permanent.
1698
1699
1700 .section Temporary delivery failure
1701 .index delivery||temporary failure
1702 There are many reasons why a message may not be immediately deliverable to a
1703 particular address. Failure to connect to a remote machine (because it, or the
1704 connection to it, is down) is one of the most common. Temporary failures may be
1705 detected during routing as well as during the transport stage of delivery.
1706 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1707 is on a file system where the user is over quota. Exim can be configured to
1708 impose its own quotas on local mailboxes; where system quotas are set they will
1709 also apply.
1710
1711 If a host is unreachable for a period of time, a number of messages may be
1712 waiting for it by the time it recovers, and sending them in a single SMTP
1713 connection is clearly beneficial. Whenever a delivery to a remote host is
1714 deferred,
1715 .index hints database
1716 Exim makes a note in its hints database, and whenever a successful
1717 SMTP delivery has happened, it looks to see if any other messages are waiting
1718 for the same host. If any are found, they are sent over the same SMTP
1719 connection, subject to a configuration limit as to the maximum number in any
1720 one connection.
1721
1722
1723
1724 .section Permanent delivery failure
1725 .index delivery||permanent failure
1726 .index bounce message||when generated
1727 When a message cannot be delivered to some or all of its intended recipients, a
1728 bounce message is generated. Temporary delivery failures turn into permanent
1729 errors when their timeout expires. All the addresses that fail in a given
1730 delivery attempt are listed in a single message. If the original message has
1731 many recipients, it is possible for some addresses to fail in one delivery
1732 attempt and others to fail subsequently, giving rise to more than one bounce
1733 message. The wording of bounce messages can be customized by the administrator.
1734 See chapter ~~CHAPemsgcust for details.
1735
1736 .index ::X-Failed-Recipients:: header line
1737 Bounce messages contain an ::X-Failed-Recipients:: header line that lists the
1738 failed addresses, for the benefit of programs that try to analyse such messages
1739 automatically.
1740
1741 .index bounce message||recipient of
1742 A bounce message is normally sent to the sender of the original message, as
1743 obtained from the message's envelope. For incoming SMTP messages, this is the
1744 address given in the \\MAIL\\ command. However, when an address is
1745 expanded via a forward or alias file, an alternative address can be specified
1746 for delivery failures of the generated addresses. For a mailing list expansion
1747 (see section ~~SECTmailinglists) it is common to direct bounce messages to the
1748 manager of the list.
1749
1750
1751
1752 .section Failures to deliver bounce messages
1753 .index bounce message||failure to deliver
1754 If a bounce message (either locally generated or received from a remote host)
1755 itself suffers a permanent delivery failure, the message is left on the queue,
1756 but it is frozen, awaiting the attention of an administrator. There are options
1757 which can be used to make Exim discard such failed messages, or to keep them
1758 for only a short time (see \timeout@_frozen@_after\ and
1759 \ignore@_bounce@_errors@_after\).
1760
1761
1762
1763 .
1764 .
1765 .
1766 .
1767 . ============================================================================
1768 .chapter Building and installing Exim
1769 .set runningfoot "building/installing"
1770
1771 .index building Exim
1772 .section Unpacking
1773 Exim is distributed as a gzipped or bzipped tar file which, when upacked,
1774 creates a directory with the name of the current release (for example,
1775 \(exim-~~version)\) into which the following files are placed:
1776 .display rm
1777 .if !~~sys.fancy && ~~sgcal
1778 .tabs 16
1779 .else
1780 .tabs 22
1781 .fi
1782 \(ACKNOWLEDGMENTS)\ $t contains some acknowledgments
1783 .newline
1784 \(CHANGES)\      $t contains a reference to where changes are documented
1785 \(LICENCE)\      $t the GNU General Public Licence
1786 \(Makefile)\     $t top-level make file
1787 \(NOTICE)\       $t conditions for the use of Exim
1788 \(README)\       $t list of files, directories and simple build instructions
1789 .endd
1790 Other files whose names begin with \(README)\ may also be present. The
1791 following subdirectories are created:
1792 .display rm
1793 .if !~~sys.fancy && ~~sgcal
1794 .tabs 16
1795 .else
1796 .tabs 22
1797 .fi
1798 \(Local)\        $t an empty directory for local configuration files
1799 \(OS)\           $t OS-specific files
1800 \(doc)\          $t documentation files
1801 \(exim@_monitor)\$t source files for the Exim monitor
1802 \(scripts)\      $t scripts used in the build process
1803 \(src)\          $t remaining source files
1804 \(util)\         $t independent utilities
1805 .endd
1806 The main utility programs are contained in the \(src)\ directory, and are built
1807 with the Exim binary. The \(util)\ directory contains a few optional scripts
1808 that may be useful to some sites.
1809
1810 .section Multiple machine architectures and operating systems
1811 .index building Exim||multiple OS/architectures
1812 The building process for Exim is arranged to make it easy to build binaries for
1813 a number of different architectures and operating systems from the same set of
1814 source files. Compilation does not take place in the \(src)\ directory. Instead,
1815 a \*build directory*\ is created for each architecture and operating system.
1816 .index symbolic link||to build directory
1817 Symbolic links to the sources are installed in this directory, which is where
1818 the actual building takes place.
1819
1820 In most cases, Exim can discover the machine architecture and operating system
1821 for itself, but the defaults can be overridden if necessary.
1822
1823 .section DBM libraries
1824 .rset SECTdb "~~chapter.~~section"
1825 .index DBM||libraries, discussion of
1826 .index hints database||DBM files used for
1827 Even if you do not use any DBM files in your configuration, Exim still needs a
1828 DBM library in order to operate, because it uses indexed files for its hints
1829 databases. Unfortunately, there are a number of DBM libraries in existence, and
1830 different operating systems often have different ones installed.
1831
1832 .index Solaris||DBM library for
1833 .index IRIX, DBM library for
1834 .index BSD, DBM library for
1835 .index Linux, DBM library for
1836 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1837 Linux distribution, the DBM configuration should happen automatically, and you
1838 may be able to ignore this section. Otherwise, you may have to learn more than
1839 you would like about DBM libraries from what follows.
1840
1841 .index \*ndbm*\ DBM library
1842 Licensed versions of Unix normally contain a library of DBM functions operating
1843 via the \*ndbm*\ interface, and this is what Exim expects by default. Free
1844 versions of Unix seem to vary in what they contain as standard. In particular,
1845 some early versions of Linux have no default DBM library, and different
1846 distributors have chosen to bundle different libraries with their packaged
1847 versions. However, the more recent releases seem to have standardised on the
1848 Berkeley DB library.
1849
1850 Different DBM libraries have different conventions for naming the files they
1851 use. When a program opens a file called \(dbmfile)\, there are four
1852 possibilities:
1853 .numberpars
1854 A traditional \*ndbm*\ implementation, such as that supplied as part of
1855 Solaris, operates on two files called \(dbmfile.dir)\ and \(dbmfile.pag)\.
1856 .nextp
1857 .index \*gdbm*\ DBM library
1858 The GNU library, \*gdbm*\, operates on a single file. If used via its \*ndbm*\
1859 compatibility interface it makes two different hard links to it with names
1860 \(dbmfile.dir)\ and \(dbmfile.pag)\, but if used via its native interface, the
1861 file name is used unmodified.
1862 .nextp
1863 .index Berkeley DB library
1864 The Berkeley DB package, if called via its \*ndbm*\ compatibility interface,
1865 operates on a single file called \(dbmfile.db)\, but otherwise looks to the
1866 programmer exactly the same as the traditional \*ndbm*\ implementation.
1867 .nextp
1868 If the Berkeley package is used in its native mode, it operates on a single
1869 file called \(dbmfile)\; the programmer's interface is somewhat different to
1870 the traditional \*ndbm*\ interface.
1871 .nextp
1872 To complicate things further, there are several very different versions of the
1873 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1874 2.$it{x} and 3.$it{x} were current for a while, but the latest versions are now
1875 numbered 4.$it{x}. Maintenance of some of the earlier releases has ceased. All
1876 versions of Berkeley DB can be obtained from
1877 .display rm
1878 \?http://www.sleepycat.com/?\
1879 .endd
1880 .nextp
1881 .index \*tdb*\ DBM library
1882 Yet another DBM library, called \*tdb*\, has become available from
1883 .display rm
1884 \?http://download.sourceforge.net/tdb?\
1885 .endd
1886 It has its own interface, and also operates on a single file.
1887 .endp
1888 .index \\USE@_DB\\
1889 .index DBM||libraries, configuration for building
1890 Exim and its utilities can be compiled to use any of these interfaces. In order
1891 to use any version of the Berkeley DB package in native mode, you must set
1892 \\USE@_DB\\ in an appropriate configuration file (typically
1893 \(Local/Makefile)\). For example:
1894 .display asis
1895 USE_DB=yes
1896 .endd
1897 Similarly, for gdbm you set \\USE@_GDBM\\, and for tdb you set \\USE@_TDB\\. An
1898 error is diagnosed if you set more than one of these.
1899
1900 At the lowest level, the build-time configuration sets none of these options,
1901 thereby assuming an interface of type (1). However, some operating system
1902 configuration files (for example, those for the BSD operating systems and
1903 Linux) assume type (4) by setting \\USE@_DB\\ as their default, and the
1904 configuration files for Cygwin set \\USE@_GDBM\\. Anything you set in
1905 \(Local/Makefile)\, however, overrides these system defaults.
1906
1907 As well as setting \\USE@_DB\\, \\USE@_GDBM\\, or \\USE@_TDB\\, it may also be
1908 necessary to set \\DBMLIB\\, to cause inclusion of the appropriate library, as
1909 in one of these lines:
1910 .display asis
1911 DBMLIB = -ldb
1912 DBMLIB = -ltdb
1913 .endd
1914 Settings like that will work if the DBM library is installed in the standard
1915 place. Sometimes it is not, and the library's header file may also not be in
1916 the default path. You may need to set \\INCLUDE\\ to specify where the header
1917 file is, and to specify the path to the library more fully in \\DBMLIB\\, as in
1918 this example:
1919 .display asis
1920 INCLUDE=-I/usr/local/include/db-4.1
1921 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1922 .endd
1923
1924 There is further detailed discussion about the various DBM libraries in the
1925 file \(doc/dbm.discuss.txt)\ in the Exim distribution.
1926
1927
1928 .section Pre-building configuration
1929 .index building Exim||pre-building configuration
1930 .index configuration for building Exim
1931 .index \(Local/Makefile)\
1932 .index \(src/EDITME)\
1933 Before building Exim, a local configuration file that specifies options
1934 independent of any operating system has to be created with the name
1935 \(Local/Makefile)\. A template for this file is supplied as the file
1936 \(src/EDITME)\, and it contains full descriptions of all the option settings
1937 therein. These descriptions are therefore not repeated here. If you are
1938 building Exim for the first time, the simplest thing to do is to copy
1939 \(src/EDITME)\ to \(Local/Makefile)\, then read it and edit it appropriately.
1940
1941 There are three settings that you must supply, because Exim will not build
1942 without them. They are the location of the run time configuration file
1943 (\\CONFIGURE@_FILE\\), the directory in which Exim binaries will be installed
1944 (\\BIN@_DIRECTORY\\), and the identity of the Exim user (\\EXIM@_USER\\ and
1945 maybe \\EXIM@_GROUP\\ as well). The value of \\CONFIGURE@_FILE\\ can in fact be
1946 a colon-separated list of file names; Exim uses the first of them that exists.
1947
1948 There are a few other parameters that can be specified either at build time or
1949 at run time, to enable the same binary to be used on a number of different
1950 machines. However, if the locations of Exim's spool directory and log file
1951 directory (if not within the spool directory) are fixed, it is recommended that
1952 you specify them in \(Local/Makefile)\ instead of at run time, so that errors
1953 detected early in Exim's execution (such as a malformed configuration file) can
1954 be logged.
1955
1956 .index content scanning||specifying at build time
1957 .em
1958 Exim's interfaces for calling virus and spam scanning sofware directly from 
1959 access control lists are not compiled by default. If you want to include these 
1960 facilities, you need to set
1961 .display asis
1962 WITH_CONTENT_SCAN=yes
1963 .endd
1964 in your \(Local/Makefile)\. For details of the facilities themselves, see 
1965 chapter ~~CHAPexiscan.
1966 .nem
1967
1968 .index \(Local/eximon.conf)\
1969 .index \(exim@_monitor/EDITME)\
1970 If you are going to build the Exim monitor, a similar configuration process is
1971 required. The file \(exim@_monitor/EDITME)\ must be edited appropriately for
1972 your installation and saved under the name \(Local/eximon.conf)\. If you are
1973 happy with the default settings described in \(exim@_monitor/EDITME)\,
1974 \(Local/eximon.conf)\ can be empty, but it must exist.
1975
1976 This is all the configuration that is needed in straightforward cases for known
1977 operating systems. However, the building process is set up so that it is easy
1978 to override options that are set by default or by operating-system-specific
1979 configuration files, for example to change the name of the C compiler, which
1980 defaults to \gcc\. See section ~~SECToverride below for details of how to do
1981 this.
1982
1983
1984 .section Support for iconv()
1985 .index \*iconv()*\ support
1986 The contents of header lines in messages may be encoded according to the rules
1987 described RFC 2047. This makes it possible to transmit characters that are not
1988 in the ASCII character set, and to label them as being in a particular
1989 character set. When Exim is inspecting header lines by means of the \@$h@_\
1990 mechanism, it decodes them, and translates them into a specified character set
1991 (default ISO-8859-1). The translation is possible only if the operating system
1992 supports the \*iconv()*\ function.
1993
1994 However, some of the operating systems that supply \*iconv()*\ do not support
1995 very many conversions. The GNU \libiconv\ library (available from
1996 \?http:/@/www.gnu.org/software/libiconv/?\) can be installed on such systems to
1997 remedy this deficiency, as well as on systems that do not supply \*iconv()*\ at
1998 all. After installing \libiconv\, you should add
1999 .display asis
2000 HAVE_ICONV=yes
2001 .endd
2002 to your \(Local/Makefile)\ and rebuild Exim.
2003
2004
2005 .section Including TLS/SSL encryption support
2006 .rset SECTinctlsssl "~~chapter.~~section"
2007 .index TLS||including support for TLS
2008 .index encryption||including support for
2009 .index \\SUPPORT@_TLS\\
2010 .index OpenSSL||building Exim with
2011 .index GnuTLS||building Exim with
2012 Exim can be built to support encrypted SMTP connections, using the \\STARTTLS\\
2013 command as per RFC 2487. It can also support legacy clients that expect to
2014 start a TLS session immediately on connection to a non-standard port (see the
2015 \tls@_on@_connect@_ports\ runtime option and the \-tls-on-connect-\ command
2016 line option).
2017
2018 If you want to build Exim with TLS support, you must first install either the
2019 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
2020 implementing SSL.
2021
2022 If OpenSSL is installed, you should set
2023 .display asis
2024 SUPPORT_TLS=yes
2025 TLS_LIBS=-lssl -lcrypto
2026 .endd
2027 in \(Local/Makefile)\. You may also need to specify the locations of the
2028 OpenSSL library and include files. For example:
2029 .display asis
2030 SUPPORT_TLS=yes
2031 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
2032 TLS_INCLUDE=-I/usr/local/openssl/include/
2033 .endd
2034
2035 If GnuTLS is installed, you should set
2036 .index \\USE@_GNUTLS\\
2037 .display asis
2038 SUPPORT_TLS=yes
2039 USE_GNUTLS=yes
2040 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
2041 .endd
2042 in \(Local/Makefile)\, and again you may need to specify the locations of the
2043 library and include files. For example:
2044 .display asis
2045 SUPPORT_TLS=yes
2046 USE_GNUTLS=yes
2047 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
2048 TLS_INCLUDE=-I/usr/gnu/include
2049 .endd
2050 You do not need to set \\TLS@_INCLUDE\\ if the relevant directory is already
2051 specified in \\INCLUDE\\. Details of how to configure Exim to make use of TLS
2052 are given in chapter ~~CHAPTLS.
2053
2054
2055
2056 .section Use of tcpwrappers
2057 .index tcpwrappers, building Exim to support
2058 .index \\USE@_TCP@_WRAPPERS\\
2059 Exim can be linked with the \*tcpwrappers*\ library in order to check incoming
2060 SMTP calls using the \*tcpwrappers*\ control files. This may be a convenient
2061 alternative to Exim's own checking facilities for installations that are
2062 already making use of \*tcpwrappers*\ for other purposes. To do this, you should
2063 set \\USE@_TCP@_WRAPPERS\\ in \(Local/Makefile)\, arrange for the file
2064 \(tcpd.h)\ to be available at compile time, and also ensure that the library
2065 \(libwrap.a)\ is available at link time, typically by including \-lwrap-\ in
2066 \\EXTRALIBS@_EXIM\\. For example, if \*tcpwrappers*\ is installed in
2067 \(/usr/local)\, you might have
2068 .display
2069 USE@_TCP@_WRAPPERS=yes
2070 CFLAGS=-O -I/usr/local/include
2071 .newline
2072 EXTRALIBS@_EXIM=-L/usr/local/lib -lwrap
2073 .endd
2074 in \(Local/Makefile)\. The name to use in the \*tcpwrappers*\ control files is
2075 `exim'. For example, the line
2076 .display
2077 exim : LOCAL  192.168.1.  .friendly.domain.example
2078 .endd
2079 in your \(/etc/hosts.allow)\ file allows connections from the local host, from
2080 the subnet 192.168.1.0/24, and from all hosts in \*friendly.domain.example*\.
2081 All other connections are denied. Consult the \*tcpwrappers*\ documentation for
2082 further details.
2083
2084
2085 .section Including support for IPv6
2086 .index IPv6||including support for
2087 Exim contains code for use on systems that have IPv6 support. Setting
2088 \\HAVE@_IPV6=YES\\ in \(Local/Makefile)\ causes the IPv6 code to be included;
2089 it may also be necessary to set \\IPV6@_INCLUDE\\ and \\IPV6@_LIBS\\ on systems
2090 where the IPv6 support is not fully integrated into the normal include and
2091 library files.
2092
2093 .em
2094 Two different types of DNS record for handling IPv6 addresses have been
2095 defined. AAAA records (analagous to A records for IPv4) are in use, and are
2096 currently seen as the mainstream. Another record type called A6 was proposed
2097 as better than AAAA because it had more flexibility. However, it was felt to
2098 be over-complex, and its status was reduced to `experimental'. It is not known
2099 if anyone is actually using A6 records. Exim has support for A6 records, but
2100 this is included only if you set \\SUPPORT@_A6=YES\\ in \(Local/Makefile)\. The
2101 support has not been tested for some time.
2102 .nem
2103
2104 .section The building process
2105 .index build directory
2106 Once \(Local/Makefile)\ (and \(Local/eximon.conf)\, if required) have been
2107 created, run \*make*\ at the top level. It determines the architecture and
2108 operating system types, and creates a build directory if one does not exist.
2109 For example, on a Sun system running Solaris 8, the directory
2110 \(build-SunOS5-5.8-sparc)\ is created.
2111 .index symbolic link||to source files
2112 Symbolic links to relevant source files are installed in the build directory.
2113
2114 \**Warning**\: The \-j-\ (parallel) flag must not be used with \*make*\; the
2115 building process fails if it is set.
2116
2117 If this is the first time \*make*\ has been run, it calls a script that builds
2118 a make file inside the build directory, using the configuration files from the
2119 \(Local)\ directory. The new make file is then passed to another instance of
2120 \*make*\. This does the real work, building a number of utility scripts, and
2121 then compiling and linking the binaries for the Exim monitor (if configured), a
2122 number of utility programs, and finally Exim itself. The command \*make
2123 makefile*\ can be used to force a rebuild of the make file in the build
2124 directory, should this ever be necessary.
2125
2126 If you have problems building Exim, check for any comments there may be in the
2127 \(README)\ file concerning your operating system, and also take a look at the
2128 .if ~~html
2129 [(A HREF="FAQ.html")]
2130 .fi
2131 FAQ,
2132 .if ~~html
2133 [(/A)]
2134 .fi
2135 where some common problems are covered.
2136
2137
2138
2139 .section Overriding build-time options for Exim
2140 .index build-time options, overriding
2141 .rset SECToverride "~~chapter.~~section"
2142 The main make file that is created at the beginning of the building process
2143 consists of the concatenation of a number of files which set configuration
2144 values, followed by a fixed set of \*make*\ instructions. If a value is set
2145 more than once, the last setting overrides any previous ones. This provides a
2146 convenient way of overriding defaults. The files that are concatenated are, in
2147 order:
2148 .display rm
2149 \(OS/Makefile-Default)\
2150 \(OS/Makefile-)\<<ostype>>
2151 \(Local/Makefile)\
2152 \(Local/Makefile-)\<<ostype>>
2153 \(Local/Makefile-)\<<archtype>>
2154 \(Local/Makefile-)\<<ostype>>-<<archtype>>
2155 \(OS/Makefile-Base)\
2156 .endd
2157 .index \(Local/Makefile)\
2158 where <<ostype>> is the operating system type and <<archtype>> is the
2159 .index building Exim||operating system type
2160 .index building Exim||architecture type
2161 architecture type. \(Local/Makefile)\ is required to exist, and the building
2162 process fails if it is absent. The other three \(Local)\ files are optional,
2163 and are often not needed.
2164
2165 The values used for <<ostype>> and <<archtype>> are obtained from scripts
2166 called \(scripts/os-type)\ and \(scripts/arch-type)\ respectively. If either of
2167 the environment variables \\EXIM@_OSTYPE\\ or \\EXIM@_ARCHTYPE\\ is set, their
2168 values are used, thereby providing a means of forcing particular settings.
2169 Otherwise, the scripts try to get values from the \uname\ command. If this
2170 fails, the shell variables \\OSTYPE\\ and \\ARCHTYPE\\ are inspected. A number
2171 of $it{ad hoc} transformations are then applied, to produce the standard names
2172 that Exim expects. You can run these scripts directly from the shell in order
2173 to find out what values are being used on your system.
2174
2175
2176 \(OS/Makefile-Default)\ contains comments about the variables that are set
2177 therein. Some (but not all) are mentioned below. If there is something that
2178 needs changing, review the contents of this file and the contents of the make
2179 file for your operating system (\(OS/Makefile-<<ostype>>)\) to see what the
2180 default values are.
2181
2182
2183 .index building Exim||overriding default settings
2184 If you need to change any of the values that are set in \(OS/Makefile-Default)\
2185 or in \(OS/Makefile-<<ostype>>)\, or to add any new definitions, you do not
2186 need to change the original files. Instead, you should make the changes by
2187 putting the new values in an appropriate \(Local)\ file. For example,
2188 .index Tru64-Unix build-time settings
2189 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2190 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2191 compiler is called \*cc*\ rather than \*gcc*\. Also, the compiler must be
2192 called with the option \-std1-\, to make it recognize some of the features of
2193 Standard C that Exim uses. (Most other compilers recognize Standard C by
2194 default.) To do this, you should create a file called \(Local/Makefile-OSF1)\
2195 containing the lines
2196 .display
2197 CC=cc
2198 CFLAGS=-std1
2199 .endd
2200 If you are compiling for just one operating system, it may be easier to put
2201 these lines directly into \(Local/Makefile)\.
2202
2203 Keeping all your local configuration settings separate from the distributed
2204 files makes it easy to transfer them to new versions of Exim simply by copying
2205 the contents of the \(Local)\ directory.
2206
2207
2208 .index NIS lookup type||including support for
2209 .index NIS@+ lookup type||including support for
2210 .index LDAP||including support for
2211 .index lookup||inclusion in binary
2212 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2213 lookup, but not all systems have these components installed, so the default is
2214 not to include the relevant code in the binary. All the different kinds of file
2215 and database lookup that Exim supports are implemented as separate code modules
2216 which are included only if the relevant compile-time options are set. In the
2217 case of LDAP, NIS, and NIS+, the settings for \(Local/Makefile)\ are:
2218 .display asis
2219 LOOKUP_LDAP=yes
2220 LOOKUP_NIS=yes
2221 LOOKUP_NISPLUS=yes
2222 .endd
2223 and similar settings apply to the other lookup types. They are all listed in
2224 \(src/EDITME)\. In most cases the relevant include files and interface
2225 libraries need to be installed before compiling Exim.
2226 .index cdb||including support for
2227 However, in the case of cdb, which is included in the binary only if
2228 .display asis
2229 LOOKUP_CDB=yes
2230 .endd
2231 is set, the code is entirely contained within Exim, and no external include
2232 files or libraries are required. When a lookup type is not included in the
2233 binary, attempts to configure Exim to use it cause run time configuration
2234 errors.
2235
2236 .index Perl||including support for
2237 Exim can be linked with an embedded Perl interpreter, allowing Perl
2238 subroutines to be called during string expansion. To enable this facility,
2239 .display asis
2240 EXIM_PERL=perl.o
2241 .endd
2242 must be defined in \(Local/Makefile)\. Details of this facility are given in
2243 chapter ~~CHAPperl.
2244
2245 .index X11 libraries, location of
2246 The location of the X11 libraries is something that varies a lot between
2247 operating systems, and of course there are different versions of X11 to cope
2248 with. Exim itself makes no use of X11, but if you are compiling the Exim
2249 monitor, the X11 libraries must be available.
2250 The following three variables are set in \(OS/Makefile-Default)\:
2251 .display asis
2252 X11=/usr/X11R6
2253 XINCLUDE=-I$(X11)/include
2254 XLFLAGS=-L$(X11)/lib
2255 .endd
2256 These are overridden in some of the operating-system configuration files. For
2257 example, in \(OS/Makefile-SunOS5)\ there is
2258 .display asis
2259 X11=/usr/openwin
2260 XINCLUDE=-I$(X11)/include
2261 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2262 .endd
2263 If you need to override the default setting for your operating system, place a
2264 definition of all three of these variables into your
2265 \(Local/Makefile-<<ostype>>)\ file.
2266
2267 .index \\EXTRALIBS\\
2268 If you need to add any extra libraries to the link steps, these can be put in a
2269 variable called \\EXTRALIBS\\, which appears in all the link commands, but by
2270 default is not defined. In contrast, \\EXTRALIBS@_EXIM\\ is used only on the
2271 command for linking the main Exim binary, and not for any associated utilities.
2272 .index DBM||libraries, configuration for building
2273 There is also \\DBMLIB\\, which appears in the link commands for binaries that
2274 use DBM functions (see also section ~~SECTdb). Finally, there is
2275 \\EXTRALIBS@_EXIMON\\, which appears only in the link step for the Exim monitor
2276 binary, and which can be used, for example, to include additional X11
2277 libraries.
2278
2279 .index configuration file||editing
2280 The make file copes with rebuilding Exim correctly if any of the configuration
2281 files are edited. However, if an optional configuration file is deleted, it is
2282 necessary to touch the associated non-optional file (that is, \(Local/Makefile)\
2283 or \(Local/eximon.conf)\) before rebuilding.
2284
2285 .section OS-specific header files
2286 .index \(os.h)\
2287 .index building Exim||OS-specific C header files
2288 The \(OS)\ directory contains a number of files with names of the form
2289 \(os.h-<<ostype>>)\. These are system-specific C header files that should not
2290 normally need to be changed. There is a list of macro settings that are
2291 recognized in the file \(OS/os.configuring)\, which should be consulted if you
2292 are porting Exim to a new operating system.
2293
2294
2295 .section Overriding build-time options for the monitor
2296 .index building Eximon||overriding default options
2297 A similar process is used for overriding things when building the Exim monitor,
2298 where the files that are involved are
2299 .display rm
2300 \(OS/eximon.conf-Default)\
2301 \(OS/eximon.conf-)\<<ostype>>
2302 \(Local/eximon.conf)\
2303 \(Local/eximon.conf-)\<<ostype>>
2304 \(Local/eximon.conf-)\<<archtype>>
2305 \(Local/eximon.conf-)\<<ostype>>-<<archtype>>
2306 .endd
2307 .index \(Local/eximon.conf)\
2308 As with Exim itself, the final three files need not exist, and in this case the
2309 \(OS/eximon.conf-<<ostype>>)\ file is also optional. The default values in
2310 \(OS/eximon.conf-Default)\ can be overridden dynamically by setting environment
2311 variables of the same name, preceded by \\EXIMON@_\\. For example, setting
2312 \\EXIMON@_LOG@_DEPTH\\ in the environment overrides the value of
2313 \\LOG@_DEPTH\\ at run time.
2314
2315
2316
2317 .section Installing Exim binaries and scripts
2318 .index installing Exim
2319 .index \\BIN@_DIRECTORY\\
2320 The command \*make install*\ runs the \*exim@_install*\ script with no
2321 arguments. The script copies binaries and utility scripts into the directory
2322 whose name is specified by the \\BIN@_DIRECTORY\\ setting in
2323 \(Local/Makefile)\.
2324
2325 Exim's run time configuration file is named by the \\CONFIGURE@_FILE\\ setting
2326 .index \\CONFIGURE@_FILE\\
2327 in \(Local/Makefile)\. If this names a single file, and the file does not
2328 exist, the default configuration file \(src/configure.default)\ is copied there
2329 by the installation script. If a run time configuration file already exists, it
2330 is left alone. If \\CONFIGURE@_FILE\\ is a colon-separated list, naming several
2331 alternative files, no default is installed.
2332
2333 .index system aliases file
2334 .index \(/etc/aliases)\
2335 One change is made to the default configuration file when it is installed: the
2336 default configuration contains a router that references a system aliases file.
2337 The path to this file is set to the value specified by
2338 \\SYSTEM@_ALIASES@_FILE\\ in \(Local/Makefile)\ (\(/etc/aliases)\ by default).
2339 If the system aliases file does not exist, the installation script creates it,
2340 and outputs a comment to the user.
2341
2342 The created file contains no aliases, but it does contain comments about the
2343 aliases a site should normally have. Mail aliases have traditionally been
2344 kept in \(/etc/aliases)\. However, some operating systems are now using
2345 \(/etc/mail/aliases)\. You should check if yours is one of these, and change
2346 Exim's configuration if necessary.
2347
2348 The default configuration uses the local host's name as the only local domain,
2349 and is set up to do local deliveries into the shared directory \(/var/mail)\,
2350 running as the local user. System aliases and \(.forward)\ files in users' home
2351 directories are supported, but no NIS or NIS+ support is configured. Domains
2352 other than the name of the local host are routed using the DNS, with delivery
2353 over SMTP.
2354
2355 The install script copies files only if they are newer than the files they are
2356 going to replace. The Exim binary is required to be owned by root and have the
2357 \*setuid*\ bit set,
2358 .index setuid||installing Exim with
2359 for normal configurations. Therefore, you must run \*make install*\ as root so
2360 that it can set up the Exim binary in this way. However, in some special
2361 situations (for example, if a host is doing no local deliveries) it may be
2362 possible to run Exim without making the binary setuid root (see chapter
2363 ~~CHAPsecurity for details).
2364
2365 It is possible to install Exim for special purposes (such as building a binary
2366 distribution) in a private part of the file system. You can do this by a
2367 command such as
2368 .display asis
2369 make DESTDIR=/some/directory/ install
2370 .endd
2371 This has the effect of pre-pending the specified directory to all the file
2372 paths, except the name of the system aliases file that appears in the default
2373 configuration. (If a default alias file is created, its name \*is*\ modified.)
2374 For backwards compatibility, \\ROOT\\ is used if \\DESTDIR\\ is not set,
2375 but this usage is deprecated.
2376
2377 .index installing Exim||what is not installed
2378 Running \*make install*\ does not copy the Exim 4 conversion script
2379 \*convert4r4*\, or the \*pcretest*\ test program. You will probably run the
2380 first of these only once (if you are upgrading from Exim 3), and the second
2381 isn't really part of Exim. None of the documentation files in the \(doc)\
2382 directory are copied, except for the info files when you have set
2383 \\INFO@_DIRECTORY\\, as described in section ~~SECTinsinfdoc below.
2384
2385 For the utility programs, old versions are renamed by adding the suffix \(.O)\
2386 to their names. The Exim binary itself, however, is handled differently. It is
2387 installed under a name that includes the version number and the compile number,
2388 for example \(exim-~~version-1)\. The script then arranges for a symbolic link
2389 called \(exim)\ to point to the binary. If you are updating a previous version
2390 of Exim, the script takes care to ensure that the name \(exim)\ is never absent
2391 from the directory (as seen by other processes).
2392
2393 .index installing Exim||testing the script
2394 If you want to see what the \*make install*\ will do before running it for
2395 real, you can pass the \-n-\ option to the installation script by this command:
2396 .display asis
2397 make INSTALL_ARG=-n install
2398 .endd
2399 The contents of the variable \\INSTALL@_ARG\\ are passed to the installation
2400 script. You do not need to be root to run this test. Alternatively, you can run
2401 the installation script directly, but this must be from within the build
2402 directory. For example, from the top-level Exim directory you could use this
2403 command:
2404 .display
2405 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim@_install -n)
2406 .endd
2407
2408 .index installing Exim||install script options
2409 There are two other options that can be supplied to the installation script.
2410 .numberpars $.
2411 \-no@_chown-\ bypasses the call to change the owner of the installed binary
2412 to root, and the call to make it a setuid binary.
2413 .nextp
2414 \-no@_symlink-\ bypasses the setting up of the symbolic link \(exim)\ to the
2415 installed binary.
2416 .endp
2417 \\INSTALL@_ARG\\ can be used to pass these options to the script. For example:
2418 .display asis
2419 make INSTALL_ARG=-no_symlink install
2420 .endd
2421
2422 The installation script can also be given arguments specifying which files are
2423 to be copied. For example, to install just the Exim binary, and nothing else,
2424 without creating the symbolic link, you could use:
2425 .display asis
2426 make INSTALL_ARG='-no_symlink exim' install
2427 .endd
2428
2429
2430 .section Installing info documentation
2431 .rset SECTinsinfdoc "~~chapter.~~section"
2432 .index installing Exim||\*info*\ documentation
2433 Not all systems use the GNU \*info*\ system for documentation, and for this
2434 reason, the Texinfo source of Exim's documentation is not included in the main
2435 distribution. Instead it is available separately from the ftp site (see section
2436 ~~SECTavail).
2437
2438 If you have defined \\INFO@_DIRECTORY\\ in \(Local/Makefile)\ and the Texinfo
2439 source of the documentation is found in the source tree, running \*make
2440 install*\ automatically builds the info files and installs them.
2441
2442
2443 .section Setting up the spool directory
2444 .index spool directory||creating
2445 When it starts up, Exim tries to create its spool directory if it does not
2446 exist. The Exim uid and gid are used for the owner and group of the spool
2447 directory. Sub-directories are automatically created in the spool directory as
2448 necessary.
2449
2450
2451
2452 .section Testing
2453 .index testing||installation
2454 Having installed Exim, you can check that the run time configuration file is
2455 syntactically valid by running the following command, which assumes that the
2456 Exim binary directory is within your \\PATH\\ environment variable:
2457 .display
2458 exim -bV
2459 .endd
2460 If there are any errors in the configuration file, Exim outputs error messages.
2461 Otherwise it outputs the version number and build date,
2462 the DBM library that is being used, and information about which drivers and
2463 other optional code modules are included in the binary.
2464 Some simple routing tests can be done by using the address testing option. For
2465 example,
2466 .display
2467 exim -bt <<local username>>
2468 .endd
2469 should verify that it recognizes a local mailbox, and
2470 .display
2471 exim -bt <<remote address>>
2472 .endd
2473 a remote one. Then try getting it to deliver mail, both locally and remotely.
2474 This can be done by passing messages directly to Exim, without going through a
2475 user agent. For example:
2476 .display
2477 exim -v postmaster@@your.domain.example
2478 From: user@@your.domain.example
2479 To: postmaster@@your.domain.example
2480 Subject: Testing Exim
2481
2482 This is a test message.
2483 ^D
2484 .endd
2485 The \-v-\ option causes Exim to output some verification of what it is doing.
2486 In this case you should see copies of three log lines, one for the message's
2487 arrival, one for its delivery, and one containing `Completed'.
2488
2489 .index delivery||problems with
2490 If you encounter problems, look at Exim's log files (\*mainlog*\ and
2491 \*paniclog*\) to see if there is any relevant information there. Another source
2492 of information is running Exim with debugging turned on, by specifying the
2493 \-d-\ option. If a message is stuck on Exim's spool, you can force a delivery
2494 with debugging turned on by a command of the form
2495 .display
2496 exim -d -M <<message-id>>
2497 .endd
2498 You must be root or an `admin user' in order to do this. The \-d-\ option
2499 produces rather a lot of output, but you can cut this down to specific areas.
2500 For example, if you use \-d-all+route-\ only the debugging information relevant
2501 to routing is included. (See the \-d-\ option in chapter ~~CHAPcommandline for
2502 more details.)
2503
2504 .index `sticky' bit
2505 .index lock files
2506 One specific problem that has shown up on some sites is the inability to do
2507 local deliveries into a shared mailbox directory, because it does not have the
2508 `sticky bit' set on it. By default, Exim tries to create a lock file before
2509 writing to a mailbox file, and if it cannot create the lock file, the delivery
2510 is deferred. You can get round this either by setting the `sticky bit' on the
2511 directory, or by setting a specific group for local deliveries and allowing
2512 that group to create files in the directory (see the comments above the
2513 \%local@_delivery%\ transport in the default configuration file). Another
2514 approach is to configure Exim not to use lock files, but just to rely on
2515 \*fcntl()*\ locking instead. However, you should do this only if all user
2516 agents also use \*fcntl()*\ locking. For further discussion of locking issues,
2517 see chapter ~~CHAPappendfile.
2518
2519 One thing that cannot be tested on a system that is already running an MTA is
2520 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2521 \-oX-\ option can be used to run an Exim daemon that listens on some other
2522 port, or \*inetd*\ can be used to do this. The \-bh-\ option and the
2523 \*exim@_checkaccess*\ utility can be used to check out policy controls on
2524 incoming SMTP mail.
2525
2526 Testing a new version on a system that is already running Exim can most easily
2527 be done by building a binary with a different \\CONFIGURE@_FILE\\ setting. From
2528 within the run time configuration, all other file and directory names
2529 that Exim uses can be altered, in order to keep it entirely clear of the
2530 production version.
2531
2532 .section Replacing another MTA with Exim
2533 .index replacing another MTA
2534 Building and installing Exim for the first time does not of itself put it in
2535 general use. The name by which the system's MTA is called by mail user agents
2536 is either \(/usr/sbin/sendmail)\, or \(/usr/lib/sendmail)\ (depending on the
2537 operating system), and it is necessary to make this name point to the \*exim*\
2538 binary in order to get the user agents to pass messages to Exim. This is
2539 normally done by renaming any existing file and making \(/usr/sbin/sendmail)\
2540 or \(/usr/lib/sendmail)\
2541 .index symbolic link||to \*exim*\ binary
2542 a symbolic link to the \*exim*\ binary. It is a good idea to remove any setuid
2543 privilege and executable status from the old MTA. It is then necessary to stop
2544 and restart the mailer daemon, if one is running.
2545
2546 .index FreeBSD, MTA indirection
2547 .index \(/etc/mail/mailer.conf)\
2548 Some operating systems have introduced alternative ways of switching MTAs. For
2549 example, if you are running FreeBSD, you need to edit the file
2550 \(/etc/mail/mailer.conf)\ instead of setting up a symbolic link as just
2551 described. A typical example of the contents of this file for running Exim is
2552 as follows:
2553 .display asis
2554 sendmail            /usr/exim/bin/exim
2555 send-mail           /usr/exim/bin/exim
2556 mailq               /usr/exim/bin/exim -bp
2557 newaliases          /usr/bin/true
2558 .endd
2559
2560 Once you have set up the symbolic link, or edited \(/etc/mail/mailer.conf)\,
2561 your Exim installation is `live'. Check it by sending a message from your
2562 favourite user agent.
2563
2564 You should consider what to tell your users about the change of MTA. Exim may
2565 have different capabilities to what was previously running, and there are
2566 various operational differences such as the text of messages produced by
2567 command line options and in bounce messages. If you allow your users to make
2568 use of Exim's filtering capabilities, you should make the document entitled
2569 .if ~~html
2570 [(A HREF="filter.html")]
2571 .fi
2572 \*Exim's interface to mail filtering*\
2573 .if ~~html
2574 [(/A)]
2575 .fi
2576 available to them.
2577
2578
2579 .section Upgrading Exim
2580 .index upgrading Exim
2581 If you are already running Exim on your host, building and installing a new
2582 version automatically makes it available to MUAs, or any other programs that
2583 call the MTA directly. However, if you are running an Exim daemon, you do need
2584 to send it a HUP signal, to make it re-exec itself, and thereby pick up the new
2585 binary. You do not need to stop processing mail in order to install a new
2586 version of Exim.
2587
2588
2589 .section Stopping the Exim daemon on Solaris
2590 .index Solaris||stopping Exim on
2591 The standard command for stopping the mailer daemon on Solaris is
2592 .display
2593 /etc/init.d/sendmail stop
2594 .endd
2595 If \(/usr/lib/sendmail)\ has been turned into a symbolic link, this script
2596 fails to stop Exim because it uses the command \*ps -e*\ and greps the output
2597 for the text `sendmail'; this is not present because the actual program name
2598 (that is, `exim') is given by the \*ps*\ command with these options. A solution
2599 is to replace the line that finds the process id with something like
2600 .display asis
2601 pid=`cat /var/spool/exim/exim-daemon.pid`
2602 .endd
2603 to obtain the daemon's pid directly from the file that Exim saves it in.
2604
2605 Note, however, that stopping the daemon does not `stop Exim'. Messages can
2606 still be received from local processes, and if automatic delivery is configured
2607 (the normal case), deliveries will still occur.
2608
2609
2610 .
2611 .
2612 .
2613 .
2614 . ============================================================================
2615 .chapter The Exim command line
2616 .set runningfoot "command line"
2617 .rset CHAPcommandline ~~chapter
2618 .index command line||options
2619 .index options||command line
2620
2621 Exim's command line takes the standard Unix form of a sequence of options,
2622 each starting with a hyphen character, followed by a number of arguments. The
2623 options are compatible with the main options of Sendmail, and there are also
2624 some additional options, some of which are compatible with Smail 3. Certain
2625 combinations of options do not make sense, and provoke an error if used.
2626 The form of the arguments depends on which options are set.
2627
2628 .section Setting options by program name
2629 .index \*mailq*\
2630 If Exim is called under the name \*mailq*\, it behaves as if the option \-bp-\
2631 were present before any other options.
2632 The \-bp-\ option requests a listing of the contents of the mail queue on the
2633 standard output.
2634 This feature is for compatibility with some systems that contain a command of
2635 that name in one of the standard libraries, symbolically linked to
2636 \(/usr/sbin/sendmail)\ or \(/usr/lib/sendmail)\.
2637
2638 .index \*rsmtp*\
2639 If Exim is called under the name \*rsmtp*\ it behaves as if the option \-bS-\
2640 were present before any other options, for compatibility with Smail. The \-bS-\
2641 option is used for reading in a number of messages in batched SMTP format.
2642
2643 .index \*rmail*\
2644 If Exim is called under the name \*rmail*\ it behaves as if the \-i-\ and
2645 \-oee-\ options were present before any other options, for compatibility with
2646 Smail. The name \*rmail*\ is used as an interface by some UUCP systems.
2647
2648 .index \*runq*\
2649 .index queue runner
2650 If Exim is called under the name \*runq*\ it behaves as if the option \-q-\ were
2651 present before any other options, for compatibility with Smail. The \-q-\
2652 option causes a single queue runner process to be started.
2653
2654 .index \*newaliases*\
2655 .index alias file||building
2656 .index Sendmail compatibility||calling Exim as \*newaliases*\
2657 If Exim is called under the name \*newaliases*\ it behaves as if the option
2658 \-bi-\ were present before any other options, for compatibility with Sendmail.
2659 This option is used for rebuilding Sendmail's alias file. Exim does not have
2660 the concept of a single alias file, but can be configured to run a given
2661 command if called with the \-bi-\ option.
2662
2663 .section Trusted and admin users
2664 .rset SECTtrustedadmin "~~chapter.~~section"
2665 Some Exim options are available only to \*trusted users*\ and others are
2666 available only to \*admin users*\. In the description below, the phrases `Exim
2667 user' and `Exim group' mean the user and group defined by \\EXIM@_USER\\ and
2668 \\EXIM@_GROUP\\ in \(Local/Makefile)\ or set by the \exim@_user\ and
2669 \exim@_group\ options. These do not necessarily have to use the name `exim'.
2670
2671 .numberpars $.
2672 .index trusted user||definition of
2673 .index user||trusted, definition of
2674 The trusted users are root, the Exim user, any user listed in the
2675 \trusted@_users\ configuration option, and any user whose current group or any
2676 supplementary group is one of those listed in the \trusted@_groups\
2677 configuration option. Note that the Exim group is not automatically trusted.
2678
2679 .index `From' line
2680 .index envelope sender
2681 Trusted users are always permitted to use the \-f-\ option or a leading `From '
2682 line to specify the envelope sender of a message that is passed to Exim through
2683 the local interface (see the \-bm-\ and \-f-\ options below). See the
2684 \untrusted@_set@_sender\ option for a way of permitting non-trusted users to
2685 set envelope senders.
2686 .index ::From:: header line
2687 .index ::Sender:: header line
2688 For a trusted user, there is never any check on the contents of the ::From::
2689 header line, and a ::Sender:: line is never added. Furthermore, any existing
2690 ::Sender:: line in incoming local (non-TCP/IP) messages is not removed.
2691
2692 Trusted users may also specify a host name, host address, interface address,
2693 protocol name, ident value, and authentication data when submitting a message
2694 locally. Thus, they are able to insert messages into Exim's queue locally that
2695 have the characteristics of messages received from a remote host. Untrusted
2696 users may in some circumstances use \-f-\, but can never set the other values
2697 that are available to trusted users.
2698 .nextp
2699 .index user||admin, definition of
2700 .index admin user||definition of
2701 The admin users are root, the Exim user, and any user that is a member of the
2702 Exim group or of any group listed in the \admin@_groups\ configuration option.
2703 The current group does not have to be one of these groups.
2704
2705 Admin users are permitted to list the queue, and to carry out certain
2706 operations on messages, for example, to force delivery failures. It is also
2707 necessary to be an admin user in order to see the full information provided by
2708 the Exim monitor, and full debugging output.
2709
2710 By default, the use of the \-M-\, \-q-\, \-R-\, and \-S-\ options to cause Exim
2711 to attempt delivery of messages on its queue is restricted to admin users.
2712 However, this restriction can be relaxed by setting the \prod@_requires@_admin\
2713 option false (that is, specifying \no@_prod@_requires@_admin\).
2714
2715 Similarly, the use of the \-bp-\ option to list all the messages in the queue
2716 is restricted to admin users unless \queue@_list@_requires@_admin\ is set
2717 false.
2718 .endp
2719
2720 \**Warning**\: If you configure your system so that admin users are able to
2721 edit Exim's configuration file, you are giving those users an easy way of
2722 getting root. There is further discussion of this issue at the start of chapter
2723 ~~CHAPconf.
2724
2725
2726
2727 .section Command line options
2728 The command options are described in alphabetical order below.
2729
2730 .startoptions
2731
2732 .option @-
2733 .index options||command line, terminating
2734 This is a pseudo-option whose only purpose is to terminate the options and
2735 therefore to cause subsequent command line items to be treated as arguments
2736 rather than options, even if they begin with hyphens.
2737
2738 .option -help
2739 This option causes Exim to output a few sentences stating what it is.
2740 The same output is generated if the Exim binary is called with no options and
2741 no arguments.
2742
2743 .option B <<type>>
2744 .index 8-bit characters
2745 .index Sendmail compatibility||8-bit characters
2746 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2747 clean; it ignores this option.
2748
2749 .option bd
2750 .index daemon
2751 .index SMTP listener
2752 .index queue runner
2753 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2754 the \-bd-\ option is combined with the \-q-\<<time>> option, to specify that
2755 the daemon should also initiate periodic queue runs.
2756
2757 The \-bd-\ option can be used only by an admin user. If either of the \-d-\
2758 (debugging) or \-v-\ (verifying) options are set, the daemon does not
2759 disconnect from the controlling terminal. When running this way, it can be
2760 stopped by pressing ctrl-C.
2761
2762 By default, Exim listens for incoming connections to the standard SMTP port on
2763 all the host's running interfaces. However, it is possible to listen on other
2764 ports, on multiple ports, and only on specific interfaces. Chapter
2765 ~~CHAPinterfaces contains a description of the options that control this.
2766
2767 .index daemon||process id (pid)
2768 .index pid (process id)||of daemon
2769 When a listening daemon is started without the use of \-oX-\ (that is, without
2770 overriding the normal configuration), it writes its process id to a file called
2771 \(exim-daemon.pid)\ in Exim's spool directory. This location can be overridden
2772 by setting \\PID@_FILE@_PATH\\ in \(Local/Makefile)\. The file is written while
2773 Exim is still running as root.
2774
2775 When \-oX-\ is used on the command line to start a listening daemon, the
2776 process id is not written to the normal pid file path. However, \-oP-\ can be
2777 used to specify a path on the command line if a pid file is required.
2778
2779 .index \\SIGHUP\\
2780 The \\SIGHUP\\ signal can be used to cause the daemon to re-exec itself. This
2781 should be done whenever Exim's configuration file, or any file that is
2782 incorporated into it by means of the \.include\ facility, is changed, and also
2783 whenever a new version of Exim is installed. It is not necessary to do this
2784 when other files that are referenced from the configuration (for example, alias
2785 files) are changed, because these are reread each time they are used.
2786
2787 .option bdf
2788 This option has the same effect as \-bd-\ except that it never disconnects from
2789 the controlling terminal, even when no debugging is specified.
2790
2791 .option be
2792 .index testing||string expansion
2793 .index expansion||testing
2794 Run Exim in expansion testing mode. Exim discards its root privilege, to
2795 prevent ordinary users from using this mode to read otherwise inaccessible
2796 files. If no arguments are given, Exim runs interactively, prompting for lines
2797 of data. 
2798 .em
2799 If Exim was built with \\USE@_READLINE\\=yes in \(Local/Makefile)\, it tries
2800 to load the \libreadline\ library dynamically whenever the \-be-\ option is
2801 used without command line arguments. If successful, it uses the \*readline()*\
2802 function, which provides extensive line-editing facilities, for reading the
2803 test data. A line history is supported.
2804 .nem
2805
2806 Long expansion expressions can be split over several lines by using backslash
2807 continuations. As in Exim's run time configuration, whitespace at the start of
2808 continuation lines is ignored. Each argument or data line is passed through the
2809 string expansion mechanism, and the result is output. Variable values from the
2810 configuration file (for example, \$qualify@_domain$\) are available, but no
2811 message-specific values (such as \$domain$\) are set, because no message is
2812 being processed.
2813
2814 .option bF #<<filename>>
2815 .index system filter||testing
2816 .index testing||system filter
2817 This option is the same as \-bf-\ except that it assumes that the filter being
2818 tested is a system filter. The additional commands that are available only in
2819 system filters are recognized.
2820
2821 .option bf #<<filename>>
2822 .index filter||testing
2823 .index testing||filter file
2824 .index forward file||testing
2825 .index testing||forward file
2826 .index Sieve filter||testing
2827 This option runs Exim in user filter testing mode; the file is the filter file
2828 to be tested, and a test message must be supplied on the standard input. If
2829 there are no message-dependent tests in the filter, an empty file can be
2830 supplied.
2831 .em
2832 If you want to test a system filter file, use \-bF-\ instead of \-bf-\. You can 
2833 use both \-bF-\ and \-bf-\ on the same command, in order to
2834 test a system filter and a user filter in the same run. For example:
2835 .display asis
2836 exim -bF /system/filter -bf /user/filter </test/message
2837 .endd
2838 This is helpful when the system filter adds header lines or sets filter
2839 variables that are used by the user filter.
2840 .nem
2841
2842 If the test filter file does not begin with one of the special lines
2843 .display asis
2844 # Exim filter
2845 # Sieve filter
2846 .endd
2847 it is taken to be a normal \(.forward)\ file, and is tested for validity under
2848 that interpretation. See sections ~~SECTitenonfilred to ~~SECTspecitredli for a
2849 description of the possible contents of non-filter redirection lists.
2850
2851 The result of an Exim command that uses \-bf-\, provided no errors are
2852 detected, is a list of the actions that Exim would try to take if presented
2853 with the message for real. More details of filter testing are given in the
2854 separate document entitled \*Exim's interfaces to mail filtering*\.
2855
2856 .index `From' line
2857 .index envelope sender
2858 .index \-f-\ option||for filter testing
2859 When testing a filter file, the envelope sender can be set by the \-f-\ option,
2860 or by a `From ' line at the start of the test message. Various parameters that
2861 would normally be taken from the envelope recipient address of the message can
2862 be set by means of additional command line options (see the next four options).
2863
2864 .em
2865 .option bfd #<<domain>>
2866 This sets the domain of the recipient address when a filter file is being 
2867 tested by means of the \-bf-\ option. The default is the value of 
2868 \$qualify@_domain$\.
2869
2870 .option bfl #<<local part>>
2871 This sets the local part of the recipient address when a filter file is being
2872 tested by means of the \-bf-\ option. The default is the username of the
2873 process that calls Exim. A local part should be specified with any prefix or
2874 suffix stripped, because that is how it appears to the filter when a message is
2875 actually being delivered.
2876
2877 .option bfp #<<prefix>>
2878 This sets the prefix of the local part of the recipient address when a filter
2879 file is being tested by means of the \-bf-\ option. The default is an empty 
2880 prefix.
2881
2882 .option bfp #<<suffix>>
2883 This sets the suffix of the local part of the recipient address when a filter
2884 file is being tested by means of the \-bf-\ option. The default is an empty 
2885 suffix.
2886 .em
2887
2888
2889 .option bh #<<IP address>>
2890 .index testing||incoming SMTP
2891 .index SMTP||testing incoming
2892 .index testing||relay control
2893 .index relaying||testing configuration
2894 .index policy control||testing
2895 .index debugging||\-bh-\ option
2896 This option runs a fake SMTP session as if from the given IP address, using the
2897 standard input and output. The IP address may include a port number at the end,
2898 after a full stop. For example:
2899 .display asis
2900 exim -bh 10.9.8.7.1234
2901 exim -bh fe80::a00:20ff:fe86:a061.5678
2902 .endd
2903 .em
2904 When an IPv6 address is given, it is converted into canonical form. In the case 
2905 of the second example above, the value of \$sender@_host@_address$\ after 
2906 conversion to the canonical form is \"fe80:0000:0000:0a00:20ff:fe86:a061.5678"\.
2907 .nem
2908
2909 Comments as to what is going on are written to the standard error file. These
2910 include lines beginning with `LOG' for anything that would have been logged.
2911 This facility is provided for testing configuration options for incoming
2912 messages, to make sure they implement the required policy. For example, you can
2913 test your relay controls using \-bh-\.
2914
2915 .index RFC 1413
2916 \**Warning 1**\: You cannot test features of the configuration that rely on
2917 ident (RFC 1413) callouts. These cannot be done when testing using
2918 \-bh-\ because there is no incoming SMTP connection.
2919
2920 \**Warning 2**\: Address verification callouts (see section ~~SECTcallver) are
2921 also skipped when testing using \-bh-\. If you want these callouts to occur,
2922 use \-bhc-\ instead.
2923
2924 Messages supplied during the testing session are discarded, and nothing is
2925 written to any of the real log files. There may be pauses when DNS (and other)
2926 lookups are taking place, and of course these may time out. The \-oMi-\ option
2927 can be used to specify a specific IP interface and port if this is important.
2928
2929 The \*exim@_checkaccess*\ utility is a `packaged' version of \-bh-\ whose
2930 output just states whether a given recipient address from a given host is
2931 acceptable or not. See section ~~SECTcheckaccess.
2932
2933 .option bhc #<<IP address>>
2934 This option operates in the same way as \-bh-\, except that address
2935 verification callouts are performed if required. This includes consulting and
2936 updating the callout cache database.
2937
2938 .option bi
2939 .index alias file||building
2940 .index building alias file
2941 .index Sendmail compatibility||\-bi-\ option
2942 Sendmail interprets the \-bi-\ option as a request to rebuild its alias file.
2943 Exim does not have the concept of a single alias file, and so it cannot mimic
2944 this behaviour. However, calls to \(/usr/lib/sendmail)\ with the \-bi-\ option
2945 tend to appear in various scripts such as NIS make files, so the option must be
2946 recognized.
2947
2948 If \-bi-\ is encountered, the command specified by the \bi@_command\
2949 configuration option is run, under the uid and gid of the caller of Exim. If
2950 the \-oA-\ option is used, its value is passed to the command as an argument.
2951 The command set by \bi@_command\ may not contain arguments. The command can use
2952 the \*exim@_dbmbuild*\ utility, or some other means, to rebuild alias files if
2953 this is required. If the \bi@_command\ option is not set, calling Exim with
2954 \-bi-\ is a no-op.
2955
2956 .option bm
2957 .index local message reception
2958 This option runs an Exim receiving process that accepts an incoming,
2959 locally-generated message on the current input. The recipients are given as the
2960 command arguments (except when \-t-\ is also present -- see below). Each
2961 argument can be a comma-separated list of RFC 2822 addresses. This is the
2962 default option for selecting the overall action of an Exim call; it is assumed
2963 if no other conflicting option is present.
2964
2965 If any addresses in the message are unqualified (have no domain), they are
2966 qualified by the values of the \qualify@_domain\ or \qualify@_recipient\
2967 options, as appropriate. The \-bnq-\ option (see below) provides a way of
2968 suppressing this for special cases.
2969
2970 Policy checks on the contents of local messages can be enforced by means of the
2971 non-SMTP ACL. See chapter ~~CHAPACL for details.
2972 .index return code||for \-bm-\
2973 The return code is zero if the message is successfully accepted. Otherwise, the
2974 action is controlled by the \-oe$it{x}-\ option setting -- see below.
2975
2976 .index message||format
2977 .index format||message
2978 .index `From' line
2979 .index UUCP||`From' line
2980 .index Sendmail compatibility||`From' line
2981 The format of the message must be as defined in RFC 2822, except that, for
2982 compatibility with Sendmail and Smail, a line in one of the forms
2983 .display
2984 From sender Fri Jan  5 12:55 GMT 1997
2985 From sender Fri, 5 Jan 97 12:55:01
2986 .endd
2987 (with the weekday optional, and possibly with additional text after the date)
2988 is permitted to appear at the start of the message. There appears to be no
2989 authoritative specification of the format of this line. Exim recognizes it by
2990 matching against the regular expression defined by the \uucp@_from@_pattern\
2991 option, which can be changed if necessary.
2992 .index \-f-\ option||overriding `From' line
2993 The specified sender is treated as if it were given as the argument to the
2994 \-f-\ option, but if a \-f-\ option is also present, its argument is used in
2995 preference to the address taken from the message. The caller of Exim must be a
2996 trusted user for the sender of a message to be set in this way.
2997
2998 .option bnq
2999 .index address||qualification, suppressing
3000 By default, Exim automatically qualifies unqualified addresses (those
3001 without domains) that appear in messages that are submitted locally (that
3002 is, not over TCP/IP). This qualification applies both to addresses in
3003 envelopes, and addresses in header lines. Sender addresses are qualified using
3004 \qualify@_domain\, and recipient addresses using \qualify@_recipient\ (which
3005 defaults to the value of \qualify@_domain\).
3006
3007 Sometimes, qualification is not wanted. For example, if \-bS-\ (batch SMTP) is
3008 being used to re-submit messages that originally came from remote hosts after
3009 content scanning, you probably do not want to qualify unqualified addresses in
3010 header lines. (Such lines will be present only if you have not enabled a header
3011 syntax check in the appropriate ACL.)
3012
3013 The \-bnq-\ option suppresses all qualification of unqualified addresses in
3014 messages that originate on the local host. When this is used, unqualified
3015 addresses in the envelope provoke errors (causing message rejection) and
3016 unqualified addresses in header lines are left alone.
3017
3018
3019 .option bP
3020 .index configuration options, extracting
3021 .index options||configuration, extracting
3022 If this option is given with no arguments, it causes the values of all Exim's
3023 main configuration options to be written to the standard output. The values
3024 of one or more specific options can be requested by giving their names as
3025 arguments, for example:
3026 .display
3027 exim -bP qualify@_domain hold@_domains
3028 .endd
3029 However, any option setting that is preceded by the word `hide' in the
3030 configuration file is not shown in full, except to an admin user. For other
3031 users, the output is as in this example:
3032 .display asis
3033 mysql_servers = <value not displayable>
3034 .endd
3035 If \configure@_file\ is given as an argument, the name of the run time
3036 configuration file is output.
3037 If a list of configuration files was supplied, the value that is output here
3038 is the name of the file that was actually used.
3039
3040 .index daemon||process id (pid)
3041 .index pid (process id)||of daemon
3042 If \log__file__path\ or \pid@_file@_path\ are given, the names of the
3043 directories where log files and daemon pid files are written are output,
3044 respectively. If these values are unset, log files are written in a
3045 sub-directory of the spool directory called \log\, and the pid file is written
3046 directly into the spool directory.
3047
3048 If \-bP-\ is followed by a name preceded by \"+"\, for example,
3049 .display asis
3050 exim -bP +local_domains
3051 .endd
3052 it searches for a matching named list of any type (domain, host, address, or
3053 local part) and outputs what it finds.
3054
3055 .index options||router, extracting
3056 .index options||transport, extracting
3057 If one of the words \router\, \transport\, or \authenticator\ is given,
3058 followed by the name of an appropriate driver instance, the option settings for
3059 that driver are output. For example:
3060 .display
3061 exim -bP transport local@_delivery
3062 .endd
3063 The generic driver options are output first, followed by the driver's private
3064 options. A list of the names of drivers of a particular type can be obtained by
3065 using one of the words \router@_list\, \transport@_list\, or
3066 \authenticator@_list\, and a complete list of all drivers with their option
3067 settings can be obtained by using \routers\, \transports\, or \authenticators\.
3068
3069
3070 .option bp
3071 .index queue||listing messages on
3072 .index listing||messages on the queue
3073 This option requests a listing of the contents of the mail queue on the
3074 standard output. If the \-bp-\ option is followed by a list of message ids,
3075 just those messages are listed. By default, this option can be used only by an
3076 admin user. However, the \queue__list__requires__admin\ option can be set false
3077 to allow any user to see the queue.
3078
3079 Each message on the queue is displayed as in the following example:
3080 .display
3081 25m  2.9K 0t5C6f-0000c8-00 <alice@@wonderland.fict.example>
3082           red.king@@looking-glass.fict.example
3083           <<other addresses>>
3084 .endd
3085 .index message||size in queue listing
3086 .index size||of message
3087 The first line contains the length of time the message has been on the queue
3088 (in this case 25 minutes), the size of the message (2.9K), the unique local
3089 identifier for the message, and the message sender, as contained in the
3090 envelope. For bounce messages, the sender address is empty, and appears as
3091 `<>'. If the message was submitted locally by an untrusted user who overrode
3092 the default sender address, the user's login name is shown in parentheses
3093 before the sender address.
3094 .index frozen messages||in queue listing
3095 If the message is frozen (attempts to deliver it are suspended) then the text
3096 `$*$$*$$*$ frozen $*$$*$$*$' is displayed at the end of this line.
3097
3098 The recipients of the message (taken from the envelope, not the headers) are
3099 displayed on subsequent lines. Those addresses to which the message has already
3100 been delivered are marked with the letter D. If an original address gets
3101 expanded into several addresses via an alias or forward file, the original is
3102 displayed with a D only when deliveries for all of its child addresses are
3103 complete.
3104
3105
3106 .option bpa
3107 This option operates like \-bp-\, but in addition it shows delivered addresses
3108 that were generated from the original top level address(es) in each message by
3109 alias or forwarding operations. These addresses are flagged with `+D' instead
3110 of just `D'.
3111
3112
3113 .option bpc
3114 .index queue||count of messages on
3115 This option counts the number of messages on the queue, and writes the total
3116 to the standard output. It is restricted to admin users, unless
3117 \queue__list__requires__admin\ is set false.
3118
3119
3120 .option bpr
3121 This option operates like \-bp-\, but the output is not sorted into
3122 chronological order of message arrival. This can speed it up when there are
3123 lots of messages on the queue, and is particularly useful if the output is
3124 going to be post-processed in a way that doesn't need the sorting.
3125
3126 .option bpra
3127 This option is a combination of \-bpr-\ and \-bpa-\.
3128
3129 .option bpru
3130 This option is a combination of \-bpr-\ and \-bpu-\.
3131
3132
3133 .option bpu
3134 This option operates like \-bp-\ but shows only undelivered top-level addresses
3135 for each message displayed. Addresses generated by aliasing or forwarding are
3136 not shown, unless the message was deferred after processing by a router with
3137 the \one@_time\ option set.
3138
3139
3140 .option brt
3141 .index testing||retry configuration
3142 .index retry||configuration testing
3143 This option is for testing retry rules, and it must be followed by up to three
3144 arguments. It causes Exim to look for a retry rule that matches the values
3145 and to write it to the standard output. For example:
3146 .display asis
3147 exim -brt bach.comp.mus.example
3148 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3149 .endd
3150 See chapter ~~CHAPretry for a description of Exim's retry rules. The first
3151 argument, which is required, can be a complete address in the form
3152 \*local@_part@@domain*\, or it can be just a domain name. The second argument is
3153 an optional second domain name; if no retry rule is found for the first
3154 argument, the second is tried. This ties in with Exim's behaviour when looking
3155 for retry rules for remote hosts -- if no rule is found that matches the host,
3156 one that matches the mail domain is sought. The final argument is the name of a
3157 specific delivery error, as used in setting up retry rules, for example
3158 `quota@_3d'.
3159
3160 .option brw
3161 .index testing||rewriting
3162 .index rewriting||testing
3163 This option is for testing address rewriting rules, and it must be followed by
3164 a single argument, consisting of either a local part without a domain, or a
3165 complete address with a fully qualified domain. Exim outputs how this address
3166 would be rewritten for each possible place it might appear. See chapter
3167 ~~CHAPrewrite for further details.
3168
3169 .option bS
3170 .index SMTP||batched incoming
3171 .index batched SMTP input
3172 This option is used for batched SMTP input, which is an alternative interface
3173 for non-interactive local message submission. A number of messages can be
3174 submitted in a single run. However, despite its name, this is not really SMTP
3175 input. Exim reads each message's envelope from SMTP commands on the standard
3176 input, but generates no responses. If the caller is trusted, or
3177 \untrusted@_set@_sender\ is set, the senders in the SMTP \\MAIL\\ commands are
3178 believed; otherwise the sender is always the caller of Exim.
3179
3180 The message itself is read from the standard input, in SMTP format (leading
3181 dots doubled), terminated by a line containing just a single dot. An error is
3182 provoked if the terminating dot is missing. A further message may then follow.
3183
3184 As for other local message submissions, the contents of incoming batch SMTP
3185 messages can be checked using the non-SMTP ACL (see chapter ~~CHAPACL).
3186 Unqualified addresses are automatically qualified using \qualify@_domain\ and
3187 \qualify@_recipient\, as appropriate, unless the \-bnq-\ option is used.
3188
3189 Some other SMTP commands are recognized in the input. \\HELO\\ and \\EHLO\\ act
3190 as \\RSET\\; \\VRFY\\, \\EXPN\\, \\ETRN\\, and \\HELP\\ act as \\NOOP\\;
3191 \\QUIT\\ quits, ignoring the rest of the standard input.
3192
3193 If any error is encountered, reports are written to the standard output and
3194 error streams, and Exim gives up immediately.
3195 .index return code||for \-bS-\
3196 The return code is 0 if no error was detected; it is 1 if one or more messages
3197 were accepted before the error was detected; otherwise it is 2.
3198
3199 More details of input using batched SMTP are given in section
3200 ~~SECTincomingbatchedSMTP.
3201
3202 .option bs
3203 .index SMTP||local input
3204 .index local SMTP input
3205 This option causes Exim to accept one or more messages by reading SMTP commands
3206 on the standard input, and producing SMTP replies on the standard output. SMTP
3207 policy controls, as defined in ACLs (see chapter ~~CHAPACL) are applied.
3208
3209 Some user agents use this interface as a way of passing locally-generated
3210 messages to the MTA.
3211 .index sender||source of
3212 In this usage, if the caller of Exim is trusted, or \untrusted@_set@_sender\ is
3213 set, the senders of messages are taken from the SMTP \\MAIL\\ commands.
3214 Otherwise the content of these commands is ignored and the sender is set up as
3215 the calling user. Unqualified addresses are automatically qualified using
3216 \qualify@_domain\ and \qualify@_recipient\, as appropriate, unless the \-bnq-\
3217 option is used.
3218
3219 .index inetd
3220 The \-bs-\ option is also used to run Exim from \*inetd*\, as an alternative to
3221 using a listening daemon. Exim can distinguish the two cases by checking
3222 whether the standard input is a TCP/IP socket. When Exim is called from
3223 \*inetd*\, the source of the mail is assumed to be remote, and the comments
3224 above concerning senders and qualification do not apply. In this situation,
3225 Exim behaves in exactly the same way as it does when receiving a message via
3226 the listening daemon.
3227
3228 .option bt
3229 .index testing||addresses
3230 .index address||testing
3231 This option runs Exim in address testing mode, in which each argument is taken
3232 as an address to be tested for deliverability. The results are written to the
3233 standard output. If a test fails, and the caller is not an admin user, no
3234 details of the failure are output, because these might contain sensitive
3235 information such as usernames and passwords for database lookups.
3236
3237 If no arguments are given, Exim runs in an interactive manner, prompting with a
3238 right angle bracket for addresses to be tested. 
3239 .em
3240 Unlike the \-be-\ test option, you cannot arrange for Exim to use the 
3241 \*readline()*\ function, because it is running as \*root*\ and there are
3242 security issues.
3243 .nem
3244
3245 Each address is handled as if it were the recipient address of a message
3246 (compare the \-bv-\ option). It is passed to the routers and the result is
3247 written to the standard output. However, any router that has
3248 \no@_address@_test\ set is bypassed. This can make \-bt-\ easier to use for
3249 genuine routing tests if your first router passes everything to a scanner
3250 program.
3251
3252 .index return code||for \-bt-\
3253 The return code is 2 if any address failed outright; it is 1 if no address
3254 failed outright but at least one could not be resolved for some reason. Return
3255 code 0 is given only when all addresses succeed.
3256
3257 \**Warning**\: \-bt-\ can only do relatively simple testing. If any of the
3258 routers in the configuration makes any tests on the sender address of a
3259 message,
3260 .index \-f-\ option||for address testing
3261 you can use the \-f-\ option to set an appropriate sender when running
3262 \-bt-\ tests. Without it, the sender is assumed to be the calling user at the
3263 default qualifying domain. However, if you have set up (for example) routers
3264 whose behaviour depends on the contents of an incoming message, you cannot test
3265 those conditions using \-bt-\. The \-N-\ option provides a possible way of
3266 doing such tests.
3267
3268 .option bV
3269 .index version number of Exim, verifying
3270 This option causes Exim to write the current version number, compilation
3271 number, and compilation date of the \*exim*\ binary to the standard output.
3272 It also lists the DBM library this is being used, the optional modules (such as
3273 specific lookup types), the drivers that are included in the binary, and the
3274 name of the run time configuration file that is in use.
3275
3276 .em
3277 As part of its operation, \-bV-\ causes Exim to read and syntax check its 
3278 configuration file. However, this is a static check only. It cannot check
3279 values that are to be expanded. For example, although a misspelt ACL verb is
3280 detected, an error in the verb's arguments is not. You cannot rely on \-bV-\
3281 alone to discover (for example) all the typos in the configuration; some
3282 realistic testing is needed. The \-bh-\ and \-N-\ options provide more dynamic
3283 testing facilities.
3284 .nem
3285
3286
3287 .option bv
3288 .index verifying||address, using \-bv-\
3289 .index address||verification
3290 This option runs Exim in address verification mode, in which each argument is
3291 taken as an address to be verified. During normal operation, verification
3292 happens mostly as a consequence processing a \verify\ condition in an ACL (see
3293 chapter ~~CHAPACL). If you want to test an entire ACL, see the \-bh-\ option.
3294
3295 If verification fails, and the caller is not an admin user, no details of the
3296 failure are output, because these might contain sensitive information such as
3297 usernames and passwords for database lookups.
3298
3299 If no arguments are given, Exim runs in an interactive manner, prompting with a
3300 right angle bracket for addresses to be verified. 
3301 .em
3302 Unlike the \-be-\ test option, you cannot arrange for Exim to use the 
3303 \*readline()*\ function, because it is running as \*exim*\ and there are
3304 security issues.
3305 .nem
3306
3307 Verification differs from address testing (the \-bt-\ option) in that routers
3308 that have \no@_verify\ set are skipped, and if the address is accepted by a
3309 router that has \fail@_verify\ set, verification fails. The address is verified
3310 as a recipient if \-bv-\ is used; to test verification for a sender address,
3311 \-bvs-\ should be used.
3312
3313 If the \-v-\ option is not set, the output consists of a single line for each
3314 address, stating whether it was verified or not, and giving a reason in the
3315 latter case. Otherwise, more details are given of how the address has been
3316 handled, and in the case of address redirection, all the generated addresses
3317 are also considered. Without \-v-\, generating more than one address by
3318 redirection causes verification to end sucessfully.
3319
3320 .index return code||for \-bv-\
3321 The return code is 2 if any address failed outright; it is 1 if no address
3322 failed outright but at least one could not be resolved for some reason. Return
3323 code 0 is given only when all addresses succeed.
3324
3325 If any of the routers in the configuration makes any tests on the sender
3326 address of a message, you should use the \-f-\ option to set an appropriate
3327 sender when running \-bv-\ tests. Without it, the sender is assumed to be the
3328 calling user at the default qualifying domain.
3329
3330 .option bvs
3331 This option acts like \-bv-\, but verifies the address as a sender rather
3332 than a recipient address. This affects any rewriting and qualification that
3333 might happen.
3334
3335 .option C #<<filelist>>
3336 .index configuration file||alternate
3337 .index \\CONFIGURE@_FILE\\
3338 .index alternate configuration file
3339 This option causes Exim to find the run time configuration file from the given
3340 list instead of from the list specified by the \\CONFIGURE@_FILE\\
3341 compile-time setting. Usually, the list will consist of just a single file
3342 name, but it can be a colon-separated list of names. In this case, the first
3343 file that exists is used. Failure to open an existing file stops Exim from
3344 proceeding any further along the list, and an error is generated.
3345
3346 When this option is used by a caller other than root or the Exim user, and the
3347 list is different from the compiled-in list, Exim gives up its root privilege
3348 immediately, and runs with the real and effective uid and gid set to those of
3349 the caller. However, if \\ALT@_CONFIG@_ROOT@_ONLY\\ is defined in
3350 \(Local/Makefile)\, root privilege is retained for \-C-\ only if the caller of
3351 Exim is root.
3352 .em
3353 That is, the Exim user is no longer privileged in this regard. This build-time
3354 option is not set by default in the Exim source distribution tarbundle. 
3355 However, if you are using a `packaged' version of Exim (source or binary), the 
3356 packagers might have enabled it.
3357 .nem
3358
3359 Setting \\ALT@_CONFIG@_ROOT@_ONLY\\ locks out the possibility of testing a
3360 configuration using \-C-\ right through message reception and delivery, even if
3361 the caller is root. The reception works, but by that time, Exim is running as
3362 the Exim user, so when it re-execs to regain privilege for the delivery, the
3363 use of \-C-\ causes privilege to be lost. However, root can test reception and
3364 delivery using two separate commands (one to put a message on the queue, using
3365 \-odq-\, and another to do the delivery, using \-M-\).
3366
3367 If \\ALT@_CONFIG@_PREFIX\\ is defined \(in Local/Makefile)\, it specifies a
3368 prefix string with which any file named in a \-C-\ command line option
3369 must start. In addition, the file name must not contain the sequence \"/../"\.
3370 However, if the value of the \-C-\ option is identical to the value of
3371 \\CONFIGURE@_FILE\\ in \(Local/Makefile)\, Exim ignores \-C-\ and proceeds as
3372 usual. There is no default setting for \\ALT@_CONFIG@_PREFIX\\; when it is
3373 unset, any file name can be used with \-C-\.
3374
3375 \\ALT@_CONFIG@_PREFIX\\ can be used to confine alternative configuration files
3376 to a directory to which only root has access. This prevents someone who has
3377 broken into the Exim account from running a privileged Exim with an arbitrary
3378 configuration file.
3379
3380 The \-C-\ facility is useful for ensuring that configuration files are
3381 syntactically correct, but cannot be used for test deliveries, unless the
3382 caller is privileged, or unless it is an exotic configuration that does not
3383 require privilege. No check is made on the owner or group of the files
3384 specified by this option.
3385
3386 .option D <<macro>>=<<value>>
3387 .index macro||setting on command line
3388 This option can be used to override macro definitions in the configuration file
3389 (see section ~~SECTmacrodefs). However, like \-C-\, if it is used by an
3390 unprivileged caller, it causes Exim to give up its root privilege.
3391 If \\DISABLE@_D@_OPTION\\ is defined in \(Local/Makefile)\, the use of \-D-\ is
3392 completely disabled, and its use causes an immediate error exit.
3393
3394 The entire option (including equals sign if present) must all be within one
3395 command line item. \-D-\ can be used to set the value of a macro to the empty
3396 string, in which case the equals sign is optional. These two commands are
3397 synonymous:
3398 .display asis
3399 exim -DABC  ...
3400 exim -DABC= ...
3401 .endd
3402 To include spaces in a macro definition item, quotes must be used. If you use
3403 quotes, spaces are permitted around the macro name and the equals sign. For
3404 example:
3405 .display asis
3406 exim '-D ABC = something' ...
3407 .endd
3408 \-D-\ may be repeated up to 10 times on a command line.
3409
3410 .option d <<debug options>>
3411 .index debugging||list of selectors
3412 .index debugging||\-d-\ option
3413 This option causes debugging information to be written to the standard
3414 error stream. It is restricted to admin users because debugging output may show
3415 database queries that contain password information. Also, the details of users'
3416 filter files should be protected. When \-d-\ is used, \-v-\ is assumed. If
3417 \-d-\ is given on its own, a lot of standard debugging data is output. This can
3418 be reduced, or increased to include some more rarely needed information, by
3419 following \-d-\ with a string made up of names preceded by plus or minus
3420 characters. These add or remove sets of debugging data, respectively. For
3421 example, \-d+filter-\ adds filter debugging, whereas \-d-all+filter-\ selects
3422 only filter debugging. The available debugging categories are:
3423 .display flow
3424 .tabs 21
3425 .
3426 . The odd formatting of the lines below is deliberate. It does not affect the
3427 . SGCAL output, but by putting in the space it keeps things aligned in the man
3428 . page that is automatically generated from this text.
3429 .
3430 acl           $t $rm{ACL interpretation}
3431 auth          $t $rm{authenticators}
3432 deliver       $t $rm{general delivery logic}
3433 dns           $t $rm{DNS lookups (see also resolver)}
3434 dnsbl         $t $rm{DNS black list (aka RBL) code}
3435 exec          $t $rm{arguments for \execv@(@)\ calls}
3436 expand        $t $rm{detailed debugging for string expansions}
3437 filter        $t $rm{filter handling}
3438 hints@_lookup  $t $rm{hints data lookups}
3439 host@_lookup   $t $rm{all types of name-to-IP address handling}
3440 ident         $t $rm{ident lookup}
3441 interface     $t $rm{lists of local interfaces}
3442 lists         $t $rm{matching things in lists}
3443 load          $t $rm{system load checks}
3444 local@_scan    $t $rm{can be used by \*local@_scan()*\ (see chapter ~~CHAPlocalscan)}
3445 lookup        $t $rm{general lookup code and all lookups}
3446 memory        $t $rm{memory handling}
3447 pid           $t $rm{add pid to debug output lines}
3448 process@_info  $t $rm{setting info for the process log}
3449 queue@_run     $t $rm{queue runs}
3450 receive       $t $rm{general message reception logic}
3451 resolver      $t $rm{turn on the DNS resolver's debugging output}
3452 retry         $t $rm{retry handling}
3453 rewrite       $t $rm{address rewriting}
3454 route         $t $rm{address routing}
3455 timestamp     $t $rm{add timestamp to debug output lines}
3456 tls           $t $rm{TLS logic}
3457 transport     $t $rm{transports}
3458 uid           $t $rm{changes of uid/gid and looking up uid/gid}
3459 verify        $t $rm{address verification logic}
3460
3461 all           $t $rm{all of the above, and also \-v-\}
3462 .endd
3463 .index resolver, debugging output
3464 .index DNS||resolver, debugging output
3465 The \"resolver"\ option produces output only if the DNS resolver was compiled
3466 with \\DEBUG\\ enabled. This is not the case in some operating systems. Also,
3467 unfortunately, debugging output from the DNS resolver is written to stdout
3468 rather than stderr.
3469
3470 The default (\-d-\ with no argument) omits \"expand"\, \"filter"\,
3471 \"interface"\, \"load"\, \"memory"\, \"pid"\, \"resolver"\, and \"timestamp"\.
3472 However, the \"pid"\ selector is forced when debugging is turned on for a
3473 daemon, which then passes it on to any re-executed Exims. Exim also
3474 automatically adds the pid to debug lines when several remote deliveries are
3475 run in parallel.
3476
3477 The \"timestamp"\ selector causes the current time to be inserted at the start
3478 of all debug output lines. This can be useful when trying to track down delays
3479 in processing.
3480
3481 If the \debug@_print\ option is set in any driver, it produces output whenever
3482 any debugging is selected, or if \-v-\ is used.
3483
3484 .em
3485 .option dd <<debug options>>
3486 This option behaves exactly like \-d-\ except when used on a command that
3487 starts a daemon process. In that case, debugging is turned off for the
3488 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3489 behaviour of the daemon without creating as much output as full debugging does.
3490 .nem
3491
3492 .option dropcr
3493 This is an obsolete option that is now a no-op. It used to affect the way Exim
3494 handled CR and LF characters in incoming messages. What happens now is
3495 described in section ~~SECTlineendings.
3496
3497
3498 .option E
3499 .index bounce message||generating
3500 This option specifies that an incoming message is a locally-generated delivery
3501 failure report. It is used internally by Exim when handling delivery failures
3502 and is not intended for external use. Its only effect is to stop Exim
3503 generating certain messages to the postmaster, as otherwise message cascades
3504 could occur in some situations. As part of the same option, a message id may
3505 follow the characters \-E-\. If it does, the log entry for the receipt of the
3506 new message contains the id, following `R=', as a cross-reference.
3507
3508 .option e$it{x}
3509 There are a number of Sendmail options starting with \-oe-\ which seem to be
3510 called by various programs without the leading \o\ in the option. For example,
3511 the \vacation\ program uses \-eq-\. Exim treats all options of the form
3512 \-e$it{x}-\ as synonymous with the corresponding \-oe$it{x}-\ options.
3513
3514 .option F #<<string>>
3515 .index sender||name
3516 .index name||of sender
3517 This option sets the sender's full name for use when a locally-generated
3518 message is being accepted. In the absence of this option, the user's \*gecos*\
3519 entry from the password data is used. As users are generally permitted to alter
3520 their \*gecos*\ entries, no security considerations are involved. White space
3521 between \-F-\ and the <<string>> is optional.
3522
3523 .option f #<<address>>
3524 .index sender||address
3525 .index address||sender
3526 .index trusted user
3527 .index envelope sender
3528 .index user||trusted
3529 This option sets the address of the envelope sender of a locally-generated
3530 message (also known as the return path). The option can normally be used only
3531 by a trusted user, but \untrusted@_set@_sender\ can be set to allow untrusted
3532 users to use it. 
3533 .em
3534 Processes running as root or the Exim user are always trusted. Other
3535 trusted users are defined by the \trusted@_users\ or \trusted@_groups\ options.
3536
3537 In the absence of \-f-\, or if the caller is not trusted, the sender of a local
3538 message is set to the caller's login name at the default qualify domain.
3539
3540 There is one exception to the restriction on the use of \-f-\: an empty sender
3541 can be specified by any user, trusted or not,
3542 .nem
3543 to create a message that can never provoke a bounce. An empty sender can be
3544 specified either as an empty string, or as a pair of angle brackets with
3545 nothing between them, as in these examples of shell commands:
3546 .display asis
3547 exim -f '<>' user@domain
3548 exim -f "" user@domain
3549 .endd
3550 In addition, the use of \-f-\ is not restricted when testing a filter file with
3551 \-bf-\ or when testing or verifying addresses using the \-bt-\ or \-bv-\
3552 options.
3553
3554 Allowing untrusted users to change the sender address does not of itself make
3555 it possible to send anonymous mail. Exim still checks that the ::From:: header
3556 refers to the local user, and if it does not, it adds a ::Sender:: header,
3557 though this can be overridden by setting \no@_local@_from@_check\.
3558
3559 .index `From' line
3560 White space between \-f-\ and the <<address>> is optional
3561 (that is, they can be given as two arguments or one combined argument).
3562 The sender of a locally-generated message can also be set (when permitted) by
3563 an initial `From ' line in the message -- see the description of \-bm-\ above
3564 -- but if \-f-\ is also present, it overrides `From'.
3565
3566 .option G
3567 .index Sendmail compatibility||\-G-\ option ignored
3568 This is a Sendmail option which is ignored by Exim.
3569
3570 .option h #<<number>>
3571 .index Sendmail compatibility||\-h-\ option ignored
3572 This option is accepted for compatibility with Sendmail, but has no effect. (In
3573 Sendmail it overrides the `hop count' obtained by counting ::Received::
3574 headers.)
3575
3576 .option i
3577 .index Solaris||\*mail*\ command
3578 .index dot||in incoming, non-SMTP message
3579 This option, which has the same effect as \-oi-\, specifies that a dot on a
3580 line by itself should not terminate an incoming, non-SMTP message. I can find
3581 no documentation for this option in Solaris 2.4 Sendmail, but the \*mailx*\
3582 command in Solaris 2.4 uses it. See also \-ti-\.
3583
3584 .option M #<<message id>>#<<message id>> ...
3585 .index forcing delivery
3586 .index delivery||forcing attempt
3587 .index frozen messages||forcing delivery
3588 This option requests Exim to run a delivery attempt on each message in turn. If
3589 any of the messages are frozen, they are automatically thawed before the
3590 delivery attempt. The settings of \queue@_domains\, \queue@_smtp@_domains\, and
3591 \hold@_domains\ are ignored.
3592 .index hints database||overriding retry hints
3593 Retry hints for any of the addresses are
3594 overridden -- Exim tries to deliver even if the normal retry time has not yet
3595 been reached. This option requires the caller to be an admin user. However,
3596 there is an option called \prod@_requires@_admin\ which can be set false to
3597 relax this restriction (and also the same requirement for the \-q-\, \-R-\, and
3598 \-S-\ options).
3599
3600
3601 .option Mar #<<message id>>#<<address>>#<<address>> ...
3602 .index message||adding recipients
3603 .index recipient||adding
3604 This option requests Exim to add the addresses to the list of recipients of the
3605 message (`ar' for `add recipients'). The first argument must be a message id,
3606 and the remaining ones must be email addresses. However, if the message is
3607 active (in the middle of a delivery attempt), it is not altered. This option
3608 can be used only by an admin user.
3609
3610 .index SMTP||passed connection
3611 .index SMTP||multiple deliveries
3612 .index multiple SMTP deliveries
3613 .option MC #<<transport>>#<<hostname>>#<<sequence number>>#<<message id>>
3614 This option is not intended for use by external callers. It is used internally
3615 by Exim to invoke another instance of itself to deliver a waiting message using
3616 an existing SMTP connection, which is passed as the standard input. Details are
3617 given in chapter ~~CHAPSMTP. This must be the final option, and the caller must
3618 be root or the Exim user in order to use it.
3619
3620 .option MCA
3621 This option is not intended for use by external callers. It is used internally
3622 by Exim in conjunction with the \-MC-\ option. It signifies that the connection
3623 to the remote host has been authenticated.
3624
3625 .option MCP
3626 This option is not intended for use by external callers. It is used internally
3627 by Exim in conjunction with the \-MC-\ option. It signifies that the server to
3628 which Exim is connected supports pipelining.
3629
3630 .option MCQ #<<process id>> <<pipe fd>>
3631 This option is not intended for use by external callers. It is used internally
3632 by Exim in conjunction with the \-MC-\ option when the original delivery was
3633 started by a queue runner. It passes on the process id of the queue runner,
3634 together with the file descriptor number of an open pipe. Closure of the pipe
3635 signals the final completion of the sequence of processes that are passing
3636 messages through the same SMTP connection.
3637
3638 .option MCS
3639 This option is not intended for use by external callers. It is used internally
3640 by Exim in conjunction with the \-MC-\ option, and passes on the fact that the
3641 SMTP \\SIZE\\ option should be used on messages delivered down the existing
3642 connection.
3643
3644 .option MCT
3645 This option is not intended for use by external callers. It is used internally
3646 by Exim in conjunction with the \-MC-\ option, and passes on the fact that the
3647 host to which Exim is connected supports TLS encryption.
3648
3649 .option Mc #<<message id>>#<<message id>> ...
3650 .index hints database||not overridden by \-Mc-\
3651 .index delivery||manually started, not forced
3652 This option requests Exim to run a delivery attempt on each message in turn,
3653 but unlike the \-M-\ option, it does check for retry hints, and respects any
3654 that are found. This option is not very useful to external callers. It is
3655 provided mainly for internal use by Exim when it needs to re-invoke itself in
3656 order to regain root privilege for a delivery (see chapter ~~CHAPsecurity).
3657 However, \-Mc-\ can be useful when testing, in order to run a delivery that
3658 respects retry times and other options such as \hold@_domains\ that are
3659 overridden when \-M-\ is used. Such a delivery does not count as a queue run.
3660 If you want to run a specific delivery as if in a queue run, you should use
3661 \-q-\ with a message id argument. A distinction between queue run deliveries
3662 and other deliveries is made in one or two places.
3663
3664 .option Mes #<<message id>>#<<address>>
3665 .index message||changing sender
3666 .index sender||changing
3667 This option requests Exim to change the sender address in the message to the
3668 given address, which must be a fully qualified address or `<>' (`es' for `edit
3669 sender'). There must be exactly two arguments. The first argument must be a
3670 message id, and the second one an email address. However, if the message is
3671 active (in the middle of a delivery attempt), its status is not altered. This
3672 option can be used only by an admin user.
3673
3674 .option Mf #<<message id>>#<<message id>> ...
3675 .index freezing messages
3676 .index message||manually freezing
3677 This option requests Exim to mark each listed message as `frozen'. This
3678 prevents any delivery attempts taking place until the message is `thawed',
3679 either manually or as a result of the \auto@_thaw\ configuration option.
3680 However, if any of the messages are active (in the middle of a delivery
3681 attempt), their status is not altered. This option can be used only by an admin
3682 user.
3683
3684 .option Mg #<<message id>>#<<message id>> ...
3685 .index giving up on messages
3686 .index message||abandoning delivery attempts
3687 .index delivery||abandoning further attempts
3688 This option requests Exim to give up trying to deliver the listed messages,
3689 including any that are frozen. However, if any of the messages are active,
3690 their status is not altered.
3691 For non-bounce messages, a delivery error message is sent to the sender,
3692 containing the text `cancelled by administrator'. Bounce messages are just
3693 discarded.
3694 This option can be used only by an admin user.
3695
3696 .option Mmad #<<message id>>#<<message id>> ...
3697 .index delivery||cancelling all
3698 This option requests Exim to mark all the recipient addresses in the messages
3699 as already delivered (`mad' for `mark all delivered'). However, if any message
3700 is active (in the middle of a delivery attempt), its status is not altered.
3701 This option can be used only by an admin user.
3702
3703 .option Mmd #<<message id>>#<<address>>#<<address>> ...
3704 .index delivery||cancelling by address
3705 .index recipient||removing
3706 .index removing recipients
3707 This option requests Exim to mark the given addresses as already delivered
3708 (`md' for `mark delivered'). The first argument must be a message id, and the
3709 remaining ones must be email addresses. These are matched to recipient
3710 addresses in the message in a case-sensitive manner. If the message is active
3711 (in the middle of a delivery attempt), its status is not altered. This option
3712 can be used only by an admin user.
3713
3714 .option Mrm #<<message id>>#<<message id>> ...
3715 .index removing messages
3716 .index abandoning mail
3717 .index message||manually discarding
3718 This option requests Exim to remove the given messages from the queue. No
3719 bounce messages are sent; each message is simply forgotten. However, if any of
3720 the messages are active, their status is not altered. This option can be used
3721 only by an admin user or by the user who originally caused the message to be
3722 placed on the queue.
3723
3724 .option Mt #<<message id>>#<<message id>> ...
3725 .index thawing messages
3726 .index unfreezing messages
3727 .index frozen messages||thawing
3728 .index message||thawing frozen
3729 This option requests Exim to `thaw' any of the listed messages that are
3730 `frozen', so that delivery attempts can resume. However, if any of the messages
3731 are active, their status is not altered. This option can be used only by an
3732 admin user.
3733
3734 .option Mvb #<<message id>>
3735 .index listing||message body
3736 .index message||listing body of