2007-09-28 [paul] 3.0.1cvs37
[claws.git] / README
diff --git a/README b/README
index 745d10584fdd511692cdf48a1954803ce305c081..eefc73ac56abf433be423a2db99096f7fc32edf2 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,13 @@
-
-[LAST REVISION: 2006-07-31]
-
-Sylpheed-Claws - a GTK+ based, lightweight, and fast e-mail client
+Claws Mail - a GTK+ based, lightweight, and fast e-mail client
 
 ---------------------------------------------------------------------
 
-   Copyright(C) 1999-2006 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp> and the
-   Sylpheed-Claws Team
+   Copyright(C) 1999-2007 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,
@@ -28,7 +25,7 @@ Sylpheed-Claws - a GTK+ based, lightweight, and fast e-mail client
 
 Summary:
 
- 1. What is Sylpheed-Claws?
+ 1. What is Claws Mail?
  2. Plugins
  3. Actions
  4. Icon Themes
@@ -45,30 +42,30 @@ Summary:
 15. Useful Links
 
 
-1. What is Sylpheed-Claws?
+1. What is Claws Mail?
 --------------------------
 
-Sylpheed-Claws is the extended version of Sylpheed, a lightweight and
-highly configurable email client and news reader based on the GTK+ GUI
-toolkit, it runs on the X Window System.
+Claws Mail (previously known as Sylpheed-Claws) is a lightweight and
+highly configurable email client and news reader based on the GTK+
+GUI toolkit, it runs on the X Window System.
 
-Sylpheed-Claws is free software distributed under the GNU GPL.
+Claws Mail is free software distributed under the GNU GPL.
 
-To run Sylpheed-Claws use 'sylpheed-claws' on the command line.
+To run Claws Mail use 'claws-mail' on the command line.
 
-When sylpheed-claws is executed for the first time a configuration
-'Wizard' will appear prompting you for the minimum information necesary
-to create a new account.
+When claws-mail is executed for the first time a configuration
+'Wizard' will appear prompting you for the minimum information
+necessary to create a new account.
 
 
 2. Plugins
 ----------
 
-Sylpheed-Claws' capabilities are extended by plugins. It comes with
-the following plugins included, all of which, except SpamAssassin, are
-built automatically if the required libraries are present.
+Claws Mail' capabilities are extended by plugins. It comes with
+the following plugins included, all of which are built automatically
+if the required libraries are present.
 
-Plugins are installed in $PREFIX/lib/sylpheed-claws/plugins/
+Plugins are installed in $PREFIX/lib/claws-mail/plugins/
 and have a suffix of '.so'
 To load a plugin go to '/Configuration/Plugins' and click
 the 'Load Plugin' button.
@@ -118,7 +115,7 @@ Select the plugin that you want and click 'OK'
     new, unread and total number of messages
 
 Additonal plugins can be found here:
-http://www.sylpheed-claws.net/plugins.php
+http://www.claws-mail.org/plugins.php
 
 
 3. Actions
@@ -128,8 +125,8 @@ http://www.sylpheed-claws.net/plugins.php
   just one of its parts. It allows also the use of an external command to 
   filter the whole text or just a selected part in the message window or in 
   the compose window. This is a generic tool that allows to do any uncommon 
-  actions on the messages, and thus extends the possibilities of Sylpheed-Claws
-  For example, Sylpheed-Claws does not include the rot13 cyphering algorithm 
+  actions on the messages, and thus extends the possibilities of Claws Mail
+  For example, Claws Mail does not include the rot13 cyphering algorithm 
   popular in some newsgroups. It does not support uuencoded messages. As 
   all these features can be handled by external programs, the actions 
   provide a convenient way to use them from the menu bar.
@@ -142,7 +139,7 @@ http://www.sylpheed-claws.net/plugins.php
   command. The created menu will be found in the Tools -> Actions submenu. 
   By inserting a slash / in the menu name, you create a submenu.
 
-  The command is entered in the Command line entry. Note that Sylpheed-Claws
+  The command is entered in the Command line entry. Note that Claws Mail
   stores every single email in a separate file. This allows to use the 
   following syntax for the command:
 
@@ -166,7 +163,7 @@ http://www.sylpheed-claws.net/plugins.php
         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-Claws won't wait for the
+        That means "fire and forget". Claws Mail won't wait for the
         command to finish, nor will it catch its output or its error
         messages.
     * Prepending the vertical bar | (pipe-in): this will send the current 
