Openslp README
===============

1 - Introduction
2 - Roadmap
3 - Build 
4 - Install 
5 - Users Guide
6 - Developers Guide
7 - FAQ


1 - Introduction
-----------------
The OpenSLP project is an effort to develop an open-source implementation of
Service Location Protocol suitable for commercial and non-commercial 
application.

Those that are investigating OpenSLP as part of a development or
porting project should look at the 1.1.x development releases.  This
is where the development action will be.  Those that are deploying
OpenSLP in production systems should continue to look at OpenSLP
1.0.11 until the 1.1.x code becomes stable enought for production use.


2 - Roadmap
------------
The first phase of OpenSLP is now complete.  The OpenSLP 1.0.x branch
is now frozen. The CVS repository has been branched to allow new 
development for the next major release of OpenSLP.  OpenSLP 1.1.x will be
the main development branch that will be used to implement revisions and
features currently under discussion on the Service Location Protocol mailing lists
(see http://srvloc.org).  For more roadmap information please see 
http://openslp.org/roadmap.html.
    

3 - Building OpenSLP
---------------------
Building OpenSLP requires the proper installation of automake, autoconf and
libtool.  To build OpenSLP please use the following steps:

    - Unzip and untar the openslp-x.x.x.tar.gz tarball.
   
      $ tar -zxf openslp-x.x.x.tar.gz 
	  
    - Run the autogen.sh script to generate configure script. Do not be
      alarmed if the autogen script prints a few errors.  Try the resulting
      configure (next step) script anyway.  If the ./configure script already
      exists, skip running ./autogen.sh
      
      $ cd openslp-x.x.x
      $ ./autogen.sh
	  
    - Run the configure script to create openslp make files.  Please note that
      the configure script accepts several --enable-xxxx and --disable-xxxx
      options that should be interesting to you.  Run ./configure --help and 
      read the details of each of these switches. If the configure
      script fails... now you have a problem.
     
      $ ./configure --help
      $ ./configure
	  
    - Run the top level make file (you need to use GNU make)
    
      $ make
	  
    - If the make is successful, look for the following binaries:
      
      slpd/slpd
      libslp/.libs/libslp.so
      test/.libs/*


4 - Installing OpenSLP       
-----------------------
To install OpenSLP make the install target in the top level make file
    
    $ make install
    
Installation of OpenSLP creates the following files:
    
    /usr/sbin/slpd 
    /usr/lib/libslp.so.x.x (and several appropriate links)
    /usr/lib/libslp.a 
    /etc/slp.conf          (old slp.conf is renamed)
    /etc/slp.reg           (old slp.reg is renamed)
    

5 - OpenSLP Users Guide 
------------------------
Rather than be repetitive in this document, the reader is refered to a fairly
complete OpenSLP users guide that is available in the doc/html directory
of the OpenSLP distribution or on the web at:
    
    http://www.openslp.org/doc/html/UsersGuide
    
The OpenSLp users guide gives instruction on how network and system
administrators should configure and use OpenSLP once it is installed


6 - OpenSLP Programmers Guide
------------------------------
Again, to avoid repetition, the reader is refered to a the Programmers Guide
available in the doc/html directory of the OpenSLP distribution or on the web 
at:
   
    http://www.openslp.org/doc/html/ProgrammersGuide
    
    
7 - FAQ
--------
The frequently asked questions have been moved to a faq.html file located in 
the doc directory of the OpenSLP tarball.  
