Fix for folder cache if the cache was somehow broken. Reproduced bad cache

[squirrelmail.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index cf1f63099cd4057f60af73cce44dba595da6a854..5a75c96aa400c51bb7de5f403a51af381ff02193 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -22,7 +22,7 @@ Each of these steps is covered in detail below.
 - Unpack the SquirrelMail package in a web-accessible location.
 - Select a data-dir and attachment dir, outside the webtree (e.g. in /var).
   The data-dir (for user prefs) should be owned by the user the webserver
-  runs as (eg www-data). The attachment dir (for uploading files as
+  runs as (e.g. www-data). The attachment dir (for uploading files as
   attachments) should be file mode 0730 and in the same group as the
   webserver.
 - Run config/conf.pl from the command line. Use the D option to load
@@ -43,17 +43,31 @@ Each of these steps is covered in detail below.
   You can find PHP at http://www.php.net. See the documentation that
   comes with PHP for instructions how to set it up.
 
-  The PHP IMAP extension is NOT neccessary at all (but won't harm)!
+  The PHP IMAP extension is NOT necessary at all (but won't harm)!
   Below is a list of optional PHP extensions:
 
-  --with-ldap     Required for LDAP addressbooks
-  --with-mhash    Will improve charset decoding if present
-  --with-mysql    For MySQL storage of preferences or addressbooks
-  --with-openssl  When you want to use encrypted IMAP connections (TLS)
+  --with-ldap
+    Required for LDAP addressbooks
 
-  If you're going to use LDAP in the addressbook, you must compile PHP
-  with the LDAP extension. Include the MHASH extension to improve
-  performance in character set decoding.
+  --with-pear and --with-mysql
+    For MySQL storage of preferences or addressbooks. You will need PHP
+    compiled with --with-pgsql option, if you want to use PostgreSQL instead
+    of MySQL. You will need PHP with appropriate database extension, if you
+    want to use any other database.
+
+  --with-openssl
+    Required for encrypted IMAP or SMTP connections (TLS)
+
+  --with-mcrypt
+    Can be used by SquirrelSpell plugin for encryption of personal
+    dictionaries
+
+  --with-iconv or --with-recode
+    Can be used by Eastern charset decoding functions
+
+  --enable-mbstring
+    Required for Japanese translation. Optional for translations that
+    use non-ISO-8859-1 charset
 
   If you want your users to attach files to their mails, make sure
   File Uploads in php.ini is set to On.
@@ -169,7 +183,7 @@ c. Setting up SquirrelMail
 
   Point your browser at the URL at which SquirrelMail is installed.  A
   possible example of this is:
-     http://www.yourdomain.com/squirrelmail
+     http://www.example.com/squirrelmail
 
   It should be pretty straight forward to use. Some more documentation
   might show up one day or another.
@@ -179,7 +193,7 @@ c. Setting up SquirrelMail
 -------------------
 
   For information on how to make SquirrelMail work with Russian
-  Apache, see the README.russian_apache in the doc/ subdirectory.
+  Apache, see the russian_apache.txt in the doc/ subdirectory.
 
 
 6. TRANSLATIONS
@@ -192,24 +206,26 @@ c. Setting up SquirrelMail
   Locale packages can be downloaded from SquirrelMail SourceForge
   project page.
 
-  http://sourceforge.net/project/showfiles.php?group_id=311&package_id=110388
+     http://sourceforge.net/project/showfiles.php?group_id=311&package_id=110388
 
-  Each translation contains install script that copies required files
-  into appropriate locations. If you can't run that script, you can extract
-  contents of translation packages into your SquirrelMail directory.
+  Each translation contains an install script that copies the required files
+  into their appropriate locations. If you can't run that script, you can
+  extract the contents of translation packages into your SquirrelMail
+  directory.
 
-  NOTE No.1: *-src.tar.gz, *-src.tar.bz2 and *-src.zip archives does not contain
-  compiled translation files. You will need to run compilelocales script
+  NOTE No.1: *-src.tar.gz, *-src.tar.bz2 and *-src.zip archives do not contain
+  compiled translation files. You will need to run the compilelocales script
   in order to get all gettext binary translations.
 
   NOTE No.2: You might need to restart your webserver before using translations.
   If you can't do that, install your translations _before_ you use SquirrelMail.
 
+
 7. PLUGINS
 ----------
 
-  SquirrelMail package includes some standard plugins. These plugins can be 
-  enabled in SquirrelMail configuration script.
+  The SquirrelMail package includes some standard plugins. These plugins can be
+  enabled in the SquirrelMail configuration script.
 
   Included plugins can use additional configuration files:
   * change_password
@@ -221,5 +237,5 @@ c. Setting up SquirrelMail
     configuration is stored in plugins/squirrelspell/sqspell_config.php
     Default configuration might not work on your server.
   * administrator
-    plugin must be setup correctly in order to detect administrative user. 
+    plugin must be setup correctly in order to detect administrative user.
     See plugins/administrator/INSTALL