/* $Id: chooks.dox,v 1.2 2003/12/09 21:15:59 hei Exp $ */
/*========================================================================
   Main documentation for ips/chooks.
   (c) 2003 Harald Eilertsen
   
   Build with doxygen doxygen.cfg
   
   $Log: chooks.dox,v $
   Revision 1.2  2003/12/09 21:15:59  hei
   Removed revision from "project number field", and tidied up intro doc.

   Revision 1.1  2003/10/28 22:12:27  hei
   Added file to project

   Revision 1.1  2003/10/26 23:02:04  hei
   Added file to project.

   =====================================================================*/
   
/**
 * @mainpage ips/chooks Documentation
 *************************************************************************

<b>ips/chooks</b> is a C interface to writing hooks for 
<a href="http://www.inetpowerserver.com/">InetPowerServer</a>. A hook is
a function in a DLL, that is called by IPS on certain conditions. Exactly what 
triggers a hook to be called depends on how it installed with IPS. Check the 
<a href="http://www.inetpowerserver.com/documentation/index.html">IPS 
documentatin</a> for details.

The ips/chooks interface currently consists of two files:
- ipsHookInterface.h    This is the interface definition, and should be #include'd
                        in all source files using the IPS callback functions, or
                        implementing a hook.
- callbacks.c           This is the implementation for the IPS callback functions.
                        This file should be compiled and linked in with the other
                        files in your project. It is possible to write a hook and
                        call IPS callback functions without these functions, but
                        they make it a lot easier.
                        
In addition a few other files are included:
- testhook.c            This is a simple hook that can be used for testing the
                        hook interface. It will simply install a hook that will
                        produce some statistics from IPS on the client.
- os2/makefile.wcc      (Open)Watcom makefile for testhook sample for OS/2.
- win/makefile.vc       Visual C makefile for testhook sample. Use nmake.
- win/makefile.wcc      (Open)Watcom makefile for testhook sample for windows.
- doc/doxygen.cfg       The doxygen configuration file used for making this 
                        documentation.
- doc/chooks.dox        The file this introductory documentation is built from.

For bugreports, suggestions or other comments, please contact the author at the
following e-mail address: haraldei@anduin.net

 ******************************************************************************
 * @version 1.0
 * @author Harald Eilertsen (haraldei@anduin.net)
 */