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