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