fix building on MAC. fixes bug 3835, 'autogen.sh fails with invalid test on line 33'
[claws.git] / README
diff --git a/README b/README
index 27f9ce0e5beb45c1a74f5b41a7f0b596834269a2..b6d238938b7e6ccb0e68ffe2c3c8e35e6b95728c 100644 (file)
--- a/README
+++ b/README
@@ -2,13 +2,14 @@ Claws Mail - a GTK+ based, lightweight, and fast e-mail client
 
 ---------------------------------------------------------------------
 
-   Copyright(C) 1999-2010 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp> and the
-   Claws Mail Team
+   Copyright (C) 1999-2017 The Claws Mail Team and Hiroyuki Yamamoto
+   <hiro-y@kcn.ne.jp>
+   
 
-   This program is free software; you can redistribute it and/or modify
+   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 3, or (at your option)
-   any later version.
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -16,8 +17,7 @@ Claws Mail - a GTK+ based, lightweight, and fast e-mail client
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    For more details see the file COPYING.
 
@@ -36,7 +36,7 @@ Summary:
  9. Tools
 10. How to contribute
 11. How to request features
-12. Installing Claws from CVS
+12. Installing Claws from Git
 13. Release History
 14. Useful Links
 
@@ -70,52 +70,172 @@ To load a plugin go to '/Configuration/Plugins' and click
 the 'Load Plugin' button.
 Select the plugin that you want and click 'OK'
 
+All plugin preferences can be found under
+'/Configuration/Preferences/Plugins/'.
+
+  o ACPI Notifier
+    Notifies of new mail via the mail LED available on some laptops. The 
+    LED can be set to blinking or on states when new mail is received. 
+    Appropriate kernel modules have to be loaded first for this plugin to 
+    work. Laptops supported are from ACER (acerhk and acer_acpi modules), 
+    ASUS (asus_laptop and asus_acpi), IBM (ibm_acpi), Lenovo (tm_smapi) 
+    and Fujitsu (apanel) manufacturers.
+
+  o Address Keeper
+    Saves mail addresses typed in the 'To', 'Cc' or 'Bcc' fields of 
+    outgoing messages to a designated folder in the address book. 
+    Addresses are saved only if not already present in the address book.
+
+  o Archiver
+    Archives mail folders using libarchive library. Folders can be archived 
+    with or without compression (ZIP, GZIP or BZIP2) and also in several 
+    formats (TAR, SHAR, PAX or CPIO).
+    Libarchive is available from http://www.libarchive.org/.
+
+  o Attachment Remover
+    Selectively removes attachments from messages. Messages are permanently 
+    modified by using this feature, so be careful!
+
+  o Attachment Warning
+    Warns the user of possibly forgotten attachments when some keywords 
+    are found in the outgoing messages. False positives (being warned when 
+    no attachment is realy needed) exist, but some configuration options 
+    can help to reduce their probability.
+
   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/ 
