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