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