document TK's bug 1239 fix in ChangeLog

[users/jgh/exim.git] / doc / doc-txt / OptionLists.txt

diff --git a/doc/doc-txt/OptionLists.txt b/doc/doc-txt/OptionLists.txt
index 89d86063e5a40d197933a572ae93731ecae7d6cf..5313fd17c53d06be70e69410d56191d948185254 100644 (file)
--- a/doc/doc-txt/OptionLists.txt
+++ b/doc/doc-txt/OptionLists.txt
@@ -1,5 +1,3 @@
-$Cambridge: exim/doc/doc-txt/OptionLists.txt,v 1.37 2010/06/06 02:08:50 pdp Exp $
-

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


@@ -182,6 +180,7 @@ 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
 dns_retrans                          time            0s            main              1.60
 dns_retry                            integer         0             main              1.60
 dns_search_parents                   boolean         false         smtp

+dns_use_edns0                        integer         -1            main              4.76

 domains                              domain list     unset         routers           4.00
 driver                               string          unset         authenticators
                                                      unset         routers           4.00
 domains                              domain list     unset         routers           4.00
 driver                               string          unset         authenticators
                                                      unset         routers           4.00


@@ -235,6 +234,7 @@ forbid_pipe                          boolean         false         redirect
 forbid_sieve_filter                  boolean         false         redirect          4.44
 forbid_smtp_code                     boolean         false         redirect          4.63
 freeze_exec_fail                     boolean         false         pipe              1.89
 forbid_sieve_filter                  boolean         false         redirect          4.44
 forbid_smtp_code                     boolean         false         redirect          4.63
 freeze_exec_fail                     boolean         false         pipe              1.89

+freeze_signal                        boolean         false         pipe              4.75

 freeze_tell                          boolean         false         main              4.00 replaces freeze_tell_mailmaster
 from                                 string*         unset         autoreply
 gecos_name                           string*         unset         main
 freeze_tell                          boolean         false         main              4.00 replaces freeze_tell_mailmaster
 from                                 string*         unset         autoreply
 gecos_name                           string*         unset         main


@@ -336,7 +336,7 @@ mailbox_size                         string*         unset         appendfile
 maildir_format                       boolean         false         appendfile        1.70
 maildir_retries                      integer         10            appendfile        1.70
 maildir_tag                          string*         unset         appendfile        1.92
 maildir_format                       boolean         false         appendfile        1.70
 maildir_retries                      integer         10            appendfile        1.70
 maildir_tag                          string*         unset         appendfile        1.92

-maildir_use_size_file                boolean         false         appendfile        4.30
+maildir_use_size_file                boolean*        false         appendfile        4.30 expanded in 4.77

 maildirfolder_create_regex           string          unset         appendfile        4.62
 mailstore_format                     boolean         false         appendfile        2.00
 mailstore_prefix                     string*         unset         appendfile        2.00
 maildirfolder_create_regex           string          unset         appendfile        4.62
 mailstore_format                     boolean         false         appendfile        2.00
 mailstore_prefix                     string*         unset         appendfile        2.00


@@ -466,14 +466,19 @@ sender_unqualified_hosts             host list       unset         main
 senders                              address list    unset         routers           4.00
 serialize_hosts                      host list       unset         smtp              1.60
 server_advertise_condition           string*         unset         authenticators    4.14
 senders                              address list    unset         routers           4.00
 serialize_hosts                      host list       unset         smtp              1.60
 server_advertise_condition           string*         unset         authenticators    4.14

+server_channelbinding                bool            false         gsasl             4.78

 server_condition                     string*         unset         authenticators    3.10 (plaintext) 4.64 (others)
 server_condition                     string*         unset         authenticators    3.10 (plaintext) 4.64 (others)

-server_hostname                      string*   "$primary_hostname" cyrus_sasl        4.43
+server_hostname                      string*   "$primary_hostname" cyrus_sasl,gsasl,heimdal_gssapi (cyrus-only) 4.78 (others)
+server_keytab                        string*         unset         heimdal_gssapi    4.78

 server_mail_auth_condition           string*         unset         authenticators    3.22
 server_mail_auth_condition           string*         unset         authenticators    3.22

