Skip to content

Commit

Permalink
Fixed man pages for release 2.2.0
Browse files Browse the repository at this point in the history
* Fixed new entries for getsockopt/setsockopt SNDTIMEO and RCVTIMEO
* Removed individual authorship from man page footers
  • Loading branch information
hintjens committed Apr 4, 2012
1 parent 87cce25 commit 0b2f5cb
Show file tree
Hide file tree
Showing 29 changed files with 95 additions and 135 deletions.
3 changes: 1 addition & 2 deletions doc/zmq.txt
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,7 @@ of the 0MQ community and pointers can be found on the 0MQ website.

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.


RESOURCES
Expand Down
3 changes: 1 addition & 2 deletions doc/zmq_bind.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_close.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_connect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -87,5 +87,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_cpp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -208,5 +208,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
16 changes: 1 addition & 15 deletions doc/zmq_device.txt
Original file line number Diff line number Diff line change
Expand Up @@ -121,18 +121,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Pieter Hintjens <ph@imatix.com>


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.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_errno.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
67 changes: 33 additions & 34 deletions doc/zmq_getsockopt.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,38 @@ Default value:: 0
Applicable socket types:: all


ZMQ_RCVTIMEO: Maximum time before a socket operation returns with EAGAIN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Retrieve the timeout for recv operation on the socket. If the value is `0`,
_zmq_recv(3)_ will return immediately, with a EAGAIN error if there is no
message to receive. If the value is `-1`, it will block until a message is
available. For all other values, it will wait for a message for that amount
of time before returning with an EAGAIN error.

[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: -1 (infinite)
Applicable socket types:: all


ZMQ_SNDTIMEO: Maximum time before a socket operation returns with EAGAIN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Retrieve the timeout for send operation on the socket. If the value is `0`,
_zmq_send(3)_ will return immediately, with a EAGAIN error if the message
cannot be sent. If the value is `-1`, it will block until the message is sent.
For all other values, it will try to send the message for that amount of time
before returning with an EAGAIN error.

[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: -1 (infinite)
Applicable socket types:: all


ZMQ_SWAP: Retrieve disk offload size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_SWAP' option shall retrieve the disk offload (swap) size for the
Expand Down Expand Up @@ -394,38 +426,6 @@ assert (rc == 0);
----


ZMQ_RCVTIMEO: Maximum time before a socket operation returns with EAGAIN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Retrieve the timeout for recv operation on the socket. If the value is `0`,
_zmq_recv(3)_ will return immediately, with a EAGAIN error if there is no
message to receive. If the value is `-1`, it will block until a message is
available. For all other values, it will wait for a message for that amount
of time before returning with an EAGAIN error.

[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: -1 (infinite)
Applicable socket types:: all


ZMQ_SNDTIMEO: Maximum time before a socket operation returns with EAGAIN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Retrieve the timeout for send operation on the socket. If the value is `0`,
_zmq_send(3)_ will return immediately, with a EAGAIN error if the message
cannot be sent. If the value is `-1`, it will block until the message is sent.
For all other values, it will try to send the message for that amount of time
before returning with an EAGAIN error.

[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: -1 (infinite)
Applicable socket types:: all


SEE ALSO
--------
linkzmq:zmq_setsockopt[3]
Expand All @@ -435,5 +435,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_init.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,4 @@ linkzmq:zmq_term[3]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_inproc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,5 +85,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_ipc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_msg_close.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_msg_copy.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_msg_data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_msg_init.txt
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_msg_init_data.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_msg_init_size.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_msg_move.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_msg_size.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
4 changes: 2 additions & 2 deletions doc/zmq_pgm.txt
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ linkzmq:zmq_ipc[7]
linkzmq:zmq_inproc[7]
linkzmq:zmq[7]


AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_poll.txt
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,4 @@ Your operating system documentation for the _poll()_ system call.

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_recv.txt
Original file line number Diff line number Diff line change
Expand Up @@ -117,5 +117,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_send.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
67 changes: 33 additions & 34 deletions doc/zmq_setsockopt.txt
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,38 @@ Default value:: N/A
Applicable socket types:: ZMQ_SUB


ZMQ_RCVTIMEO: Maximum time before a recv operation returns with EAGAIN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sets the timeout for receive operation on the socket. If the value is `0`,
_zmq_recv(3)_ will return immediately, with a EAGAIN error if there is no
message to receive. If the value is `-1`, it will block until a message is
available. For all other values, it will wait for a message for that amount
of time before returning with an EAGAIN error.

[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: -1 (infinite)
Applicable socket types:: all


ZMQ_SNDTIMEO: Maximum time before a send operation returns with EAGAIN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sets the timeout for send operation on the socket. If the value is `0`,
_zmq_send(3)_ will return immediately, with a EAGAIN error if the message
cannot be sent. If the value is `-1`, it will block until the message is sent.
For all other values, it will try to send the message for that amount of time
before returning with an EAGAIN error.

[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: -1 (infinite)
Applicable socket types:: all


ZMQ_RATE: Set multicast data rate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_RATE' option shall set the maximum send or receive data rate for
Expand Down Expand Up @@ -369,38 +401,6 @@ assert (rc);
----


ZMQ_RCVTIMEO: Maximum time before a recv operation returns with EAGAIN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sets the timeout for receive operation on the socket. If the value is `0`,
_zmq_recv(3)_ will return immediately, with a EAGAIN error if there is no
message to receive. If the value is `-1`, it will block until a message is
available. For all other values, it will wait for a message for that amount
of time before returning with an EAGAIN error.

[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: -1 (infinite)
Applicable socket types:: all


ZMQ_SNDTIMEO: Maximum time before a send operation returns with EAGAIN
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Sets the timeout for send operation on the socket. If the value is `0`,
_zmq_send(3)_ will return immediately, with a EAGAIN error if the message
cannot be sent. If the value is `-1`, it will block until the message is sent.
For all other values, it will try to send the message for that amount of time
before returning with an EAGAIN error.

[horizontal]
Option value type:: int
Option value unit:: milliseconds
Default value:: -1 (infinite)
Applicable socket types:: all


SEE ALSO
--------
linkzmq:zmq_getsockopt[3]
Expand All @@ -410,5 +410,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_socket.txt
Original file line number Diff line number Diff line change
Expand Up @@ -338,5 +338,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_strerror.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_tcp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -158,5 +158,4 @@ linkzmq:zmq[7]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
3 changes: 1 addition & 2 deletions doc/zmq_term.txt
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,4 @@ linkzmq:zmq_setsockopt[3]

AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.
4 changes: 2 additions & 2 deletions doc/zmq_version.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ SEE ALSO
--------
linkzmq:zmq[7]


AUTHORS
-------
This 0MQ manual page was written by Martin Sustrik <sustrik@250bpm.com> and
Martin Lucina <mato@kotelna.sk>.
This manual page was written by the 0MQ community.

0 comments on commit 0b2f5cb

Please sign in to comment.