2005-10-11 [colin] 1.9.15cvs30
[claws.git] / README.claws
index c12d694fd9d54b13a98120f9b9ff5beb767d3744..c3d229c0f8e7d37d6dbc291ee1920b36f9efa14d 100644 (file)
 README.claws
 ------------
+[last revision: 2005-07-22]
 
 Summary:
 
-1. What is Sylpheed Claws?
-2. Switching between Sylpheed Claws and Sylpheed
-   * From Sylpheed to Sylpheed Claws
-   * From Sylpheed Claws to Sylpheed
-3. Things Claws does different
-   * auto address replacement in summary view
-   * manual selection of MIME types for attachments
-   * sharing mail folders
-   * default to address for folders
-   * threading mode per folder
-   * simplify subject string
-   * pixmap themes
-   * user definable actions
-   * spell checking (with installation instructions)
-4. How to contribute
-5. How to request features
-6. Installing Claws from CVS
-7. History
-
-
-
-1. What is Sylpheed Claws?
+ 1. What is Sylpheed-Claws?
+ 2. Plugins
+ 3. Switching between Sylpheed Claws and Sylpheed
+ 4. Actions
+ 5. Icon Themes
+ 6. Spell Checking
+ 7. Quick Search
+ 8. Custom toolbar
+ 9. Partial downloading of POP3 mails
+10. Other things that Claws does differently
+11. Tools
+12. How to contribute
+13. How to request features
+14. Installing Claws from CVS
+15. Release History
+16. Useful Links
+
+
+1. What is Sylpheed-Claws?
 --------------------------
 
-Sylpheed Claws is a bleeding edge branch of Sylpheed, a light weight mail 
+Sylpheed-Claws is an extended version of Sylpheed, a light weight mail
 user agent for UNIX. Features in this branch may (or may not) end up in 
 Sylpheed. 
 
-Hiroyuki's ChangeLog is also included in the claws-branch distribution, 
+Hiroyuki's ChangeLog is also included in the Claws branch distribution,
 so it should be easy to spot which features were merged with Sylpheed
 (and which features were not).
 
-For brevity Sylpheed Claws is referred to as Claws, and Sylpheed as either
+For brevity Sylpheed-Claws is referred to as Claws, and Sylpheed as either
 Sylpheed or Main.
 
 
 
-2. Switching between Sylpheed Claws and Sylpheed
+2. Plugins
+----------
+
+All plugins, except SpamAssassin, are built automatically
+if the required libraries are present.
+
+Plugins are installed in $PREFIX/lib/sylpheed/plugins/
+and have a suffix of '.so'
+To load a plugin go to '/Configuration/Plugins' and click
+the 'Load Plugin' button.
+Select the plugin that you want and click 'OK'
+  o Clam AntiVirus
+    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 
+    '/Configuration/Preferences/Filtering/Clam AntiVirus'.
+    Clam AntiVirus is available from http://clamav.sourceforge.net/
+  
+  o Dillo HTML Viewer 
+    Enables the viewing of html messages using the Dillo web
+    browser, version 0.7.0 or newer. It uses Dillo's --local
+    option by default for safe browsing. Preferences can be 
+    found in '/Configuration/Preferences/Message View/Dillo Browser'.
+    Dillo is available from http://www.dillo.org/
+       
+  o MathML Viewer
+    Enables the viewing of attachments that have the 
+    Content-Type 'text/mathml' using the GtkMathView widget
+    which is available from 
+    http://helm.cs.unibo.it/mml-widget/
+
+  o PGP/Core
+    Handles core PGP functions and is required by the PGP/Inline
+    and PGP/MIME plugins.
+    Uses GnuPG/GPGME, <ftp://ftp.gnupg.org/gcrypt/gpgme/>
+
+  o PGP/inline
+    Handles inline PGP signed and/or encrypted mails. You can
+    decrypt mails, verify signatures or sign and encrypt your
+    own mails. Uses GnuPG/GPGME, <ftp://ftp.gnupg.org/gcrypt/gpgme/>
+
+  o PGP/MIME
+    Handles PGP/MIME signed and/or encrypted mails. You can
+    decrypt mails, verify signatures or sign and encrypt your
+    own mails. Uses GnuPG/GPGME, <ftp://ftp.gnupg.org/gcrypt/gpgme/>
+
+  o SpamAssassin
+    Enables the scanning of incoming mail received from a POP,
+    IMAP or LOCAL account using SpamAssassin. It can optionally 
+    delete mail identified as spam or save it to a designated 
+    folder. Preferences can be found in '/Configuration/
+    Preferences/Filtering/SpamAssassin'.
+    SpamAssassin is available from http://spamassassin.org
+    Configure option:
+       --enable-spamassassin-plugin
+       
+  o Trayicon 
+    Places an icon in the system tray that indicates whether
+    you have any new mail. A tooltip also shows the current
+    new, unread and total number of messages
+
+More plugins can be found here:
+http://sylpheed-claws.sourceforge.net/plugins.php
+
+
+3. Switching between Sylpheed Claws and Sylpheed
 ------------------------------------------------
 
   From Sylpheed to Sylpheed Claws      
   -------------------------------
 
   From the user perspective Claws is just a fancy Sylpheed, so it uses the
