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