2012-07-03 [mir] 3.8.1cvs2
[claws.git] / manual / advanced.xml
index 1da53701afdafd06464554368a6db4929b375c74..27a2b7a4553a46160ed4133a594ca9fc04be6402 100644 (file)
        such as editing a raw mail in your text editor, 
        <emphasis>hide</emphasis> 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 <quote>Tools</quote> 
-       menu.
+       imagination. You can create and configure Actions via the
+       <quote>/Configuration/Actions...</quote> menu.
+    </para>
+    <para>
+        The <quote>Tools/Actions/</quote> menu will contain one submenu
+       item for each action that you have created. When you have selected
+       one or more messages in the Message List, or are viewing a message
+       in the Message View, selecting one of these menu items will invoke
+       the action, and, depending on how it was defined, will pass the
+       message(s) to it.
+    </para>
+    <para>
+        Additionally, it is possible to add toolbar entries for your
+        actions. To do so, open the <quote>Configuration/Preferences</quote>
+        menu and select <quote>Toolbars/Main Window</quote>.
+       Select <quote>User Action</quote> in the <quote>Item type</quote>
+       dropdown menu, then select the Action in the <quote>Event executed on click</quote>
+       dropdown menu, and click the <quote>Icon</quote> button to select the
+       icon that you want to use.
     </para>
     <blockquote>
       <example>
     <title>Processing</title>
     <para>
        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.
+       applied when entering a folder or when manually applied from a folder's
+       context menu 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.
     </para><para>
        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 across all folders. You can 
-       configure them from the <quote>Tools</quote> menu. Pre-processing rules
-       are executed before the folder's specific Processing rules, while 
-       Post-processing rules are executed afterwards.
+       rules. Like Processing rules, they apply when opening a folder or manually
+       applying them from a folder's context menu, but like Filtering rules,
+       they are shared across all folders. You can configure them from the
+       <quote>Tools</quote> menu. Pre-processing rules are executed before the
+       folder's specific Processing rules, while Post-processing rules are executed
+       afterwards.
     </para>
   </section>
   <section id="adv_colour_labels">
        <quote>Configuration/Preferences/Display/Colors</quote> page.
     </para>
   </section>
+  <section id="adv_tags">
+    <title>Tags</title>
+    <para>
+       Tags are short text notes which may be set on messages. They are useful
+       for classifying messages with your own words. These tags can be used
+       later to find the mails with Quick Search or to manage them with
+       filtering or processing rules, for example.
+    </para><para>
+       Tagged messages are displayed with a yellow background at the top of
+       the Message View. This line shows all tags associated with the
+       message. You can enable the "Tags" column in the Message List, so
+       tagged items can be seen without having to open the message.
+    </para><para>
+       Setting of tags is done by right-clicking on the message in the Message
+       List or by the corresponding option in Message menu. A panel with the
+       existing tags is shown and you can select some of them or just add a
+       new one. Removal of existing tags is also allowed, of course.
+    </para><para>
+       Once tags exist it's even easier, as the context menu allows you to
+       set and unset tags with just one click to the selected messages.
+       Mixed selections of tagged and untagged messages are allowed, and
+       Claws Mail is clever enough to do what you want to do in any case.
+    </para>
+  </section>
   <section id="adv_ml_support">
     <title>Mailing-List support</title>
     <para>
        following, and change them while Claws Mail is not running, in 
        <filename>~/.claws-mail/clawsrc</filename>.
     </para>
+    <para>
+       There's a small tool written in Perl-GTK called Clawsker which 
+       provides a user-friendly GUI for tweaking these settings instead of
+       direct editing of <filename>clawsrc</filename>. You can read more
+       about it on the <ulink url="http://www.claws-mail.org/clawsker">Clawsker
+       page</ulink>.
+    </para>
     <variablelist>
       <varlistentry>
        <term><literal>addressbook_use_editaddress_dialog</literal></term>
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><literal>emphasis_color</literal></term>
+       <listitem>
+         <para>
+       The colour used for the X-Mailer line when its value is Claws Mail.
+         </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><literal>enable_dotted_lines</literal></term>
        <listitem>
        <term><literal>log_msg_color</literal></term>
        <term><literal>log_out_color</literal></term>
        <term><literal>log_warn_color</literal></term>
