sync with 0.9.11cvs17 HEAD
[claws.git] / src / plugins / trayicon / README
1 Trayicon Plugin
2 ---------------
3
4 This plugin puts a little icon into the system tray. The system tray
5 has to be compatible to the system tray protocol specification from
6 http://www.freedesktop.org/standards/.  System trays know to work are
7 available for Gnome 2 (Notification Area Applet) and KDE 3.1.1.
8
9 The plugin uses a backport of the GTK eggtray widget from Gnome 2. Not
10 all features of GTK+ 2 are available in GTK+ 1.2 and so I'm not sure
11 if the plugin will properly work. It is a known problem that the icon
12 sometimes does not dock into the system tray and opens in a seperate
13 window. The reason for this is unknown. If you are sure that your system
14 tray is working correctly or if it worked before restarting sylpheed
15 fixes this in most cases.
16
17 The icon in the system tray will show you if you have new or unread
18 mail. If the mailbox is empty you have no unread mails, if a letter is
19 properly put into it you have unread mails, a letter that was just put
20 into it indicates new mail.
21
22 The icon also has a tooltip. If you keep the mouse 1 second over the
23 icon a tooltip showing the text "New: xxx, Unread: xxx, Total: xxx"
24 will appear, where xxx is the number of new, unread and total messages.
25
26 It is planned to add a popup menu that can be opened with the right mouse
27 button to execute some quick actions.  Ideas for the menu are currently
28 to start a check for new mails and to open a compose window.
29
30 Another idea is to allow to hide the sylpheed main window completely by
31 clicking on the icon with the left mouse button. This currently breaks
32 the automatic mail check. If these problems have been solved the feature
33 will be available.