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