Make sure link tags are proper XHTML

[squirrelmail.git] / config / config_local.example.php

diff --git a/config/config_local.example.php b/config/config_local.example.php
index bcb482c672a5eac89a27b461d7ea83f8b309b50c..d3dc9611b719ee83c1078296870e6fc5cb932d12 100644 (file)
--- a/config/config_local.example.php
+++ b/config/config_local.example.php
@@ -7,7 +7,7 @@
  * Don't do it unless you know what you're doing.
  * Use standard PHP syntax, see config.php for examples.
  *
- * @copyright 2002-2014 The SquirrelMail Project Team
+ * @copyright 2002-2018 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -52,28 +52,98 @@
  * (those that are displayed in a different color than other
  * "normal" mailboxes).
  *
- * $smtpSslOptions allows more control over the SSL context used
- * when connecting to the SMTP server over SSL/TLS.  See:
+ * $hash_dirs_use_md5 (boolean) If set to TRUE, forces the
+ * hashed preferences directory calculation to use MD5 instead
+ * of CRC32.
+ *
+ * $hash_dirs_strip_domain (boolean) If set to TRUE, and if
+ * usernames are in full email address format, the domain
+ * part (beginning with "@") will be stripped before
+ * calculating the CRC or MD5.
+ *
+ * $smtp_stream_options allows more control over the SSL context
+ * used when connecting to the SMTP server over SSL/TLS.  See:
+ * http://www.php.net/manual/context.php and in particular
  * http://php.net/manual/context.ssl.php
  * For example, you can specify a CA file that corresponds
  * to your server's certificate and make sure that the
  * server's certificate is validated when connecting:
- * $smtpSslOptions = array(
- *     'cafile' => '/etc/pki/tls/certs/ca-bundle.crt',
- *     'verify_peer' => true,
- *     'verify_depth' => 3,
+ * $smtp_stream_options = array(
+ *     'ssl' => array(
+ *         'cafile' => '/etc/pki/tls/certs/ca-bundle.crt',
+ *         'verify_peer' => true,
+ *         'verify_depth' => 3,
+ *     ),
  * );
  *
- * $imapSslOptions allows more control over the SSL context used
- * when connecting to the IMAP server over SSL/TLS.  See:
- * http://php.net/manual/context.ssl.php
+ * $imap_stream_options allows more control over the SSL
+ * context used when connecting to the IMAP server over
+ * SSL/TLS.  See: http://www.php.net/manual/context.php
+ * and in particular http://php.net/manual/context.ssl.php
  * For example, you can specify a CA file that corresponds
  * to your server's certificate and make sure that the
  * server's certificate is validated when connecting:
- * $imapSslOptions = array(
- *     'cafile' => '/etc/pki/tls/certs/ca-bundle.crt',
- *     'verify_peer' => true,
- *     'verify_depth' => 3,
+ * $imap_stream_options = array(
+ *     'ssl' => array(
+ *         'cafile' => '/etc/pki/tls/certs/ca-bundle.crt',
+ *         'verify_peer' => true,
+ *         'verify_depth' => 3,
+ *     ),
  * );
+ *
+ * $disable_pdo (boolean) tells SquirrelMail not to use
+ * PDO to access the user preferences and address book
+ * databases as it normally would.  When this is set to
+ * TRUE, Pear DB will be used instead, but this is not
+ * recommended.
+ *
+ * $pdo_show_sql_errors (boolean) causes the actual
+ * database error to be displayed when one is encountered.
+ * When set to FALSE, generic errors are displayed,
+ * preventing internal database information from being
+ * exposed.  This should be set to TRUE only for debugging
+ * purposes.
+ *
+ * $pdo_identifier_quote_char (string) allows you to
+ * override the character used for quoting table and field
+ * names in database queries.  Set this to the desired
+ * Quote character, for example:
+ * $pdo_identifier_quote_char = '"';
+ * Or you can tell SquirrelMail not to quote identifiers
+ * at all by setting this to "none".  When this setting
+ * is empty or not found, SquirrelMail will attempt to
+ * quote table and field names with what it thinks is
+ * the appropriate quote character for the database type
+ * being used (backtick for MySQL (and thus MariaDB),
+ * double quotes for all others).
+ *
+ * $use_expiring_security_tokens (boolean) allows you to
+ * make SquirrelMail use short-lived anti-CSRF security
+ * tokens that expire as desired (not recommended, can
+ * cause user-facing issues when tokens expire unexpectedly).
+ *
+ * $max_token_age_days (integer) allows you to indicate how
+ * long a token should be valid for (in days) (only relevant
+ * when $use_expiring_security_tokens is enabled).
+ *
+ * $do_not_use_single_token (boolean) allows you to force
+ * SquirrelMail to generate a new token every time one is
+ * requested (which may increase obscurity through token
+ * randomness at the cost of some performance).  Otherwise,
+ * only one token will be generated per user which will
+ * change only after it expires or is used outside of the
+ * validity period specified when calling
+ * sm_validate_security_token() (only relevant when
+ * $use_expiring_security_tokens is enabled).
+ * 
+ * $head_tag_extra can be used to add custom tags inside
+ * the <head> section of *ALL* pages.  The string
+ * "###SM BASEURI###" will be replaced with the base URI
+ * for this SquirrelMail installation.  This may be used,
+ * for example, to add custom favicon tags.  If this
+ * setting is empty here, SquirrelMail will add a favicon
+ * tag by default.  If you want to retain the default favicon
+ * while using this setting, you must include the following
+ * as part of this setting:
+ * $head_tag_extra = '<link rel="shortcut icon" href="###SM BASEURI###favicon.ico" />...<YOUR CONTENT HERE>...';
  */
-