man page (draft version)

1 files changed, 79 insertions, 0 deletions

diff --git a/doc/ivy-java.1 b/doc/ivy-java.1
new file mode 100644
index 0000000..c17901f
--- /dev/null
+++ b/doc/ivy-java.1
@@ -0,0 +1,79 @@
+'\"
+'\" Ivy, Java interface \- library managing connexions to a software bus
+'\"
+'\" Copyright (C) 1997-1999
+'\" Centre d'Études de la Navigation Aérienne
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\" 
+'\" 
+.TH Ivy-java-1.0 1 1.0  "Ivy-java-1.0 Interface"
+.SH NAME
+ivy-java - a software bus library
+.SH SYNOPSIS
+Ivy-java provides a useful set of Java library classes for communicating between different
+processes through a software bus
+.SH DESCRIPTION
+Ivy is a software bus, ie a system that allows any software component to freely exchange data.
+The basic principle of a software bus is to ease the rapid implementation of new agents, and to manage a dynamic collection of agents on the bus: agents connect, send and receive messages, and disconnect without perturbing the overall functionment of the bus.
+Each time an application initializes a connection on the bus, a
+"ready" message is sent to all other applications already connected, and the
+list of the messages subscribed by this application is dispatched.
+The format for the messages is free.
+.nf
+The essential classes of Ivy Java are:
+.nf
+.I Ivy: 
+\ API for the connexion to the software bus
+.nf
+.I IvyWatcher: 
+\ to handle UDP socket
+.nf
+.I IvyMessageListener: 
+\ to receive messages
+.nf
+.I IvyApplicationListener: 
+\ contains 4 virtual methods for handling connexion/deconnexion, die and direct messages
+.nf
+.I IvyApplicationAdapter: 
+\ to implement the IvyApplicationListener methods
+
+.SH FILES
+.I /usr/share/java/ivy-java.jar
+.nf
+.I /usr/src/ivy-java/fr/dgac/ivy/*.java
+
+.SH EXAMPLE
+This library is delivered with a test class named TestIvy:
+.nf
+java -DIVYBUS=143.196.53.255:2011 -classpath /usr/lib/jdk1.1/lib/classes.zip:/usr/share/java/gnu-regexp-1.0.6.jar:/usr/share/java/ivy-java.jar fr.dgac.ivy.TestIvy
+.nf
+-DIVYBUS is optional
+
+.SH NEEDED LIBRARIES
+.I jdk1.1 version 1.1
+.nf
+.I libgnu-regexp-java version 1.0
+
+.SH BUGS
+none reported yet!
+.SH AUTHORS
+.nf
+Francois-Regis Colin <fcolin@cenatoulouse.dgac.fr>
+.nf
+Yannick Jestin <jestin@cenatoulouse.dgac.fr>
+.SH SEE ALSO
+ivy-c (1)
+.nf
+ivy-perl (1)
+.nf
+ivy-c-functions (1)
+.nf
+ivyprobe (1)
+.sp
+For further details, please refer to the Ivy html page at http://www.cenatls.cena.dgac.fr/pii/produits/Ivy.html
+.SH NOTES
+In case of any comment or bug report on this library, please contact
+fcolin@cenatoulouse.dgac.fr, jestin@cenatoulouse.dgac.fr or jacomi@cenatoulouse.dgac.fr
+