sync with 0.8.10cvs23
[claws.git] / README.claws
index da13f7996547f40546b70896adebb967eb3eed03..3335d435a97454dca0fabc61d1e6f3a1c1cf210c 100644 (file)
@@ -19,6 +19,8 @@ Summary:
    * spell checking (with installation instructions)
    * new cache
    * selective download, delete messages on server
+   * extended search in quick search
+   * 'dynamic' signatures
 4. How to contribute
 5. How to request features
 6. Installing Claws from CVS
@@ -58,14 +60,13 @@ Sylpheed or Main.
   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.
   * What happened to the compose email and compose news buttons? 
 
     There's a composite button for both composing mail and news. You can toggle
@@ -453,7 +454,94 @@ mention it.
       subject match "SPAM" delete_on_server
     Next time, you retrieve the headers using selective download,
     all messages that matched this criteria are marked.
-
+    NOTE: Selective download is a pop3 only feature and makes 
+         no sense if used as a folder processing filter.
+
+* Custom toolbar
+----------------
+   Configuration->Custom toolbar 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 may as well have your "Sylpheed Actions"
+   (refer to "user definable 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
+
+* extended search in quick search
+---------------------------------
+    This feature allows one to define criteria that messages have
+    to match in order to 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 recognize 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
+    
+* 'dynamic' signatures
+----------------------
+    To use program output, e.g. fortune, as a message signature
+    use a | (pipe) symbol. For example, in the Account Preferences
+    'Compose' tab, enter the following in the Signature File box:
+
+    | /usr/games/fortune 
 
 
 4. How to contribute