Mercurial > addons > weechat-scripts > weechat-notification-script
comparison README @ 2:400b3d7b1313 default tip
Add a README file
| author | Guido Berhoerster <guido+weechat@berhoerster.name> |
|---|---|
| date | Tue, 10 Mar 2015 11:30:22 +0100 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 1:ba1005429c76 | 2:400b3d7b1313 |
|---|---|
| 1 Weechat Notification Script | |
| 2 =========================== | |
| 3 | |
| 4 The notification script for Weechat notifies of a number of events through | |
| 5 desktop notifications and an optional status icon. It can be configured to | |
| 6 notify of private messages, highlighted messages, and DCC requests and to only | |
| 7 notify of messages which are actually displayed within Weechat. The script | |
| 8 supports several different user interface toolkits to display the notifications | |
| 9 and the status icon, including GTK 2, GTK 3, Qt 4, and KDE 4. | |
| 10 | |
| 11 Usage | |
| 12 ----- | |
| 13 | |
| 14 The notification script is written in Python 2 and requires Weechat 1.0 or | |
| 15 later with support for Python scripts. Each of the different user interfaces | |
| 16 has its own set of dependencies. | |
| 17 | |
| 18 The user interface based on the GTK 2 toolkit requires PyGTK and | |
| 19 notify-python. | |
| 20 | |
| 21 The user interface based on the GTK 3 toolkit requires GObject Introspection | |
| 22 bindings for glib, GDK-PixBuf, GTK 3, and libnotify. | |
| 23 | |
| 24 The user interface based on the Qt 4 toolkit requires PyQt4. | |
| 25 | |
| 26 The user interface based on the KDE 4 libraries PyQt4 and PyKDE 4. | |
| 27 | |
| 28 The notification script can be configured through the following Weechat | |
| 29 settings: | |
| 30 | |
| 31 plugins.var.python.notification.status_icon | |
| 32 : The path or name of the status icon, if empty, does not display a status | |
| 33 icon. The default value is weechat. | |
| 34 | |
| 35 plugins.var.python.notification.notification_icon | |
| 36 : The path or name of the icon shown in notifications. The default value is | |
| 37 weechat. | |
| 38 | |
| 39 plugins.var.python.notification.preferred_toolkit | |
| 40 : The preferred user interface toolkit, if empty it will be selected | |
| 41 automatically based on the running desktop environment and the | |
| 42 installed toolkits. Valid values are gtk2, gtk3, gt4, and kde4. The | |
| 43 default value is empty. | |
| 44 | |
| 45 plugins.var.python.notification.notify_on_displayed_only | |
| 46 : Indicates whether to only notify of messages that are actually displayed | |
| 47 by Weechat. The default value is on. | |
| 48 | |
| 49 plugins.var.python.notification.notify_on_privmsg | |
| 50 : Indicates wheter to notify when receiving a private message. The default | |
| 51 value is on. | |
| 52 | |
| 53 plugins.var.python.notification.notify_on_highlight | |
| 54 : Indicates whether to notify when a messages is highlighted. The default | |
| 55 value is on. | |
| 56 | |
| 57 plugins.var.python.notification.notify_on_dcc_request | |
| 58 : Indicates whether to notify on DCC requests. The default value is on. | |
| 59 | |
| 60 Contact | |
| 61 ------- | |
| 62 | |
| 63 Please send any feedback, translations or bug reports via email to | |
| 64 <guido+weechat@berhoerster.name>. | |
| 65 | |
| 66 Bug Reports | |
| 67 ----------- | |
| 68 | |
| 69 When sending bug reports, please always mention the exact version of the | |
| 70 script with which the issue occurs as well as the version of Weechat and the | |
| 71 operating system you are using and make sure that you provide sufficient | |
| 72 information to reproduce the issue and include any input, output, any error | |
| 73 messages and Python stack traces. | |
| 74 | |
| 75 License | |
| 76 ------- | |
| 77 | |
| 78 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and | |
| 79 distributed under the following license terms: | |
| 80 | |
| 81 Copyright (C) 2014 Guido Berhoerster <guido+weechat@berhoerster.name> | |
| 82 | |
| 83 Licensed under the GNU General Public License Version 3 | |
| 84 | |
| 85 This program is free software: you can redistribute it and/or modify it under | |
| 86 the terms of the GNU General Public License as published by the Free Software | |
| 87 Foundation, either version 3 of the License, or (at your option) any later | |
| 88 version. | |
| 89 | |
| 90 This program is distributed in the hope that it will be useful, but WITHOUT ANY | |
| 91 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | |
| 92 PARTICULAR PURPOSE. See the GNU General Public License for more details. | |
| 93 | |
| 94 You should have received a copy of the GNU General Public License along with | |
| 95 this program. If not, see <http://www.gnu.org/licenses/>. | |
| 96 |