Skip to content

Latest commit

 

History

History
85 lines (53 loc) · 2.06 KB

README.markdown

File metadata and controls

85 lines (53 loc) · 2.06 KB
Raw

libstrophe Build Status

libstrophe is a lightweight XMPP client library written in C. It has minimal dependencies and is configurable for various environments. It runs well on Linux, Unix and Windows based platforms.

libstrophe is dual licensed under MIT and GPLv3.

Build Instructions

If you are building from a source control checkout, run:

./bootstrap.sh

to generate the configure script.

From the top-level directory, run the following commands:

./configure
make

The public API is defined in strophe.h which is in the top-level directory.

The examples directory contains some examples of how to use the library; these may be helpful in addition to the API documentation

To install on your system, as root (or using sudo):

make install

Note, the default install path is /usr/local/, to specify another path use the --prefix option during configure, e.g.:

./configure --prefix=/usr

Android

Run script build-android.sh and follow the instructions. You will need expat sources and android-ndk.

Code Coverage

If you want to create a code coverage report, run:

./configure --enable-coverage
make coverage

The coverage report can be found in ./coverage/index.html.

Requirements

libstrophe requires:

  • expat or libxml2 - expat is the default; use --with-libxml2 to switch
  • openssl or GnuTLS on UNIX systems - openssl is default; use --with-gnutls to switch

To build libstrophe using autotools you will need autoconf, automake, libtool and pkg-config.

To run code coverage analysis you will need gcov and lcov.

Installation

libstrophe package has been added to popular Linux distributions, BSD systems and OSX package managers.

Documentation

API documentation is inline with the code and conforms to Doxygen standards. You can generate an HTML version of the API documentation by running:

doxygen

Then open docs/html/index.html.