From 1afbcc6fa34335e77e089ddc5d67d069d3189ea7 Mon Sep 17 00:00:00 2001
From: bustico
Date: Tue, 8 Apr 2008 14:42:23 +0000
Subject:   * fix a bug with the behavior of send system call in non blocking
 mode 	in some rare case   * simplify ivythroutput and his fileset

---
 doc/ivy-c-functions.1 | 168 +++++++++++++++++++++++++-------------------------
 1 file changed, 84 insertions(+), 84 deletions(-)

(limited to 'doc/ivy-c-functions.1')

diff --git a/doc/ivy-c-functions.1 b/doc/ivy-c-functions.1
index d54bb77..1c58f0c 100644
--- a/doc/ivy-c-functions.1
+++ b/doc/ivy-c-functions.1
@@ -1,50 +1,50 @@
-'\"
-'\" Ivy, C interface \- library managing connexions to a software bus
-'\"
-'\" Copyright (C) 1997-2006
-'\" 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-c-3.9 1 3.9  "Ivy-c-3.9 Library Functions"
-.SH NAME
-IvyInit, IvyStart, IvyStop, IvyBindMsg, IvyUnbindMsg, IvyBindDirectMsg,
+.\" '\"
+.\" '\" Ivy, C interface \- library managing connexions to a software bus
+.\" '\"
+.\" '\" Copyright (C) 1997-2006
+.\" 
+.\" '\"
+.\" '\" 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)
+.\" 
+.\" .\}
+.\" .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-c-3.11" "1" "3.11" "Francois-Regis Colin, Stephane Chatty" "library"
+.SH "NAME"
+IvyInit, IvyStart, IvyStop, IvyBindMsg, IvyChangeMsg, IvyUnbindMsg, IvyBindDirectMsg,
 IvySendMsg, IvySendDirectMsg, IvySendDieMsg, IvySendError, IvyGetApplicationName,
 IvyGetApplicationHost, IvyGetApplication, IvyGetApplicationList,
 IvyGetApplicationMessages, IvyDefaultApplicationCallback, IvySetFilter, IvySetBindCallback,
@@ -52,11 +52,12 @@ IvyChannelInit, IvyChannelStop, IvyChannelAdd, IvyChannelRemove, IvyMainLoop,
 IvyChannelDelete, IvyChannelHandleRead, IvyChannelHandleExcpt,
 IvySetBeforeSelectHook, IvySetAfterSelectHook,
 IvyXtChannelAppContext, 
-.SH SYNOPSIS
+.SH "SYNOPSIS"
 useful set of library functions for communicating between different
 processes through a software bus
-.nf
+.nf 
 .sp
+void
 \fBIvyInit(\fIAppName, ready, callback, data, die_callback, die_data\fB)\fR
 .sp
 void
@@ -126,9 +127,9 @@ static void
 .sp
 void
 \fBIvyXtChannelAppContext(\fIcntx\fB)\fR
-.SH ARGUMENTS
+.SH "ARGUMENTS"
 Only main functions are detailed in this section
-.SH
+.SH ""
 \fBIvyInit\fR:
 Initialisation of a connection
 .sp
@@ -145,30 +146,30 @@ user data
 last change callback before die
 .AP void *die_data in
 user data
-.SH Example:
-\fBIvyInit ("PLN-SERVER", "PLN-READY", NULL, NULL, NULL);\fR
-.SH
+.SH "Example:"
+\fBIvyInit ("PLN\-SERVER", "PLN\-READY", NULL, NULL, NULL);\fR
+.SH ""
 \fBIvyStart\fR:
 Initialisation of TCP/UPD port and sending of a broadcast handshake on every network
 .AP const_char *bus in
 Bus to be used (format : network list followed by broadcast port).
-.SH Example:
+.SH "Example:"
 the given bus can be a string like 123.231,123.123:2000 or 123.231 or
 :2000. If no argument is specified, then the environment variable
 \fBIVYBUS\fR is checked, else the default value : 127.255.255.255:2010 
 is used (broadcast on the local machine).
-.nf
+.nf 
 \fBIvyStart ("143.196.53.255:2001");\fR
