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