= HC_CHAT =

== NAME ==
    hc_chat - Simple chat using HAMcast stack

== BUILD/INSTALL ==

=== Requirements ===

    - cmake (Version 2.6+)
    - cmake macro '!FindLibHamcast.cmake'
    - boost libraries developers edition
    - HAMcast library and middleware

=== Build ===

    We recommend an 'out-of-source' cmake-build. Create a new folder, e.g.
    'build' within the source directory. Change to new folder (cd build)
    and run:
{{{
  cmake ../
}}}
    if you have not install libhamcast to standard directories, run:
{{{
  cmake -DHAMCAST_INCLUDE_PATH=<path-to-headers> \
        -DHAMCAST_LIBRARY_PATH=<path-to-libhamcast> ../
}}}

    'path-to-headers' is the absolute path where 'hamcast/hamcast.hpp' can
    be found. 'path-to-libhamcast' is the absolute path where 'libhamcast.so'
    can be found. If both are the same, you have to provide only one of them.
    This will initialize build environment, if no errors occure run:
{{{
  make
}}}

    If build was successful you find the binary in 'build' folder.

=== Install ===

    Currently not supported. Just run hc_chat from build directory.

== SYNOPSIS ==
{{{
  hc_chat [GROUP]
}}}

== DESCRIPTION ==

    The program is a simple chat client to send and receive multicast chat
    messages using HAMcast stack. It uses the default interface configured
    in HAMcast middleware.

== EXIT STATUS ==

    hc_chat exits with status 0 (EXIT_SUCCESS) if no errors occur,
    otherwise 1 (EXIT_FAILURE) is returned.

== OPTIONS ==

    None

== EXAMPLES ==

    Using default group (URI: ip//239.0.0.1:1234):
{{{
  ./hc_chat
}}}
    Using specifc group:
{{{
  ./hc_chat <GROUP URI>
}}}

== FILES ==

    No other files required or used.

== ENVIRONMENT ==

    {{{LD_LIBRARY_PATH}}} must be set if libhamcast is not installed into
    standard directories, e.g. {{{/usr/lib}}}.

== NOTES ==

    None