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