Mercurial > addons > weechat-scripts > weechat-notification-script

annotate README @ 2:400b3d7b1313 default tip

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