2011-10-09 [colin] 3.7.10cvs27
[claws.git] / README
diff --git a/README b/README
index c2c1575f3bd10fbec442060c73a6ddf385816201..a6e4fe480446e9c1783efe73bd29f33abd728bd1 100644 (file)
--- a/README
+++ b/README
@@ -2,12 +2,12 @@ Claws Mail - a GTK+ based, lightweight, and fast e-mail client
 
 ---------------------------------------------------------------------
 
-   Copyright(C) 1999-2007 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp> and the
+   Copyright(C) 1999-2010 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp> and the
    Claws Mail Team
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2, or (at your option)
+   the Free Software Foundation; either version 3, or (at your option)
    any later version.
 
    This program is distributed in the hope that it will be useful,
@@ -29,17 +29,16 @@ Summary:
  2. Plugins
  3. Actions
  4. Icon Themes
- 5. Spell Checking
- 6. Quick Search
- 7. Custom toolbar
- 8. Partial downloading of POP3 mails
- 9. Hidden Options
-10. Tools
-11. How to contribute
-12. How to request features
-13. Installing Claws from CVS
-14. Release History
-15. Useful Links
+ 5. Quick Search
+ 6. Custom toolbar
+ 7. Partial downloading of POP3 mails
+ 8. Hidden Options
+ 9. Tools
+10. How to contribute
+11. How to request features
+12. Installing Claws from CVS
+13. Release History
+14. Useful Links
 
 
 1. What is Claws Mail?
@@ -70,15 +69,15 @@ and have a suffix of '.so'
 To load a plugin go to '/Configuration/Plugins' and click
 the 'Load Plugin' button.
 Select the plugin that you want and click 'OK'
+
+  o Bogofilter
+    Enables the scanning of incoming mail received from a POP,
+    IMAP, or LOCAL account using Bogofilter. It can optionally
+    delete mail identified as spam or save it to a designated folder.
+    Bogofilter is a pure Bayesian filter, therefore it has better
+    speed performance than SpamAssassin but might catch less spam.
+    Bogofilter is available from http://bogofilter.sourceforge.net/ 
  
-  o Clam AntiVirus
-    Enables the scanning of message attachments in mail
-    received from a POP, IMAP or LOCAL account using Clam 
-    AntiVirus. It can optionally delete the mail or save it 
-    to a designated folder. Preferences can be found in 
-    '/Configuration/PreferencesPlugins/Clam AntiVirus'.
-    Clam AntiVirus is available from http://clamav.sourceforge.net/
-  
   o Dillo HTML Viewer 
     Enables the viewing of html messages using the Dillo web
     browser, version 0.7.0 or newer. It uses Dillo's --local
@@ -101,6 +100,10 @@ Select the plugin that you want and click 'OK'
     decrypt mails, verify signatures or sign and encrypt your
     own mails. Uses GnuPG/GPGME, <ftp://ftp.gnupg.org/gcrypt/gpgme/>
 
+  o S/MIME
+    This plugin handles S/MIME signed and/or encrypted mails. You can
+    decrypt mails, verify signatures or sign and encrypt your own mails.
+
   o SpamAssassin
     Enables the scanning of incoming mail received from a POP,
     IMAP or LOCAL account using SpamAssassin. It can optionally 
@@ -243,108 +246,9 @@ http://www.claws-mail.org/plugins.php
   to select them, /Configuration/Preferences/Display/Themes
 
   This interface can also be used to install new themes.
