TIPC utilities package for Linux README

Version: 3.0
Version Info: Added Java and Python demos.
Last updated: 04 July 2018

Version: 3.0.1
Version Info: Removed dependencey on old addressing scheme in multicast_blast test
Last updated: 10 October 2018

Version: 3.0.2/3.0.3
Some improvements to benchmark program
Last updated: 11 December 2018

Version: 3.0.4
Added tipc-trace client
Small fix to benchmark help text
Removed obsolete inter-cluster address test in ptts test program
Last updated: 1 February 2019

Version: 3.0.5
Support for Python 3

This directory contains a variety of demo, test and utility programs for use 
with Linux TIPC.

Building the utilities package
------------------------------
The master makefile for the utilities package allows you to build all programs
in a single operation.  (If desired, you can also build a specific utility
individually from its own sub-directory.)

If you cloned out the git repo you will need to run

   ./bootstrap

first, if you have the dist tarball you need only run:

    ./configure
    make

If the TIPC includes are not found for some reason,
or you want to build agains a different set of kernel headers.
You need to specify this directory in the configure stage as:
    ./configure  CFLAGS=-I<path to directory containing linux/tipc.h>

Note: In the standard Linux kernel source tree, this directory is located
at <top of source tree>/include.

In order to build TIPC GOLang API examples, --with-goapi need to specify in
the configure stage as:
    ./configure --with-goapi
    (This require Go tools - part of Go distribution are available in system)

In order to build TIPC PYTHON API examples, --with-py need to specify in the
configure stage as:
    ./configure --with-py
    (This require PYTHON available in system + setuptools, pip, PyInstaller
     modules)

In order to build TIPC JAVA, --with-tipcj need to specify in the configure.

The build procedure produces executable programs in the various sub-directories
that make up the package.


TIPC utilities uses autoconf and automake, to customize your build please
see the autotools and automake manuals. A few common targets are

    make install
    make dist


Running the utilities package
-----------------------------
Consult the README file in each sub-directory for further details on using
the associated application.
