replace deprecated g_memmove with memmove
[claws.git] / README
diff --git a/README b/README
index 34ec9bafbe94ec2b982f841a1ff221b531133383..8e19c343465a3d478176e45a2bfc406ef7acf233 100644 (file)
--- a/README
+++ b/README
@@ -2,13 +2,14 @@ Claws Mail - a GTK+ based, lightweight, and fast e-mail client
 
 ---------------------------------------------------------------------
 
-   Copyright(C) 1999-2013 Hiroyuki Yamamoto <hiro-y@kcn.ne.jp> and the
-   Claws Mail Team
+   Copyright (C) 1999-2019 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,9 +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.
 
@@ -37,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
 
@@ -124,29 +123,43 @@ All plugin preferences can be found under
     daemon, so it has to be previously configured to allow this. 
     Clam AntiVirus is available from http://www.clamav.net/.
 
+  o Dillo
+    Uses the Dillo browser (http://www.dillo.org) to render HTML mails
+    and HTML parts of multipart messages. Dillo is started with
+    special options to embed its window inside Claws Mail's message
+    view and to render the HTML safely. If required, remote content
+    can be also retrieved.
+
+  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. The GTK+
+    WebKit is available from http://trac.webkit.org/wiki/WebKitGTK/.
+
   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.
@@ -232,7 +245,7 @@ All plugin preferences can be found under
     
 
 Additonal plugins can be found here:
-http://www.claws-mail.org/plugins.php
+https://www.claws-mail.org/plugins.php
 
 
 3. Actions
@@ -354,7 +367,7 @@ http://www.claws-mail.org/plugins.php
 4. Icon Themes
 --------------
   Claws has support for different icon sets. Several icon sets can be
-  downloaded from http://www.claws-mail.org/themes.php
+  downloaded from https://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
@@ -393,7 +406,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 #
@@ -480,293 +494,41 @@ http://www.claws-mail.org/plugins.php
 8. Hidden options
 -----------------
 
-    It is recommended that you use Clawsker to edit these options,
-    http://www.claws-mail.org/clawsker.php
-
-    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
-
-    diff_added_color            (default: #008b8b)
-    diff_deleted_color          (default: #6a5acd)
-    diff_hunk_color             (default: #a52a2a)
-        Colors to use when displaying attachments in unified diff 
-       format.
-
-    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.
-
-    msgview_date_format                 (default: 0)
-        Use the same user-defined date format in the Message View as
-       is used in the Message List.
-       0: off  1: on
-
-    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
-
-    show_compose_margin                 (default: 0)
-        Adds margins to the message text area in the Compose window.
-       0: off  1: on
-
-    show_inline_attachments             (default: 1)
-        Show inline attachments in MimeView.
-       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
-
-    zero_replacement_char       (default: 0)
-       Character to show in Folder List counter columns when a 
-       folder doesn't contain messages.
+  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:
+
+  https://www.claws-mail.org/manual/claws-mail-manual.html#adv_hidden
 
 9. Tools
---------- 
-  You will find all of these tools in the 'tools' directory:
-
-  acroread2claws-mail.pl 
-       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
-  filter_conv.pl
-       convert sylpheed main's filter rules, (< 0.9.99),
-       into Claws' filtering format
-  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
-       browser
-  gif2xface.pl
-       convert a gif file to an xface
-  google_msgid.pl
-       Actions script to lookup selected message-id on 
-       google using mozilla.
-  google_search.pl
-       Actions script to lookup up the selected text on
-       google using the configured browser
-  kdeservicemenu/*
-       Service Menus for Konqueror to allow sending
-       files to Claws Mail
-  kmail2claws-mail.pl
-       convert a Kmail addressbook to a Claws Mail
-       addressbook
-  kmail2claws-mail_v2.pl
-       new version of the address book conversion script
-       for newer versions of Kmail/Kaddressbook
-  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
-       enables sending files from the Nautilus file manager
-       to Claws Mail
-  OOo2claws-mail.pl
-       enable OpenOffice to send documents through
-       Claws Mail
-  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
-  tb2claws-mail
-       convert an addressbook exported from The Bat! into 
-       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
-  uuooffice
-       Decode uuencoded attachments and open them with OpenOffice
-  vcard2xml.py
-       import an Evolution vCard
+--------
+
+  Tools are small scripts which can help integrate Claws Mail with
+  other programs; perform format conversions between different kinds
+  of mailboxes, address books, etc.; be used in Claws Mail Actions for
+  a variety of purposes; or used in other programs to ease their
+  interoperability with Claws Mail.
 
+  You will find all the tools in the 'tools' directory and a detailed
+  description of the available scripts in 'tools/README.'
 
 10. How to contribute
 ---------------------
 
 You are encourged to send patches via the Claws Mail bugzilla at
-http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
+https://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 But please first read the patch guidelines here:
-http://www.claws-mail.org/devel.php
+https://www.claws-mail.org/devel.php
 
 If that's too troublesome, either contact Paul Mangan
 <paul@claws-mail.org> or consider posting to the
 Claws Mail-users mailing list.
-http://www.claws-mail.org/MLs.php
+https://www.claws-mail.org/MLs.php
 
 Bugs can be reported with Claws' bugzilla at:
-http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
+https://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 
 Of course, you can also post to the Claws Mail-users mailing list.
 
@@ -774,7 +536,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.
 
 
 
@@ -787,26 +549,24 @@ 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 add a request to our bugzilla, (severity:
 'enhancement'), at
-http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
+https://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 https://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
   -------------
@@ -827,6 +587,27 @@ http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 
 GTK 2 Version
 -------------
+2019-07-26     3.17.4
+2018-12-22     3.17.3
+2018-12-14     3.17.2
+2018-08-26     3.17.1
+2018-08-15     3.17.0
+2017-12-17     3.16.0
+2017-08-29     3.15.1
+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
@@ -945,31 +726,35 @@ GTK 1 Version
 14. Useful links
 ----------------
 Homepage
-    http://www.claws-mail.org/
+    https://www.claws-mail.org/
 User Contributed FAQ
-    http://www.claws-mail.org/faq/
-Project page
-    http://sourceforge.net/projects/sylpheed-claws/
+    https://www.claws-mail.org/faq/
 Downloads
-    http://www.claws-mail.org/downloads.php
-Extra Plugins
-    http://www.claws-mail.org/plugins.php
+    https://www.claws-mail.org/releases.php
+Release Announcement Feed
+    https://www.claws-mail.org/releases.rss
+Latest Release Notes
+    https://www.claws-mail.org/news.php
+Other Downloads
+    https://www.claws-mail.org/downloads.php
+List of Plugins
+    https://www.claws-mail.org/plugins.php
 Icon Themes
-    http://www.claws-mail.org/themes.php
+    https://www.claws-mail.org/themes.php
 Mailing Lists
-    http://www.claws-mail.org/MLs.php
+    https://www.claws-mail.org/MLs.php
 Users Mailing List archive
-    http://lists.claws-mail.org/pipermail/users/index.html
+    https://lists.claws-mail.org/pipermail/users/index.html
 Commits Announcement List archive
-    http://lists.claws-mail.org/pipermail/commits/index.html
+    https://lists.claws-mail.org/pipermail/commits/index.html
 Bug/Patch/Feature Request Tracker
-    http://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
+    https://www.thewildbeast.co.uk/claws-mail/bugzilla/index.cgi
 Internationalisation Status
-    http://www.claws-mail.org/i18n.php
+    https://www.claws-mail.org/i18n.php
 Donations
-    http://www.claws-mail.org/sponsors.php
+    https://www.claws-mail.org/sponsors.php
 Planet Claws Mail
-    http://planet.claws-mail.org/
+    https://planet.claws-mail.org/
 Claws Mail for Windows homepage
-    http://www.claws-mail.org/win32/
+    https://www.claws-mail.org/win32/