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