docs/readme.mdwn
author Myhailo Danylenko <isbear@ukrpost.net>
Mon, 20 Aug 2012 18:53:05 +0300
changeset 37 0477d4800fbd
parent 29 README@23fa36d480fb
permissions -rw-r--r--
Rearrange docs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     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
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
     7
'Pep' module provides common listener for incoming PEP events.
29
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
     8
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
     9
'Tune' module provides '/tune' command to publish music, you are
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    10
listening to at the moment. However, it does not by itself does that.
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    11
You'll need some other module, that will provide music information,
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    12
like 'mpd' one. Alternatively, you can set up some scripts to publish
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    13
information with '/tune' command via fifo.
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    14
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    15
'Mood' module provides '/mood' command to publish your current mood.
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    16
Currently it does not check for validity of its input, so, it's
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    17
strongly suggested to use provided completion for first argument.
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    18
[[List of valid moods|moods]]
29
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
    19
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    20
'Geoloc' module provides '/geoloc' command to publish your current
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    21
location. Currently, there are no known use cases of this module, but I
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    22
hope, that someday there will be a module, that will retrieve
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    23
geolocation information from devices and use this module to publish it.
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    24
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    25
'Activity' module provides '/activity' command to publish your current
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    26
activity. Currently it does not check for validity of its input either,
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    27
so, please use completion for first two arguments.
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    28
[[List of valid activities|activities]]
29
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
    29
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    30
Modules recognize options 'tune_interval' and 'geoloc_interval' to
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    31
limit publication rate and option 'tune_pause_is_stop', that controls
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    32
whether tune should publish empty information for paused state.
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    33
29
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
    34
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
    35
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
    36
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
    37
buddies events.
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
    38
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
    39
All of the modules also provide C headers for other C modules to use
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    40
to publish data. Note, however, that I plan to switch to events
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    41
interface for that - it provides multiplexing ability, and in general
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    42
is more flexible.
29
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
    43
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
    44
# Installation
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    45
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    46
To install it, you need:
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    47
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    48
 * mcabber headers
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    49
 * glib
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    50
 * loudmouth
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    51
 * cmake
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    52
 * make
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    53
 * c compiler (gcc)
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    54
 * linker (binutils)
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    55
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    56
Then do:
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    57
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    58
    $ mkdir build
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    59
    $ cd build
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    60
    $ cmake ..
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    61
    $ make edit_cache
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    62
    $ make
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    63
    # make install
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    64
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    65
Debian users can instead of make install do:
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    66
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    67
    $ make package
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    68
    # dpkg -i libmcabber-pep_*.deb
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    69
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    70
Users of other distributions can select appropriate package generator,
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    71
using cache editor.
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    72
29
23fa36d480fb Merge pep modules & use events
Myhailo Danylenko <isbear@ukrpost.net>
parents: 18
diff changeset
    73
# License
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    74
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    75
This code underlies terms of GNU GPL v2 or later. You can find it in
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    76
file COPYING from this distribution or on a GNU web-site
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    77
<http://www.gnu.org/licenses/>.
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    78
37
0477d4800fbd Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 29
diff changeset
    79
# Contact
5
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    80
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    81
I will be happy to get feedback, patches, suggestions, etc.
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    82
You can send me email or contact via jabber <isbear@unixzone.org.ua>.
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    83
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    84
  -- Myhailo Danylenko <isbear@ukrpost.net>
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    85