Commit 79da450b authored by Pieter Hintjens's avatar Pieter Hintjens

Fixed formatting in man page

parent 0404b3b6
...@@ -42,6 +42,7 @@ tests/test_connect_resolve ...@@ -42,6 +42,7 @@ tests/test_connect_resolve
tests/test_connect_delay tests/test_connect_delay
tests/test_term_endpoint tests/test_term_endpoint
tests/test_router_mandatory tests/test_router_mandatory
tests/test_raw_sock
src/platform.hpp* src/platform.hpp*
src/stamp-h1 src/stamp-h1
perf/local_lat perf/local_lat
......
...@@ -117,6 +117,7 @@ Option value unit:: N/A (bitmap) ...@@ -117,6 +117,7 @@ Option value unit:: N/A (bitmap)
Default value:: 0 Default value:: 0
Applicable socket types:: N/A Applicable socket types:: N/A
ZMQ_IDENTITY: Set socket identity ZMQ_IDENTITY: Set socket identity
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_IDENTITY' option shall retrieve the identity of the specified 'socket'. The 'ZMQ_IDENTITY' option shall retrieve the identity of the specified 'socket'.
...@@ -270,7 +271,6 @@ Applicable socket types:: all, only for connection-oriented transports ...@@ -270,7 +271,6 @@ Applicable socket types:: all, only for connection-oriented transports
ZMQ_MAXMSGSIZE: Maximum acceptable inbound message size ZMQ_MAXMSGSIZE: Maximum acceptable inbound message size
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The option shall retrieve limit for the inbound messages. If a peer sends The option shall retrieve limit for the inbound messages. If a peer sends
a message larger than ZMQ_MAXMSGSIZE it is disconnected. Value of -1 means a message larger than ZMQ_MAXMSGSIZE it is disconnected. Value of -1 means
'no limit'. 'no limit'.
...@@ -284,7 +284,6 @@ Applicable socket types:: all ...@@ -284,7 +284,6 @@ Applicable socket types:: all
ZMQ_MULTICAST_HOPS: Maximum network hops for multicast packets ZMQ_MULTICAST_HOPS: Maximum network hops for multicast packets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The option shall retrieve time-to-live used for outbound multicast packets. The option shall retrieve time-to-live used for outbound multicast packets.
The default of 1 means that the multicast packets don't leave the local network. The default of 1 means that the multicast packets don't leave the local network.
...@@ -297,7 +296,6 @@ Applicable socket types:: all, when using multicast transports ...@@ -297,7 +296,6 @@ Applicable socket types:: all, when using multicast transports
ZMQ_RCVTIMEO: Maximum time before a socket operation returns with EAGAIN 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`, 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 _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 message to receive. If the value is `-1`, it will block until a message is
...@@ -313,7 +311,6 @@ Applicable socket types:: all ...@@ -313,7 +311,6 @@ Applicable socket types:: all
ZMQ_SNDTIMEO: Maximum time before a socket operation returns with EAGAIN 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`, 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 _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. cannot be sent. If the value is `-1`, it will block until the message is sent.
...@@ -329,7 +326,6 @@ Applicable socket types:: all ...@@ -329,7 +326,6 @@ Applicable socket types:: all
ZMQ_IPV4ONLY: Retrieve IPv4-only socket override status ZMQ_IPV4ONLY: Retrieve IPv4-only socket override status
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve the underlying native socket type. A value of `1` will use IPv4 Retrieve the underlying native socket type. A value of `1` will use IPv4
sockets, while the value of `0` will use IPv6 sockets. An IPv6 socket sockets, while the value of `0` will use IPv6 sockets. An IPv6 socket
lets applications connect to and accept connections from both IPv4 and IPv6 lets applications connect to and accept connections from both IPv4 and IPv6
...@@ -342,9 +338,8 @@ Default value:: 1 (true) ...@@ -342,9 +338,8 @@ Default value:: 1 (true)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_DELAY_ATTACH_ON_CONNECT ZMQ_DELAY_ATTACH_ON_CONNECT: Retrieve attach-on-connect value
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve the state of the attach on connect value. If set to `1`, will delay the Retrieve the state of the attach on connect value. If set to `1`, will delay the
attachment of a pipe on connect until the underlying connection has completed. attachment of a pipe on connect until the underlying connection has completed.
This will cause the socket to block if there are no other connections, but will This will cause the socket to block if there are no other connections, but will
...@@ -413,6 +408,7 @@ Option value unit:: N/A (flags) ...@@ -413,6 +408,7 @@ Option value unit:: N/A (flags)
Default value:: N/A Default value:: N/A
Applicable socket types:: all Applicable socket types:: all
ZMQ_LAST_ENDPOINT: Retrieve the last endpoint set ZMQ_LAST_ENDPOINT: Retrieve the last endpoint set
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The 'ZMQ_LAST_ENDPOINT' option shall retrieve the last endpoint bound for The 'ZMQ_LAST_ENDPOINT' option shall retrieve the last endpoint bound for
...@@ -426,6 +422,7 @@ Option value unit:: N/A ...@@ -426,6 +422,7 @@ Option value unit:: N/A
Default value:: NULL Default value:: NULL
Applicable socket types:: all, when binding TCP or IPC transports Applicable socket types:: all, when binding TCP or IPC transports
ZMQ_TCP_KEEPALIVE: Override SO_KEEPALIVE socket option ZMQ_TCP_KEEPALIVE: Override SO_KEEPALIVE socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Override 'SO_KEEPALIVE' socket option(where supported by OS). Override 'SO_KEEPALIVE' socket option(where supported by OS).
...@@ -437,6 +434,7 @@ Option value unit:: -1,0,1 ...@@ -437,6 +434,7 @@ Option value unit:: -1,0,1
Default value:: -1 (leave to OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_IDLE: Override TCP_KEEPCNT(or TCP_KEEPALIVE on some OS) ZMQ_TCP_KEEPALIVE_IDLE: Override TCP_KEEPCNT(or TCP_KEEPALIVE on some OS)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Override 'TCP_KEEPCNT'(or 'TCP_KEEPALIVE' on some OS) socket option(where supported by OS). Override 'TCP_KEEPCNT'(or 'TCP_KEEPALIVE' on some OS) socket option(where supported by OS).
...@@ -448,6 +446,7 @@ Option value unit:: -1,>0 ...@@ -448,6 +446,7 @@ Option value unit:: -1,>0
Default value:: -1 (leave to OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_CNT: Override TCP_KEEPCNT socket option ZMQ_TCP_KEEPALIVE_CNT: Override TCP_KEEPCNT socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Override 'TCP_KEEPCNT' socket option(where supported by OS). Override 'TCP_KEEPCNT' socket option(where supported by OS).
...@@ -459,6 +458,7 @@ Option value unit:: -1,>0 ...@@ -459,6 +458,7 @@ Option value unit:: -1,>0
Default value:: -1 (leave to OS default) Default value:: -1 (leave to OS default)
Applicable socket types:: all, when using TCP transports. Applicable socket types:: all, when using TCP transports.
ZMQ_TCP_KEEPALIVE_INTVL: Override TCP_KEEPINTVL socket option ZMQ_TCP_KEEPALIVE_INTVL: Override TCP_KEEPINTVL socket option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Override 'TCP_KEEPINTVL' socket option(where supported by OS). Override 'TCP_KEEPINTVL' socket option(where supported by OS).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment