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