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