summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartin Lucina <martin@lucina.net>2012-03-13 17:27:15 +0100
committerMartin Lucina <martin@lucina.net>2012-03-13 17:27:15 +0100
commitc1729113ea21e7fd90b217e979e333a85e26dc9a (patch)
tree2577c7bd37d328882be763d9eed09f900b44e5e8
parent51160a668dbb2ec659a19ae9a1c6c4c28075c492 (diff)
Rename zmq(7) manual to xs_zmq(7) and always install it
Signed-off-by: Martin Lucina <martin@lucina.net>
-rw-r--r--doc/Makefile.am6
-rw-r--r--doc/xs.txt5
-rw-r--r--doc/xs_zmq.txt (renamed from doc/zmq.txt)30
3 files changed, 19 insertions, 22 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 7cfc637..66dd87b 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,11 +4,7 @@ MAN3 = xs_bind.3 xs_close.3 xs_connect.3 xs_init.3 \
xs_poll.3 xs_recv.3 xs_send.3 xs_setsockopt.3 xs_socket.3 \
xs_strerror.3 xs_term.3 xs_version.3 xs_getsockopt.3 xs_errno.3 \
xs_sendmsg.3 xs_recvmsg.3 xs_getmsgopt.3 xs_setctxopt.3
-MAN7 = xs.7 xs_tcp.7 xs_pgm.7 xs_inproc.7 xs_ipc.7
-
-if BUILD_LIBZMQ
-MAN7 += zmq.7
-endif
+MAN7 = xs.7 xs_tcp.7 xs_pgm.7 xs_inproc.7 xs_ipc.7 xs_zmq.7
MAN_DOC = $(MAN1) $(MAN3) $(MAN7)
diff --git a/doc/xs.txt b/doc/xs.txt
index 93ff16a..cf5ce14 100644
--- a/doc/xs.txt
+++ b/doc/xs.txt
@@ -179,9 +179,8 @@ provided by the vendor of their language binding.
ZEROMQ COMPATIBILITY
--------------------
The Crossroads library provides an optional drop-in 'libzmq' compatibility
-library for ZeroMQ applications. If your version of Crossroads was built with
-the `--enable-libzmq` option, you can find the compatibility library
-documentation in linkxs:zmq[7].
+library for ZeroMQ applications. See linkxs:xs_zmq[7] for documentation on
+this option.
AUTHORS
diff --git a/doc/zmq.txt b/doc/xs_zmq.txt
index f1e1abf..310ab64 100644
--- a/doc/zmq.txt
+++ b/doc/xs_zmq.txt
@@ -1,10 +1,10 @@
-zmq(7)
-======
+xs_zmq(7)
+=========
NAME
----
-zmq - Crossroads I/O ZeroMQ compatibility library
+xs_zmq - Crossroads I/O ZeroMQ compatibility library
SYNOPSIS
@@ -20,21 +20,23 @@ This 'libzmq' compatibility library is provided by the Crossroads I/O project
as a transitional drop-in replacement for existing applications and language
bindings written for the ZeroMQ library.
-The interfaces provided emulate those provided by ZeroMQ release 2.1.11, and
-binary compatibility is provided for ABI version 1.0.0.
+The intent is to ease transition of existing ZeroMQ applications and
+language bindings to Crossroads I/O, thus this feature will not be
+maintained indefinitely and developers are strongly encouraged to migrate
+their applications to native 'libxs' interfaces.
-Existing applications can use these interfaces as a drop-in replacement for the
-ZeroMQ-provided 'libzmq' by installing the Crossroads version of this library
-in its place.
+'libzmq' interfaces provided emulate those provided by ZeroMQ release
+2.1.11, and binary compatibility is provided for ABI version 1.0.0.
-Applications can also be recompiled against this library with no code or build
-system changes.
+Existing applications can use these interfaces as a drop-in replacement for
+the ZeroMQ-provided 'libzmq' by installing the Crossroads version of this
+library in its place. Applications can also be recompiled against this
+library with no code or build system changes.
IMPORTANT: The 'libzmq' compatibility library is an optional component of
-the Crossroads project, intended as a way to ease transition of existing
-applications and language bindings to the native 'libxs' interfaces, this
-feature will not be maintained indefinitely, hence developers are strongly
-encouraged to migrate their applications to 'libxs'.
+Crossroads I/O, and is only built and installed if your copy of the
+Crossroads library was configured with `--enable-libzmq` at build time.
+
CONSTANTS
---------