2008-06-21 [paul] 3.4.0cvs101
[claws.git] / manual / advanced.xml
index 489e6a9ad8739f09961aa4154120c364adb9b6b0..d0018cbbbbd504b99dab4d6c077d39caff766703 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>Customize 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>
@@ -76,7 +93,7 @@
              <para>
        Searches Google for the currently selected text 
        (<emphasis>|</emphasis>) using the external script <emphasis><ulink 
-       url="http://www.sylpheed-claws.net/tools.php"
+       url="http://www.claws-mail.org/tools.php"
        >google_search.pl</ulink></emphasis>.
              </para>
            </listitem>
        Bcc and Subject fields follow.
     </para><para>
        Further information and examples of usage can be found in the 
-       user-contributed FAQ on the Sylpheed-Claws website <ulink 
-       url="http://www.sylpheed-claws.net/faq/"
-       >http://www.sylpheed-claws.net/faq/</ulink>.
+       user-contributed FAQ on the Claws Mail website <ulink 
+       url="http://www.claws-mail.org/faq/"
+       >http://www.claws-mail.org/faq/</ulink>.
     </para>
    </section>
   <section id="adv_processing">
     <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 accross 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">
   <section id="adv_ml_support">
     <title>Mailing-List support</title>
     <para>
-       Sylpheed-Claws offers mailing-list support from the 
+       Claws Mail offers mailing-list support from the 
        <quote>Message/Mailing-List/</quote> submenu. When you have a 
        mailing-list message selected, the submenu allows you to quickly 
        initiate subscribing, unsubscribing, posting, getting help, contacting 
   <section id="adv_plugins">
     <title>Plugins</title>
     <para>
-       Plugins are the mechanism for extending Sylpheed-Claws' capabilities. 
+       Plugins are the mechanism for extending Claws Mail' 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.
+       Claws Mail you can simply write a plugin to achieve the task.
     </para><para>
        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> 
+       developed for Claws Mail already exist, and more are to come. The 
+       <link linkend="ch_plugins">Extending Claws Mail section</link> 
        gives details of them.
     </para>
   </section>
   <section id="deploying">
-    <title>Deploying Sylpheed-Claws</title>
+    <title>Deploying Claws Mail</title>
     <para>
        The initial configuration wizard tries to guess various fields using 
        information gathered from the system, such as username, hostname, and 
        more. As it is oriented towards general use, the default values often 
        have to be fixed. However, this wizard is customisable, in a manner 
-       designed to allow system administrators to deploy Sylpheed-Claws easily
+       designed to allow system administrators to deploy Claws Mail easily
        over various users of one machine, or even over multiple machines 
        installed via some replication tool.
     </para><para>
        The first part consists of creating a wizard configuration template 
-       and setting the various default parameters of a new Sylpheed-Claws 
+       and setting the various default parameters of a new Claws Mail 
        installation.
     </para>
     <itemizedlist>
       <listitem>
         <para>
        Start with a user who does not have a <filename class="directory"
-       >~/.sylpheed-claws</filename> directory, ideally a new user.
+       >~/.claws-mail</filename> directory, ideally a new user.
        </para>
       </listitem>
       <listitem>
        <para>
-       Start Sylpheed-Claws and go through the wizard. The values you fill in 
+       Start Claws Mail and go through the wizard. The values you fill in 
        will be of no use for the future deployment, so you can click 
        next-next-next.
        </para>
       </listitem>
       <listitem>
         <para>
-       Once the wizard is finished and you have Sylpheed-Claws' main window 
+       Once the wizard is finished and you have Claws Mail' main window 
        opened, configure the various defaults you want to have in the master. 
        You can load plugins, add people or LDAP servers in the addressbook, 
        create filtering rules, and so on.
       </listitem>
       <listitem>
        <para>
-       If needed, and if the deployed Sylpheed-Claws will use MH folders, you 
+       If needed, and if the deployed Claws Mail will use MH folders, you 
        can create subdirectories in the mailbox.
        </para>
       </listitem>
       <listitem>
        <para>
-       Next, quit Sylpheed-Claws.
+       Next, quit Claws Mail.
        </para>
       </listitem>
       <listitem>
        <para>
        Now, edit the newly created wizard template file, 
-       <filename>~/.sylpheed-claws/accountrc.tmpl</filename>. In this file, 
+       <filename>~/.claws-mail/accountrc.tmpl</filename>. In this file, 
        you will see different variables, corresponding to the wizard's fields.
        You can leave some commented, in which case the usual default will be 
        used, or specify values or variables. Not all fields can contain 
       <listitem>
        <para>
        Save this file, and delete both 
