Man pages for XREQ/XREP/zmq_queue updated

4 files changed, 49 insertions, 3 deletions

diff --git a/man/Makefile.am b/man/Makefile.am
index c1fbeb4..a292082 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,4 +1,4 @@
-dist_man_MANS = man1/zmq_forwarder.1 man1/zmq_streamer.1 \
+dist_man_MANS = man1/zmq_forwarder.1 man1/zmq_streamer.1 man1/zmq_queue.1 \
     man3/zmq_init.3 man3/zmq_term.3 \
     man3/zmq_socket.3 man3/zmq_close.3 man3/zmq_setsockopt.3 man3/zmq_bind.3 \
     man3/zmq_connect.3 man3/zmq_send.3 man3/zmq_flush.3 man3/zmq_recv.3 \
diff --git a/man/convert2pdf.sh b/man/convert2pdf.sh
index 61ed06d..8f41e0e 100755
--- a/man/convert2pdf.sh
+++ b/man/convert2pdf.sh
@@ -21,6 +21,8 @@ groff -man -Tps man1/zmq_forwarder.1 > man1/zmq_forwarder.1.ps
 ps2pdf man1/zmq_forwarder.1.ps zmq_forwarder.pdf
 groff -man -Tps man1/zmq_streamer.1 > man1/zmq_streamer.1.ps
 ps2pdf man1/zmq_streamer.1.ps zmq_streamer.pdf
+groff -man -Tps man1/zmq_queue.1 > man1/zmq_queue.1.ps
+ps2pdf man1/zmq_queue.1.ps zmq_queue.pdf
 
 groff -man -Tps man3/zmq_init.3 > man3/zmq_init.3.ps
 ps2pdf man3/zmq_init.3.ps zmq_init.pdf
diff --git a/man/man1/zmq_queue.1 b/man/man1/zmq_queue.1
new file mode 100644
index 0000000..25aeab6
--- /dev/null
+++ b/man/man1/zmq_queue.1
@@ -0,0 +1,11 @@
+.TH zmq_queue 1 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_queue \- forwards REQ/REP messages
+.SH SYNOPSIS
+.SH DESCRIPTION
+.SH OPTIONS
+.SH "SEE ALSO"
+.SH AUTHOR
+Martin Sustrik <sustrik at 250bpm dot com>
+
+
diff --git a/man/man3/zmq_socket.3 b/man/man3/zmq_socket.3
index a73bba5..de32d5f 100644
--- a/man/man3/zmq_socket.3
+++ b/man/man3/zmq_socket.3
@@ -18,33 +18,66 @@ from any other thread.
 Socket to communicate with a single peer. Allows for only a single connect or a
 single bind. There's no message routing or message filtering involved.
 
+Compatible peer sockets: ZMQ_P2P.
+
 .IP "\fBZMQ_PUB\fP"
 Socket to distribute data. Recv fuction is not implemented for this socket
 type. Messages are distributed in fanout fashion to all the peers.
 
+Compatible peer sockets: ZMQ_SUB.
+
 .IP "\fBZMQ_SUB\fP"
 Socket to subscribe for data. Send function is not implemented for this
 socket type. Initially, socket is subscribed for no messages. Use ZMQ_SUBSCRIBE
 option to specify which messages to subscribe for.
 
+Compatible peer sockets: ZMQ_PUB.
+
 .IP "\fBZMQ_REQ\fP"
 Socket to send requests and receive replies. Requests are load-balanced among
 all the peers. This socket type allows only an alternated sequence of
 send's and recv's.
 
+Compatible peer sockets: ZMQ_REP, ZMQ_XREP.
+
 .IP "\fBZMQ_REP\fP"
 Socket to receive requests and send replies. This socket type allows
 only an alternated sequence of recv's and send's. Each send is routed to
 the peer that issued the last received request.
 
+Compatible peer sockets: ZMQ_REQ, ZMQ_XREQ.
+
+.IP "\fBZMQ_XREQ\fP"
+Special socket type to be used in request/reply middleboxes such as
+.BR zmq_queue(7) .
+Requests forwarded using this socket type should be tagged by a proper postix
+identifying the original requester. Replies received by this socket are tagged
+with a proper postfix that can be use to route the reply back to the original
+requester.
+
+Compatible peer sockets: ZMQ_REP, ZMQ_XREP.
+
+.IP "\fBZMQ_XREP\fP"
+Special socket type to be used in request/reply middleboxes such as
+.BR zmq_queue(7) .
+Requests received using this socket are already properly tagged with postfix
+identifying the original requester. When sending a reply via XREP socket the
+message should be tagged with a postfix from a corresponding request.
+
+Compatible peer sockets: ZMQ_REQ, ZMQ_XREQ.
+
 .IP "\fBZMQ_UPSTREAM\fP"
 Socket to receive messages from up the stream. Messages are fair-queued
 from among all the connected peers. Send function is not implemented for
-this socket type. 
+this socket type.
+
+Compatible peer sockets: ZMQ_DOWNSTREAM.
 
 .IP "\fBZMQ_DOWNSTREAM\fP"
 Socket to send messages down stream. Messages are load-balanced among all the
-connected peers. Send function is not implemented for this socket type. 
+connected peers. Send function is not implemented for this socket type.
+
+Compatible peer sockets: ZMQ_UPSTREAM.
 
 .SH RETURN VALUE
 Function returns socket handle is successful. Otherwise it returns NULL and