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