+    Bogofilter is available from http://bogofilter.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
-    option by default for safe browsing. Preferences can be 
-    found in '/Configuration/Preferences/Plugins/Dillo Browser'.
-    Dillo is available from http://www.dillo.org/
+  o BSFilter
+    Checks all messages received from IMAP, POP or local accounts using 
+    BSFilter, a bayesian spam filter program, which has to be installed 
+    locally. Messages identified as spam can be deleted or saved to a 
+    designated folder. 
+    Bsfilter is available from http://sourceforge.jp/projects/bsfilter/.
+
+  o Clamd
+    Uses the Clam AntiVirus in daemon mode to scan received messages from 
+    IMAP, POP or local accounts. Scanning is done through a socket to the 
+    daemon, so it has to be previously configured to allow this. 
+    Clam AntiVirus is available from http://www.clamav.net/.
+
+  o Fetchinfo
+    Modifies downloaded messages and inserts special headers containing 
+    some download information: UIDL, Claws Mail account name, POP server, 
+    user ID and retrieval time. These headers can be used later for more 
+    elaborate filtering or processing rules.
+
+  o Fancy
+    Renders HTML mails and HTML parts of multipart messages using the GTK+ 
+    port of the WebKit library. External content is blocked by default 
+    (including images) to avoid remote tracking, but can be enabled either 
+    globally or just on the displayed message.
+    GTK+ WebKit is available from http://trac.webkit.org/wiki/WebKitGTK/.
+
+  o GData
+    Includes your Gmail account contacts in the list generated for 
+    Tab-address completion on compose window, using the GData library.
+    Gdata library is available from https://live.gnome.org/libgdata/.
+
+  o Libravatar
+    Displays sender avatars from https://www.libravatar.org/, from own
+    sender's domain if enabled or even an automatically generated one.
+
+  o MailMbox
+    Handles mailboxes in Mbox format using the libEtPan! library. Mbox 
+    files can be added to the folder tree and used like regular mailboxes.
+    LibEtPan! is available from http://www.etpan.org/.
+
+  o Managesieve
+    Manage sieve filters on a server using the ManageSieve protocol.
+
+  o Newmail
+    Writes a header summary to a log file for each mail received after 
+    sorting. The file for the summary is ~/Mail/NewLog.
+
+  o Notification
+    Provides various ways of notifying the user of new and unread email. 
+    Current methods include: a banner, a popup window, a user command, 
+    a message to a LCD daemon, a system tray icon and an indicator icon.
+    Sound notifications are also possible through libcanberra. Each method 
+    can be customized in detail through the plugin preferences.
+    Indicator library is available from https://launchpad.net/libindicator/
+    and libcanberra from http://0pointer.de/lennart/projects/libcanberra/.
+
+  o Perl
+    Extends the filtering possibilities of Claws Mail. Provides a Perl 5 
+    interface to Claws Mail's filtering mechanism, allowing the use of full 
+    Perl power in email filters. A conversion script is provided to 
+    translate user rules into perl rules suitable for this plugin. 
+    Perl is available from http://www.perl.org/.
+
+  o PDF Viewer
+    Displays Portable Document Format (PDF) and PostScript attachments 
+    within the message view using Poppler. PostScript attachments are 
+    converted to PDF on the fly by the 'gs' tool, which has to be installed 
+    first. The 'gs' tool is available from http://pages.cs.wisc.edu/~ghost/.
+    The Poppler library is available from http://poppler.freedesktop.org/.
        
   o PGP/Core
     Handles core PGP functions and is required by the PGP/Inline
     and PGP/MIME plugins.
-    Uses GnuPG/GPGME, <ftp://ftp.gnupg.org/gcrypt/gpgme/>
+    Uses GnuPG/GPGME, ftp://ftp.gnupg.org/gcrypt/gpgme/.
 
   o PGP/inline
     Handles inline PGP signed and/or encrypted mails. You can
     decrypt mails, verify signatures or sign and encrypt your
-    own mails. Uses GnuPG/GPGME, <ftp://ftp.gnupg.org/gcrypt/gpgme/>
+    own mails. Uses GnuPG/GPGME, ftp://ftp.gnupg.org/gcrypt/gpgme/.
 
   o PGP/MIME
     Handles PGP/MIME signed and/or encrypted mails. You can
     decrypt mails, verify signatures or sign and encrypt your
-    own mails. Uses GnuPG/GPGME, <ftp://ftp.gnupg.org/gcrypt/gpgme/>
+    own mails. Uses GnuPG/GPGME, ftp://ftp.gnupg.org/gcrypt/gpgme/.
+
+  o Python
+    Provides Python scripting access to Claws Mail functions. A testing 
+    console is also featured. Scripts can be saved to specific folders 
+    for automatic loading on startup or being available as new menu items 
+    under the '/Tools/Python scripts' menu. 
+    Python is available from http://python.org/.
+
+  o RSSyl
+    Creates mailboxes where newsfeeds in RSS 1.0, RSS 2.0 or Atom format 
+    can be added. Each newsfeed will create a folder with the appropriate 
+    entries, fetched from the web. You can read them, and delete or keep 
+    old entries.
 
   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.
+    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 
-    delete mail identified as spam or save it to a designated 
-    folder. Preferences can be found in '/Configuration/
-    Preferences/Plugins/SpamAssassin'.
+    Scans incoming mail received from a POP, IMAP or LOCAL account using 
+    SpamAssassin. It can optionally delete mail identified as spam or save 
+    it to a designated folder. 
     SpamAssassin is available from http://spamassassin.apache.org/.
-       
-  o Trayicon 
-    Places an icon in the system tray that indicates whether
-    you have any new mail. A tooltip also shows the current
-    new, unread and total number of messages
+
+  o Spam Report
+    Reports spam messages to online spam harvesting sites. Sites suported 
+    are http://www.signal-spam.fr/ and http://www.spamcop.net/. The Debian 
+    mailing list spam nomination system is also supported.
+
+  o TNEF Parser
+    Decodes attachments with 'application/ms-tnef' MIME type (also known 
+    as "winmail.dat" files) in Claws Mail, using the ytnef library. 
+    Decoded parts can be saved to files.
+    The ytnef library is available from http://ytnef.sourceforge.net/.
+
+  o VCalendar
+    Displays vCalendar messages. Only the meeting subset of the vCalendar 
+    format is currently supported, which includes planning, sendding and 
+    receiving invitations and answering them. Public calendar (WebCal) 
+    subscriptions, free/busy information export/import and reminding of 
+    events is also supported.
+    
 
 Additonal plugins can be found here:
 http://www.claws-mail.org/plugins.php
