summaryrefslogtreecommitdiff
path: root/doc/ivyecho.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ivyecho.1')
-rw-r--r--doc/ivyecho.158
1 files changed, 50 insertions, 8 deletions
diff --git a/doc/ivyecho.1 b/doc/ivyecho.1
index 32a55bc..1956cb2 100644
--- a/doc/ivyecho.1
+++ b/doc/ivyecho.1
@@ -15,33 +15,75 @@
-.TH IVYECHO 1 "17 Feb 1999"
+.TH IVYECHO 1 "11 Nov 1999"
.ds )H CENA, France.
.ds ]W V1.0
.UC 4
.SH NAME
-ivyecho - client of ivyd, Ivy equivalent of 'echo'
+ivyecho - client of the Ivy daemon: the Ivy equivalent of 'echo'
.SH SYNOPSIS
-.B "ivyecho [-s serverhost] text"
+.B "ivyecho [-b bus] [-d] [-s serverhost] text"
.SH DESCRIPTION
.B ivyecho
emits
.I text
-on an Ivy bus. It first sends a request to the
+on an Ivy bus.
+
+This works as follows:
+.B ivyecho
+first sends a request to the
.B in.ivyd
-daemon to determine on which port to contact
-.B ivyd.
+daemon to determine on which port to contact the appropriate
+.B ivyd
+relay server.
It then sends a request to
.B ivyd,
that relays
.I text
-to the Ivy bus.
+to the Ivy bus. This only works if the appropriate
+.B ivyd
+server is running.
+
.SH OPTIONS
.RS
+
.TP 6
+.B -b bus
+Get message relayed to the Ivy bus defined by the address
+.I bus.
+The syntax of bus addresses is
+.I [network[,network]][:port],
+where
+.I port
+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.
+.I port
+is used to determine which
+.B ivyd
+server to use.
+
+.TP
+.B -d
+print debug information.
+
+
.TP
.B -s serverhost
-Determines the host on which to contact in.ivyd and ivyd.
+Use
+.I serverhost
+as the host on which to contact
+.B in.ivyd
+and
+.B ivyd.
+
.SH SEE ALSO
.PP
in.ivyd(1),