@@ -181,8 +178,8 @@ http://www.sylpheed-claws.net/plugins.php
   Note: It is not possible to use actions containing %f, %F or %p from the
   compose window. 
 
-  When a command is run, and unless it is run asynchronously, Sylpheed will
-  be insensitive to any interaction and it will wait for the command to 
+  When a command is run, and unless it is run asynchronously, Claws Mail
+  will 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 output: error messages or even its standard output 
@@ -195,7 +192,7 @@ http://www.sylpheed-claws.net/plugins.php
 
   Here are some examples that are listed in the same syntax as used for 
   storing the actions list. You can copy and past the definition in your 
-  ~/.sylpheed-claws/actionsrc file (exit Sylpheed-Claws before). The syntax
+  ~/.claws-mail/actionsrc file (exit Claws Mail before). The syntax
   is very simple: one line per action, each action contains the menu name
   and the command line separated by a colon and a space ": "
 
@@ -229,20 +226,6 @@ http://www.sylpheed-claws.net/plugins.php
   Definition:  Part/Dillo: dillo %p&
   Details:     Browse the selected message part in Dillo.
 
-  Purpose:     Clear Sign
-  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
-  Details:     Verify clear signed messages. The result is displayed in the
-               actions output dialog.
-
-  Purpose:     Decrypt ASCII Armored
-  Definition:  GnuPG/Decrypt: *gpg --no-tty --command-fd 0 --passphrase-fd 0 --decrypt %f|
-  Details:     Decrypt ASCII armored messages. The passphrase is entered 
-               into the opened action's input dialog.
 
   [1] The uudec script can be found in the 'tools' directory of the 
   distribution package. It needs uudecode and ImageMagick's display. The 
@@ -250,15 +233,11 @@ http://www.sylpheed-claws.net/plugins.php
   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. 
-
-
 
 4. Icon Themes
 --------------
   Claws has support for different icon sets. Several icon sets can be
-  downloaded from http://www.sylpheed-claws.net/themes.php
+  downloaded from http://www.claws-mail.org/themes.php
   You will need to create a directory called 'themes' in your config
   directory, unpack them into this directory, and then use the interface
   to select them, /Configuration/Preferences/Display/Themes
@@ -277,7 +256,7 @@ http://www.sylpheed-claws.net/plugins.php
   a. Requirements
   ---------------
 
-  The spell checker in Sylpheed-Claws requires the GNU/aspell library
+  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
@@ -317,12 +296,12 @@ http://www.sylpheed-claws.net/plugins.php
   c. Usage
   --------
 
-  After successful compiling, you need to tell Sylpheed-Claws where your
+  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 Sylpheed and go to /Configuration/Preferences/Compose/Spell Checking.
+  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
@@ -373,10 +352,10 @@ http://www.sylpheed-claws.net/plugins.php
     Extended Search allows one to define criteria that messages must
     have in order to match and 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
+    Search type extended allows one to use Claws Mail's powerful
     filtering engine to select messages. Examples:
     from regexpcase "foo"
-    subject regexp "Bug" & to regexp "sylpheed-claws"
+    subject regexp "Bug" & to regexp "claws-mail"
 
     Additionally, it is possible to use simpler yet equally
     powerfull patterns for message selections. Mutt users will
@@ -438,14 +417,14 @@ http://www.sylpheed-claws.net/plugins.php
    /Configuration/Preferences/Customize Toolbars 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 can also have your "Sylpheed-Claws Actions"
+   from are predefined. You can also have your "Claws Mail Actions"
    (refer to "Actions" above) on your toolbar.
 
    Example: 
        * Configuration->Actions 
                - add an entry "Dillo: dillo %p&"
         * Configuration->Custom toolbar    
-               - select Sylpheed Actions Feature
+               - select Claws Mail Actions Feature
                - select "Dillo: dillo %p&" from drop down list
                - choose an icon and click ok
 
@@ -473,22 +452,18 @@ http://www.sylpheed-claws.net/plugins.php
 9. Hidden options
 -----------------
 
-    allow_jisx0201_kana                (default: 0)
-       allow JIS X 0201 Kana (half-width kana) on sending.
-       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 sylpheed should use.
+       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 sylpheed will keep
+       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
@@ -503,14 +478,15 @@ http://www.sylpheed-claws.net/plugins.php
        account selector
        0: normal (markup) 1: no markup
 
