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