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