Custom Toolbar Final
[claws.git] / README.claws
index 0b52d5e80353d3ee278619c3e50cbdabeed4ddff..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
@@ -60,7 +62,7 @@ Sylpheed or Main.
 
     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 convers
+    the distribution there is a Perl script called filter_conv.pl which converts
     old filter rules to the claws filtering system.
   
 
@@ -83,19 +85,26 @@ Sylpheed or Main.
   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 
+  ~/.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). 
 
+  Switching between Sylpheed Claws and Sylpheed on a regular basis
+  ----------------------------------------------------------------
 
+  If you want to have both claws and main installed concurrently simply pass them
+  a different --prefix when doing ./configure. Then use the script 'sylpheed-switcher',
+  (which is provided in the tools directory), to launch the version you require without
+  fear of losing specific settings related to either claws or main. Further details can
+  be found in tools/README. 
 
 3. Things Claws does different
 ------------------------------
 
 Claws does a lot of things different. Here a quick run-down of things that
-are hardly noticable, but deserve mentioning:
+are hardly noticeable, but deserve mentioning:
 
 * auto address replacement in summary view
 -----------------------------------
@@ -119,7 +128,7 @@ are hardly noticable, but deserve mentioning:
  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 recepient address
+  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
@@ -177,11 +186,11 @@ are hardly noticable, but deserve mentioning:
         input a text that you will enter in a dialog window.
     * Prepending *: this will allow you to send to the command's standard 
         input a text that you will enter in a dialog window. But in 
-        contrast to prepending >, the entered text is hidded (useful when 
+        contrast to prepending >, the entered text is hidden (useful when 
         entering passwords).
     * Appending an ampersand &: this will run the command asynchronously. 
         That means "fire and forget". Sylpheed won't wait for the command 
-        to finish, nor will it catch it's output or it's error messages.
+        to finish, nor will it catch its output or its error messages.
     * Prepending the vertical bar | (pipe-in): this will send the current 
         displayed text or the current selected text from the message view 
         or the compose window to the command standard input. The command 
@@ -198,9 +207,9 @@ are hardly noticable, but deserve mentioning:
   be insensitive to any interaction and it will wait for the command to 
   finish. If the command takes too long (5 seconds), it will popup a dialog 
   window allowing to stop it. This dialog will also be displayed as soon as
-  the command has some ouput: error messages or even its standard output 
+  the command has some output: error messages or even its standard output 
   when the command is not a "pipe-out" command. When multiple commands are 
-  being run, they are run in parallel and each command ouput is separated 
+  being run, they are run in parallel and each command output is separated 
   from the outputs of the others.
 
   a. Examples
@@ -224,7 +233,7 @@ are hardly noticable, 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
@@ -233,7 +242,7 @@ are hardly noticable, but deserve mentioning:
                unneeded message parts, etc.
 
   Purpose:     Pretty format
-  Definition:  Par: |par 72Tbgjqw74bEe B=._A_a 72bg
+  Definition:  Par: |par 72Tbgjqw74bEe B=._A_a 72bg|
   Details:     par is a utility that can pretty format any text. It does a 
                very good job in indenting quoted messages, and justifying 
                text. Used when composing a message
@@ -243,12 +252,12 @@ are hardly noticable, 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,17 +266,14 @@ are hardly noticable, 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 guudecode 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
 -----------------------------------
@@ -355,7 +361,7 @@ are hardly noticable, but deserve mentioning:
   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
-  of latin alphabet (if this does not suit your language, please send
+  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
@@ -364,10 +370,10 @@ are hardly noticable, but deserve mentioning:
 
   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.
+  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 misktakes 'feature' 
-  (useful only with aspell).
+  Finally, you can change the suggestion mode, and the learn from
+  misktakes feature (only when using an aspell dictionary).
 
   Spell checking can also be done using keyboard shortcuts.  In the
   "Edit" menu of the compose window, there are two menus "Check backwards
@@ -416,6 +422,7 @@ are hardly noticable, 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
@@ -425,9 +432,54 @@ are hardly noticable, 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
@@ -451,7 +503,7 @@ Sylpheed Claws:
        Bugs can be reported in the same way; the recommended web page:
        http://sourceforge.net/tracker/?group_id=25528&atid=384598
 
-       Ofcourse you can also post to the sylpheed claws users
+       Of course you can also post to the sylpheed claws users
        mailing list.
 
 Also, we really try to incorporate good contributions, but sometimes we
@@ -501,7 +553,7 @@ sourceforge project page.
   make install         [as root]
 
   You will need a full set of development tools installed to be able to run
-  autogen.sh.
+  autogen.sh. See also ac/README.
 
 7. History
 ----------