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