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