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