projects / claws.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
2011-08-12 [wwp] 3.7.9cvs44
[claws.git] / manual / plugins.xml
diff --git a/manual/plugins.xml b/manual/plugins.xml
index 15ef6e33525e3a649a75fd39512b8697ad96230f..585fba2370fa79b01016e8cdc0e8e1345ed054c6 100644 (file)
--- a/manual/plugins.xml
+++ b/manual/plugins.xml
@@ -19,6 +19,11 @@
        If you don't find the plugin you're looking for, it is possible that 
        your Operating System distribution provides it in a separate package. 
        In this case, search for the plugin in your package manager.
        If you don't find the plugin you're looking for, it is possible that 
        your Operating System distribution provides it in a separate package. 
        In this case, search for the plugin in your package manager.
+    </para><para>
+       Some plugins provide the same functionality as others, (for example, the 
+       three HTML message viewers). In this case you will have to choose which 
+       one to load, as Claws Mail will refuse to load more than one of
+       the same type.
     </para>
     <variablelist>
       <varlistentry>
     </para>
     <variablelist>
       <varlistentry>
@@ -36,7 +41,7 @@
        You can train Bogofilter by marking messages as spam or ham from the 
        Message List contextual menu, or using the relevant toolbar button in 
        the main window or the message window (see 
        You can train Bogofilter by marking messages as spam or ham from the 
        Message List contextual menu, or using the relevant toolbar button in 
        the main window or the message window (see 
-       <quote>Configuration/Preferences/Customize toolbars</quote>). Messages 
+       <quote>Configuration/Preferences/Toolbars</quote>). Messages 
        marked as spam are optionally saved to a designated folder.
          </para><para>
        Plugin preferences can be found in 
        marked as spam are optionally saved to a designated folder.
          </para><para>
        Plugin preferences can be found in 
@@ -50,21 +55,6 @@
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
-      <varlistentry>
-        <term>Clam Antivirus</term>
-       <listitem>
-         <para>
-       Enables the scanning of message attachments in mail received from a 
-       POP, IMAP or LOCAL account using Clam AntiVirus. It can optionally 
-       delete the mail or save it to a designated folder. Preferences can be 
-       found in 
-       <quote>Configuration/Preferences/Plugins/Clam AntiVirus</quote>. 
-       Clam AntiVirus is available from <ulink 
-       url="http://clamav.sourceforge.net/"
-       >http://clamav.sourceforge.net/</ulink>.
-         </para>
-       </listitem>
-      </varlistentry>
       <varlistentry>
        <term>Dillo HTML Viewer</term>
        <listitem>
       <varlistentry>
        <term>Dillo HTML Viewer</term>
        <listitem>
@@ -89,6 +79,17 @@
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term>S/MIME</term>
+       <listitem>
+         <para>
+       Handles S/MIME signed and/or encrypted mails. You can decrypt mails, 
+       verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME 
+       and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
+       >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
+         </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term>SpamAssassin</term>
        <listitem>
       <varlistentry>
        <term>SpamAssassin</term>
        <listitem>
@@ -104,7 +105,7 @@
        You can train SpamAssassin by marking messages as spam or ham from the 
        Message List contextual menu, or using the relevant toolbar button in 
        the main window or the message window (see 
        You can train SpamAssassin by marking messages as spam or ham from the 
        Message List contextual menu, or using the relevant toolbar button in 
        the main window or the message window (see 
-       <quote>Configuration/Preferences/Customize toolbars</quote>). Messages 
+       <quote>Configuration/Preferences/Toolbars</quote>). Messages 
        marked as spam are optionally saved to a designated folder.
          </para><para>
        Plugin preferences can be found in 
        marked as spam are optionally saved to a designated folder.
          </para><para>
        Plugin preferences can be found in 
@@ -149,6 +150,8 @@
          <para>
        Enables new mail notification via the LEDs found on some laptops like 
        Acer, Asus, Fujitsu and IBM laptops.
          <para>
        Enables new mail notification via the LEDs found on some laptops like 
        Acer, Asus, Fujitsu and IBM laptops.
+       More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=acpinotifier">
+       www.claws-mail.org/plugin.php?plugin=acpinotifier</ulink>
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
@@ -159,6 +162,8 @@
        Reminds you about possibly forgotten attachments. Checks for common
        expressions found when attaching a file and warns you if no attachment
        was added to the mail you're sending.
        Reminds you about possibly forgotten attachments. Checks for common
        expressions found when attaching a file and warns you if no attachment
        was added to the mail you're sending.
+       More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=attachwarner">
+       www.claws-mail.org/plugin.php?plugin=attachwarner</ulink>
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
@@ -166,7 +171,23 @@
        <term>AttRemover</term>
        <listitem>
          <para> 
        <term>AttRemover</term>
        <listitem>
          <para> 
-       This plugin lets you remove attachments from emails.
+       Allows you to remove attachments from emails.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term>BSFilter</term>
+       <listitem>
+         <para> 
+       BSFilter is a plugin that is very similar to the Bogofilter plugin but uses
+       the bsfilter (<ulink url="http://bsfilter.org/index-e.html">bsfilter.org/index-e.html</ulink>)
+       bayesian spam filter as a backend. 
+         </para><para>
+       Like Bogofilter, you have to train it with spam and ham
+       messages in order for bsfilter to start recognising spam.
+         </para><para>
+       Plugin preferences can be found in 
+       <quote>Configuration/Preferences/Plugins/BSFilter</quote>.
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
@@ -176,18 +197,17 @@
          <para>
        Saves the caches every 60 seconds (or user-defined period). It helps 
        avoiding the loss of metadata if your computer (<emphasis>or 
          <para>
        Saves the caches every 60 seconds (or user-defined period). It helps 
        avoiding the loss of metadata if your computer (<emphasis>or 
-       Claws Mail!</emphasis>) crashes.
+       Claws Mail!</emphasis>) crashes. (NOTE: using this plugin can slow
+       down Claws Mail.)
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>etpan! Privacy</term>
+       <term>Fancy</term>
        <listitem>
          <para>
        <listitem>
          <para>
