author | Myhailo Danylenko <isbear@ukrpost.net> |
Sun, 22 Jul 2012 15:50:50 +0300 | |
changeset 35 | a77a8e7ab8ae |
parent 29 | 23fa36d480fb |
child 37 | 0477d4800fbd |
permissions | -rw-r--r-- |
5 | 1 |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
2 |
# Personal Eventing Protocol modules |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
3 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
4 |
This is a set of modules, that provide notfication about other's events |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
5 |
and allow you to publish yours. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
6 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
7 |
Pep module provides common listener for incoming PEP events. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
8 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
9 |
Tune module provides '/tune' command to publish music, you are listening |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
10 |
to at the moment. However, it does not by itself does that. You'll need |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
11 |
some other module, that will provide music information, like 'mpd' one. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
12 |
Alternatively, you can set up some scripts to publish information with |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
13 |
'/tune' command via fifo. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
14 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
15 |
Mood module provides '/mood' command to publish your current mood. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
16 |
Currently it does not check for validity of its input, so, it's strongly |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
17 |
suggested to use provided completion for first argument. |
5 | 18 |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
19 |
Geoloc module provides '/geoloc' command to publish your current location. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
20 |
Currently, there are no known use cases of this module, but I hope, that |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
21 |
someday there will be a module, that will retrieve geolocation information |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
22 |
from devices and use this module to publish it. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
23 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
24 |
Activity module provides '/activity' command to publish your current activity. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
25 |
Currently it does not check for validity of its input either, so, please |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
26 |
use completion for first two arguments. |
5 | 27 |
|
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
28 |
Note: In order for you to actually publish something, your server must |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
29 |
support PEP, and that is still not that widely available. Still, even |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
30 |
if your server does not, you can load modules to be notified about your |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
31 |
buddies events. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
32 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
33 |
All of the modules also provide C headers for other C modules to use |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
34 |
to publish data. Note, however, that I plan to switch to events interface |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
35 |
for that - it provides multiplexing ability, and in general is more |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
36 |
flexible. |
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
37 |
|
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
38 |
# Installation |
5 | 39 |
|
40 |
To install it, you need: |
|
41 |
cmake |
|
42 |
make |
|
43 |
gcc |
|
44 |
glib |
|
45 |
loudmouth |
|
46 |
mcabber's headers |
|
47 |
||
48 |
Then do |
|
49 |
$ mkdir build |
|
50 |
$ cd build |
|
51 |
$ cmake .. |
|
52 |
$ make edit_cache |
|
53 |
$ make |
|
54 |
# make install |
|
55 |
||
56 |
Debian users can instead of make install do |
|
57 |
$ fakeroot make package |
|
10
a7575953642d
Change mcabber headers naming scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents:
5
diff
changeset
|
58 |
# dpkg -i libmcabber-pep*.deb |
5 | 59 |
|
60 |
Users of other distributions can select appropriate package |
|
61 |
generator, using cache editor. |
|
62 |
||
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
63 |
# License |
5 | 64 |
|
65 |
This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING |
|
66 |
from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>. |
|
67 |
||
29
23fa36d480fb
Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents:
18
diff
changeset
|
68 |
# Contacts |
5 | 69 |
|
70 |
I will be happy to get feedback, patches, suggestions, etc. |
|
71 |
You can send me email or contact via jabber <isbear@unixzone.org.ua>. |
|
72 |
||
73 |
-- Myhailo Danylenko <isbear@ukrpost.net> |
|
74 |