generic-library/libzmq
1
0
Fork 0
mirror of https://github.com/zeromq/libzmq.git synced 2025-11-04 04:10:00 +01:00
Code Issues Projects Releases Wiki Activity

typos in man pages fixed

Browse Source
This commit is contained in:
Martin Sustrik
2010-01-18 13:16:14 +01:00
parent bddff50271
commit 4ceb839350
13 changed files with 42 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
.gitignore vendored
View File

@@ -16,3 +16,16 @@ autom4te.cache
.* .*
src/platform.hpp src/platform.hpp
src/stamp-h1 src/stamp-h1
devices/zmq_forwarder/zmq_forwarder
devices/zmq_queue/zmq_queue
devices/zmq_streamer/zmq_streamer
examples/chat/display
examples/chat/prompt
perf/c/local_lat
perf/c/local_thr
perf/c/remote_lat
perf/c/remote_thr
perf/cpp/local_lat
perf/cpp/local_thr
perf/cpp/remote_lat
perf/cpp/remote_thr

2
man/man3/zmq_bind.3
View File

@@ -8,7 +8,7 @@ The function binds socket
.IR s .IR s
to a particular transport. Actual semantics of the to a particular transport. Actual semantics of the
command depend on the underlying transport mechanism, however, in cases where command depend on the underlying transport mechanism, however, in cases where
peers connect in an asymetric manner, peers connect in an asymmetric manner,
.IR zmq_bind .IR zmq_bind
should be called first, should be called first,
.IR zmq_connect .IR zmq_connect

2
man/man3/zmq_connect.3
View File

@@ -9,7 +9,7 @@ The function connect socket
to the peer identified by to the peer identified by
.IR addr . .IR addr .
Actual semantics of the command depend on the underlying transport mechanism, Actual semantics of the command depend on the underlying transport mechanism,
however, in cases where peers connect in an asymetric manner, however, in cases where peers connect in an asymmetric manner,
.IR zmq_bind .IR zmq_bind
should be called first, should be called first,
.IR zmq_connect .IR zmq_connect

2
man/man3/zmq_recv.3
View File

@@ -33,7 +33,7 @@ it's a non-blocking receive and there's no message available at the moment.
function isn't supported by particular socket type. function isn't supported by particular socket type.
.IP "\fBEFSM\fP" .IP "\fBEFSM\fP"
function cannot be called at the moment, because socket is not in the function cannot be called at the moment, because socket is not in the
approprite state. This error may occur with sockets that switch between appropriate state. This error may occur with sockets that switch between
several states (e.g. ZMQ_REQ). several states (e.g. ZMQ_REQ).
.SH EXAMPLE .SH EXAMPLE
.nf .nf

2
man/man3/zmq_send.3
View File

@@ -41,7 +41,7 @@ it's a non-blocking send and message cannot be sent at the moment.
function isn't supported by particular socket type. function isn't supported by particular socket type.
.IP "\fBEFSM\fP" .IP "\fBEFSM\fP"
function cannot be called at the moment, because socket is not in the function cannot be called at the moment, because socket is not in the
approprite state. This error may occur with sockets that switch between appropriate state. This error may occur with sockets that switch between
several states (e.g. ZMQ_REQ). several states (e.g. ZMQ_REQ).
.SH EXAMPLE .SH EXAMPLE
.nf .nf

8
man/man3/zmq_socket.3
View File

