docs/readme.mdwn
author Myhailo Danylenko <isbear@ukrpost.net>
Mon, 20 Aug 2012 22:51:51 +0300
changeset 58 694833145b98
parent 56 f0e3c123d506
permissions -rw-r--r--
Add a note about header
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
     1
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
     2
# Service Discovery
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     3
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     4
This is a module for mcabber to send service discovery requests.
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     5
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
     6
It provides mcabber command 'disco'. To use this module just load it -
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
     7
then command will be available.
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     8
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
     9
With this you can discover abilities of various jabber entities, like
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    10
servers, transports etc. Note, that it can only provide information,
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    11
what to do with this information (eg register to entity, that supports
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    12
it) is not this module's task. Note also, that if you want to get
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    13
abilities of some buddy, you should send disco request to specific
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    14
resource of that buddy (because of this this command supports extended
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    15
notation ./resource), if you'll send request to bare jid, you'll get
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    16
reply from server, that serves that jid.
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    17
58
694833145b98 Add a note about header
Myhailo Danylenko <isbear@ukrpost.net>
parents: 56
diff changeset
    18
Module also provides C header file, so that it's functionality can be
694833145b98 Add a note about header
Myhailo Danylenko <isbear@ukrpost.net>
parents: 56
diff changeset
    19
used from other modules.
694833145b98 Add a note about header
Myhailo Danylenko <isbear@ukrpost.net>
parents: 56
diff changeset
    20
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    21
# Installation
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    22
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    23
To install it, you need:
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    24
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    25
 * mcabber headers
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    26
 * glib
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    27
 * loudmouth
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    28
 * cmake
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    29
 * make
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    30
 * c compiler (gcc)
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    31
 * linker (binutils)
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    32
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    33
Then do:
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    34
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    35
    $ mkdir build
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    36
    $ cd build
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    37
    $ cmake ..
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    38
    $ make edit_cache
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    39
    $ make
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    40
    # make install
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    41
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    42
Debian users can instead of make install do:
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    43
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    44
    $ make package
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    45
    # dpkg -i libmcabber-disco_*.deb
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    46
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    47
Users of other distributions can select appropriate package generator,
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    48
using cache editor.
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    49
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    50
# License
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    51
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    52
This code underlies terms of GNU GPL v2 or later. You can find it in
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    53
file COPYING from this distribution or on a GNU web-site
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    54
<http://www.gnu.org/licenses/>.
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    55
56
f0e3c123d506 Rearrange docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    56
# Contact
11
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    57
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    58
I will be happy to get feedback, patches, suggestions, etc.
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    59
You can send me email or contact via jabber <isbear@unixzone.org.ua>.
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    60
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    61
  -- Myhailo Danylenko <isbear@ukrpost.net>
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    62