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