diff options
Diffstat (limited to 'doc/ivyd.1')
| -rw-r--r-- | doc/ivyd.1 | 93 |
1 files changed, 75 insertions, 18 deletions
@@ -6,7 +6,7 @@ .\" .\" man page for ivyd .\" -.\" Author(s): Stephane Chatty <chatty@cenatoulouse.dgac.fr> +.\" Author(s): Stephane Chatty <chatty@cena.dgac.fr> .\" .\" $Id$ .\" @@ -15,40 +15,97 @@ -.TH IVYD 1 "17 Feb 1999" +.TH IVYD 1 "11 Nov 1999" .ds )H CENA, France. .ds ]W V1.0 .UC 4 .SH NAME -ivyd - daemon to relay messages to an Ivy bus. +ivyd - the Ivy daemon that relays messages to an Ivy bus. .SH SYNOPSIS -.B "ivyd [-d] [-b [network[,network]][:port]]" +.B "ivyd [-d] [-b bus]" .SH DESCRIPTION .B ivyd -is an Ivy agent which binds to a port and awaits requests from +is an Ivy agent which binds to a socket and awaits requests from clients. Upon receiving a request, it reemits its contents as a message -on the Ivy bus. The port is chosen dynamically, and registered by sending an UDP -message to the -.B in.ivyd -daemon. - +on the Ivy bus it belongs to. .B ivyd is especially useful for short-lived applications that wish to send -messages on an Ivy bus but cannot stay connected to a bus long enough. +messages on an Ivy bus but cannot stay connected to a bus long enough, +such as a shell script. Many other applications will want to connect directly +to a bus rather than using +.B ivyd, +however. + .SH OPTIONS .RS .TP 6 .B -d -Prints debug messages, and do not fork from the calling shell. +Print debug messages, and do not fork from the calling shell. .TP -.B -b [network[,network]][:port] -Connects to and reemits messages on the Ivy bus defined by the broadcast address +.B -b bus +Connect to and reemit messages on the Ivy bus defined by the address +.I bus. +The syntax of bus addresses is +.I [network[,network]][:port], +where .I port -and/or the set of networks -.I network[,network]. -The default port is 2010, and the default network is 127, ie loopback. +is the UDP port used to broadcast information on the Ivy bus, and +.I network[,network] +is a set of network addresses on which information is +broadcast. Examples of bus adresses are 192.75:2000, :2001 or 192.75,192.76. +The default port is +.I 2010, +and the default network is +.I 127, +ie. loopback on the +local host. + +.SH EXAMPLE +.LP +This example launches an ivyd relay to the bus :2010 (port 2010 on local host) +then relays two messages to the bus. +.IP +.B ivyd \-b +.I :2010 + +.B ivyecho \-b +.I :2010 +.I This is message 1 + +.B ivyecho \-b +.I :2010 +.I And this is message 2 + +.SH CLIENT-SERVER ISSUES +The communication port with clients is chosen dynamically, and registered by +sending an UDP message to the +.B in.ivyd +super-daemon. Clients such as +.B ivyecho +obtain the address by sending a request to the super-daemon. +.B in.ivyd +is often launched at boot time, this is the default behaviour with +Linux packages of ivyd. + + +.SH LIMITATIONS +The mapping between clients and multiple +.B ivyd +servers is ensured through the port number in the bus address: in the example +above, the +.B ivyecho +client is directed by +.B in.ivyd +to the server that was launched just before because it refers to the bus port +.I 2010. +This means that only one Ivy daemon can run on a given bus. + +Another limitation: no server is automatically launched if a client tries to get +a message relayed to a bus for which there is no relay server. You must launch +your servers beforehand. + .SH SEE ALSO .PP -in.ivyd(1), +in.ivyd(8), ivyecho(1), Ivy(1) |