-server_mech                          string          public_name   cyrus_sasl        4.43
+server_mech                          string          public_name   cyrus_sasl,gsasl  4.43 (cyrus-only) 4.78 (others)
+server_password                      string          unset         gsasl             4.78

 server_prompts                       string*         unset         plaintext         3.10
 server_prompts                       string*         unset         plaintext         3.10

-server_realm                         string          unset         cyrus_sasl        4.43
+server_realm                         string          unset         cyrus_sasl,gsasl  4.43 (cyrus-only) 4.78 (others)
+server_scram_iter                    string*         unset         gsasl             4.78
+server_scram_salt                    string*         unset         gsasl             4.78

 server_secret                        string*         unset         cram_md5          3.10
 server_secret                        string*         unset         cram_md5          3.10

-server_service                       string          "smtp"        cyrus_sasl        4.43
+server_service                       string          "smtp"  cyrus_sasl,gsasl,heimdal_gssapi  (cyrus-only) 4.78 (others)

 server_set_id                        string*         unset         authenticators    3.10
 shadow_condition                     string*         unset         transports
 shadow_transport                     string          unset         transports
 server_set_id                        string*         unset         authenticators    3.10
 shadow_condition                     string*         unset         transports
 shadow_transport                     string          unset         transports


@@ -529,6 +534,7 @@ system_filter_reply_transport        string          unset         main
 system_filter_user                   string          unset         main              4.00 replacing message_filter
 tcp_nodelay                          boolean         true          main              4.23
                                                      true          smtp              4.23
 system_filter_user                   string          unset         main              4.00 replacing message_filter
 tcp_nodelay                          boolean         true          main              4.23
                                                      true          smtp              4.23

+tcp_wrappers_daemon_name             string*         ++            main              4.73

 temp_errors                          string list     +             pipe              1.95
 text                                 string*         unset         autoreply
 timeout                              time            5m            lmtp              3.20
 temp_errors                          string list     +             pipe              1.95
 text                                 string*         unset         autoreply
 timeout                              time            5m            lmtp              3.20


@@ -736,9 +742,12 @@ provide compatibility with Sendmail.
 3. BUILD TIME OPTIONS FOR EXIM
 ------------------------------
 
 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. More information about individual options
-can be found in src/EDITME and OS/Makefile-Default.
+The table below contains a "mostly" complete list of options that can be
+set in Local/Makefile when building Exim.  The only items not included are
+those whose names can be trivially derived from rules stated below.
+
+More information about individual options can be found in src/EDITME and
+OS/Makefile-Default.

 
 The second column below gives the type of option:
 
 
 The second column below gives the type of option:
 


@@ -768,17 +777,36 @@ 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.
 
 actually want to modify a setting from the OS-specific file, there is nothing
 to stop you overriding it in your Local/Makefile.
 

+When building Exim with dynamically loaded lookup support, for "LOOKUP_FOO",
+you can define "LOOKUP_FOO_INCLUDE" and "LOOKUP_FOO_LIBS", for includes and
+libraries specific only to that module.  These rules are only used where the
+relevant lookup is a module.  These options are not explicitly listed below.
+
+Variables with names endined `_PC' are used for pkg-config integration; setting
+the value to the name of a pkg-config package will cause Exim's build system to
+query the --cflags and --libs for the given name, when building anything
+dependent upon the component associated with the `_PC' variable.  For lookups,
+if the lookup is dynamically loaded, then this *replaces* the use of the
+corresponding _INCLUDE and _LIBS options, which will be ignored.  If the lookup
+is statically loaded into Exim, the results will be inserted into the
+"LOOKUP_INCLUDE" and "LOOKUP_LIBS" options.  For authenticator, the results
+will be inserted into the "CFLAGS" and "AUTH_LIBS" options.  These options are
+only listed below for the TLS implementation cases.
+
+

 Option                       Type         Description
 ------------------------------------------------------------------------------
 
 ALT_CONFIG_PREFIX            optional     restricts location of -C files
 Option                       Type         Description
 ------------------------------------------------------------------------------
 
 ALT_CONFIG_PREFIX            optional     restricts location of -C files

