README
author Myhailo Danylenko <isbear@ukrpost.net>
Fri, 15 Jan 2010 09:16:59 +0200
changeset 11 2f9ffa1c24c5
parent 10 f9ab0b7f462a
child 23 2b7060ce1152
permissions -rw-r--r--
Change mcabber headers naming scheme
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     1
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     2
This is a module, implementing avatar publishing/retrieving via pep/pubsub.
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     3
This module informs you, when your buddies publish their avatars via pep
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     4
and provides command '/avatar' to publish your own. But this is not all.
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     5
It also will show you buddy's avatar! Yes, it is aalib :)
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     6
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     7
This module depends on module 'pep'. You must load it prior to this module
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     8
and not unload until you unload this module.
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     9
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    10
For this module to actually do something you should set option
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    11
avatars_directory - a place, where your buddy's avatars will be saved.
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    12
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    13
Note, that currently only pubsub-publishing of avatars is supported
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    14
(retrieving too works only for pubsub, but there you will be at least
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    15
informed of url, that you can use to view avatar manually). Thus, as
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    16
standard states, that pubsub-published data must be image/png, your
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    17
avatar should be in png format.
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    18
2
c1ee5fae2549 Added note about server support for pep and pubsub
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    19
To receive notifications you need only to load it (better at startup, as
c1ee5fae2549 Added note about server support for pep and pubsub
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    20
I had some problems otherwise due to server's caching features). Then when
c1ee5fae2549 Added note about server support for pep and pubsub
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    21
your buddy will change avatar, you will receive notification and new
c1ee5fae2549 Added note about server support for pep and pubsub
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    22
avatar will be downloaded, saved and printed to buddy's window. To publish
c1ee5fae2549 Added note about server support for pep and pubsub
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    23
avatar you need your server to support both pep and pubsub (many public
c1ee5fae2549 Added note about server support for pep and pubsub
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    24
jabber servers offer only pubsub or neither, while for example prosody in
c1ee5fae2549 Added note about server support for pep and pubsub
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    25
default debian's complectation supports only pep).
c1ee5fae2549 Added note about server support for pep and pubsub
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    26
4
43eb96df8612 Mention AAOPTS in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 2
diff changeset
    27
You can use AAOPTS environment variable to set aalib operation options, like
43eb96df8612 Mention AAOPTS in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 2
diff changeset
    28
contrast, brightness, etc (you can change mcabber environment at run-time
43eb96df8612 Mention AAOPTS in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 2
diff changeset
    29
with env module). For a list of options see aalib documentation:
43eb96df8612 Mention AAOPTS in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 2
diff changeset
    30
http://aa-project.sourceforge.net/aalib/aalib_9.html
43eb96df8612 Mention AAOPTS in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 2
diff changeset
    31
0
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    32
INSTALLATION
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    33
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    34
To install it, you need:
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    35
loudmouth
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    36
glib
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    37
aalib
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    38
libpng
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    39
mcabber's headers
10
f9ab0b7f462a mention pep as dep
Myhailo Danylenko <isbear@ukrpost.net>
parents: 7
diff changeset
    40
pep module's headers
0
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    41
cmake
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    42
make
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    43
gcc
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    44
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    45
Then do
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    46
$ mkdir build
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    47
$ cd build
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    48
$ cmake ..
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    49
$ make edit_cache
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    50
$ make
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    51
# make install
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    52
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    53
Debian users can instead of make install do
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    54
$ fakeroot make package
11
2f9ffa1c24c5 Change mcabber headers naming scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 10
diff changeset
    55
# dpkg -i libmcabber-avatar*.deb
0
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    56
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    57
Users of other distributions can select appropriate package
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    58
generator, using cache editor.
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    59
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    60
LICENSE
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    61
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    62
This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    63
from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    64
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    65
CONTACTS
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    66
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    67
I will be happy to get feedback, patches, suggestions, etc.
7
b33256405413 Update contact jid
Myhailo Danylenko <isbear@ukrpost.net>
parents: 4
diff changeset
    68
You can send me email or contact via jabber <isbear@unixzone.org.ua>.
0
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    69
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    70
  -- Myhailo Danylenko <isbear@ukrpost.net>
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    71
29423ceb6adf Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    72