LISTS OF EXIM OPTIONS
---------------------

This file contains complete lists of three kinds of Exim option:

  1. Those that can appear in the run time configuration file;
  2. Those that can be used on the command line;
  3. Those that can appear in the build time configuration (Local/Makefile);
  4. Those that can appear in the build time configuration for the Exim monitor
     (Local/eximon.conf).

This file was last updated for Exim release 3.30.


1. RUN TIME OPTIONS
-------------------

As Exim has developed, new options have been added at each major release. For
the most part, backwards compatibility has been maintained, and obsolete
options continue to be recognized. However, an incompatible change took place
at release 3.00, where several groups of options were amalgamated into a single
new, extended option. For example,

  sender_host_accept
  sender_net_accept
  sender_host_reject
  sender_net_reject
  sender_host_reject_except
  sender_net_reject_except

were all replaced by the single option host_reject, which can now contain IP
addresses as well as host names, and negated items to cater for exceptions. The
opportunity was taken to remove or revise number of other options at the same
time. Since release 3.00, from_hack has been rendered obsolete by check_string
and escape_string; collapse_source_routes is also obsolete, because its action
is now always taken. These old options are still recognized, though not
documented here.

The table below contains a complete list of all Exim's options, along with
their types, default values, and where they can be used. String options that
are expanded before use are marked with *. In some cases the defaults are not
fixed values, or not short enough to fit in the table. These are indicated by
+. Some other default values are determined when the Exim binary is compiled;
these are indicated by ++.

