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