Revise plugin documentation. Mainly, this removes remains of documentation
[squirrelmail.git] / plugins / squirrelspell / INSTALL
index 808dec0..1ac0c51 100644 (file)
@@ -1,17 +1,24 @@
-SquirrelSpell-v0.3.1
----------------------
+SquirrelSpell plugin
+--------------------
 
-Untar SquirrelSpell into your squirrelmail/plugins directory. Modify the 
-sqspell_config.php file making sure you have ispell or aspell
+Modify the sqspell_config.php file making sure you have ispell or aspell
 available on your system and located in PHP's path. The squirrelspell
 doesn't check for that and if it is not available, you're just going to
-get a "No errors found"  message every time. :) Quite pleasing, but not
+get a "No errors found" message every time. :) Quite pleasing, but not
 very useful.
 
 Read files in "doc" directory -- they explain some features.
 
 Enable the plugin either by hand or by running the configure script from
-your squirrelmail install directory.
+your SquirrelMail install directory.
+
+NOTE: If you are using php >= 4.3.0 squirrelspell should work in safe mode.
+Otherwise, you may have to disable safe mode for the squirrelspell directory.
+   APACHE CONF EXAMPLE:
+        <Directory /webroot/squirrelmail/plugins/squirrelspell>
+                php_admin_value safe_mode 0
+        </Directory>
+
 
 Enjoy and report bugs. ;)
 
@@ -22,7 +29,7 @@ This is an options commented sqspell_config.php
    /**
     **  sqspell_config.php -- SquirrelSpell Configuration file.
     **
-    **  Copyright (c) 1999-2000 The SquirrelMail development team
+    **  Copyright (c) 1999-2000 The SquirrelMail Project Team
     **  Licensed under the GNU GPL. For full terms see the file COPYING.
     **
     **
@@ -54,11 +61,11 @@ This is an options commented sqspell_config.php
        configure the array to look something like this:
 
        $SQSPELL_APP = array(
-                       "English" => "aspell -a",
+                            "English" => "aspell -a",
                             "Russian" => "ispell -d russian -a",
-                       ...
-                       "Swahili" => "ispell -d swahili -a"
-                      );
+                            ...
+                            "Swahili" => "ispell -d swahili -a"
+                           );
 
        Watch the commas, making sure there isn't one after your last
        dictionary declaration. Also, make sure all these dictionaries
@@ -113,4 +120,4 @@ This is an options commented sqspell_config.php
                     Adding until resolved.
     **/
     $SQSPELL_SOUP_NAZI = 'Mozilla/3, Mozilla/2, Opera 4, Opera/4, Macintosh';
-?>    
\ No newline at end of file
+?>