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