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