-
-
-
-5. Spell Checking
------------------
-  a. Requirements
-  b. Configuration and installation
-  c. Usage
-  d. Known problems
-
-  a. Requirements
-  ---------------
-
-  The spell checker in Claws Mail requires the 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 Claws
-  --------------------
-
-  Spell checking is enabled automatically if the aspell executable is
-  found. If it is in unusual places, use '--with-aspell-prefix' to state
-  the path to the aspell executable.  E.g., if aspell's full path is
-  /foo/bar/bin/aspell, then use:
-
-  ./configure --with-aspell-prefix=/foo/bar
-
-  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 manually specify the includes and libraries path by using
-  either following options:
-
-  --with-aspell-includes=/foo/bar/include
-
-  and/or 
-
-  --with-aspell-libs=/rab/oof/lib
-
-  as appropriate.
-
-  The configure script summarizes the options compiled in.  Check that
-  it lists 'GNU/aspell = yes'.
-
-  Then proceed as usual, with 'make' and 'make install'.
-
-  c. Usage
-  --------
-
-  After successful compiling, you need to tell Claws Mail 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 the
-  path to the dictionaries.
-
-  Then run claws-mail and go to /Configuration/Preferences/Compose/Spell Checking.
-  Check the box 'Enable spell checker' and use the directory selector to select
-  the path where the dictionaries reside.  Within the file selector, go to that
-  directory and select *any* file in the file lists.  Click OK. Then, you should
-  be able to select your default dictionary.
-
-  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 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'
-  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'). 
-
-  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.
-  With this menu, you can also change the dictionary while editing.
-  Finally, you can change the suggestion mode, and the learn from
-  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' 
-  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 
-  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.
   
 
-6. Quick Search with extended search
+5. Quick Search with extended search
 ------------------------------------
     Quick Search, with its powerful Extended search function,
     enables searching through folder's messages.
@@ -378,6 +282,7 @@ http://www.claws-mail.org/plugins.php
     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
+    k       #          messages which are marked with color #
     L                   locked messages
     n        S          messages which are in newsgroup S
     N                   new messages
@@ -392,11 +297,22 @@ http://www.claws-mail.org/plugins.php
     Sg       #          messages whose size is greater than #
     Ss       #          messages whose size is smaller than #
     t        S          messages which have been sent to S
+    tg       S         messages with tags containing S
+    tagged             messages which are tagged
     T                   marked messages
     U                   unread messages
     x        S          messages which contain S in References header
+    x        "cmd args" messages returning 0 when passed to command
+                       - %F is message file
     y        S          messages which contain S in X-Label header
 
+    &       logical AND operator
+    |        logical OR operator
+    ! or ~   logical NOT operator
+    %        case sensitive search
+
+    all filtering expressions are allowed
+
     # means number
     S means regexp string
 
@@ -411,7 +327,7 @@ http://www.claws-mail.org/plugins.php
     f foo & ~s bar     messages from foo that do not have bar in thesubject
 
 
-7. Custom toolbar
+6. Custom toolbar
 -----------------
 
    /Configuration/Preferences/Customize Toolbars lets you define the
@@ -430,7 +346,7 @@ http://www.claws-mail.org/plugins.php
 
 
     
-8. Partial downloading of POP3 mails
+7. Partial downloading of POP3 mails
 ------------------------------------
   Messages over the configured size limit, (/[Account preferences]/
   Receive/Message size limit), will be partially retrieved. These
@@ -447,49 +363,57 @@ http://www.claws-mail.org/plugins.php
   Trash folder has been emptied.
 
 
+8. Hidden options
+-----------------
 
+    It is recommnede that you use Clawsker to edit these options,
+    http://www.claws-mail.org/clawsker
 
-9. Hidden options
------------------
+    addressbook_use_editaddress_dialog (default: 1)
+       Use a separate dialogue to edit a person's details. '0'
+       will use a form embedded in the addressbook's main window.
+       0: off  1: on
 
     bold_unread                        (default: 1)
        show unread messages using bold font in summary view
        0: off  1: on
 
     cache_max_mem_usage                (default: 4096)
-       the maximum kB of memory Claws Mail 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.
+       the maximum kB of memory Claws Mail 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 Claws Mail 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 minimum time in minutes Claws Mail 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.
 
     compose_no_markup          (default: 0)
-       prevent italic and bold text in the Compose dialog
-       account selector
+       prevent italic and bold text in the Compose dialog account
+       selector
        0: normal (markup) 1: no markup
 
