0
0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-27 15:41:05 +08:00

Revert "Various changes to documentation project:"

This reverts commit 77a3c36ff1f11215229a4efdb821a3cb83a9d6fc.
This commit is contained in:
Martin Lucina 2010-09-04 15:55:11 +02:00
parent 4cb6dbd52f
commit 32baeb610e
33 changed files with 155 additions and 156 deletions

View File

@ -33,21 +33,6 @@ template::[header-declarations]
<refname>{manname}</refname> <refname>{manname}</refname>
<refpurpose>{manpurpose}</refpurpose> <refpurpose>{manpurpose}</refpurpose>
</refnamediv> </refnamediv>
[footer]
<refsect1 id="_authors">
<title>AUTHORS</title>
<simpara>Man pages by Martin Lucina &lt;<ulink url="mailto:mato@kotelna.sk">mato@kotelna.sk</ulink>&gt;, Martin Sustrik &lt;<ulink url="mailto:sustrik@250bpm.com">sustrik@250bpm.com</ulink>&gt;, and Pieter Hintjens &lt;<ulink url="mailto:ph@imatix.com">ph@imatix.com</ulink>&gt;.</simpara>
</refsect1>
<refsect1 id="_resources">
<title>RESOURCES</title>
<simpara>Main web site: <ulink url="http://www.zeromq.org/">http://www.zeromq.org/</ulink></simpara>
<simpara>Report bugs to the 0MQ development mailing list: &lt;<ulink url="mailto:zeromq-dev@lists.zeromq.org">zeromq-dev@lists.zeromq.org</ulink>&gt;</simpara>
</refsect1>
<refsect1 id="_copyright">
<title>COPYRIGHT</title>
<simpara>Copyright (c) 2007-2010 iMatix Corporation and contributors. License LGPLv3+: GNU LGPL 3 or later &lt;<ulink url="http://gnu.org/licenses/lgpl.html">http://gnu.org/licenses/lgpl.html</ulink>&gt;. This is free software: you are free to change it and redistribute it. There is NO WARRANTY, to the extent permitted by law. For details see the files <literal>COPYING</literal> and <literal>COPYING.LESSER</literal> included with the 0MQ distribution.</simpara>
</refsect1>
</refentry>
endif::backend-docbook[] endif::backend-docbook[]
endif::doctype-manpage[] endif::doctype-manpage[]

View File

@ -199,3 +199,22 @@ Other language bindings
Other language bindings (Python, Ruby, Java and more) are provided by members Other language bindings (Python, Ruby, Java and more) are provided by members
of the 0MQ community and pointers can be found on the 0MQ website. of the 0MQ community and pointers can be found on the 0MQ website.
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
RESOURCES
---------
Main web site: <http://www.zeromq.org/>
Report bugs to the 0MQ development mailing list: <zeromq-dev@lists.zeromq.org>
COPYING
-------
Free use of this software is granted under the terms of the GNU Lesser General
Public License (LGPL). For details see the files `COPYING` and `COPYING.LESSER`
included with the 0MQ distribution.

View File

