documenting functions. adding @deprecated to obsolate functions and @since

[squirrelmail.git] / config / config_default.php

diff --git a/config/config_default.php b/config/config_default.php
index fe4c4a840abc43856a38f5423a3e068e9ec969db..2203bc588c7b8fb30d9c882f13bbf4d3e3f11bf2 100644 (file)
--- a/config/config_default.php
+++ b/config/config_default.php
@@ -50,7 +50,7 @@ $org_logo_height = '111';
  * This is the web page title that appears at the top of the browser window.
  * @global string $org_title
  */
-$org_title = "SquirrelMail $version";
+$org_title = "SquirrelMail";
 
 /**
  * Signout page
@@ -90,12 +90,12 @@ $provider_name = 'SquirrelMail';
  * Provider URI
  *
  * Here you can set URL of the link displayed on the right side of main page.
- *
+ * When empty, this refers to the SquirrelMail About page.
  * Link will be displayed only if you have $hide_sm_attributions
  * option set to true.
  * @global string $provider_uri
  */
-$provider_uri = 'http://www.squirrelmail.org/';
+$provider_uri = '';
 
 /*** Server Settings ***/
 /**
@@ -145,7 +145,7 @@ $smtpPort = 25;
 /**
  * SquirrelMail header control
  *
- * Option can be used to disable Received: headers added by squirrelmail.
+ * Option can be used to disable Received: headers added by SquirrelMail.
  * This can increase user's privacy and solve problems with spam filters
  * that increase spam marks for dynamic dialup addresses.
  *
@@ -192,13 +192,14 @@ $imapPort = 143;
  *   exchange
  *   uw
  *   macosx
+ *   hmailserver
  *   mercury32
  *   other
  *
  * Please note that this changes only some of server settings.
  *
  * In order to set everything correctly, you need to adjust several
- * squirrelmail options. These options are listed in doc/presets.txt
+ * SquirrelMail options. These options are listed in doc/presets.txt
  * @global string $imap_server_type
  */
 $imap_server_type = 'other';
@@ -455,7 +456,7 @@ $attachment_dir = $data_dir;
 /**
  * Hash level used for data directory.
  *
- * This option allows spliting file based squirrelmail user
+ * This option allows spliting file based SquirrelMail user
  * data storage directory into several subfolders. Number from
  * 0 to 4 allows allows having up to four subfolder levels.
  *
@@ -496,7 +497,7 @@ $default_use_priority = true;
 /**
  * SquirrelMail Attributions Control
  *
- * This option disables display of "created by squirrelmail developers"
+ * This option disables display of "created by SquirrelMail developers"
  * strings and provider link
  * @global bool $hide_sm_attributions
  */
@@ -749,15 +750,24 @@ $default_use_javascript_addr_book = false;
 /**
  * Shared filebased address book
  * @global string $abook_global_file
+ * @since 1.5.1 and 1.4.4
  */
 $abook_global_file = '';
 
 /**
  * Writing into shared address book control
  * @global bool $abook_global_file_writeable
+ * @since 1.5.1 and 1.4.4
  */
 $abook_global_file_writeable = false;
 
+/**
+ * Listing of shared address book control
+ * @global bool $abook_global_file_listing
+ * @since 1.5.1
+ */
+$abook_global_file_listing = true;
+
 /**
  * MOTD
  *
@@ -772,8 +782,8 @@ $motd = "";
  * the plugin directory name relative to the /plugins/ directory.
  * For instance, for the 'sqclock' plugin, you'd put a line like
  * the following.
- *    $plugins[0] = 'sqclock';
- *    $plugins[1] = 'attachment_common';
+ *    $plugins[] = 'sqclock';
+ *    $plugins[] = 'attachment_common';
  */
 // Add list of enabled plugins here
 
@@ -803,12 +813,31 @@ $prefs_table = 'userprefs';
 $prefs_key_field = 'prefkey';
 $prefs_user_field = 'user';
 $prefs_val_field = 'prefval';
+
+/*** Global sql database options ***/
 /**
- * Global sql database options
+ * DSN of global address book database
+ * @global string $addrbook_global_dsn
+ * @since 1.5.1
  */
 $addrbook_global_dsn = '';
+/**
+ * Table used for global database address book
+ * @global string $addrbook_global_table
+ * @since 1.5.1
+ */
 $addrbook_global_table = 'global_abook';
+/**
+ * Control writing into global database address book
+ * @global boolean $addrbook_global_writeable
+ * @since 1.5.1
+ */
 $addrbook_global_writeable = false;
+/**
+ * Control listing of global database address book
+ * @global boolean $addrbook_global_listing
+ * @since 1.5.1
+ */
 $addrbook_global_listing = false;
 
 /*** Language settings ***/
@@ -890,19 +919,12 @@ $lossy_encoding = false;
  */
 $advanced_tree = false;
 
-/**
- * Older listing way control
- *
- * Use older way of folder listing
- * @global bool $oldway
- */
-$oldway = false;
-
 /**
  * Message Icons control
  *
  * Use icons for message and folder markers
  * @global bool $use_icons
+ * @since 1.5.1
  */
 $use_icons = false;
 
@@ -934,6 +956,13 @@ $use_php_recode = false;
  */
 $use_php_iconv = false;
 
+/**
+ * Controls remote configuration checks
+ * @global boolean $allow_remote_configtest
+ * @since 1.5.1
+ */
+$allow_remote_configtest = false;
+
 /**
  * Subscribe Listing Control
  *
@@ -968,4 +997,4 @@ $config_use_color = 2;
  * sent and regular output to begin, which will majorly screw
  * things up when we try to send more headers later.
  */
-?>
\ No newline at end of file
+?>