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