[Commits] [SCM] claws branch, master, updated. 3.9.3-42-g3fd05a0
mones at claws-mail.org
mones at claws-mail.org
Sat Mar 15 16:26:48 CET 2014
The branch master of project "claws" (Claws Mail) has been updated
via 3fd05a0f8ccd49ac57bf6c83f01a3284b20a807a (commit)
via 1dd522127b992fb19cf59ffe64682927c70af256 (commit)
via 9d693983936f9f463f1d3c85c31c9cdcdd9070ec (commit)
from eeb18db35ed1136568ae802b2fb7445315471025 (commit)
- Log -----------------------------------------------------------------
commit 3fd05a0f8ccd49ac57bf6c83f01a3284b20a807a
Author: Ricardo Mones <ricardo at mones.org>
Date: Sat Mar 15 16:05:05 2014 +0100
A better README for libravatar plugin
• Structure it more clearly (I hope)
• Add a section about network issues and possible workarounds
• Talk about plugin hidden property (yes, they're everywhere)
diff --git a/src/plugins/libravatar/README b/src/plugins/libravatar/README
index fdd9e71..7fd4c55 100644
--- a/src/plugins/libravatar/README
+++ b/src/plugins/libravatar/README
@@ -1,5 +1,13 @@
Libravatar plugin for Claws Mail
---------------------------------
+================================
+
+1. What is it for?
+2. Network issues
+3. Cache details
+4. Reporting bugs
+
+1. What is it for?
+------------------
This plugin allows showing the profile picture associated to email
addresses provided by https://www.libravatar.org/. You can read
@@ -16,23 +24,45 @@ Face/X-Face machinery will operate as usual, allowing to show the
avatar images provided by those headers when no profile picture
exists in the servers.
+2. Network issues
+-----------------
+
+This plugin requires a reliable network connection to work. If your
+connection is unreliable or has high latency you're going to experience
+delays when viewing messages for first time (or always if you disable
+cache, which is not recommended, of course).
+
+Another option to alleviate high network latency is to install a local
+libravatar server (see http://wiki.libravatar.org/running_your_own/),
+then change the “base_url” hidden property on your ~/.claws-mail/clawsrc
+file to point your local server URL instead of Libravatar project's URL.
+
+Yet another option is using a caching proxy on your network.
+
This plugin uses libcurl to download images, so proxy support is
already implemented. You just need to set the “http_proxy” variable
in your environment before launching Claws Mail (see ENVIRONMENT
section in curl(1) manpage for details).
+3. Cache details
+----------------
+
This plugin saves retrieved images for later reuse instead of making
a network request on every message. Cache directory is in
~/.claws-mail/avatarcache. Does also save the missing ones in a
-special file to avoid filling the cache with empty files. You can
-control how much time will be kept there before trying to download
-them again. Missing items are valid for more time, 7 times your
-configured interval cache time. You can disable the image cache,
+special file to avoid filling the cache with empty files.
+
+You can control how much time will be kept there before trying to
+download them again. Missing items are valid for more time, 7 times
+your configured interval cache time. You can disable the image cache,
but notice that write access to avatarcache is still required.
Missing cache cannot be disabled.
-The TODO file contains more known issues/enhancements, read it before
-reporting bugs.
+4. Reporting bugs
+-----------------
+
+The TODO file contains more known issues/enhancements, please read it
+before reporting bugs.
--
Ricardo Mones <ricardo at mones.org>
commit 1dd522127b992fb19cf59ffe64682927c70af256
Author: Ricardo Mones <ricardo at mones.org>
Date: Sat Mar 15 16:02:49 2014 +0100
Even more crazy idea added
diff --git a/src/plugins/libravatar/TODO b/src/plugins/libravatar/TODO
index c21ff67..581c4f1 100644
--- a/src/plugins/libravatar/TODO
+++ b/src/plugins/libravatar/TODO
@@ -19,6 +19,9 @@ Enhancements, possibilities and random ideas
is not the one in http_proxy environment variable) (??)
- Limit avatar download size (??) or time (???)
- Configure missing factor/time separately (??)
+- Allow changing size of pictures retrieved (while easy on plugin's
+ side, this requires changes on Claws Mail itself, so not probably worth
+ the effort) (????)
As these are already known, please do not request enhancement bugs for any
of the above unless you have a working patch to be attached to the bug ;-)
commit 9d693983936f9f463f1d3c85c31c9cdcdd9070ec
Author: Ricardo Mones <ricardo at mones.org>
Date: Sat Mar 15 16:00:07 2014 +0100
Improve plugin description a bit
diff --git a/src/plugins/libravatar/libravatar.c b/src/plugins/libravatar/libravatar.c
index ef9219e..0255920 100644
--- a/src/plugins/libravatar/libravatar.c
+++ b/src/plugins/libravatar/libravatar.c
@@ -435,8 +435,15 @@ const gchar *plugin_name(void)
*/
const gchar *plugin_desc(void)
{
- return _("Get and display libravatar images for mail messages.\n\n"
- "Info about libravatar at http://www.libravatar.org/\n\n"
+ return _("Display libravatar profiles' images for mail messages. More\n"
+ "info about libravatar at http://www.libravatar.org/. If you have\n"
+ "a gravatar.com profile but not a libravatar one, those will also\n"
+ "be retrieved (when redirections are allowed in plugin config).\n"
+ "Plugin config page it's available from main window at:\n"
+ "Configuration→Preferences→Plugins→Libravatar.\n\n"
+ "This plugin uses libcurl to retrieve images, so if you're behind a\n"
+ "proxy please refer to curl(1) manpage for details on ‘http_proxy’\n"
+ "configuration. More details about this and others on README file.\n\n"
"Feedback to <ricardo at mones.org> is welcome.\n");
}
-----------------------------------------------------------------------
Summary of changes:
src/plugins/libravatar/README | 44 +++++++++++++++++++++++++++++------
src/plugins/libravatar/TODO | 3 +++
src/plugins/libravatar/libravatar.c | 11 +++++++--
3 files changed, 49 insertions(+), 9 deletions(-)
hooks/post-receive
--
Claws Mail
More information about the Commits
mailing list