phpDocumentor updates

[squirrelmail.git] / config / config_default.php

diff --git a/config/config_default.php b/config/config_default.php
index f564b4cf9fd9d70d55bc95e2e115ae2a94957e43..1db8ddee1e1e6cbffbe45bfb2f77daf2c7f7fb65 100644 (file)
--- a/config/config_default.php
+++ b/config/config_default.php
@@ -10,6 +10,9 @@
  * conf.pl if at all possible.  That is the easiest and cleanest way
  * to configure.
  *
+ * @copyright © 2000-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package squirrelmail
  * @subpackage config
  */
@@ -192,14 +195,15 @@ $imapPort = 143;
  *
  * The type of IMAP server you are running.
  * Valid type are the following (case is important):
+ *   bincimap
  *   courier
  *   cyrus
+ *   dovecot
  *   exchange
- *   uw
- *   macosx
  *   hmailserver
+ *   macosx
  *   mercury32
- *   dovecot
+ *   uw
  *   other
  *
  * Please note that this changes only some of server settings.
@@ -425,21 +429,24 @@ $noselect_fix_enable = false;
 /**
  * Path to the data/ directory
  *
+ *   You need to create this directory yourself (see INSTALL).
+ *
  *   It is a possible security hole to have a writable directory
  *   under the web server's root directory (ex: /home/httpd/html).
- *   For this reason, it is possible to put the data directory
- *   anywhere you would like. The path name can be absolute or
- *   relative (to the config directory). It doesn't matter. Here
- *   are two examples:
+ *   The path name can be absolute or relative (to the config directory).
+ *   Here are two examples:
  *
  * Absolute:
- *   $data_dir = '/usr/local/squirrelmail/data/';
+ *   $data_dir = '/var/local/squirrelmail/data/';
  *
  * Relative (to main SM directory):
  *   $data_dir = SM_PATH . 'data/';
+ *   (NOT recommended: you need to secure apache to make sure these
+ *   files are not world readable)
+ *
  * @global string $data_dir
  */
-$data_dir = SM_PATH . 'data/';
+$data_dir = '/var/local/squirrelmail/data';
 
 /**
  * Attachments directory
@@ -452,8 +459,9 @@ $data_dir = SM_PATH . 'data/';
  *      list files in this directory. Confidential data might be laying
  *      around there.
  *    + Since the webserver is not able to list the files in the content
- *       is also impossible for the webserver to delete files lying around
- *       there for too long.
+ *      is also impossible for the webserver to delete files lying around
+ *      there for too long. You should have some script that deletes
+ *      left over temp files.
  *    + It should probably be another directory than data_dir.
  * @global string $attachment_dir
  */
@@ -742,6 +750,15 @@ $theme[39]['NAME'] = 'Simple Green';
 $theme[40]['PATH'] = SM_PATH . 'themes/wood_theme.php';
 $theme[40]['NAME'] = 'Wood';
 
+$theme[41]['PATH'] = SM_PATH . 'themes/bluesome.php';
+$theme[41]['NAME'] = 'Bluesome';
+
+$theme[42]['PATH'] = SM_PATH . 'themes/simple_green2.php';
+$theme[42]['NAME'] = 'Simple Green 2';
+
+$theme[43]['PATH'] = SM_PATH . 'themes/simple_purple.php';
+$theme[43]['NAME'] = 'Simple Purple';
+
 /**
  * LDAP server(s)
  *   Array of arrays with LDAP server parameters. See
@@ -832,9 +849,39 @@ $addrbook_table = 'address';
  */
 $prefs_dsn = '';
 $prefs_table = 'userprefs';
+/**
+ * Preference key field 
+ * @global string $prefs_key_field
+ */
 $prefs_key_field = 'prefkey';
+/**
+ * Size of preference key field
+ * @global integer $prefs_key_size
+ * @since 1.5.1
+ */
+$prefs_key_size = 64;
+/**
+ * Preference owner field 
+ * @global string $prefs_user_field
+ */
 $prefs_user_field = 'user';
+/**
+ * Size of preference owner field
+ * @global integer $prefs_user_size
+ * @since 1.5.1
+ */
+$prefs_user_size = 128;
+/**
+ * Preference value field 
+ * @global string $prefs_val_field
+ */
 $prefs_val_field = 'prefval';
+/**
+ * Size of preference key field
+ * @global integer $prefs_val_size
+ * @since 1.5.1
+ */
+$prefs_val_size = 65536;
 
 /*** Global sql database options ***/
 /**
@@ -886,19 +933,6 @@ $squirrelmail_default_language = 'en_US';
  */
 $default_charset = 'iso-8859-1';
 
-/**
- * Available Languages
- *
- * This option controls number of languages available to end user in
- * language selection preferences. You can use space separated list
- * of translations installed in locale/ directory or special keys
- * 'all' (all languages are available) and 'none' (language selection
- * is disabled, interface is set to $squirrelmail_default_language
- * @global string $available_languages
- * @since 1.5.0
- */
-$available_languages   = 'all';
-
 /**
  * Alternative Language Names Control
  *
@@ -931,6 +965,29 @@ $aggressive_decoding = false;
  */
 $lossy_encoding = false;
 
+/**
+ * Controls use of time zone libraries
+ *
+ * Possible values:
+ * <ul>
+ *  <li>0 - default, SquirrelMail uses GNU C timezone names in
+ *          TZ environment variables
+ *  <li>1 - strict, SquirrelMail uses 'TZ' subkey values in TZ
+ *          environment variables
+ *  <li>2 - custom, SquirrelMail loads time zone data from
+ *          config/timezones.php and uses time zone array keys in
+ *          TZ enviroment variables
+ *  <li>3 - custom strict, SquirrelMail loads time zone data from
+ *          config/timezones.php and uses TZ subkey values in
+ *          TZ enviroment variables
+ * </ul>
+ * Use of any other value switches to default SquirrelMail time zone
+ * handling ($time_zone_type).
+ * @global integer $time_zone_type
+ * @since 1.5.1
+ */
+$time_zone_type = 0;
+
 /*** Tweaks ***/
 /**
  * Advanced DHTML tree control