vCalendar plugin: use external libical
[claws.git] / manual / plugins.xml
index 9d89e00770d8aadfc95036642ce562441822278a..6cb2629ae15374d309caf05b68857d40082db821 100644 (file)
          </para><para>
        Bogofilter's advantage over Spamassassin is its speed.
          </para><para>
+       Bogofilter must be trained before it can filter messages. To train
+       it you will need to mark some spam as Spam, and some legitimate 
+       emails as Ham.
+         </para><para>
        Bogofilter is available from <ulink
        url="http://bogofilter.sourceforge.net/"
        >http://bogofilter.sourceforge.net/</ulink>.
        <term>Fancy</term>
        <listitem>
          <para>
-       Enables the display of HTML messages using the GTK+ port of the
-       WebKit library.
+       Enables the rendering of HTML messages using the GTK+ port of the
+       WebKit library. By default, no remote content is loaded.
+         </para><para>
+       Plugin preferences can be found in 
+       <quote>Configuration/Preferences/Plugins/Fancy</quote>.
          </para>
        </listitem>
       </varlistentry>
          </para>
        </listitem>
       </varlistentry>
-      <varlistentry>
-       <term>GeoLocation</term>
-       <listitem>
-         <para>
-       Provides geolocation functionality based on the addresses contained
-       in the messages.
-         </para>
-       </listitem>
-      </varlistentry>
       <varlistentry>
        <term>Libravatar</term>
        <listitem>
          <para>
-       Enables displaying avatar images associated to user profiles in
-       libravatar.org or user's avatar enabled domains.
+       Enables the display of avatar images associated with user profiles at
+       libravatar.org or the user's avatar enabled domains.
        More information: <ulink
        url="http://www.claws-mail.org/plugin.php?plugin=libravatar"
        >www.claws-mail.org/plugin.php?plugin=libravatar</ulink>
        <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. 
+       Writes a message header summary to a log file, (Default:
+       <filename>~/Mail/NewLog</filename>), on arrival of new mail
+       <emphasis>after</emphasis> sorting.
          </para>
        </listitem>
       </varlistentry>
        <term>TNEF parse</term>
        <listitem>
          <para>
-       This plugin enables reading <literal>application/ms-tnef attachments</literal>.
+       This plugin enables reading <literal>application/ms-tnef</literal> attachments.
        More information: <ulink
        url="http://www.claws-mail.org/plugin.php?plugin=tnef_parser"
        >www.claws-mail.org/plugin.php?plugin=tnef_parser</ulink>
        If you're a developer, writing a plugin to extend Claws Mail's
        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</literal> on Freenode or IRCnet.
+       in the mailing-list or on the IRC channel,
+       <literal>#claws</literal> on Freenode.
     </para>
   </section>
 
   <section id="plugins_network">
     <title>Network access from the plugins</title>
     <para>
-       Some of the external plugins, for example RSSyl, vCalendar or GtkHtml 
-       Viewer, need Internet access for their operations (retrieving feeds in 
-       the case of RSSyl or vCalendar, and fetching images in the case of 
-       GtkHtml Viewer). These plugins use the Curl library. Hence, if your 
+       Some of the external plugins, for example RSSyl, vCalendar, Libravatar
+       or Fancy, need Internet access for their operations (retrieving feeds in
+       the case of RSSyl or vCalendar, and fetching images in the case of
+       Libravatar or Fancy). These plugins use the Curl library. Hence, if your
        Internet access is restricted by a proxy, you will need to tell libCurl
-       to use this proxy. This is done by setting an environment variable, 
+       to use this proxy. This is done by setting an environment variable,
        <literal>http_proxy</literal>. For example, 
-<literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal> 
-       will tell libCurl to connect to port 8080 of the machine 
-       myproxy.example.com, with the user <quote>user</quote> and password 
-       <quote>passwd</quote> to connect to the Internet. 
+       <literal>http_proxy=http://user:passwd@myproxy.example.com:8080</literal>
+       will tell libCurl to connect to port 8080 of the machine
+       myproxy.example.com, with the user <quote>user</quote> and password
+       <quote>passwd</quote> to connect to the Internet.
     </para><para>
-       You can either set this variable before starting Claws Mail, by 
-       using for example 
-       <command>http_proxy=http://user:passwd@myproxy.example.com:8080 
-       claws-mail</command>, or set it in your 
-       <filename>~/.bashrc</filename> file (or your shell equivalent), by 
-       adding the following line<footnote><para>Other shells may have 
-       diferent syntaxes, check your shell's manual page.</para></footnote>: 
-<command>export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
+       You can either set this variable before starting Claws Mail by
+       using, for example,
+       <command>http_proxy=http://user:passwd@myproxy.example.com:8080
+       claws-mail</command>, or you can set it in your
+       <filename>~/.bashrc</filename> file (or your shell equivalent), by
+       adding the following line<footnote><para>Other shells may have
+       diferent syntaxes, check your shell's manual page.</para></footnote>:
+       <command
+       >export http_proxy=http://user:passwd@myproxy.example.com:8080</command>
        (you'll have to reconnect to have it taken into account).
     </para>
   </section>
 
+  <section id="plugin_path_config">
+    <title>Plugin path configuration</title>
+    <para>
+    By default, when loading a plugin, its full path is saved in
+    <filename>~/.claws-mail/clawsrc</filename>.
+    </para><para>
+    As most users have only one copy of Claws Mail installed and always
+    use the same installation method, this is not a problem.
+    </para><para>
+    However, if you have multiple copies of Claws Mail installed
+    and want to share the same configuration among them, this may not
+    work, particularly when using different versions of Claws Mail.
+    </para><para>
+    A second installed copy will try to load the plugins installed by
+    the first and, if the versions differ, the plugins will be rejected.
+    </para><para>
+    In order to avoid this problem you can manually edit the plugins
+    section in the <filename>clawsrc</filename> file, replacing the full
+    path with just the plugin file name of those you want to load
+    relative to the copy of Claws Mail being run.
+    </para><para>
+    In so doing, each copy of Claws Mail will try to load those plugins
+    from its own plugin directory, rather than a fixed location.
+    </para>
+  </section>
+
 </section>