-       <filename>~/.sylpheed-claws/accountrc</filename>, (which contains your 
+       <filename>~/.claws-mail/accountrc</filename>, (which contains your 
        dummy account) and 
-       <filename>~/.sylpheed-claws/folderlist.xml</filename>, (so that the 
+       <filename>~/.claws-mail/folderlist.xml</filename>, (so that the 
        folder tree will be correctly parsed for new users). Recursively copy 
-       <filename class="directory">.sylpheed-claws</filename> to 
+       <filename class="directory">.claws-mail</filename> to 
        <filename class="directory">/etc/skel/</filename>; if the deployed 
-       Sylpheed-Claws will use MH folders, also copy the created 
+       Claws Mail will use MH folders, also copy the created 
        <filename class="directory">Mail</filename> directory. chown all of 
-       <filename class="directory">/etc/skel/.sylpheed-claws</filename> 
+       <filename class="directory">/etc/skel/.claws-mail</filename> 
        and <filename class="directory">/etc/skel/Mail</filename> to 
        <literal>root:root</literal> for security reasons.
        </para>
       </listitem>
       <listitem>
        <para>
-       Test! Create a new user, login as that user, run Sylpheed-Claws. If you
+       Test! Create a new user, login as that user, run Claws Mail. If you
        filled everything as you wanted, this user will just have to fill in 
        his passwords.
        </para>
   <section id="adv_hidden">
     <title>Hidden preferences</title>
     <para>
-       There are a number of hidden preferences in Sylpheed-Claws, preferences
+       There are a number of hidden preferences in Claws Mail, 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 
-       <filename>~/.sylpheed-claws/sylpheedrc</filename>.
+       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>
+       <listitem>
+         <para>
+       Use a separate dialogue to edit a person's details. 
+       '0' will use a form embedded in the addressbook's main window.
+         </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><literal>bold_unread</literal></term>
        <listitem>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term><literal>enable_dotted_lines</literal></term>
+       <term><literal>emphasis_color</literal></term>
        <listitem>
          <para>
-       Use the <emphasis>old</emphasis> dotted line look for the Folder List and
-       Message List instead of the <emphasis>modern</emphasis> lineless look.
+       The colour used for the X-Mailer line when its value is Claws Mail.
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term><literal>enable_hscrollbar</literal></term>
+       <term><literal>enable_dotted_lines</literal></term>
        <listitem>
          <para>
-       Enable the horizontal scrollbar in the Message List.
+       Use the <emphasis>old</emphasis> dotted line look in the main window
+       GtkTreeView components, (Folder List and Message List), instead of the
+       <emphasis>modern</emphasis> lineless look.
          </para>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term><literal>enable_rules_hint</literal></term>
+       <term><literal>enable_hscrollbar</literal></term>
        <listitem>
          <para>
-       Enable alternately coloured lines in GtkTreeView components.
+       Enable the horizontal scrollbar in the Message List.
          </para>
        </listitem>
       </varlistentry>
        </listitem>
       </varlistentry>
       <varlistentry>
-       <term><literal>mark_as_read_delay</literal></term>
+       <term><literal>outgoing_fallback_to_ascii</literal></term>
        <listitem>
          <para>
-       Number of seconds to wait before marking an opened mail as read.
+       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>respect_flowed_format</literal></term>
+       <listitem>
+         <para>
+       0 or 1. Respect format=flowed on text/plain message parts. This
+       will cause some mails to have long lines, but will fix some URLs
+       that would otherwise be wrapped. Default is 0, turned off.
+         </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>
          </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term><literal>stripes_color_offset</literal></term>
+       <listitem>
+       <para>
+       Specify the value to use when creating alternately coloured lines in
+       GtkTreeView components. The smaller the value, the less visible the
+       difference in the alternating colours of the lines.
+       </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>
+       Allows Claws to remember multiple SSL certificates for a given 
+       server/port. This is disabled by default.
+       </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>
+       Enable alternately coloured lines in GtkTreeView components.
+       </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><literal>use_stripes_in_summaries</literal></term>
+       <listitem>
+       <para>
+       Enable alternately coloured lines in the main window GtkTreeView
+       components, (Folder List and Message List). The only useful way to
+       use this option is to set it to 0 when use_stripes_everywhere is set
+       to 1.
+       </para>
+       </listitem>
+      </varlistentry>
       <varlistentry>
        <term><literal>utf8_instead_of_locale_for_broken_mail</literal></term>
        <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>