For options that are specific to a particular driver, the fourth column
contains the driver name, for example, appendfile. Otherwise, it contains

 . `main' for options that appear in the main section of Exim's configuration
    file;

 . `authenticators' for generic options that apply to any authenticator;

 . `directors' for generic options that apply to any director;

 . `routers' for generic options that apply to any router;

 . `transports' for generic options that apply to any transport.

The fifth column contains the version of Exim in which the option was added,
or substantially changed. Where no number is given, the option has been in Exim
since the very early releases.

Option                               Type            Default       Where          Version
-----------------------------------------------------------------------------------------
accept_8bitmime                      boolean         false         main              1.60
accept_timeout                       time            0s            main
admin_groups                         string list     unset         main              3.02
allow_commands                       string list*    unset         pipe              1.89
allow_fifo                           boolean         false         appendfile        3.13
allow_localhost                      boolean         false         smtp              1.73
allow_mx_to_ip                       boolean         false         main              3.14
allow_symlink                        boolean         false         appendfile
allow_system_actions                 boolean         false         forwardfile       1.89
always_bcc                           boolean         false         main              1.60
auth_always_advertise                boolean         true          main              3.13
auth_hosts                           host list       unset         main              3.13
authenticate_hosts                   host list       unset         smtp              3.13
auto_thaw                            time            0s            main
batch                                string          "none"        appendfile
                                                     "none"        lmtp              3.20
                                                     "none"        pipe
batch_max                            integer         100           appendfile
                                                     100           lmtp              3.20
                                                     100           pipe
                                                     0             smtp
bcc                                  string*         unset         autoreply
bi_command                           string          unset         main
body_only                            boolean         false         transports        2.05
bsmtp                                string          "none"        appendfile
                                                     "none"        pipe
bsmtp_helo                           boolean         false         appendfile        1.73
                                                     false         pipe              1.73
cc                                   string*         unset         autoreply
check_ancestor                       boolean         false         aliasfile         1.89
                                                     false         forwardfile       1.62
check_group                          boolean         false         appendfile
                                                     false         forwardfile
check_local_user                     boolean         true          forwardfile
check_log_inodes                     integer         0             main
check_log_space                      integer         0             main
check_owner                          boolean         true          appendfile        3.14
check_secondary_mx                   boolean         false         lookuphost        1.95
check_spool_inodes                   integer         0             main
check_spool_space                    integer         0             main
check_string                         string          "From "       appendfile        3.03
                                                     unset         pipe              3.03
client_name                          string*         +             cram_md5          3.10
client_secret                        string*         unset         cram_md5          3.10
client_send                          string*         unset         plaintext         3.10
command                              string*         unset         lmtp              3.20
                                                     unset         pipe
                                                     unset         queryprogram
command_group                        string          unset         queryprogram      2.05
command_timeout                      time            5m            smtp
command_user                         string          unset         queryprogram      2.05
condition                            string*         unset         directors         1.73
                                                     unset         routers           1.73
connect_timeout                      time            0s            smtp              1.60
create_directory                     boolean         true          appendfile
create_file                          string          "anywhere"    appendfile
current_directory                    string*         unset         appendfile
                                                     unset         directors         1.89
                                                     unset         pipe
                                                     unset         queryprogram      1.89
daemon_smtp_port                     string          unset         main              1.75
data                                 string          unset         forwardfile       3.20
data_timeout                         time            5m            smtp
debug_level                          integer         0             main
debug_print                          string*         unset         directors         2.00
                                                     unset         routers           2.00
                                                     unset         transports        2.00
delay_after_cutoff                   boolean         true          smtp
delay_warning                        time list       24h           main
delay_warning_condition              string*         +             main              1.73
deliver_load_max                     fixed-point     unset         main
deliver_queue_load_max               fixed-point     unset         main              1.70
delivery_date_add                    boolean         false         transports
delivery_date_remove                 boolean         true          main
directory                            string*         unset         appendfile
directory2_transport                 string*         unset         aliasfile         1.73
                                                     unset         forwardfile       1.73
directory_mode                       octal-integer   0700          appendfile
directory_transport                  string*         unset         aliasfile         1.73
                                                     unset         forwardfile       1.73
dns_again_means_nonexist             domain list     unset         main              1.89
dns_check_names                      boolean         true          main              2.05
dns_check_names_pattern              string          +             main              2.11
dns_ipv4_lookup                      boolean         false         main              3.20
dns_qualify_single                   boolean         true          smtp
dns_retrans                          time            0s            main              1.60
dns_retry                            integer         0             main              1.60
dns_search_parents                   boolean         false         smtp
domains                              domain list*    unset         directors
                                                     unset         routers
driver                               string          unset         authenticators
                                                     unset         directors
                                                     unset         routers
                                                     unset         transports
envelope_to_add                      boolean         false         transports
envelope_to_remove                   boolean         true          main
environment                          string*         unset         pipe              2.95
errmsg_file                          string          unset         main              1.89
errmsg_text                          string          unset         main              1.89
errors_address                       string          "postmaster"  main
errors_copy                          string list*    unset         main
errors_reply_to                      string          unset         main
errors_to                            string*         unset         directors
                                                     unset         routers
escape_string                        string          ">From "      appendfile        3.03
                                                     unset         pipe              3.03
exim_group                           string          ++            main
exim_path                            string          ++            main
exim_user                            string          ++            main
expand                               boolean         false         aliasfile
expn                                 boolean         true          directors
extract_addresses_remove_arguments   boolean         true          main              1.92
fail_verify                          boolean         false         directors
                                                     false         routers
fail_verify_recipient                boolean         false         directors         1.60
                                                     false         routers           1.60
fail_verify_sender                   boolean         false         directors         1.60
                                                     false         routers           1.60
fallback_hosts                       string list     unset         directors         1.95
                                                     unset         routers           1.95
                                                     unset         smtp
file                                 string*         unset         aliasfile
                                                     unset         appendfile
                                                     unset         autoreply
                                                     unset         forwardfile
file_directory                       string*         unset         forwardfile
file_expand                          boolean         false         autoreply
file_format                          string          unset         appendfile        3.03
file_must_exist                      boolean         false         appendfile
file_optional                        boolean         false         autoreply
file_transport                       string*         unset         aliasfile         1.73
                                                     unset         forwardfile       1.73
                                                     unset         smartuser         3.20
filter                               boolean         false         forwardfile
final_timeout                        time            10m           smtp
finduser_retries                     integer         0             main
forbid_domain_literals               boolean         false         main
forbid_file                          boolean         false         aliasfile
                                                     false         forwardfile
                                                     false         smartuser         3.20
forbid_filter_existstest             boolean         false         forwardfile
forbid_filter_logwrite               boolean         false         forwardfile       1.89
forbid_filter_lookup                 boolean         false         forwardfile       3.09
forbid_filter_perl                   boolean         false         forwardfile       3.09
forbid_filter_reply                  boolean         false         forwardfile       3.09
forbid_include                       boolean         false         aliasfile
                                                     false         forwardfile
forbid_pipe                          boolean         false         aliasfile
                                                     false         forwardfile
                                                     false         smartuser         3.20
freeze_exec_fail                     boolean         false         pipe              1.89
freeze_missing_include               boolean         true          aliasfile
                                                     true          forwardfile
freeze_tell_mailmaster               boolean         false         main
from                                 string*         unset         autoreply
gecos_name                           string*         unset         main
gecos_pattern                        string          unset         main
gethostbyname                        boolean         false         lookuphost
                                                     false         smtp
group                                string          unset         appendfile
                                                     unset         autoreply
                                                     +             directors         1.92
                                                     unset         lmtp              3.20
                                                     unset         pipe
                                                     +             routers           1.92
headers                              string*         unset         autoreply
headers_add                          string*         unset         directors         1.89
                                                     unset         routers           1.89
                                                     unset         transports
headers_check_syntax                 boolean         false         main              1.70
headers_checks_fail                  boolean         true          main              1.70
headers_only                         boolean         false         transports        2.05
headers_remove                       string*         unset         directors         1.89
                                                     unset         routers           1.89
                                                     unset         transports
headers_rewrite                      string          unset         transports        3.20
headers_sender_verify                boolean         false         main              1.70
headers_sender_verify_errmsg         boolean         false         main              1.70
helo_accept_junk_hosts               host list       unset         main              3.00
helo_data                            string*   "$primary_hostname" smtp              3.21
helo_strict_syntax                   boolean         false         main              1.89
helo_verify                          host list       unset         main              1.73
hide_child_in_errmsg                 boolean         false         aliasfile         3.20
                                                                   forwardfile       3.20
                                                                   smartuser         3.20
hold_domains                         domain list     unset         main              1.70
home_directory                       string*         unset         directors         3.09
                                                     unset         pipe
host_accept_relay                    host list       unset         main
host_auth_accept_relay               host list       unset         main              3.10
host_find_failed                     string          "freeze"      domainlist        1.85
host_lookup                          host list       unset         main              3.00
host_reject                          host list       unset         main
host_reject_recipients               host list       unset         main
hosts                                string          unset         iplookup
                                     string list*    unset         smtp
hosts_avoid_tls                      host list       unset         smtp              3.20
hosts_max_try                        integer         5             smtp              3.20
hosts_override                       boolean         false         smtp              2.11
hosts_randomize                      boolean         false         domainlist        3.14
                                                     false         smtp              3.14
hosts_require_tls                    host list       unset         smtp              3.20
hosts_treat_as_local                 domain list     unset         main              1.95
ignore_eacces                        boolean         false         forwardfile       1.73
ignore_enotdir                       boolean         false         forwardfile       1.73
ignore_errmsg_errors                 boolean         false         main
ignore_errmsg_errors_after           time            0s            main              1.70
ignore_fromline_hosts                host list       unset         main
ignore_fromline_local                boolean         false         main              2.05
ignore_status                        boolean         false         pipe
ignore_target_hosts                  host list       unset         routers           3.20
include_domain                       boolean         false         aliasfile         1.70
initgroups                           boolean         false         autoreply
                                                     false         directors         1.92
                                                     false         pipe
                                                     false         routers           1.92
interface                            string          unset         smtp              1.70
ipv4_address_lookup                  boolean         false         main              3.21
keep_malformed                       time            4d            main
keepalive                            boolean         true          smtp              2.05
kill_ip_options                      boolean         true          main              1.60
ldap_default_servers                 string list     unset         main              3.02
local_domains                        domain list     +             main
local_domains_include_host           boolean         false         main
local_domains_include_host_literals  boolean         false         main
local_from_check                     boolean         true          main              3.14
local_from_prefix                    string          unset         main              3.14
local_interfaces                     string list     unset         main              1.60
local_parts                          string list*    unset         directors
                                                     unset         routers
localhost_number                     string          unset         main
locally_caseless                     boolean         true          main
lock_fcntl_timeout                   time            0s            appendfile        3.14
lock_interval                        time            3s            appendfile
lock_retries                         integer         10            appendfile
lockfile_mode                        octal-integer   0600          appendfile
lockfile_timeout                     time            30m           appendfile
log                                  string*         unset         autoreply
log_all_parents                      boolean         false         main              1.89
log_arguments                        boolean         false         main              1.70
log_defer_output                     boolean         false         pipe              1.89
log_fail_output                      boolean         false         pipe              1.60
log_file_path                        string list     ++            main
log_incoming_port                    boolean         false         main              3.20
log_ip_options                       boolean         true          main              1.60
log_level                            integer         5             main              1.60
log_output                           boolean         false         pipe              1.60
log_queue_run_level                  integer         0             main              3.03
log_received_recipients              boolean         false         main
log_received_sender                  boolean         false         main              1.75
log_refused_recipients               boolean         false         main              1.70
log_rewrites                         boolean         false         main
log_sender_on_delivery               boolean         false         main              3.30
log_smtp_confirmation                boolean         false         main              1.60
log_smtp_connections                 boolean         false         main              2.10
log_smtp_syntax_errors               boolean         false         main              2.05
log_subject                          boolean         false         main              1.60
lookup_open_max                      integer         25            main              2.05
maildir_format                       boolean         false         appendfile        1.70
maildir_retries                      integer         10            appendfile        1.70
maildir_tag                          string*         unset         appendfile        1.92
mailstore_format                     boolean         false         appendfile        2.00
mailstore_prefix                     string*         unset         appendfile        2.00
mailstore_suffix                     string*         unset         appendfile        2.00
match_directory                      string*         unset         forwardfile       2.05
                                                     unset         localuser
max_output                           integer         20K           pipe
max_rcpt                             integer         100           smtp              1.60
max_user_name_length                 integer         0             main
mbx_format                           boolean         false         appendfile        2.10
message_body_visible                 integer         500           main
message_filter                       string          unset         main
message_filter_directory2_transport  string          unset         main
message_filter_directory_transport   string          unset         main
message_filter_file_transport        string          unset         main
message_filter_group                 string          unset         main
message_filter_pipe_transport        string          unset         main
message_filter_reply_transport       string          unset         main
message_filter_user                  string          unset         main
message_id_header_text               string*         unset         main
message_size_limit                   integer         0             main
                                                     0             transports        2.05
message_size_limit_count_recipients  boolean         false         main              2.10
mode                                 octal-integer   0600          appendfile
                                                     0600          autoreply
mode_fail_narrower                   boolean         true          appendfile        1.70
modemask                             octal-integer   022           aliasfile
                                                     022           domainlist
                                                     022           forwardfile
more                                 boolean         true          directors
                                                     true          routers
move_frozen_messages                 boolean         false         main              3.09
multi_domain                         boolean         true          smtp
mx_domains                           domain list     unset         lookuphost
                                                     unset         smtp
mysql_servers                        string list     unset         main              3.03
never_users                          string list     unset         main
new_address                          string*         unset         smartuser
new_director                         string          unset         directors         1.70
nobody_group                         string          unset         main
nobody_user                          string          unset         main
notify_comsat                        boolean         false         appendfile
once                                 string*         unset         autoreply
once_file_size                       integer         0             autoreply         3.20
once_repeat                          time            0s            autoreply         2.95
one_time                             boolean         false         aliasfile         1.95
                                                     false         forwardfile       1.95
optional                             boolean         false         aliasfile
                                                     false         iplookup
owners                               string list     unset         aliasfile
                                                     unset         domainlist
                                                     unset         forwardfile
owngroups                            string list     unset         aliasfile
                                                     unset         domainlist
                                                     unset         forwardfile
panic_expansion_fail                 boolean         true          smartuser
pass_on_timeout                      boolean         false         routers
path                                 string list     "/usr/bin"    pipe
percent_hack_domains                 domain list     unset         main
perl_at_start                        boolean         false         main              2.10
perl_startup                         string          unset         main              2.10
pgsql_servers                        string list     unset         main              3.14
pid_file_path                        string          ++            main
pipe_as_creator                      boolean         false         pipe
pipe_transport                       string*         unset         aliasfile         1.73
                                                     unset         forwardfile       1.73
                                                     unset         smartuser         3.20
port                                 integer         0             iplookup
                                     string          "smtp"        smtp
prefix                               string*         +             appendfile
                                     string*         +             pipe
                                     string list     unset         directors
prefix_optional                      boolean         false         directors
preserve_message_logs                boolean         false         main
primary_hostname                     string          +             main
print_topbitchars                    boolean         false         main              1.89
prod_requires_admin                  boolean         true          main              1.70
prohibition_message                  string*         unset         main              1.73
protocol                             string          "udp"         iplookup
                                     string          "smtp"        smtp              3.20
public_name                          string          unset         authenticators    3.10
qualify_domain                       string          +             main
qualify_preserve_domain              boolean         false         aliasfile         1.89
                                                     false         forwardfile       1.89
                                                     false         smartuser         3.13
qualify_recipient                    string          +             main
qualify_single                       boolean         true          domainlist        2.12
                                                     true          lookuphost
queries                              string*         unset         aliasfile         1.85
query                                string*         +             iplookup
                                                     unset         aliasfile
queue_list_requires_admin            boolean         true          main              1.95
queue_only                           boolean         false         main
queue_only_file                      string          unset         main              2.05
queue_only_load                      fixed-point     unset         main
queue_remote_domains                 domain list     unset         main
queue_run_in_order                   boolean         false         main              1.70
queue_run_max                        integer         5             main
queue_smtp_domains                   domain list     unset         main
quota                                string*         unset         appendfile        1.60
quota_filecount                      integer         0             appendfile        2.05
quota_size_regex                     string          unset         appendfile        3.14
quota_warn_message                   string*         +             appendfile        2.10
quota_warn_threshold                 string*         0             appendfile        2.10
rbl_domains                          string list     unset         main              1.73
rbl_hosts                            host list       *             main              1.72
rbl_log_headers                      boolean         false         main              2.05
rbl_log_rcpt_count                   boolean         false         main              2.05
rbl_reject_recipients                boolean         true          main              1.73
rbl_warn_header                      boolean         true          main              1.75
received_header_text                 string*         +             main
received_headers_max                 integer         30            main
receiver_try_verify                  boolean         false         main
receiver_unqualified_hosts           host list       unset         main
receiver_verify                      boolean         false         main
receiver_verify_addresses            address list    unset         main              1.70
receiver_verify_hosts                host list       *             main
receiver_verify_senders              address list    unset         main              1.70
recipients_max                       integer         0             main              1.60
recipients_max_reject                boolean         false         main              1.70
recipients_reject_except             address list    unset         main              1.70
recipients_reject_except_senders     address list    unset         main              3.09
refuse_ip_options                    boolean         true          main
relay_domains                        domain list     unset         main
relay_domains_include_local_mx       boolean         false         main              1.70
relay_match_host_or_sender           boolean         false         main              1.62
remote_max_parallel                  integer         1             main
remote_sort                          domain list     unset         main
reply_to                             string*         unset         autoreply         2.05
reply_transport                      string*         unset         forwardfile
require_files                        string list*    unset         directors
                                                     unset         routers
require_lockfile                     boolean         true          appendfile
reroute                              string*         unset         iplookup
response_pattern                     string          unset         iplookup
restrict_to_path                     boolean         false         pipe
retry_data_expire                    time            7d            main              3.03
retry_include_ip_address             boolean         true          smtp              1.92
retry_interval_max                   time            24h           main
retry_use_local_part                 boolean         true          appendfile        1.60
                                                     true          pipe              1.60
return_fail_output                   boolean         false         pipe              1.60
return_message                       boolean         false         autoreply
return_output                        boolean         false         pipe
return_path                          string*         unset         transports        2.05
return_path_add                      boolean         false         transports
return_path_remove                   boolean         true          main
return_size_limit                    integer         100K          main
rewrite                              boolean         true          aliasfile         1.60
                                                     true          forwardfile       1.60
                                                     true          smartuser         2.05
rewrite_headers                      boolean         true          lookuphost
rfc1413_hosts                        host list       *             main
rfc1413_query_timeout                time            30s           main
route_file                           string*         unset         domainlist
route_list                           string list     unset         domainlist
route_queries                        string*         unset         domainlist        1.95
route_query                          string*         unset         domainlist
search_parents                       boolean         false         domainlist        2.12
                                                     false         lookuphost
search_type                          string          unset         aliasfile
                                                     unset         domainlist
security                             string          +             main
self                                 string          "freeze"      routers
sender_address_relay                 address list    unset         main
sender_address_relay_hosts           string          *             main              3.14
sender_reject                        address list    unset         main
sender_reject_recipients             address list    unset         main
sender_try_verify                    boolean         false         main
sender_unqualified_hosts             host list       unset         main
sender_verify                        boolean         false         main
sender_verify_batch                  boolean         false         main              1.70
sender_verify_callback_domains       domain list     unset         main              3.20
sender_verify_callback_timeout       time            30s           main              3.20
sender_verify_fixup                  boolean         false         main              1.60
sender_verify_hosts                  host list       *             main
sender_verify_hosts_callback         host list       unset         main              3.20
sender_verify_max_retry_rate         integer         12            main
sender_verify_reject                 boolean         true          main
senders                              address list*   unset         directors         1.70
                                                     unset         routers           1.70
serialize_hosts                      host list       unset         smtp              1.60
server_condition                     string*         unset         plaintext         3.10
server_mail_auth_condition           string*         unset         authenticators    3.22
server_prompts                       string*         unset         plaintext         3.10
server_secret                        string*         unset         cram_md5          3.10
server_set_id                        string*         unset         authenticators    3.10
seteuid                              boolean         false         forwardfile
shadow_condition                     string*         unset         transports
shadow_transport                     string          unset         transports
size_addition                        integer         1024          smtp              1.91
skip_syntax_errors                   boolean         false         aliasfile         1.60
                                                     false         forwardfile       1.60
smtp_accept_keepalive                boolean         true          main
smtp_accept_max                      integer         20            main
smtp_accept_max_per_host             integer         0             main              2.05
smtp_accept_queue                    integer         0             main
smtp_accept_queue_per_connection     integer         10            main              2.03
smtp_accept_reserve                  integer         0             main
smtp_banner                          string*         +             main
smtp_check_spool_space               boolean         true          main              2.10
smtp_connect_backlog                 integer         5             main
smtp_etrn_command                    string*         unset         main              1.92
smtp_etrn_hosts                      host list       unset         main
smtp_etrn_serialize                  boolean         true          main              1.89
smtp_expn_hosts                      host list       unset         main              1.70
smtp_load_reserve                    fixed-point     unset         main
smtp_receive_timeout                 time            5m            main
smtp_reserve_hosts                   host list       unset         main
smtp_verify                          boolean         false         main
split_spool_directory                boolean         false         main              1.70
spool_directory                      string          ++            main
strip_excess_angle_brackets          boolean         false         main
strip_trailing_dot                   boolean         false         main
subject                              string*         unset         autoreply
suffix                               string*         "\n"          appendfile
                                                     "\n"          pipe
                                     string list     unset         directors
suffix_optional                      boolean         false         directors
syntax_errors_text                   string*         unset         aliasfile         2.05
                                                     unset         forwardfile       2.05
syntax_errors_to                     string          unset         aliasfile         1.70
                                                     unset         forwardfile       1.70
syslog_timestamp                     boolean         true          main              3.30
temp_errors                          string          +             pipe              1.95
text                                 string*         unset         autoreply
timeout                              time            5m            lmtp              3.20
                                                     1h            pipe
                                                     1h            queryprogram
                                                     5s            iplookup
timeout_frozen_after                 time            0s            main              3.20
timestamps_utc                       boolean         false         main              3.14
timezone                             string          +             main              3.15
tls_advertise_hosts                  host list       *             main              3.20
tls_certificate                      string*         unset         main              3.20
                                                     unset         smtp              3.20
tls_dhparam                          string*         unset         main              3.20
tls_host_accept_relay                host list       unset         main              3.20
tls_hosts                            host list       unset         main              3.20
tls_log_cipher                       boolean         true          main              3.20
tls_log_peerdn                       boolean         false         main              3.20
tls_privatekey                       string*         unset         main              3.20
                                                     unset         smtp              3.20
tls_verify_certificates              string*         unset         main              3.20
                                                     unset         smtp              3.20
tls_verify_ciphers                   string*         unset         main              3.20
                                                     unset         smtp              3.20
tls_verify_hosts                     host list       unset         main              3.20
to                                   string*         unset         autoreply
translate_ip_address                 string          unset         routers           3.05
transport                            string*         unset         directors
                                                     unset         routers
transport_filter                     string          unset         transports
trusted_groups                       string list     unset         main
trusted_users                        string list     unset         main
umask                                octal-integer   022           pipe
unknown_login                        string          unset         main
unknown_username                     string          unset         main
unseen                               boolean         false         directors
untrusted_set_sender                 boolean         false         main              3.20
                                                     false         routers
use_crlf                             boolean         false         appendfile        1.89
                                                     false         pipe              1.89
use_fcntl_lock                       boolean         +             appendfile        1.70
use_lockfile                         boolean         +             appendfile
use_mbx_lock                         boolean         +             appendfile        2.10
use_shell                            boolean         false         pipe              1.70
user                                 string          unset         appendfile
                                                     unset         autoreply
                                                     +             directors         1.92
                                                     unset         lmtp              3.20
                                                     unset         pipe
                                                     +             routers           1.92
uucp_from_pattern                    string          +             main              1.75
uucp_from_sender                     string*         "$1"          main              1.75
verify                               boolean         true          directors
                                                     true          routers
verify_only                          boolean         false         directors         1.60
                                                     false         routers           1.60
verify_recipient                     boolean         true          directors
                                                     true          routers
verify_sender                        boolean         true          directors
                                                     true          routers
warnmsg_file                         string          unset         main              1.89
widen_domains                        string list     unset         lookuphost


2. COMMAND LINE OPTIONS
-----------------------

The table below contains a complete list of all Exim's command line options.
Those marked with # are available only to trusted users, those marked with +
are available only to admin users, and those marked with * exist only to
provide compatibility with Sendmail.

--              Terminate options
-B            * Ignored
-bd           + Start daemon
-be             Test string expansion
-bF             Test system filter file
-bf             Test user filter file
-bh             Test incoming SMTP call
-bi           * Run <command>bi_command</command>
-bm             Accept message on standard input
-bp           + List the queue
-bpa          + ... with generated addresses
-bpr          + ... do not sort
-bpra         + ... with generated addresses, unsorted
-bpru         + ... only undelivered addresses, unsorted
-bpu          + ... only undelivered addresses
-bP             Show configuration option settings
-brt            Test retry rules
-brw            Test rewriting rules
-bS             Read batch SMTP on standard input
-bs             Run SMTP on standard input and output
-bt             Test address directing and routing
-bV             Verify version number
-bv             Test recipient address verification
-bvs            Test sender address verification
-C            + Use alternate configuration file
-D            + Define macro for configuration file
-d              Turn on debugging output
-dm             ... with memory allocation information
-dropcr         Remove CR character in input
-E              Internal use only
-ex           * Synonym for -oex
-F              Set calling user name
-f            # Set calling user address
-h            * Ignored
-i              Dot does not terminate message
-M            + Force deliver specific message
-Mar          + Add recipient to message
-MC             Internal use only
-MCA            Internal use only
-MCQ            Internal use only
-MCS            Internal use only
-Mc           + Deliver specific message
-Meb          + Edit message body
-Mes          + Edit message sender
-Mf           + Freeze message(s)
-Mg           + Give up (bounce) message(s)
-Mmad         + Mark all recipients delivered
-Mmd          + Mark one recipient delivered
-Mrm          + Remove message(s) (no bounce)
-Mt           + Thaw message(s)
-Mvb          + View message body
-Mvh          + View message header
-Mvl          + View message log
-m            * Ignored
-N            + Deliver without transporting
-n            * Ignored
-oA           * Supply argument for <option>-bi</option>
-odb            Background delivery
-odf            Foreground delivery
-odi            Foreground delivery
-odq            Queue message; do not deliver
-odqr           ... do not deliver remote domains
-odqs           ... do not do SMTP deliveries
-oee            Error sent by mail; zero return code
-oem            Error sent by mail; non-zero return code
-oep            Error written to standard error stream
-oeq          * Error written to standard error stream
-oew          * Error sent by mail; non-zero return code
-oi             Dot does not terminate message
-oitrue       * Dot does not terminate message
-oMa          # Supply host address
-oMai         # Supply authenticated id
-oMas         # Supply authenticated sender
-oMi          # Supply interface address
-oMr          # Supply protocol name
-oMs          # Supply host name
-oMt          # Supply ident string
-om           * Ignored
-oo           * Ignored
-or             Timeout non-SMTP messages
-ov           * Verbose; same as <option>-d1</option>
-oX             Alternative port for daemon
-pd             Delay Perl interpreter start
-ps             Do not delay Perl interpreter start
-q            + Normal queue run
-qf           + ... force deliveries
-qff          + ... and include frozen messages
-qfl          + ... local domains only, forced
-qffl         + ... with forced and frozen
-ql           + ... local domains only
-qq...          Two-stage queue run
-qR           * Same as <option>-R</option>
-qS           * Same as <option>-S</option>
-R              Select by recipient in queue run
-Rf             ... with forcing
-Rff            ... and frozen messages
-Rr             ... using regular expression
-Rrf            ... with forcing
-Rrff           ... and frozen messages
-r            * Synonym for <option>-f</option>
-S              Select by sender in queue run
-Sf             ... with forcing
-Sff            ... and frozen messages
-Sr             ... using regular expression
-Srf            ... with forcing
-Srff           ... and frozen messages
-t              Take recipients from header lines
-v              Verbose; same as <option>-d1</option>
-x              Ignored (AIX compatibility)


3. BUILD TIME OPTIONS FOR EXIM
------------------------------

The table below contains a complete list of options that can be set in
Local/Makefile when building Exim. The second column gives the type of option:

 . `system' means the option is concerned with the operating system;

 . `driver' means the option selects a driver to be included in the binary;

 . `lookup' means the option selects a lookuptype to be included in the binary;

 . `mandatory' means the option is required to be supplied;

 . `recommended' means the option is recommended to be supplied;

 . `optional' means what it says;

Those marked with * are specialized and are unlikely to be required in most
installations. Those that are marked with ** are commonly set in OS-specific
Makefiles. If you use any of these in your Local/Makefile, you may need to
reproduce some of the OS-specific settings. For example, in the Makefile for
Solaris (which is actually called OS/Makefile-SunOS5), there is

  LIBS=-lsocket -lnsl -lkstat

If you use LIBS to add extra libraries, you must also include the OS ones in
your setting. It is better, in this particular case, to use EXTRALIBS, which is
empty by default, and is provided for just this reason. Of course, if you do
actually want to modify a setting from the OS-specific file, there is nothing
to stop you overriding it in your Local/Makefile.

Option                       Type         Description
------------------------------------------------------------------------------
AR                           system       command to build a library
AUTH_CRAM_MD5                driver       include cram_md5 authenticator
AUTH_PLAINTEXT               driver       include plaintext authenticator
BASENAME_COMMAND             system**     path to basename
BIN_DIRECTORY                mandatory    Exim binary directory
CC                           system**     C compiler
CFLAGS                       system**     flags for C compiler
CHGRP_COMMAND                system**     path to chgrp
CHOWN_COMMAND                system**     path to chown
COMPRESS_COMMAND             system       path to a compress command
COMPRESS_SUFFIX              system       suffix added to compressed files
CONFIGURE_FILE               mandatory    Exim runtime configuration file
CONFIGURE_FILE_USE_EUID      optional*
CONFIGURE_FILE_USE_NODE      optional*
DBMLIB                       optional**   location of DBM library
DB_DIRECTORY_MODE            optional*    mode for hints directory
DB_LOCKFILE_MODE             optional*    mode for hints lock files
DB_LOCK_TIMEOUT              optional*    timeout for hints lock files
DB_MODE                      optional*    mode for hints files
DELIVER_BUFFER_SIZE          optional*
DIRECTOR_ALIASFILE           driver       include aliasfile director
DIRECTOR_FORWARDFILE         driver       include forwardfile director
DIRECTOR_LOCALUSER           driver       include localuser director
DIRECTOR_SMARTUSER           driver       include smartuser director
ERRNO_QUOTA                  optional*    error code for system quota failures
EXICYCLOG_MAX                optional     number of old log files to keep
EXIMON_TEXTPOP               system**
EXIM_CHMOD                   optional*
EXIM_GID                     recommended  gid to use for Exim
EXIM_MONITOR                 optional     set to eximon.bin to compile
EXIM_PERL                    optional
EXIM_UID                     recommended  uid to use for Exim
EXIWHAT_EGREP_ARG            system**
EXIWHAT_KILL_ARG             system**
EXIWHAT_PS_ARG               system**
EXIWHAT_PS_CMD               system**     path to ps command
EXTRALIBS                    system       additional libraries
EXTRALIBS_EXIMON             system       additional libraries for the monitor
HAVE_IPV6                    system       include IPv6 support
HAVE_SETEUID                 system**     OS has seteuid()
HAVE_SETRESUID               system**     OS has setresuid
HEADER_MAXSIZE               optional*    max memory for message header
HOSTNAME_COMMAND             system**     path to hostname command
INCLUDE                      system       path to include files
INFO_DIRECTORY               optional     directory for Info documentation
INPUT_DIRECTORY_MODE         optional     mode for input directory
IPV6_INCLUDE                 system       additional includes for IPv6
IPV6_LIBS                    system       additional libraries for IPv6
LDAP_LIB_TYPE                optional     type of LDAP library
LFLAGS                       system**     link editor flags
LIBIDENTCFLAGS               system       C flags when compiling libident
LIBIDENTNAME                 system       name for libident library
LIBRESOLV                    system**     library for DNS resolver
LIBS                         system**     additional libraries
LIBS_EXIMON                  system**     additional libraries for monitor
LOG_DIRECTORY_MODE           optional     mode for log directory
LOG_FILE_PATH                optional     path to log files
LOG_MODE                     optional     mode for log files
LOOKUP_CDB                   lookup       include cdb lookup
LOOKUP_DBM                   lookup       include dbm lookup
LOOKUP_DNSDB                 lookup       include dnsdb lookup
LOOKUP_INCLUDE               lookup       include files for lookups
LOOKUP_LDAP                  lookup       include ldap lookup
LOOKUP_LIBS                  lookup       include libraries for lookups
LOOKUP_LSEARCH               lookup       include lsearch lookup
LOOKUP_MYSQL                 lookup       include mysql lookup
LOOKUP_NIS                   lookup       include nis lookup
LOOKUP_NISPLUS               lookup       include nisplus lookup
LOOKUP_PGSQL                 lookup       include pgsql lookup
MAKE_SHELL                   optional*    shell to use
MAXINTERFACES                system       maximum network interfaces
MSGLOG_DIRECTORY_MODE        optional*    mode for message log directory
MV_COMMAND                   system       path to mv command
PCRE_CFLAGS                  system       compile flags for PCRE library
PERL_CC                      system*      compiler for Perl interface code
PERL_CCOPTS                  system*      flags for same
PERL_COMMAND                 system       path to Perl
PERL_LIBS                    system*      library for compiling Perl interface
PID_FILE_PATH                optional     path to daemon's pid file
RANLIB                       system**     path to ranlib command
RM_COMMAND                   system       path to rm command
ROUTER_DOMAINLIST            driver       include domainlist router
ROUTER_IPLITERAL             driver       include ipliteral router
ROUTER_IPLOOKUP              driver       include iplookup router
ROUTER_LOOKUPHOST            driver       include lookuphost router
ROUTER_QUERYPROGRAM          driver       include queryprogram router
SPOOL_DIRECTORY              recommended  path to spool directory
SPOOL_DIRECTORY_MODE         optional     mode of spool directory
SPOOL_MODE                   optional     mode of spool files
STDERR_FILE                  optional*    file for debug output
SUPPORT_MAILDIR              optional     support for maildir delivery
SUPPORT_MAILSTORE            optional     support for mailstore delivery
SUPPORT_MBX                  optional     support for MBX delivery
SUPPORT_MOVE_FROZEN_MESSAGES optional     support for frozen message moving
SUPPORT_PAM                  optional     support for PAM authentication
SUPPORT_TLS                  optional     support for TLS encryption over SMTP
TIMEZONE_DEFAULT             optional     default for timezone option
TLS_INCLUDE                  optional     path to include files for TLS
TLS_LIBS                     optional     additional libraries for TLS
TRANSPORT_APPENDFILE         driver       include appendfile transport
TRANSPORT_AUTOREPLY          driver       include autoreply transport
TRANSPORT_LMTP               driver       include lmtp transport
TRANSPORT_PIPE               driver       include pipe transport
TRANSPORT_SMTP               driver       include smtp transport
USE_DB                       system**     use native DB interface
USE_TDB                      optional     use the tdb DB interface
USE_TCP_WRAPPERS             system       link with tcpwrappers
X11                          system**     X11 base directory
X11_LD_LIB                   system**     X11 link library
XINCLUDE                     system**     X11 include directory
XLFLAGS                      system**     X11 link time flags
ZCAT_COMMAND                 system       path to zcat command


4. BUILD TIME OPTIONS FOR EXIMON
--------------------------------

The table below contains a complete list of options that can be set in
Local/eximon.conf when building the Exim monitor. Where the default is shown as
** it means that the text string is too long to fit in the table and is instead
given below. A blank default means that there is no default value.

ACTION_OUTPUT=yes                         show output for every action
ACTION_QUEUE_UPDATE=yes                   update queue display after actions
BODY_MAX=20000                            maximum body display
DOMAIN=                                   domain to strip from window title
LOG_BUFFER=20K                            buffer for log tail
LOG_DEPTH=300                             depth of log subwindow
LOG_FONT=**                               font for log display
LOG_STRIPCHARTS=**                        patterns for stripcharts
LOG_WIDTH=950                             width of log subwindow
MENU_EVENT='Shift<Btn1Down>'              keypress for menu
MIN_HEIGHT=162                            minimum window height
MIN_WIDTH=103                             minimum window width
QUALIFY_DOMAIN=                           local domain to strip from addresses
QUEUE_DEPTH=200                           depth of queue subwindow
QUEUE_FONT=$LOG_FONT                      font for queue display
QUEUE_INTERVAL=300                        queue refresh interval
QUEUE_MAX_ADDRESSES=10                    max addresses to show in queue
QUEUE_STRIPCHART_NAME=queue               name for queue stripchart
QUEUE_WIDTH=950                           width of queue subwindow
SIZE_STRIPCHART=                          request partition size stripchart
SIZE_STRIPCHART_NAME=space                name for size stripchart
START_SMALL=no                            if yes, start with small window
STRIPCHART_INTERVAL=60                    stripchart refresh interval
TEXT_DEPTH=200                            depth of text windows
WINDOW_TITLE="${hostname} eximon"         window title

The default for LOG_FONT is

  LOG_FONT=-misc-fixed-medium-r-normal-*-14-140-*-*-*-*-iso8859-1

and the default for LOG_STRIPCHARTS is

  LOG_STRIPCHARTS='/ <= /in/
                   / => /out/
                   / => .+ D=/local/
                   / => .+ T=[^ ]*smtp/smtp/'

That is, there are four stripcharts, named in, out, local, and smtp. The first
counts message arrivals, the second counts all deliveries, the third counts
deliveries where the director's name starts with local, and the fourth counts
deliveries where the transport name ends in smtp.

**** End of OptionLists ****
