2004-11-17 [colin] 0.9.12cvs150
[claws.git] / README.claws
index cdaf9c9..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
@@ -285,11 +285,19 @@ are hardly noticeable, but deserve mentioning:
   a. Requirements
   ---------------
 
-  The spell checker in sylpheed requires the new GNU/aspell library
+  Note:
+  As for version 0.8.3 (and cvs version 0.8.2claws3), Sylpheed-Claws uses
+  the new GNU/aspell 0.50 for spell checking instead of the obsolete pspell
+  and old aspell 0.33.x.  You will need to upgrade your system.  See
+  http://www.gnu.org/software/aspell for instructions on how to do this.
+
+  The spell checker in Sylpheed requires the new GNU/aspell library
   (http://www.gnu.org/software/aspell), version 0.50 or newer.
 
   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.
 
   b. Configuring Sylpheed
   -----------------------
@@ -306,18 +314,21 @@ are hardly noticeable, but deserve mentioning:
 
   ./configure --enable-aspell --with-aspell-prefix=/foo/bar
 
-  If ./configure cannot find the includes or libraries of aspell,
-  check first where these are located, and add either following options:
+  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 manually the includes and libraries path by using
+  either following options:
 
   --with-aspell-includes=/foo/bar/include
 
-  or 
+  and/or 
 
-  --with-aspell-libs=/foo/bar/lib
+  --with-aspell-libs=/rab/oof/lib
 
   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'.
@@ -325,13 +336,15 @@ are hardly noticeable, but deserve mentioning:
   c. Usage
   --------
 
-  NOTE: if you upgraded from 0.8.1claws or earlier, please reselect 
-  your default dictionary in the preferences.
+  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
+  it accordingly as explained below.
 
   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 their path.
+  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' and
@@ -343,14 +356,14 @@ are hardly noticeable, but deserve mentioning:
   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. 
+  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). Aspell has a 'learn from mistake'
+  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'). 
@@ -363,24 +376,24 @@ are hardly noticeable, but deserve mentioning:
   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
   -----------------
 
-    No known problems as the time of this writing.
+    No known problems as the time of this writing (0.8.2claws3).
 
 * simplify subject string
 -----------------------------------
@@ -431,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
@@ -461,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.
@@ -496,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