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