README

sipXtackLib itself is a library with end user application however the
following tools either use this library or are related to SIP stack
information processing.

SIP Related Utilities
================================

Each of the following tools can be executed from the
commandline. Listed here the commands to either display the
commandline usage or in the case of siptest, start program where help
can be displayed.

siptest
 Interactive terminal based application to send and recieve
SIP based messages to other servers.  After starting siptest
the "help" command will provide a list of commands which can be
run from the siptest shell.  "help" <command> will give help on
a specific command.  An example request that can be sent using
the "send" command from siptest is in siptest/src/siptest/invite.txt
The "rt" command sets a template which is used to generate
responses to incoming requests.  The format of the template
file is the same as a SIP response message file.
The ports that siptest listen on can be set my creating a file
called siptest-config in the directory from which siptest is
started that contains the following parameters:
SIP_TEST_TCP_PORT : 3000
SIP_TEST_UDP_PORT : 3000

Documentation
=============

To generate doxygen docs, you must have doxygen installed first then
run this make target.

 make doc


Unit Testing
============

You can run unittests to ensure library is built properly on your
system.  This checks the library before it's installed, but can be run
at anytime.

  make check

Write unittests when developing new functionality or demonstrating a
bug with or without a patch.  Read CPP Unittesting HOWTO for more
information.

  http://www.sipfoundry.org/sipX/cpp-unittesting.html


Searching and Reporting Bugs
============================

Search JIRA bug list before reporting any new bugs.

  http://track.sipfoundry.org/browse/XSL