plugins/README.plugins

   1 Plugins
   2 =======
   3
   4 To understand more about plugins, read:
   5
   6   http://squirrelmail.org/docs/admin/admin-7.html#ss7.1
   7   http://squirrelmail.org/docs/devel/devel-4.html
   8
   9
  10 For the impatient, here is an extremely brief overview of how to
  11 install plugins.
  12
  13   1.  Change to the plugins directory.
  14
  15         $ cd plugins/
  16
  17   2.  Unarchive the plugin.
  18
  19         $ tar -zxvf /home/me/myplugin.tar.gz
  20
  21   3.  Note the directory that the plugin was created into.  For this
  22       example, we will assume it was put in the directory: myplugin/.
  23
  24   4.  Read the README, INSTALL or other documentation in your new plugin.
  25       Follow any important configuration instructions inside (about half
  26       the time there are none, sometimes they are extensive).
  27
  28         $ cd myplugin/
  29         $ more README
  30
  31   5.  Go to the config directory and run conf.pl
  32
  33         $ cd ../../config/
  34         $ ./conf.pl
  35
  36   6.  Choose option 8 and proceed to add the new plugin following
  37       the instructions there (move the desired plugin from the "Available
  38       Plugins" category to the "Installed Plugins" category by entering
  39       its number).  Save and exit, and your plugin should be in place.
  40
  41 The following plugins are "core" plugins; that is, plugins shipped with
  42 the SquirrelMail distribution.  Unless you are a developer and know what
  43 you are doing, you should not replace these plugins with other versions.
  44
  45 - abook_take
  46 - administrator
  47 - bug_report
  48 - calendar
  49 - change_password
  50 - filters
  51 - fortune
  52 - info
  53 - listcommands
  54 - mail_fetch
  55 - message_details
  56 - newmail
  57 - plist
  58 - sent_subfolders
  59 - spamcop
  60 - squirrelspell
  61 - translate