XORP Source Code Documentation

The following source code documentation is available:

libxorp XORP core type and utility library
libxorp-callback XORP callback routines
libcomm Socket library
libxipc XORP interprocess communication library
libproto Protocol Node library used by XORP multicast processes
xrl-interfaces Generated code for sending Xrl's to Targets
xrl-targets Generated Xrl Target base classes
mrt Multicast Routing Table library
cli Command Line Interface library
libfeaclient Forwarind Engine Abstraction Client library
fea Forwarding Engine Abstraction daemon
mld6igmp Multicast Listener Discovery daemon
pim Protocol Independent Multicast (PIM) daemon
bgp BGP4 daemon
fib2mrib FIB2MRIB daemon
mibs MIB modules for Net-SNMP
rib Routing Information Base daemon
rip Routing Information Protocol
rtrmgr Router Manager
static_routes Static Routes daemon

Generating this documentation

The XORP project uses a modified version of the KDE documentation tool kdoc tool to produce source code documentation.

The XORP kdoc includes a number of C++ grammar additions, adds some support for style sheets, and generates W3C 4.01 transitional compliant HTML. XORP's version of kdoc is available by CVS, using:

	$ cvs -d :pserver:xorpcvs@cvs.xorp.org:/cvs co other/kdoc

Follow the instructions in the kdoc README file to install the program.

Once kdoc is installed, and go to the top level of the XORP source code tree and type:

	$ cd docs/kdoc
	$ ./gen-kdoc.sh

The script gen-kdoc.sh manages the generation of source documentation from the source code using kdoc and generates this boilerplate. All of the configuration information for the documentation generation is contained within gen-kdoc.sh. It should be relatively straightforward to add new targets by looking at the existing configuration towards the end of the script.

Generated by: pavlin on possum.icir.org at Thu Jul 8 23:48:42 PDT 2004 by gen-kdoc.sh.