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