README
author Samuel Tesla <stesla@engineyard.com>
Mon, 09 Mar 2009 18:05:59 -0500
changeset 593 2c04915af500
parent 589 5ed52ee1e2d9
child 596 9096d2549372
permissions -rw-r--r--
Update release information files. * Combined AUTHORS and CONTRIBUTORS. * Added some more folks to the AUTHORS file based on commit history. * Added Makefile recipe to dynamically generate ChangeLog from last annotated tag or a specified ref. * Added ignores for tarballs and ChangeLog.
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
589
5ed52ee1e2d9 Made Tests Optional to Allow Older glib
Jayson Vantuyl <jvantuyl@engineyard.com>
parents: 481
diff changeset
    17
Glib >= 2.12.4:
481
91c75e6b3190 Updated reference to GLib in README
Mikael Hallendal <micke@imendio.com>
parents: 480
diff changeset
    18
http://ftp.gnome.org/pub/GNOME/sources/glib/2.16/
1
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
589
5ed52ee1e2d9 Made Tests Optional to Allow Older glib
Jayson Vantuyl <jvantuyl@engineyard.com>
parents: 481
diff changeset
    23
If you want our unit tests through the g_test framework:
5ed52ee1e2d9 Made Tests Optional to Allow Older glib
Jayson Vantuyl <jvantuyl@engineyard.com>
parents: 481
diff changeset
    24
Glib >= 2.16.0
5ed52ee1e2d9 Made Tests Optional to Allow Older glib
Jayson Vantuyl <jvantuyl@engineyard.com>
parents: 481
diff changeset
    25
29
06a0e0c2e2eb 2003-08-04 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 7
diff changeset
    26
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
    27
GnuTLS >= 1.2.0 with libtasn support.
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    28
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    29
Building:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    30
=========
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    31
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    32
./configure --prefix=
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    33
make
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    34
make install
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    35
480
89568ffc9265 Added comment about SSL in README
Mikael Hallendal <micke@imendio.com>
parents: 314
diff changeset
    36
SSL Support:
89568ffc9265 Added comment about SSL in README
Mikael Hallendal <micke@imendio.com>
parents: 314
diff changeset
    37
============
89568ffc9265 Added comment about SSL in README
Mikael Hallendal <micke@imendio.com>
parents: 314
diff changeset
    38
You can choose between using GnuTLS (recommended) and OpenSSL to enable SSL
89568ffc9265 Added comment about SSL in README
Mikael Hallendal <micke@imendio.com>
parents: 314
diff changeset
    39
support in Loudmouth. You choose which backend to use by passing the
89568ffc9265 Added comment about SSL in README
Mikael Hallendal <micke@imendio.com>
parents: 314
diff changeset
    40
--with-ssl= flag to configure. GnuTLS is the default and will be used unless
89568ffc9265 Added comment about SSL in README
Mikael Hallendal <micke@imendio.com>
parents: 314
diff changeset
    41
you pass the flag, use "openssl" for OpenSSL.
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    42
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    43
Debugging:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    44
==========
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    45
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    46
You can get debug information printed to STDOUT by using the environment 
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    47
variable LM_DEBUG.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    48
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    49
export LM_DEBUG=<keyword>
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    50
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    51
Where keyword is one or more (separated by :) of the following:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    52
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    53
* "NET": Shows all the data sent over the network.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    54
* "PARSER": Shows debug output from the parser.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    55
* "VERBOSE": Shows various verbose output.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    56
* "ALL": Enables all output.
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    57
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    58
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    59
Questions, remarks, bug reports:
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    60
================================
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    61
81
b9dfe6efc011 2004-02-05 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 58
diff changeset
    62
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
    63
b9dfe6efc011 2004-02-05 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 58
diff changeset
    64
http://projects.imendio.com/loudmouth
1
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    65
50e230cf7818 Initial revision
hallski <hallski>
parents:
diff changeset
    66
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
    67
email: micke@imendio.com
d8eae83450ac 2003-06-13 Mikael Hallendal <micke@imendio.com>
hallski <hallski>
parents: 3
diff changeset
    68
jabber: micke@imendio.com