cd61f3d1c6f8ae635a17239b9df5f7dd531fdfb3
[exim.git] / doc / doc-txt / OptionLists.txt
1 $Cambridge: exim/doc/doc-txt/OptionLists.txt,v 1.11 2005/11/10 12:30:14 ph10 Exp $
2
3 LISTS OF EXIM OPTIONS
4 ---------------------
5
6 This file contains complete lists of four kinds of Exim option:
7
8 1. Those that can appear in the run time configuration file;
9 2. Those that can be used on the command line;
10 3. Those that can appear in the build time configuration (Local/Makefile);
11 4. Those that can appear in the build time configuration for the Exim monitor
12 (Local/eximon.conf).
13
14 This file was last updated for Exim release 4.51.
15
16
17 1. RUN TIME OPTIONS
18 -------------------
19
20 As Exim has developed, new options have been added at each major release. For
21 the most part, backwards compatibility has been maintained, and obsolete
22 options continue to be recognized. However, incompatible changes took place at
23 releases 3.00, and 4.00. In both cases, several groups of options were
24 amalgamated into new, extended options, and obsolete options were removed.
25
26 The table below contains a complete list of all Exim's current options, along
27 with their types, default values, and where they can be used. String options
28 that are expanded before use are marked with *. Host lists, domain lists, and
29 address lists are always expanded. In some cases the defaults are not fixed
30 values, or not short enough to fit in the table. These are indicated by +. Some
31 other default values are determined when the Exim binary is compiled; these are
32 indicated by ++.
33
34 For options that are specific to a particular driver, the fourth column
35 contains the driver name, for example, appendfile. Otherwise, it contains
36
37 . `main' for options that appear in the main section of Exim's configuration
38 file;
39
40 . `authenticators' for generic options that apply to any authenticator;
41
42 . `routers' for generic options that apply to any router;
43
44 . `transports' for generic options that apply to any transport.
45
46 The fifth column contains the version of Exim in which the option was added, or
47 substantially changed. Where no number is given, the option has been in Exim
48 since the very early releases. The routers were completely reorganised for
49 release 4.00, and so no router options are shown as earlier than 4.00, though
50 in fact some of them were inherited from earlier versions.
51
52 -----------------------------------------------------------------------------------------
53 accept_8bitmime boolean false main 1.60
54 acl_not_smtp string* unset main 4.11
55 acl_not_smtp_mime string* unset main 4.51 with content scan
56 acl_smtp_auth string* unset main 4.00
57 acl_smtp_connect string* unset main 4.11
58 acl_smtp_data string* unset main 4.00
59 acl_smtp_etrn string* unset main 4.00
60 acl_smtp_expn string* unset main 4.00
61 acl_smtp_helo string* unset main 4.20
62 acl_smtp_mail string* unset main 4.11
63 acl_smtp_mailauth string* unset main 4.21
64 acl_smtp_mime string* unset main 4.50 with content scan
65 acl_smtp_predata string* unset main 4.43
66 acl_smtp_quit string* unset main 4.43
67 acl_smtp_rcpt string* unset main 4.00
68 acl_smtp_starttls string* unset main 4.11
69 acl_smtp_vrfy string* unset main 4.00
70 address_data string* unset routers 4.00
71 address_test boolean true routers 4.14
72 admin_groups string list unset main 3.02
73 allow_domain_literals boolean false main 4.00 replacing forbid_domain_literals
74 allow_commands string list* unset pipe 1.89
75 allow_defer boolean false redirect 4.00
76 allow_fail boolean false redirect 4.00
77 allow_filter boolean false redirect 4.00
78 allow_freeze boolean false redirect 4.00
79 allow_fifo boolean false appendfile 3.13
80 allow_localhost boolean false smtp 1.73
81 allow_mx_to_ip boolean false main 3.14
82 allow_symlink boolean false appendfile
83 allow_utf8_domains boolean false main 4.14
84 auth_advertise_hosts host list "*" main 4.00
85 authenticated_sender string* unset smtp 4.14
86 authenticate_hosts host list unset smtp 3.13
87 auto_thaw time 0s main
88 av_scanner string* + main 4.50 with content scan
89 batch_id string unset appendfile 4.00
90 unset lmtp 4.00
91 unset pipe 4.00
92 batch_max integer 100 appendfile
93 100 lmtp 3.20
94 100 pipe
95 bcc string* unset autoreply
96 bi_command string unset main
97 body_only boolean false transports 2.05
98 bounce_message_file string unset main 4.00
99 bounce_message_text string unset main 4.00
100 bounce_return_body boolean true main 4.23
101 bounce_return_message boolean true main 4.00
102 bounce_return_size_limit int 100K main 4.23 better name for return_size_limit
103 bounce_sender_authentication string unset main 4.00
104 callout_domain_negative_expire time 3h main 4.11
105 callout_domain_positive_expire time 7d main 4.11
106 callout_negative_expire time 2h main 4.11
107 callout_positive_expire time 24h main 4.11
108 callout_random_local_part string* + main 4.11
109 cannot_route_message string* unset routers 4.11
110 caseful_local_part boolean false routers 4.00
111 cc string* unset autoreply
112 check_ancestor boolean false redirect 4.00
113 check_group boolean false appendfile
114 + redirect 4.00
115 check_local_user boolean false routers 4.00
116 check_log_inodes integer 0 main
117 check_log_space integer 0 main
118 check_owner boolean true appendfile 3.14
119 + redirect 4.00
120 check_secondary_mx boolean false dnslookup 4.00
121 check_spool_inodes integer 0 main
122 check_spool_space integer 0 main
123 check_string string "From " appendfile 3.03
124 unset pipe 3.03
125 check_srv string* unset dnslookup 4.31
126 client_name string* + cram_md5 3.10
127 client_secret string* unset cram_md5 3.10
128 client_send string* unset plaintext 3.10
129 command string* unset lmtp 3.20
130 unset pipe
131 unset queryprogram 4.00
132 command_group string unset queryprogram 4.00
133 command_timeout time 5m smtp
134 command_user string unset queryprogram 4.00
135 condition string* unset routers 4.00
136 connect_timeout time 0s smtp 1.60
137 connection_max_messages integer 500 smtp 4.00 replaces batch_max
138 create_directory boolean true appendfile
139 create_file string "anywhere" appendfile
140 current_directory string unset transports 4.00
141 unset queryprogram 4.00
142 daemon_smtp_ports string unset main 1.75 pluralised in 4.21
143 daemon_startup_retries int 9 main 4.52
144 daemon_startup_sleep time 30s main 4.52
145 data string unset redirect 4.00
146 data_timeout time 5m smtp
147 debug_print string* unset authenticators 4.00
148 unset routers 4.00
149 unset transports 2.00
150 delay_after_cutoff boolean true smtp
151 delay_warning time list 24h main
152 delay_warning_condition string* + main 1.73
153 deliver_drop_privilege boolean false main 4.00
154 deliver_queue_load_max fixed-point unset main 1.70
155 delivery_date_add boolean false transports
156 delivery_date_remove boolean true main
157 directory string* unset appendfile
158 directory_mode octal-integer 0700 appendfile
159 directory_transport string* unset redirect 4.00
160 disable_logging boolean false routers 4.11
161 disable_logging boolean false transports 4.11
162 dns_again_means_nonexist domain list unset main 1.89
163 dns_check_names_pattern string + main 2.11
164 dns_csa_search_limit integer 5 main 4.60
165 dns_csa_use_reverse boolean true main 4.60
166 dns_ipv4_lookup boolean false main 3.20
167 dns_qualify_single boolean true smtp
168 dns_retrans time 0s main 1.60
169 dns_retry integer 0 main 1.60
170 dns_search_parents boolean false smtp
171 domains domain list unset routers 4.00
172 driver string unset authenticators
173 unset routers 4.00
174 unset transports
175 drop_cr boolean false main 4.00 became a no-op in 4.21
176 envelope_to_add boolean false transports
177 envelope_to_remove boolean true main
178 environment string* unset pipe 2.95
179 errors_copy string list* unset main
180 errors_reply_to string unset main
181 errors_to string* unset routers 4.00
182 escape_string string ">From " appendfile 3.03
183 unset pipe 3.03
184 exim_group string ++ main
185 exim_path string ++ main
186 exim_user string ++ main
187 expn boolean true routers
188 extra_local_interfaces string unset main 4.21
189 extract_addresses_remove_arguments boolean true main 1.92
190 fail_verify boolean false routers
191 fail_verify_recipient boolean false routers 4.00
192 fail_verify_sender boolean false routers 4.00
193 fallback_hosts string list unset routers 4.00
194 unset smtp
195 file string* unset appendfile
196 unset autoreply
197 unset redirect 4.00
198 file_expand boolean false autoreply
199 file_format string unset appendfile 3.03
200 file_must_exist boolean false appendfile
201 file_optional boolean false autoreply
202 file_transport string* unset redirect 4.00
203 final_timeout time 10m smtp
204 finduser_retries integer 0 main
205 forbid_blackhole boolean false redirect 4.00
206 forbid_exim_filter boolean false redirect 4.44
207 forbid_fail boolean false redirect 4.00
208 forbid_file boolean false redirect 4.00
209 forbid_filter_existstest boolean false redirect 4.00
210 forbid_filter_logwrite boolean false redirect 4.00
211 forbid_filter_lookup boolean false redirect 4.00
212 forbid_filter_perl boolean false redirect 4.00
213 forbid_filter_readfile boolean false redirect 4.00
214 forbid_filter_readsocket boolean false redirect 4.11
215 forbid_filter_reply boolean false redirect 4.00
216 forbid_filter_run boolean false redirect 4.00
217 forbid_include boolean false redirect 4.00
218 forbid_pipe boolean false redirect 4.00
219 forbid_sieve_filter boolean false redirect 4.44
220 freeze_exec_fail boolean false pipe 1.89
221 freeze_tell boolean false main 4.00 replaces freeze_tell_mailmaster
222 from string* unset autoreply
223 gecos_name string* unset main
224 gecos_pattern string unset main
225 gethostbyname boolean false smtp
226 group string + routers 4.00
227 unset transports 4.00 replaces local option in some transports
228 header_line_maxsize integer 0 (unset) main 4.14
229 header_maxsize integer 1M main 4.14
230 headers string* unset autoreply
231 headers_add string* unset routers 4.00
232 unset transports
233 headers_charset string ++ main 4.21
234 headers_only boolean false transports 2.05
235 headers_remove string* unset routers 4.00
236 unset transports
237 headers_rewrite string unset transports 3.20
238 helo_accept_junk_hosts host list unset main 3.00
239 helo_allow_chars string "" main 4.02
240 helo_lookup_domains domain list unset main 4.00
241 helo_data string* "$primary_hostname" smtp 3.21
242 helo_try_verify_hosts host list unset main 4.00
243 helo_verify_hosts host list unset main 1.73
244 hide_child_in_errmsg false redirect 4.00
245 hold_domains domain list unset main 1.70
246 home_directory string* unset transports 4.00 replaces individual options
247 host_find_failed string "freeze" manualroute 4.00
248 host_lookup host list unset main 3.00
249 host_lookup_order string list "bydns:byaddr" main 4.30
250 host_reject_connection host list unset main 4.00
251 hosts string unset iplookup 4.00
252 string list* unset smtp
253 hosts_avoid_esmtp host list unset smtp 4.21
254 hosts_avoid_tls host list unset smtp 3.20
255 hosts_connection_nolog host list unset main 4.43
256 hosts_max_try integer 5 smtp 3.20
257 hosts_max_try_hardlimit integer 50 smtp 4.50
258 hosts_nopass_tls host list unset smtp 4.00
259 hosts_override boolean false smtp 2.11
260 hosts_randomize boolean false manualroute 4.00
261 false smtp 3.14
262 hosts_require_auth host list unset smtp 4.00
263 hosts_require_tls host list unset smtp 3.20
264 hosts_treat_as_local domain list unset main 1.95
265 hosts_try_auth host list unset smtp 4.00
266 ignore_bounce_errors_after time 0s main 4.00
267 ignore_eacces boolean false redirect 4.00
268 ignore_enotdir boolean false redirect 4.00
269 ignore_fromline_hosts host list unset main
270 ignore_fromline_local boolean false main 2.05
271 ignore_status boolean false pipe
272 ignore_target_hosts host list unset routers 4.00
273 include_directory string unset redirect 4.00
274 initgroups false routers 4.00
275 interface string list unset smtp 1.70
276 keep_malformed time 4d main
277 keepalive boolean true smtp 2.05
278 ldap_default_servers string list unset main 3.02
279 ldap_version int 2 or 3 main 4.14
280 local_from_check boolean true main 3.14
281 local_from_prefix string unset main 3.14
282 local_from_suffix string unset main 3.14
283 local_interfaces string list unset main 1.60
284 local_part_prefix string unset routers 4.00 replaces prefix
285 local_part_prefix_optional boolean unset routers 4.00 replaces prefix_optional
286 local_part_suffix string unset routers 4.00 replaces suffix
287 local_part_suffix_optional boolean unset routers 4.00 replaces suffix_optional
288 local_parts string list* unset routers 4.00
289 local_scan_timeout time 5m main 4.03
290 local_sender_retain boolean false main 4.00
291 localhost_number string unset main
292 lock_fcntl_timeout time 0s appendfile 3.14
293 lock_flock_timeout time 0s appendfile 4.11
294 lock_interval time 3s appendfile
295 lock_retries integer 10 appendfile
296 lockfile_mode octal-integer 0600 appendfile
297 lockfile_timeout time 30m appendfile
298 log string* unset autoreply
299 log_as_local boolean + routers 4.00
300 log_file_path string list ++ main
301 log_defer_output boolean false pipe 1.89
302 log_fail_output boolean false pipe 1.60
303 log_output boolean false pipe 1.60
304 log_selector string unset main 4.00
305 log_timezone boolean false main 4.11
306 lookup_open_max integer 25 main 2.05
307 mailbox_filecount string* unset appendfile 4.43
308 mailbox_size string* unset appendfile 4.43
309 maildir_format boolean false appendfile 1.70
310 maildir_retries integer 10 appendfile 1.70
311 maildir_tag string* unset appendfile 1.92
312 maildir_use_size_file boolean false appendfile 4.30
313 mailstore_format boolean false appendfile 2.00
314 mailstore_prefix string* unset appendfile 2.00
315 mailstore_suffix string* unset appendfile 2.00
316 match_directory string* unset localuser
317 max_output integer 20K pipe
318 max_rcpt integer 100 smtp 1.60
319 max_user_name_length integer 0 main
320 mbx_format boolean false appendfile 2.10
321 message_body_visible integer 500 main
322 message_id_header_domain string* unset main 4.11
323 message_id_header_text string* unset main
324 message_logs boolean true main 4.10
325 message_prefix string* + appendfile 4.00 replaces prefix
326 string* unset pipe 4.00 replaces prefix
327 message_size_limit integer 0 main
328 0 transports 2.05
329 message_suffix string* + appendfile 4.00 replaces suffix
330 string* unset pipe 4.00 replaces suffix
331 mode octal-integer 0600 appendfile
332 0600 autoreply
333 mode_fail_narrower boolean true appendfile 1.70
334 modemask octal-integer 022 redirect 4.00
335 more boolean true routers 4.00
336 move_frozen_messages boolean false main 3.09
337 multi_domain boolean true smtp
338 mx_domains domain list unset dnslookup 4.00
339 mx_fail_domains domain list unset dnslookup 4.43
340 mysql_servers string list unset main 3.03
341 never_users string list unset main
342 notify_comsat boolean false appendfile
343 once string* unset autoreply
344 once_file_size integer 0 autoreply 3.20
345 once_repeat time 0s autoreply 2.95
346 one_time boolean false redirect 4.00
347 optional boolean false iplookup 4.00
348 oracle_servers string unset main 4.00
349 owners string list unset redirect 4.00
350 owngroups string list unset redirect 4.00
351 pass_on_timeout boolean false routers 4.00
352 pass_router string unset routers 4.00
353 path string "/usr/bin" pipe
354 percent_hack_domains domain list unset main
355 perl_at_start boolean false main 2.10
356 perl_startup string unset main 2.10
357 pgsql_servers string list unset main 3.14
358 pid_file_path string ++ main
359 pipe_as_creator boolean false pipe
360 pipe_transport string* unset redirect 4.00
361 pipelining_advertise_hosts host list "*" main 4.14
362 port integer 0 iplookup 4.00
363 string "smtp" smtp
364 preserve_message_logs boolean false main
365 primary_hostname string + main
366 print_topbitchars boolean false main 1.89
367 process_log_path string unset main 4.21
368 prod_requires_admin boolean true main 1.70
369 protocol string "udp" iplookup 4.00
370 string "smtp" smtp 3.20
371 public_name string unset authenticators 3.10
372 qualify_domain string + main
373 string* unset redirect 4.31
374 qualify_preserve_domain boolean false redirect 4.00
375 qualify_recipient string + main
376 qualify_single boolean true dnslookup 4.00
377 query string* + iplookup 4.00
378 queue_domains domain list unset main 4.00
379 queue_list_requires_admin boolean true main 1.95
380 queue_only boolean false main
381 queue_only_file string unset main 2.05
382 queue_only_load fixed-point unset main
383 queue_only_override boolean true main 4.21
384 queue_run_in_order boolean false main 1.70
385 queue_run_max integer 5 main
386 queue_smtp_domains domain list unset main
387 quota string* unset appendfile 1.60
388 quota_directory string* unset appendfile 4.11
389 quota_filecount integer 0 appendfile 2.05
390 quota_is_inclusive boolean true appendfile 3.20
391 quota_size_regex string unset appendfile 3.14
392 quota_warn_message string* + appendfile 2.10
393 quota_warn_threshold string* 0 appendfile 2.10
394 rcpt_include_affixes boolean false transports 4.21
395 receive_timeout time 0s main 4.00 replacing accept_timeout
396 received_header_text string* + main
397 received_headers_max integer 30 main
398 recipient_unqualified_hosts host list unset main 4.00 replacing receiver_unqualified_hosts
399 recipients_max integer 0 main 1.60
400 recipients_max_reject boolean false main 1.70
401 redirect_router string unset routers 4.00
402 remote_max_parallel integer 1 main
403 remote_sort_domains domain list unset main 4.00 replacing remote_sort
404 repeat_use boolean true redirect 4.00
405 reply_to string* unset autoreply 2.05
406 reply_transport string* unset redirect 4.00
407 require_files string list* unset routers 4.00
408 reroute string* unset iplookup 4.00
409 response_pattern string unset iplookup 4.00
410 restrict_to_path boolean false pipe
411 retry_data_expire time 7d main 3.03
412 retry_include_ip_address boolean true smtp 1.92
413 retry_interval_max time 24h main
414 retry_use_local_part boolean + routers 4.00
415 + transports 4.00 replacing individual options
416 return_fail_output boolean false pipe 1.60
417 return_message boolean false autoreply
418 return_output boolean false pipe
419 return_path string* unset transports 2.05
420 return_path_add boolean false transports
421 return_path_remove boolean true main
422 return_size_limit integer 100K main renamed bounce_return_size_limit in 4.23
423 rewrite boolean true redirect 4.00
424 rewrite_headers boolean true dnslookup 4.00
425 rfc1413_hosts host list * main
426 rfc1413_query_timeout time 30s main
427 router_home_directory string* unset routers 4.11
428 route_data string* unset manualroute 4.00
429 route_list string list unset manualroute 4.00
430 same_domain_copy_routing boolean false dnslookup 4.00
431 search_parents boolean false dnslookup 4.00
432 self string "freeze" routers 4.00
433 sender_unqualified_hosts host list unset main
434 senders address list unset routers 4.00
435 serialize_hosts host list unset smtp 1.60
436 server_advertise_condition string* unset authenticators 4.14
437 server_condition string* unset plaintext 3.10
438 server_hostname string* "$primary_hostname" cyrus_sasl 4.43
439 server_mail_auth_condition string* unset authenticators 3.22
440 server_mech string public_name cyrus_sasl 4.43
441 server_prompts string* unset plaintext 3.10
442 server_realm string unset cyrus_sasl 4.43
443 server_secret string* unset cram_md5 3.10
444 server_service string "smtp" cyrus_sasl 4.43
445 server_set_id string* unset authenticators 3.10
446 shadow_condition string* unset transports
447 shadow_transport string unset transports
448 size_addition integer 1024 smtp 1.91
449 skip_syntax_errors boolean false redirect 4.00
450 smtp_accept_keepalive boolean true main
451 smtp_accept_max integer 20 main
452 smtp_accept_max_nonmail integer 10 main 4.11
453 smtp_accept_max_nonmail_hosts host list * main 4.14
454 smtp_accept_max_per_connection integer 1000 main 4.00
455 smtp_accept_max_per_host integer 0 main 2.05
456 smtp_accept_queue integer 0 main
457 smtp_accept_queue_per_connection integer 10 main 2.03
458 smtp_accept_reserve integer 0 main
459 smtp_active_hostname string* unset main 4.33
460 smtp_banner string* + main
461 smtp_check_spool_space boolean true main 2.10
462 smtp_connect_backlog integer 5 main
463 smtp_enforce_sync boolean true main 4.00
464 smtp_etrn_command string* unset main 1.92
465 smtp_etrn_serialize boolean true main 1.89
466 smtp_load_reserve fixed-point unset main
467 smtp_max_synprot_errors integer 3 main 4.30
468 smtp_max_unknown_commands integer 3 main 4.14
469 smtp_ratelimit_hosts host list unset main 4.00
470 smtp_ratelimit_mail string unset main 4.00
471 smtp_ratelimit_rcpt string unset main 4.00
472 smtp_receive_timeout time 5m main
473 smtp_reserve_hosts host list unset main
474 smtp_return_error_details boolean false main 4.11
475 socket string* unset lmtp 4.11
476 spamd_address string + main 4.50 with content scan
477 split_spool_directory boolean false main 1.70
478 spool_directory string ++ main
479 sqlite_lock_timeout time 5s main 4.53
480 srv_fail_domains domain list unset dnslookup 4.43
481 strip_excess_angle_brackets boolean false main
482 strip_trailing_dot boolean false main
483 subject string* unset autoreply
484 syntax_errors_text string* unset redirect 4.00
485 syntax_errors_to string unset redirect 4.00
486 syslog_duplication boolean true main 4.21
487 syslog_facility string unset main 4.20
488 syslog_processname string "exim" main 4.20
489 syslog_timestamp boolean true main 4.00
490 system_filter string unset main 4.00 replacing message_filter
491 system_filter_directory_transport string unset main 4.00 replacing message_filter
492 system_filter_file_transport string unset main 4.00 replacing message_filter
493 system_filter_group string unset main 4.00 replacing message_filter
494 system_filter_pipe_transport string unset main 4.00 replacing message_filter
495 system_filter_reply_transport string unset main 4.00 replacing message_filter
496 system_filter_user string unset main 4.00 replacing message_filter
497 tcp_nodelay boolean true main 4.23
498 true smtp 4.23
499 temp_errors string list + pipe 1.95
500 text string* unset autoreply
501 timeout time 5m lmtp 3.20
502 1h pipe
503 1h queryprogram 4.00
504 5s iplookup 4.00
505 timeout_defer boolean false pipe 4.51
506 timeout_frozen_after time 0s main 3.20
507 timezone string + main 3.15
508 tls_advertise_hosts host list * main 3.20
509 tls_certificate string* unset main 3.20
510 unset smtp 3.20
511 tls_dhparam string* unset main 3.20
512 tls_on_connect_ports string unset main 4.43
513 tls_privatekey string* unset main 3.20
514 unset smtp 3.20
515 tls_remember_emstp boolean false main 4.21
516 tls_require_ciphers string* unset smtp 4.00 replaces tls_verify_ciphers
517 string* unset main 4.33
518 tls_tempfail_tryclear boolean true smtp 4.05
519 tls_try_verify_hosts host list unset main 4.00
520 tls_verify_certificates string* unset main 3.20
521 unset smtp 3.20
522 tls_verify_hosts host list unset main 3.20
523 to string* unset autoreply
524 translate_ip_address string unset routers 4.00
525 transport string* unset routers 4.00
526 transport_current_directory string unset routers 4.00
527 transport_home_directory string unset routers 4.00
528 transport_filter string unset transports
529 transport_filter_timeout time 5m transports 4.30
530 trusted_groups string list unset main
531 trusted_users string list unset main
532 umask octal-integer 022 pipe
533 unknown_login string unset main
534 unknown_username string unset main
535 unseen boolean false routers 4.00
536 untrusted_set_sender boolean false main 3.20
537 use_bsmtp boolean false appendfile 4.00
538 false pipe 4.00
539 use_crlf boolean false appendfile 1.89
540 false pipe 1.89
541 use_fcntl_lock boolean + appendfile 1.70
542 use_flock_lock boolean + appendfile 4.11
543 use_lockfile boolean + appendfile
544 use_mbx_lock boolean + appendfile 2.10
545 use_shell boolean false pipe 1.70
546 user string + routers 4.00
547 unset transports 4.00 replaces individual options
548 uucp_from_pattern string + main 1.75
549 uucp_from_sender string* "$1" main 1.75
550 verify boolean true routers 4.00
551 verify_only boolean false routers 4.00
552 verify_recipient boolean true routers 4.00
553 verify_sender boolean true routers 4.00
554 warn_message_file string unset main 4.00
555 widen_domains string list unset dnslookup 4.00
556 write_rejectlog boolean true main 4.31
557
558
559
560 2. COMMAND LINE OPTIONS
561 -----------------------
562
563 The table below contains a complete list of all Exim's command line options.
564 Those marked with # are available only to trusted users, those marked with +
565 are available only to admin users, and those marked with * exist only to
566 provide compatibility with Sendmail.
567
568 -- Terminate options
569 --help Give a little help (not a lot)
570 -B * Ignored
571 -bd + Start daemon
572 -bdf + Start daemon and run it in the foreground
573 -be Test string expansion
574 -bF Test system filter file
575 -bf Test user filter file
576 -bfd Set domain for filter testing
577 -bfl Set local part for filter testing
578 -bfp Set local part prefix for filter testing
579 -bfs Set local part suffix for filter testing
580 -bh Test incoming SMTP call, omitting callouts
581 -bhc Test incoming SMTP call, with callouts
582 -bi * Run <command>bi_command</command>
583 -bm Accept message on standard input
584 -bnq Don't qualify addresses in locally submitted messages
585 -bP Show configuration option settings
586 -bp + List the queue
587 -bpa + ... with generated addresses as well
588 -bpc + ... but just show a count of messages
589 -bpr + ... do not sort
590 -bpra + ... with generated addresses, unsorted
591 -bpru + ... only undelivered addresses, unsorted
592 -bpu + ... only undelivered addresses
593 -brt Test retry rules
594 -brw Test rewriting rules
595 -bS Read batch SMTP on standard input
596 -bs Run SMTP on standard input and output
597 -bt Test address directing and routing
598 -bV Verify version number
599 -bv Test recipient address verification
600 -bvs Test sender address verification
601 -C + Use alternate configuration file
602 -D + Define macro for configuration file
603 -d + Turn on debugging output
604 -dd + Ditto, but if a daemon, not for subprocesses
605 -dropcr Remove CR character in input: became a no-op in 4.21
606 -E Internal use only
607 -ex * Synonym for -oex (for several different x)
608 -F Set calling user name
609 -f # Set calling user address
610 -G * Ignored
611 -h * Ignored
612 -i Dot does not terminate message
613 -M + Force deliver specific message
614 -Mar + Add recipient to message
615 -MC Internal use only
616 -MCA Internal use only
617 -MCP Internal use only
618 -MCQ Internal use only
619 -MCS Internal use only
620 -MCT Internal use only
621 -Mc + Deliver specific message
622 -Mes + Edit message sender
623 -Mf + Freeze message(s)
624 -Mg + Give up (bounce) message(s)
625 -Mmad + Mark all recipients delivered
626 -Mmd + Mark one recipient delivered
627 -Mrm + Remove message(s) (no bounce)
628 -Mt + Thaw message(s)
629 -Mvb + View message body
630 -Mvh + View message header
631 -Mvl + View message log
632 -m * Ignored
633 -N + Deliver without transporting
634 -n * Ignored
635 -O * Ignored
636 -oA * Supply argument for <option>-bi</option>
637 -oB Set max messages down one connection
638 -odb Background delivery
639 -odf Foreground delivery
640 -odi Foreground delivery
641 -odq Queue message; do not deliver
642 -odqs ... do not do SMTP deliveries
643 -oee Error sent by mail; zero return code
644 -oem Error sent by mail; non-zero return code
645 -oep Error written to standard error stream
646 -oeq * Error written to standard error stream
647 -oew * Error sent by mail; non-zero return code
648 -oi Dot does not terminate message
649 -oitrue * Dot does not terminate message
650 -oMa # Supply host address
651 -oMaa # Supply authenticator name
652 -oMai # Supply authenticated id
653 -oMas # Supply authenticated sender
654 -oMi # Supply interface address
655 -oMr # Supply protocol name
656 -oMs # Supply host name
657 -oMt # Supply ident string
658 -om * Ignored
659 -oo * Ignored
660 -oP * Specify path for daemon's pid file
661 -or Timeout non-SMTP messages
662 -os Timeout for SMTP messages
663 -ov * Verbose; same as -v
664 -oX Alternative port for daemon
665 -pd Delay Perl interpreter start
666 -ps Do not delay Perl interpreter start
667 -p<r>:<s> * Same as -oMr <r> -oMs <s>
668 -q + Run the queue )
669 -qf + ... force delivery ) Other combinations are
670 -qff + ... and include frozen messages ) possible. The syntax is
671 -qi + ... initial deliveries only )
672 -ql + ... local deliveries only ) -q[q][f][f][i|l][time]
673 -qq + Two-stage queue run )
674 -qR * Same as -R
675 -qS * Same as -S
676 -R Select by recipient in queue run
677 -Rf ... with forcing
678 -Rff ... and frozen messages
679 -Rr ... using regular expression
680 -Rrf ... with forcing
681 -Rrff ... and frozen messages
682 -r * Synonym for -f
683 -S Select by sender in queue run
684 -Sf ... with forcing
685 -Sff ... and frozen messages
686 -Sr ... using regular expression
687 -Srf ... with forcing
688 -Srff ... and frozen messages
689 -Tqt * Used by Exim test suite; not recognized in normal use
690 -t Take recipients from header lines
691 -ti * Same as -t -i
692 -tls-on-connect Do TLS on startup (for legacy clients)
693 -U * Ignored
694 -v Verbose - shows SMTP dialogue and other delivery info
695 -x Ignored (AIX compatibility)
696
697
698 3. BUILD TIME OPTIONS FOR EXIM
699 ------------------------------
700
701 The table below contains a complete list of options that can be set in
702 Local/Makefile when building Exim. More information about individual options
703 can be found in src/EDITME and OS/Makefile-Default.
704
705 The second column below gives the type of option:
706
707 . `system' means the option is concerned with the operating system;
708
709 . `driver' means the option selects a driver to be included in the binary;
710
711 . `lookup' means the option selects a lookuptype to be included in the binary;
712
713 . `mandatory' means the option is required to be supplied;
714
715 . `recommended' means the option is recommended to be supplied;
716
717 . `optional' means what it says;
718
719 Those marked with * are specialized and are unlikely to be required in most
720 installations. Those that are marked with ** are commonly set in OS-specific
721 Makefiles. If you use any of these in your Local/Makefile, you may need to
722 reproduce some of the OS-specific settings. For example, in the Makefile for
723 Solaris (which is actually called OS/Makefile-SunOS5), there is
724
725 LIBS=-lsocket -lnsl -lkstat
726
727 If you use LIBS to add extra libraries, you must also include the OS ones in
728 your setting. It is better, in this particular case, to use EXTRALIBS, which is
729 empty by default, and is provided for just this reason. Of course, if you do
730 actually want to modify a setting from the OS-specific file, there is nothing
731 to stop you overriding it in your Local/Makefile.
732
733 Option Type Description
734 ------------------------------------------------------------------------------
735
736 ALT_CONFIG_PREFIX optional restricts location of -C files
737 ALT_CONFIG_ROOT_ONLY optional* privileged -C needs root (not exim)
738 APPENDFILE_MODE optional*
739 APPENDFILE_DIRECTORY_MODE optional*
740 APPENDFILE_LOCKFILE_MODE optional*
741 AR system command to build a library
742 AUTH_CRAM_MD5 driver include cram_md5 authenticator
743 AUTH_CYRUS_SASL driver include Cyrus SASL authenticator
744 AUTH_PLAINTEXT driver include plaintext authenticator
745 AUTH_SPA driver include SPA (NTLM) authenticator
746 BASENAME_COMMAND system** path to basename
747 BASE_62=62 optional* not normally changed for Unix
748 BIN_DIRECTORY mandatory Exim binary directory
749 CC system** C compiler
750 CFLAGS system** flags for C compiler
751 CHGRP_COMMAND system** path to chgrp
752 CHOWN_COMMAND system** path to chown
753 COMPRESS_COMMAND system path to a compress command
754 COMPRESS_SUFFIX system suffix added to compressed files
755 CONFIGURE_FILE mandatory Exim runtime configuration file
756 CONFIGURE_FILE_USE_EUID optional*
757 CONFIGURE_FILE_USE_NODE optional*
758 CONFIGURE_GROUP optional* alternate group for configuration file
759 CONFIGURE_OWNER optional* alternate owner for configuration file
760 CYRUS_PWCHECK_SOCKET optional socket for pwcheck daemon
761 DBMLIB optional** location of DBM library
762 DB_DIRECTORY_MODE optional* mode for hints directory
763 DB_LOCKFILE_MODE optional* mode for hints lock files
764 DB_LOCK_TIMEOUT optional* timeout for hints lock files
765 DB_MODE optional* mode for hints files
766 DEFAULT_CRYPT optional use crypt16() as default
767 DELIVER_IN_BUFFER_SIZE optional*
768 DELIVER_OUT_BUFFER_SIZE optional*
769 DISABLE_D_OPTION optional disables -D option
770 ERRNO_QUOTA optional* error code for system quota failures
771 EXICYCLOG_MAX optional number of old log files to keep
772 EXIMDB_DIRECTORY_MODE optional* for hints database directory
773 EXIMDB_LOCKFILE_MODE optional* for hints lock files
774 EXIMDB_MODE optional* mode for hints files
775 EXIMON_TEXTPOP system**
776 EXIM_CHMOD optional*
777 EXIM_GROUP mandatory group to use for Exim
778 EXIM_MONITOR optional set to eximon.bin to compile
779 EXIM_PERL optional
780 EXIM_USER mandatory user to use for Exim
781 EXIWHAT_EGREP_ARG system** to find Exim processes from ps
782 EXIWHAT_KILL_SIGNAL system** -SIGUSER1 or numerical equivalent
783 EXIWHAT_MULTIKILL_CMD system**
784 EXIWHAT_MULTIKILL_ARG system**
785 EXIWHAT_PS_ARG system** to list all processes
786 EXIWHAT_PS_CMD system** path to ps command
787 EXTRALIBS system additional libraries
788 EXTRALIBS_EXIM system additional libraries for Exim only
789 EXTRALIBS_EXIMON system additional libraries for the monitor
790 FIXED_NEVER_USERS optional can't override at runtime
791 HAVE_ICONV system the iconv() function is available
792 HAVE_IPV6 system include IPv6 support
793 HEADERS_CHARSET optional charset for decoded header lines
794 HEADER_ADD_BUFFER_SIZE optional* buffer for header_add()
795 HEADER_MAXSIZE optional* max memory for message header
796 HOSTNAME_COMMAND system** path to hostname command
797 INCLUDE system path to include files
798 INFO_DIRECTORY optional directory for Info documentation
799 INPUT_DIRECTORY_MODE optional mode for input directory
800 IPV6_INCLUDE system additional includes for IPv6
801 IPV6_LIBS system additional libraries for IPv6
802 LDAP_LIB_TYPE optional type of LDAP library
803 LFLAGS system** link editor flags
804 LIBIDENTCFLAGS system C flags when compiling libident
805 LIBIDENTNAME system name for libident library
806 LIBRESOLV system** library for DNS resolver
807 LIBS system** additional libraries
808 LIBS_EXIM system** additional libraries for Exim ony
809 LIBS_EXIMON system** additional libraries for monitor
810 LOCAL_SCAN_SOURCE optional location of local_scan() source
811 LOG_DIRECTORY_MODE optional mode for log directory
812 LOG_FILE_PATH optional path to log files
813 LOG_MODE optional mode for log files
814 LOOKUP_CDB lookup include cdb lookup
815 LOOKUP_DBM lookup include dbm lookup
816 LOOKUP_DNSDB lookup include dnsdb lookup
817 LOOKUP_DSEARCH lookup include dsearch lookup
818 LOOKUP_INCLUDE lookup include files for lookups
819 LOOKUP_LDAP lookup include ldap lookup
820 LOOKUP_LIBS lookup include libraries for lookups
821 LOOKUP_LSEARCH lookup include all lsearch lookups
822 LOOKUP_MYSQL lookup include mysql lookup
823 LOOKUP_NIS lookup include nis lookup
824 LOOKUP_NISPLUS lookup include nisplus lookup
825 LOOKUP_ORACLE lookup include oracle lookup
826 LOOKUP_PGSQL lookup include pgsql lookup
827 LOOKUP_TESTDB lookup*
828 LOOKUP_WHOSON lookup include whoson lookup
829 MAKE_SHELL optional* shell to use for make
830 MAX_FILTER_SIZE optional* max file size for filter files
831 MAX_INCLUDE_SIZE optional* max file size for :include: files
832 MAX_LOCALHOST_NUMBER=256 optional* for when localhost_number is set
833 MAX_NAMED_LIST optional* max named lists of a given type
834 MAX_INTERFACES system maximum network interfaces
835 MSGLOG_DIRECTORY_MODE optional* mode for message log directory
836 MV_COMMAND system path to mv command
837 NO_SYMLINK optional install doesn't make 'exim" symlink
838 PCRE_CFLAGS system compile flags for PCRE library
839 PERL_CC system* compiler for Perl interface code
840 PERL_CCOPTS system* flags for same
841 PERL_COMMAND system path to Perl
842 PERL_LIBS system* library for compiling Perl interface
843 PID_FILE_PATH optional path to daemon's pid file
844 RADIUS_CONFIG_FILE optional path to Radius config file
845 RADIUS_LIB_TYPE optional type of RADIUS library
846 RANLIB system** path to ranlib command
847 RM_COMMAND system path to rm command
848 ROUTER_ACCEPT driver include accept router
849 ROUTER_DNSLOOKUP driver include dnslookup router
850 ROUTER_MANUALROUTE driver include manualroute router
851 ROUTER_IPLITERAL driver include ipliteral router
852 ROUTER_IPLOOKUP driver include iplookup router
853 ROUTER_REDIRECT driver include redirect router
854 ROUTER_QUERYPROGRAM driver include queryprogram router
855 SPOOL_DIRECTORY recommended path to spool directory
856 SPOOL_DIRECTORY_MODE optional mode of spool directory
857 SPOOL_MODE optional mode of spool files
858 STRING_SPRINTF_BUFFER_SIZE optional* buffer for string_sprintf()
859 STRIP_COMMAND optional* can be used to strp binaries
860 SUPPORT_A6 optional* support A6 DNS records
861 SUPPORT_CRYPTEQ optional support crypteq (if no auths)
862 SUPPORT_MAILDIR optional support for maildir delivery
863 SUPPORT_MAILSTORE optional support for mailstore delivery
864 SUPPORT_MBX optional support for MBX delivery
865 SUPPORT_MOVE_FROZEN_MESSAGES optional* support for frozen message moving
866 SUPPORT_PAM optional support for PAM authentication
867 SUPPORT_TLS optional support for TLS encryption over SMTP
868 SUPPORT_TRANSLATE_IP_ADDRESS optional* support for address translation
869 SYSLOG_LOG_PID optional add pid to syslog lines
870 SYSLOG_LONG_LINES optional do not split long syslog lines
871 SYSTEM_ALIASES_FILE optional defaults to /etc/aliases
872 TIMEZONE_DEFAULT optional default for timezone option
873 TLS_INCLUDE optional path to include files for TLS
874 TLS_LIBS optional additional libraries for TLS
875 TMPDIR system value for TMPDIR environment variable
876 TRANSPORT_APPENDFILE driver include appendfile transport
877 TRANSPORT_AUTOREPLY driver include autoreply transport
878 TRANSPORT_LMTP driver include lmtp transport
879 TRANSPORT_PIPE driver include pipe transport
880 TRANSPORT_SMTP driver include smtp transport
881 USE_DB system** use native DB interface
882 USE_GNUTLS optional use GnuTLS instead of OpenSSL
883 USE_READLINE optional try to load libreadline for -be
884 USE_TCP_WRAPPERS system link with tcpwrappers
885 USE_TDB optional use the tdb DB interface
886 X11 system** X11 base directory
887 X11_LD_LIB system** X11 link library
888 XINCLUDE system** X11 include directory
889 XLFLAGS system** X11 link time flags
890 ZCAT_COMMAND system path to zcat command
891
892
893 4. BUILD TIME OPTIONS FOR EXIMON
894 --------------------------------
895
896 The table below contains a complete list of options that can be set in
897 Local/eximon.conf when building the Exim monitor. Where the default is shown as
898 ** it means that the text string is too long to fit in the table and is instead
899 given below. A blank default means that there is no default value.
900
901 ACTION_OUTPUT=no show output for every action
902 ACTION_QUEUE_UPDATE=yes update queue display after actions
903 BODY_MAX=20000 maximum body display
904 DOMAIN= domain to strip from window title
905 LOG_BUFFER=20K buffer for log tail
906 LOG_DEPTH=300 depth of log subwindow
907 LOG_FONT=** font for log display
908 LOG_STRIPCHARTS=** patterns for stripcharts
909 LOG_WIDTH=950 width of log subwindow
910 MENU_EVENT='Shift<Btn1Down>' keypress for menu
911 MIN_HEIGHT=162 minimum window height
912 MIN_WIDTH=103 minimum window width
913 QUALIFY_DOMAIN= local domain to strip from addresses
914 QUEUE_DEPTH=200 depth of queue subwindow
915 QUEUE_FONT=$LOG_FONT font for queue display
916 QUEUE_INTERVAL=300 queue refresh interval
917 QUEUE_MAX_ADDRESSES=10 max addresses to show in queue
918 QUEUE_STRIPCHART_NAME=queue name for queue stripchart
919 QUEUE_WIDTH=950 width of queue subwindow
920 SIZE_STRIPCHART= request partition size stripchart
921 SIZE_STRIPCHART_NAME=space name for size stripchart
922 START_SMALL=no if yes, start with small window
923 STRIPCHART_INTERVAL=60 stripchart refresh interval
924 TEXT_DEPTH=200 depth of text windows
925 WINDOW_TITLE="${hostname} eximon" window title
926
927 The default for LOG_FONT is
928
929 LOG_FONT=-misc-fixed-medium-r-normal-*-14-140-*-*-*-*-iso8859-1
930
931 and the default for LOG_STRIPCHARTS is
932
933 LOG_STRIPCHARTS='/ <= /in/
934 / => /out/
935 / => .+ R=local/local/
936 / => .+ T=[^ ]*smtp/smtp/'
937
938 That is, there are four stripcharts, named in, out, local, and smtp. The first
939 counts message arrivals, the second counts all deliveries, the third counts
940 deliveries where the router's name starts with "local", and the fourth counts
941 deliveries where the transport name contains "smtp".
942
943 **** End of OptionLists ****