-ALT_CONFIG_ROOT_ONLY         optional*    privileged -C needs root (not exim)

 APPENDFILE_MODE              optional*
 APPENDFILE_DIRECTORY_MODE    optional*
 APPENDFILE_LOCKFILE_MODE     optional*
 AR                           system       command to build a library
 AUTH_CRAM_MD5                driver       include cram_md5 authenticator
 AUTH_CYRUS_SASL              driver       include Cyrus SASL authenticator
 APPENDFILE_MODE              optional*
 APPENDFILE_DIRECTORY_MODE    optional*
 APPENDFILE_LOCKFILE_MODE     optional*
 AR                           system       command to build a library
 AUTH_CRAM_MD5                driver       include cram_md5 authenticator
 AUTH_CYRUS_SASL              driver       include Cyrus SASL authenticator

+AUTH_GSASL                   driver       include GNU SASL authenticator
+AUTH_HEIMDAL_GSSAPI          driver       include Heimdal GSSAPI authenticator
+AUTH_LIBS                    system       library linkage for authenticators

 AUTH_PLAINTEXT               driver       include plaintext authenticator
 AUTH_SPA                     driver       include SPA (NTLM) authenticator
 AUTH_VARS=3                  optional*    number of $auth variables
 AUTH_PLAINTEXT               driver       include plaintext authenticator
 AUTH_SPA                     driver       include SPA (NTLM) authenticator
 AUTH_VARS=3                  optional*    number of $auth variables


@@ -787,6 +815,7 @@ BASE_62=62                   optional*    not normally changed for Unix
 BIN_DIRECTORY                mandatory    Exim binary directory
 CC                           system**     C compiler
 CFLAGS                       system**     flags for C compiler
 BIN_DIRECTORY                mandatory    Exim binary directory
 CC                           system**     C compiler
 CFLAGS                       system**     flags for C compiler

+CFLAGS_DYNAMIC               system**     extra flags needed for .so modules

 CHGRP_COMMAND                system**     path to chgrp
 CHOWN_COMMAND                system**     path to chown
 COMPRESS_COMMAND             system       path to a compress command
 CHGRP_COMMAND                system**     path to chgrp
 CHOWN_COMMAND                system**     path to chown
 COMPRESS_COMMAND             system       path to a compress command


@@ -824,6 +853,7 @@ EXIWHAT_MULTIKILL_CMD        system**
 EXIWHAT_MULTIKILL_ARG        system**
 EXIWHAT_PS_ARG               system**     to list all processes
 EXIWHAT_PS_CMD               system**     path to ps command
 EXIWHAT_MULTIKILL_ARG        system**
 EXIWHAT_PS_ARG               system**     to list all processes
 EXIWHAT_PS_CMD               system**     path to ps command

+EXPAND_LISTMATCH_RHS         optional*    restore pre-4.77 match_*{}{} behaviour

 EXTRALIBS                    system       additional libraries
 EXTRALIBS_EXIM               system       additional libraries for Exim only
 EXTRALIBS_EXIMON             system       additional libraries for the monitor
 EXTRALIBS                    system       additional libraries
 EXTRALIBS_EXIM               system       additional libraries for Exim only
 EXTRALIBS_EXIMON             system       additional libraries for the monitor


@@ -859,6 +889,7 @@ LOOKUP_INCLUDE               lookup       include files for lookups
 LOOKUP_LDAP                  lookup       include ldap lookup
 LOOKUP_LIBS                  lookup       include libraries for lookups
 LOOKUP_LSEARCH               lookup       include all lsearch lookups
 LOOKUP_LDAP                  lookup       include ldap lookup
 LOOKUP_LIBS                  lookup       include libraries for lookups
 LOOKUP_LSEARCH               lookup       include all lsearch lookups

+LOOKUP_MODULE_DIR            optional*    where dynamic lookup modules live

 LOOKUP_MYSQL                 lookup       include mysql lookup
 LOOKUP_NIS                   lookup       include nis lookup
 LOOKUP_NISPLUS               lookup       include nisplus lookup
 LOOKUP_MYSQL                 lookup       include mysql lookup
 LOOKUP_NIS                   lookup       include nis lookup
 LOOKUP_NISPLUS               lookup       include nisplus lookup