+    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. 
+
     enable_hscrollbar          (default: 1)
        enable horizontal scroll bar in summary view
        0: off  1: on
 
-    enable_rules_hint          (default: 1)
-       enable alternate coloring of items in GtkTreeView
-       0: off  1: on
-
     enable_swap_from           (default: 0)
        display sender's email address in To column in Sent
        folder instead of recipient's
@@ -525,9 +501,35 @@ http://www.sylpheed-claws.net/plugins.php
        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.
+
+    log_error_color, log_in_color, log_msg_color, log_out_color,
+    log_warn_color
+       The colours used in the log window.  
+
+    mark_as_read_delay                 (default: 0)
+       Number of seconds to wait before marking an opened mail
+       as read.
+
+    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.
+    skip_ssl_cert_check                        (default: 0)
+       Disables the verification of SSL certificates. 
+
     statusbar_update_step              (default: 10)
        update stepping in progress bars
 
+    stripes_color_offset               (default: 4000)
+       Specify the value to use when creating alternately coloured
+       lines in GtkTreeView components. The smaller the value, the
+       less visible the difference in the alternating colours of the
+       lines. 
+
     textview_cursor_visible            (default: 0)
        display the cursor in the message view
        0: off  1: on
@@ -536,10 +538,19 @@ http://www.sylpheed-claws.net/plugins.php
        number of days to include a message in a thread when using
        'Thread using subject in addition to standard headers'
 
-    toolbar_detachable         (default: 0)
+    toolbar_detachable                 (default: 0)
        hide handles in the toolbar
        0: off  1: on
 
+    use_stripes_everywhere             (default: 1)
+       Enable alternately coloured lines in GtkTreeView components. 
+
+    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. 
+
     utf8_instead_of_locale_for_broken_mail     (default: 0)
        use UTF-8 encoding for broken mails instead of current
        locale
@@ -553,7 +564,7 @@ http://www.sylpheed-claws.net/plugins.php
 --------- 
   You will find all of these tools in the 'tools' directory:
 
-  acroread2sylpheed.pl 
+  acroread2claws-mail.pl 
        send PDFs from Adobe Reader 7
   calypso_convert.pl 
        import mbox files exported by calypso
@@ -568,6 +579,8 @@ http://www.sylpheed-claws.net/plugins.php
   filter_conv_new.pl
        convert sylpheed main's filter rules, (>= 0.9.99),
        into Claws' filtering format
+  fix-date.sh
+       Replace/Add a message's Date field
   freshmeat_search.pl
        Actions script to lookup the selected text on
        Freshmeat www.freshmeat.net using the configured
@@ -580,80 +593,82 @@ http://www.sylpheed-claws.net/plugins.php
   google_search.pl
        Actions script to lookup up the selected text on
        google using the configured browser
