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