README
author Mikael Berthe <mikael@lilotux.net>
Mon, 13 Jun 2022 18:01:27 +0200
changeset 745 7785b42dd7bc
parent 729 e63d00271473
permissions -rw-r--r--
Merge pull request #46 from nekopsykose/fix-asyncns-addrinfo fix macro define for freeaddrinfo with asyncns committer: GitHub <noreply@github.com>
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
729
e63d00271473 Bump minimum GLib version
Mikael Berthe <mikael@lilotux.net>
parents: 701
diff changeset
    17
Glib >= 2.38.0:
e63d00271473 Bump minimum GLib version
Mikael Berthe <mikael@lilotux.net>
parents: 701
diff changeset
    18
http://ftp.gnome.org/pub/GNOME/sources/glib/
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:
729
e63d00271473 Bump minimum GLib version
Mikael Berthe <mikael@lilotux.net>
parents: 701
diff changeset
    24
Glib >= 2.38.0
589
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:
701
bbbe2d24eea4 Update required GnuTLS version number
Frank Zschockelt <lm@freakysoft.de>
parents: 673
diff changeset
    27
GnuTLS >= 3.0.20 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
596
9096d2549372 Removed Dangerous Instructions
Jayson Vantuyl <jvantuyl@engineyard.com>
parents: 589
diff changeset
    32
./configure
1
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
664
f57b1b61e1fe Remove trailing whitespace and mixed indenting
Till Maas <opensource@till.name>
parents: 640
diff changeset
    46
You can get debug information printed to STDOUT by using the environment
1
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
638
bdfa8e1da006 Update contacts in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 596
diff changeset
    62
This fork of loudmouth is lazily maintained by MCabber community, members
640
abe35c907b20 Fix MUC room address in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 638
diff changeset
    63
of which can be found in official mcabber chatroom: <xmpp:mcabber@conf.lilotux.net>.
638
bdfa8e1da006 Update contacts in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 596
diff changeset
    64
673
1144e05fdde3 Update README wrt new release
Mikael Berthe <mikael@lilotux.net>
parents: 666
diff changeset
    65
New releases from the MCabber team are available at
1144e05fdde3 Update README wrt new release
Mikael Berthe <mikael@lilotux.net>
parents: 666
diff changeset
    66
<https://mcabber.com/files/loudmouth/>
1144e05fdde3 Update README wrt new release
Mikael Berthe <mikael@lilotux.net>
parents: 666
diff changeset
    67
638
bdfa8e1da006 Update contacts in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 596
diff changeset
    68
Bugs can be also reported (to not lose track of them) to github bugtracker:
666
685631ef717b Link to TLS-secured issue tracker at GitHub.
Hanno Heinrichs <hanno.heinrichs@rwth-aachen.de>
parents: 664
diff changeset
    69
<https://github.com/mcabber/loudmouth/issues>
638
bdfa8e1da006 Update contacts in README
Myhailo Danylenko <isbear@ukrpost.net>
parents: 596
diff changeset
    70
673
1144e05fdde3 Update README wrt new release
Mikael Berthe <mikael@lilotux.net>
parents: 666
diff changeset
    71
1144e05fdde3 Update README wrt new release
Mikael Berthe <mikael@lilotux.net>
parents: 666
diff changeset
    72
Official loudmouth project is no more maintained - both
1144e05fdde3 Update README wrt new release
Mikael Berthe <mikael@lilotux.net>
parents: 666
diff changeset
    73
<http://projects.imendio.com/loudmouth> and
1144e05fdde3 Update README wrt new release
Mikael Berthe <mikael@lilotux.net>
parents: 666
diff changeset
    74
<http://loudmouth-project.org>.