ClamAV INSTREAM scanning by default, unless built with WITH_OLD_CLAMAV_STREAM.
[exim.git] / doc / doc-txt / OptionLists.txt
CommitLineData
595028e4 1$Cambridge: exim/doc/doc-txt/OptionLists.txt,v 1.35 2007/08/29 13:37:28 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
595028e4 284ibase_servers string unset main 4.23
495ae4b0
PH
285ignore_bounce_errors_after time 0s main 4.00
286ignore_eacces boolean false redirect 4.00
287ignore_enotdir boolean false redirect 4.00
288ignore_fromline_hosts host list unset main
289ignore_fromline_local boolean false main 2.05
290ignore_status boolean false pipe
291ignore_target_hosts host list unset routers 4.00
292include_directory string unset redirect 4.00
293initgroups false routers 4.00
294interface string list unset smtp 1.70
295keep_malformed time 4d main
296keepalive boolean true smtp 2.05
297ldap_default_servers string list unset main 3.02
298ldap_version int 2 or 3 main 4.14
299local_from_check boolean true main 3.14
300local_from_prefix string unset main 3.14
301local_from_suffix string unset main 3.14
302local_interfaces string list unset main 1.60
303local_part_prefix string unset routers 4.00 replaces prefix
304local_part_prefix_optional boolean unset routers 4.00 replaces prefix_optional
305local_part_suffix string unset routers 4.00 replaces suffix
306local_part_suffix_optional boolean unset routers 4.00 replaces suffix_optional
307local_parts string list* unset routers 4.00
308local_scan_timeout time 5m main 4.03
309local_sender_retain boolean false main 4.00
310localhost_number string unset main
311lock_fcntl_timeout time 0s appendfile 3.14
312lock_flock_timeout time 0s appendfile 4.11
313lock_interval time 3s appendfile
314lock_retries integer 10 appendfile
315lockfile_mode octal-integer 0600 appendfile
316lockfile_timeout time 30m appendfile
317log string* unset autoreply
318log_as_local boolean + routers 4.00
319log_file_path string list ++ main
320log_defer_output boolean false pipe 1.89
321log_fail_output boolean false pipe 1.60
322log_output boolean false pipe 1.60
323log_selector string unset main 4.00
324log_timezone boolean false main 4.11
325lookup_open_max integer 25 main 2.05
326mailbox_filecount string* unset appendfile 4.43
327mailbox_size string* unset appendfile 4.43
328maildir_format boolean false appendfile 1.70
329maildir_retries integer 10 appendfile 1.70
330maildir_tag string* unset appendfile 1.92
331maildir_use_size_file boolean false appendfile 4.30
d6629cdc 332maildirfolder_create_regex string unset appendfile 4.62
495ae4b0
PH
333mailstore_format boolean false appendfile 2.00
334mailstore_prefix string* unset appendfile 2.00
335mailstore_suffix string* unset appendfile 2.00
336match_directory string* unset localuser
337max_output integer 20K pipe
338max_rcpt integer 100 smtp 1.60
339max_user_name_length integer 0 main
340mbx_format boolean false appendfile 2.10
ddea74fa 341message_body_newlines boolean false main 4.68
495ae4b0
PH
342message_body_visible integer 500 main
343message_id_header_domain string* unset main 4.11
344message_id_header_text string* unset main
345message_logs boolean true main 4.10
346message_prefix string* + appendfile 4.00 replaces prefix
347 string* unset pipe 4.00 replaces prefix
1c098beb 348message_size_limit integer 50M main
495ae4b0
PH
349 0 transports 2.05
350message_suffix string* + appendfile 4.00 replaces suffix
351 string* unset pipe 4.00 replaces suffix
352mode octal-integer 0600 appendfile
353 0600 autoreply
354mode_fail_narrower boolean true appendfile 1.70
355modemask octal-integer 022 redirect 4.00
356more boolean true routers 4.00
357move_frozen_messages boolean false main 3.09
358multi_domain boolean true smtp
359mx_domains domain list unset dnslookup 4.00
360mx_fail_domains domain list unset dnslookup 4.43
361mysql_servers string list unset main 3.03
362never_users string list unset main
363notify_comsat boolean false appendfile
364once string* unset autoreply
365once_file_size integer 0 autoreply 3.20
366once_repeat time 0s autoreply 2.95
367one_time boolean false redirect 4.00
368optional boolean false iplookup 4.00
369oracle_servers string unset main 4.00
370owners string list unset redirect 4.00
371owngroups string list unset redirect 4.00
372pass_on_timeout boolean false routers 4.00
373pass_router string unset routers 4.00
374path string "/usr/bin" pipe
375percent_hack_domains domain list unset main
376perl_at_start boolean false main 2.10
377perl_startup string unset main 2.10
378pgsql_servers string list unset main 3.14
379pid_file_path string ++ main
380pipe_as_creator boolean false pipe
381pipe_transport string* unset redirect 4.00
382pipelining_advertise_hosts host list "*" main 4.14
383port integer 0 iplookup 4.00
384 string "smtp" smtp
385preserve_message_logs boolean false main
386primary_hostname string + main
387print_topbitchars boolean false main 1.89
388process_log_path string unset main 4.21
389prod_requires_admin boolean true main 1.70
390protocol string "udp" iplookup 4.00
391 string "smtp" smtp 3.20
392public_name string unset authenticators 3.10
393qualify_domain string + main
394 string* unset redirect 4.31
395qualify_preserve_domain boolean false redirect 4.00
396qualify_recipient string + main
397qualify_single boolean true dnslookup 4.00
398query string* + iplookup 4.00
399queue_domains domain list unset main 4.00
400queue_list_requires_admin boolean true main 1.95
401queue_only boolean false main
402queue_only_file string unset main 2.05
403queue_only_load fixed-point unset main
8669f003 404queue_only_load_latch boolean true main 4.68
495ae4b0
PH
405queue_only_override boolean true main 4.21
406queue_run_in_order boolean false main 1.70
407queue_run_max integer 5 main
408queue_smtp_domains domain list unset main
409quota string* unset appendfile 1.60
410quota_directory string* unset appendfile 4.11
411quota_filecount integer 0 appendfile 2.05
412quota_is_inclusive boolean true appendfile 3.20
413quota_size_regex string unset appendfile 3.14
414quota_warn_message string* + appendfile 2.10
415quota_warn_threshold string* 0 appendfile 2.10
416rcpt_include_affixes boolean false transports 4.21
417receive_timeout time 0s main 4.00 replacing accept_timeout
418received_header_text string* + main
419received_headers_max integer 30 main
420recipient_unqualified_hosts host list unset main 4.00 replacing receiver_unqualified_hosts
421recipients_max integer 0 main 1.60
422recipients_max_reject boolean false main 1.70
423redirect_router string unset routers 4.00
424remote_max_parallel integer 1 main
425remote_sort_domains domain list unset main 4.00 replacing remote_sort
426repeat_use boolean true redirect 4.00
427reply_to string* unset autoreply 2.05
428reply_transport string* unset redirect 4.00
429require_files string list* unset routers 4.00
430reroute string* unset iplookup 4.00
431response_pattern string unset iplookup 4.00
432restrict_to_path boolean false pipe
433retry_data_expire time 7d main 3.03
434retry_include_ip_address boolean true smtp 1.92
435retry_interval_max time 24h main
436retry_use_local_part boolean + routers 4.00
437 + transports 4.00 replacing individual options
438return_fail_output boolean false pipe 1.60
439return_message boolean false autoreply
440return_output boolean false pipe
441return_path string* unset transports 2.05
442return_path_add boolean false transports
443return_path_remove boolean true main
444return_size_limit integer 100K main renamed bounce_return_size_limit in 4.23
445rewrite boolean true redirect 4.00
446rewrite_headers boolean true dnslookup 4.00
447rfc1413_hosts host list * main
8def5aaf 448rfc1413_query_timeout time 5s main
495ae4b0
PH
449router_home_directory string* unset routers 4.11
450route_data string* unset manualroute 4.00
451route_list string list unset manualroute 4.00
452same_domain_copy_routing boolean false dnslookup 4.00
453search_parents boolean false dnslookup 4.00
454self string "freeze" routers 4.00
455sender_unqualified_hosts host list unset main
456senders address list unset routers 4.00
457serialize_hosts host list unset smtp 1.60
458server_advertise_condition string* unset authenticators 4.14
16ff981e 459server_condition string* unset authenticators 3.10 (plaintext) 4.64 (others)
495ae4b0
PH
460server_hostname string* "$primary_hostname" cyrus_sasl 4.43
461server_mail_auth_condition string* unset authenticators 3.22
462server_mech string public_name cyrus_sasl 4.43
463server_prompts string* unset plaintext 3.10
464server_realm string unset cyrus_sasl 4.43
465server_secret string* unset cram_md5 3.10
466server_service string "smtp" cyrus_sasl 4.43
467server_set_id string* unset authenticators 3.10
468shadow_condition string* unset transports
469shadow_transport string unset transports
470size_addition integer 1024 smtp 1.91
471skip_syntax_errors boolean false redirect 4.00
472smtp_accept_keepalive boolean true main
473smtp_accept_max integer 20 main
474smtp_accept_max_nonmail integer 10 main 4.11
475smtp_accept_max_nonmail_hosts host list * main 4.14
476smtp_accept_max_per_connection integer 1000 main 4.00
477smtp_accept_max_per_host integer 0 main 2.05
478smtp_accept_queue integer 0 main
479smtp_accept_queue_per_connection integer 10 main 2.03
480smtp_accept_reserve integer 0 main
481smtp_active_hostname string* unset main 4.33
482smtp_banner string* + main
483smtp_check_spool_space boolean true main 2.10
484smtp_connect_backlog integer 5 main
485smtp_enforce_sync boolean true main 4.00
486smtp_etrn_command string* unset main 1.92
487smtp_etrn_serialize boolean true main 1.89
488smtp_load_reserve fixed-point unset main
489smtp_max_synprot_errors integer 3 main 4.30
490smtp_max_unknown_commands integer 3 main 4.14
491smtp_ratelimit_hosts host list unset main 4.00
492smtp_ratelimit_mail string unset main 4.00
493smtp_ratelimit_rcpt string unset main 4.00
494smtp_receive_timeout time 5m main
495smtp_reserve_hosts host list unset main
496smtp_return_error_details boolean false main 4.11
497socket string* unset lmtp 4.11
54cdb463 498spamd_address string + main 4.50 with content scan
495ae4b0
PH
499split_spool_directory boolean false main 1.70
500spool_directory string ++ main
31480e42 501sqlite_lock_timeout time 5s main 4.53
38a0a95f 502strict_acl_vars boolean false main 4.64
495ae4b0
PH
503srv_fail_domains domain list unset dnslookup 4.43
504strip_excess_angle_brackets boolean false main
505strip_trailing_dot boolean false main
506subject string* unset autoreply
507syntax_errors_text string* unset redirect 4.00
508syntax_errors_to string unset redirect 4.00
509syslog_duplication boolean true main 4.21
510syslog_facility string unset main 4.20
511syslog_processname string "exim" main 4.20
512syslog_timestamp boolean true main 4.00
513system_filter string unset main 4.00 replacing message_filter
514system_filter_directory_transport string unset main 4.00 replacing message_filter
515system_filter_file_transport string unset main 4.00 replacing message_filter
516system_filter_group string unset main 4.00 replacing message_filter
517system_filter_pipe_transport string unset main 4.00 replacing message_filter
518system_filter_reply_transport string unset main 4.00 replacing message_filter
519system_filter_user string unset main 4.00 replacing message_filter
520tcp_nodelay boolean true main 4.23
521 true smtp 4.23
522temp_errors string list + pipe 1.95
523text string* unset autoreply
524timeout time 5m lmtp 3.20
525 1h pipe
526 1h queryprogram 4.00
527 5s iplookup 4.00
2e2a30b4 528timeout_defer boolean false pipe 4.51
495ae4b0
PH
529timeout_frozen_after time 0s main 3.20
530timezone string + main 3.15
531tls_advertise_hosts host list * main 3.20
532tls_certificate string* unset main 3.20
533 unset smtp 3.20
534tls_dhparam string* unset main 3.20
535tls_on_connect_ports string unset main 4.43
536tls_privatekey string* unset main 3.20
537 unset smtp 3.20
538tls_remember_emstp boolean false main 4.21
539tls_require_ciphers string* unset smtp 4.00 replaces tls_verify_ciphers
540 string* unset main 4.33
541tls_tempfail_tryclear boolean true smtp 4.05
542tls_try_verify_hosts host list unset main 4.00
543tls_verify_certificates string* unset main 3.20
544 unset smtp 3.20
545tls_verify_hosts host list unset main 3.20
546to string* unset autoreply
547translate_ip_address string unset routers 4.00
548transport string* unset routers 4.00
549transport_current_directory string unset routers 4.00
550transport_home_directory string unset routers 4.00
551transport_filter string unset transports
552transport_filter_timeout time 5m transports 4.30
553trusted_groups string list unset main
554trusted_users string list unset main
555umask octal-integer 022 pipe
556unknown_login string unset main
557unknown_username string unset main
558unseen boolean false routers 4.00
559untrusted_set_sender boolean false main 3.20
560use_bsmtp boolean false appendfile 4.00
561 false pipe 4.00
562use_crlf boolean false appendfile 1.89
563 false pipe 1.89
564use_fcntl_lock boolean + appendfile 1.70
565use_flock_lock boolean + appendfile 4.11
566use_lockfile boolean + appendfile
567use_mbx_lock boolean + appendfile 2.10
568use_shell boolean false pipe 1.70
569user string + routers 4.00
570 unset transports 4.00 replaces individual options
571uucp_from_pattern string + main 1.75
572uucp_from_sender string* "$1" main 1.75
573verify boolean true routers 4.00
574verify_only boolean false routers 4.00
575verify_recipient boolean true routers 4.00
576verify_sender boolean true routers 4.00
577warn_message_file string unset main 4.00
578widen_domains string list unset dnslookup 4.00
579write_rejectlog boolean true main 4.31
580
581
582
5832. COMMAND LINE OPTIONS
584-----------------------
585
586The table below contains a complete list of all Exim's command line options.
587Those marked with # are available only to trusted users, those marked with +
588are available only to admin users, and those marked with * exist only to
589provide compatibility with Sendmail.
590
591-- Terminate options
592--help Give a little help (not a lot)
593-B * Ignored
594-bd + Start daemon
595-bdf + Start daemon and run it in the foreground
596-be Test string expansion
328895cc 597-bem Test string expansion, read test message first
495ae4b0
PH
598-bF Test system filter file
599-bf Test user filter file
600-bfd Set domain for filter testing
601-bfl Set local part for filter testing
602-bfp Set local part prefix for filter testing
603-bfs Set local part suffix for filter testing
604-bh Test incoming SMTP call, omitting callouts
605-bhc Test incoming SMTP call, with callouts
606-bi * Run <command>bi_command</command>
607-bm Accept message on standard input
608-bnq Don't qualify addresses in locally submitted messages
609-bP Show configuration option settings
610-bp + List the queue
611-bpa + ... with generated addresses as well
612-bpc + ... but just show a count of messages
613-bpr + ... do not sort
614-bpra + ... with generated addresses, unsorted
615-bpru + ... only undelivered addresses, unsorted
616-bpu + ... only undelivered addresses
617-brt Test retry rules
618-brw Test rewriting rules
619-bS Read batch SMTP on standard input
620-bs Run SMTP on standard input and output
621-bt Test address directing and routing
622-bV Verify version number
623-bv Test recipient address verification
624-bvs Test sender address verification
625-C + Use alternate configuration file
626-D + Define macro for configuration file
3d235903
PH
627-d + Turn on debugging output
628-dd + Ditto, but if a daemon, not for subprocesses
495ae4b0
PH
629-dropcr Remove CR character in input: became a no-op in 4.21
630-E Internal use only
631-ex * Synonym for -oex (for several different x)
632-F Set calling user name
633-f # Set calling user address
634-G * Ignored
635-h * Ignored
636-i Dot does not terminate message
637-M + Force deliver specific message
638-Mar + Add recipient to message
639-MC Internal use only
640-MCA Internal use only
641-MCP Internal use only
642-MCQ Internal use only
643-MCS Internal use only
644-MCT Internal use only
645-Mc + Deliver specific message
646-Mes + Edit message sender
647-Mf + Freeze message(s)
648-Mg + Give up (bounce) message(s)
649-Mmad + Mark all recipients delivered
650-Mmd + Mark one recipient delivered
651-Mrm + Remove message(s) (no bounce)
328895cc 652-Mset + Load message's variables when testing with -be
495ae4b0
PH
653-Mt + Thaw message(s)
654-Mvb + View message body
655-Mvh + View message header
656-Mvl + View message log
657-m * Ignored
658-N + Deliver without transporting
659-n * Ignored
660-O * Ignored
661-oA * Supply argument for <option>-bi</option>
662-oB Set max messages down one connection
663-odb Background delivery
664-odf Foreground delivery
665-odi Foreground delivery
666-odq Queue message; do not deliver
667-odqs ... do not do SMTP deliveries
668-oee Error sent by mail; zero return code
669-oem Error sent by mail; non-zero return code
670-oep Error written to standard error stream
671-oeq * Error written to standard error stream
672-oew * Error sent by mail; non-zero return code
673-oi Dot does not terminate message
674-oitrue * Dot does not terminate message
675-oMa # Supply host address
676-oMaa # Supply authenticator name
677-oMai # Supply authenticated id
678-oMas # Supply authenticated sender
679-oMi # Supply interface address
680-oMr # Supply protocol name
681-oMs # Supply host name
682-oMt # Supply ident string
683-om * Ignored
684-oo * Ignored
685-oP * Specify path for daemon's pid file
686-or Timeout non-SMTP messages
687-os Timeout for SMTP messages
688-ov * Verbose; same as -v
689-oX Alternative port for daemon
690-pd Delay Perl interpreter start
691-ps Do not delay Perl interpreter start
692-p<r>:<s> * Same as -oMr <r> -oMs <s>
693-q + Run the queue )
694-qf + ... force delivery ) Other combinations are
695-qff + ... and include frozen messages ) possible. The syntax is
696-qi + ... initial deliveries only )
697-ql + ... local deliveries only ) -q[q][f][f][i|l][time]
698-qq + Two-stage queue run )
699-qR * Same as -R
700-qS * Same as -S
701-R Select by recipient in queue run
702-Rf ... with forcing
703-Rff ... and frozen messages
704-Rr ... using regular expression
705-Rrf ... with forcing
706-Rrff ... and frozen messages
707-r * Synonym for -f
708-S Select by sender in queue run
709-Sf ... with forcing
710-Sff ... and frozen messages
711-Sr ... using regular expression
712-Srf ... with forcing
713-Srff ... and frozen messages
714-Tqt * Used by Exim test suite; not recognized in normal use
715-t Take recipients from header lines
716-ti * Same as -t -i
717-tls-on-connect Do TLS on startup (for legacy clients)
718-U * Ignored
719-v Verbose - shows SMTP dialogue and other delivery info
720-x Ignored (AIX compatibility)
721
722
7233. BUILD TIME OPTIONS FOR EXIM
724------------------------------
725
726The table below contains a complete list of options that can be set in
727Local/Makefile when building Exim. More information about individual options
728can be found in src/EDITME and OS/Makefile-Default.
729
730The second column below gives the type of option:
731
732 . `system' means the option is concerned with the operating system;
733
734 . `driver' means the option selects a driver to be included in the binary;
735
736 . `lookup' means the option selects a lookuptype to be included in the binary;
737
738 . `mandatory' means the option is required to be supplied;
739
740 . `recommended' means the option is recommended to be supplied;
741
742 . `optional' means what it says;
743
744Those marked with * are specialized and are unlikely to be required in most
745installations. Those that are marked with ** are commonly set in OS-specific
746Makefiles. If you use any of these in your Local/Makefile, you may need to
747reproduce some of the OS-specific settings. For example, in the Makefile for
748Solaris (which is actually called OS/Makefile-SunOS5), there is
749
750 LIBS=-lsocket -lnsl -lkstat
751
752If you use LIBS to add extra libraries, you must also include the OS ones in
753your setting. It is better, in this particular case, to use EXTRALIBS, which is
754empty by default, and is provided for just this reason. Of course, if you do
755actually want to modify a setting from the OS-specific file, there is nothing
756to stop you overriding it in your Local/Makefile.
757
758Option Type Description
759------------------------------------------------------------------------------
760
761ALT_CONFIG_PREFIX optional restricts location of -C files
762ALT_CONFIG_ROOT_ONLY optional* privileged -C needs root (not exim)
763APPENDFILE_MODE optional*
764APPENDFILE_DIRECTORY_MODE optional*
765APPENDFILE_LOCKFILE_MODE optional*
766AR system command to build a library
767AUTH_CRAM_MD5 driver include cram_md5 authenticator
068aaea8 768AUTH_CYRUS_SASL driver include Cyrus SASL authenticator
495ae4b0
PH
769AUTH_PLAINTEXT driver include plaintext authenticator
770AUTH_SPA driver include SPA (NTLM) authenticator
f78eb7c6 771AUTH_VARS=3 optional* number of $auth variables
495ae4b0
PH
772BASENAME_COMMAND system** path to basename
773BASE_62=62 optional* not normally changed for Unix
774BIN_DIRECTORY mandatory Exim binary directory
775CC system** C compiler
776CFLAGS system** flags for C compiler
777CHGRP_COMMAND system** path to chgrp
778CHOWN_COMMAND system** path to chown
779COMPRESS_COMMAND system path to a compress command
780COMPRESS_SUFFIX system suffix added to compressed files
781CONFIGURE_FILE mandatory Exim runtime configuration file
782CONFIGURE_FILE_USE_EUID optional*
783CONFIGURE_FILE_USE_NODE optional*
35edf2ff 784CONFIGURE_GROUP optional* alternate group for configuration file
495ae4b0
PH
785CONFIGURE_OWNER optional* alternate owner for configuration file
786CYRUS_PWCHECK_SOCKET optional socket for pwcheck daemon
787DBMLIB optional** location of DBM library
788DB_DIRECTORY_MODE optional* mode for hints directory
789DB_LOCKFILE_MODE optional* mode for hints lock files
790DB_LOCK_TIMEOUT optional* timeout for hints lock files
791DB_MODE optional* mode for hints files
96c065cb 792DEFAULT_CRYPT optional default crypt() function
495ae4b0
PH
793DELIVER_IN_BUFFER_SIZE optional*
794DELIVER_OUT_BUFFER_SIZE optional*
795DISABLE_D_OPTION optional disables -D option
796ERRNO_QUOTA optional* error code for system quota failures
797EXICYCLOG_MAX optional number of old log files to keep
798EXIMDB_DIRECTORY_MODE optional* for hints database directory
799EXIMDB_LOCKFILE_MODE optional* for hints lock files
800EXIMDB_MODE optional* mode for hints files
801EXIMON_TEXTPOP system**
802EXIM_CHMOD optional*
803EXIM_GROUP mandatory group to use for Exim
804EXIM_MONITOR optional set to eximon.bin to compile
805EXIM_PERL optional
806EXIM_USER mandatory user to use for Exim
807EXIWHAT_EGREP_ARG system** to find Exim processes from ps
808EXIWHAT_KILL_SIGNAL system** -SIGUSER1 or numerical equivalent
809EXIWHAT_MULTIKILL_CMD system**
810EXIWHAT_MULTIKILL_ARG system**
811EXIWHAT_PS_ARG system** to list all processes
812EXIWHAT_PS_CMD system** path to ps command
813EXTRALIBS system additional libraries
814EXTRALIBS_EXIM system additional libraries for Exim only
815EXTRALIBS_EXIMON system additional libraries for the monitor
816FIXED_NEVER_USERS optional can't override at runtime
817HAVE_ICONV system the iconv() function is available
818HAVE_IPV6 system include IPv6 support
819HEADERS_CHARSET optional charset for decoded header lines
820HEADER_ADD_BUFFER_SIZE optional* buffer for header_add()
821HEADER_MAXSIZE optional* max memory for message header
822HOSTNAME_COMMAND system** path to hostname command
823INCLUDE system path to include files
824INFO_DIRECTORY optional directory for Info documentation
825INPUT_DIRECTORY_MODE optional mode for input directory
826IPV6_INCLUDE system additional includes for IPv6
827IPV6_LIBS system additional libraries for IPv6
828LDAP_LIB_TYPE optional type of LDAP library
829LFLAGS system** link editor flags
830LIBIDENTCFLAGS system C flags when compiling libident
831LIBIDENTNAME system name for libident library
832LIBRESOLV system** library for DNS resolver
833LIBS system** additional libraries
834LIBS_EXIM system** additional libraries for Exim ony
835LIBS_EXIMON system** additional libraries for monitor
836LOCAL_SCAN_SOURCE optional location of local_scan() source
837LOG_DIRECTORY_MODE optional mode for log directory
838LOG_FILE_PATH optional path to log files
839LOG_MODE optional mode for log files
840LOOKUP_CDB lookup include cdb lookup
841LOOKUP_DBM lookup include dbm lookup
842LOOKUP_DNSDB lookup include dnsdb lookup
843LOOKUP_DSEARCH lookup include dsearch lookup
844LOOKUP_INCLUDE lookup include files for lookups
845LOOKUP_LDAP lookup include ldap lookup
846LOOKUP_LIBS lookup include libraries for lookups
847LOOKUP_LSEARCH lookup include all lsearch lookups
848LOOKUP_MYSQL lookup include mysql lookup
849LOOKUP_NIS lookup include nis lookup
850LOOKUP_NISPLUS lookup include nisplus lookup
851LOOKUP_ORACLE lookup include oracle lookup
852LOOKUP_PGSQL lookup include pgsql lookup
853LOOKUP_TESTDB lookup*
854LOOKUP_WHOSON lookup include whoson lookup
855MAKE_SHELL optional* shell to use for make
856MAX_FILTER_SIZE optional* max file size for filter files
857MAX_INCLUDE_SIZE optional* max file size for :include: files
858MAX_LOCALHOST_NUMBER=256 optional* for when localhost_number is set
859MAX_NAMED_LIST optional* max named lists of a given type
860MAX_INTERFACES system maximum network interfaces
861MSGLOG_DIRECTORY_MODE optional* mode for message log directory
862MV_COMMAND system path to mv command
863NO_SYMLINK optional install doesn't make 'exim" symlink
864PCRE_CFLAGS system compile flags for PCRE library
865PERL_CC system* compiler for Perl interface code
866PERL_CCOPTS system* flags for same
867PERL_COMMAND system path to Perl
868PERL_LIBS system* library for compiling Perl interface
869PID_FILE_PATH optional path to daemon's pid file
870RADIUS_CONFIG_FILE optional path to Radius config file
871RADIUS_LIB_TYPE optional type of RADIUS library
872RANLIB system** path to ranlib command
873RM_COMMAND system path to rm command
874ROUTER_ACCEPT driver include accept router
875ROUTER_DNSLOOKUP driver include dnslookup router
876ROUTER_MANUALROUTE driver include manualroute router
877ROUTER_IPLITERAL driver include ipliteral router
878ROUTER_IPLOOKUP driver include iplookup router
879ROUTER_REDIRECT driver include redirect router
880ROUTER_QUERYPROGRAM driver include queryprogram router
881SPOOL_DIRECTORY recommended path to spool directory
882SPOOL_DIRECTORY_MODE optional mode of spool directory
883SPOOL_MODE optional mode of spool files
884STRING_SPRINTF_BUFFER_SIZE optional* buffer for string_sprintf()
885STRIP_COMMAND optional* can be used to strp binaries
886SUPPORT_A6 optional* support A6 DNS records
887SUPPORT_CRYPTEQ optional support crypteq (if no auths)
888SUPPORT_MAILDIR optional support for maildir delivery
889SUPPORT_MAILSTORE optional support for mailstore delivery
890SUPPORT_MBX optional support for MBX delivery
891SUPPORT_MOVE_FROZEN_MESSAGES optional* support for frozen message moving
892SUPPORT_PAM optional support for PAM authentication
893SUPPORT_TLS optional support for TLS encryption over SMTP
894SUPPORT_TRANSLATE_IP_ADDRESS optional* support for address translation
895SYSLOG_LOG_PID optional add pid to syslog lines
896SYSLOG_LONG_LINES optional do not split long syslog lines
897SYSTEM_ALIASES_FILE optional defaults to /etc/aliases
898TIMEZONE_DEFAULT optional default for timezone option
899TLS_INCLUDE optional path to include files for TLS
900TLS_LIBS optional additional libraries for TLS
901TMPDIR system value for TMPDIR environment variable
902TRANSPORT_APPENDFILE driver include appendfile transport
903TRANSPORT_AUTOREPLY driver include autoreply transport
904TRANSPORT_LMTP driver include lmtp transport
905TRANSPORT_PIPE driver include pipe transport
906TRANSPORT_SMTP driver include smtp transport
907USE_DB system** use native DB interface
908USE_GNUTLS optional use GnuTLS instead of OpenSSL
909USE_READLINE optional try to load libreadline for -be
910USE_TCP_WRAPPERS system link with tcpwrappers
911USE_TDB optional use the tdb DB interface
912X11 system** X11 base directory
913X11_LD_LIB system** X11 link library
914XINCLUDE system** X11 include directory
915XLFLAGS system** X11 link time flags
916ZCAT_COMMAND system path to zcat command
917
918
9194. BUILD TIME OPTIONS FOR EXIMON
920--------------------------------
921
922The table below contains a complete list of options that can be set in
923Local/eximon.conf when building the Exim monitor. Where the default is shown as
924** it means that the text string is too long to fit in the table and is instead
925given below. A blank default means that there is no default value.
926
927ACTION_OUTPUT=no show output for every action
928ACTION_QUEUE_UPDATE=yes update queue display after actions
929BODY_MAX=20000 maximum body display
930DOMAIN= domain to strip from window title
931LOG_BUFFER=20K buffer for log tail
932LOG_DEPTH=300 depth of log subwindow
933LOG_FONT=** font for log display
934LOG_STRIPCHARTS=** patterns for stripcharts
935LOG_WIDTH=950 width of log subwindow
936MENU_EVENT='Shift<Btn1Down>' keypress for menu
937MIN_HEIGHT=162 minimum window height
938MIN_WIDTH=103 minimum window width
939QUALIFY_DOMAIN= local domain to strip from addresses
940QUEUE_DEPTH=200 depth of queue subwindow
941QUEUE_FONT=$LOG_FONT font for queue display
942QUEUE_INTERVAL=300 queue refresh interval
943QUEUE_MAX_ADDRESSES=10 max addresses to show in queue
944QUEUE_STRIPCHART_NAME=queue name for queue stripchart
945QUEUE_WIDTH=950 width of queue subwindow
946SIZE_STRIPCHART= request partition size stripchart
947SIZE_STRIPCHART_NAME=space name for size stripchart
948START_SMALL=no if yes, start with small window
949STRIPCHART_INTERVAL=60 stripchart refresh interval
950TEXT_DEPTH=200 depth of text windows
951WINDOW_TITLE="${hostname} eximon" window title
952
953The default for LOG_FONT is
954
955 LOG_FONT=-misc-fixed-medium-r-normal-*-14-140-*-*-*-*-iso8859-1
956
957and the default for LOG_STRIPCHARTS is
958
959 LOG_STRIPCHARTS='/ <= /in/
960 / => /out/
961 / => .+ R=local/local/
962 / => .+ T=[^ ]*smtp/smtp/'
963
964That is, there are four stripcharts, named in, out, local, and smtp. The first
965counts message arrivals, the second counts all deliveries, the third counts
966deliveries where the router's name starts with "local", and the fourth counts
967deliveries where the transport name contains "smtp".
968
969**** End of OptionLists ****