-.SH 
+.SH ""
 \fBIvyBindMsg\fR:
 Message binding
 .AP MsgCallback callback in
 .AP void *user_data in
 .AP const_char *regexp in
 .AP MsgRcvPtr id out
-.SH Example:
+.SH "Example:"
 \fBIvyBindMsg (StartTimeCallback, 0,  "^CLOCK Start time=(.*)");\fR
-.nf
+.nf 
 In this example the function \fBStartTimeCallback\fR will be called
 each time the string \fBCLOCK Start time=(.*)\fR will be emitted on
 the bus.
@@ -176,34 +177,34 @@ There is a special syntax for specifying numeric interval, in this case
 the interval is locally transformed in a pcre regexp.
 syntax is \fB(?Imin#max[fi])\fR. min and max are the bounds,
 by default the regexp match decimal number, but if max bound is
-followed by 'i', the regexp match only integers ex : \fB(?I-10#20), (?I20#25i)\fR
+followed by 'i', the regexp match only integers ex : \fB(?I\-10#20), (?I20#25i)\fR
 Note that due to the regexp generator limitation (which will perhaps be raised eventually)
 the bounds are always integers.
-.SH 
+.SH ""
 \fBIvyUnbindMsg\fR:
 Message unbinding
 .AP MsgRcvPtr id in
 ident of the message to unbind
-.SH 
+.SH ""
 \fBIvySendMsg\fR:
 Sending a message
 .AP const_char* fmt in
 String to be sent on the bus
-.SH Example:
-\fBIvySendMsg ("SECTOR:%s.AIRCRAFT:%s Entered", sectorname, pln->indicatif);\fR
-.SH
+.SH "Example:"
+\fBIvySendMsg ("SECTOR:%s.AIRCRAFT:%s Entered", sectorname, pln\->indicatif);\fR
+.SH ""
 \fBIvyChannelAdd\fR:
 .AP HANDLE fd in
 .AP void *data in
 .AP ChannelHandleDelete handle_delete in
 .AP ChannelHandleRead handle_read in
 .AP Channel out out
-.SH Example:
+.SH "Example:"
 \fBIvyChannelAdd (0, NULL, NULL, HandleStdin);\fR:
 .VE 
-.BE
-.SH DESCRIPTION
-.PP
+.B E
+.SH "DESCRIPTION"
+.PP 
 These functions provide facilities for connecting applications on a
 software bus and managing messages exchanges among them.
 Each time an application initializes a connection on the bus, a
@@ -211,9 +212,9 @@ Each time an application initializes a connection on the bus, a
 list of the messages subscribed by this application is dispatched.
 The format for the messages is free.
 
-.SH EXAMPLE
+.SH "EXAMPLE"
 Connection of the application \fBIVYPROBE\fR on a given bus
-.nf
+.nf 
 
 .DS
 
@@ -241,28 +242,27 @@ Connection of the application \fBIVYPROBE\fR on a given bus
 };
 .DE
 
-.SH FILES
+.SH "FILES"
 .I /usr/include/ivy.h
-.nf
+.nf 
 .I /usr/include/ivyloop.h
-.nf
+.nf 
 .I /usr/include/ivysocket.h
-.SH ENVIRONMENT
+.SH "ENVIRONMENT"
 .I IVYBUS
-.nf
-.I IVYDOMAINS
-.SH DIAGNOSTICS
+.nf 
+.SH "DIAGNOSTICS"
 error messages displayed
-.SH BUGS
+.SH "BUGS"
 none reported yet!
-.SH AUTHORS
-Francois-Regis Colin
+.SH "AUTHORS"
+Francois\-Regis Colin
 Stephane Chatty
-.SH SEE ALSO
+.SH "SEE ALSO"
 ivyprobe (1)
 .sp
-For further details, please refer to the Ivy html page at http://www.tls.cena.fr/pii/produits/Ivy.html
-.SH NOTES
+For further details, please refer to the Ivy html page at http://www.tls.cena.fr/products/ivy/
+.SH "NOTES"
 In case of any comment or bug report on this library, please contact
 ivy@tls.cena.fr
 
-- 
cgit v1.1