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