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