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