head	1.1;
access;
symbols
	caudium_1_4_9:1.1
	caudium_1_4_8:1.1
	caudium_1_4_7:1.1
	caudium_1_4_6:1.1
	caudium_1_4_5:1.1
	caudium_1_4_4:1.1
	caudium_1_4_3:1.1
	caudium_1_4_2:1.1
	caudium_1_5_1:1.1
	caudium_1_4_1:1.1
	stable_1_4:1.1.0.2
	caudium_1_3_33:1.1
	caudium_1_3_32:1.1
	caudium_1_3_31:1.1
	caudium_1_3_30:1.1
	caudium_1_3_29:1.1
	caudium_1_3_23:1.1
	caudium_1_3_22:1.1
	caudium_1_3_21:1.1
	caudium_1_3_20:1.1
	caudium_1_3_19:1.1
	caudium_1_3_18:1.1
	caudium_1_3_17:1.1
	caudium_1_3_16:1.1
	caudium_1_3_15:1.1
	caudium_1_3_14:1.1
	caudium_1_3_13:1.1
	caudium_1_3_12:1.1
	caudium_1_3_11:1.1
	caudium_1_3_10:1.1
	caudium_1_3_9:1.1
	caudium_1_3_8:1.1
	caudium_1_3_7:1.1
	caudium_1_3_6:1.1
	caudium_1_3_5:1.1
	caudium_1_3_4:1.1
	caudium_1_3_3:1.1;
locks; strict;
comment	@# @;


1.1
date	2002.05.18.23.52.18;	author grendel;	state Exp;
branches;
next	;


desc
@@


1.1
log
@a few notes
@
text
@Notes for the Caudium autodoc
-----------------------------

We use the Pike 7.3+ autodoc system to produce documentation of the Caudium
Pike/C API. The bin/ directory contains all the original Pike files that
had to be modified in order to work with Caudium. The system processes only
the Pike API calls - it does NOT understand the Caudium
defvars/tags/containers for now. This is in the TODO :)

To generate the documentation you will need the following software:

1. Pike 7.3 sources
2. Pike 7.3 binaries
3. GNU Autoconf 2.5x+
4. GNU Make

Run the provided autogen.sh then invoke the generated configure script
passing it the path to the Pike 7.3 source tree:

./configure --with-pikesrc=/usr/src/pike-7.3

optionally you can pass the configure script a path to the pike binary it
should use using the --with-pike parameter.

grendel

$Id$
@