@@ -21,7 +21,7 @@ single bind. There's no message routing or message filtering involved.
Compatible peer sockets: ZMQ_P2P. Compatible peer sockets: ZMQ_P2P.
.IP "\fBZMQ_PUB\fP" .IP "\fBZMQ_PUB\fP"
Socket to distribute data. Recv fuction is not implemented for this socket Socket to distribute data. Recv function is not implemented for this socket
type. Messages are distributed in fanout fashion to all the peers. type. Messages are distributed in fanout fashion to all the peers.
Compatible peer sockets: ZMQ_SUB. Compatible peer sockets: ZMQ_SUB.
@@ -50,7 +50,7 @@ Compatible peer sockets: ZMQ_REQ, ZMQ_XREQ.
.IP "\fBZMQ_XREQ\fP" .IP "\fBZMQ_XREQ\fP"
Special socket type to be used in request/reply middleboxes such as Special socket type to be used in request/reply middleboxes such as
.BR zmq_queue(7) . .BR zmq_queue(7) .
Requests forwarded using this socket type should be tagged by a proper postix Requests forwarded using this socket type should be tagged by a proper prefix
identifying the original requester. Replies received by this socket are tagged identifying the original requester. Replies received by this socket are tagged
with a proper postfix that can be use to route the reply back to the original with a proper postfix that can be use to route the reply back to the original
requester. requester.
@@ -60,9 +60,9 @@ Compatible peer sockets: ZMQ_REP, ZMQ_XREP.
.IP "\fBZMQ_XREP\fP" .IP "\fBZMQ_XREP\fP"
Special socket type to be used in request/reply middleboxes such as Special socket type to be used in request/reply middleboxes such as
.BR zmq_queue(7) . .BR zmq_queue(7) .
Requests received using this socket are already properly tagged with postfix Requests received using this socket are already properly tagged with prefix
identifying the original requester. When sending a reply via XREP socket the identifying the original requester. When sending a reply via XREP socket the
message should be tagged with a postfix from a corresponding request. message should be tagged with a prefix from a corresponding request.
Compatible peer sockets: ZMQ_REQ, ZMQ_XREQ. Compatible peer sockets: ZMQ_REQ, ZMQ_XREQ.

4
man/man7/zmq.7
View File

@@ -16,7 +16,7 @@ throughputs are to be measured in millions of messages per second.
0MQ is designed to be very thin. It requires no more than couple of 0MQ is designed to be very thin. It requires no more than couple of
pages in resident memory and is thus well suited for any environment ranging pages in resident memory and is thus well suited for any environment ranging
from small embedded devices, routers and cell phones to enterprise-scale from small embedded devices, routers and cell phones to enterprise-scale
datacenters. data centers.
0MQ runs on a wide range of operating systems and supports variety of processor 0MQ runs on a wide range of operating systems and supports variety of processor
microarchitectures. microarchitectures.
@@ -92,7 +92,7 @@ Poll for I/O events:
.BR zmq_poll(3) .BR zmq_poll(3)
.SH ERROR HANDLING .SH ERROR HANDLING
0MQ defines couple of non-POSIX error codes. Use following fuctions to handle 0MQ defines couple of non-POSIX error codes. Use following functions to handle
them neatly. them neatly.
Convert error code into human readable string: Convert error code into human readable string:

2
man/man7/zmq_cpp.7
View File

@@ -56,7 +56,7 @@ is mapped to
.BR zmq_msg_copy(3) .BR zmq_msg_copy(3)
etc. etc.
C++ provides an additional function not avialable with C API. C++ provides an additional function not available with C API.
.IR zmq::message_t::rebuild .IR zmq::message_t::rebuild
is equivalent to calling is equivalent to calling
.BR zmq_close(3) .BR zmq_close(3)

2
man/man7/zmq_inproc.7
View File

@@ -1,6 +1,6 @@
.TH zmq_inproc 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .TH zmq_inproc 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
.SH NAME .SH NAME
In-process (inter-thread) tranport for 0MQ In-process (inter-thread) transport for 0MQ
.SH SYNOPSIS .SH SYNOPSIS
In-process transport is optimised for passing messages between threads in the In-process transport is optimised for passing messages between threads in the

8
man/man7/zmq_ipc.7
View File

@@ -1,14 +1,14 @@
.TH zmq_ipc 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .TH zmq_ipc 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
.SH NAME .SH NAME
Inter-process tranport for 0MQ Inter-process transport for 0MQ
.SH SYNOPSIS .SH SYNOPSIS
In-process transport is optimised for passing messages between processes on the Inter-process transport is optimised for passing messages between processes on
same physical machine. the same physical machine.
.SH CONNECTION STRING .SH CONNECTION STRING
Connection string for inproc transport is "inproc://" followed by a file name. Connection string for inproc transport is "ipc://" followed by a file name.
The file will be used as placeholder for a message endpoint. (UNIX domain The file will be used as placeholder for a message endpoint. (UNIX domain
sockets associate a file with the listening socket in a similar way.) sockets associate a file with the listening socket in a similar way.)

