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