@@ -279,7 +399,8 @@ http://www.claws-mail.org/plugins.php
     E        S          true if execute "S" succeeds
     f        S          messages originating from user S
     F                   forwarded messages
-    h        S          messages which contain header S
+    h        S          messages which contain S in any header name or value
+    H        S          messages which contain S in the value of any header
     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 #
@@ -366,162 +487,13 @@ http://www.claws-mail.org/plugins.php
 8. Hidden options
 -----------------
 
-    It is recommnede that you use Clawsker to edit these options,
-    http://www.claws-mail.org/clawsker
-
-    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.
-
-    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.
-
-    compose_no_markup          (default: 0)
-       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. 
-       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
-       0: off  1: on
-
-    folderview_vscrollbar_policy        (default: 0)
-       specify the policy of vertical scroll bar of folder view
-       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
-
-    live_dangerously                   (default: 0)
-       Don't ask for confirmation before definitive deletion of
-       emails.
-       0: off  1: on
-
-    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
-
-    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.
-       0: off  1: on
-
-    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
-
-    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'.
-
-    toolbar_detachable                 (default: 0)
-       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.
-        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.
-        0: off  1: on
-
-    utf8_instead_of_locale_for_broken_mail     (default: 0)
-       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.
-       0: off  1: on
+  There's several options which are not widely used and were not
+  added to the configuration interface to avoid excesive bloat.
+
+  The complete and up to date list of hidden options can be found
+  on Hidden preferences section of Claws Mail Manual:
+
+  http://www.claws-mail.org/manual/claws-mail-manual.html#adv_hidden
 
 9. Tools
 --------- 
@@ -637,7 +609,7 @@ 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
 <paul@claws-mail.org>. We can probably arrange access to the
-Claws Mail CVS tree.
+Claws Mail Git repository.
 
 
 
@@ -653,23 +625,21 @@ cool!) Another possibility is to add a request to our bugzilla, (severity:
 http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 
 
-12. Installing Claws Mail from CVS
+12. Installing Claws Mail from Git
 --------------------------------------
 
   a. Downloading
   --------------
 
-  To download the latest cvs cd to the directory where you wish to download
+  To download the latest Git, cd to the directory where you wish to download
   to and type the following information:
 
-  export CVS_RSH=ssh
-  cvs -z3 -d:pserver:anonymous@claws-mail.org:/ co -r gtk2 claws 
+  git clone http://git.claws-mail.org/readonly/claws.git 
 
   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 
+  git pull --all
 
   b. Installing
   -------------
@@ -690,6 +660,29 @@ http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 
 GTK 2 Version
 -------------
+2017-03-26     3.15.0
+2016-11-06     3.14.1
+2016-08-07     3.14.0
+2016-01-19     3.13.2
+2015-12-20     3.13.1
+2015-10-11     3.13.0
+2015-07-19     3.12.0
+2014-10-27     3.11.1
+2014-10-20     3.11.0
+2014-06-09     3.10.1
+2014-05-26     3.10.0
+2013-12-14     3.9.3
+2013-06-08     3.9.2
+2013-05-06     3.9.1
+2012-11-14     3.9.0
+2012-06-27     3.8.1
+2011-12-16     3.8.0
+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
@@ -802,22 +795,24 @@ Homepage
     http://www.claws-mail.org/
 User Contributed FAQ
     http://www.claws-mail.org/faq/
-Project page
-    http://sourceforge.net/projects/sylpheed-claws/
 Downloads
+    http://www.claws-mail.org/releases.php
+Release Announcement Feed
+    http://www.claws-mail.org/releases.rss
+Latest Release Notes
+    http://www.claws-mail.org/news.php
+Other Downloads
     http://www.claws-mail.org/downloads.php
-Extra Plugins
+List of Plugins
     http://www.claws-mail.org/plugins.php
 Icon Themes
     http://www.claws-mail.org/themes.php
-CVS webview
-    http://scm.dotsrc.org/viewvc.cgi/claws-mail/claws/?pathrev=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
+    http://lists.claws-mail.org/pipermail/commits/index.html
 Bug/Patch/Feature Request Tracker
     http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 Internationalisation Status