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