  =========================================================================

  @(#) INSTALL,v 0.8.2.1 2002/04/12 10:04:38 brian Exp

  =========================================================================

  This README is Copyright (c) 2001  OpenSS7 Corporation

  All Rights Reserved.

  Permission is granted to make and distribute verbatim copies of this
  README file provided the copyright notice and this permission notice are
  preserved on all copies.
  
  Permission is granted to copy and distribute modified versions of this
  manual under the conditions for verbatim copying, provided that the
  entire resulting derived work is distributed under the terms of a
  permission notice identical to this one
  
  Since the Linux kernel and libraries are constantly changing, this README
  file may be incorrect or out-of-date.  The author(s) assume no
  responsibility for errors or omissions, or for damages resulting from the
  use of the information contained herein.  The author(s) may not have
  taken the same level of care in the production of this manual, which is
  licensed free of charge, as they might when working professionally.
  
  Formatted or processed versions of this manual, if unaccompanied by the
  source, must acknowledge the copyright and authors of this work.
  
  -------------------------------------------------------------------------

  U.S. GOVERNMENT RESTRICTED RIGHTS.  If you are licensing this Software on
  behalf of the U.S. Government ("Government"), the following provisions
  apply to you.  If the Software is supplied by the Department of Defense
  ("DoD"), it is classified as "Commercial Computer Software" under
  paragraph 252.227-7014 of the DoD Supplement to the Federal Acquisition
  Regulations ("DFARS") (or any successor regulations) and the Government
  is acquiring only the license rights granted herein (the license rights
  customarily provided to non-Government users).  If the Software is
  supplied to any unit or agency of the Government other than DoD, it is
  classified as "Restricted Computer Software" and the Government's rights
  in the Software are defined in paragraph 52.227-19 of the Federal
  Acquisition Regulations ("FAR") (or any success regulations) or, in the
  cases of NASA, in paragraph 18.52.227-86 of the NASA Supplement to the
  FAR (or any successor regulations).

  =========================================================================

  Modified 2002/04/12 10:04:38 by brian

  =========================================================================


                  OPENSS7 STREAMS INSTALLATION INSTRUCTIONS
                  -----------------------------------------

  PRELIMINARY:

  You will need the LiS STREAMS package, version LiS-2.13.17 running on a
  Linux 2.4.x SP or SMP kernel.  If you are interested in M2PA, other
  SIGTRAN UAs and SS7, you will need the strss7-0.8.2.tgz package and
  NOT this one (which is just SCTP).

  UNPACKING:

  To begin with, you should have a copy of the tarred and gzipped source in
  the file strsctp-0.8.2.tgz  Unpack it with

        tar -xzvf strsctp-0.8.2.tgz

  in some convenient place and it will unpack into a strsctp-0.8.2 directory.


  COMPILING:

  To build the package, simply change to the unpacked strsctp-0.8.2 directory
  and type:

        make

  Make will run a bash configuration script which will check to make sure that
  you have the LiS STREAMS package properly installed on your system and so
  that it knows where to find the necessary LiS include files.  Normally, the
  script just finds things and it will not need to prompt you.  If it cannot
  locate a necessary directory or file, it will prompt you for such things as
  the location of your LiS source directory and library files.

  If there are any compile errors, they are fatal.  You will have to dig into
  the Makefiles and source code if you have a problem.  On a normal Linux
  system, all should go well.

  If there are no errors, make should build all of the necessary modules and
  test programs.
  

  INSTALLATION:

  To run the test programs or load the sctp stack for applications programs,
  you must first install the modules and development header files.  This can
  be done by merely typing (as root)

        make install
  
  If you don't like doing this a root, either use the -n option to make
  install to see what will happen first, or look at the install targets in the
  toplevel and subdirectory Makefiles.  Make install does four things:

  1)    Copies the openss7 modules to /lib/modules/$(VERSION)/misc and
        /lib/modules/misc.  These modules are

	-rwxr-xr-x  1 root  root 149502 Dec 11 10:03 streams-sctp.o

  2)    Creates several STREAMS character devices in /dev for you such
	as /dev/sctp_t.  They all begin with ss7- or sctp as follows:

	crw-rw-rw-  1 root  root  240, 0 Dec 11 10:03 /dev/sctp_n
	crw-rw-rw-  1 root  root  241, 0 Dec 11 10:03 /dev/sctp_t

  3)    Appends character device aliases to your /etc/conf.modules or
        /etc/modules.conf file (whichever exists) to support kmod or
        kerneld automatic loading of the ss7 kernel modules when these
        character devices are opened.  The lines which are appended look
        like:

	alias char-major-240  streams-sctp    # driver sctp npi
	alias char-major-241  streams-sctp    # driver sctp tpi

  4)    Copies the development header files into the /usr/include/sys
        directory (where you can include them with, say, <sys/npi.h>)
        as follows:

	-rwxr-xr-x  1 root  root  26709 Nov  8 16:27 npi.h
	-rwxr-xr-x  1 root  root   6703 Dec 11 10:03 npi_sctp.h
	-rwxr-xr-x  1 root  root  26125 Dec 11 10:03 tpi.h
	-rwxr-xr-x  1 root  root   2960 Dec 11 10:03 tpi_sctp.h
	-rwxr-xr-x  1 root  root   3199 Dec 11 10:03 xti_ip.h
	-rwxr-xr-x  1 root  root   5184 Dec 11 10:03 xti_sctp.h

  TEST PROGRAMS:

  There are several test programs that you can run to check that your
  installation is correct and to serve as an example for how to write a
  user-level STREAMS application based on the SCTP TPI and NPI interfaces.
  These are located in the strsctp-0.8.2/test/ directory as follows:

	-rwxr-xr-x  1 brian  users  222256 Dec 11 09:57 test-sctp_n
	-rwxr-xr-x  1 brian  users  227757 Dec 11 09:57 test-sctp_t

  test-sctp_n:
      Opens three /dev/sctp_n (NPI Interface) streams and performs loopback
      connection, disconnection and data transfer testing.  This also performs
      some noise and disconnection tests as well.  Sample output from this
      program can be found in strsctp-0.8.2/test/log.sctp_n

	-rw-r--r--  1 brian  users  1070460 Nov 28 19:30 test/log.sctp_n

        This file shows the output of my runs of the test-sctp_n program.

  test-sctp_t:
      Opens three /dev/sctp_n (NPI Interface) streams and performs loopback
      connection, disconnection and data transfer testing.  This also performs
      some noise and disconnection tests as well.  Sample output from this
      program can be found in strsctp-0.8.2/test/log.sctp_t

	-rw-r--r--  1 brian  users   863599 Nov 28 19:29 test/log.sctp_t

        This file shows the output of my runs of the test-sctp_t program.


  WHAT IF EVERYTHING GOES WRONG?

  Check to make sure that you have LiS STREAMS correctly installed on your
  system and that it can actually run.

  Hit our majordomo mailing list at openss7@openss7.org: to subscribe, send
  mail to majordomo@openss7.org with "subscribe openss7" in the body of the
  message.  Our mail archive is located on our home page at www.openss7.org.
  
  You can mail me at bidulock@openss7.org, but NO WARRANTY.

  Fri Apr 12 04:57:09 CDT 2002
  Brian F. G. Bidulock
  bidulock@openss7.org
