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