-       Handles signature verification and decryption of encrypted messages in 
-       S/MIME, OpenPGP and ascii-armored PGP formats. Doesn't handle 
-       passphrases. The development of this plugin has been discontinued
-       because its functions are avaliable in the PGP plugins. 
+       Enables the display of HTML messages using the GTK+ port of the
+       WebKit library.
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
@@ -201,22 +221,22 @@
        </listitem>
       </varlistentry>
       <varlistentry>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>GtkHtml Viewer</term>
+       <term>GtkHtml2 Viewer</term>
        <listitem>
          <para>
        Like Dillo, enables the viewing of HTML messages, but in a nicer way 
        (antialiased fonts).
        <listitem>
          <para>
        Like Dillo, enables the viewing of HTML messages, but in a nicer way 
        (antialiased fonts).
+       More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=gtkhtml2">
+       www.claws-mail.org/plugin.php?plugin=gtkhtml2</ulink>
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>Maildir</term>
+       <term>Mail Archiver</term>
        <listitem>
          <para>
        <listitem>
          <para>
-       Provides direct support for Maildir++ mailboxes. With this plugin you 
-       can share your Maildir++ mailbox with other mailers or IMAP servers.
-       The development of this plugin has been discontinued. If you're
-       a developer and want to adopt it then don't hesitate to contact us.
+       Enables folders and subfolders to be archived in several different
+       formats.
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
@@ -228,6 +248,26 @@
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term>NewMail</term>
+       <listitem>
+         <para>
+       Writes a msg header summary to a log file, (Default: 
+       <filename>~/Mail/NewLog</filename>), on arrival of new mail 
+       <emphasis>after</emphasis> sorting. 
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term>Notification</term>
+       <listitem>
+         <para>
+       Provides various ways to notify the user of new and unread email.
+       More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=notification">
+       www.claws-mail.org/plugin.php?plugin=notification</ulink>
+         </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term>Perl</term>
        <listitem>
       <varlistentry>
        <term>Perl</term>
        <listitem>
@@ -239,23 +279,36 @@
        </listitem>
       </varlistentry>
       <varlistentry>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>PDF Viewer</term>
+       <term>Python</term>
        <listitem>
          <para>
        <listitem>
          <para>
-       This plugin provides direct rendering of PDF and PostScript attachments
-       in the Claws Mail message view. It also allows browsing, zooming and 
-       displaying detailed information about such attachments.
+       This plugin provides Python integration features.
+       More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=python">
+       www.claws-mail.org/plugin.php?plugin=python</ulink>
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>S/MIME</term>
+       <term>RSSyl</term>
        <listitem>
          <para>
        <listitem>
          <para>
-       Handles S/MIME signed and/or encrypted mails. You can decrypt mails, 
-       verify signatures or sign and encrypt your own mails. Uses GnuPG/GPGME 
-       and GpgSM, <ulink url="ftp://ftp.gnupg.org/gcrypt/gpgme/"
-       >ftp://ftp.gnupg.org/gcrypt/gpgme/</ulink>.
+       Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and 
+       Atom feeds are currently supported.
+       More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=rssyl">
+       www.claws-mail.org/plugin.php?plugin=rssyl</ulink>
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term>SpamReport</term>
+       <listitem>
+         <para>
+       This plugin reports spam to various places.
+       Currently the sites <ulink url="http://spam-signal.fr"
+       >spam-signal.fr</ulink> and <ulink url="http://spamcop.net"
+       >spamcop.net</ulink> are supported, and the <ulink
+       url="http://lists.debian.org">Debian lists (lists.debian.org)</ulink>
+       spam nomination system.
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
@@ -270,20 +323,23 @@
        </listitem>
       </varlistentry>
       <varlistentry>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>vCalendar</term>
+       <term>TNEF parse</term>
        <listitem>
          <para>
        <listitem>
          <para>
-       Enables vCalendar message handling like that produced by Evolution or 
-       Outlook, and Webcal subscriptions.
+       This plugin enables reading <literal>application/ms-tnef attachments</literal>.
+       More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=tnef_parser">
+       www.claws-mail.org/plugin.php?plugin=tnef_parser</ulink>
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term>RSSyl</term>
+       <term>vCalendar</term>
        <listitem>
          <para>
        <listitem>
          <para>
-       Allows you to read your favorite newsfeeds in Claws. RSS 1.0, 2.0 and 
-       Atom feeds are currently supported.
+       Enables vCalendar message handling like that produced by Evolution or 
+       Outlook, and Webcal subscriptions.
+       More information: <ulink url="http://www.claws-mail.org/plugin.php?plugin=vcalendar">
+       www.claws-mail.org/plugin.php?plugin=vcalendar</ulink>
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
@@ -293,7 +349,7 @@
        capabilities is probably the best and easiest solution. We will 
        provide hosting to your code, and will be glad to answer your questions
        in the mailing-list or on the IRC channels, 
        capabilities is probably the best and easiest solution. We will 
        provide hosting to your code, and will be glad to answer your questions
        in the mailing-list or on the IRC channels, 
-       <literal>#claws-mail</literal> on Freenode or IRCnet.
+       <literal>#claws</literal> on Freenode or IRCnet.
     </para>
   </section>
   <section id="plugins_network">
     </para>
   </section>
   <section id="plugins_network">
Claws Mail