2006-05-27 Mikael Hallendal <micke@imendio.com>
[jelmer/loudmouth.git] / README
1 Introduction:
2 =============
3
4 Loudmouth is a lightweight and easy-to-use C library for programming with the
5 Jabber protocol. It's designed to be easy to get started with and yet
6 extensible to let you do anything the Jabber protocol allows.
7
8 The goal is to fully support Linux, *BSD, Mac OSX and Windows. It has
9 currently only been tested on Linux (Red Hat 8.0, Debian Unstable) and FreeBSD
10 that I know of. If someone with access to other machines can provide
11 feedback I would be most grateful.
12
13
14 Requirements:
15 =============
16
17 Glib >= 2.0:
18 ftp://ftp.gtk.org/pub/gtk/v2.2/
19
20 gtk-doc (optional, if you want documentation built):
21 ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.0
22
23 If you want SSL-support you'll also need:
24 GnuTLS >= 1.0.0might have to be built with '--with-included-libtasn1')
25
26 Building:
27 =========
28
29 ./configure --prefix=
30 make
31 make install
32
33
34 Debugging:
35 ==========
36
37 You can get debug information printed to STDOUT by using the environment 
38 variable LM_DEBUG.
39
40 export LM_DEBUG=<keyword>
41
42 Where keyword is one or more (separated by :) of the following:
43
44 * "NET": Shows all the data sent over the network.
45 * "PARSER": Shows debug output from the parser.
46 * "VERBOSE": Shows various verbose output.
47 * "ALL": Enables all output.
48
49
50 Questions, remarks, bug reports:
51 ================================
52
53 See the web page for more information and issue reporting.
54
55 http://projects.imendio.com/loudmouth
56
57 Questions and others can be sent to me at:
58 email: micke@imendio.com
59 jabber: micke@imendio.com