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