-  gpg-sign-syl
-       GnuPG cleartext-signing script for use with
-       Actions
   kdeservicemenu/*
-       Service Menus for Konqueror to allow attaching files and
-       compressing/attaching files/directories to a new Compose
-       window
-  kmail2sylpheed.pl
-       convert a Kmail addressbook to a Sylpheed
+       Service Menus for Konqueror to allow sending
+       files to Claws Mail
+  kmail2claws-mail.pl
+       convert a Kmail addressbook to a Claws Mail
        addressbook
-  kmail2sylpheed_v2.pl
+  kmail2claws-mail_v2.pl
        new version of the address book conversion script
        for newer versions of Kmail/Kaddressbook
-  maildir2sylpheed.pl
-       convert a maildir format mailbox into MH format
+  kmail-mailbox2claws-mail.pl
+       convert a Kmail mailbox into a Claws mail mailbox
   multiwebsearch.pl
        search any searchable website for the selected text
-  nautilus2sylpheed.sh
+  nautilus2claws-mail.sh
        enables sending files from the Nautilus file manager
-       to Sylpheed
-  OOo2sylpheed.pl
+       to Claws Mail
+  OOo2claws-mail.pl
        enable OpenOffice to send documents through
-       sylpheed
-  outlook2sylpheed.pl
-       convert an Outlook contacts list to a Sylpheed
+       Claws Mail
+  outlook2claws-mail.pl
+       convert an Outlook contacts list to a Claws Mail
        addressbook
   sylprint.pl
-       process a Sylpheed mail and print it using enscript
+       process a Claws Mail message and print it using enscript
        if available or lpr if not
-  tb2sylpheed
+  tb2claws-mail
        convert an addressbook exported from The Bat! into 
-       a Sylpheed addressbook
-  tbird2syl.py
-       integrate a Thunderbird folder tree into Claws
+       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
   uudec
        decode UUencoded mails, for use with Actions
-  vcard2xml
+  uuooffice
+       Decode uuencoded attachments and open them with OpenOffice
+  vcard2xml.py
        import an Evolution vCard
 
 
 11. How to contribute
 ---------------------
 
-You are encourged to send patches via the Sylpheed-Claws sourceforge
+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
 
 If that's too troublesome, either contact Paul Mangan
-<claws@thewildbeast.co.uk> or consider posting to the
-Sylpheed-Claws-users mailing list.
-http://www.sylpheed-claws.net/MLs.php
+<paul@claws-mail.org> or consider posting to the
+Claws Mail-users mailing list.
+http://www.claws-mail.org/MLs.php
 
 Bugs can be reported with Claws' bugzilla at:
-http://www.thewildbeast.co.uk/sylpheed-claws/bugzilla/index.cgi
+http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 
-Of course, you can also post to the Sylpheed-Claws-users mailing list.
+Of course, you can also post to the Claws Mail-users mailing list.
 
 Also, we really try to incorporate good contributions, but sometimes we
 don't have enough time. If the contribution is really big, or requires
 a long time to stabilise, send a mail to Paul Mangan
-<claws@thewildbeast.co.uk>. We can probably arrange access to the
-Sylpheed-Claws CVS tree.
+<paul@claws-mail.org>. We can probably arrange access to the
+Claws Mail CVS tree.
 
 
 
 12. How to request features
 ---------------------------
 
-Ask around in Sylpheed-Claws-users ML. Note that some developers may
+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.
 You might want to go ahead and hack a patch for it. (That would be very
@@ -663,7 +678,7 @@ http://sourceforge.net/tracker/?group_id=25528&atid=384601
 
 
 
-13. Installing Sylpheed-Claws from CVS
+13. Installing Claws Mail from CVS
 --------------------------------------
 
   a. Downloading
@@ -700,6 +715,26 @@ http://sourceforge.net/tracker/?group_id=25528&atid=384601
 
 GTK 2 Version
 -------------
+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]
+2006-11-06     2.6.0
+2006-10-19     2.5.6
+2006-10-12     2.5.5
+2006-10-11     2.5.4
+2006-10-04     2.5.3
+2006-09-26     2.5.2
+2006-09-26     2.5.1
+2006-09-25     2.5.0
 2006-07-31     2.4.0
 2006-06-20     2.3.1
 2006-06-12     2.3.0
@@ -775,37 +810,37 @@ GTK 1 Version
 15. Useful links
 ----------------
 Homepage
-    http://www.sylpheed-claws.net/
+    http://www.claws-mail.org/
 User Contributed FAQ
-    http://www.sylpheed-claws.net/faq/
+    http://www.claws-mail.org/faq/
 Project page
     http://sourceforge.net/projects/sylpheed-claws/
 Downloads
-    http://sourceforge.net/project/showfiles.php?group_id=25528&package_id=147457
+    http://www.claws-mail.org/downloads.php
 Extra Plugins
-    http://www.sylpheed-claws.net/plugins.php
+    http://www.claws-mail.org/plugins.php
 Icon Themes
-    http://www.sylpheed-claws.net/themes.php
+    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.sylpheed-claws.net/MLs.php
+    http://www.claws-mail.org/MLs.php
 Users Mailing List archive
     http://lists.sunsite.dk/cgi-bin/ezmlm-cgi/28
 Commits Announcement List archive
     http://lists.sunsite.dk/cgi-bin/ezmlm-cgi/27
 Bug Tracker
-    http://www.thewildbeast.co.uk/sylpheed-claws/bugzilla/index.cgi
+    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.sylpheed-claws.net/i18n.php
+    http://www.claws-mail.org/i18n.php
 Donations
-    http://www.sylpheed-claws.net/sponsors.php
-Planet Sylpheed
-    http://planet.sylpheed-claws.net/
-Sylpheed-Claws for Windows homepage
-    http://www.sylpheed-claws.net/win32/
+    http://www.claws-mail.org/sponsors.php
+Planet Claws Mail
+    http://planet.claws-mail.org/
+Claws Mail for Windows homepage
+    http://www.claws-mail.org/win32/