summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/man3/zmq_bind.312
-rw-r--r--man/man3/zmq_connect.312
-rw-r--r--man/man7/zmq_pgm.75
-rw-r--r--man/man7/zmq_tcp.75
-rw-r--r--man/man7/zmq_udp.75
5 files changed, 31 insertions, 8 deletions
diff --git a/man/man3/zmq_bind.3 b/man/man3/zmq_bind.3
index c4d955e..b8f2102 100644
--- a/man/man3/zmq_bind.3
+++ b/man/man3/zmq_bind.3
@@ -5,16 +5,20 @@ zmq_bind \- binds the socket to the specified address
.B int zmq_bind (void *s, const char *addr);
.SH DESCRIPTION
The function binds socket
-.IR s to a particular transport. Actual semantics of the
+.IR s
+to a particular transport. Actual semantics of the
command depend on the underlying transport mechanism, however, in cases where
peers connect in an asymetric manner,
.IR zmq_bind
should be called first,
.IR zmq_connect
-afterwards. For actual formats of
+afterwards. Actual formats of
.IR addr
-parameter for different types of transport have a look at
-.IR zmq(7) .
+parameter are defined by individual transports. For a list of supported
+transports have a look at
+.IR zmq(7)
+manual page.
+
Note that single socket can be bound (and connected) to
arbitrary number of peers using different transport mechanisms.
.SH RETURN VALUE
diff --git a/man/man3/zmq_connect.3 b/man/man3/zmq_connect.3
index 291d113..dd0b5d8 100644
--- a/man/man3/zmq_connect.3
+++ b/man/man3/zmq_connect.3
@@ -5,17 +5,21 @@ zmq_connect \- connect the socket to the specified peer
.B int zmq_connect (void *s, const char *addr);
.SH DESCRIPTION
The function connect socket
-.IR s to the peer identified by
+.IR s
+to the peer identified by
.IR addr .
Actual semantics of the command depend on the underlying transport mechanism,
however, in cases where peers connect in an asymetric manner,
.IR zmq_bind
should be called first,
.IR zmq_connect
-afterwards. For actual formats of
+afterwards. Formats of the
.IR addr
-parameter for different types of transport have a look at
-.IR zmq(7) .
+parameter are defined by individual transports. For a list of supported
+transports have a look at
+.IR zmq(7)
+manual page.
+
Note that single socket can be connected (and bound) to
arbitrary number of peers using different transport mechanisms.
.SH RETURN VALUE
diff --git a/man/man7/zmq_pgm.7 b/man/man7/zmq_pgm.7
index e432730..68af978 100644
--- a/man/man7/zmq_pgm.7
+++ b/man/man7/zmq_pgm.7
@@ -32,6 +32,11 @@ mutlicast group should be specified in the numeric representation. For example:
pgm://192.168.0.111:224.0.0.1:5555
.fi
+Note that NIC names are not standardised by POSIX. They tend to be rather
+arbitrary and platform dependent. Say, "eth0" on Linux would correspond to "en0"
+on OSX and "e1000g" on Solaris. On Windows platform, as there are no short NIC
+names available, you have to use numeric IP addresses instead.
+
.SH WIRE FORMAT
Consecutive PGM packets are interpreted as a single continuous stream of data.
diff --git a/man/man7/zmq_tcp.7 b/man/man7/zmq_tcp.7
index aa3f56e..f5504c8 100644
--- a/man/man7/zmq_tcp.7
+++ b/man/man7/zmq_tcp.7
@@ -18,6 +18,11 @@ a NIC name or a hostname (resolved by DNS):
tcp://lo:32768
.fi
+Note that NIC names are not standardised by POSIX. They tend to be rather
+arbitrary and platform dependent. Say, "eth0" on Linux would correspond to "en0"
+on OSX and "e1000g" on Solaris. On Windows platform, as there are no short NIC
+names available, you have to use numeric IP addresses instead.
+
.SH WIRE FORMAT
A message consists of a message length followed by message data.
diff --git a/man/man7/zmq_udp.7 b/man/man7/zmq_udp.7
index bfebc1c..151a6d4 100644
--- a/man/man7/zmq_udp.7
+++ b/man/man7/zmq_udp.7
@@ -24,6 +24,11 @@ mutlicast group should be specified in the numeric representation. For example:
udp://192.168.0.111:224.0.0.1:5555
.fi
+Note that NIC names are not standardised by POSIX. They tend to be rather
+arbitrary and platform dependent. Say, "eth0" on Linux would correspond to "en0"
+on OSX and "e1000g" on Solaris. On Windows platform, as there are no short NIC
+names available, you have to use numeric IP addresses instead.
+
.SH WIRE FORMAT
Same as with PGM transport except for UDP packet headers.