README
author Mikael Hallendal <micke@imendio.com>
Tue, 04 Mar 2008 00:38:08 +0100
changeset 349 3dafc8376e9b
parent 314 69dccab55eb7
child 479 812dd97245db
permissions -rw-r--r--
Release 1.3.4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     1
Introduction:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     2
=============
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     3
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     4
Loudmouth is a lightweight and easy-to-use C library for programming with the
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     5
Jabber protocol. It's designed to be easy to get started with and yet
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     6
extensible to let you do anything the Jabber protocol allows.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     7
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     8
The goal is to fully support Linux, *BSD, Mac OSX and Windows. It has
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
     9
currently only been tested on Linux (Red Hat 8.0, Debian Unstable) and FreeBSD
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    10
that I know of. If someone with access to other machines can provide
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    11
feedback I would be most grateful.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    12
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    13
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    14
Requirements:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    15
=============
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    16
253
a1fe0293e37b Updated requirements and obsoleted NEWS file.
Mikael Hallendal <micke@imendio.com>
parents: 84
diff changeset
    17
Glib >= 2.4.0:
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    18
ftp://ftp.gtk.org/pub/gtk/v2.2/
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    19
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    20
gtk-doc (optional, if you want documentation built):
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    21
ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.0
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    22
29
06a0e0c2e2eb 2003-08-04 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 7
diff changeset
    23
If you want SSL-support you'll also need:
253
a1fe0293e37b Updated requirements and obsoleted NEWS file.
Mikael Hallendal <micke@imendio.com>
parents: 84
diff changeset
    24
GnuTLS >= 1.2.0 with libtasn support.
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    25
314
69dccab55eb7 add link to Check website (issue LM-111)
Dafydd Harries <dafydd.harries@collabora.co.uk>
parents: 253
diff changeset
    26
If you want to run the unit tests, you'll also need:
69dccab55eb7 add link to Check website (issue LM-111)
Dafydd Harries <dafydd.harries@collabora.co.uk>
parents: 253
diff changeset
    27
Check
69dccab55eb7 add link to Check website (issue LM-111)
Dafydd Harries <dafydd.harries@collabora.co.uk>
parents: 253
diff changeset
    28
http://check.sourceforge.net/
69dccab55eb7 add link to Check website (issue LM-111)
Dafydd Harries <dafydd.harries@collabora.co.uk>
parents: 253
diff changeset
    29
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    30
Building:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    31
=========
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    32
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    33
./configure --prefix=
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    34
make
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    35
make install
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    36
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    37
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    38
Debugging:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    39
==========
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    40
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    41
You can get debug information printed to STDOUT by using the environment 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    42
variable LM_DEBUG.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    43
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    44
export LM_DEBUG=<keyword>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    45
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    46
Where keyword is one or more (separated by :) of the following:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    47
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    48
* "NET": Shows all the data sent over the network.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    49
* "PARSER": Shows debug output from the parser.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    50
* "VERBOSE": Shows various verbose output.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    51
* "ALL": Enables all output.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    52
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    53
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    54
Questions, remarks, bug reports:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    55
================================
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    56
81
b9dfe6efc011 2004-02-05 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 58
diff changeset
    57
See the web page for more information and issue reporting.
b9dfe6efc011 2004-02-05 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 58
diff changeset
    58
b9dfe6efc011 2004-02-05 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 58
diff changeset
    59
http://projects.imendio.com/loudmouth
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    60
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    61
Questions and others can be sent to me at:
7
d8eae83450ac 2003-06-13 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 3
diff changeset
    62
email: micke@imendio.com
d8eae83450ac 2003-06-13 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 3
diff changeset
    63
jabber: micke@imendio.com