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