2004-11-17 [colin] 0.9.12cvs150
[claws.git] / README.claws
index b7e0bdf..6581c33 100644 (file)
@@ -18,7 +18,8 @@ Summary:
    * user definable actions
    * 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 +59,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
@@ -314,10 +314,10 @@ are hardly noticeable, but deserve mentioning:
 
   ./configure --enable-aspell --with-aspell-prefix=/foo/bar
 
-  Using the '--with-aspell-prefix=PREFIX' option will let the configure
-  script look for includes and libraries in PREFIX/include and PREFIX/lib.
+  The '--with-aspell-prefix=PREFIX' option will let the configure
+  script search for includes and libraries in PREFIX/include and PREFIX/lib.
 
-  You can also specify manualle the includes and libraries path by using
+  You can also specify manually the includes and libraries path by using
   either following options:
 
   --with-aspell-includes=/foo/bar/include
@@ -328,7 +328,7 @@ are hardly noticeable, but deserve mentioning:
 
   as appropriate.
 
-  The configure script summarizes the options compiled in. Check that
+  The configure script summarizes the options compiled in.  Check that
   it lists 'GNU/aspell = yes'.
 
   Then proceed as usual, with 'make' and 'make install'.
@@ -339,7 +339,7 @@ are hardly noticeable, but deserve mentioning:
   NOTE: if you upgraded from Sylpheed-Claws 0.8.2 (or cvs version 0.8.2claws2) 
   or earlier, please check if the dictionary path was updated in the
   Configuration -> Common Preferences -> Spell Checker menu.  If not, update
-  accordingly as explained below.
+  it accordingly as explained below.
 
   After successful compiling, you need to tell Sylpheed where your
   dictionaries reside. The configure script should have found it,
@@ -444,16 +444,92 @@ are hardly noticeable, but deserve mentioning:
 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.
-
+* 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
+
+* (build in) image viewer
+-----------------------
+    Claws allows to load viewers for mime parts with plugins. To keep
+    the main programs code small and easier to maintain by defining an
+    API for viewers and not having to include every viewer in the code
+    the build in image viewer was removed and put into a plugin. If you
+    wonder why image viewing is not working anymore you probably have
+    to load the plugin.
 
 
 4. How to contribute
@@ -474,8 +550,8 @@ Sylpheed Claws:
        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
+       Bugs can be reported with Claws' bugzilla at:
+       http://sylpheed-claws.sourceforge.net/cgi-bin/bugzilla/index.cgi
 
        Of course you can also post to the sylpheed claws users
        mailing list.
@@ -509,12 +585,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 sylpheed-claws 
 
 
   b. Installing