INSTALL

   1                       HOW TO COMPILE, RUN AND INSTALL
   2                       -------------------------------
   3
   4 CONTENTS
   5 --------
   6
   7 The lksctp-tools package is intended for two audiences.
   8         1) SCTP application developers
   9         2) LKSCTP project developers
  10
  11 For SCTP application developers, this package provides the user-level
  12 C language header files and a library for accessing SCTP specific
  13 application programming interfaces not provided by the standard sockets.
  14
  15 For LKSCTP project developers, this package provides the functional
  16 and API regression tests.
  17
  18 For either role, this project provides sample code, utilities, and
  19 tests that one may find useful.
  20
  21 The below INSTALL directions are provided with in each of these roles.
  22
  23 NOTE:  To build, run and install the lksctp-tools package, your system is
  24 required to be running with linux-2.5.36, or a later version of the
  25 kernel, configured with the Network options "SCTP Configuration"
  26 support enabled.
  27
  28 ______________________________________________________________________
  29
  30
  31 INSTALLATION
  32 -------------
  33 Prerequisite:  A Linux kernel with SCTP support.  This may come stock with
  34 your distrbution (some day), or you will need to build your own 2.5.36 or
  35 later kernel.
  36
  37 To install/build the lksctp-tools utilities/tests do the following:
  38
  39 1) Download and install the following binary RPMs from the lksctp sourceforge
  40    website at
  41         http://sourceforge.net/project/showfiles.php?group_id=26529
  42    * lksctp-tools-x.y.z-1.i386.rpm
  43    * lksctp-tools-x.y.z-devel-1.i386.rpm
  44    * lksctp-tools-x.y.z-doc-1.i386.rpm
  45
  46    lksctp-tools-x.y.z-1.i386.rpm includes
  47    * SCTP run-time library.
  48    * Sample SCTP applications: sctp_darn and sctp_test.
  49    * withsctp: a tool when used with existing TCP binaries replaces TCP
  50                with SCTP.
  51
  52    lksctp-tools-x.y.z-devel-1.i386.rpm includes
  53    * SCTP header file /usr/include/netinet/sctp.h
  54    * SCTP man pages.
  55    * Source code for sample SCTP applications.
  56
  57    lksctp-tools-x.y.z-doc-1.i386.rpm includes
  58    * SCTP RFC's and internet drafts.
  59
  60    If you want to run and play with the included sample SCTP applications or
  61    develop your own SCTP applications, you can skip the rest of the
  62    instructions.
  63
  64    If you are interested in running the functional regression tests included
  65    in the lksctp-tools package, continue with the following instructions.
  66
  67 2) Download and install the following source RPM form the lksctp sourceforge
  68    website at
  69         http://sourceforge.net/project/showfiles.php?group_id=26529
  70    * lksctp-tools-x.y.z-1.src.rpm
  71    This will install the lksctp-tools gzipped tarball and RPM spec file.
  72
  73 3) Untar the lksctp-tools directory from the gzipped tarball. This creates a
  74    subdirectory called lksctp-tools-x.y.z.
  75
  76    Ensure you have autoconf, automake and libtool packages installed on your
  77    system.
  78
  79 4) Run ./bootstrap
  80
  81 5) Run ./configure
  82
  83 6) Run make
  84
  85 7) To run the SCTP kernel regression tests,
  86
  87    $ cd src/func_tests
  88    $ make v4test (regression tests for the IPv4 socket support)
  89    $ make v6test (regression tests for the IPv6 socket support)
  90
  91 8) Run other SCTP test tools/applications in src/apps directory to verify the
  92    running SCTP.