Installing The Reset User Preferences Plugin
============================================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 1.0 version of the Reset User
   Preferences plugin.

  $ cd plugins
  $ tar -zxvf reset_prefs-1.0-1.4.9.tar.gz

2) If you do not want to change the default behavior of this
   plugin, skip to step four.

3) (OPTIONAL) Decide if you want to store the plugin
   configuration file in the plugin directory or in
   the main SquirrelMail config directory.

   A) To store the configuration file in the plugin directory,
      change into the reset_prefs directory, copy
      config_example.php to config.php and edit config.php,
      making adjustments as you deem necessary.

     ----- optional -----
     $ cd reset_prefs
     $ cp config_example.php config.php
     $ vi config.php
     ----- optional -----

   B) To store the configuration file in the main SquirrelMail
      config directory, change into the reset_prefs directory,
      copy config_example.php to ../../config/config_reset_prefs.php
      and edit ../../config/config_reset_prefs.php, making
      adjustments as you deem necessary.

     ----- optional -----
     $ cd reset_prefs
     $ cp config_example.php ../../config/config_reset_prefs.php
     $ vi ../../config/config_reset_prefs.php
     ----- optional -----

4) If you are running SquirrelMail 1.4.16 or above, skip to step six.

5) Patch the SquirrelMail source code to add the needed code
   for this plugin.

   If using SquirrelMail 1.4.14 or lower, first you must
   apply the patch that comes with the Address Book Grouping
   and Pagination plugin.  The patch that comes with the
   Reset User Preferences plugin only works with SquirrelMail
   1.4.15 otherwise.  The Address Book Grouping and Pagination
   patch will update parts of older SquirrelMail versions to 
   the 1.4.15 level.

   The Reset User Preferences patch should be run from the
   reset_prefs directory.  Make sure to use the patch that
   corresponds closest to your SquirrelMail version.

  $ patch -p0 < patches/reset_prefs_squirrelmail-1.4.15.diff

   Note for Windows users: you can get native patch functionality
   by installing this very useful package:
   http://unxutils.sourceforge.net/

6) Then go to your config directory and run conf.pl.  Choose
   option 8 and move the plugin from the "Available Plugins"
   category to the "Installed Plugins" category.  Save and exit.

  $ cd ../../config/
  $ ./conf.pl

7) Also, if not being used with SquirrelMail 1.4.10+ or 1.5.2+,
   please verify that you have the "Compatibility" plugin
   installed (but not necessarily activated).

8) Translations are not included in this package.  To get a
   translation, download the language pack needed from:

      http://www.squirrelmail.org/download.php



Upgrading Reset User Preferences
================================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 1.0 version of the Reset User
   Preferences plugin.

  $ cd plugins
  $ tar -zxvf reset_prefs-1.0-1.4.9.tar.gz

2) Change into the reset_prefs directory and check your
   config.php file against the new version to see if
   there are any new settings that you must add to your
   config.php file.

  $ diff -u config.php config_example.php

   If you store your configuration file in the main SquirrelMail
   config directory, adjust this command as follows:

  $ diff -u ../../config/config_reset_prefs.php config_example.php

   Or simply replace your configuration file with the provided
   example and reconfigure the plugin from scratch (see step three
   under the installation procedure above).