10
man/man7/zmq_pgm.7
View File

@@ -1,6 +1,6 @@
.TH zmq_pgm 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .TH zmq_pgm 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
.SH NAME .SH NAME
PGM-based tranport for 0MQ PGM-based transport for 0MQ
.SH SYNOPSIS .SH SYNOPSIS
PGM is a protocol for reliable multicast (RFC3208). 0MQ's PGM transport allows PGM is a protocol for reliable multicast (RFC3208). 0MQ's PGM transport allows
@@ -20,11 +20,11 @@ PGM transport can be used only with ZMQ_PUB and ZMQ_SUB sockets.
.SH CONNECTION STRING .SH CONNECTION STRING
Connection string for PGM transport is "pgm://" followed by an IP adress Connection string for PGM transport is "pgm://" followed by an IP address
of the NIC to use, semicolon, IP adress of the multicast group, colon and of the NIC to use, semicolon, IP address of the multicast group, colon and
port numbrt. IP address of the NIC can be either its numeric representation port number. IP address of the NIC can be either its numeric representation
or the name of the NIC as reported by operating system. IP address of the or the name of the NIC as reported by operating system. IP address of the
mutlicast group should be specified in the numeric representation. For example: multicast group should be specified in the numeric representation. For example:
.nf .nf
pgm://eth0:224.0.0.1:5555 pgm://eth0:224.0.0.1:5555

4
man/man7/zmq_tcp.7
View File

@@ -1,6 +1,6 @@
.TH zmq_tcp 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .TH zmq_tcp 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
.SH NAME .SH NAME
TCP-based tranport for 0MQ TCP-based transport for 0MQ
.SH SYNOPSIS .SH SYNOPSIS
TCP is an ubiquitous unicast transport. When connecting distributed TCP is an ubiquitous unicast transport. When connecting distributed
@@ -8,7 +8,7 @@ applications, you will mostly use TCP transport.
.SH CONNECTION STRING .SH CONNECTION STRING
Connection string for TCP transport is "tcp://" followed by an IP adress, Connection string for TCP transport is "tcp://" followed by an IP address,
colon and port number. IP address can be either its numeric representation, colon and port number. IP address can be either its numeric representation,
a NIC name or a hostname (resolved by DNS): a NIC name or a hostname (resolved by DNS):

12
man/man7/zmq_udp.7
View File

@@ -1,22 +1,22 @@
.TH zmq_udp 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .TH zmq_udp 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals"
.SH NAME .SH NAME
UDP-based tranport for 0MQ UDP-based transport for 0MQ
.SH SYNOPSIS .SH SYNOPSIS
UDP transport is exactly the same as PGM transport except that PGM packets UDP transport is exactly the same as PGM transport except that PGM packets
are encapsulated in UDP packets. Rationale for this transport is that user-space are encapsulated in UDP packets. Rationale for this transport is that user-space
implementation of PGM requires right to create raw sockets (PGM is located implementation of PGM requires right to create raw sockets (PGM is located
directly on top of IP layer in the netwroking stack), which is often not directly on top of IP layer in the networking stack), which is often not
available. UDP encapsulation solves this problem, however, it adds some overhead available. UDP encapsulation solves this problem, however, it adds some overhead
related to creating and transferring UDP packet headers. related to creating and transferring UDP packet headers.
.SH CONNECTION STRING .SH CONNECTION STRING
Connection string for UDP transport is "udp://" followed by an IP adress Connection string for UDP transport is "udp://" followed by an IP address
of the NIC to use, semicolon, IP adress of the multicast group, colon and of the NIC to use, semicolon, IP address of the multicast group, colon and
port numbrt. IP address of the NIC can be either its numeric representation port number. IP address of the NIC can be either its numeric representation
or the name of the NIC as reported by operating system. IP address of the or the name of the NIC as reported by operating system. IP address of the
mutlicast group should be specified in the numeric representation. For example: multicast group should be specified in the numeric representation. For example:
.nf .nf
udp://eth0:224.0.0.1:5555 udp://eth0:224.0.0.1:5555