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