libxode README
Mar 22, 2001
____________________________________________________________

Table of Contents


1. Introduction

   1.1 General
   1.2 Copyright
   1.3 What is libxode
   1.3.a  XML
   1.3.b  Memory Pools
   1.3.c  Strings

2. Getting Things Installed

   2.1 Obtaining
   2.2 Dependencies
   2.3 Compilation and Installation
   2.4 Problems/Bugs

______________________________________________________________________

1.  Introduction

1.1.  General

This document gives pointers for information on this package.

1.2.  Copyright

//FIXME: Info on where to find copyright info

1.3.  What is libxode

  XML, Memory, and Strings made easy... in C, even.

  libxode is a collection of three tighly nit pieces that provide
  utility functions for XML handling, using memory pools, and string
  handling

1.3.a  XML
	
  libxode provides the capability to parse, manipulate, and create
  XML.  This is done by manipulating nodes.  A key feature of libxode
  is the ability to use xmlstreams, where callbacks are triggered as
  child tags are received.  See Jabber(http://jabber.org) for a great
  use of XML streams.

1.3.b

  Memory pools, an idea originated from apache, provide a convenient method
  of containing related memory.  It allows memory to be malloced against a 
  pool, and it will all be freed when the pool is release.

1.3.c
 
  libxode provides string functions in the form of xode_spools that allow
  an easy method for building large strings from small pieces.

2.  Getting it Installed

2.1 Obtaining

  Two main methods:
  
  //FIXME: Where is distribution site

  Anonymous CVS:

  //FIXME:  anonymous cvs info

2.2.  Dependencies

  gnu make, automake, autoconf, libtool and m4 are required to compile this
  library. 

2.3.  Compilation and Installation

  To installm you must be able to become super user. 
  Do the following in the libxode root directory:

  ______________________________________________________________________
  ./configure
  make
  (become root, su)
  make install
  ldconfig
  (unbecome root, exit)
  ______________________________________________________________________

2.4.  Problems/Bugs
 
  //FIXME:  Where to get help

3.  Extra Info

3.1 Tests
    
  the test/ folder contains several tests to test the different functionality
  of the libxode library.. simply running "make" in this folder will compile
  the tests, and run them.  NOTE: the library must be compiled in order for 
  the tests to run properly.
