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