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