2006-03-04 [wwp] 2.0.0cvs105
[claws.git] / manual / advanced.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="ch_advanced">
3   <title>Advanced features</title>
4   <section id="adv_actions">
5     <title>Actions</title>
6     <para>
7     Actions allow you to use all the power of the Unix command-line with your emails. You can define various commands, taking parameters such as the current email file, a list of emails, the currently selected text, and so on. In this way, you'll be able to perform various tasks such as editing a raw mail in your text editor, "hide" what you mean using ROT-13, apply patches contained in emails directly, and so on. The only limit is your imagination. You can configure Actions via the Tools menu.
8     </para>
9     <blockquote>
10         <example><title>Simple <quote>Open With...</quote></title>
11                 <variablelist>
12                         <varlistentry><term>Menu name: <emphasis>Open with/kate</emphasis> Command Line: <emphasis>kate %p</emphasis></term>
13                                 <listitem><para>Opens the file of the selected decoded MIME part (<emphasis>%p</emphasis>) with the <emphasis>kate</emphasis> text editor.
14                                     </para></listitem>
15                     </varlistentry>
16                 </variablelist>
17         </example>
18         <example><title>Spam management using <ulink url="http://bogofilter.sourceforge.net/">Bogofilter</ulink></title>
19                 <variablelist>
20                         <varlistentry><term>Menu name: <emphasis>Bogofilter/Mark as Ham</emphasis> Command Line: <emphasis>bogofilter -n -v -B "%f"</emphasis></term>
21                                 <listitem><para>Marks the currently selected mails (<emphasis>%f</emphasis>) as 'not spam' using <emphasis>Bogofilter</emphasis>.
22                                     </para></listitem>
23                     </varlistentry>
24                     <varlistentry><term>Menu name: <emphasis>Bogofilter/Mark as Spam</emphasis> Command Line: <emphasis>bogofilter -s -v -B "%f"</emphasis></term>
25                             <listitem><para>Marks the currently selected mails (<emphasis>%f</emphasis>) as 'spam' using <emphasis>Bogofilter</emphasis>.
26                                     </para></listitem>
27                     </varlistentry>
28                 </variablelist>
29     </example>
30     <example><title>Search Google using an external script</title>
31             <variablelist>
32                     <varlistentry><term>Menu name: <emphasis>Search/Google</emphasis> Command Line: <emphasis>|/path/to/google_search.pl</emphasis></term>
33                             <listitem><para>Searches Google for the currently selected text (<emphasis>|</emphasis>) using the external script <emphasis><ulink url="http://claws.sylpheed.org/tools.php">google_search.pl</ulink></emphasis>.
34                                     </para></listitem>
35                     </varlistentry>
36             </variablelist>
37     </example>
38     </blockquote>
39   </section>
40   <section id="adv_templates">
41     <title>Templates</title>
42     <para>
43     Templates are used in composition windows, and act as a model for emails. Templates can be filled with static text and dynamic parts, such as the original sender's name ("Dear %N, ..."), the date, etc. When applying a template, the dynamic fields will be replaced with the relevant values. You can configure templates via the Tools menu.
44     </para>
45     <para>
46     When applying a template, you will be asked to <quote>Insert</quote> or <quote>Replace</quote>, the difference between replacing and inserting is only concerned with the message body. <quote>Replace</quote> will replace the current composition window message body with the body defined in the template, clearing it if the template body is empty. <quote>Insert</quote> will insert the template's body, if set, at the current cursor position.
47     </para>
48     <para>
49     Whether you choose to Insert or Replace, any To, Cc or Bcc field that is defined in the template will be appended to the compose window's recipients list. If it is defined, the template's Subject will always replace the compose window's Subject.
50     </para>
51     <para>
52     Symbols can be used in all parts of the templates and will be substituted with their respective dynamic value if possible, otherwise no value will be used. This often makes more sense if you apply a template when a replying or forwarding. There is no restriction on which symbols can be used in template parts, even if inserting the body (%M or %Q) may make no sense in common situations.
53     </para>
54     <para>
55     When applying a template, the body is processed first, then the To, Cc, Bcc and Subject fields follow.
56     </para>
57     <para>
58             Further information and examples of usage can be found in the user-contributed FAQ on the Sylpheed-Claws website <ulink url="http://claws.sylpheed.org/faq.php">http://claws.sylpheed.org/faq.php</ulink>
59     </para>
60    </section>
61   <section id="adv_processing">
62     <title>Processing</title>
63     <para>
64     Processing rules are the same as Filtering rules, except that they are applied when entering a folder and apply only to this folder. You can use them to automatically move old mails into an archive folder, or for further dispatching of emails, and more. You can set each folder's Processing rules by right-clicking on it.
65     </para>
66     <para>
67     Processing rules are accompanied by Pre-processing and Post-processing rules. Like Processing rules, they apply only when opening a folder, but like Filtering rules, they are shared accross all folders. You can configure them from the Tools menu. Pre-processing rules are executed before the folder's specific Processing rules, while Post-processing rules are executed afterwards.
68     </para>
69   </section>
70   <section id="adv_plugins">
71     <title>Plugins</title>
72     <para>
73       Plugins are the mechanism for extending Sylpheed-Claws' capabilities. For example, imagine that you want to store your mails in a remote <acronym>SQL</acronym> database. In most mailers out there this is simply impossible without reworking the internals of the mailer. With Sylpheed-Claws you can simply write a plugin to achieve the task.
74     </para>
75     <para>
76             This is just an example of the possibilities. A good number of plugins developed for Sylpheed-Claws already exist, and more are to come. The <link linkend="ch_plugins">Extending Sylpheed-Claws section</link> gives details of them.
77     </para>
78   </section>
79   <section id="adv_hidden">
80     <title>Hidden preferences</title>
81     <para>
82     There are a number of hidden preferences in Sylpheed-Claws, preferences that some users who we wanted to please couldn't live without, but which did not have a place in the GUI in our opinion. You can find the following, and change them while Sylpheed-Claws is not running in ~/.sylpheed-claws/sylpheedrc.
83     </para>
84     <variablelist>
85             <varlistentry><term>bold_unread</term>
86                     <listitem><para>show unread messages using bold font in summary view</para></listitem>
87             </varlistentry>
88             <varlistentry><term>cache_max_mem_usage</term>
89                     <listitem><para>the maximum amount of memory to use to cache messages, in kB.</para></listitem>
90             </varlistentry>
91             <varlistentry><term>cache_min_keep_time</term>
92                     <listitem><para>the minimum time to keep a cache in memory, in minutes. Caches more recent than this time will not be freed, even if the memory usage is too high.</para></listitem>
93             </varlistentry>
94             <varlistentry><term>enable_hscrollbar</term>
95                     <listitem><para>enables horizontal scrollbar in summaryview</para></listitem>
96             </varlistentry>
97             <varlistentry><term>enable_rules_hint</term>
98                     <listitem><para>enable alternate lines in GtkTreeViews</para></listitem>
99             </varlistentry>
100             <varlistentry><term>enable_swap_from</term>
101                     <listitem><para>display sender's email address in To column in Sent folder instead of recipient's</para></listitem>
102             </varlistentry>
103             <varlistentry><term>folderview_vscrollbar_policy</term>
104                     <listitem><para>specify the policy of vertical scroll bar of folder view</para></listitem>
105             </varlistentry>
106             <varlistentry><term>hover_timeout</term>
107                     <listitem><para>time in milliseconds that will cause a folder tree to expand during drag 'n' drop when the mouse cover is held over it</para></listitem>
108             </varlistentry>
109             <varlistentry><term>statusbar_update_step</term>
110                     <listitem><para>update stepping in progress bars</para></listitem>
111             </varlistentry>
112             <varlistentry><term>textview_cursor_visible</term>
113                     <listitem><para>display the cursor in the message view</para></listitem>
114             </varlistentry>
115             <varlistentry><term>thread_by_subject_max_age</term>
116                     <listitem><para>number of days to include a message in a thread when using 'Thread using subject in addition to standard headers'</para></listitem>
117             </varlistentry>
118             <varlistentry><term>toolbar_detachable</term>
119                     <listitem><para>hide handles in the toolbars</para></listitem>
120             </varlistentry>
121             <varlistentry><term>utf8_instead_of_locale_for_broken_mail</term>
122                     <listitem><para>use UTF-8 encoding for broken mails instead of current locale</para></listitem>
123             </varlistentry>
124             <varlistentry><term>warn_dnd</term>
125                     <listitem><para>display a confirmation dialog on drag 'n' drop of folders</para></listitem>
126             </varlistentry>
127     </variablelist>
128   </section>
129 </section>