-  same sylpheed setting files located in ~/.sylpheed.
+  same Sylpheed setting files located in ~/.sylpheed. However, you may wish
+  to use the ./configure option --with-config-dir=RCDIR, so that you can
+  preserve your Sylpheed settings.
 
   It's always a good idea to back up all files in ~/.sylpheed in case
-  you want to switch back to Sylpheed. (You don't have to backup the
-  directories.)
+  you want to switch back to Sylpheed and didn't use the --with-config-dir
+  option. (You don't have to backup the directories.)
 
+  If you use a new configuration directory you will need to manually copy
+  all of your address book files, ~/.sylpheed/addrbook*
+  
   There are some things that frequently come up when switching to Claws:
 
 
-  * Why does the advanced filtering system not work?
-
-    Claws uses the new filtering system as soon as you define a new rule for it.
-    Your old sylpheed filter rules will not be used. In subdirectory tools/ of
-    the distribution there is a Perl script called filter_conv.pl which converts
-    old filter rules to the claws filtering system.
-  
+  * What happened to my filter rules? 
 
+    Claws uses a new filtering system. Your old Sylpheed filter rules will not 
+    be used. In subdirectory tools/ of the distribution there is a Perl script 
+    called filter_conv.pl which converts old filter rules to the claws 
+    filtering system, see tools/README for details. This currently only supports
+    conversion from Sylpheed's old filtering system, < 0.9.99.
   * What happened to the compose email and compose news buttons? 
 
-    There's a composite button for both composing mail and news. You can toggle
-    between composing mail and news by clicking on the button with the triangle.
+    There's a composite button for both composing mail and news. It is toggled
+    between composing mail and news automatically when  a mail or news folder
+    is selected.
 
 
   * And to the Preferences and Execute buttons?
@@ -82,60 +153,16 @@ Sylpheed or Main.
   Claws put in the settings files. This also means that the old rules will work
   again. 
 
-  If you want to switch back to Claws at a later time, make sure you back up at least
-  ~/.sylpheed/filteringrc (the Claws filtering rules), and ~/.sylpheed/sylpheedrc 
-  (which may have some claws specific settings).
+  If you want to switch back to Claws at a later time, and are using the same config
+  directory for both, make sure you back up at least  ~/.sylpheed/matcherrc (the
+  Claws filtering rules), and ~/.sylpheed/sylpheedrc (which may have some claws
+  specific settings).
 
   When switching back to Sylpheed you will not lose messages or message flags (color
   labels, read / unread status of messages). 
 
-
-
-3. Things Claws does different
-------------------------------
-
-Claws does a lot of things different. Here a quick run-down of things that
-are hardly noticeable, but deserve mentioning:
-
-* auto address replacement in summary view
------------------------------------
-  This matches a plain email address with a person in the address book. This
-  feature is enabled in Common Preferences | Tab Display | SummaryView Group |
-  Display sender using addressbook
-
-* manual selection of MIME types for attachments
------------------------------------
-  You can change the MIME type of an attachment by right-clicking in the
-  attachment list, selecting Property in the menu. The MIME type list
-  is a combo box with the known MIME types.
-
-* sharing mail folders   
- -----------------------------------
- You can also share or use shared mail folders. Right-click a folder and
-  select Property. Change the Folder chmod setting.
-
-* default to address for folders
- -----------------------------------
- Most people filter mailing list mails to separate folders. Claws allows
-  you to associate a folder with a mailing list or a person. Right-click a
-  folder, select Property and change the Default To setting. When you
-  compose a new mail, when this folder is selected the recipient address
-  will be set to this address.
-
-  (NOTE: this is also a shoot-yourself-in-the-foot-setting! If you want
-   to send a private mail, don't have a folder selected with this setting
-   set.)
-
-* pixmap themes
------------------------------------
-  To use different icon sets you need to create a directory: 
-       mkdir ~/.sylpheed/themes
-  Icon sets should be placed in this directory in their own sub-directory. 
-  They are then selectable from Pixmap Theme on the Interface tab of Commmon
-  Preferences. 
-
-* user definable actions
------------------------------------
+4. Actions
+----------
   The "actions" feature is a convenient way for the user to launch external 
   commands to process a complete message file including headers and body or 
   just one of its parts. It allows also the use of an external command to 
@@ -224,7 +251,7 @@ are hardly noticeable, but deserve mentioning:
 
   Purpose:     Display uuencoded image
   Definition:  Display uuencoded: uudec %f&
-  Details:     Displays uuencoded files. The uudec script can be found in 
+  Details:     Displays uuencoded files. The uudec[1] script can be found in 
                the 'tools' directory of the distribution package.
  
   Purpose:     Alter messages
@@ -243,12 +270,12 @@ are hardly noticeable, but deserve mentioning:
   Details:     Browse the selected message part in Dillo.
 
   Purpose:     Clear Sign
-  Definition:  GnuPG/Clear Sign: |gpg-sign|
-  Details:     Clear sign a message. The gpg-sign script is responsible for 
-               asking the passphrase and for running gnupg. 
+  Definition:  GnuPG/Clear Sign: |gpg-sign-syl|
+  Details:     Clear sign a message. The gpg-sign-syl[2] script is responsible
+               for asking the passphrase and for running gnupg. 
 
   Purpose:     Verify Clear Signed
-  Definition:  GnuPG/Verify: |gpg --no-tty --verify %f&
+  Definition:  GnuPG/Verify: |gpg --no-tty --verify
   Details:     Verify clear signed messages. The result is displayed in the
                actions output dialog.
 
@@ -257,20 +284,31 @@ are hardly noticeable, but deserve mentioning:
   Details:     Decrypt ASCII armored messages. The passphrase is entered 
                into the opened action's input dialog.
 
-  The gpg-sign script can be found in the 'tools' directory of the 
-  distribution package. It needs the ssh-askpass utility found in OpenSSH. 
-  It can be replaced by any X11 tool that asks some (hidden) text which is 
-  then sent to standard output.
-
-  The uudec script can be found in the 'tools' directory of the 
+  [1] The uudec script can be found in the 'tools' directory of the 
   distribution package. It needs uudecode and ImageMagick's display. The 
   latter can be replaced by any image viewer that can get input from 
   standard input. The script could also be modified to use temporary files 
   instead of standard input. 
 
+  [2] The gpg-sign-syl script can be found in the 'tools' directory of the 
+  distribution package. 
+
+
+
+5. Icon Themes
+--------------
+  Claws has support for different icon sets. Several icon sets can be
+  downloaded from http://sylpheed-claws.sourceforge.net/themes.php
+  You will need to create a directory called 'themes' in your config
+  directory, unpack them into this directory, and then use the interface
+  to select them, /Configuration/Preferences/Display/Themes
+
+  This interface can also be used to install new themes.
+
 
-* Spell checker for Sylpheed-Claws
------------------------------------
+
+6. Spell Checking
+-----------------
   a. Requirements
   b. Configuration and installation
   c. Usage
@@ -279,203 +317,442 @@ are hardly noticeable, but deserve mentioning:
   a. Requirements
   ---------------
 
-  The spell checker in sylpheed requires the Portable Spell Checker
-  Interface Library pspell (http://pspell.sourceforge.net), version
-  0.12.2 or newer.
-
-  You will need also the actual spell checker.  There are two alternatives:
-
-     i) ispell (http://fmg-www.cs.ucla.edu/fmg-members/geoff/ispell.html),
-        which is found on quasi every distribution.  You have then to
-        install the pspell-ispell module found at the pspell site.
+  The spell checker in Sylpheed-Claws requires the GNU/aspell library
+  (http://www.gnu.org/software/aspell), version 0.50 or newer.
 
-    ii) aspell (http://aspell.sourceforge.net).  This spell checker
-        must be installed after installing pspell.  The version tested
-        is .33.7 alpha. It has three different suggestion modes (fast
-        -default- , normal, bad spellers), has the ability to learn
-        from mistakes (default). 
+  You also need the dictionaries. Check GNU/aspell home page for how
+  to download and install them.
+  
+  NB: The old dictionaries used by the old aspell will not work.
 
-  And, last but not least, do not forget to install the dictionaries. Check
-  the corresponding spell checker home page for more information on this.
+  b. Configuring Claws
+  --------------------
 
-  b. Configuring Sylpheed
-  -----------------------
+  Spell checking is enabled if you configure Claws appropriately. Add
+  the option '--enable-aspell' when configuring, e.g.:
 
-  Spell checking is enabled if you configure sylpheed appropriately. Add
-  the option '--enable-pspell' when configuring. E.g.:
+  ./configure --enable-aspell
 
-  ./configure --enable-pspell
+  The configure script needs the 'aspell' executable to be in your path.
+  If it is in unusual places, use '--with-aspell-prefix' to tell the path of
+  the aspell executable.  E.g., if aspell's full path is
+  /foo/bar/bin/aspell, then use:
 
-  The configure script needs 'pspell-config' in your path.  If it is
-  in weird places, use '--with-pspell-prefix' to tell the path to
-  pspell-config.  E.g., if pspell-config is really
-  /foo/bar/pspell-config, then use:
+  ./configure --enable-aspell --with-aspell-prefix=/foo/bar
 
-  ./configure --enable-pspell --with-pspell-prefix=/foo/bar
+  The '--with-aspell-prefix=PREFIX' option will let the configure
+  script search for includes and libraries in PREFIX/include and PREFIX/lib.
 
-  If you have problems with not found includes or libraries, check
-  first where these are located, and add either options:
+  You can also specify manually the includes and libraries path by using
+  either following options:
 
-  --with-pspell-includes=/foo/bar/include
+  --with-aspell-includes=/foo/bar/include
 
-  or 
+  and/or 
 
-  --with-pspell-libs=/foo/bar/lib
+  --with-aspell-libs=/rab/oof/lib
 
   as appropriate.
 
-  Configure script summarizes the options compiled in. Check that
-  configure lists 'Pspell = yes'.
+  The configure script summarizes the options compiled in.  Check that
+  it lists 'GNU/aspell = yes'.
 
   Then proceed as usual, with 'make' and 'make install'.
 
   c. Usage
   --------
 
-  NOTE: if you upgraded from 0.7.0claws, please reselect your default
-  dictionary in the preferences.
-
-  After successful compiling, you need to tell sylpheed where your
-  dictionaries reside.  First run 'pspell-config pkgdatadir' on the
-  shell to get their path.
+  After successful compiling, you need to tell Sylpheed where your
+  dictionaries reside. The configure script should have found it,
+  but in case it did not, run 'aspell config dict-dir' on the
+  shell to get the path to the dictionaries.
 
-  Then run sylpheed and go to Configuration -> Common preferences ->
-  Spell Checker.  Check the box 'Enable spell checker (EXPERIMENTAL)' and
-  use the file selector ('...' button) to select the path where the
-  dictionaries reside.  Within the file selector, go to that directory
-  and select *any* file in the file lists.  Click ok. You should then
-  be able to select your default dictionary.
+  Then run Sylpheed and go to /Configuration/Preferences/Compose/Spell Checker.
+  Check the box 'Enable spell checker' and use the file selector ('...' button)
+  to select the path where the dictionaries reside.  Within the file selector,
+  go to that directory and select *any* file in the file lists.  Click OK.
+  Then, you should be able to select your default dictionary.
 
   When composing, misspelled words are highlighted.  Click on any
   highlighted word with the right mouse button to get a list of
   suggestions.  The first entry of the menu just displays the unknown
-  word.  Selecting "Accept in this session" (or hitting MOD1-Space, 
-  where MOD1 is usually the ALT key), will ignore this word and accept
-  it in this message.  Selecting the next entry "Add to dictionary", which
-  is bound to MOD1-Enter combination will add the unknown word to the
-  dictionary to learn it.  The next entries are the suggested words. 
-  The first 15 suggestions can be accessed typing one of the first letters
+  word.  Selecting 'Accept in this session' (or hitting MOD1-Space, 
+  where MOD1 is usually the ALT key) will ignore this word and accept
+  it in this message.  Selecting the next entry, "Add to dictionary", which
+  is bound to MOD1-Enter combination, will add the unknown word to your
+  personal dictionary to learn it.  The next entries are the suggested words. 
+  The first 15 suggestions can be accessed by typing one of the first letters
   of Latin alphabet (if this does not suit your language, please send
-  a mail to melvin.hadasht@free.fr).  If you are using an aspell 
-  dictionary, you can use its 'learn from mistake' feature, by pressing
-  the MOD1 key and selecting the suggestion (with the keyboard or with
-  the mouse).  See pspell manual §4.7.1 for an explanation of this 
-  feature. 
+  a mail to melvin.hadasht@free.fr).  Aspell has a 'learn from mistake'
+  function that can be used by pressing the MOD1 key and selecting the 
+  suggestion (with the keyboard or with the mouse).  See GNU/aspell manual
+  §6.3 for an explanation of this feature (also called 'replacement storing'). 
 
   If you click with the right mouse button everywhere else, or if you
   shift-right-click even on a misspelled word, you get the
   configuration menu.  'Check all' highlights all misspelled words.
   With this menu, you can also change the dictionary while editing.
   Finally, you can change the suggestion mode, and the learn from
-  misktakes feature (only when using an aspell dictionary).
+  misktakes feature.
 
   Spell checking can also be done using keyboard shortcuts.  In the
-  "Edit" menu of the compose window, there are two menus "Check backwards
-  misspelled word" and "Forward to next misspelled word".  Add to them 
-  appropriate keyboard shortcuts.  "Check backwards misspelled word" 
+  'Edit' menu of the compose window, there are two menus 'Check backwards
+  misspelled word' and 'Forward to next misspelled word'.  Add to them 
+  appropriate keyboard shortcuts.  'Check backwards misspelled word' 
   checks backwards from cursor position for the first misspelled word.
   If it finds one, it displays the suggestions lists which can be handled
   with the keyboard as described before. When the suggestion menu is 
   closed, the cursor returns to its original position to be able to 
-  continue editing.  The "Forward to next misspelled word" do the same 
+  continue editing.  The 'Forward to next misspelled word' do the same 
   thing in the other direction but moves the cursor at the end of the
   misspelled word.  This way, you can spell check easily a whole message
-  starting from its beginning and using the "Forward to next misspelled
-  word" keyboard short cut.
+  starting from its beginning and using the 'Forward to next misspelled
+  word' keyboard short cut.
   
 
   d. Known problems
   -----------------
 
-    i) libtool
+    No known problems as the time of this writing (0.8.2claws3).
+
+
+7. Quick Search with extended search
+------------------------------------
+    Quick Search, with its powerful Extended search function,
+    enables searching through folder's messages.
+
+    Extended Search allows one to define criteria that messages must
+    have in order to match and be displayed in the summary view pane.
+    Search types titled From, Subject and To are self explanatory.
+    Search type extended allows one to use Sylpheed's powerful
+    filtering engine to select messages. Examples:
+    from regexpcase "foo"
+    subject regexp "Bug" & to regexp "sylpheed-claws"
+
+    Additionally, it is possible to use simpler yet equally
+    powerfull patterns for message selections. Mutt users will
+    immediately recognise most of the available patterns:
+
+    Pattern  Parameter  Selects
+    ----------------------------------------------------
+    a                   all messages
+    ag       #          messages whose age is greater than #
+    al       #          messages whose age is lower than #
+    b        S          messages which contain S in the message body
+    B        S          messages which contain S in the whole message
+    c        S          messages carbon-copied to S
+    C        S          message is either to: or cc: to S
+    D                   deleted messages
+    e        S          messages which contain S in the Sender field
+    E        S          true if execute "S" succeeds
+    f        S          messages originating from user S
+    F                   forwarded messages
+    h        S          messages which contain header S
+    i        S          messages which contain S in Message-Id header
+    I        S          messages which contain S in inreplyto header
+    L                   locked messages
+    n        S          messages which are in newsgroup S
+    N                   new messages
+    O                   old messages
+    r                   messages which have been replied to
+    R                   read messages
+    s        S          messages which contain S in subject
+    se       #          messages whose score is equal to #
+    sg       #          messages whose score is greater than #
+    sl       #          messages whose score is lower than #
+    Se       #          messages whose size is equal to #
+    Sg       #          messages whose size is greater than #
+    Ss       #          messages whose size is smaller than #
+    t        S          messages which have been sent to S
+    T                   marked messages
+    U                   unread messages
+    x        S          messages which contain S in References header
+    y        S          messages which contain S in X-Label header
+
+    # means number
+    S means regexp string
+
+    It is possible to use logical operators AND (&), OR (|) and
+    NOT (! or ~). Case sensitive search is achieved with %.
+    Examples:
+    T                  marked messages
+    U                  unread messages
+    f "john beavis"    messages from john beavis
+    %f "John Beavis"   messages from John Beavis (case sensitive)
+    ~s foo             messages which do not have foo in the subject
+    f foo & ~s bar     messages from foo that do not have bar in thesubject
+
+
+8. Custom toolbar
+-----------------
+
+   /Configuration/Preferences/Customize Toolbars lets you define the
+   toolbar you want. The configuration dialog enables you to set an icon,
+   an appropriate text, and map an action to it. Actions to choose
+   from are predefined. You can also have your "Sylpheed Actions" (refer
+   to "Actions" above) on your toolbar.
+
+   Example: 
+       * Configuration->Actions 
+               - add an entry "Dillo: dillo %p&"
+        * Configuration->Custom toolbar    
+               - select Sylpheed Actions Feature
+               - select "Dillo: dillo %p&" from drop down list
+               - choose an icon and click ok
+
+
+    
+9. Partial downloading of POP3 mails
+------------------------------------
+  Messages over the configured size limit, (/[Account preferences]/
+  Receive/Message size limit), will be partially retrieved. These
+  messages will have a Notice View displayed (above the Message View),
+  informing of the partially retrieved state and the total size of the
+  message. The Notice View will also contain two buttons, 'Mark for
+  download' and 'Mark for deletion'. If the user clicks 'Mark for
+  download', the message will be downloaded in full at the next message
+  retrieval, (and the partial one deleted); if the user checks 'Mark for
+  deletion' it will be removed from the server after the normal delay
+  as specified in the POP3 account's 'Receive' preferences.
+  If a user moves a partially retrieved message to the Trash folder 
+  it will be deleted on the server at the next retrieval after the 
+  Trash folder has been emptied.
+
+
+
+
+10. Other things that Claws does differently
+--------------------------------------------
+  Claws does a lot of things differently. Here is a quick run-down of
+  just a few of them:
+
+  * auto address replacement in summary view
+  
+    This matches a plain email address with a person in the address book.
+    This feature is enabled in /Configuration/Preferences/Common/Display
+    'Display sender using addressbook'
 
-    The only real known problems until now are configuration and
-    compilation problems  due to libtool interaction with pspell. 
+  * manual selection of MIME types for attachments
 
-    If you do not compile pspell/aspell/pspell-ispell yourself, you
-    need to install them with their devel packages.
+    You can change the MIME type of an attachment by right-clicking in the
+    attachment list, selecting Property in the menu. The MIME type list
+    is a combo box with the known MIME types.
 
-    Pspell work with dynamic linking of libraries and thus uses the
-    libltdl library of libtool.  If you have weird problems when
-    configuring showing 'libtool', chances are the libtool used when
-    compiling the pspell package is not compatible with what you have
-    on your system.  The best solution, is to install the latest
-    libtool AND compile yourself pspell package.  I can't help more
-    than that in this issue.
+  * sharing mail folders   
 
-    After successfully compiled and used sylpheed with spell checking,
-    the same problem can appear if you upgrade your libtool to a
-    version which libltdl is incompatible to your older one.    The
-    symptoms are a crash when starting to compose.  Disabling spell
-    checking avoids the problem. The solution should be to recompile pspell.
+    You can also share or use shared mail folders. Right-click a folder and
+    select Properties. Change the Folder chmod setting.
 
-    ii) New installed ispell dictionary are not detected
+  * simplify subject string
 