+    emphasis_color             (default: #0000CF)
+       The colour used for the X-Mailer line when its value is
+       Claws Mail.
+
     enable_dotted_lines                (default: 0)
-       Use the old dotted line look in the main window
-       GtkTreeView components, (Folder List and Message List),
-       instead of the modern lineless look. 
+       Use the old dotted line look in the main window GtkTreeView
+       components, (Folder List and Message List), instead of the
+       modern lineless look. 
+       0: off  1: on
 
     enable_hscrollbar          (default: 1)
        enable horizontal scroll bar in summary view
        0: off  1: on
 
     enable_swap_from           (default: 0)
-       display sender's email address in To column in Sent
-       folder instead of recipient's
+       display sender's email address in To column in Sent folder
+       instead of recipient's
        0: off  1: on
 
     folderview_vscrollbar_policy        (default: 0)
@@ -497,32 +421,55 @@ http://www.claws-mail.org/plugins.php
        0: always  1: automatic  2: never
 
     hover_timeout                      (default: 500)
-       time in milliseconds that will cause a folder tree to
-       expand during drag n drop when the mouse cover is held
-       over it
+       time in milliseconds that will cause a folder tree to expand
+       during drag n drop when the mouse cover is held over it
 
     live_dangerously                   (default: 0)
        Don't ask for confirmation before definitive deletion of
        emails.
+       0: off  1: on
 
-    log_error_color, log_in_color, log_msg_color, log_out_color,
-    log_warn_color
-       The colours used in the log window.  
+    log_error_color                    (default: #af0000)
+    log_in_color                       (default: #000000)
+    log_msg_color                      (default: #00af00)
+    log_out_color                      (default: #0000ef)
+    log_warn_color                     (default: #af0000)
+    log_status_ok_color                        (default: #00af00)
+    log_status_nok_color               (default: #0000af)
+    log_status_skip_color              (default: #aa00aa)
+       The colours used in the Network Log window.  
+
+    outgoing_fallback_to_ascii         (default: 1)
+       The outgoing encoding of a message will use 7bit US-ASCII
+       whenever it is suitable for the message content, ignoring
+       the "Outgoing encoding" option unless it is necessary.
+       Turning this option off forces the user-defined encoding to
+       be used, regardless of message content.
+       0: off  1: on
 
-    mark_as_read_delay                 (default: 0)
-       Number of seconds to wait before marking an opened mail
-       as read.
+    primary_paste_unselects            (default: 0)
+       Causes the primary buffer to be cleared and the insertion
+       point to be repositioned when the middle mouse button is used
+       for pasting text.
+       0: off  1: on   
 
     respect_flowed_format              (default: 0)
        Respect format=flowed on text/plain message parts. This will
        cause some mails to have long lines, but will fix some URLs
        that would otherwise be wrapped.
+       0: off  1: on
  
+    save_parts_readwrite               (default: 0)
+       Saves temporary files when opening attachment with write bit
+       set.
+       0: off  1: on
+
     skip_ssl_cert_check                        (default: 0)
-       Disables the verification of SSL certificates. 
+       Disables the verification of SSL certificates.
+       0: off  1: on
 
     statusbar_update_step              (default: 10)
-       update stepping in progress bars
+       update stepping in progress bars.
 
     stripes_color_offset               (default: 4000)
        Specify the value to use when creating alternately coloured
@@ -531,36 +478,52 @@ http://www.claws-mail.org/plugins.php
        lines. 
 
     textview_cursor_visible            (default: 0)
-       display the cursor in the message view
+       display the cursor in the message view.
        0: off  1: on
 
     thread_by_subject_max_age          (default: 10)
        number of days to include a message in a thread when using
-       'Thread using subject in addition to standard headers'
+       'Thread using subject in addition to standard headers'.
 
     toolbar_detachable                 (default: 0)
-       hide handles in the toolbar
+       hide handles in the toolbar.
+       0: off  1: on
+
+    two_line_vertical                  (default: 1)
+       Spread message list information over two lines when using the
+       three column layout.
+       0: off  1: on
+
+    unsafe_ssl_certs                   (default: 0)
+       Allows Claws to remember multiple SSL certificates for a
+       given server/port.
+       0: off  1: on
+
+    use_networkmanager                 (default: 1)
+       Use NetworkManager to switch offline automatically.
        0: off  1: on
 
     use_stripes_everywhere             (default: 1)
-       Enable alternately coloured lines in GtkTreeView components. 
+       Enable alternately coloured lines in GtkTreeView components.
+        0: off  1: on
 
     use_stripes_in_summaries           (default: 1)
        Enable alternately coloured lines in the main window
        GtkTreeView components, (Folder List and Message List). The
        only useful way to use this option is to set it to 0 when
-       use_stripes_everywhere is set to 1. 
+       use_stripes_everywhere is set to 1.
+        0: off  1: on
 
     utf8_instead_of_locale_for_broken_mail     (default: 0)
-       use UTF-8 encoding for broken mails instead of current
-       locale
+       Use UTF-8 encoding for broken mails instead of current
+       locale.
        0: off  1: on
 
     warn_dnd                   (default: 1)
-       display a confirmation dialog on drag n drop of folders
+       Display a confirmation dialog on drag'n'drop of folders.
        0: off  1: on
 
-10. Tools
+9. Tools
 --------- 
   You will find all of these tools in the 'tools' directory:
 
@@ -568,8 +531,13 @@ http://www.claws-mail.org/plugins.php
        send PDFs from Adobe Reader 7
   calypso_convert.pl 
        import mbox files exported by calypso
+  claws-mail-compose-insert-files.pl
+       insert files into a new Compose window
   convert_mbox.pl
        convert mbox format to MH format
+  csv2addressbook.pl
+       import Becky, Thunderbird, Kmail, Gmail and Fox Mail
+       address books
   eud2gc.py
        convert a Eudora (v.3?) addressbook to vCard 
        (GnomeCard) format
@@ -602,8 +570,13 @@ http://www.claws-mail.org/plugins.php
   kmail2claws-mail_v2.pl
        new version of the address book conversion script
        for newer versions of Kmail/Kaddressbook
-  maildir2claws-mail.pl
-       convert a maildir format mailbox into MH format
+  kmail-mailbox2claws-mail.pl
+       convert a Kmail mailbox into a Claws mail mailbox
+  mairix.sh
+       a wrapper to mairix, to enable global searches in mail
+       folders
+  mew2claws-mail.pl
+       import a Mew address book
   multiwebsearch.pl
        search any searchable website for the selected text
   nautilus2claws-mail.sh
@@ -615,6 +588,8 @@ http://www.claws-mail.org/plugins.php
   outlook2claws-mail.pl
        convert an Outlook contacts list to a Claws Mail
        addressbook
+  popfile-link.sh
+       open messages in POPFile control center to edit their status
   sylprint.pl
        process a Claws Mail message and print it using enscript
        if available or lpr if not
@@ -623,8 +598,12 @@ http://www.claws-mail.org/plugins.php
        a Claws Mail addressbook
   tbird2claws.py
        integrate a Thunderbird folder tree into Claws Mail
+  textviewer.pl
+       Display various attachments as text
   textviewer.sh
        attempt to view an attachment as plain text
+  thunderbird-filters-convertor.pl
+       convert Thunderbird filtering rules
   update-po 
        translators' tool that eases the creation of 
        *.po files
@@ -636,12 +615,13 @@ http://www.claws-mail.org/plugins.php
        import an Evolution vCard
 
 
-11. How to contribute
+10. How to contribute
 ---------------------
 
-You are encourged to send patches via the Claws Mail sourceforge
-project's Patch Tracker.
-http://sourceforge.net/tracker/?atid=384600&group_id=25528&func=browse
+You are encourged to send patches via the Claws Mail bugzilla at
+http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
+But please first read the patch guidelines here:
+http://www.claws-mail.org/devel.php
 
 If that's too troublesome, either contact Paul Mangan
 <paul@claws-mail.org> or consider posting to the
@@ -661,20 +641,19 @@ Claws Mail CVS tree.
 
 
 
-12. How to request features
+11. How to request features
 ---------------------------
 
 Ask around in Claws Mail-users ML. Note that some developers may
-have already thought about your feature, may,perhaps, be implementing it,
-or the feature was already discussed and rejected for whatever reason.
+have already thought about your feature and may, perhaps, be implementing
+it, or the feature was already discussed and rejected for whatever reason.
 You might want to go ahead and hack a patch for it. (That would be very
-cool!) Another possibility is to use the Feature Request Tracker at the
-sourceforge project.
-http://sourceforge.net/tracker/?group_id=25528&atid=384601
-
+cool!) Another possibility is to add a request to our bugzilla, (severity:
+'enhancement'), at
+http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 
 
-13. Installing Claws Mail from CVS
+12. Installing Claws Mail from CVS
 --------------------------------------
 
   a. Downloading
@@ -683,14 +662,14 @@ http://sourceforge.net/tracker/?group_id=25528&atid=384601
   To download the latest cvs cd to the directory where you wish to download
   to and type the following information:
 
-  cvs -z3 -d:pserver:cvs@sunsite.dk:/pack/anoncvs login
-
-  The password is cvs
-
-  After logging in:
+  export CVS_RSH=ssh
+  cvs -z3 -d:pserver:anonymous@claws-mail.org:/ co -r gtk2 claws 
 
-   cvs -z3 -d:pserver:cvs@sunsite.dk:/pack/anoncvs co -r gtk2 sylpheedclaws/sylpheed-claws
+  Later, when you want to update your local repository, you'll just have to
+  go back to the 'claws' directory, and type:
 
+  export CVS_RSH=ssh
+  cvs -z3 update -dPR 
 
   b. Installing
   -------------
@@ -706,11 +685,40 @@ http://sourceforge.net/tracker/?group_id=25528&atid=384601
 
 
 
-14. Release History
+13. Release History
 -------------------
 
 GTK 2 Version
 -------------
+2011-08-27     3.7.10
+2011-04-09     3.7.9
+2010-12-04     3.7.8
+2010-11-19     3.7.7
+2010-05-01     3.7.6
+2010-01-31     3.7.5
+2010-01-08     3.7.4
+2009-10-09     3.7.3
+2009-07-03     3.7.2
+2009-03-06     3.7.1
+2008-12-19     3.7.0
+2008-10-10     3.6.1
+2008-10-03     3.6.0
+2008-06-27     3.5.0
+2008-04-18     3.4.0
+2008-02-23     3.3.1
+2008-02-08     3.3.0
+2007-12-17     3.2.0
+2007-11-19     3.1.0
+2007-10-02     3.0.2
+2007-09-17     3.0.1
+2007-09-03     3.0.0
+2007-07-02     2.10.0
+2007-05-08     2.9.2
+2007-04-19     2.9.1
+2007-04-16     2.9.0
+2007-03-06     2.8.1
+2007-02-26     2.8.0
+2007-01-26     2.7.2
 2007-01-15     2.7.1
 2007-01-08     2.7.0
 2006-12-04     2.6.1 [first release as Claws Mail]
@@ -794,7 +802,7 @@ GTK 1 Version
 
 
 
-15. Useful links
+14. Useful links
 ----------------
 Homepage
     http://www.claws-mail.org/
@@ -808,20 +816,14 @@ Extra Plugins
     http://www.claws-mail.org/plugins.php
 Icon Themes
     http://www.claws-mail.org/themes.php
-CVS webview
-    http://cvs.sunsite.dk/viewcvs.cgi/sylpheedclaws/sylpheed-claws/?only_with_tag=gtk2
 Mailing Lists
     http://www.claws-mail.org/MLs.php
 Users Mailing List archive
-    http://lists.sunsite.dk/cgi-bin/ezmlm-cgi/28
+    http://lists.claws-mail.org/pipermail/users/index.html
 Commits Announcement List archive
-    http://lists.sunsite.dk/cgi-bin/ezmlm-cgi/27
-Bug Tracker
+    http://lists.claws-mail.org/pipermail/commits/index.html
+Bug/Patch/Feature Request Tracker
     http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
-Feature Request Tracker
-    http://sourceforge.net/tracker/?group_id=25528&atid=384601
-Patch Tracker
-    http://sourceforge.net/tracker/?group_id=25528&atid=384600
 Internationalisation Status
     http://www.claws-mail.org/i18n.php
 Donations