« back to all changes in this revision
Viewing changes to .pc/31_eximmanpage.dpatch/doc/exim.8
- browse files at revision 33
- compare with another revision
- download diff
- download tarball
- view history from revision 33
- Committer: Bazaar Package Importer
- Author(s): Artur Rona
- Date: 2010-07-25 02:00:42 UTC
- mfrom: (2.1.7 sid)
- Revision ID: james.westby@ubuntu.com-20100725020042-bk1uw1p7ysmnsn9f
Tags: 4.72-1ubuntu1
* Merge with Debian unstable (LP: #609620). Remaining changes:
+ debian/patches/71_exiq_grep_error_on_messages_without_size.dpatch:
Improve handling of broken messages when "exim4 -bp" (mailq) reports
lines without size info.
+ Don't declare a Provides: default-mta; in Ubuntu, we want postfix to be
the default.
+ debian/control: Change build dependencies to MySQL 5.1.
+ debian/{control,rules}: add and enable hardened build for PIE
(Closes: #542726).
+ debian/patches/71_exiq_grep_error_on_messages_without_size.dpatch:
Improve handling of broken messages when "exim4 -bp" (mailq) reports
lines without size info.
+ Don't declare a Provides: default-mta; in Ubuntu, we want postfix to be
the default.
+ debian/control: Change build dependencies to MySQL 5.1.
+ debian/{control,rules}: add and enable hardened build for PIE
(Closes: #542726).
- files added:
- .pc
- .pc/30_dontoverridecflags.dpatch
- .pc/30_dontoverridecflags.dpatch/OS
- .pc/31_eximmanpage.dpatch
- .pc/31_eximmanpage.dpatch/doc
- .pc/32_exim4.dpatch
- .pc/32_exim4.dpatch/OS
- .pc/32_exim4.dpatch/src
- .pc/33_eximon.binary.dpatch
- .pc/33_eximon.binary.dpatch/OS
- .pc/34_eximstatsmanpage.dpatch
- .pc/34_eximstatsmanpage.dpatch/src
- .pc/35_install.dpatch
- .pc/35_install.dpatch/scripts
- .pc/50_localscan_dlopen.dpatch
- .pc/50_localscan_dlopen.dpatch/src
- .pc/60_convert4r4.dpatch
- .pc/60_convert4r4.dpatch/src
- .pc/66_enlarge-dh-parameters-size.dpatch
- .pc/66_enlarge-dh-parameters-size.dpatch/src
- .pc/70_remove_exim-users_references.dpatch
- .pc/70_remove_exim-users_references.dpatch/src
- .pc/71_exiq_grep_error_on_messages_without_size.dpatch
- .pc/71_exiq_grep_error_on_messages_without_size.dpatch/src
- files removed:
- debian/exim4-daemon-heavy-dbg.install
- debian/lintian
- debian/lintian/overrides
- files modified:
- OS/Makefile-NetBSD
added
removed
.pc/31_eximmanpage.dpatch/doc/exim.8
1
.TH EXIM 8
2
.SH NAME
3
exim \- a Mail Transfer Agent
4
.SH SYNOPSIS
5
.nf
6
.B exim [options] arguments ...
7
.B mailq [options] arguments ...
8
.B rsmtp [options] arguments ...
9
.B rmail [options] arguments ...
10
.B runq [options] arguments ...
11
.B newaliases [options] arguments ...
12
.fi
13
.
14
.SH DESCRIPTION
15
.rs
16
.sp
17
Exim is a mail transfer agent (MTA) developed at the University of Cambridge.
18
It is a large program with very many facilities. For a full specification, see
19
the reference manual. This man page contains only a description of the command
20
line options. It has been automatically generated from the reference manual
21
source, hopefully without too much mangling.
22
.P
23
Like other MTAs, Exim replaces Sendmail, and is normally called by user agents
24
(MUAs) using the path \fI/usr/sbin/sendmail\fP when they submit messages for
25
delivery (some operating systems use \fI/usr/lib/sendmail\fP). This path is
26
normally set up as a symbolic link to the Exim binary. It may also be used by
27
boot scripts to start the Exim daemon. Many of Exim's command line options are
28
compatible with Sendmail so that it can act as a drop-in replacement.
29
.
30
.SH "DEFAULT ACTION"
31
.rs
32
.sp
33
If no options are present that require a specific action (such as starting the
34
daemon or a queue runner, testing an address, receiving a message in a specific
35
format, or listing the queue), and there are no arguments on the command line,
36
Exim outputs a brief message about itself and exits.
37
.sp
38
However, if there is at least one command line argument, \fB-bm\fR (accept a
39
local message on the standard input, with the arguments specifying the
40
recipients) is assumed. Thus, for example, if Exim is installed in
41
\fI/usr/sbin\fP, you can send a message from the command line like this:
42
.sp
43
/usr/sbin/exim -i <recipient-address(es)>
44
<message content, including all the header lines>
45
CTRL-D
46
.sp
47
The \fB-i\fP option prevents a line containing just a dot from terminating
48
the message. Only an end-of-file (generated by typing CTRL-D if the input is
49
from a terminal) does so.
50
.
51
.SH "SETTING OPTIONS BY PROGRAM NAME"
52
.rs
53
.sp
54
If an Exim binary is called using one of the names listed in this section
55
(typically via a symbolic link), certain options are assumed.
56
.TP
57
\fBmailq\fR
58
Behave as if the option \fB\-bp\fP were present before any other options.
59
The \fB\-bp\fP option requests a listing of the contents of the mail queue
60
on the standard output.
61
.TP
62
\fBrsmtp\fR
63
Behaves as if the option \fB\-bS\fP were present before any other options,
64
for compatibility with Smail. The \fB\-bS\fP option is used for reading in a
65
number of messages in batched SMTP format.
66
.TP
67
\fBrmail\fR
68
Behave as if the \fB\-i\fP and \fB\-oee\fP options were present before
69
any other options, for compatibility with Smail. The name \fBrmail\fR is used
70
as an interface by some UUCP systems. The \fB\-i\fP option specifies that a
71
dot on a line by itself does not terminate a non\-SMTP message; \fB\-oee\fP
72
requests that errors detected in non\-SMTP messages be reported by emailing
73
the sender.
74
.TP
75
\fBrunq\fR
76
Behave as if the option \fB\-q\fP were present before any other options, for
77
compatibility with Smail. The \fB\-q\fP option causes a single queue runner
78
process to be started. It processes the queue once, then exits.
79
.TP
80
\fBnewaliases\fR
81
Behave as if the option \fB\-bi\fP were present before any other options,
82
for compatibility with Sendmail. This option is used for rebuilding Sendmail's
83
alias file. Exim does not have the concept of a single alias file, but can be
84
configured to run a specified command if called with the \fB\-bi\fP option.
85
.
86
.SH "OPTIONS"
87
.rs
88
.TP 10
89
\fB\-\-\fP
90
This is a pseudo\-option whose only purpose is to terminate the options and
91
therefore to cause subsequent command line items to be treated as arguments
92
rather than options, even if they begin with hyphens.
93
.TP 10
94
\fB\-\-help\fP
95
This option causes Exim to output a few sentences stating what it is.
96
The same output is generated if the Exim binary is called with no options and
97
no arguments.
98
.TP 10
99
\fB\-B\fP<\fItype\fP>
100
This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8\-bit
101
clean; it ignores this option.
102
.TP 10
103
\fB\-bd\fP
104
This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
105
the \fB\-bd\fP option is combined with the \fB\-q\fP<\fItime\fP> option, to specify
106
that the daemon should also initiate periodic queue runs.
107
.sp
108
The \fB\-bd\fP option can be used only by an admin user. If either of the \fB\-d\fP
109
(debugging) or \fB\-v\fP (verifying) options are set, the daemon does not
110
disconnect from the controlling terminal. When running this way, it can be
111
stopped by pressing ctrl\-C.
112
.sp
113
By default, Exim listens for incoming connections to the standard SMTP port on
114
all the host's running interfaces. However, it is possible to listen on other
115
ports, on multiple ports, and only on specific interfaces.
116
.sp
117
When a listening daemon
118
is started without the use of \fB\-oX\fP (that is, without overriding the normal
119
configuration), it writes its process id to a file called exim\-daemon.pid
120
in Exim's spool directory. This location can be overridden by setting
121
PID_FILE_PATH in Local/Makefile. The file is written while Exim is still
122
running as root.
123
.sp
124
When \fB\-oX\fP is used on the command line to start a listening daemon, the
125
process id is not written to the normal pid file path. However, \fB\-oP\fP can be
126
used to specify a path on the command line if a pid file is required.
127
.sp
128
The SIGHUP signal
129
can be used to cause the daemon to re\-execute itself. This should be done
130
whenever Exim's configuration file, or any file that is incorporated into it by
131
means of the \fB.include\fP facility, is changed, and also whenever a new version
132
of Exim is installed. It is not necessary to do this when other files that are
133
referenced from the configuration (for example, alias files) are changed,
134
because these are reread each time they are used.
135
.TP 10
136
\fB\-bdf\fP
137
This option has the same effect as \fB\-bd\fP except that it never disconnects
138
from the controlling terminal, even when no debugging is specified.
139
.TP 10
140
\fB\-be\fP
141
Run Exim in expansion testing mode. Exim discards its root privilege, to
142
prevent ordinary users from using this mode to read otherwise inaccessible
143
files. If no arguments are given, Exim runs interactively, prompting for lines
144
of data. Otherwise, it processes each argument in turn.
145
.sp
146
If Exim was built with USE_READLINE=yes in Local/Makefile, it tries
147
to load the \fBlibreadline\fP library dynamically whenever the \fB\-be\fP option is
148
used without command line arguments. If successful, it uses the readline()
149
function, which provides extensive line\-editing facilities, for reading the
150
test data. A line history is supported.
151
.sp
152
Long expansion expressions can be split over several lines by using backslash
153
continuations. As in Exim's run time configuration, white space at the start of
154
continuation lines is ignored. Each argument or data line is passed through the
155
string expansion mechanism, and the result is output. Variable values from the
156
configuration file (for example, \fI$qualify_domain\fP) are available, but no
157
message\-specific values (such as \fI$sender_domain\fP) are set, because no message
158
is being processed (but see \fB\-bem\fP and \fB\-Mset\fP).
159
.sp
160
\fBNote\fP: If you use this mechanism to test lookups, and you change the data
161
files or databases you are using, you must exit and restart Exim before trying
162
the same lookup again. Otherwise, because each Exim process caches the results
163
of lookups, you will just get the same result as before.
164
.TP 10
165
\fB\-bem\fP <\fIfilename\fP>
166
This option operates like \fB\-be\fP except that it must be followed by the name
167
of a file. For example:
168
.sp
169
exim \-bem /tmp/testmessage
170
.sp
171
The file is read as a message (as if receiving a locally\-submitted non\-SMTP
172
message) before any of the test expansions are done. Thus, message\-specific
173
variables such as \fI$message_size\fP and \fI$header_from:\fP are available. However,
174
no \fIReceived:\fP header is added to the message. If the \fB\-t\fP option is set,
175
recipients are read from the headers in the normal way, and are shown in the
176
\fI$recipients\fP variable. Note that recipients cannot be given on the command
177
line, because further arguments are taken as strings to expand (just like
178
\fB\-be\fP).
179
.TP 10
180
\fB\-bF\fP <\fIfilename\fP>
181
This option is the same as \fB\-bf\fP except that it assumes that the filter being
182
tested is a system filter. The additional commands that are available only in
183
system filters are recognized.
184
.TP 10
185
\fB\-bf\fP <\fIfilename\fP>
186
This option runs Exim in user filter testing mode; the file is the filter file
187
to be tested, and a test message must be supplied on the standard input. If
188
there are no message\-dependent tests in the filter, an empty file can be
189
supplied.
190
.sp
191
If you want to test a system filter file, use \fB\-bF\fP instead of \fB\-bf\fP. You
192
can use both \fB\-bF\fP and \fB\-bf\fP on the same command, in order to test a system
193
filter and a user filter in the same run. For example:
194
.sp
195
exim \-bF /system/filter \-bf /user/filter </test/message
196
.sp
197
This is helpful when the system filter adds header lines or sets filter
198
variables that are used by the user filter.
199
.sp
200
If the test filter file does not begin with one of the special lines
201
.sp
202
# Exim filter
203
# Sieve filter
204
.sp
205
it is taken to be a normal .forward file, and is tested for validity under
206
that interpretation.
207
.sp
208
The result of an Exim command that uses \fB\-bf\fP, provided no errors are
209
detected, is a list of the actions that Exim would try to take if presented
210
with the message for real. More details of filter testing are given in the
211
separate document entitled \fIExim's interfaces to mail filtering\fP.
212
.sp
213
When testing a filter file,
214
the envelope sender can be set by the \fB\-f\fP option,
215
or by a "From " line at the start of the test message. Various parameters
216
that would normally be taken from the envelope recipient address of the message
217
can be set by means of additional command line options (see the next four
218
options).
219
.TP 10
220
\fB\-bfd\fP <\fIdomain\fP>
221
This sets the domain of the recipient address when a filter file is being
222
tested by means of the \fB\-bf\fP option. The default is the value of
223
\fI$qualify_domain\fP.
224
.TP 10
225
\fB\-bfl\fP <\fIlocal part\fP>
226
This sets the local part of the recipient address when a filter file is being
227
tested by means of the \fB\-bf\fP option. The default is the username of the
228
process that calls Exim. A local part should be specified with any prefix or
229
suffix stripped, because that is how it appears to the filter when a message is
230
actually being delivered.
231
.TP 10
232
\fB\-bfp\fP <\fIprefix\fP>
233
This sets the prefix of the local part of the recipient address when a filter
234
file is being tested by means of the \fB\-bf\fP option. The default is an empty
235
prefix.
236
.TP 10
237
\fB\-bfs\fP <\fIsuffix\fP>
238
This sets the suffix of the local part of the recipient address when a filter
239
file is being tested by means of the \fB\-bf\fP option. The default is an empty
240
suffix.
241
.TP 10
242
\fB\-bh\fP <\fIIP address\fP>
243
This option runs a fake SMTP session as if from the given IP address, using the
244
standard input and output. The IP address may include a port number at the end,
245
after a full stop. For example:
246
.sp
247
exim \-bh 10.9.8.7.1234
248
exim \-bh fe80::a00:20ff:fe86:a061.5678
249
.sp
250
When an IPv6 address is given, it is converted into canonical form. In the case
251
of the second example above, the value of \fI$sender_host_address\fP after
252
conversion to the canonical form is
253
fe80:0000:0000:0a00:20ff:fe86:a061.5678.
254
.sp
255
Comments as to what is going on are written to the standard error file. These
256
include lines beginning with "LOG" for anything that would have been logged.
257
This facility is provided for testing configuration options for incoming
258
messages, to make sure they implement the required policy. For example, you can
259
test your relay controls using \fB\-bh\fP.
260
.sp
261
\fBWarning 1\fP:
262
You can test features of the configuration that rely on ident (RFC 1413)
263
information by using the \fB\-oMt\fP option. However, Exim cannot actually perform
264
an ident callout when testing using \fB\-bh\fP because there is no incoming SMTP
265
connection.
266
.sp
267
\fBWarning 2\fP: Address verification callouts
268
are also skipped when testing using \fB\-bh\fP. If you want these callouts to
269
occur, use \fB\-bhc\fP instead.
270
.sp
271
Messages supplied during the testing session are discarded, and nothing is
272
written to any of the real log files. There may be pauses when DNS (and other)
273
lookups are taking place, and of course these may time out. The \fB\-oMi\fP option
274
can be used to specify a specific IP interface and port if this is important,
275
and \fB\-oMaa\fP and \fB\-oMai\fP can be used to set parameters as if the SMTP
276
session were authenticated.
277
.sp
278
The \fIexim_checkaccess\fP utility is a "packaged" version of \fB\-bh\fP whose
279
output just states whether a given recipient address from a given host is
280
acceptable or not.
281
.sp
282
Features such as authentication and encryption, where the client input is not
283
plain text, cannot easily be tested with \fB\-bh\fP. Instead, you should use a
284
specialized SMTP test program such as
285
\fBswaks\fP.
286
.TP 10
287
\fB\-bhc\fP <\fIIP address\fP>
288
This option operates in the same way as \fB\-bh\fP, except that address
289
verification callouts are performed if required. This includes consulting and
290
updating the callout cache database.
291
.TP 10
292
\fB\-bi\fP
293
Sendmail interprets the \fB\-bi\fP option as a request to rebuild its alias file.
294
Exim does not have the concept of a single alias file, and so it cannot mimic
295
this behaviour. However, calls to /usr/lib/sendmail with the \fB\-bi\fP option
296
tend to appear in various scripts such as NIS make files, so the option must be
297
recognized.
298
.sp
299
If \fB\-bi\fP is encountered, the command specified by the \fBbi_command\fP
300
configuration option is run, under the uid and gid of the caller of Exim. If
301
the \fB\-oA\fP option is used, its value is passed to the command as an argument.
302
The command set by \fBbi_command\fP may not contain arguments. The command can
303
use the \fIexim_dbmbuild\fP utility, or some other means, to rebuild alias files
304
if this is required. If the \fBbi_command\fP option is not set, calling Exim with
305
\fB\-bi\fP is a no\-op.
306
.TP 10
307
\fB\-bm\fP
308
This option runs an Exim receiving process that accepts an incoming,
309
locally\-generated message on the current input. The recipients are given as the
310
command arguments (except when \fB\-t\fP is also present \- see below). Each
311
argument can be a comma\-separated list of RFC 2822 addresses. This is the
312
default option for selecting the overall action of an Exim call; it is assumed
313
if no other conflicting option is present.
314
.sp
315
If any addresses in the message are unqualified (have no domain), they are
316
qualified by the values of the \fBqualify_domain\fP or \fBqualify_recipient\fP
317
options, as appropriate. The \fB\-bnq\fP option (see below) provides a way of
318
suppressing this for special cases.
319
.sp
320
Policy checks on the contents of local messages can be enforced by means of
321
the non\-SMTP ACL.
322
.sp
323
The return code is zero if the message is successfully accepted. Otherwise, the
324
action is controlled by the \fB\-oe\fP\fIx\fP option setting \- see below.
325
.sp
326
The format
327
of the message must be as defined in RFC 2822, except that, for
328
compatibility with Sendmail and Smail, a line in one of the forms
329
.sp
330
From sender Fri Jan 5 12:55 GMT 1997
331
From sender Fri, 5 Jan 97 12:55:01
332
.sp
333
(with the weekday optional, and possibly with additional text after the date)
334
is permitted to appear at the start of the message. There appears to be no
335
authoritative specification of the format of this line. Exim recognizes it by
336
matching against the regular expression defined by the \fBuucp_from_pattern\fP
337
option, which can be changed if necessary.
338
.sp
339
The specified sender is treated as if it were given as the argument to the
340
\fB\-f\fP option, but if a \fB\-f\fP option is also present, its argument is used in
341
preference to the address taken from the message. The caller of Exim must be a
342
trusted user for the sender of a message to be set in this way.
343
.TP 10
344
\fB\-bnq\fP
345
By default, Exim automatically qualifies unqualified addresses (those
346
without domains) that appear in messages that are submitted locally (that
347
is, not over TCP/IP). This qualification applies both to addresses in
348
envelopes, and addresses in header lines. Sender addresses are qualified using
349
\fBqualify_domain\fP, and recipient addresses using \fBqualify_recipient\fP (which
350
defaults to the value of \fBqualify_domain\fP).
351
.sp
352
Sometimes, qualification is not wanted. For example, if \fB\-bS\fP (batch SMTP) is
353
being used to re\-submit messages that originally came from remote hosts after
354
content scanning, you probably do not want to qualify unqualified addresses in
355
header lines. (Such lines will be present only if you have not enabled a header
356
syntax check in the appropriate ACL.)
357
.sp
358
The \fB\-bnq\fP option suppresses all qualification of unqualified addresses in
359
messages that originate on the local host. When this is used, unqualified
360
addresses in the envelope provoke errors (causing message rejection) and
361
unqualified addresses in header lines are left alone.
362
.TP 10
363
\fB\-bP\fP
364
If this option is given with no arguments, it causes the values of all Exim's
365
main configuration options to be written to the standard output. The values
366
of one or more specific options can be requested by giving their names as
367
arguments, for example:
368
.sp
369
exim \-bP qualify_domain hold_domains
370
.sp
371
However, any option setting that is preceded by the word "hide" in the
372
configuration file is not shown in full, except to an admin user. For other
373
users, the output is as in this example:
374
.sp
375
mysql_servers = <value not displayable>
376
.sp
377
If \fBconfigure_file\fP is given as an argument, the name of the run time
378
configuration file is output.
379
If a list of configuration files was supplied, the value that is output here
380
is the name of the file that was actually used.
381
.sp
382
If \fBlog_file_path\fP or \fBpid_file_path\fP are given, the names of the
383
directories where log files and daemon pid files are written are output,
384
respectively. If these values are unset, log files are written in a
385
sub\-directory of the spool directory called \fBlog\fP, and the pid file is
386
written directly into the spool directory.
387
.sp
388
If \fB\-bP\fP is followed by a name preceded by +, for example,
389
.sp
390
exim \-bP +local_domains
391
.sp
392
it searches for a matching named list of any type (domain, host, address, or
393
local part) and outputs what it finds.
394
.sp
395
If one of the words \fBrouter\fP, \fBtransport\fP, or \fBauthenticator\fP is given,
396
followed by the name of an appropriate driver instance, the option settings for
397
that driver are output. For example:
398
.sp
399
exim \-bP transport local_delivery
400
.sp
401
The generic driver options are output first, followed by the driver's private
402
options. A list of the names of drivers of a particular type can be obtained by
403
using one of the words \fBrouter_list\fP, \fBtransport_list\fP, or
404
\fBauthenticator_list\fP, and a complete list of all drivers with their option
405
settings can be obtained by using \fBrouters\fP, \fBtransports\fP, or
406
\fBauthenticators\fP.
407
.sp
408
If invoked by an admin user, then \fBmacro\fP, \fBmacro_list\fP and \fBmacros\fP
409
are available, similarly to the drivers. Because macros are sometimes used
410
for storing passwords, this option is restricted.
411
The output format is one item per line.
412
.TP 10
413
\fB\-bp\fP
414
This option requests a listing of the contents of the mail queue on the
415
standard output. If the \fB\-bp\fP option is followed by a list of message ids,
416
just those messages are listed. By default, this option can be used only by an
417
admin user. However, the \fBqueue_list_requires_admin\fP option can be set false
418
to allow any user to see the queue.
419
.sp
420
Each message on the queue is displayed as in the following example:
421
.sp
422
25m 2.9K 0t5C6f\-0000c8\-00 <alice@wonderland.fict.example>
423
red.king@looking\-glass.fict.example
424
<other addresses>
425
.sp
426
The first line contains the length of time the message has been on the queue
427
(in this case 25 minutes), the size of the message (2.9K), the unique local
428
identifier for the message, and the message sender, as contained in the
429
envelope. For bounce messages, the sender address is empty, and appears as
430
"<>". If the message was submitted locally by an untrusted user who overrode
431
the default sender address, the user's login name is shown in parentheses
432
before the sender address.
433
.sp
434
If the message is frozen (attempts to deliver it are suspended) then the text
435
"*** frozen ***" is displayed at the end of this line.
436
.sp
437
The recipients of the message (taken from the envelope, not the headers) are
438
displayed on subsequent lines. Those addresses to which the message has already
439
been delivered are marked with the letter D. If an original address gets
440
expanded into several addresses via an alias or forward file, the original is
441
displayed with a D only when deliveries for all of its child addresses are
442
complete.
443
.TP 10
444
\fB\-bpa\fP
445
This option operates like \fB\-bp\fP, but in addition it shows delivered addresses
446
that were generated from the original top level address(es) in each message by
447
alias or forwarding operations. These addresses are flagged with "+D" instead
448
of just "D".
449
.TP 10
450
\fB\-bpc\fP
451
This option counts the number of messages on the queue, and writes the total
452
to the standard output. It is restricted to admin users, unless
453
\fBqueue_list_requires_admin\fP is set false.
454
.TP 10
455
\fB\-bpr\fP
456
This option operates like \fB\-bp\fP, but the output is not sorted into
457
chronological order of message arrival. This can speed it up when there are
458
lots of messages on the queue, and is particularly useful if the output is
459
going to be post\-processed in a way that doesn't need the sorting.
460
.TP 10
461
\fB\-bpra\fP
462
This option is a combination of \fB\-bpr\fP and \fB\-bpa\fP.
463
.TP 10
464
\fB\-bpru\fP
465
This option is a combination of \fB\-bpr\fP and \fB\-bpu\fP.
466
.TP 10
467
\fB\-bpu\fP
468
This option operates like \fB\-bp\fP but shows only undelivered top\-level
469
addresses for each message displayed. Addresses generated by aliasing or
470
forwarding are not shown, unless the message was deferred after processing by a
471
router with the \fBone_time\fP option set.
472
.TP 10
473
\fB\-brt\fP
474
This option is for testing retry rules, and it must be followed by up to three
475
arguments. It causes Exim to look for a retry rule that matches the values
476
and to write it to the standard output. For example:
477
.sp
478
exim \-brt bach.comp.mus.example
479
Retry rule: *.comp.mus.example F,2h,15m; F,4d,30m;
480
.sp
481
The first
482
argument, which is required, can be a complete address in the form
483
\fIlocal_part@domain\fP, or it can be just a domain name. If the second argument
484
contains a dot, it is interpreted as an optional second domain name; if no
485
retry rule is found for the first argument, the second is tried. This ties in
486
with Exim's behaviour when looking for retry rules for remote hosts \- if no
487
rule is found that matches the host, one that matches the mail domain is
488
sought. Finally, an argument that is the name of a specific delivery error, as
489
used in setting up retry rules, can be given. For example:
490
.sp
491
exim \-brt haydn.comp.mus.example quota_3d
492
Retry rule: *@haydn.comp.mus.example quota_3d F,1h,15m
493
.TP 10
494
\fB\-brw\fP
495
This option is for testing address rewriting rules, and it must be followed by
496
a single argument, consisting of either a local part without a domain, or a
497
complete address with a fully qualified domain. Exim outputs how this address
498
would be rewritten for each possible place it might appear.
499
.TP 10
500
\fB\-bS\fP
501
This option is used for batched SMTP input, which is an alternative interface
502
for non\-interactive local message submission. A number of messages can be
503
submitted in a single run. However, despite its name, this is not really SMTP
504
input. Exim reads each message's envelope from SMTP commands on the standard
505
input, but generates no responses. If the caller is trusted, or
506
\fBuntrusted_set_sender\fP is set, the senders in the SMTP MAIL commands are
507
believed; otherwise the sender is always the caller of Exim.
508
.sp
509
The message itself is read from the standard input, in SMTP format (leading
510
dots doubled), terminated by a line containing just a single dot. An error is
511
provoked if the terminating dot is missing. A further message may then follow.
512
.sp
513
As for other local message submissions, the contents of incoming batch SMTP
514
messages can be checked using the non\-SMTP ACL.
515
Unqualified addresses are automatically qualified using \fBqualify_domain\fP and
516
\fBqualify_recipient\fP, as appropriate, unless the \fB\-bnq\fP option is used.
517
.sp
518
Some other SMTP commands are recognized in the input. HELO and EHLO act
519
as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
520
QUIT quits, ignoring the rest of the standard input.
521
.sp
522
If any error is encountered, reports are written to the standard output and
523
error streams, and Exim gives up immediately. The return code is 0 if no error
524
was detected; it is 1 if one or more messages were accepted before the error
525
was detected; otherwise it is 2.
526
.sp
527
.TP 10
528
\fB\-bs\fP
529
This option causes Exim to accept one or more messages by reading SMTP commands
530
on the standard input, and producing SMTP replies on the standard output. SMTP
531
policy controls, as defined in ACLs are applied.
532
Some user agents use this interface as a way of passing locally\-generated
533
messages to the MTA.
534
.sp
535
In
536
this usage, if the caller of Exim is trusted, or \fBuntrusted_set_sender\fP is
537
set, the senders of messages are taken from the SMTP MAIL commands.
538
Otherwise the content of these commands is ignored and the sender is set up as
539
the calling user. Unqualified addresses are automatically qualified using
540
\fBqualify_domain\fP and \fBqualify_recipient\fP, as appropriate, unless the
541
\fB\-bnq\fP option is used.
542
.sp
543
The
544
\fB\-bs\fP option is also used to run Exim from \fIinetd\fP, as an alternative to
545
using a listening daemon. Exim can distinguish the two cases by checking
546
whether the standard input is a TCP/IP socket. When Exim is called from
547
\fIinetd\fP, the source of the mail is assumed to be remote, and the comments
548
above concerning senders and qualification do not apply. In this situation,
549
Exim behaves in exactly the same way as it does when receiving a message via
550
the listening daemon.
551
.TP 10
552
\fB\-bt\fP
553
This option runs Exim in address testing mode, in which each argument is taken
554
as a recipient address to be tested for deliverability. The results are
555
written to the standard output. If a test fails, and the caller is not an admin
556
user, no details of the failure are output, because these might contain
557
sensitive information such as usernames and passwords for database lookups.
558
.sp
559
If no arguments are given, Exim runs in an interactive manner, prompting with a
560
right angle bracket for addresses to be tested.
561
.sp
562
Unlike the \fB\-be\fP test option, you cannot arrange for Exim to use the
563
readline() function, because it is running as \fIroot\fP and there are
564
security issues.
565
.sp
566
Each address is handled as if it were the recipient address of a message
567
(compare the \fB\-bv\fP option). It is passed to the routers and the result is
568
written to the standard output. However, any router that has
569
\fBno_address_test\fP set is bypassed. This can make \fB\-bt\fP easier to use for
570
genuine routing tests if your first router passes everything to a scanner
571
program.
572
.sp
573
The return code is 2 if any address failed outright; it is 1 if no address
574
failed outright but at least one could not be resolved for some reason. Return
575
code 0 is given only when all addresses succeed.
576
.sp
577
\fBNote\fP: When actually delivering a message, Exim removes duplicate recipient
578
addresses after routing is complete, so that only one delivery takes place.
579
This does not happen when testing with \fB\-bt\fP; the full results of routing are
580
always shown.
581
.sp
582
\fBWarning\fP: \fB\-bt\fP can only do relatively simple testing. If any of the
583
routers in the configuration makes any tests on the sender address of a
584
message,
585
you can use the \fB\-f\fP option to set an appropriate sender when running
586
\fB\-bt\fP tests. Without it, the sender is assumed to be the calling user at the
587
default qualifying domain. However, if you have set up (for example) routers
588
whose behaviour depends on the contents of an incoming message, you cannot test
589
those conditions using \fB\-bt\fP. The \fB\-N\fP option provides a possible way of
590
doing such tests.
591
.TP 10
592
\fB\-bV\fP
593
This option causes Exim to write the current version number, compilation
594
number, and compilation date of the \fIexim\fP binary to the standard output.
595
It also lists the DBM library this is being used, the optional modules (such as
596
specific lookup types), the drivers that are included in the binary, and the
597
name of the run time configuration file that is in use.
598
.sp
599
As part of its operation, \fB\-bV\fP causes Exim to read and syntax check its
600
configuration file. However, this is a static check only. It cannot check
601
values that are to be expanded. For example, although a misspelt ACL verb is
602
detected, an error in the verb's arguments is not. You cannot rely on \fB\-bV\fP
603
alone to discover (for example) all the typos in the configuration; some
604
realistic testing is needed. The \fB\-bh\fP and \fB\-N\fP options provide more
605
dynamic testing facilities.
606
.TP 10
607
\fB\-bv\fP
608
This option runs Exim in address verification mode, in which each argument is
609
taken as a recipient address to be verified by the routers. (This does
610
not involve any verification callouts). During normal operation, verification
611
happens mostly as a consequence processing a \fBverify\fP condition in an ACL. If you want to test an entire ACL, possibly
612
including callouts, see the \fB\-bh\fP and \fB\-bhc\fP options.
613
.sp
614
If verification fails, and the caller is not an admin user, no details of the
615
failure are output, because these might contain sensitive information such as
616
usernames and passwords for database lookups.
617
.sp
618
If no arguments are given, Exim runs in an interactive manner, prompting with a
619
right angle bracket for addresses to be verified.
620
.sp
621
Unlike the \fB\-be\fP test option, you cannot arrange for Exim to use the
622
readline() function, because it is running as \fIexim\fP and there are
623
security issues.
624
.sp
625
Verification differs from address testing (the \fB\-bt\fP option) in that routers
626
that have \fBno_verify\fP set are skipped, and if the address is accepted by a
627
router that has \fBfail_verify\fP set, verification fails. The address is
628
verified as a recipient if \fB\-bv\fP is used; to test verification for a sender
629
address, \fB\-bvs\fP should be used.
630
.sp
631
If the \fB\-v\fP option is not set, the output consists of a single line for each
632
address, stating whether it was verified or not, and giving a reason in the
633
latter case. Without \fB\-v\fP, generating more than one address by redirection
634
causes verification to end successfully, without considering the generated
635
addresses. However, if just one address is generated, processing continues,
636
and the generated address must verify successfully for the overall verification
637
to succeed.
638
.sp
639
When \fB\-v\fP is set, more details are given of how the address has been handled,
640
and in the case of address redirection, all the generated addresses are also
641
considered. Verification may succeed for some and fail for others.
642
.sp
643
The
644
return code is 2 if any address failed outright; it is 1 if no address
645
failed outright but at least one could not be resolved for some reason. Return
646
code 0 is given only when all addresses succeed.
647
.sp
648
If any of the routers in the configuration makes any tests on the sender
649
address of a message, you should use the \fB\-f\fP option to set an appropriate
650
sender when running \fB\-bv\fP tests. Without it, the sender is assumed to be the
651
calling user at the default qualifying domain.
652
.TP 10
653
\fB\-bvs\fP
654
This option acts like \fB\-bv\fP, but verifies the address as a sender rather
655
than a recipient address. This affects any rewriting and qualification that
656
might happen.
657
.TP 10
658
\fB\-C\fP <\fIfilelist\fP>
659
This option causes Exim to find the run time configuration file from the given
660
list instead of from the list specified by the CONFIGURE_FILE
661
compile\-time setting. Usually, the list will consist of just a single file
662
name, but it can be a colon\-separated list of names. In this case, the first
663
file that exists is used. Failure to open an existing file stops Exim from
664
proceeding any further along the list, and an error is generated.
665
.sp
666
When this option is used by a caller other than root or the Exim user, and the
667
list is different from the compiled\-in list, Exim gives up its root privilege
668
immediately, and runs with the real and effective uid and gid set to those of
669
the caller. However, if ALT_CONFIG_ROOT_ONLY is defined in
670
Local/Makefile, root privilege is retained for \fB\-C\fP only if the caller of
671
Exim is root.
672
.sp
673
That is, the Exim user is no longer privileged in this regard. This build\-time
674
option is not set by default in the Exim source distribution tarbundle.
675
However, if you are using a "packaged" version of Exim (source or binary),
676
the packagers might have enabled it.
677
.sp
678
Setting ALT_CONFIG_ROOT_ONLY locks out the possibility of testing a
679
configuration using \fB\-C\fP right through message reception and delivery, even
680
if the caller is root. The reception works, but by that time, Exim is running
681
as the Exim user, so when it re\-executes to regain privilege for the delivery,
682
the use of \fB\-C\fP causes privilege to be lost. However, root can test reception
683
and delivery using two separate commands (one to put a message on the queue,
684
using \fB\-odq\fP, and another to do the delivery, using \fB\-M\fP).
685
.sp
686
If ALT_CONFIG_PREFIX is defined in Local/Makefile, it specifies a
687
prefix string with which any file named in a \fB\-C\fP command line option
688
must start. In addition, the file name must not contain the sequence /../.
689
However, if the value of the \fB\-C\fP option is identical to the value of
690
CONFIGURE_FILE in Local/Makefile, Exim ignores \fB\-C\fP and proceeds as
691
usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
692
unset, any file name can be used with \fB\-C\fP.
693
.sp
694
ALT_CONFIG_PREFIX can be used to confine alternative configuration files
695
to a directory to which only root has access. This prevents someone who has
696
broken into the Exim account from running a privileged Exim with an arbitrary
697
configuration file.
698
.sp
699
The \fB\-C\fP facility is useful for ensuring that configuration files are
700
syntactically correct, but cannot be used for test deliveries, unless the
701
caller is privileged, or unless it is an exotic configuration that does not
702
require privilege. No check is made on the owner or group of the files
703
specified by this option.
704
.TP 10
705
\fB\-D\fP<\fImacro\fP>=<\fIvalue\fP>
706
This option can be used to override macro definitions in the configuration file. However, like \fB\-C\fP, if it is used by an
707
unprivileged caller, it causes Exim to give up its root privilege.
708
If DISABLE_D_OPTION is defined in Local/Makefile, the use of \fB\-D\fP is
709
completely disabled, and its use causes an immediate error exit.
710
.sp
711
The entire option (including equals sign if present) must all be within one
712
command line item. \fB\-D\fP can be used to set the value of a macro to the empty
713
string, in which case the equals sign is optional. These two commands are
714
synonymous:
715
.sp
716
exim \-DABC ...
717
exim \-DABC= ...
718
.sp
719
To include spaces in a macro definition item, quotes must be used. If you use
720
quotes, spaces are permitted around the macro name and the equals sign. For
721
example:
722
.sp
723
exim '\-D ABC = something' ...
724
.sp
725
\fB\-D\fP may be repeated up to 10 times on a command line.
726
.TP 10
727
\fB\-d\fP<\fIdebug options\fP>
728
This option causes debugging information to be written to the standard
729
error stream. It is restricted to admin users because debugging output may show
730
database queries that contain password information. Also, the details of users'
731
filter files should be protected. If a non\-admin user uses \fB\-d\fP, Exim
732
writes an error message to the standard error stream and exits with a non\-zero
733
return code.
734
.sp
735
When \fB\-d\fP is used, \fB\-v\fP is assumed. If \fB\-d\fP is given on its own, a lot of
736
standard debugging data is output. This can be reduced, or increased to include
737
some more rarely needed information, by directly following \fB\-d\fP with a string
738
made up of names preceded by plus or minus characters. These add or remove sets
739
of debugging data, respectively. For example, \fB\-d+filter\fP adds filter
740
debugging, whereas \fB\-d\-all+filter\fP selects only filter debugging. Note that
741
no spaces are allowed in the debug setting. The available debugging categories
742
are:
743
.sp
744
acl ACL interpretation
745
auth authenticators
746
deliver general delivery logic
747
dns DNS lookups (see also resolver)
748
dnsbl DNS black list (aka RBL) code
749
exec arguments for execv() calls
750
expand detailed debugging for string expansions
751
filter filter handling
752
hints_lookup hints data lookups
753
host_lookup all types of name\-to\-IP address handling
754
ident ident lookup
755
interface lists of local interfaces
756
lists matching things in lists
757
load system load checks
758
local_scan can be used by local_scan()
759
lookup general lookup code and all lookups
760
memory memory handling
761
pid add pid to debug output lines
762
process_info setting info for the process log
763
queue_run queue runs
764
receive general message reception logic
765
resolver turn on the DNS resolver's debugging output
766
retry retry handling
767
rewrite address rewriting
768
route address routing
769
timestamp add timestamp to debug output lines
770
tls TLS logic
771
transport transports
772
uid changes of uid/gid and looking up uid/gid
773
verify address verification logic
774
all almost all of the above (see below), and also \fB\-v\fP
775
.sp
776
The all option excludes memory when used as +all, but includes it
777
for \-all. The reason for this is that +all is something that people
778
tend to use when generating debug output for Exim maintainers. If +memory
779
is included, an awful lot of output that is very rarely of interest is
780
generated, so it now has to be explicitly requested. However, \-all does
781
turn everything off.
782
.sp
783
The resolver option produces output only if the DNS resolver was compiled
784
with DEBUG enabled. This is not the case in some operating systems. Also,
785
unfortunately, debugging output from the DNS resolver is written to stdout
786
rather than stderr.
787
.sp
788
The default (\fB\-d\fP with no argument) omits expand, filter,
789
interface, load, memory, pid, resolver, and timestamp.
790
However, the pid selector is forced when debugging is turned on for a
791
daemon, which then passes it on to any re\-executed Exims. Exim also
792
automatically adds the pid to debug lines when several remote deliveries are
793
run in parallel.
794
.sp
795
The timestamp selector causes the current time to be inserted at the start
796
of all debug output lines. This can be useful when trying to track down delays
797
in processing.
798
.sp
799
If the \fBdebug_print\fP option is set in any driver, it produces output whenever
800
any debugging is selected, or if \fB\-v\fP is used.
801
.TP 10
802
\fB\-dd\fP<\fIdebug options\fP>
803
This option behaves exactly like \fB\-d\fP except when used on a command that
804
starts a daemon process. In that case, debugging is turned off for the
805
subprocesses that the daemon creates. Thus, it is useful for monitoring the
806
behaviour of the daemon without creating as much output as full debugging does.
807
.TP 10
808
\fB\-dropcr\fP
809
This is an obsolete option that is now a no\-op. It used to affect the way Exim
810
handled CR and LF characters in incoming messages.
811
.TP 10
812
\fB\-E\fP
813
This option specifies that an incoming message is a locally\-generated delivery
814
failure report. It is used internally by Exim when handling delivery failures
815
and is not intended for external use. Its only effect is to stop Exim
816
generating certain messages to the postmaster, as otherwise message cascades
817
could occur in some situations. As part of the same option, a message id may
818
follow the characters \fB\-E\fP. If it does, the log entry for the receipt of the
819
new message contains the id, following "R=", as a cross\-reference.
820
.TP 10
821
\fB\-e\fP\fIx\fP
822
There are a number of Sendmail options starting with \fB\-oe\fP which seem to be
823
called by various programs without the leading \fBo\fP in the option. For
824
example, the \fBvacation\fP program uses \fB\-eq\fP. Exim treats all options of the
825
form \fB\-e\fP\fIx\fP as synonymous with the corresponding \fB\-oe\fP\fIx\fP options.
826
.TP 10
827
\fB\-F\fP <\fIstring\fP>
828
This option sets the sender's full name for use when a locally\-generated
829
message is being accepted. In the absence of this option, the user's \fIgecos\fP
830
entry from the password data is used. As users are generally permitted to alter
831
their \fIgecos\fP entries, no security considerations are involved. White space
832
between \fB\-F\fP and the <\fIstring\fP> is optional.
833
.TP 10
834
\fB\-f\fP <\fIaddress\fP>
835
This option sets the address of the envelope sender of a locally\-generated
836
message (also known as the return path). The option can normally be used only
837
by a trusted user, but \fBuntrusted_set_sender\fP can be set to allow untrusted
838
users to use it.
839
.sp
840
Processes running as root or the Exim user are always trusted. Other
841
trusted users are defined by the \fBtrusted_users\fP or \fBtrusted_groups\fP
842
options. In the absence of \fB\-f\fP, or if the caller is not trusted, the sender
843
of a local message is set to the caller's login name at the default qualify
844
domain.
845
.sp
846
There is one exception to the restriction on the use of \fB\-f\fP: an empty sender
847
can be specified by any user, trusted or not, to create a message that can
848
never provoke a bounce. An empty sender can be specified either as an empty
849
string, or as a pair of angle brackets with nothing between them, as in these
850
examples of shell commands:
851
.sp
852
exim \-f '<>' user@domain
853
exim \-f "" user@domain
854
.sp
855
In addition, the use of \fB\-f\fP is not restricted when testing a filter file
856
with \fB\-bf\fP or when testing or verifying addresses using the \fB\-bt\fP or
857
\fB\-bv\fP options.
858
.sp
859
Allowing untrusted users to change the sender address does not of itself make
860
it possible to send anonymous mail. Exim still checks that the \fIFrom:\fP header
861
refers to the local user, and if it does not, it adds a \fISender:\fP header,
862
though this can be overridden by setting \fBno_local_from_check\fP.
863
.sp
864
White
865
space between \fB\-f\fP and the <\fIaddress\fP> is optional (that is, they can be
866
given as two arguments or one combined argument). The sender of a
867
locally\-generated message can also be set (when permitted) by an initial
868
"From " line in the message \- see the description of \fB\-bm\fP above \- but
869
if \fB\-f\fP is also present, it overrides "From ".
870
.TP 10
871
\fB\-G\fP
872
This is a Sendmail option which is ignored by Exim.
873
.TP 10
874
\fB\-h\fP <\fInumber\fP>
875
This option is accepted for compatibility with Sendmail, but has no effect. (In
876
Sendmail it overrides the "hop count" obtained by counting \fIReceived:\fP
877
headers.)
878
.TP 10
879
\fB\-i\fP
880
This option, which has the same effect as \fB\-oi\fP, specifies that a dot on a
881
line by itself should not terminate an incoming, non\-SMTP message. I can find
882
no documentation for this option in Solaris 2.4 Sendmail, but the \fImailx\fP
883
command in Solaris 2.4 uses it. See also \fB\-ti\fP.
884
.TP 10
885
\fB\-M\fP <\fImessage id\fP> <\fImessage id\fP> ...
886
This option requests Exim to run a delivery attempt on each message in turn. If
887
any of the messages are frozen, they are automatically thawed before the
888
delivery attempt. The settings of \fBqueue_domains\fP, \fBqueue_smtp_domains\fP,
889
and \fBhold_domains\fP are ignored.
890
.sp
891
Retry
892
hints for any of the addresses are overridden \- Exim tries to deliver even if
893
the normal retry time has not yet been reached. This option requires the caller
894
to be an admin user. However, there is an option called \fBprod_requires_admin\fP
895
which can be set false to relax this restriction (and also the same requirement
896
for the \fB\-q\fP, \fB\-R\fP, and \fB\-S\fP options).
897
.sp
898
The deliveries happen synchronously, that is, the original Exim process does
899
not terminate until all the delivery attempts have finished. No output is
900
produced unless there is a serious error. If you want to see what is happening,
901
use the \fB\-v\fP option as well, or inspect Exim's main log.
902
.TP 10
903
\fB\-Mar\fP <\fImessage id\fP> <\fIaddress\fP> <\fIaddress\fP> ...
904
This option requests Exim to add the addresses to the list of recipients of the
905
message ("ar" for "add recipients"). The first argument must be a message
906
id, and the remaining ones must be email addresses. However, if the message is
907
active (in the middle of a delivery attempt), it is not altered. This option
908
can be used only by an admin user.
909
.TP 10
910
\fB\-MC\fP <\fItransport\fP> <\fIhostname\fP> <\fIsequence number\fP> <\fImessage id\fP>
911
This option is not intended for use by external callers. It is used internally
912
by Exim to invoke another instance of itself to deliver a waiting message using
913
an existing SMTP connection, which is passed as the standard input. This must be the final option, and the caller
914
must be root or the Exim user in order to use it.
915
.TP 10
916
\fB\-MCA\fP
917
This option is not intended for use by external callers. It is used internally
918
by Exim in conjunction with the \fB\-MC\fP option. It signifies that the
919
connection to the remote host has been authenticated.
920
.TP 10
921
\fB\-MCP\fP
922
This option is not intended for use by external callers. It is used internally
923
by Exim in conjunction with the \fB\-MC\fP option. It signifies that the server to
924
which Exim is connected supports pipelining.
925
.TP 10
926
\fB\-MCQ\fP <\fIprocess id\fP> <\fIpipe fd\fP>
927
This option is not intended for use by external callers. It is used internally
928
by Exim in conjunction with the \fB\-MC\fP option when the original delivery was
929
started by a queue runner. It passes on the process id of the queue runner,
930
together with the file descriptor number of an open pipe. Closure of the pipe
931
signals the final completion of the sequence of processes that are passing
932
messages through the same SMTP connection.
933
.TP 10
934
\fB\-MCS\fP
935
This option is not intended for use by external callers. It is used internally
936
by Exim in conjunction with the \fB\-MC\fP option, and passes on the fact that the
937
SMTP SIZE option should be used on messages delivered down the existing
938
connection.
939
.TP 10
940
\fB\-MCT\fP
941
This option is not intended for use by external callers. It is used internally
942
by Exim in conjunction with the \fB\-MC\fP option, and passes on the fact that the
943
host to which Exim is connected supports TLS encryption.
944
.TP 10
945
\fB\-Mc\fP <\fImessage id\fP> <\fImessage id\fP> ...
946
This option requests Exim to run a delivery attempt on each message in turn,
947
but unlike the \fB\-M\fP option, it does check for retry hints, and respects any
948
that are found. This option is not very useful to external callers. It is
949
provided mainly for internal use by Exim when it needs to re\-invoke itself in
950
order to regain root privilege for a delivery.
951
However, \fB\-Mc\fP can be useful when testing, in order to run a delivery that
952
respects retry times and other options such as \fBhold_domains\fP that are
953
overridden when \fB\-M\fP is used. Such a delivery does not count as a queue run.
954
If you want to run a specific delivery as if in a queue run, you should use
955
\fB\-q\fP with a message id argument. A distinction between queue run deliveries
956
and other deliveries is made in one or two places.
957
.TP 10
958
\fB\-Mes\fP <\fImessage id\fP> <\fIaddress\fP>
959
This option requests Exim to change the sender address in the message to the
960
given address, which must be a fully qualified address or "<>" ("es" for
961
"edit sender"). There must be exactly two arguments. The first argument must
962
be a message id, and the second one an email address. However, if the message
963
is active (in the middle of a delivery attempt), its status is not altered.
964
This option can be used only by an admin user.
965
.TP 10
966
\fB\-Mf\fP <\fImessage id\fP> <\fImessage id\fP> ...
967
This option requests Exim to mark each listed message as "frozen". This
968
prevents any delivery attempts taking place until the message is "thawed",
969
either manually or as a result of the \fBauto_thaw\fP configuration option.
970
However, if any of the messages are active (in the middle of a delivery
971
attempt), their status is not altered. This option can be used only by an admin
972
user.
973
.TP 10
974
\fB\-Mg\fP <\fImessage id\fP> <\fImessage id\fP> ...
975
This option requests Exim to give up trying to deliver the listed messages,
976
including any that are frozen. However, if any of the messages are active,
977
their status is not altered. For non\-bounce messages, a delivery error message
978
is sent to the sender, containing the text "cancelled by administrator".
979
Bounce messages are just discarded. This option can be used only by an admin
980
user.
981
.TP 10
982
\fB\-Mmad\fP <\fImessage id\fP> <\fImessage id\fP> ...
983
This option requests Exim to mark all the recipient addresses in the messages
984
as already delivered ("mad" for "mark all delivered"). However, if any
985
message is active (in the middle of a delivery attempt), its status is not
986
altered. This option can be used only by an admin user.
987
.TP 10
988
\fB\-Mmd\fP <\fImessage id\fP> <\fIaddress\fP> <\fIaddress\fP> ...
989
This option requests Exim to mark the given addresses as already delivered
990
("md" for "mark delivered"). The first argument must be a message id, and
991
the remaining ones must be email addresses. These are matched to recipient
992
addresses in the message in a case\-sensitive manner. If the message is active
993
(in the middle of a delivery attempt), its status is not altered. This option
994
can be used only by an admin user.
995
.TP 10
996
\fB\-Mrm\fP <\fImessage id\fP> <\fImessage id\fP> ...
997
This option requests Exim to remove the given messages from the queue. No
998
bounce messages are sent; each message is simply forgotten. However, if any of
999
the messages are active, their status is not altered. This option can be used
1000
only by an admin user or by the user who originally caused the message to be
1001
placed on the queue.
1002
.TP 10
1003
\fB\-Mset\fP <\fImessage id\fP>
1004
This option is useful only in conjunction with \fB\-be\fP (that is, when testing
1005
string expansions). Exim loads the given message from its spool before doing
1006
the test expansions, thus setting message\-specific variables such as
1007
\fI$message_size\fP and the header variables. The \fI$recipients\fP variable is made
1008
available. This feature is provided to make it easier to test expansions that
1009
make use of these variables. However, this option can be used only by an admin
1010
user. See also \fB\-bem\fP.
1011
.TP 10
1012
\fB\-Mt\fP <\fImessage id\fP> <\fImessage id\fP> ...
1013
This option requests Exim to "thaw" any of the listed messages that are
1014
"frozen", so that delivery attempts can resume. However, if any of the
1015
messages are active, their status is not altered. This option can be used only
1016
by an admin user.
1017
.TP 10
1018
\fB\-Mvb\fP <\fImessage id\fP>
1019
This option causes the contents of the message body (\-D) spool file to be
1020
written to the standard output. This option can be used only by an admin user.
1021
.TP 10
1022
\fB\-Mvc\fP <\fImessage id\fP>
1023
This option causes a copy of the complete message (header lines plus body) to
1024
be written to the standard output in RFC 2822 format. This option can be used
1025
only by an admin user.
1026
.TP 10
1027
\fB\-Mvh\fP <\fImessage id\fP>
1028
This option causes the contents of the message headers (\-H) spool file to be
1029
written to the standard output. This option can be used only by an admin user.
1030
.TP 10
1031
\fB\-Mvl\fP <\fImessage id\fP>
1032
This option causes the contents of the message log spool file to be written to
1033
the standard output. This option can be used only by an admin user.
1034
.TP 10
1035
\fB\-m\fP
1036
This is apparently a synonym for \fB\-om\fP that is accepted by Sendmail, so Exim
1037
treats it that way too.
1038
.TP 10
1039
\fB\-N\fP
1040
This is a debugging option that inhibits delivery of a message at the transport
1041
level. It implies \fB\-v\fP. Exim goes through many of the motions of delivery \-
1042
it just doesn't actually transport the message, but instead behaves as if it
1043
had successfully done so. However, it does not make any updates to the retry
1044
database, and the log entries for deliveries are flagged with "*>" rather
1045
than "=>".
1046
.sp
1047
Because \fB\-N\fP discards any message to which it applies, only root or the Exim
1048
user are allowed to use it with \fB\-bd\fP, \fB\-q\fP, \fB\-R\fP or \fB\-M\fP. In other
1049
words, an ordinary user can use it only when supplying an incoming message to
1050
which it will apply. Although transportation never fails when \fB\-N\fP is set, an
1051
address may be deferred because of a configuration problem on a transport, or a
1052
routing problem. Once \fB\-N\fP has been used for a delivery attempt, it sticks to
1053
the message, and applies to any subsequent delivery attempts that may happen
1054
for that message.
1055
.TP 10
1056
\fB\-n\fP
1057
This option is interpreted by Sendmail to mean "no aliasing". It is ignored
1058
by Exim.
1059
.TP 10
1060
\fB\-O\fP <\fIdata\fP>
1061
This option is interpreted by Sendmail to mean set option. It is ignored by
1062
Exim.
1063
.TP 10
1064
\fB\-oA\fP <\fIfile name\fP>
1065
This option is used by Sendmail in conjunction with \fB\-bi\fP to specify an
1066
alternative alias file name. Exim handles \fB\-bi\fP differently; see the
1067
description above.
1068
.TP 10
1069
\fB\-oB\fP <\fIn\fP>
1070
This is a debugging option which limits the maximum number of messages that can
1071
be delivered down one SMTP connection, overriding the value set in any smtp
1072
transport. If <\fIn\fP> is omitted, the limit is set to 1.
1073
.TP 10
1074
\fB\-odb\fP
1075
This option applies to all modes in which Exim accepts incoming messages,
1076
including the listening daemon. It requests "background" delivery of such
1077
messages, which means that the accepting process automatically starts a
1078
delivery process for each message received, but does not wait for the delivery
1079
processes to finish.
1080
.sp
1081
When all the messages have been received, the reception process exits,
1082
leaving the delivery processes to finish in their own time. The standard output
1083
and error streams are closed at the start of each delivery process.
1084
This is the default action if none of the \fB\-od\fP options are present.
1085
.sp
1086
If one of the queueing options in the configuration file
1087
(\fBqueue_only\fP or \fBqueue_only_file\fP, for example) is in effect, \fB\-odb\fP
1088
overrides it if \fBqueue_only_override\fP is set true, which is the default
1089
setting. If \fBqueue_only_override\fP is set false, \fB\-odb\fP has no effect.
1090
.TP 10
1091
\fB\-odf\fP
1092
This option requests "foreground" (synchronous) delivery when Exim has
1093
accepted a locally\-generated message. (For the daemon it is exactly the same as
1094
\fB\-odb\fP.) A delivery process is automatically started to deliver the message,
1095
and Exim waits for it to complete before proceeding.
1096
.sp
1097
The original Exim reception process does not finish until the delivery
1098
process for the final message has ended. The standard error stream is left open
1099
during deliveries.
1100
.sp
1101
However, like \fB\-odb\fP, this option has no effect if \fBqueue_only_override\fP is
1102
false and one of the queueing options in the configuration file is in effect.
1103
.sp
1104
If there is a temporary delivery error during foreground delivery, the
1105
message is left on the queue for later delivery, and the original reception
1106
process exits.
1107
.TP 10
1108
\fB\-odi\fP
1109
This option is synonymous with \fB\-odf\fP. It is provided for compatibility with
1110
Sendmail.
1111
.TP 10
1112
\fB\-odq\fP
1113
This option applies to all modes in which Exim accepts incoming messages,
1114
including the listening daemon. It specifies that the accepting process should
1115
not automatically start a delivery process for each message received. Messages
1116
are placed on the queue, and remain there until a subsequent queue runner
1117
process encounters them. There are several configuration options (such as
1118
\fBqueue_only\fP) that can be used to queue incoming messages under certain
1119
conditions. This option overrides all of them and also \fB\-odqs\fP. It always
1120
forces queueing.
1121
.TP 10
1122
\fB\-odqs\fP
1123
This option is a hybrid between \fB\-odb\fP/\fB\-odi\fP and \fB\-odq\fP.
1124
However, like \fB\-odb\fP and \fB\-odi\fP, this option has no effect if
1125
\fBqueue_only_override\fP is false and one of the queueing options in the
1126
configuration file is in effect.
1127
.sp
1128
When \fB\-odqs\fP does operate, a delivery process is started for each incoming
1129
message, in the background by default, but in the foreground if \fB\-odi\fP is
1130
also present. The recipient addresses are routed, and local deliveries are done
1131
in the normal way. However, if any SMTP deliveries are required, they are not
1132
done at this time, so the message remains on the queue until a subsequent queue
1133
runner process encounters it. Because routing was done, Exim knows which
1134
messages are waiting for which hosts, and so a number of messages for the same
1135
host can be sent in a single SMTP connection. The \fBqueue_smtp_domains\fP
1136
configuration option has the same effect for specific domains. See also the
1137
\fB\-qq\fP option.
1138
.TP 10
1139
\fB\-oee\fP
1140
If an error is detected while a non\-SMTP message is being received (for
1141
example, a malformed address), the error is reported to the sender in a mail
1142
message.
1143
.sp
1144
Provided
1145
this error message is successfully sent, the Exim receiving process
1146
exits with a return code of zero. If not, the return code is 2 if the problem
1147
is that the original message has no recipients, or 1 any other error. This is
1148
the default \fB\-oe\fP\fIx\fP option if Exim is called as \fIrmail\fP.
1149
.TP 10
1150
\fB\-oem\fP
1151
This is the same as \fB\-oee\fP, except that Exim always exits with a non\-zero
1152
return code, whether or not the error message was successfully sent.
1153
This is the default \fB\-oe\fP\fIx\fP option, unless Exim is called as \fIrmail\fP.
1154
.TP 10
1155
\fB\-oep\fP
1156
If an error is detected while a non\-SMTP message is being received, the
1157
error is reported by writing a message to the standard error file (stderr).
1158
The return code is 1 for all errors.
1159
.TP 10
1160
\fB\-oeq\fP
1161
This option is supported for compatibility with Sendmail, but has the same
1162
effect as \fB\-oep\fP.
1163
.TP 10
1164
\fB\-oew\fP
1165
This option is supported for compatibility with Sendmail, but has the same
1166
effect as \fB\-oem\fP.
1167
.TP 10
1168
\fB\-oi\fP
1169
This option, which has the same effect as \fB\-i\fP, specifies that a dot on a
1170
line by itself should not terminate an incoming, non\-SMTP message. Otherwise, a
1171
single dot does terminate, though Exim does no special processing for other
1172
lines that start with a dot. This option is set by default if Exim is called as
1173
\fIrmail\fP. See also \fB\-ti\fP.
1174
.TP 10
1175
\fB\-oitrue\fP
1176
This option is treated as synonymous with \fB\-oi\fP.
1177
.TP 10
1178
\fB\-oMa\fP <\fIhost address\fP>
1179
A number of options starting with \fB\-oM\fP can be used to set values associated
1180
with remote hosts on locally\-submitted messages (that is, messages not received
1181
over TCP/IP). These options can be used by any caller in conjunction with the
1182
\fB\-bh\fP, \fB\-be\fP, \fB\-bf\fP, \fB\-bF\fP, \fB\-bt\fP, or \fB\-bv\fP testing options. In
1183
other circumstances, they are ignored unless the caller is trusted.
1184
.sp
1185
The \fB\-oMa\fP option sets the sender host address. This may include a port
1186
number at the end, after a full stop (period). For example:
1187
.sp
1188
exim \-bs \-oMa 10.9.8.7.1234
1189
.sp
1190
An alternative syntax is to enclose the IP address in square brackets,
1191
followed by a colon and the port number:
1192
.sp
1193
exim \-bs \-oMa [10.9.8.7]:1234
1194
.sp
1195
The IP address is placed in the \fI$sender_host_address\fP variable, and the
1196
port, if present, in \fI$sender_host_port\fP. If both \fB\-oMa\fP and \fB\-bh\fP
1197
are present on the command line, the sender host IP address is taken from
1198
whichever one is last.
1199
.TP 10
1200
\fB\-oMaa\fP <\fIname\fP>
1201
See \fB\-oMa\fP above for general remarks about the \fB\-oM\fP options. The \fB\-oMaa\fP
1202
option sets the value of \fI$sender_host_authenticated\fP (the authenticator
1203
name).
1204
This option can be used with \fB\-bh\fP and \fB\-bs\fP to set up an
1205
authenticated SMTP session without actually using the SMTP AUTH command.
1206
.TP 10
1207
\fB\-oMai\fP <\fIstring\fP>
1208
See \fB\-oMa\fP above for general remarks about the \fB\-oM\fP options. The \fB\-oMai\fP
1209
option sets the value of \fI$authenticated_id\fP (the id that was authenticated).
1210
This overrides the default value (the caller's login id, except with \fB\-bh\fP,
1211
where there is no default) for messages from local sources.
1212
.TP 10
1213
\fB\-oMas\fP <\fIaddress\fP>
1214
See \fB\-oMa\fP above for general remarks about the \fB\-oM\fP options. The \fB\-oMas\fP
1215
option sets the authenticated sender value in \fI$authenticated_sender\fP. It
1216
overrides the sender address that is created from the caller's login id for
1217
messages from local sources, except when \fB\-bh\fP is used, when there is no
1218
default. For both \fB\-bh\fP and \fB\-bs\fP, an authenticated sender that is
1219
specified on a MAIL command overrides this value.
1220
.TP 10
1221
\fB\-oMi\fP <\fIinterface address\fP>
1222
See \fB\-oMa\fP above for general remarks about the \fB\-oM\fP options. The \fB\-oMi\fP
1223
option sets the IP interface address value. A port number may be included,
1224
using the same syntax as for \fB\-oMa\fP. The interface address is placed in
1225
\fI$received_ip_address\fP and the port number, if present, in \fI$received_port\fP.
1226
.TP 10
1227
\fB\-oMr\fP <\fIprotocol name\fP>
1228
See \fB\-oMa\fP above for general remarks about the \fB\-oM\fP options. The \fB\-oMr\fP
1229
option sets the received protocol value that is stored in
1230
\fI$received_protocol\fP. However, it does not apply (and is ignored) when \fB\-bh\fP
1231
or \fB\-bs\fP is used. For \fB\-bh\fP, the protocol is forced to one of the standard
1232
SMTP protocol names. For \fB\-bs\fP, the protocol is always "local\-" followed by
1233
one of those same names. For \fB\-bS\fP (batched SMTP) however, the protocol can
1234
be set by \fB\-oMr\fP.
1235
.TP 10
1236
\fB\-oMs\fP <\fIhost name\fP>
1237
See \fB\-oMa\fP above for general remarks about the \fB\-oM\fP options. The \fB\-oMs\fP
1238
option sets the sender host name in \fI$sender_host_name\fP. When this option is
1239
present, Exim does not attempt to look up a host name from an IP address; it
1240
uses the name it is given.
1241
.TP 10
1242
\fB\-oMt\fP <\fIident string\fP>
1243
See \fB\-oMa\fP above for general remarks about the \fB\-oM\fP options. The \fB\-oMt\fP
1244
option sets the sender ident value in \fI$sender_ident\fP. The default setting for
1245
local callers is the login id of the calling process, except when \fB\-bh\fP is
1246
used, when there is no default.
1247
.TP 10
1248
\fB\-om\fP
1249
In Sendmail, this option means "me too", indicating that the sender of a
1250
message should receive a copy of the message if the sender appears in an alias
1251
expansion. Exim always does this, so the option does nothing.
1252
.TP 10
1253
\fB\-oo\fP
1254
This option is ignored. In Sendmail it specifies "old style headers",
1255
whatever that means.
1256
.TP 10
1257
\fB\-oP\fP <\fIpath\fP>
1258
This option is useful only in conjunction with \fB\-bd\fP or \fB\-q\fP with a time
1259
value. The option specifies the file to which the process id of the daemon is
1260
written. When \fB\-oX\fP is used with \fB\-bd\fP, or when \fB\-q\fP with a time is used
1261
without \fB\-bd\fP, this is the only way of causing Exim to write a pid file,
1262
because in those cases, the normal pid file is not used.
1263
.TP 10
1264
\fB\-or\fP <\fItime\fP>
1265
This option sets a timeout value for incoming non\-SMTP messages. If it is not
1266
set, Exim will wait forever for the standard input. The value can also be set
1267
by the \fBreceive_timeout\fP option.
1268
.TP 10
1269
\fB\-os\fP <\fItime\fP>
1270
This option sets a timeout value for incoming SMTP messages. The timeout
1271
applies to each SMTP command and block of data. The value can also be set by
1272
the \fBsmtp_receive_timeout\fP option; it defaults to 5 minutes.
1273
.TP 10
1274
\fB\-ov\fP
1275
This option has exactly the same effect as \fB\-v\fP.
1276
.TP 10
1277
\fB\-oX\fP <\fInumber or string\fP>
1278
This option is relevant only when the \fB\-bd\fP (start listening daemon) option
1279
is also given. It controls which ports and interfaces the daemon uses. When \fB\-oX\fP is used to start a daemon, no pid
1280
file is written unless \fB\-oP\fP is also present to specify a pid file name.
1281
.TP 10
1282
\fB\-pd\fP
1283
This option applies when an embedded Perl interpreter is linked with Exim. It overrides the setting of the \fBperl_at_start\fP
1284
option, forcing the starting of the interpreter to be delayed until it is
1285
needed.
1286
.TP 10
1287
\fB\-ps\fP
1288
This option applies when an embedded Perl interpreter is linked with Exim. It overrides the setting of the \fBperl_at_start\fP
1289
option, forcing the starting of the interpreter to occur as soon as Exim is
1290
started.
1291
.TP 10
1292
\fB\-p\fP<\fIrval\fP>:<\fIsval\fP>
1293
For compatibility with Sendmail, this option is equivalent to
1294
.sp
1295
\-oMr <\fIrval\fP> \-oMs <\fIsval\fP>
1296
.sp
1297
It sets the incoming protocol and host name (for trusted callers). The
1298
host name and its colon can be omitted when only the protocol is to be set.
1299
Note the Exim already has two private options, \fB\-pd\fP and \fB\-ps\fP, that refer
1300
to embedded Perl. It is therefore impossible to set a protocol value of p
1301
or s using this option (but that does not seem a real limitation).
1302
.TP 10
1303
\fB\-q\fP
1304
This option is normally restricted to admin users. However, there is a
1305
configuration option called \fBprod_requires_admin\fP which can be set false to
1306
relax this restriction (and also the same requirement for the \fB\-M\fP, \fB\-R\fP,
1307
and \fB\-S\fP options).
1308
.sp
1309
The \fB\-q\fP option starts one queue runner process. This scans the queue of
1310
waiting messages, and runs a delivery process for each one in turn. It waits
1311
for each delivery process to finish before starting the next one. A delivery
1312
process may not actually do any deliveries if the retry times for the addresses
1313
have not been reached. Use \fB\-qf\fP (see below) if you want to override this.
1314
.sp
1315
If
1316
the delivery process spawns other processes to deliver other messages down
1317
passed SMTP connections, the queue runner waits for these to finish before
1318
proceeding.
1319
.sp
1320
When all the queued messages have been considered, the original queue runner
1321
process terminates. In other words, a single pass is made over the waiting
1322
mail, one message at a time. Use \fB\-q\fP with a time (see below) if you want
1323
this to be repeated periodically.
1324
.sp
1325
Exim processes the waiting messages in an unpredictable order. It isn't very
1326
random, but it is likely to be different each time, which is all that matters.
1327
If one particular message screws up a remote MTA, other messages to the same
1328
MTA have a chance of getting through if they get tried first.
1329
.sp
1330
It is possible to cause the messages to be processed in lexical message id
1331
order, which is essentially the order in which they arrived, by setting the
1332
\fBqueue_run_in_order\fP option, but this is not recommended for normal use.
1333
.TP 10
1334
\fB\-q\fP<\fIqflags\fP>
1335
The \fB\-q\fP option may be followed by one or more flag letters that change its
1336
behaviour. They are all optional, but if more than one is present, they must
1337
appear in the correct order. Each flag is described in a separate item below.
1338
.TP 10
1339
\fB\-qq...\fP
1340
An option starting with \fB\-qq\fP requests a two\-stage queue run. In the first
1341
stage, the queue is scanned as if the \fBqueue_smtp_domains\fP option matched
1342
every domain. Addresses are routed, local deliveries happen, but no remote
1343
transports are run.
1344
.sp
1345
The hints database that remembers which messages are waiting for specific hosts
1346
is updated, as if delivery to those hosts had been deferred. After this is
1347
complete, a second, normal queue scan happens, with routing and delivery taking
1348
place as normal. Messages that are routed to the same host should mostly be
1349
delivered down a single SMTP
1350
connection because of the hints that were set up during the first queue scan.
1351
This option may be useful for hosts that are connected to the Internet
1352
intermittently.
1353
.TP 10
1354
\fB\-q[q]i...\fP
1355
If the \fIi\fP flag is present, the queue runner runs delivery processes only for
1356
those messages that haven't previously been tried. (\fIi\fP stands for "initial
1357
delivery".) This can be helpful if you are putting messages on the queue using
1358
\fB\-odq\fP and want a queue runner just to process the new messages.
1359
.TP 10
1360
\fB\-q[q][i]f...\fP
1361
If one \fIf\fP flag is present, a delivery attempt is forced for each non\-frozen
1362
message, whereas without \fIf\fP only those non\-frozen addresses that have passed
1363
their retry times are tried.
1364
.TP 10
1365
\fB\-q[q][i]ff...\fP
1366
If \fIff\fP is present, a delivery attempt is forced for every message, whether
1367
frozen or not.
1368
.TP 10
1369
\fB\-q[q][i][f[f]]l\fP
1370
The \fIl\fP (the letter "ell") flag specifies that only local deliveries are to
1371
be done. If a message requires any remote deliveries, it remains on the queue
1372
for later delivery.
1373
.TP 10
1374
\fB\-q\fP<\fIqflags\fP> <\fIstart id\fP> <\fIend id\fP>
1375
When scanning the queue, Exim can be made to skip over messages whose ids are
1376
lexically less than a given value by following the \fB\-q\fP option with a
1377
starting message id. For example:
1378
.sp
1379
exim \-q 0t5C6f\-0000c8\-00
1380
.sp
1381
Messages that arrived earlier than 0t5C6f\-0000c8\-00 are not inspected. If a
1382
second message id is given, messages whose ids are lexically greater than it
1383
are also skipped. If the same id is given twice, for example,
1384
.sp
1385
exim \-q 0t5C6f\-0000c8\-00 0t5C6f\-0000c8\-00
1386
.sp
1387
just one delivery process is started, for that message. This differs from
1388
\fB\-M\fP in that retry data is respected, and it also differs from \fB\-Mc\fP in
1389
that it counts as a delivery from a queue run. Note that the selection
1390
mechanism does not affect the order in which the messages are scanned. There
1391
are also other ways of selecting specific sets of messages for delivery in a
1392
queue run \- see \fB\-R\fP and \fB\-S\fP.
1393
.TP 10
1394
\fB\-q\fP<\fIqflags\fP><\fItime\fP>
1395
When a time value is present, the \fB\-q\fP option causes Exim to run as a daemon,
1396
starting a queue runner process at intervals specified by the given time value. This form of the
1397
\fB\-q\fP option is commonly combined with the \fB\-bd\fP option, in which case a
1398
single daemon process handles both functions. A common way of starting up a
1399
combined daemon at system boot time is to use a command such as
1400
.sp
1401
/usr/exim/bin/exim \-bd \-q30m
1402
.sp
1403
Such a daemon listens for incoming SMTP calls, and also starts a queue runner
1404
process every 30 minutes.
1405
.sp
1406
When a daemon is started by \fB\-q\fP with a time value, but without \fB\-bd\fP, no
1407
pid file is written unless one is explicitly requested by the \fB\-oP\fP option.
1408
.TP 10
1409
\fB\-qR\fP<\fIrsflags\fP> <\fIstring\fP>
1410
This option is synonymous with \fB\-R\fP. It is provided for Sendmail
1411
compatibility.
1412
.TP 10
1413
\fB\-qS\fP<\fIrsflags\fP> <\fIstring\fP>
1414
This option is synonymous with \fB\-S\fP.
1415
.TP 10
1416
\fB\-R\fP<\fIrsflags\fP> <\fIstring\fP>
1417
The <\fIrsflags\fP> may be empty, in which case the white space before the string
1418
is optional, unless the string is \fIf\fP, \fIff\fP, \fIr\fP, \fIrf\fP, or \fIrff\fP,
1419
which are the possible values for <\fIrsflags\fP>. White space is required if
1420
<\fIrsflags\fP> is not empty.
1421
.sp
1422
This option is similar to \fB\-q\fP with no time value, that is, it causes Exim to
1423
perform a single queue run, except that, when scanning the messages on the
1424
queue, Exim processes only those that have at least one undelivered recipient
1425
address containing the given string, which is checked in a case\-independent
1426
way. If the <\fIrsflags\fP> start with \fIr\fP, <\fIstring\fP> is interpreted as a
1427
regular expression; otherwise it is a literal string.
1428
.sp
1429
If you want to do periodic queue runs for messages with specific recipients,
1430
you can combine \fB\-R\fP with \fB\-q\fP and a time value. For example:
1431
.sp
1432
exim \-q25m \-R @special.domain.example
1433
.sp
1434
This example does a queue run for messages with recipients in the given domain
1435
every 25 minutes. Any additional flags that are specified with \fB\-q\fP are
1436
applied to each queue run.
1437
.sp
1438
Once a message is selected for delivery by this mechanism, all its addresses
1439
are processed. For the first selected message, Exim overrides any retry
1440
information and forces a delivery attempt for each undelivered address. This
1441
means that if delivery of any address in the first message is successful, any
1442
existing retry information is deleted, and so delivery attempts for that
1443
address in subsequently selected messages (which are processed without forcing)
1444
will run. However, if delivery of any address does not succeed, the retry
1445
information is updated, and in subsequently selected messages, the failing
1446
address will be skipped.
1447
.sp
1448
If the <\fIrsflags\fP> contain \fIf\fP or \fIff\fP, the delivery forcing applies to
1449
all selected messages, not just the first; frozen messages are included when
1450
\fIff\fP is present.
1451
.sp
1452
The \fB\-R\fP option makes it straightforward to initiate delivery of all messages
1453
to a given domain after a host has been down for some time. When the SMTP
1454
command ETRN is accepted by its ACL, its default
1455
effect is to run Exim with the \fB\-R\fP option, but it can be configured to run
1456
an arbitrary command instead.
1457
.TP 10
1458
\fB\-r\fP
1459
This is a documented (for Sendmail) obsolete alternative name for \fB\-f\fP.
1460
.TP 10
1461
\fB\-S\fP<\fIrsflags\fP> <\fIstring\fP>
1462
This option acts like \fB\-R\fP except that it checks the string against each
1463
message's sender instead of against the recipients. If \fB\-R\fP is also set, both
1464
conditions must be met for a message to be selected. If either of the options
1465
has \fIf\fP or \fIff\fP in its flags, the associated action is taken.
1466
.TP 10
1467
\fB\-Tqt\fP <\fItimes\fP>
1468
This an option that is exclusively for use by the Exim testing suite. It is not
1469
recognized when Exim is run normally. It allows for the setting up of explicit
1470
"queue times" so that various warning/retry features can be tested.
1471
.TP 10
1472
\fB\-t\fP
1473
When Exim is receiving a locally\-generated, non\-SMTP message on its standard
1474
input, the \fB\-t\fP option causes the recipients of the message to be obtained
1475
from the \fITo:\fP, \fICc:\fP, and \fIBcc:\fP header lines in the message instead of
1476
from the command arguments. The addresses are extracted before any rewriting
1477
takes place and the \fIBcc:\fP header line, if present, is then removed.
1478
.sp
1479
If the command has any arguments, they specify addresses to which the message
1480
is \fInot\fP to be delivered. That is, the argument addresses are removed from
1481
the recipients list obtained from the headers. This is compatible with Smail 3
1482
and in accordance with the documented behaviour of several versions of
1483
Sendmail, as described in man pages on a number of operating systems (e.g.
1484
Solaris 8, IRIX 6.5, HP\-UX 11). However, some versions of Sendmail \fIadd\fP
1485
argument addresses to those obtained from the headers, and the O'Reilly
1486
Sendmail book documents it that way. Exim can be made to add argument addresses
1487
instead of subtracting them by setting the option
1488
\fBextract_addresses_remove_arguments\fP false.
1489
.sp
1490
If there are any \fBResent\-\fP header lines in the message, Exim extracts
1491
recipients from all \fIResent\-To:\fP, \fIResent\-Cc:\fP, and \fIResent\-Bcc:\fP header
1492
lines instead of from \fITo:\fP, \fICc:\fP, and \fIBcc:\fP. This is for compatibility
1493
with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
1494
\fB\-t\fP was used in conjunction with \fBResent\-\fP header lines.)
1495
.sp
1496
RFC 2822 talks about different sets of \fBResent\-\fP header lines (for when a
1497
message is resent several times). The RFC also specifies that they should be
1498
added at the front of the message, and separated by \fIReceived:\fP lines. It is
1499
not at all clear how \fB\-t\fP should operate in the present of multiple sets,
1500
nor indeed exactly what constitutes a "set".
1501
In practice, it seems that MUAs do not follow the RFC. The \fBResent\-\fP lines
1502
are often added at the end of the header, and if a message is resent more than
1503
once, it is common for the original set of \fBResent\-\fP headers to be renamed as
1504
\fBX\-Resent\-\fP when a new set is added. This removes any possible ambiguity.
1505
.TP 10
1506
\fB\-ti\fP
1507
This option is exactly equivalent to \fB\-t\fP \fB\-i\fP. It is provided for
1508
compatibility with Sendmail.
1509
.TP 10
1510
\fB\-tls\-on\-connect\fP
1511
This option is available when Exim is compiled with TLS support. It forces all
1512
incoming SMTP connections to behave as if the incoming port is listed in the
1513
\fBtls_on_connect_ports\fP option.
1514
.TP 10
1515
\fB\-U\fP
1516
Sendmail uses this option for "initial message submission", and its
1517
documentation states that in future releases, it may complain about
1518
syntactically invalid messages rather than fixing them when this flag is not
1519
set. Exim ignores this option.
1520
.TP 10
1521
\fB\-v\fP
1522
This option causes Exim to write information to the standard error stream,
1523
describing what it is doing. In particular, it shows the log lines for
1524
receiving and delivering a message, and if an SMTP connection is made, the SMTP
1525
dialogue is shown. Some of the log lines shown may not actually be written to
1526
the log if the setting of \fBlog_selector\fP discards them. Any relevant
1527
selectors are shown with each log line. If none are shown, the logging is
1528
unconditional.
1529
.TP 10
1530
\fB\-x\fP
1531
AIX uses \fB\-x\fP for a private purpose ("mail from a local mail program has
1532
National Language Support extended characters in the body of the mail item").
1533
It sets \fB\-x\fP when calling the MTA from its \fBmail\fP command. Exim ignores
1534
this option.
1535
.sp
1536
.
1537
.SH "SEE ALSO"
1538
.rs
1539
.sp
1540
The full Exim specification, the Exim book, and the Exim wiki.
Loggerhead is a web-based interface for Breezy
Version: 2.0.1