diff options
Diffstat (limited to 'doc')
80 files changed, 916 insertions, 251 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 3c7b20b..ba2b64a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -17,7 +17,7 @@ if INSTALL_MAN dist_man_MANS = $(MAN_DOC) endif -EXTRA_DIST = $(MAN_TXT) +EXTRA_DIST = asciidoc.conf $(MAN_TXT) if BUILD_DOC EXTRA_DIST += $(MAN_HTML) endif diff --git a/doc/Makefile.in b/doc/Makefile.in index c75a926..8948f1c 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -201,7 +201,7 @@ MAN_DOC = $(MAN1) $(MAN3) $(MAN7) MAN_TXT = $(MAN1:%.1=%.txt) $(MAN3:%.3=%.txt) $(MAN7:%.7=%.txt) MAN_HTML = $(MAN_TXT:%.txt=%.html) @INSTALL_MAN_TRUE@dist_man_MANS = $(MAN_DOC) -EXTRA_DIST = $(MAN_TXT) $(am__append_1) +EXTRA_DIST = asciidoc.conf $(MAN_TXT) $(am__append_1) MAINTAINERCLEANFILES = $(MAN_DOC) $(MAN_HTML) @BUILD_DOC_TRUE@SUFFIXES = .html .txt .xml .1 .3 .7 all: all-am @@ -217,9 +217,9 @@ $(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps) exit 1;; \ esac; \ done; \ - echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --foreign doc/Makefile'; \ cd $(top_srcdir) && \ - $(AUTOMAKE) --gnu doc/Makefile + $(AUTOMAKE) --foreign doc/Makefile .PRECIOUS: Makefile Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status @case '$?' in \ diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf new file mode 100644 index 0000000..d73d711 --- /dev/null +++ b/doc/asciidoc.conf @@ -0,0 +1,56 @@ +[paradef-default] +literal-style=template="literalparagraph" + +[macros] +(?su)[\\]?(?P<name>linkzmq):(?P<target>\S*?)\[(?P<attrlist>.*?)\]= + +ifdef::backend-docbook[] +[linkzmq-inlinemacro] +{0%{target}} +{0#<citerefentry>} +{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} +{0#</citerefentry>} +endif::backend-docbook[] + +ifdef::backend-xhtml11[] +[linkzmq-inlinemacro] +<a href="{target}.html">{target}{0?({0})}</a> +endif::backend-xhtml11[] + +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[header] +template::[header-declarations] +<refentry> +<refmeta> +<refentrytitle>{mantitle}</refentrytitle> +<manvolnum>{manvolnum}</manvolnum> +<refmiscinfo class="source">0MQ</refmiscinfo> +<refmiscinfo class="version">{zmq_version}</refmiscinfo> +<refmiscinfo class="manual">0MQ Manual</refmiscinfo> +</refmeta> +<refnamediv> + <refname>{manname}</refname> + <refpurpose>{manpurpose}</refpurpose> +</refnamediv> +endif::backend-docbook[] +endif::doctype-manpage[] + +ifdef::backend-xhtml11[] +[footer] +</div> +{disable-javascript%<div id="footnotes"><hr /></div>} +<div id="footer"> +<div id="footer-text"> +ØMQ {zmq_version}<br /> +Last updated {docdate} {doctime} +</div> +</div> +</body> +</html> +endif::backend-xhtml11[] + +[replacements] +ifdef::backend-xhtml11[] +0MQ=ØMQ +endif::backend-xhtml11[] @@ -2,12 +2,12 @@ .\" Title: zmq .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 06/04/2010 +.\" Date: 09/06/2010 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.0.7 +.\" Source: 0MQ 2.0.9 .\" Language: English .\" -.TH "ZMQ" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -63,7 +63,7 @@ Terminate 0MQ context \fBThread safety\fR .RS 4 .sp -A 0MQ \fIcontext\fR is thread safe and may be shared among as many application threads as the application has requested using the \fIapp_threads\fR parameter to \fIzmq_init()\fR, without any additional locking required on the part of the caller\&. Each 0MQ socket belonging to a particular \fIcontext\fR may only be used by \fBthe thread that created it\fR using \fIzmq_socket()\fR\&. +A 0MQ \fIcontext\fR is thread safe and may be shared among as many application threads as necessary, without any additional locking required on the part of the caller\&. Each 0MQ socket belonging to a particular \fIcontext\fR may only be used by \fBthe thread that created it\fR using \fIzmq_socket()\fR\&. .RE .sp .it 1 an-trap diff --git a/doc/zmq.html b/doc/zmq.html index 934381a..c73f990 100644 --- a/doc/zmq.html +++ b/doc/zmq.html @@ -620,8 +620,7 @@ Terminate ØMQ context </dl></div>
<h4 id="_thread_safety">Thread safety</h4>
<div class="paragraph"><p>A ØMQ <em>context</em> is thread safe and may be shared among as many application
-threads as the application has requested using the <em>app_threads</em> parameter to
-<em>zmq_init()</em>, without any additional locking required on the part of the
+threads as necessary, without any additional locking required on the part of the
caller. Each ØMQ socket belonging to a particular <em>context</em> may only be used
by <strong>the thread that created it</strong> using <em>zmq_socket()</em>.</p></div>
<h4 id="_multiple_contexts">Multiple contexts</h4>
@@ -859,7 +858,8 @@ included with the ØMQ distribution.</p></div> <div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2010-06-03 14:07:32 CEST
+ØMQ 2.0.9<br />
+Last updated 2010-09-06 07:11:47 CEST
</div>
</div>
</body>
diff --git a/doc/zmq.txt b/doc/zmq.txt index d13f572..06658c9 100644 --- a/doc/zmq.txt +++ b/doc/zmq.txt @@ -44,8 +44,7 @@ Terminate 0MQ context:: Thread safety ^^^^^^^^^^^^^ A 0MQ 'context' is thread safe and may be shared among as many application -threads as the application has requested using the _app_threads_ parameter to -_zmq_init()_, without any additional locking required on the part of the +threads as necessary, without any additional locking required on the part of the caller. Each 0MQ socket belonging to a particular 'context' may only be used by *the thread that created it* using _zmq_socket()_. diff --git a/doc/zmq_bind.3 b/doc/zmq_bind.3 index 164989e..3d37d82 100644 --- a/doc/zmq_bind.3 +++ b/doc/zmq_bind.3 @@ -2,12 +2,12 @@ .\" Title: zmq_bind .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 06/04/2010 +.\" Date: 09/06/2010 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.0.7 +.\" Source: 0MQ 2.0.9 .\" Language: English .\" -.TH "ZMQ_BIND" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_BIND" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -113,6 +113,13 @@ associated with the specified \fIsocket\fR was terminated\&. .RE +.PP +\fBEFAULT\fR +.RS 4 +The provided +\fIsocket\fR +was not valid (NULL)\&. +.RE .SH "EXAMPLE" .PP \fBBinding a publisher socket to an in-process and a TCP transport\fR. diff --git a/doc/zmq_bind.html b/doc/zmq_bind.html index 5035f0c..cd759ea 100644 --- a/doc/zmq_bind.html +++ b/doc/zmq_bind.html @@ -689,6 +689,14 @@ The requested <em>address</em> specifies a nonexistent interface. The ØMQ <em>context</em> associated with the specified <em>socket</em> was terminated.
</p>
</dd>
+<dt class="hdlist1">
+<strong>EFAULT</strong>
+</dt>
+<dd>
+<p>
+The provided <em>socket</em> was not valid (NULL).
+</p>
+</dd>
</dl></div>
</div>
<h2 id="_example">EXAMPLE</h2>
@@ -722,7 +730,8 @@ Martin Lucina <<a href="mailto:mato@kotelna.sk">mato@kotelna.sk</a>>.</p>< <div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2010-06-01 21:45:12 CEST
+ØMQ 2.0.9<br />
+Last updated 2010-09-06 07:11:47 CEST
</div>
</div>
</body>
diff --git a/doc/zmq_bind.txt b/doc/zmq_bind.txt index a74e81d..7aa5a0b 100644 --- a/doc/zmq_bind.txt +++ b/doc/zmq_bind.txt @@ -56,6 +56,8 @@ The requested 'address' was not local. The requested 'address' specifies a nonexistent interface. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_close.3 b/doc/zmq_close.3 index 7ea5e3f..d8f2d0e 100644 --- a/doc/zmq_close.3 +++ b/doc/zmq_close.3 @@ -2,12 +2,12 @@ .\" Title: zmq_close .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 06/04/2010 +.\" Date: 09/06/2010 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.0.7 +.\" Source: 0MQ 2.0.9 .\" Language: English .\" -.TH "ZMQ_CLOSE" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_CLOSE" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,8 +39,13 @@ The \fIzmq_close()\fR function shall destroy the socket referenced by the \fIsoc .sp The \fIzmq_close()\fR function shall return zero if successful\&. Otherwise it shall return \-1 and set \fIerrno\fR to one of the values defined below\&. .SH "ERRORS" -.sp -No errors are defined\&. +.PP +\fBEFAULT\fR +.RS 4 +The provided +\fIsocket\fR +was not valid (NULL)\&. +.RE .SH "SEE ALSO" .sp \fBzmq_socket\fR(3) \fBzmq_term\fR(3) \fBzmq\fR(7) diff --git a/doc/zmq_close.html b/doc/zmq_close.html index ebdfa9f..e8ab194 100644 --- a/doc/zmq_close.html +++ b/doc/zmq_close.html @@ -601,7 +601,16 @@ return <tt>-1</tt> and set <em>errno</em> to one of the values defined below.</p </div>
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>No errors are defined.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<strong>EFAULT</strong>
+</dt>
+<dd>
+<p>
+The provided <em>socket</em> was not valid (NULL).
+</p>
+</dd>
+</dl></div>
</div>
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
@@ -618,7 +627,8 @@ Martin Lucina <<a href="mailto:mato@kotelna.sk">mato@kotelna.sk</a>>.</p>< <div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2010-03-10 12:14:55 CEST
+ØMQ 2.0.9<br />
+Last updated 2010-09-06 07:11:47 CEST
</div>
</div>
</body>
diff --git a/doc/zmq_close.txt b/doc/zmq_close.txt index f944bda..e903437 100644 --- a/doc/zmq_close.txt +++ b/doc/zmq_close.txt @@ -31,7 +31,8 @@ return `-1` and set 'errno' to one of the values defined below. ERRORS ------ -No errors are defined. +*EFAULT*:: +The provided 'socket' was not valid (NULL). SEE ALSO diff --git a/doc/zmq_connect.3 b/doc/zmq_connect.3 index 69e67c4..695daa0 100644 --- a/doc/zmq_connect.3 +++ b/doc/zmq_connect.3 @@ -2,12 +2,12 @@ .\" Title: zmq_connect .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 06/04/2010 +.\" Date: 09/06/2010 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.0.7 +.\" Source: 0MQ 2.0.9 .\" Language: English .\" -.TH "ZMQ_CONNECT" "3" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_CONNECT" "3" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -108,6 +108,13 @@ associated with the specified \fIsocket\fR was terminated\&. .RE +.PP +\fBEFAULT\fR +.RS 4 +The provided +\fIsocket\fR +was not valid (NULL)\&. +.RE .SH "EXAMPLE" .PP \fBConnecting a subscriber socket to an in-process and a TCP transport\fR. diff --git a/doc/zmq_connect.html b/doc/zmq_connect.html index 9b7c4e9..4e33d65 100644 --- a/doc/zmq_connect.html +++ b/doc/zmq_connect.html @@ -675,6 +675,14 @@ The requested <em>transport</em> protocol is not compatible with the socket type The ØMQ <em>context</em> associated with the specified <em>socket</em> was terminated.
</p>
</dd>
+<dt class="hdlist1">
+<strong>EFAULT</strong>
+</dt>
+<dd>
+<p>
+The provided <em>socket</em> was not valid (NULL).
+</p>
+</dd>
</dl></div>
</div>
<h2 id="_example">EXAMPLE</h2>
@@ -708,7 +716,8 @@ Martin Lucina <<a href="mailto:mato@kotelna.sk">mato@kotelna.sk</a>>.</p>< <div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2010-06-01 21:45:12 CEST
+ØMQ 2.0.9<br />
+Last updated 2010-09-06 07:11:47 CEST
</div>
</div>
</body>
diff --git a/doc/zmq_connect.txt b/doc/zmq_connect.txt index 0061c37..ffcf3b4 100644 --- a/doc/zmq_connect.txt +++ b/doc/zmq_connect.txt @@ -54,6 +54,8 @@ The requested 'transport' protocol is not supported. The requested 'transport' protocol is not compatible with the socket type. *ETERM*:: The 0MQ 'context' associated with the specified 'socket' was terminated. +*EFAULT*:: +The provided 'socket' was not valid (NULL). EXAMPLE diff --git a/doc/zmq_cpp.7 b/doc/zmq_cpp.7 index 612ecec..0203dfc 100644 --- a/doc/zmq_cpp.7 +++ b/doc/zmq_cpp.7 @@ -2,12 +2,12 @@ .\" Title: zmq_cpp .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 06/04/2010 +.\" Date: 09/06/2010 .\" Manual: 0MQ Manual -.\" Source: 0MQ 2.0.7 +.\" Source: 0MQ 2.0.9 .\" Language: English .\" -.TH "ZMQ_CPP" "7" "06/04/2010" "0MQ 2\&.0\&.7" "0MQ Manual" +.TH "ZMQ_CPP" "7" "09/06/2010" "0MQ 2\&.0\&.9" "0MQ Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -345,6 +345,16 @@ Equivalent to calling the \fIzmq_msg_close()\fR function followed by the corresp .RE .SS "Input/output multiplexing" .sp +.if n \{\ +.RS 4 +.\} +.nf +\fBint poll (zmq_pollitem_t *items, int nitems, long timeout = \-1)\fR +.fi +.if n \{\ +.RE +.\} +.sp The \fIpoll()\fR function is a namespaced equivalent of the \fIzmq_poll()\fR function, as described in \fBzmq_poll\fR(3)\&. .if n \{\ .sp diff --git a/doc/zmq_cpp.html b/doc/zmq_cpp.html index c373f8e..13a8761 100644 --- a/doc/zmq_cpp.html +++ b/doc/zmq_cpp.html @@ -707,6 +707,10 @@ functions to construct, destruct and manipulate ØMQ messages.</p></div> <div class="paragraph"><p>Equivalent to calling the <em>zmq_msg_close()</em> function followed by the
corresponding <em>zmq_msg_init()</em> function.</p></div>
<h3 id="_input_ |