-    Installing a new ispell dictionary needs an additional step. Go
-    to the 'pkgdatadir' and run 'make-ispell-pwli'.  You may need to
-    su root.
+    It is possible to remove parts of subject string from the displayed
+    subject line.
+    Example:
+    True Subject: [Sylpheed-claws-users] This is a test
+    Displayed Subject: This is a test
+    Regexp: \[Sylpheed-claws-(devel|users)\]
 
-* simplify subject string
-    It is possible to remove parts of string from the subject line.
-    Example: [Sylpheed-claws-users] This is a test
-    becomes: This is a test
     This is a per folder property. Right click on a folder and select
-    property, enable Simplify Subject RegExp check box. Example
-    regexp for the above is: \[Sylpheed-claws-(devel|users)\]
-    Another example for the Sylpheed mailing list (not claws!) is:
-    \[sylpheed:[0-9]{5}\]
-
-There are a lot more options. If you find one, don't hesitate to
-mention it.
-
-
+    Properties, enable Simplify Subject RegExp check box.
 
-4. How to contribute
---------------------
+  * new cache
 
-Sylpheed Main: 
+    New cache is  a new data cache structure for sylpheed, that will
+    solve many of the problems sylpheed currently has with updates to
+    flags.  But you will also notice a large speed gain when you open
+    these folders. 
 
