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