[squirrelmail.git] / plugins / README.plugins

Plugins
=======

To understand more about plugins, read doc/plugin.txt

For the impatient, here is an extremely brief overview of how to
install plugins.

  1.  Change to the plugins directory.

        $ cd plugins/

  2.  Unarchive the plugin.

        $ tar -zxvf /home/me/myplugin.tar.gz

  3.  Note the directory that the plugin was created into.  For this
      example, we will assume it was put in the directory: myplugin/.

  4.  Go to the config directory and run conf.pl

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

  5.  Choose option 8 and proceed to add the new plugin following
      the instructions there.  Save and exit, and your plugin should
      be in place.
Commit	Line	Data
	1	Plugins
	2	=======
	3
	4	To understand more about plugins, read doc/plugin.txt
	5
	6	For the impatient, here is an extremely brief overview of how to
	7	install plugins.
	8
	9	1. Change to the plugins directory.
	10
	11	$ cd plugins/
	12
	13	2. Unarchive the plugin.
	14
	15	$ tar -zxvf /home/me/myplugin.tar.gz
	16
	17	3. Note the directory that the plugin was created into. For this
	18	example, we will assume it was put in the directory: myplugin/.
	19
	20	4. Go to the config directory and run conf.pl
	21
	22	$ cd ../../config/
	23	$ ./conf.pl
	24
	25	5. Choose option 8 and proceed to add the new plugin following
	26	the instructions there. Save and exit, and your plugin should
	27	be in place.