@ -70,8 +70,8 @@ assert (socket);
/* Bind it to a in-process transport with the address 'my_publisher' */ /* Bind it to a in-process transport with the address 'my_publisher' */
int rc = zmq_bind (socket, "inproc://my_publisher"); int rc = zmq_bind (socket, "inproc://my_publisher");
assert (rc == 0); assert (rc == 0);
/* Bind it to a TCP transport on port 5555 of all local interfaces */ /* Bind it to a TCP transport on port 5555 of the 'eth0' interface */
rc = zmq_bind (socket, "tcp://*:5555"); rc = zmq_bind (socket, "tcp://eth0:5555");
assert (rc == 0); assert (rc == 0);
---- ----
@ -82,3 +82,8 @@ linkzmq:zmq_connect[3]
linkzmq:zmq_socket[3] linkzmq:zmq_socket[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -42,3 +42,7 @@ linkzmq:zmq_term[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -81,3 +81,7 @@ linkzmq:zmq_socket[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -204,3 +204,7 @@ SEE ALSO
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -1,123 +0,0 @@
zmq_deviced(1)
==============
NAME
----
zmq_deviced - start built-in 0MQ devices
SYNOPSIS
--------
*zmq_deviced _DEVICE_ _FRONTEND_ _BACKEND_*
*zmq_deviced [_CONFIGFILE_]*
DESCRIPTION
-----------
Starts one or more 0MQ devices. If you specify a DEVICE, FRONTEND, and BACKEND then _zmq_device_ starts a single device acting as a mini-broker. If you specify a CONFIGFILE, you can configure _zmq_device_ to start multiple concurrent devices with arbitrary configurations.
*Note* - zmq_deviced is not yet implemented. This is a design.
MINI-BROKER USAGE
-----------------
Runs as a mini-broker that accepts connects to both frontend and backend. This creates a hub-and-spoke topology in which all peers connect to the device. This is a robust and easy to manage topology.
DEVICE is one of: *queue*, *forwarder*, or *streamer*. See linkzmq:zmq_device[3] for a specification of these device types.
FRONTEND and BACKEND are endpoints in the format 'transport'`://`'address', See linkzmq:zmq_bind[3] for a specification of valid transports and addresses.
CONFIGURED USAGE
----------------
CONFIGFILE is the name of an XML file, readable by 'zmq_device'. This file provides a specification of the devices to start and how to connect and/or bind their frontends and backends. If CONFIGFILE is absent or *-* then the configuration is read from standard input.
The configuration file has this general syntax:
----
<?xml?>
<config [ iothreads="..." ] >
<device type="...">
<frontend [ type="..." ] >
<set name = "..." value = "..." />...
<bind endpoint="..." /> ...
<connect address="..." /> ...
</frontend>
<backend [ type="..." ] >
<set name = "..." value = "..." />...
<bind address="..." /> ...
<connect address="..." /> ...
</backend>
</device>
</config>
----
*iothreads*::
specifies the number of I/O threads for the process. Specify this only for high-volume scenarios. See linkzmq:zmq_init[3].
*device*::
defines one device. For each device element you define, 'zmq_device' will start a thread.
*frontend*::
defines the frontend for the device. Occurs once per device element. You may override the default socket type.
*backend*::
defines the backend for the device. Occurs once per device element. You may override the default socket type.
*set*::
defines a socket option for the frontend or backend. The valid names are *hwm*, *swap*, *identity*, *subscribe*, *unsubscribe*, *rate*, *recovery_ivl*, *mcast_loop*, *sndbuf*, and *rcvbuf*. See linkzmq:zmq_setsockopt[3].
*bind*::
binds the frontend or backend to the specified endpoint. See linkzmq:zmq_bind[3].
*connect*::
binds the frontend or backend to the specified endpoint. See linkzmq:zmq_connect[3].
SOCKET TYPES
------------
By default 'zmq_device' uses these socket types:
*queue* device::
frontend is *xrep*, backend is *xreq*.
*forwarder* device::
frontend is *sub*, backend is *pub*.
*streamer* device::
frontend is *pull*, backend is *push*.
You can override the socket type for frontend or backend. The valid types are: *req*, *rep*, *xreq*, *xrep*, *sub*, *pub*, *pull*, *push*, and *pair*. See linkzmq:zmq_socket[3].
*Note*: if you use a *sub* socket you must explicitly set a subscription filter or your socket will not receive any data.
EXAMPLE
-------
.Creating a queue broker
----
zmq_device queue tcp://*:5050 tcp://*:5051
----
.A TCP-to-multicast proxy forwarder
----
zmq_device -
<?xml?>
<config>
<device type="forwarder">
<frontend>
<!-- subscribe to everything -->
<set name = "subscribe" value = "" />
<!-- connect to two publishers -->
<connect address="tcp://192.168.55.112:5055" />
<connect address="tcp://192.168.55.114:5055" />
</frontend>
<backend>
<!-- bind to epgm group via eth0 -->
<bind address="epgm://eth0;239.192.1.1:5555" />
</backend>
</device>
</config>
----
SEE ALSO
--------
linkzmq:zmq_device[3]
linkzmq:zmq_init[3]
linkzmq:zmq_setsockopt[3]
linkzmq:zmq_bind[3]
linkzmq:zmq_connect[3]
linkzmq:zmq[7]

View File

@ -44,3 +44,7 @@ SEE ALSO
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -27,3 +27,7 @@ SEE ALSO
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -237,3 +237,7 @@ linkzmq:zmq_socket[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -40,3 +40,7 @@ linkzmq:zmq[7]
linkzmq:zmq_term[3] linkzmq:zmq_term[3]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -83,3 +83,7 @@ linkzmq:zmq_pgm[7]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -74,3 +74,7 @@ linkzmq:zmq_pgm[7]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -48,3 +48,7 @@ linkzmq:zmq_msg_size[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -50,3 +50,7 @@ linkzmq:zmq_msg_close[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -42,3 +42,7 @@ linkzmq:zmq_msg_close[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -59,3 +59,7 @@ linkzmq:zmq_msg_size[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -74,3 +74,7 @@ linkzmq:zmq_msg_size[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -52,3 +52,7 @@ linkzmq:zmq_msg_size[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -45,3 +45,7 @@ linkzmq:zmq_msg_close[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -42,3 +42,7 @@ linkzmq:zmq_msg_close[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -151,4 +151,7 @@ linkzmq:zmq_ipc[7]
linkzmq:zmq_inproc[7] linkzmq:zmq_inproc[7]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -129,3 +129,7 @@ linkzmq:zmq[7]
Your operating system documentation for the _poll()_ system call. Your operating system documentation for the _poll()_ system call.
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -27,3 +27,7 @@ SEE ALSO
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -110,3 +110,7 @@ linkzmq:zmq_socket[7]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -105,3 +105,7 @@ linkzmq:zmq_socket[7]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -269,3 +269,7 @@ linkzmq:zmq_socket[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -216,24 +216,22 @@ is connected to at least one _node_. When a pipeline stage is connected to
multiple _nodes_ data is load-balanced among all connected _nodes_. multiple _nodes_ data is load-balanced among all connected _nodes_.
ZMQ_PUSH ZMQ_DOWNSTREAM
^^^^^^^^ ^^^^^^^^^^^^^^
A socket of type 'ZMQ_PUSH' is used by a pipeline _node_ to send messages A socket of type 'ZMQ_DOWNSTREAM' is used by a pipeline _node_ to send messages
to downstream pipeline _nodes_. Messages are load-balanced to all connected to downstream pipeline _nodes_. Messages are load-balanced to all connected
downstream _nodes_. The _zmq_recv()_ function is not implemented for this downstream _nodes_. The _zmq_recv()_ function is not implemented for this
socket type. socket type.
When a 'ZMQ_PUSH' socket enters an exceptional state due to having When a 'ZMQ_DOWNSTREAM' socket enters an exceptional state due to having
reached the high water mark for all downstream _nodes_, or if there are no reached the high water mark for all downstream _nodes_, or if there are no
downstream _nodes_ at all, then any linkzmq:zmq_send[3] operations on the downstream _nodes_ at all, then any linkzmq:zmq_send[3] operations on the
socket shall block until the exceptional state ends or at least one downstream socket shall block until the exceptional state ends or at least one downstream
_node_ becomes available for sending; messages are not discarded. _node_ becomes available for sending; messages are not discarded.
Deprecated alias: ZMQ_DOWNSTREAM.
[horizontal] [horizontal]
.Summary of ZMQ_PUSH characteristics .Summary of ZMQ_DOWNSTREAM characteristics
Compatible peer sockets:: 'ZMQ_PULL' Compatible peer sockets:: 'ZMQ_UPSTREAM'
Direction:: Unidirectional Direction:: Unidirectional
Send/receive pattern:: Send only Send/receive pattern:: Send only
Incoming routing strategy:: N/A Incoming routing strategy:: N/A
@ -241,18 +239,16 @@ Outgoing routing strategy:: Load-balanced
ZMQ_HWM option action:: Block ZMQ_HWM option action:: Block
ZMQ_PULL ZMQ_UPSTREAM
^^^^^^^^ ^^^^^^^^^^^^
A socket of type 'ZMQ_PULL' is used by a pipeline _node_ to receive A socket of type 'ZMQ_UPSTREAM' is used by a pipeline _node_ to receive
messages from upstream pipeline _nodes_. Messages are fair-queued from among messages from upstream pipeline _nodes_. Messages are fair-queued from among
all connected upstream _nodes_. The _zmq_send()_ function is not implemented all connected upstream _nodes_. The _zmq_send()_ function is not implemented
for this socket type. for this socket type.
Deprecated alias: ZMQ_UPSTREAM.
[horizontal] [horizontal]
.Summary of ZMQ_PULL characteristics .Summary of ZMQ_UPSTREAM characteristics
Compatible peer sockets:: 'ZMQ_PUSH' Compatible peer sockets:: 'ZMQ_DOWNSTREAM'
Direction:: Unidirectional Direction:: Unidirectional
Send/receive pattern:: Receive only Send/receive pattern:: Receive only
Incoming routing strategy:: Fair-queued Incoming routing strategy:: Fair-queued
@ -317,3 +313,8 @@ linkzmq:zmq_send[3]
linkzmq:zmq_recv[3] linkzmq:zmq_recv[3]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -27,3 +27,7 @@ SEE ALSO
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -49,3 +49,7 @@ SEE ALSO
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -156,3 +156,7 @@ linkzmq:zmq_inproc[7]
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -52,3 +52,8 @@ SEE ALSO
linkzmq:zmq[7] linkzmq:zmq[7]
linkzmq:zmq_init[3] linkzmq:zmq_init[3]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.

View File

@ -47,3 +47,7 @@ SEE ALSO
-------- --------
linkzmq:zmq[7] linkzmq:zmq[7]
AUTHORS
-------
The 0MQ documentation was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.