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