summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorsc1999-02-18 16:17:02 +0000
committersc1999-02-18 16:17:02 +0000
commit3dfd47dde8bb049a797f5dc653105c1cb57af617 (patch)
treeb2ceccec360e5184ff23b53760cefbcab6a55682
parenta129b0e495bdcb4537de91f327155d58666adb43 (diff)
downloadivyd-3dfd47dde8bb049a797f5dc653105c1cb57af617.zip
ivyd-3dfd47dde8bb049a797f5dc653105c1cb57af617.tar.gz
ivyd-3dfd47dde8bb049a797f5dc653105c1cb57af617.tar.bz2
ivyd-3dfd47dde8bb049a797f5dc653105c1cb57af617.tar.xz
Created man pages for ivyd and ivyecho
-rw-r--r--doc/ivyd.154
-rw-r--r--doc/ivyecho.149
2 files changed, 103 insertions, 0 deletions
diff --git a/doc/ivyd.1 b/doc/ivyd.1
new file mode 100644
index 0000000..6808c53
--- /dev/null
+++ b/doc/ivyd.1
@@ -0,0 +1,54 @@
+.\"
+.\" IvyDaemon, an Ivy gateway for short-lived agents
+.\"
+.\" Copyright (C) 1999
+.\" Centre d'Études de la Navigation Aérienne
+.\"
+.\" man page for ivyd
+.\"
+.\" Author(s): Stephane Chatty <chatty@cenatoulouse.dgac.fr>
+.\"
+.\" $Id$
+.\"
+.\" Please refer to file version.h for the
+.\" copyright notice regarding this software
+
+
+
+.TH IVYD 1 "17 Feb 1999"
+.ds )H CENA, France.
+.ds ]W V1.0
+.UC 4
+.SH NAME
+ivyd - daemon to relay messages to an Ivy bus.
+.SH SYNOPSIS
+.B "ivyd [-d] [-b [network[,network]][:port]]"
+.SH DESCRIPTION
+.B ivyd
+is an Ivy agent which binds to a port 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.
+
+.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.
+.SH OPTIONS
+.RS
+.TP 6
+.B -d
+Prints 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
+.I port
+and/or the set of networks
+.I network[,network].
+The default port is 2010, and the default network is 127, ie loopback.
+.SH SEE ALSO
+.PP
+in.ivyd(1),
+ivyecho(1),
+Ivy(1)
diff --git a/doc/ivyecho.1 b/doc/ivyecho.1
new file mode 100644
index 0000000..32a55bc
--- /dev/null
+++ b/doc/ivyecho.1
@@ -0,0 +1,49 @@
+.\"
+.\" IvyDaemon, an Ivy gateway for short-lived agents
+.\"
+.\" Copyright (C) 1999
+.\" Centre d'Études de la Navigation Aérienne
+.\"
+.\" man page for ivyecho
+.\"
+.\" Author(s): Stephane Chatty <chatty@cenatoulouse.dgac.fr>
+.\"
+.\" $Id$
+.\"
+.\" Please refer to file version.h for the
+.\" copyright notice regarding this software
+
+
+
+.TH IVYECHO 1 "17 Feb 1999"
+.ds )H CENA, France.
+.ds ]W V1.0
+.UC 4
+.SH NAME
+ivyecho - client of ivyd, Ivy equivalent of 'echo'
+.SH SYNOPSIS
+.B "ivyecho [-s serverhost] text"
+.SH DESCRIPTION
+.B ivyecho
+emits
+.I text
+on an Ivy bus. It first sends a request to the
+.B in.ivyd
+daemon to determine on which port to contact
+.B ivyd.
+It then sends a request to
+.B ivyd,
+that relays
+.I text
+to the Ivy bus.
+.SH OPTIONS
+.RS
+.TP 6
+.TP
+.B -s serverhost
+Determines the host on which to contact in.ivyd and ivyd.
+.SH SEE ALSO
+.PP
+in.ivyd(1),
+ivyd(1),
+Ivy(1)