******************************************************************************
******************************************************************************

                       AXENE XMAYDAY API  README FILE
                            http://www.axene.com/
             Some troubles with it ? Contact xmayday-api@axene.com      

******************************************************************************
******************************************************************************

This directory contains the API to call XMayday from your own software
in order to display online help.

- ClientWin.c	Source file of Xmu library.
- FileTools.c	Source file for file management.
- Makefile	Generic Makefile.
- TestApi.c	Test program source file.
- Vroot.h	Header to deal with 'virtual root' window managers.
- XMayday.h	Header for general definitions..
- XMaydayCom.c	Source file for API communication.
- XMaydayCom.h	Header for XMayday.c. External definition of
                API functions.
- index.html 	Html example page (index file)
- page1.html 	Html example page. Called by test program if XMayday 
		is running.
- page2.html 	Html example page. Called by test program when 
		opening XMayday.

ClientWin.c is part of Xmu library from X11R6. If you include the Xmu
library with your program, you don't need to link this file.

TestApi.c contains the main function of the test program.

Communication is made with the following Atoms:
- XA_XMAYDAY_VERSION,
- XA_XMAYDAY_LOCK,
- XA_XMAYDAY_COMMAND, 
- XA_XMAYDAY_RESPONSE.

Useful commands are: 
- INDEX={file.html[#anchor]}	: set the index file.
- URL={file.html[#anchor]}	: set the file to be displayed.
- RAISE				: specify that the XMayday Window must be 
				  raised up.
- EXIT				: specify that the XMayday Window must be
				  closed.

Use the ';' character to concat commands.

