doc updated

1 files changed, 91 insertions, 0 deletions

diff --git a/doc/ivy-perl.1 b/doc/ivy-perl.1
new file mode 100644
index 0000000..265354c
--- /dev/null
+++ b/doc/ivy-perl.1
@@ -0,0 +1,91 @@
+'\"
+'\" Ivy, Perl 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.
+'\" 
+'\" 
+'\"	# Start an argument description
+.de AP
+.ie !"\\$4"" .TP \\$4
+.el \{\
+.   ie !"\\$2"" .TP \\n()Cu
+.   el          .TP 15
+.\}
+.ie !"\\$3"" \{\
+.ta \\n()Au \\n()Bu
+\&\\$1	\\fI\\$2\\fP	(\\$3)
+.\".b
+.\}
+.el \{\
+.br
+.ie !"\\$2"" \{\
+\&\\$1	\\fI\\$2\\fP
+.\}
+.el \{\
+\&\\fI\\$1\\fP
+.\}
+.\}
+..
+'\"	# define tabbing values for .AP
+.de AS
+.nr )A 10n
+.if !"\\$1"" .nr )A \\w'\\$1'u+3n
+.nr )B \\n()Au+15n
+.\"
+.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
+.nr )C \\n()Bu+\\w'(in/out)'u+2n
+..
+'\"	# BS - start boxed text
+'\"	# ^y = starting y location
+'\"	# ^b = 1
+.TH Ivy-Perl-3.0 1 3.0  "Ivy-Perl-3.0 Interface"
+.SH NAME
+ivy-perl - a software bus library
+.SH SYNOPSIS
+Ivy-perl provides a useful set of Perl library functions 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 functions of Ivy are:
+.nf
+.I Connexion
+.nf
+.I Message sending
+.nf
+.I Message subscription
+.nf
+.I Main loop
+
+.SH FILES
+.I /usr/lib/perl5/site_perl/Ivy.pm
+.SH ENVIRONMENT
+.I IVYBUS
+.nf
+.I IVYDOMAINS
+.SH DIAGNOSTICS
+error messages displayed
+.SH BUGS
+none reported yet!
+.SH AUTHORS
+.nf
+Alexandre Bustico <bustico@cenatoulouse.dgac.fr>
+.nf
+Stephane Chatty <chatty@cenatoulouse.dgac.fr>
+.SH SEE ALSO
+ivy-c (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
+bustico@cenatoulouse.dgac.fr, chatty@cenatoulouse.dgac.fr, jacomi@cenatoulouse.dgac.fr
+