From bbbccebbe711a991d807bf70132bb4a982bb4e71 Mon Sep 17 00:00:00 2001
From: Erik Hugne <erik.hugne@ericsson.com>
Date: Tue, 5 Nov 2013 13:01:40 +0100
Subject: [PATCH] zmq: add TIPC manpage

Signed-off-by: Erik Hugne <erik.hugne@ericsson.com>
---
 doc/Makefile.am  |  2 +-
 doc/zmq_tipc.txt | 82 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 83 insertions(+), 1 deletion(-)
 create mode 100644 doc/zmq_tipc.txt

diff --git a/doc/Makefile.am b/doc/Makefile.am
index db826199..e193292e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -12,7 +12,7 @@ MAN3 = zmq_bind.3 zmq_unbind.3 zmq_connect.3 zmq_disconnect.3 zmq_close.3 \
     zmq_z85_encode.3 zmq_z85_decode.3 zmq_curve_keypair.3
 
 MAN7 = zmq.7 zmq_tcp.7 zmq_pgm.7 zmq_epgm.7 zmq_inproc.7 zmq_ipc.7 \
-    zmq_null.7 zmq_plain.7 zmq_curve.7
+    zmq_null.7 zmq_plain.7 zmq_curve.7 zmq_tipc.7
 
 MAN_DOC = $(MAN1) $(MAN3) $(MAN7)
 
diff --git a/doc/zmq_tipc.txt b/doc/zmq_tipc.txt
new file mode 100644
index 00000000..52ad3353
--- /dev/null
+++ b/doc/zmq_tipc.txt
@@ -0,0 +1,82 @@
+zmq_tipc(7)
+==========
+
+
+NAME
+----
+zmq_tipc - 0MQ unicast transport using TIPC
+
+
+SYNOPSIS
+--------
+TIPC is a cluster IPC protocol with a location transparent addressing scheme.
+
+
+ADDRESSING
+----------
+A 0MQ endpoint is a string consisting of a 'transport'`://` followed by an
+'address'. The 'transport' specifies the underlying protocol to use. The
+'address' specifies the transport-specific address to connect to.
+
+For the TIPC transport, the transport is `tipc`, and the meaning of the
+'address' part is defined below.
+
+
+Assigning a port name to a socket
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+When assigning a port name to a socket using _zmq_bind()_ with the 'tipc'
+transport, the 'endpoint' is defined in the form:
+{type, lower, upper}
+
+* Type is the numerical (u32) ID of your service.
+* Lower and Upper specify a range for your service.
+
+Publishing the same service with overlapping lower/upper ID's will
+cause connection requests to be distributed over these in a round-robin
+manner.
+
+
+Connecting a socket
+~~~~~~~~~~~~~~~~~~~
+When connecting a socket to a peer address using _zmq_connect()_ with the 'tipc'
+transport, the 'endpoint' shall be interpreted as a service ID, followed by a 
+comma and the instance ID.
+
+The instance ID must be within the lower/upper range of a published port name
+for the endpoint to be valid.
+
+EXAMPLES
+--------
+.Assigning a local address to a socket
+----
+//  Publish TIPC service ID 5555
+rc = zmq_bind(socket, "tipc://{5555,0,0}");
+assert (rc == 0);
+//  Publish TIPC service ID 5555 with a service range of 0-100
+rc = zmq_bind(socket, "tipc://{5555,0,100}");
+assert (rc == 0);
+----
+
+.Connecting a socket
+----
+//  Connect to service 5555 instance id 50
+rc = zmq_connect(socket, "tipc://{5555,50}");
+assert (rc == 0);
+----
+
+
+SEE ALSO
+--------
+linkzmq:zmq_bind[3]
+linkzmq:zmq_connect[3]
+linkzmq:zmq_tcp[7]
+linkzmq:zmq_pgm[7]
+linkzmq:zmq_ipc[7]
+linkzmq:zmq_inproc[7]
+linkzmq:zmq[7]
+
+
+AUTHORS
+-------
+This page was written by the 0MQ community. To make a change please
+read the 0MQ Contribution Policy at <http://www.zeromq.org/docs:contributing>.