+       <term><literal>log_status_ok_color</literal></term>
+       <term><literal>log_status_nok_color</literal></term>
+       <term><literal>log_status_skip_color</literal></term>
        <listitem>
          <para>
        The colours used in the log window.
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><literal>msgview_date_format</literal></term>
+       <listitem>
+         <para>
+       0 or 1. Use the same user-defined date format in the Message
+       View as is used in the Message List. Default is 0, turned off.
+         </para>
+       </listitem>
+      </varlistentry>      
+      <varlistentry>
+       <term><literal>outgoing_fallback_to_ascii</literal></term>
+       <listitem>
+         <para>
+       0 or 1. The outgoing encoding of a message will use 7bit US-ASCII
+       whenever it is suitable for the message content, ignoring the
+       <quote>Outgoing encoding</quote> option unless it is necessary. Turning
+       this option off forces the user-defined encoding to be used, regardless
+       of message content. Default is 1, turned on.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><literal>primary_paste_unselects</literal></term>
+       <listitem>
+         <para>
+       0 or 1. Causes the primary buffer to be cleared and the insertion
+       point to be repositioned when the middle mouse button is used
+       for pasting text. Default is 0, turned off.
+         </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><literal>respect_flowed_format</literal></term>
        <listitem>
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><literal>save_parts_readwrite</literal></term>
+       <listitem>
+         <para>
+       Saves temporary files when opening attachment with write bit set.
+         </para>
+       </listitem>
+      </varlistentry>
+       <varlistentry>
+       <term><literal>show_compose_margin</literal></term>
+       <listitem>
+         <para>
+       0 or 1. Adds margins to the message text area in the Compose window.
+       Default is 0, turned off.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><literal>show_inline_attachments</literal></term>
+       <listitem>
+         <para>
+       0 or 1. Show inline attachments in MimeView.
+       Default is 1, turned on.
+         </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><literal>skip_ssl_cert_check</literal></term>
        <listitem>
        </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><literal>summary_from_show</literal></term>
+       <listitem>
+       <para>
+       Controls the data displayed in the From column in the Message List.
+       Default value 0 displays name, 1 displays address and 2 displays both
+       name and address. 
+       </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><literal>textview_cursor_visible</literal></term>
        <listitem>
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><literal>two_line_vertical</literal></term>
+       <listitem>
+         <para>
+       Spread message list information over two lines when using the
+       three column layout.
+         </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><literal>unsafe_ssl_certs</literal></term>
        <listitem>
        </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><literal>use_networkmanager</literal></term>
+       <listitem>
+       <para>
+       Use NetworkManager to switch offline automatically. This is enabled
+       by default.
+       </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><literal>use_stripes_everywhere</literal></term>
        <listitem>
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><literal>zero_replacement_char</literal></term>
+       <listitem>
+         <para>
+       Character to show in Folder List counter columns when a folder contains
+       no messages. Default value is 0.
+         </para>
+       </listitem>
+      </varlistentry>
     </variablelist>
   </section>
+  <section id="adv_autofaces">
+    <title>Autofaces</title>
+    <para>
+       Claws Mail allows setting the Face and X-Face headers directly
+       from files, either globally for all defined accounts 
+       or on a per-account basis. These files must be placed in the
+       <filename>~/.claws-mail/autofaces/</filename> directory.
+    </para>
+    <para>
+       If they exist, the global Face and/or X-Face headers for all
+       accounts are taken from the <filename>face</filename> and/or
+       <filename>xface</filename> files respectively. In a similar
+       manner, Face and/or X-Face headers for a specific account can
+       be provided by <filename>face.</filename><emphasis>accountname</emphasis>
+       and/or <filename>xface.</filename><emphasis>accountname</emphasis>,
+       where <emphasis>accountname</emphasis> is the name of the account you 
+       want this header to be associated with.
+   </para>
+   <para>
+       If the name of the account contains characters which may be unsuitable 
+       for the underlying filesystem (including spaces) these are replaced by 
+       underscores (<quote>_</quote>) when searching for the autofaces of 
+       that account. For example, if your account is called 
+       <quote>&lt;My Mail&gt;</quote>, the name for the X-Face filename for
+       that account would be
+       <filename>~/.claws-mail/autofaces/xface._My_Mail_</filename>.
+       Be aware that this feature doesn't check the content of the files,
+       or for duplication of headers, (most mailers, including Claws 
+       Mail, will ignore duplicates and display the last one only). 
+    </para>
+  </section>
 </section>