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