Add "server=" feature to MySQL and PostgreSQL lookups.
[exim.git] / doc / doc-txt / OptionLists.txt
CommitLineData
8669f003 1$Cambridge: exim/doc/doc-txt/OptionLists.txt,v 1.33 2007/06/27 11:01:51 ph10 Exp $
495ae4b0
PH
2
3LISTS OF EXIM OPTIONS
4---------------------
5
0bd1a913 6This file contains complete lists of four kinds of Exim option:
495ae4b0
PH
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
83da1223 14This file was last updated for Exim release 4.67.
495ae4b0
PH
15
16
171. RUN TIME OPTIONS
18-------------------
19
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.
25
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 ++.
33
34For options that are specific to a particular driver, the fourth column
35contains 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
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.
51
52-----------------------------------------------------------------------------------------
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
495ae4b0
PH
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
495ae4b0
PH
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
495ae4b0
PH
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
495ae4b0
PH
88authenticate_hosts host list unset smtp 3.13
89auto_thaw time 0s main
54cdb463 90av_scanner string* + main 4.50 with content scan
495ae4b0
PH
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
495ae4b0
PH
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
495ae4b0
PH
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
4aee0225
PH
148daemon_startup_retries int 9 main 4.52
149daemon_startup_sleep time 30s main 4.52
495ae4b0
PH
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
162directory string* unset appendfile
f324b55d 163directory_file string* + appendfile
495ae4b0
PH
164directory_mode octal-integer 0700 appendfile
165directory_transport string* unset redirect 4.00
7e66e54d 166disable_ipv6 boolean false main 4.61
495ae4b0 167disable_logging boolean false routers 4.11
7e66e54d 168 false transports 4.11
495ae4b0
PH
169dns_again_means_nonexist domain list unset main 1.89
170dns_check_names_pattern string + main 2.11
068aaea8
PH
171dns_csa_search_limit integer 5 main 4.60
172dns_csa_use_reverse boolean true main 4.60
495ae4b0
PH
173dns_ipv4_lookup boolean false main 3.20
174dns_qualify_single boolean true smtp
175dns_retrans time 0s main 1.60
176dns_retry integer 0 main 1.60
177dns_search_parents boolean false smtp
178domains domain list unset routers 4.00
179driver string unset authenticators
180 unset routers 4.00
181 unset transports
182drop_cr boolean false main 4.00 became a no-op in 4.21
f89d2485 183dsn_from string* + main 4.67
495ae4b0
PH
184envelope_to_add boolean false transports
185envelope_to_remove boolean true main
186environment string* unset pipe 2.95
187errors_copy string list* unset main
188errors_reply_to string unset main
189errors_to string* unset routers 4.00
190escape_string string ">From " appendfile 3.03
191 unset pipe 3.03
192exim_group string ++ main
193exim_path string ++ main
194exim_user string ++ main
195expn boolean true routers
196extra_local_interfaces string unset main 4.21
197extract_addresses_remove_arguments boolean true main 1.92
198fail_verify boolean false routers
199fail_verify_recipient boolean false routers 4.00
200fail_verify_sender boolean false routers 4.00
201fallback_hosts string list unset routers 4.00
202 unset smtp
203file string* unset appendfile
204 unset autoreply
205 unset redirect 4.00
206file_expand boolean false autoreply
207file_format string unset appendfile 3.03
208file_must_exist boolean false appendfile
209file_optional boolean false autoreply
210file_transport string* unset redirect 4.00
4608d683 211filter_prepend_home boolean true redirect 4.63
495ae4b0
PH
212final_timeout time 10m smtp
213finduser_retries integer 0 main
214forbid_blackhole boolean false redirect 4.00
23c7ff99 215forbid_exim_filter boolean false redirect 4.44
495ae4b0
PH
216forbid_fail boolean false redirect 4.00
217forbid_file boolean false redirect 4.00
218forbid_filter_existstest boolean false redirect 4.00
219forbid_filter_logwrite boolean false redirect 4.00
220forbid_filter_lookup boolean false redirect 4.00
221forbid_filter_perl boolean false redirect 4.00
222forbid_filter_readfile boolean false redirect 4.00
223forbid_filter_readsocket boolean false redirect 4.11
224forbid_filter_reply boolean false redirect 4.00
225forbid_filter_run boolean false redirect 4.00
226forbid_include boolean false redirect 4.00
227forbid_pipe boolean false redirect 4.00
23c7ff99 228forbid_sieve_filter boolean false redirect 4.44
5abeaa6e 229forbid_smtp_code boolean false redirect 4.63
495ae4b0
PH
230freeze_exec_fail boolean false pipe 1.89
231freeze_tell boolean false main 4.00 replaces freeze_tell_mailmaster
232from string* unset autoreply
233gecos_name string* unset main
234gecos_pattern string unset main
235gethostbyname boolean false smtp
83da1223
PH
236gnutls_require_kx string* unset main 4.67
237 string* unset smtp 4.67
238gnutls_require_mac string* unset main 4.67
239 string* unset smtp 4.67
240gnutls_require_protocols string* unset main 4.67
241 string* unset smtp 4.67
495ae4b0
PH
242group string + routers 4.00
243 unset transports 4.00 replaces local option in some transports
244header_line_maxsize integer 0 (unset) main 4.14
245header_maxsize integer 1M main 4.14
246headers string* unset autoreply
247headers_add string* unset routers 4.00
248 unset transports
249headers_charset string ++ main 4.21
250headers_only boolean false transports 2.05
251headers_remove string* unset routers 4.00
252 unset transports
253headers_rewrite string unset transports 3.20
254helo_accept_junk_hosts host list unset main 3.00
255helo_allow_chars string "" main 4.02
256helo_lookup_domains domain list unset main 4.00
257helo_data string* "$primary_hostname" smtp 3.21
258helo_try_verify_hosts host list unset main 4.00
259helo_verify_hosts host list unset main 1.73
260hide_child_in_errmsg false redirect 4.00
261hold_domains domain list unset main 1.70
262home_directory string* unset transports 4.00 replaces individual options
c456d9bb 263host_all_ignored string "defer" manualroute 4.67
495ae4b0
PH
264host_find_failed string "freeze" manualroute 4.00
265host_lookup host list unset main 3.00
266host_lookup_order string list "bydns:byaddr" main 4.30
267host_reject_connection host list unset main 4.00
268hosts string unset iplookup 4.00
269 string list* unset smtp
270hosts_avoid_esmtp host list unset smtp 4.21
c51b8e75 271hosts_avoid_pipelining host list unset smtp 4.67
495ae4b0
PH
272hosts_avoid_tls host list unset smtp 3.20
273hosts_connection_nolog host list unset main 4.43
274hosts_max_try integer 5 smtp 3.20
533244af 275hosts_max_try_hardlimit integer 50 smtp 4.50
495ae4b0
PH
276hosts_nopass_tls host list unset smtp 4.00
277hosts_override boolean false smtp 2.11
278hosts_randomize boolean false manualroute 4.00
279 false smtp 3.14
280hosts_require_auth host list unset smtp 4.00
281hosts_require_tls host list unset smtp 3.20
282hosts_treat_as_local domain list unset main 1.95
283hosts_try_auth host list unset smtp 4.00
284ignore_bounce_errors_after time 0s main 4.00
285ignore_eacces boolean false redirect 4.00
286ignore_enotdir boolean false redirect 4.00
287ignore_fromline_hosts host list unset main
288ignore_fromline_local boolean false main 2.05
289ignore_status boolean false pipe
290ignore_target_hosts host list unset routers 4.00
291include_directory string unset redirect 4.00
292initgroups false routers 4.00
293interface string list unset smtp 1.70
294keep_malformed time 4d main
295keepalive boolean true smtp 2.05
296ldap_default_servers string list unset main 3.02
297ldap_version int 2 or 3 main 4.14
298local_from_check boolean true main 3.14
299local_from_prefix string unset main 3.14
300local_from_suffix string unset main 3.14
301local_interfaces string list unset main 1.60
302local_part_prefix string unset routers 4.00 replaces prefix
303local_part_prefix_optional boolean unset routers 4.00 replaces prefix_optional
304local_part_suffix string unset routers 4.00 replaces suffix
305local_part_suffix_optional boolean unset routers 4.00 replaces suffix_optional
306local_parts string list* unset routers 4.00
307local_scan_timeout time 5m main 4.03
308local_sender_retain boolean false main 4.00
309localhost_number string unset main
310lock_fcntl_timeout time 0s appendfile 3.14
311lock_flock_timeout time 0s appendfile 4.11
312lock_interval time 3s appendfile
313lock_retries integer 10 appendfile
314lockfile_mode octal-integer 0600 appendfile
315lockfile_timeout time 30m appendfile
316log string* unset autoreply
317log_as_local boolean + routers 4.00
318log_file_path string list ++ main
319log_defer_output boolean false pipe 1.89
320log_fail_output boolean false pipe 1.60
321log_output boolean false pipe 1.60
322log_selector string unset main 4.00
323log_timezone boolean false main 4.11
324lookup_open_max integer 25 main 2.05
325mailbox_filecount string* unset appendfile 4.43
326mailbox_size string* unset appendfile 4.43
327maildir_format boolean false appendfile 1.70
328maildir_retries integer 10 appendfile 1.70
329maildir_tag string* unset appendfile 1.92
330maildir_use_size_file boolean false appendfile 4.30
d6629cdc 331maildirfolder_create_regex string unset appendfile 4.62
495ae4b0
PH
332mailstore_format boolean false appendfile 2.00
333mailstore_prefix string* unset appendfile 2.00
334mailstore_suffix string* unset appendfile 2.00
335match_directory string* unset localuser
336max_output integer 20K pipe
337max_rcpt integer 100 smtp 1.60
338max_user_name_length integer 0 main
339mbx_format boolean false appendfile 2.10
340message_body_visible integer 500 main
341message_id_header_domain string* unset main 4.11
342message_id_header_text string* unset main
343message_logs boolean true main 4.10
344message_prefix string* + appendfile 4.00 replaces prefix
345 string* unset pipe 4.00 replaces prefix
1c098beb 346message_size_limit integer 50M main
495ae4b0
PH
347 0 transports 2.05
348message_suffix string* + appendfile 4.00 replaces suffix
349 string* unset pipe 4.00 replaces suffix
350mode octal-integer 0600 appendfile
351 0600 autoreply
352mode_fail_narrower boolean true appendfile 1.70
353modemask octal-integer 022 redirect 4.00
354more boolean true routers 4.00
355move_frozen_messages boolean false main 3.09
356multi_domain boolean true smtp
357mx_domains domain list unset dnslookup 4.00
358mx_fail_domains domain list unset dnslookup 4.43
359mysql_servers string list unset main 3.03
360never_users string list unset main
361notify_comsat boolean false appendfile
362once string* unset autoreply
363once_file_size integer 0 autoreply 3.20
364once_repeat time 0s autoreply 2.95
365one_time boolean false redirect 4.00
366optional boolean false iplookup 4.00
367oracle_servers string unset main 4.00
368owners string list unset redirect 4.00
369owngroups string list unset redirect 4.00
370pass_on_timeout boolean false routers 4.00
371pass_router string unset routers 4.00
372path string "/usr/bin" pipe
373percent_hack_domains domain list unset main
374perl_at_start boolean false main 2.10
375perl_startup string unset main 2.10
376pgsql_servers string list unset main 3.14
377pid_file_path string ++ main
378pipe_as_creator boolean false pipe
379pipe_transport string* unset redirect 4.00
380pipelining_advertise_hosts host list "*" main 4.14
381port integer 0 iplookup 4.00
382 string "smtp" smtp
383preserve_message_logs boolean false main
384primary_hostname string + main
385print_topbitchars boolean false main 1.89
386process_log_path string unset main 4.21
387prod_requires_admin boolean true main 1.70
388protocol string "udp" iplookup 4.00
389 string "smtp" smtp 3.20
390public_name string unset authenticators 3.10
391qualify_domain string + main
392 string* unset redirect 4.31
393qualify_preserve_domain boolean false redirect 4.00
394qualify_recipient string + main
395qualify_single boolean true dnslookup 4.00
396query string* + iplookup 4.00
397queue_domains domain list unset main 4.00
398queue_list_requires_admin boolean true main 1.95
399queue_only boolean false main
400queue_only_file string unset main 2.05
401queue_only_load fixed-point unset main
8669f003 402queue_only_load_latch boolean true main 4.68
495ae4b0
PH
403queue_only_override boolean true main 4.21
404queue_run_in_order boolean false main 1.70
405queue_run_max integer 5 main
406queue_smtp_domains domain list unset main
407quota string* unset appendfile 1.60
408quota_directory string* unset appendfile 4.11
409quota_filecount integer 0 appendfile 2.05
410quota_is_inclusive boolean true appendfile 3.20
411quota_size_regex string unset appendfile 3.14
412quota_warn_message string* + appendfile 2.10
413quota_warn_threshold string* 0 appendfile 2.10
414rcpt_include_affixes boolean false transports 4.21
415receive_timeout time 0s main 4.00 replacing accept_timeout
416received_header_text string* + main
417received_headers_max integer 30 main
418recipient_unqualified_hosts host list unset main 4.00 replacing receiver_unqualified_hosts
419recipients_max integer 0 main 1.60
420recipients_max_reject boolean false main 1.70
421redirect_router string unset routers 4.00
422remote_max_parallel integer 1 main
423remote_sort_domains domain list unset main 4.00 replacing remote_sort
424repeat_use boolean true redirect 4.00
425reply_to string* unset autoreply 2.05
426reply_transport string* unset redirect 4.00
427require_files string list* unset routers 4.00
428reroute string* unset iplookup 4.00
429response_pattern string unset iplookup 4.00
430restrict_to_path boolean false pipe
431retry_data_expire time 7d main 3.03
432retry_include_ip_address boolean true smtp 1.92
433retry_interval_max time 24h main
434retry_use_local_part boolean + routers 4.00
435 + transports 4.00 replacing individual options
436return_fail_output boolean false pipe 1.60
437return_message boolean false autoreply
438return_output boolean false pipe
439return_path string* unset transports 2.05
440return_path_add boolean false transports
441return_path_remove boolean true main
442return_size_limit integer 100K main renamed bounce_return_size_limit in 4.23
443rewrite boolean true redirect 4.00
444rewrite_headers boolean true dnslookup 4.00
445rfc1413_hosts host list * main
8def5aaf 446rfc1413_query_timeout time 5s main
495ae4b0
PH
447router_home_directory string* unset routers 4.11
448route_data string* unset manualroute 4.00
449route_list string list unset manualroute 4.00
450same_domain_copy_routing boolean false dnslookup 4.00
451search_parents boolean false dnslookup 4.00
452self string "freeze" routers 4.00
453sender_unqualified_hosts host list unset main
454senders address list unset routers 4.00
455serialize_hosts host list unset smtp 1.60
456server_advertise_condition string* unset authenticators 4.14
16ff981e 457server_condition string* unset authenticators 3.10 (plaintext) 4.64 (others)
495ae4b0
PH
458server_hostname string* "$primary_hostname" cyrus_sasl 4.43
459server_mail_auth_condition string* unset authenticators 3.22
460server_mech string public_name cyrus_sasl 4.43
461server_prompts string* unset plaintext 3.10
462server_realm string unset cyrus_sasl 4.43
463server_secret string* unset cram_md5 3.10
464server_service string "smtp" cyrus_sasl 4.43
465server_set_id string* unset authenticators 3.10
466shadow_condition string* unset transports
467shadow_transport string unset transports
468size_addition integer 1024 smtp 1.91
469skip_syntax_errors boolean false redirect 4.00
470smtp_accept_keepalive boolean true main
471smtp_accept_max integer 20 main
472smtp_accept_max_nonmail integer 10 main 4.11
473smtp_accept_max_nonmail_hosts host list * main 4.14
474smtp_accept_max_per_connection integer 1000 main 4.00
475smtp_accept_max_per_host integer 0 main 2.05
476smtp_accept_queue integer 0 main
477smtp_accept_queue_per_connection integer 10 main 2.03
478smtp_accept_reserve integer 0 main
479smtp_active_hostname string* unset main 4.33
480smtp_banner string* + main
481smtp_check_spool_space boolean true main 2.10
482smtp_connect_backlog integer 5 main
483smtp_enforce_sync boolean true main 4.00
484smtp_etrn_command string* unset main 1.92
485smtp_etrn_serialize boolean true main 1.89
486smtp_load_reserve fixed-point unset main
487smtp_max_synprot_errors integer 3 main 4.30
488smtp_max_unknown_commands integer 3 main 4.14
489smtp_ratelimit_hosts host list unset main 4.00
490smtp_ratelimit_mail string unset main 4.00
491smtp_ratelimit_rcpt string unset main 4.00
492smtp_receive_timeout time 5m main
493smtp_reserve_hosts host list unset main
494smtp_return_error_details boolean false main 4.11
495socket string* unset lmtp 4.11
54cdb463 496spamd_address string + main 4.50 with content scan
495ae4b0
PH
497split_spool_directory boolean false main 1.70
498spool_directory string ++ main
31480e42 499sqlite_lock_timeout time 5s main 4.53
38a0a95f 500strict_acl_vars boolean false main 4.64
495ae4b0
PH
501srv_fail_domains domain list unset dnslookup 4.43
502strip_excess_angle_brackets boolean false main
503strip_trailing_dot boolean false main
504subject string* unset autoreply
505syntax_errors_text string* unset redirect 4.00
506syntax_errors_to string unset redirect 4.00
507syslog_duplication boolean true main 4.21
508syslog_facility string unset main 4.20
509syslog_processname string "exim" main 4.20
510syslog_timestamp boolean true main 4.00
511system_filter string unset main 4.00 replacing message_filter
512system_filter_directory_transport string unset main 4.00 replacing message_filter
513system_filter_file_transport string unset main 4.00 replacing message_filter
514system_filter_group string unset main 4.00 replacing message_filter
515system_filter_pipe_transport string unset main 4.00 replacing message_filter
516system_filter_reply_transport string unset main 4.00 replacing message_filter
517system_filter_user string unset main 4.00 replacing message_filter
518tcp_nodelay boolean true main 4.23
519 true smtp 4.23
520temp_errors string list + pipe 1.95
521text string* unset autoreply
522timeout time 5m lmtp 3.20
523 1h pipe
524 1h queryprogram 4.00
525 5s iplookup 4.00
2e2a30b4 526timeout_defer boolean false pipe 4.51
495ae4b0
PH
527timeout_frozen_after time 0s main 3.20
528timezone string + main 3.15
529tls_advertise_hosts host list * main 3.20
530tls_certificate string* unset main 3.20
531 unset smtp 3.20
532tls_dhparam string* unset main 3.20
533tls_on_connect_ports string unset main 4.43
534tls_privatekey string* unset main 3.20
535 unset smtp 3.20
536tls_remember_emstp boolean false main 4.21
537tls_require_ciphers string* unset smtp 4.00 replaces tls_verify_ciphers
538 string* unset main 4.33
539tls_tempfail_tryclear boolean true smtp 4.05
540tls_try_verify_hosts host list unset main 4.00
541tls_verify_certificates string* unset main 3.20
542 unset smtp 3.20
543tls_verify_hosts host list unset main 3.20
544to string* unset autoreply
545translate_ip_address string unset routers 4.00
546transport string* unset routers 4.00
547transport_current_directory string unset routers 4.00
548transport_home_directory string unset routers 4.00
549transport_filter string unset transports
550transport_filter_timeout time 5m transports 4.30
551trusted_groups string list unset main
552trusted_users string list unset main
553umask octal-integer 022 pipe
554unknown_login string unset main
555unknown_username string unset main
556unseen boolean false routers 4.00
557untrusted_set_sender boolean false main 3.20
558use_bsmtp boolean false appendfile 4.00
559 false pipe 4.00
560use_crlf boolean false appendfile 1.89
561 false pipe 1.89
562use_fcntl_lock boolean + appendfile 1.70
563use_flock_lock boolean + appendfile 4.11
564use_lockfile boolean + appendfile
565use_mbx_lock boolean + appendfile 2.10
566use_shell boolean false pipe 1.70
567user string + routers 4.00
568 unset transports 4.00 replaces individual options
569uucp_from_pattern string + main 1.75
570uucp_from_sender string* "$1" main 1.75
571verify boolean true routers 4.00
572verify_only boolean false routers 4.00
573verify_recipient boolean true routers 4.00
574verify_sender boolean true routers 4.00
575warn_message_file string unset main 4.00
576widen_domains string list unset dnslookup 4.00
577write_rejectlog boolean true main 4.31
578
579
580
5812. COMMAND LINE OPTIONS
582-----------------------
583
584The table below contains a complete list of all Exim's command line options.
585Those marked with # are available only to trusted users, those marked with +
586are available only to admin users, and those marked with * exist only to
587provide compatibility with Sendmail.
588
589-- Terminate options
590--help Give a little help (not a lot)
591-B * Ignored
592-bd + Start daemon
593-bdf + Start daemon and run it in the foreground
594-be Test string expansion
328895cc 595-bem Test string expansion, read test message first
495ae4b0
PH
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
608-bp + List the queue
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
3d235903
PH
625-d + Turn on debugging output
626-dd + Ditto, but if a daemon, not for subprocesses
495ae4b0
PH
627-dropcr Remove CR character in input: became a no-op in 4.21
628-E Internal use only
629-ex * Synonym for -oex (for several different x)
630-F Set calling user name
631-f # Set calling user address
632-G * Ignored
633-h * Ignored
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)
328895cc 650-Mset + Load message's variables when testing with -be
495ae4b0
PH
651-Mt + Thaw message(s)
652-Mvb + View message body
653-Mvh + View message header
654-Mvl + View message log
655-m * Ignored
656-N + Deliver without transporting
657-n * Ignored
658-O * Ignored
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
681-om * Ignored
682-oo * Ignored
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>
691-q + Run the queue )
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 )
697-qR * Same as -R
698-qS * Same as -S
699-R Select by recipient in queue run
700-Rf ... with forcing
701-Rff ... and frozen messages
702-Rr ... using regular expression
703-Rrf ... with forcing
704-Rrff ... and frozen messages
705-r * Synonym for -f
706-S Select by sender in queue run
707-Sf ... with forcing
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
714-ti * Same as -t -i
715-tls-on-connect Do TLS on startup (for legacy clients)
716-U * Ignored
717-v Verbose - shows SMTP dialogue and other delivery info
718-x Ignored (AIX compatibility)
719
720
7213. BUILD TIME OPTIONS FOR EXIM
722------------------------------
723
724The table below contains a complete list of options that can be set in
725Local/Makefile when building Exim. More information about individual options
726can be found in src/EDITME and OS/Makefile-Default.
727
728The second column below gives the type of option:
729
730 . `system' means the option is concerned with the operating system;
731
732 . `driver' means the option selects a driver to be included in the binary;
733
734 . `lookup' means the option selects a lookuptype to be included in the binary;
735
736 . `mandatory' means the option is required to be supplied;
737
738 . `recommended' means the option is recommended to be supplied;
739
740 . `optional' means what it says;
741
742Those marked with * are specialized and are unlikely to be required in most
743installations. Those that are marked with ** are commonly set in OS-specific
744Makefiles. If you use any of these in your Local/Makefile, you may need to
745reproduce some of the OS-specific settings. For example, in the Makefile for
746Solaris (which is actually called OS/Makefile-SunOS5), there is
747
748 LIBS=-lsocket -lnsl -lkstat
749
750If you use LIBS to add extra libraries, you must also include the OS ones in
751your setting. It is better, in this particular case, to use EXTRALIBS, which is
752empty by default, and is provided for just this reason. Of course, if you do
753actually want to modify a setting from the OS-specific file, there is nothing
754to stop you overriding it in your Local/Makefile.
755
756Option Type Description
757------------------------------------------------------------------------------
758
759ALT_CONFIG_PREFIX optional restricts location of -C files
760ALT_CONFIG_ROOT_ONLY optional* privileged -C needs root (not exim)
761APPENDFILE_MODE optional*
762APPENDFILE_DIRECTORY_MODE optional*
763APPENDFILE_LOCKFILE_MODE optional*
764AR system command to build a library
765AUTH_CRAM_MD5 driver include cram_md5 authenticator
068aaea8 766AUTH_CYRUS_SASL driver include Cyrus SASL authenticator
495ae4b0
PH
767AUTH_PLAINTEXT driver include plaintext authenticator
768AUTH_SPA driver include SPA (NTLM) authenticator
f78eb7c6 769AUTH_VARS=3 optional* number of $auth variables
495ae4b0
PH
770BASENAME_COMMAND system** path to basename
771BASE_62=62 optional* not normally changed for Unix
772BIN_DIRECTORY mandatory Exim binary directory
773CC system** C compiler
774CFLAGS system** flags for C compiler
775CHGRP_COMMAND system** path to chgrp
776CHOWN_COMMAND system** path to chown
777COMPRESS_COMMAND system path to a compress command
778COMPRESS_SUFFIX system suffix added to compressed files
779CONFIGURE_FILE mandatory Exim runtime configuration file
780CONFIGURE_FILE_USE_EUID optional*
781CONFIGURE_FILE_USE_NODE optional*
35edf2ff 782CONFIGURE_GROUP optional* alternate group for configuration file
495ae4b0
PH
783CONFIGURE_OWNER optional* alternate owner for configuration file
784CYRUS_PWCHECK_SOCKET optional socket for pwcheck daemon
785DBMLIB optional** location of DBM library
786DB_DIRECTORY_MODE optional* mode for hints directory
787DB_LOCKFILE_MODE optional* mode for hints lock files
788DB_LOCK_TIMEOUT optional* timeout for hints lock files
789DB_MODE optional* mode for hints files
96c065cb 790DEFAULT_CRYPT optional default crypt() function
495ae4b0
PH
791DELIVER_IN_BUFFER_SIZE optional*
792DELIVER_OUT_BUFFER_SIZE optional*
793DISABLE_D_OPTION optional disables -D option
794ERRNO_QUOTA optional* error code for system quota failures
795EXICYCLOG_MAX optional number of old log files to keep
796EXIMDB_DIRECTORY_MODE optional* for hints database directory
797EXIMDB_LOCKFILE_MODE optional* for hints lock files
798EXIMDB_MODE optional* mode for hints files
799EXIMON_TEXTPOP system**
800EXIM_CHMOD optional*
801EXIM_GROUP mandatory group to use for Exim
802EXIM_MONITOR optional set to eximon.bin to compile
803EXIM_PERL optional
804EXIM_USER mandatory user to use for Exim
805EXIWHAT_EGREP_ARG system** to find Exim processes from ps
806EXIWHAT_KILL_SIGNAL system** -SIGUSER1 or numerical equivalent
807EXIWHAT_MULTIKILL_CMD system**
808EXIWHAT_MULTIKILL_ARG system**
809EXIWHAT_PS_ARG system** to list all processes
810EXIWHAT_PS_CMD system** path to ps command
811EXTRALIBS system additional libraries
812EXTRALIBS_EXIM system additional libraries for Exim only
813EXTRALIBS_EXIMON system additional libraries for the monitor
814FIXED_NEVER_USERS optional can't override at runtime
815HAVE_ICONV system the iconv() function is available
816HAVE_IPV6 system include IPv6 support
817HEADERS_CHARSET optional charset for decoded header lines
818HEADER_ADD_BUFFER_SIZE optional* buffer for header_add()
819HEADER_MAXSIZE optional* max memory for message header
820HOSTNAME_COMMAND system** path to hostname command
821INCLUDE system path to include files
822INFO_DIRECTORY optional directory for Info documentation
823INPUT_DIRECTORY_MODE optional mode for input directory
824IPV6_INCLUDE system additional includes for IPv6
825IPV6_LIBS system additional libraries for IPv6
826LDAP_LIB_TYPE optional type of LDAP library
827LFLAGS system** link editor flags
828LIBIDENTCFLAGS system C flags when compiling libident
829LIBIDENTNAME system name for libident library
830LIBRESOLV system** library for DNS resolver
831LIBS system** additional libraries
832LIBS_EXIM system** additional libraries for Exim ony
833LIBS_EXIMON system** additional libraries for monitor
834LOCAL_SCAN_SOURCE optional location of local_scan() source
835LOG_DIRECTORY_MODE optional mode for log directory
836LOG_FILE_PATH optional path to log files
837LOG_MODE optional mode for log files
838LOOKUP_CDB lookup include cdb lookup
839LOOKUP_DBM lookup include dbm lookup
840LOOKUP_DNSDB lookup include dnsdb lookup
841LOOKUP_DSEARCH lookup include dsearch lookup
842LOOKUP_INCLUDE lookup include files for lookups
843LOOKUP_LDAP lookup include ldap lookup
844LOOKUP_LIBS lookup include libraries for lookups
845LOOKUP_LSEARCH lookup include all lsearch lookups
846LOOKUP_MYSQL lookup include mysql lookup
847LOOKUP_NIS lookup include nis lookup
848LOOKUP_NISPLUS lookup include nisplus lookup
849LOOKUP_ORACLE lookup include oracle lookup
850LOOKUP_PGSQL lookup include pgsql lookup
851LOOKUP_TESTDB lookup*
852LOOKUP_WHOSON lookup include whoson lookup
853MAKE_SHELL optional* shell to use for make
854MAX_FILTER_SIZE optional* max file size for filter files
855MAX_INCLUDE_SIZE optional* max file size for :include: files
856MAX_LOCALHOST_NUMBER=256 optional* for when localhost_number is set
857MAX_NAMED_LIST optional* max named lists of a given type
858MAX_INTERFACES system maximum network interfaces
859MSGLOG_DIRECTORY_MODE optional* mode for message log directory
860MV_COMMAND system path to mv command
861NO_SYMLINK optional install doesn't make 'exim" symlink
862PCRE_CFLAGS system compile flags for PCRE library
863PERL_CC system* compiler for Perl interface code
864PERL_CCOPTS system* flags for same
865PERL_COMMAND system path to Perl
866PERL_LIBS system* library for compiling Perl interface
867PID_FILE_PATH optional path to daemon's pid file
868RADIUS_CONFIG_FILE optional path to Radius config file
869RADIUS_LIB_TYPE optional type of RADIUS library
870RANLIB system** path to ranlib command
871RM_COMMAND system path to rm command
872ROUTER_ACCEPT driver include accept router
873ROUTER_DNSLOOKUP driver include dnslookup router
874ROUTER_MANUALROUTE driver include manualroute router
875ROUTER_IPLITERAL driver include ipliteral router
876ROUTER_IPLOOKUP driver include iplookup router
877ROUTER_REDIRECT driver include redirect router
878ROUTER_QUERYPROGRAM driver include queryprogram router
879SPOOL_DIRECTORY recommended path to spool directory
880SPOOL_DIRECTORY_MODE optional mode of spool directory
881SPOOL_MODE optional mode of spool files
882STRING_SPRINTF_BUFFER_SIZE optional* buffer for string_sprintf()
883STRIP_COMMAND optional* can be used to strp binaries
884SUPPORT_A6 optional* support A6 DNS records
885SUPPORT_CRYPTEQ optional support crypteq (if no auths)
886SUPPORT_MAILDIR optional support for maildir delivery
887SUPPORT_MAILSTORE optional support for mailstore delivery
888SUPPORT_MBX optional support for MBX delivery
889SUPPORT_MOVE_FROZEN_MESSAGES optional* support for frozen message moving
890SUPPORT_PAM optional support for PAM authentication
891SUPPORT_TLS optional support for TLS encryption over SMTP
892SUPPORT_TRANSLATE_IP_ADDRESS optional* support for address translation
893SYSLOG_LOG_PID optional add pid to syslog lines
894SYSLOG_LONG_LINES optional do not split long syslog lines
895SYSTEM_ALIASES_FILE optional defaults to /etc/aliases
896TIMEZONE_DEFAULT optional default for timezone option
897TLS_INCLUDE optional path to include files for TLS
898TLS_LIBS optional additional libraries for TLS
899TMPDIR system value for TMPDIR environment variable
900TRANSPORT_APPENDFILE driver include appendfile transport
901TRANSPORT_AUTOREPLY driver include autoreply transport
902TRANSPORT_LMTP driver include lmtp transport
903TRANSPORT_PIPE driver include pipe transport
904TRANSPORT_SMTP driver include smtp transport
905USE_DB system** use native DB interface
906USE_GNUTLS optional use GnuTLS instead of OpenSSL
907USE_READLINE optional try to load libreadline for -be
908USE_TCP_WRAPPERS system link with tcpwrappers
909USE_TDB optional use the tdb DB interface
910X11 system** X11 base directory
911X11_LD_LIB system** X11 link library
912XINCLUDE system** X11 include directory
913XLFLAGS system** X11 link time flags
914ZCAT_COMMAND system path to zcat command
915
916
9174. BUILD TIME OPTIONS FOR EXIMON
918--------------------------------
919
920The table below contains a complete list of options that can be set in
921Local/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
923given below. A blank default means that there is no default value.
924
925ACTION_OUTPUT=no show output for every action
926ACTION_QUEUE_UPDATE=yes update queue display after actions
927BODY_MAX=20000 maximum body display
928DOMAIN= domain to strip from window title
929LOG_BUFFER=20K buffer for log tail
930LOG_DEPTH=300 depth of log subwindow
931LOG_FONT=** font for log display
932LOG_STRIPCHARTS=** patterns for stripcharts
933LOG_WIDTH=950 width of log subwindow
934MENU_EVENT='Shift<Btn1Down>' keypress for menu
935MIN_HEIGHT=162 minimum window height
936MIN_WIDTH=103 minimum window width
937QUALIFY_DOMAIN= local domain to strip from addresses
938QUEUE_DEPTH=200 depth of queue subwindow
939QUEUE_FONT=$LOG_FONT font for queue display
940QUEUE_INTERVAL=300 queue refresh interval
941QUEUE_MAX_ADDRESSES=10 max addresses to show in queue
942QUEUE_STRIPCHART_NAME=queue name for queue stripchart
943QUEUE_WIDTH=950 width of queue subwindow
944SIZE_STRIPCHART= request partition size stripchart
945SIZE_STRIPCHART_NAME=space name for size stripchart
946START_SMALL=no if yes, start with small window
947STRIPCHART_INTERVAL=60 stripchart refresh interval
948TEXT_DEPTH=200 depth of text windows
949WINDOW_TITLE="${hostname} eximon" window title
950
951The default for LOG_FONT is
952
953 LOG_FONT=-misc-fixed-medium-r-normal-*-14-140-*-*-*-*-iso8859-1
954
955and the default for LOG_STRIPCHARTS is
956
957 LOG_STRIPCHARTS='/ <= /in/
958 / => /out/
959 / => .+ R=local/local/
960 / => .+ T=[^ ]*smtp/smtp/'
961
962That is, there are four stripcharts, named in, out, local, and smtp. The first
963counts message arrivals, the second counts all deliveries, the third counts
964deliveries where the router's name starts with "local", and the fourth counts
965deliveries where the transport name contains "smtp".
966
967**** End of OptionLists ****