Readme for building and installing Firefox(1.6a1) with SCTP.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Note: In the current release, the configure scripts and makefiles assume FreeBSD with KAME SCTP 
(http://www.kame.net) as the underlying system. This release will not build if the system has no SCTP
stack. If you are interested in building mozilla on system with no SCTP stack, please get the latest 
mozilla source for TCP from www.mozilla.org.

For other OSes/SCTP stacks, the SCTP related changes should compile fine, whereas the configure and 
makefile scripts have to be tweaked a little.

Do contact me if you are interested in building this code on other OSes/SCTP stack.

Please feel free to offer suggestions/improvements to the code or submit bug reports 
to pel at cis dot udel dot edu

~~~~~~~~~~~~~~~~
Installation Steps
~~~~~~~~~~~~~~~~

1. Refer to mozilla web site for the build requirements for your system.
   http://developer.mozilla.org/en/docs/Build_Documentation#Build_Requirements

2. Download and untar the Firefox(1.6a1) + SCTP code. 
   Assume this untar'd root directory name to be "mozilla".

3. Change parameter values in the source code.
 
If you would like to change the hardcoded values for any of the following
parameters, do so before the build process. We are currently working on 
auto configuration of these parameter values. Any ideas/inputs on how to 
do the same are most welcome.

Note: Each of these changes have extensive comments in the corresponding methods/functions.

*  Choose the transport protocol for this build - TCP/SCTP (default = SCTP). 

   In method BuildSocket of the nsSocketTransport class 
   (file: mozilla/netwerk/base/src/nsSocketTransport2.cpp), 
   comment/unocmment PR_OpenTCPSocket/PR_OpenSCTPSocket. 

* SCTP related parameters :

  a) Number of SCTP streams (default = 10). In function PR_Socket 
     (file: mozilla/nsprpub/pr/src/pthreads/ptio.c).

  b) Number of INIT attempts in SCTP association handshake (default = 5). 
     In function PR_Socket (file: mozilla/nsprpub/pr/src/pthreads/ptio.c)

4. Build and Install

* cd to mozilla.

* Edit the .mozconfig file. 

  The .mozconfig file supplies values for relevant options to the configure script.

  a) Install directory. Specify the desired directory in ac_add_options --prefix="Install_Directory"

  b) Object directory (default = moz_dbg_obj). Specify the desired object directory in 
     mk_add_options MOZ_OBJDIR="Object_Directory". 

* create Object_Directory (or moz_dbg_obj)

* cd to Object_Directory (or moz_dbg_obj)

*  Run configure script.
	prompt> ../configure

* Compile. If there are no problems, the compilation will complete in 1-2 hrs. 
  So, feel free to take a nap :-)

	prompt> gmake

* Install. 
	prompt> gmake install

5. Run Firefox

* cd to Install_directory/bin/

* Run firefox.  
	prompt> ./firefox &

This will print a lot of debug messages on the screen and eventually open up a Firefox window. If 
you've built Firefox over TCP, try to access any WWW site. If you've built Firefox over SCTP, try to
access the default web page of your Apache/SCTP web server.