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