Adding info about translations

[squirrelmail.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 55df47739e7e97ccef4d665bf2d790c8c21ba843..04ca7186e0916492c7d11d432785640f3eacefea 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -9,8 +9,6 @@ Table of Contents:
   5.  (CHARSETS) Russian Charsets
 
 
-
-
 1. CONFIGURE YOUR WEBSERVER TO WORK WITH PHP4
 ---------------------------------------------
 
@@ -20,14 +18,15 @@ Table of Contents:
   to run as CGI under Apache. How you end up doing this is up to you
   (your mileage may vary).
 
-  NOTE: The new plugin architecture required the use of some functions 
-  which are not in all versions of PHP4. You will need at least 
-  PHP4 v4.0.2. If you need to upgrade please go ahead and install the
-  latest release version of PHP4.
+  You will need at least PHP v4.0.6. If you need to upgrade please go
+  ahead and install it now.
 
 a. Obtaining and compiling PHP4
+  
+  SquirrelMail has not been extensively tested for use with PHP 4.3.x.
+  See the ReleaseNotes file.
 
-  Point your favorite webserver at http://www.php.net/version4/ and
+  Point your favorite web browser at http://www.php.net/downloads.php/ and
   download the source. Untar (tar xvfz filename-you-downloaded.tgz)
   the source, cd into the directory and run configure. To make PHP4
   work with SquirrelMail a commandline like this should do:
@@ -58,8 +57,6 @@ b. Changing php.ini
   be sure to change the session.save_path to someplace that can only 
   be read and written to by the webserver.  session.save_path is the
   location that PHP's session data will be written to.
-  
-  Squirrelmail 1.2.x also requires register_globals to be enabled. 
 
   SECURITY WARNING - If a user has access to write PHP scripts on your 
   system and knows the location where PHP stores session data, he 
@@ -67,6 +64,10 @@ b. Changing php.ini
   session's data with his own PHP script.  Caution should be used when 
   setting up permissions and locations of php.ini and the session data.
 
+  FILE UPLOADS - Note that sending attachments will not work if your
+  "file_uploads" setting is "Off". Squirrelmail requires that setting
+  enabled in order to be able to attach files.
+
 c. Setting up .php files to use PHP4
 
   You need to create a .htaccess file in you SquirrelMail directory
@@ -92,12 +93,11 @@ d. Running into trouble
 3. OBTAINING AND INSTALLING SQUIRRELMAIL
 ----------------------------------------
 
-  SquirrelMail is still under development. Therefore you should always
-  get the newest version around. Look at
-  http://www.squirrelmail.org/index.php3?page=5 to see what it
-  is. If you want to be bleeding edge you might want to consider using
-  the latest CVS version (with the latest and most fashionable of
-  bugs).
+  SquirrelMail is constantly being improved. Therefore you should always
+  get the newest version around. Look at http://www.squirrelmail.org/
+  to see what it is. If you want to be bleeding edge you might want to
+  consider using the latest CVS version (with the latest and most
+  fashionable of bugs).
 
 a. Download SquirrelMail
 
@@ -171,7 +171,7 @@ b. Setting up directories
 
 c. Setting up SquirrelMail
 
-  There are two ways to configure Squirrelmail.  In the config/ directory,
+  There are two ways to configure SquirrelMail.  In the config/ directory,
   there is a perl script called conf.pl that will aid you in the
   configuration process.  This is the recommended way of handling
   the config.
@@ -179,6 +179,12 @@ c. Setting up SquirrelMail
   You can also copy the config/config_default.php file to config/config.php
   and edit that manually.
 
+  After you've created a configuration, you can use your webbrowser to
+  browse to http://your-squirrelmail-location/src/configtest.php.
+  This will perform some basic checks on your config to make sure
+  everything works like it should.
+
+
 4. RUNNING SQUIRRELMAIL
 -----------------------
 
@@ -195,3 +201,26 @@ c. Setting up SquirrelMail
 
   For information on how to make SquirrelMail work with Russian
   Apache, see the README.russian_apache in the doc/ subdirectory.
+
+6. TRANSLATIONS
+---------------
+
+  In order to use translated versions of SquirrelMail, you need 
+  to download and install locale packages that contain translations
+  that you want to use with squirrelmail.
+  
+  Locale packages can be downloaded from SquirrelMail SourceForge
+  project page.
+  
+  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.
+  
+  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
+  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.