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