Custom Toolbar Final
[claws.git] / README.claws
index e101cf60389f16f67845e5ce505dfeb5f9fe0818..060fe4fbbbea36e1325e308e9b0d8ed2b0372811 100644 (file)
@@ -17,6 +17,8 @@ Summary:
    * pixmap themes
    * user definable actions
    * spell checking (with installation instructions)
+   * new cache
+   * selective download, delete messages on server
 4. How to contribute
 5. How to request features
 6. Installing Claws from CVS
@@ -231,7 +233,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
@@ -250,9 +252,9 @@ 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
@@ -264,17 +266,14 @@ 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. 
 
 * Spell checker for Sylpheed-Claws
 -----------------------------------
@@ -423,6 +422,7 @@ are hardly noticeable, but deserve mentioning:
     su root.
 
 * 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
@@ -432,9 +432,54 @@ are hardly noticeable, but deserve mentioning:
     Another example for the Sylpheed mailing list (not claws!) is:
     \[sylpheed:[0-9]{5}\]
 
+* new cache
+-----------------------------------
+    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. 
+
+    New cache uses two new configuration parameters that can be
+    adjusted in ~/.sylpheed/sylpheedrc (no gui for them available yet).
+
+    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.
+
+    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.
+
 There are a lot more options. If you find one, don't hesitate to
 mention it.
 
+* selective download, delete messages on server
+-----------------------------------
+    The selective download window lets you select messages, that
+    should be retrieved from or deleted on the server.
+    The selection can be automated by setting up a *global*
+    filtering rule (folder based rules are ignored), e.g
+      subject match "SPAM" delete_on_server
+    Next time, you retrieve the headers using selective download,
+    all messages that matched this criteria are marked.
+
 
 
 4. How to contribute