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