Added ChangeLog entry for f68cdd
[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
PH
237freeze_exec_fail boolean false pipe 1.89
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
339maildir_use_size_file boolean false appendfile 4.30
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
22380b86 376openssl_options string "+dont_insert_empty_fragments" main 4.73
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
16ff981e 469server_condition string* unset authenticators 3.10 (plaintext) 4.64 (others)
495ae4b0
PH
470server_hostname string* "$primary_hostname" cyrus_sasl 4.43
471server_mail_auth_condition string* unset authenticators 3.22
472server_mech string public_name cyrus_sasl 4.43
473server_prompts string* unset plaintext 3.10
474server_realm string unset cyrus_sasl 4.43
475server_secret string* unset cram_md5 3.10
476server_service string "smtp" cyrus_sasl 4.43
477server_set_id string* unset authenticators 3.10
478shadow_condition string* unset transports
479shadow_transport string unset transports
480size_addition integer 1024 smtp 1.91
481skip_syntax_errors boolean false redirect 4.00
482smtp_accept_keepalive boolean true main
483smtp_accept_max integer 20 main
484smtp_accept_max_nonmail integer 10 main 4.11
485smtp_accept_max_nonmail_hosts host list * main 4.14
486smtp_accept_max_per_connection integer 1000 main 4.00
487smtp_accept_max_per_host integer 0 main 2.05
488smtp_accept_queue integer 0 main
489smtp_accept_queue_per_connection integer 10 main 2.03
490smtp_accept_reserve integer 0 main
491smtp_active_hostname string* unset main 4.33
492smtp_banner string* + main
493smtp_check_spool_space boolean true main 2.10
494smtp_connect_backlog integer 5 main
495smtp_enforce_sync boolean true main 4.00
496smtp_etrn_command string* unset main 1.92
497smtp_etrn_serialize boolean true main 1.89
498smtp_load_reserve fixed-point unset main
499smtp_max_synprot_errors integer 3 main 4.30
500smtp_max_unknown_commands integer 3 main 4.14
501smtp_ratelimit_hosts host list unset main 4.00
502smtp_ratelimit_mail string unset main 4.00
503smtp_ratelimit_rcpt string unset main 4.00
504smtp_receive_timeout time 5m main
505smtp_reserve_hosts host list unset main
506smtp_return_error_details boolean false main 4.11
507socket string* unset lmtp 4.11
22380b86 508spamd_address string* + main 4.50 with content scan
495ae4b0
PH
509split_spool_directory boolean false main 1.70
510spool_directory string ++ main
31480e42 511sqlite_lock_timeout time 5s main 4.53
38a0a95f 512strict_acl_vars boolean false main 4.64
495ae4b0
PH
513srv_fail_domains domain list unset dnslookup 4.43
514strip_excess_angle_brackets boolean false main
515strip_trailing_dot boolean false main
516subject string* unset autoreply
517syntax_errors_text string* unset redirect 4.00
518syntax_errors_to string unset redirect 4.00
519syslog_duplication boolean true main 4.21
520syslog_facility string unset main 4.20
521syslog_processname string "exim" main 4.20
522syslog_timestamp boolean true main 4.00
523system_filter string unset main 4.00 replacing message_filter
524system_filter_directory_transport string unset main 4.00 replacing message_filter
525system_filter_file_transport string unset main 4.00 replacing message_filter
526system_filter_group string unset main 4.00 replacing message_filter
527system_filter_pipe_transport string unset main 4.00 replacing message_filter
528system_filter_reply_transport string unset main 4.00 replacing message_filter
529system_filter_user string unset main 4.00 replacing message_filter
530tcp_nodelay boolean true main 4.23
531 true smtp 4.23
5dc43717 532tcp_wrappers_daemon_name string* ++ main 4.73
495ae4b0
PH
533temp_errors string list + pipe 1.95
534text string* unset autoreply
535timeout time 5m lmtp 3.20
536 1h pipe
537 1h queryprogram 4.00
538 5s iplookup 4.00
2e2a30b4 539timeout_defer boolean false pipe 4.51
495ae4b0
PH
540timeout_frozen_after time 0s main 3.20
541timezone string + main 3.15
542tls_advertise_hosts host list * main 3.20
543tls_certificate string* unset main 3.20
544 unset smtp 3.20
545tls_dhparam string* unset main 3.20
546tls_on_connect_ports string unset main 4.43
547tls_privatekey string* unset main 3.20
548 unset smtp 3.20
549tls_remember_emstp boolean false main 4.21
550tls_require_ciphers string* unset smtp 4.00 replaces tls_verify_ciphers
551 string* unset main 4.33
552tls_tempfail_tryclear boolean true smtp 4.05
553tls_try_verify_hosts host list unset main 4.00
554tls_verify_certificates string* unset main 3.20
555 unset smtp 3.20
556tls_verify_hosts host list unset main 3.20
557to string* unset autoreply
558translate_ip_address string unset routers 4.00
559transport string* unset routers 4.00
560transport_current_directory string unset routers 4.00
561transport_home_directory string unset routers 4.00
562transport_filter string unset transports
563transport_filter_timeout time 5m transports 4.30
564trusted_groups string list unset main
565trusted_users string list unset main
566umask octal-integer 022 pipe
567unknown_login string unset main
568unknown_username string unset main
569unseen boolean false routers 4.00
570untrusted_set_sender boolean false main 3.20
571use_bsmtp boolean false appendfile 4.00
572 false pipe 4.00
573use_crlf boolean false appendfile 1.89
574 false pipe 1.89
575use_fcntl_lock boolean + appendfile 1.70
576use_flock_lock boolean + appendfile 4.11
577use_lockfile boolean + appendfile
578use_mbx_lock boolean + appendfile 2.10
579use_shell boolean false pipe 1.70
580user string + routers 4.00
581 unset transports 4.00 replaces individual options
582uucp_from_pattern string + main 1.75
583uucp_from_sender string* "$1" main 1.75
584verify boolean true routers 4.00
585verify_only boolean false routers 4.00
586verify_recipient boolean true routers 4.00
587verify_sender boolean true routers 4.00
588warn_message_file string unset main 4.00
589widen_domains string list unset dnslookup 4.00
590write_rejectlog boolean true main 4.31
591
592
593
5942. COMMAND LINE OPTIONS
595-----------------------
596
597The table below contains a complete list of all Exim's command line options.
598Those marked with # are available only to trusted users, those marked with +
599are available only to admin users, and those marked with * exist only to
600provide compatibility with Sendmail.
601
602-- Terminate options
603--help Give a little help (not a lot)
4b2241d2 604--version Give version information (alias for -bV)
495ae4b0
PH
605-B * Ignored
606-bd + Start daemon
607-bdf + Start daemon and run it in the foreground
608-be Test string expansion
328895cc 609-bem Test string expansion, read test message first
495ae4b0
PH
610-bF Test system filter file
611-bf Test user filter file
612-bfd Set domain for filter testing
613-bfl Set local part for filter testing
614-bfp Set local part prefix for filter testing
615-bfs Set local part suffix for filter testing
616-bh Test incoming SMTP call, omitting callouts
617-bhc Test incoming SMTP call, with callouts
618-bi * Run <command>bi_command</command>
619-bm Accept message on standard input
22380b86 620-bmalware + Invoke configured malware scanning against supplied filename
495ae4b0
PH
621-bnq Don't qualify addresses in locally submitted messages
622-bP Show configuration option settings
623-bp + List the queue
624-bpa + ... with generated addresses as well
625-bpc + ... but just show a count of messages
626-bpr + ... do not sort
627-bpra + ... with generated addresses, unsorted
628-bpru + ... only undelivered addresses, unsorted
629-bpu + ... only undelivered addresses
630-brt Test retry rules
631-brw Test rewriting rules
632-bS Read batch SMTP on standard input
633-bs Run SMTP on standard input and output
634-bt Test address directing and routing
635-bV Verify version number
636-bv Test recipient address verification
637-bvs Test sender address verification
638-C + Use alternate configuration file
639-D + Define macro for configuration file
3d235903
PH
640-d + Turn on debugging output
641-dd + Ditto, but if a daemon, not for subprocesses
495ae4b0
PH
642-dropcr Remove CR character in input: became a no-op in 4.21
643-E Internal use only
644-ex * Synonym for -oex (for several different x)
645-F Set calling user name
646-f # Set calling user address
647-G * Ignored
648-h * Ignored
649-i Dot does not terminate message
650-M + Force deliver specific message
651-Mar + Add recipient to message
652-MC Internal use only
653-MCA Internal use only
654-MCP Internal use only
655-MCQ Internal use only
656-MCS Internal use only
657-MCT Internal use only
658-Mc + Deliver specific message
659-Mes + Edit message sender
660-Mf + Freeze message(s)
661-Mg + Give up (bounce) message(s)
662-Mmad + Mark all recipients delivered
663-Mmd + Mark one recipient delivered
664-Mrm + Remove message(s) (no bounce)
328895cc 665-Mset + Load message's variables when testing with -be
495ae4b0
PH
666-Mt + Thaw message(s)
667-Mvb + View message body
22380b86 668-Mvc + View entire message in RFC 2822 format
495ae4b0
PH
669-Mvh + View message header
670-Mvl + View message log
671-m * Ignored
672-N + Deliver without transporting
673-n * Ignored
674-O * Ignored
675-oA * Supply argument for <option>-bi</option>
676-oB Set max messages down one connection
677-odb Background delivery
678-odf Foreground delivery
679-odi Foreground delivery
680-odq Queue message; do not deliver
681-odqs ... do not do SMTP deliveries
682-oee Error sent by mail; zero return code
683-oem Error sent by mail; non-zero return code
684-oep Error written to standard error stream
685-oeq * Error written to standard error stream
686-oew * Error sent by mail; non-zero return code
687-oi Dot does not terminate message
688-oitrue * Dot does not terminate message
689-oMa # Supply host address
690-oMaa # Supply authenticator name
691-oMai # Supply authenticated id
692-oMas # Supply authenticated sender
693-oMi # Supply interface address
694-oMr # Supply protocol name
695-oMs # Supply host name
696-oMt # Supply ident string
697-om * Ignored
698-oo * Ignored
699-oP * Specify path for daemon's pid file
700-or Timeout non-SMTP messages
701-os Timeout for SMTP messages
702-ov * Verbose; same as -v
703-oX Alternative port for daemon
704-pd Delay Perl interpreter start
705-ps Do not delay Perl interpreter start
706-p<r>:<s> * Same as -oMr <r> -oMs <s>
707-q + Run the queue )
708-qf + ... force delivery ) Other combinations are
709-qff + ... and include frozen messages ) possible. The syntax is
710-qi + ... initial deliveries only )
711-ql + ... local deliveries only ) -q[q][f][f][i|l][time]
712-qq + Two-stage queue run )
713-qR * Same as -R
714-qS * Same as -S
715-R Select by recipient in queue run
716-Rf ... with forcing
717-Rff ... and frozen messages
718-Rr ... using regular expression
719-Rrf ... with forcing
720-Rrff ... and frozen messages
721-r * Synonym for -f
722-S Select by sender in queue run
723-Sf ... with forcing
724-Sff ... and frozen messages
725-Sr ... using regular expression
726-Srf ... with forcing
727-Srff ... and frozen messages
728-Tqt * Used by Exim test suite; not recognized in normal use
729-t Take recipients from header lines
730-ti * Same as -t -i
731-tls-on-connect Do TLS on startup (for legacy clients)
732-U * Ignored
733-v Verbose - shows SMTP dialogue and other delivery info
734-x Ignored (AIX compatibility)
735
736
7373. BUILD TIME OPTIONS FOR EXIM
738------------------------------
739
740The table below contains a complete list of options that can be set in
741Local/Makefile when building Exim. More information about individual options
742can be found in src/EDITME and OS/Makefile-Default.
743
744The second column below gives the type of option:
745
746 . `system' means the option is concerned with the operating system;
747
748 . `driver' means the option selects a driver to be included in the binary;
749
750 . `lookup' means the option selects a lookuptype to be included in the binary;
751
752 . `mandatory' means the option is required to be supplied;
753
754 . `recommended' means the option is recommended to be supplied;
755
756 . `optional' means what it says;
757
758Those marked with * are specialized and are unlikely to be required in most
759installations. Those that are marked with ** are commonly set in OS-specific
760Makefiles. If you use any of these in your Local/Makefile, you may need to
761reproduce some of the OS-specific settings. For example, in the Makefile for
762Solaris (which is actually called OS/Makefile-SunOS5), there is
763
764 LIBS=-lsocket -lnsl -lkstat
765
766If you use LIBS to add extra libraries, you must also include the OS ones in
767your setting. It is better, in this particular case, to use EXTRALIBS, which is
768empty by default, and is provided for just this reason. Of course, if you do
769actually want to modify a setting from the OS-specific file, there is nothing
770to stop you overriding it in your Local/Makefile.
771
772Option Type Description
773------------------------------------------------------------------------------
774
775ALT_CONFIG_PREFIX optional restricts location of -C files
495ae4b0
PH
776APPENDFILE_MODE optional*
777APPENDFILE_DIRECTORY_MODE optional*
778APPENDFILE_LOCKFILE_MODE optional*
779AR system command to build a library
780AUTH_CRAM_MD5 driver include cram_md5 authenticator
068aaea8 781AUTH_CYRUS_SASL driver include Cyrus SASL authenticator
495ae4b0
PH
782AUTH_PLAINTEXT driver include plaintext authenticator
783AUTH_SPA driver include SPA (NTLM) authenticator
f78eb7c6 784AUTH_VARS=3 optional* number of $auth variables
495ae4b0
PH
785BASENAME_COMMAND system** path to basename
786BASE_62=62 optional* not normally changed for Unix
787BIN_DIRECTORY mandatory Exim binary directory
788CC system** C compiler
789CFLAGS system** flags for C compiler
35110e70 790CFLAGS_DYNAMIC system** extra flags needed for .so modules
495ae4b0
PH
791CHGRP_COMMAND system** path to chgrp
792CHOWN_COMMAND system** path to chown
793COMPRESS_COMMAND system path to a compress command
794COMPRESS_SUFFIX system suffix added to compressed files
795CONFIGURE_FILE mandatory Exim runtime configuration file
796CONFIGURE_FILE_USE_EUID optional*
797CONFIGURE_FILE_USE_NODE optional*
35edf2ff 798CONFIGURE_GROUP optional* alternate group for configuration file
495ae4b0
PH
799CONFIGURE_OWNER optional* alternate owner for configuration file
800CYRUS_PWCHECK_SOCKET optional socket for pwcheck daemon
801DBMLIB optional** location of DBM library
802DB_DIRECTORY_MODE optional* mode for hints directory
803DB_LOCKFILE_MODE optional* mode for hints lock files
804DB_LOCK_TIMEOUT optional* timeout for hints lock files
805DB_MODE optional* mode for hints files
96c065cb 806DEFAULT_CRYPT optional default crypt() function
495ae4b0
PH
807DELIVER_IN_BUFFER_SIZE optional*
808DELIVER_OUT_BUFFER_SIZE optional*
22380b86 809DISABLE_DKIM optional disables DKIM support
495ae4b0
PH
810DISABLE_D_OPTION optional disables -D option
811ERRNO_QUOTA optional* error code for system quota failures
812EXICYCLOG_MAX optional number of old log files to keep
813EXIMDB_DIRECTORY_MODE optional* for hints database directory
814EXIMDB_LOCKFILE_MODE optional* for hints lock files
815EXIMDB_MODE optional* mode for hints files
816EXIMON_TEXTPOP system**
817EXIM_CHMOD optional*
818EXIM_GROUP mandatory group to use for Exim
819EXIM_MONITOR optional set to eximon.bin to compile
820EXIM_PERL optional
821EXIM_USER mandatory user to use for Exim
822EXIWHAT_EGREP_ARG system** to find Exim processes from ps
823EXIWHAT_KILL_SIGNAL system** -SIGUSER1 or numerical equivalent
824EXIWHAT_MULTIKILL_CMD system**
825EXIWHAT_MULTIKILL_ARG system**
826EXIWHAT_PS_ARG system** to list all processes
827EXIWHAT_PS_CMD system** path to ps command
828EXTRALIBS system additional libraries
829EXTRALIBS_EXIM system additional libraries for Exim only
830EXTRALIBS_EXIMON system additional libraries for the monitor
831FIXED_NEVER_USERS optional can't override at runtime
832HAVE_ICONV system the iconv() function is available
833HAVE_IPV6 system include IPv6 support
834HEADERS_CHARSET optional charset for decoded header lines
835HEADER_ADD_BUFFER_SIZE optional* buffer for header_add()
836HEADER_MAXSIZE optional* max memory for message header
837HOSTNAME_COMMAND system** path to hostname command
838INCLUDE system path to include files
839INFO_DIRECTORY optional directory for Info documentation
840INPUT_DIRECTORY_MODE optional mode for input directory
841IPV6_INCLUDE system additional includes for IPv6
842IPV6_LIBS system additional libraries for IPv6
843LDAP_LIB_TYPE optional type of LDAP library
844LFLAGS system** link editor flags
845LIBIDENTCFLAGS system C flags when compiling libident
846LIBIDENTNAME system name for libident library
847LIBRESOLV system** library for DNS resolver
848LIBS system** additional libraries
849LIBS_EXIM system** additional libraries for Exim ony
850LIBS_EXIMON system** additional libraries for monitor
851LOCAL_SCAN_SOURCE optional location of local_scan() source
852LOG_DIRECTORY_MODE optional mode for log directory
853LOG_FILE_PATH optional path to log files
854LOG_MODE optional mode for log files
855LOOKUP_CDB lookup include cdb lookup
856LOOKUP_DBM lookup include dbm lookup
857LOOKUP_DNSDB lookup include dnsdb lookup
858LOOKUP_DSEARCH lookup include dsearch lookup
859LOOKUP_INCLUDE lookup include files for lookups
860LOOKUP_LDAP lookup include ldap lookup
861LOOKUP_LIBS lookup include libraries for lookups
862LOOKUP_LSEARCH lookup include all lsearch lookups
35110e70 863LOOKUP_MODULE_DIR optional* where dynamic lookup modules live
495ae4b0
PH
864LOOKUP_MYSQL lookup include mysql lookup
865LOOKUP_NIS lookup include nis lookup
866LOOKUP_NISPLUS lookup include nisplus lookup
867LOOKUP_ORACLE lookup include oracle lookup
868LOOKUP_PGSQL lookup include pgsql lookup
869LOOKUP_TESTDB lookup*
870LOOKUP_WHOSON lookup include whoson lookup
35110e70
PP
871LOOKUP_*_INCLUDE optional* include files for dynamic module
872LOOKUP_*_LIBS optional* libraries for dynamic module
495ae4b0
PH
873MAKE_SHELL optional* shell to use for make
874MAX_FILTER_SIZE optional* max file size for filter files
875MAX_INCLUDE_SIZE optional* max file size for :include: files
876MAX_LOCALHOST_NUMBER=256 optional* for when localhost_number is set
877MAX_NAMED_LIST optional* max named lists of a given type
878MAX_INTERFACES system maximum network interfaces
879MSGLOG_DIRECTORY_MODE optional* mode for message log directory
880MV_COMMAND system path to mv command
881NO_SYMLINK optional install doesn't make 'exim" symlink
882PCRE_CFLAGS system compile flags for PCRE library
883PERL_CC system* compiler for Perl interface code
884PERL_CCOPTS system* flags for same
885PERL_COMMAND system path to Perl
886PERL_LIBS system* library for compiling Perl interface
887PID_FILE_PATH optional path to daemon's pid file
888RADIUS_CONFIG_FILE optional path to Radius config file
889RADIUS_LIB_TYPE optional type of RADIUS library
890RANLIB system** path to ranlib command
891RM_COMMAND system path to rm command
892ROUTER_ACCEPT driver include accept router
893ROUTER_DNSLOOKUP driver include dnslookup router
894ROUTER_MANUALROUTE driver include manualroute router
895ROUTER_IPLITERAL driver include ipliteral router
896ROUTER_IPLOOKUP driver include iplookup router
897ROUTER_REDIRECT driver include redirect router
898ROUTER_QUERYPROGRAM driver include queryprogram router
899SPOOL_DIRECTORY recommended path to spool directory
900SPOOL_DIRECTORY_MODE optional mode of spool directory
901SPOOL_MODE optional mode of spool files
902STRING_SPRINTF_BUFFER_SIZE optional* buffer for string_sprintf()
903STRIP_COMMAND optional* can be used to strp binaries
904SUPPORT_A6 optional* support A6 DNS records
905SUPPORT_CRYPTEQ optional support crypteq (if no auths)
906SUPPORT_MAILDIR optional support for maildir delivery
907SUPPORT_MAILSTORE optional support for mailstore delivery
908SUPPORT_MBX optional support for MBX delivery
909SUPPORT_MOVE_FROZEN_MESSAGES optional* support for frozen message moving
910SUPPORT_PAM optional support for PAM authentication
911SUPPORT_TLS optional support for TLS encryption over SMTP
912SUPPORT_TRANSLATE_IP_ADDRESS optional* support for address translation
913SYSLOG_LOG_PID optional add pid to syslog lines
914SYSLOG_LONG_LINES optional do not split long syslog lines
915SYSTEM_ALIASES_FILE optional defaults to /etc/aliases
35110e70 916TCP_WRAPPERS_DAEMON_NAME system* daemon name used by tcpwrappers library
495ae4b0
PH
917TIMEZONE_DEFAULT optional default for timezone option
918TLS_INCLUDE optional path to include files for TLS
919TLS_LIBS optional additional libraries for TLS
920TMPDIR system value for TMPDIR environment variable
921TRANSPORT_APPENDFILE driver include appendfile transport
922TRANSPORT_AUTOREPLY driver include autoreply transport
923TRANSPORT_LMTP driver include lmtp transport
924TRANSPORT_PIPE driver include pipe transport
925TRANSPORT_SMTP driver include smtp transport
35110e70 926TRUSTED_CONFIG_LIST optional config files safe to retain privileges
495ae4b0
PH
927USE_DB system** use native DB interface
928USE_GNUTLS optional use GnuTLS instead of OpenSSL
929USE_READLINE optional try to load libreadline for -be
930USE_TCP_WRAPPERS system link with tcpwrappers
931USE_TDB optional use the tdb DB interface
35110e70 932WHITELIST_D_MACROS optional -Dmacros safe to retain privileges with
22380b86 933WITH_OLD_CLAMAV_STREAM optional* use ClamAV API from before ClamAV 0.95
495ae4b0
PH
934X11 system** X11 base directory
935X11_LD_LIB system** X11 link library
936XINCLUDE system** X11 include directory
937XLFLAGS system** X11 link time flags
938ZCAT_COMMAND system path to zcat command
939
940
9414. BUILD TIME OPTIONS FOR EXIMON
942--------------------------------
943
944The table below contains a complete list of options that can be set in
945Local/eximon.conf when building the Exim monitor. Where the default is shown as
946** it means that the text string is too long to fit in the table and is instead
947given below. A blank default means that there is no default value.
948
949ACTION_OUTPUT=no show output for every action
950ACTION_QUEUE_UPDATE=yes update queue display after actions
951BODY_MAX=20000 maximum body display
952DOMAIN= domain to strip from window title
953LOG_BUFFER=20K buffer for log tail
954LOG_DEPTH=300 depth of log subwindow
955LOG_FONT=** font for log display
956LOG_STRIPCHARTS=** patterns for stripcharts
957LOG_WIDTH=950 width of log subwindow
958MENU_EVENT='Shift<Btn1Down>' keypress for menu
959MIN_HEIGHT=162 minimum window height
960MIN_WIDTH=103 minimum window width
961QUALIFY_DOMAIN= local domain to strip from addresses
962QUEUE_DEPTH=200 depth of queue subwindow
963QUEUE_FONT=$LOG_FONT font for queue display
964QUEUE_INTERVAL=300 queue refresh interval
965QUEUE_MAX_ADDRESSES=10 max addresses to show in queue
966QUEUE_STRIPCHART_NAME=queue name for queue stripchart
967QUEUE_WIDTH=950 width of queue subwindow
968SIZE_STRIPCHART= request partition size stripchart
969SIZE_STRIPCHART_NAME=space name for size stripchart
970START_SMALL=no if yes, start with small window
971STRIPCHART_INTERVAL=60 stripchart refresh interval
972TEXT_DEPTH=200 depth of text windows
973WINDOW_TITLE="${hostname} eximon" window title
974
975The default for LOG_FONT is
976
977 LOG_FONT=-misc-fixed-medium-r-normal-*-14-140-*-*-*-*-iso8859-1
978
979and the default for LOG_STRIPCHARTS is
980
981 LOG_STRIPCHARTS='/ <= /in/
982 / => /out/
983 / => .+ R=local/local/
984 / => .+ T=[^ ]*smtp/smtp/'
985
986That is, there are four stripcharts, named in, out, local, and smtp. The first
987counts message arrivals, the second counts all deliveries, the third counts
988deliveries where the router's name starts with "local", and the fourth counts
989deliveries where the transport name contains "smtp".
990
991**** End of OptionLists ****