@@ -866,6 +897,8 @@ LOOKUP_ORACLE                lookup       include oracle lookup
 LOOKUP_PGSQL                 lookup       include pgsql lookup
 LOOKUP_TESTDB                lookup*
 LOOKUP_WHOSON                lookup       include whoson lookup
 LOOKUP_PGSQL                 lookup       include pgsql lookup
 LOOKUP_TESTDB                lookup*
 LOOKUP_WHOSON                lookup       include whoson lookup

+LOOKUP_*_INCLUDE             optional*    include files for dynamic module
+LOOKUP_*_LIBS                optional*    libraries for dynamic module

 MAKE_SHELL                   optional*    shell to use for make
 MAX_FILTER_SIZE              optional*    max file size for filter files
 MAX_INCLUDE_SIZE             optional*    max file size for :include: files
 MAKE_SHELL                   optional*    shell to use for make
 MAX_FILTER_SIZE              optional*    max file size for filter files
 MAX_INCLUDE_SIZE             optional*    max file size for :include: files


@@ -909,6 +942,7 @@ SUPPORT_TRANSLATE_IP_ADDRESS optional*    support for address translation
 SYSLOG_LOG_PID               optional     add pid to syslog lines
 SYSLOG_LONG_LINES            optional     do not split long syslog lines
 SYSTEM_ALIASES_FILE          optional     defaults to /etc/aliases
 SYSLOG_LOG_PID               optional     add pid to syslog lines
 SYSLOG_LONG_LINES            optional     do not split long syslog lines
 SYSTEM_ALIASES_FILE          optional     defaults to /etc/aliases

+TCP_WRAPPERS_DAEMON_NAME     system*      daemon name used by tcpwrappers library

 TIMEZONE_DEFAULT             optional     default for timezone option
 TLS_INCLUDE                  optional     path to include files for TLS
 TLS_LIBS                     optional     additional libraries for TLS
 TIMEZONE_DEFAULT             optional     default for timezone option
 TLS_INCLUDE                  optional     path to include files for TLS
 TLS_LIBS                     optional     additional libraries for TLS


@@ -918,11 +952,15 @@ TRANSPORT_AUTOREPLY          driver       include autoreply transport
 TRANSPORT_LMTP               driver       include lmtp transport
 TRANSPORT_PIPE               driver       include pipe transport
 TRANSPORT_SMTP               driver       include smtp transport
 TRANSPORT_LMTP               driver       include lmtp transport
 TRANSPORT_PIPE               driver       include pipe transport
 TRANSPORT_SMTP               driver       include smtp transport

+TRUSTED_CONFIG_LIST          optional     config files safe to retain privileges

 USE_DB                       system**     use native DB interface
 USE_GNUTLS                   optional     use GnuTLS instead of OpenSSL
 USE_DB                       system**     use native DB interface
 USE_GNUTLS                   optional     use GnuTLS instead of OpenSSL

+USE_GNUTLS_PC                optional     probably "gnutls"
+USE_OPENSSL_PC               optional     probably "openssl"

 USE_READLINE                 optional     try to load libreadline for -be
 USE_TCP_WRAPPERS             system       link with tcpwrappers
 USE_TDB                      optional     use the tdb DB interface
 USE_READLINE                 optional     try to load libreadline for -be
 USE_TCP_WRAPPERS             system       link with tcpwrappers
 USE_TDB                      optional     use the tdb DB interface

+WHITELIST_D_MACROS           optional     -Dmacros safe to retain privileges with

 WITH_OLD_CLAMAV_STREAM       optional*    use ClamAV API from before ClamAV 0.95
 X11                          system**     X11 base directory
 X11_LD_LIB                   system**     X11 link library
 WITH_OLD_CLAMAV_STREAM       optional*    use ClamAV API from before ClamAV 0.95
 X11                          system**     X11 base directory
 X11_LD_LIB                   system**     X11 link library