-       submit it to the Sylpheed ML, Hiroyuki, or Paul Mangan
-       (for incorporation on the Sylpheed Patches page,
-        <http://www.thewildbeast.co.uk/sylpheed/>)
+    New cache uses two new configuration parameters that can be
+    adjusted in ~/[RCDIR]/sylpheedrc (no gui for them available yet).
 
-Sylpheed Claws:
+    cache_max_mem_usage                (default: 4096)
+       the maximum kB of memory sylpheed should use.
+       It will try to keep the memory usage below this
+       value, but it will always use the assigned
+       amount of memory for speed gain.
 
-       It is highly recommended to use the sourceforge project page
-       of claws. Check: 
-       http://sourceforge.net/tracker/?atid=384600&group_id=25528&func=browse
-
-       If that's too troublesome, either contact Paul Mangan or consider
-       posting to the sylpheed claws users mailing list.
-
-       Bugs can be reported in the same way; the recommended web page:
-       http://sourceforge.net/tracker/?group_id=25528&atid=384598
-
-       Of course you can also post to the sylpheed claws users
-       mailing list.
+    cache_min_keep_time                (default: 15)
+       the minimum time in minutes sylpheed will keep
+       the folder cache in memory. If a cache is more
+       recent than this time it will not be freed even
+       if the memory usage is above the maximum. You
+       should probably set this value higher than your
+       mail check interval. Otherwise the cache will
+       always be freed between checks even if the folder
+       is accessed on every check, which will cause much
+       disk IO.
+
+    The check if memory can be freed is currently done after the
+    active folder has been changed or whenever a new cache is read,
+    i.e. triggered by mail incorporation.
+
+    New mails in MH folders are not detected automatically like before,
+    when you enter the folder. You have to update the folder manually,
+    or activate the auto update setting in the options.
+
+  * SMTP Message Size Declaration
+    If the server supports it, oversize messages will not be sent and
+    the maximum allowed message size will be displayed in the log,
+    (/Tools/Log window/).
+
+  * Reply-finder
+    Clicking on the replied icon in the Status (S) column of the summary
+    view will attempt to find and display your reply that is stored in
+    your Outbox.
+
+  * pop before smtp authentication
+
+  * Automatic saving of message when composing
+
+  * signature in the message view can be coloured
+
+  * built-in gdb crash handler
+
+  * extra Font configuration
+
+  * message scoring
+
+  * 'hide read messages' feature
+
+  * Request Return-Receipt
+
+  * ability to change folder order
+
+  * 'ignore thread' marking
+
+  * message priority setting
+
+  * Automatic message drafting and cache saving on kill
+
+  * SSL certificate management and checking
+
+  * Indication of unread answers to marked mails:
+    '(!)' is appended to the folder name when a marked message
+    has a response
+
+  * address auto-completion includes a dynamic LDAP search
+
+  * address auro-completion works on nicknames and aliases
+
+  * Password encryption in config files is implemented using 
+    unix encrypt and setkey functions.
+   
+  This is not an exhaustive list.
+
+
+
+11. Tools
+--------- 
+  You will find all of these tools in the 'tools' directory:
+
+  acroread2sylpheed.pl 
+       send PDFs from Adobe Reader 7
+  calypso_convert.pl 
+       import mbox files exported by calypso
+  convert_mbox.pl
+       convert mbox format to MH format
+  eud2gc.py
+       convert a Eudora (v.3?) addressbook to vCard 
+       (GnomeCard) format
+  filter_conv.pl
+       convert sylpheed main's filter rules, (< 0.9.99),
+       into Claws' filtering format
+  freshmeat_search.pl
+       Actions script to lookup the selected text on
+       Freshmeat www.freshmeat.net using the configured
+       browser
+  gif2xface.pl
+       convert a gif file to an xface
+  google_msgid.pl
+       Actions script to lookup selected message-id on 
+       google using mozilla.
+  google_search.pl
+       Actions script to lookup up the selected text on
+       google using the configured browser
+  gpg-sign-syl
+       GnuPG cleartext-signing script for use with
+       Actions
+  kmail2sylpheed.pl
+       convert a Kmail addressbook to a Sylpheed
+       addressbook
+  kmail2sylpheed_v2.pl
+       new version of the address book conversion script
+       for newer versions of Kmail/Kaddressbook
+  maildir2sylpheed.pl
+       convert a maildir format mailbox into MH format
+  multiwebsearch.pl
+       search any searchable website for the selected text
+  nautilus2sylpheed.sh
+       enables sending files from the Nautilus file manager
+       to Sylpheed
+  OOo2sylpheed.pl
+       enable OpenOffice to send documents through
+       sylpheed
+  outlook2sylpheed.pl
+       convert an Outlook contacts list to a Sylpheed
+       addressbook
+  sylpheed-switcher
+       enable quick-switching between claws and main
+       in a non-destructive way
+  sylprint.pl
+       process a Sylpheed mail and print it using enscript
+       if available or lpr if not
+  tb2sylpheed
+       convert an addressbook exported from The Bat! into 
+       a Sylpheed addressbook
+  textviewer.sh
+       attempt to view an attachment as plain text
+  update-po 
+       translators' tool that eases the creation of 
+       *.po files
+  uudec
+       decode UUencoded mails, for use with Actions
+  kdeservicemenu/*
+       Service Menus for Konqueror to allow attaching files and
+       compressing/attaching files/directories to a new Compose
+       window
+
+
+12. How to contribute
+---------------------
+
+You are encourged to send patches via the Sylpheed-Claws sourceforge
+project's Patch Tracker.
+http://sourceforge.net/tracker/?atid=384600&group_id=25528&func=browse
+
+If that's too troublesome, either contact Paul Mangan
+<twb@users.sourceforge.net> or consider posting to the
+Sylpheed-Claws-users mailing list.
+http://lists.sourceforge.net/lists/listinfo/sylpheed-claws-users
+
+Bugs can be reported with Claws' bugzilla at:
+http://www.thewildbeast.co.uk/sylpheed-claws/bugzilla/index.cgi
+
+Of course, you can also post to the Sylpheed-Claws-users mailing list.
 
 Also, we really try to incorporate good contributions, but sometimes we
 don't have enough time. If the contribution is really big, or requires
-a long time to stabilize, send a mail to Paul Mangan. We can probably
-arrange access to the Claws branch.
+a long time to stabilise, send a mail to Paul Mangan
+<twb@users.sourceforge.net>. We can probably arrange access to the
+Sylpheed-Claws CVS tree.
 
 
 
-5. How to request features
---------------------------
+13. How to request features
+---------------------------
 
-Ask around in both Sylpheed ML and Sylpheed Claws Users ML. Note
-that some developers may already thought about your feature, may
-perhaps be implementing it - or the feature was already discussed
-and rejected for whatever reason.  You might want to go ahead and 
-hack a patch for it. (That would be very cool!) Another
-possibility is to use the Feature Request Tracker at the
-sourceforge project page.
+Ask around in Sylpheed-Claws-users ML. Note that some developers may
+have already thought about your feature, may,perhaps, be implementing it,
+or the feature was already discussed and rejected for whatever reason.
+You might want to go ahead and hack a patch for it. (That would be very
+cool!) Another possibility is to use the Feature Request Tracker at the
+sourceforge project.
+http://sourceforge.net/tracker/?group_id=25528&atid=384601
 
 
 
-6. Installing Claws from CVS
-----------------------------
+14. Installing Claws from CVS
+-----------------------------
 
   a. Downloading
   --------------
@@ -483,12 +760,12 @@ sourceforge project page.
   To download the latest cvs cd to the directory where you wish to download
   to and type the following information:
 
-  cvs -d:pserver:anonymous@cvs.sylpheed-claws.sourceforge.net:/cvsroot/sylpheed-claws login
+  cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/sylpheed-claws login
 
   When prompted for a password press the RETURN key.
   After anonymously logging in:
 
-  cvs -z3 -d:pserver:anonymous@cvs.sylpheed-claws.sourceforge.net:/cvsroot/sylpheed-claws co sylpheed-claws 
+  cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/sylpheed-claws co -r gtk2 sylpheed-claws 
 
 
   b. Installing
@@ -501,10 +778,103 @@ sourceforge project page.
   make install         [as root]
 
   You will need a full set of development tools installed to be able to run
-  autogen.sh.
-
-7. History
-----------
-
-TODO
-
+  autogen.sh. See also ac/README.
+
+
+
+15. Release History
+-------------------
+
+GTK 2 Version
+-------------
+2005-05-09     1.9.9
+2005-03-18     1.9.6
+
+GTK 1 Version
+-------------
+2005-05-09     1.0.4a
+2005-03-24     1.0.4
+2005-03-10     1.0.3
+2005-02-08     1.0.1
+2005-01-17     1.0.0
+2004-12-06     0.9.13
+2004-09-27     0.9.12b
+2004-08-23     0.9.12a
+2004-06-28     0.9.12
+2004-05-31     0.9.11claws
+2004-03-08     0.9.10claws
+2004-02-06     0.9.9claws
+2003-12-19     0.9.8claws
+2003-11-26     0.9.7claws
+2003-10-02     0.9.6claws
+2003-09-10     0.9.5claws
+2003-08-04     0.9.4claws
+2003-07-12     0.9.3claws
+2003-05-24     0.9.0claws
+2003-03-12     0.8.11claws
+2003-02-12     0.8.10claws
+2003-01-24     0.8.9claws
+2002-12-26     0.8.8claws
+2002-12-23     0.8.7claws
+2002-11-25     0.8.6claws
+2002-10-07     0.8.5claws
+2002-09-22     0.8.3claws
+2002-08-28     0.8.2claws
+2002-07-30     0.8.1claws
+2002-07-23     0.8.0claws
+2002-06-15     0.7.8claws
+2002-05-18     0.7.6claws
+2002-04-28     0.7.5claws
+2002-03-11     0.7.4claws
+2002-02-19     0.7.2claws
+2002-02-14     0.7.1claws
+2002-01-14     0.7.0claws
+2001-12-16     0.6.6claws
+2001-10-16     0.6.5claws8
+2001-09-30     0.6.2claws
+2001-08-14     0.6.1claws
+2001-07-13     0.5.1claws
+2001-07-01     0.5.0claws3
+2001-06-16     0.4.99claws
+2001-05-29     0.4.99claws3
+2001-05-11     0.4.67claws1
+
+
+
+16. Useful links
+----------------
+Homepage
+    http://sylpheed-claws.sourceforge.net/
+Sylpheed-Claws for Windows homepage
+    http://sylpheed-claws.sourceforge.net/win32/
+FAQ
+    http://sylpheed-claws.sourceforge.net/phpwiki/
+Project page
+    http://sourceforge.net/projects/sylpheed-claws/
+Downloads
+    http://sourceforge.net/project/showfiles.php?group_id=25528
+External Plugins
+    http://sylpheed-claws.sourceforge.net/plugins.php
+Icon Themes
+    http://sylpheed-claws.sourceforge.net/themes.php
+CVS webview
+    http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/sylpheed-claws/sylpheed-claws/?only_with_tag=gtk2
+Users Mailing List subscription page
+    http://lists.sourceforge.net/lists/listinfo/sylpheed-claws-users/
+Users Mailing List archive
+    http://sourceforge.net/mailarchive/forum.php?forum=sylpheed-claws-users/
+Commits Announcement List subscription page
+    http://lists.sourceforge.net/lists/listinfo/sylpheed-claws-commits/
+Commits Announcement List archive
+    http://sourceforge.net/mailarchive/forum.php?forum=sylpheed-claws-commits/
+Bug Tracker
+    http://www.thewildbeast.co.uk/sylpheed-claws/bugzilla/index.cgi
+Feature Request Tracker
+    http://sourceforge.net/tracker/?group_id=25528&atid=384601
+Patch Tracker
+    http://sourceforge.net/tracker/?group_id=25528&atid=384600
+Internationalisation Status
+    http://sylpheed-claws.sourceforge.net/i18n.php
+
+
+