diff options
Diffstat (limited to 'man')
33 files changed, 41 insertions, 35 deletions
diff --git a/man/convert2pdf.sh b/man/convert2pdf.sh index 8f41e0e..f8ab00c 100755 --- a/man/convert2pdf.sh +++ b/man/convert2pdf.sh @@ -1,6 +1,6 @@ #!/bin/sh # -# Copyright (c) 2007-2009 FastMQ Inc. +# Copyright (c) 2007-2010 iMatix Corporation # # This file is part of 0MQ. # diff --git a/man/man1/zmq_forwarder.1 b/man/man1/zmq_forwarder.1 index 610767a..b45d9c8 100644 --- a/man/man1/zmq_forwarder.1 +++ b/man/man1/zmq_forwarder.1 @@ -1,4 +1,4 @@ -.TH zmq_forwarder 1 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_forwarder 1 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_forwarder \- forwards the stream of PUB/SUB messages .SH SYNOPSIS diff --git a/man/man1/zmq_queue.1 b/man/man1/zmq_queue.1 index 25aeab6..da29d86 100644 --- a/man/man1/zmq_queue.1 +++ b/man/man1/zmq_queue.1 @@ -1,4 +1,4 @@ -.TH zmq_queue 1 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_queue 1 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_queue \- forwards REQ/REP messages .SH SYNOPSIS diff --git a/man/man1/zmq_streamer.1 b/man/man1/zmq_streamer.1 index 34b837b..deadc65 100644 --- a/man/man1/zmq_streamer.1 +++ b/man/man1/zmq_streamer.1 @@ -1,4 +1,4 @@ -.TH zmq_streamer 1 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_streamer 1 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_streamer \- forwards the stream of UPSTREAM/DOWNSTREAM messages .SH SYNOPSIS diff --git a/man/man3/zmq_bind.3 b/man/man3/zmq_bind.3 index 069b966..c4d955e 100644 --- a/man/man3/zmq_bind.3 +++ b/man/man3/zmq_bind.3 @@ -1,4 +1,4 @@ -.TH zmq_bind 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_bind 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_bind \- binds the socket to the specified address .SH SYNOPSIS diff --git a/man/man3/zmq_close.3 b/man/man3/zmq_close.3 index cc49635..b2a9274 100644 --- a/man/man3/zmq_close.3 +++ b/man/man3/zmq_close.3 @@ -1,4 +1,4 @@ -.TH zmq_close 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_close 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_close \- destroys 0MQ socket .SH SYNOPSIS diff --git a/man/man3/zmq_connect.3 b/man/man3/zmq_connect.3 index 8f09e20..5824a80 100644 --- a/man/man3/zmq_connect.3 +++ b/man/man3/zmq_connect.3 @@ -1,4 +1,4 @@ -.TH zmq_connect 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_connect 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_connect \- connect the socket to the specified peer .SH SYNOPSIS diff --git a/man/man3/zmq_flush.3 b/man/man3/zmq_flush.3 index 194cf6c..eb2a719 100644 --- a/man/man3/zmq_flush.3 +++ b/man/man3/zmq_flush.3 @@ -1,4 +1,4 @@ -.TH zmq_flush 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_flush 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_flush \- flushes pre-sent messages to the socket .SH SYNOPSIS diff --git a/man/man3/zmq_init.3 b/man/man3/zmq_init.3 index f4f7076..6b5e75f 100644 --- a/man/man3/zmq_init.3 +++ b/man/man3/zmq_init.3 @@ -1,4 +1,4 @@ -.TH zmq_init 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_init 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_init \- initialises 0MQ context .SH SYNOPSIS diff --git a/man/man3/zmq_msg_close.3 b/man/man3/zmq_msg_close.3 index 6613360..e601ea2 100644 --- a/man/man3/zmq_msg_close.3 +++ b/man/man3/zmq_msg_close.3 @@ -1,4 +1,4 @@ -.TH zmq_msg_close 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_msg_close 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_msg_close \- destroys 0MQ message .SH SYNOPSIS diff --git a/man/man3/zmq_msg_copy.3 b/man/man3/zmq_msg_copy.3 index 2f70400..acb8389 100644 --- a/man/man3/zmq_msg_copy.3 +++ b/man/man3/zmq_msg_copy.3 @@ -1,4 +1,4 @@ -.TH zmq_msg_copy 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_msg_copy 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_msg_copy \- copies content of a message to another message .SH SYNOPSIS diff --git a/man/man3/zmq_msg_data.3 b/man/man3/zmq_msg_data.3 index 9876378..ef3cba8 100644 --- a/man/man3/zmq_msg_data.3 +++ b/man/man3/zmq_msg_data.3 @@ -1,4 +1,4 @@ -.TH zmq_msg_data 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_msg_data 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_msg_data \- retrieves pointer to the message content .SH SYNOPSIS diff --git a/man/man3/zmq_msg_init.3 b/man/man3/zmq_msg_init.3 index a531fc1..80d51d2 100644 --- a/man/man3/zmq_msg_init.3 +++ b/man/man3/zmq_msg_init.3 @@ -1,4 +1,4 @@ -.TH zmq_msg_init 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_msg_init 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_msg_init \- initialises empty 0MQ message .SH SYNOPSIS diff --git a/man/man3/zmq_msg_init_data.3 b/man/man3/zmq_msg_init_data.3 index 8b51c2b..0af95be 100644 --- a/man/man3/zmq_msg_init_data.3 +++ b/man/man3/zmq_msg_init_data.3 @@ -1,4 +1,4 @@ -.TH zmq_msg_init_data 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_msg_init_data 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_msg_init \- initialises 0MQ message from the given data .SH SYNOPSIS diff --git a/man/man3/zmq_msg_init_size.3 b/man/man3/zmq_msg_init_size.3 index ce1ec94..cc7a71e 100644 --- a/man/man3/zmq_msg_init_size.3 +++ b/man/man3/zmq_msg_init_size.3 @@ -1,4 +1,4 @@ -.TH zmq_msg_init_size 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_msg_init_size 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_msg_init \- initialises 0MQ message of a specified size .SH SYNOPSIS diff --git a/man/man3/zmq_msg_move.3 b/man/man3/zmq_msg_move.3 index 810e105..8663585 100644 --- a/man/man3/zmq_msg_move.3 +++ b/man/man3/zmq_msg_move.3 @@ -1,4 +1,4 @@ -.TH zmq_msg_move 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_msg_move 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_msg_move \- moves content of a message to another message .SH SYNOPSIS diff --git a/man/man3/zmq_msg_size.3 b/man/man3/zmq_msg_size.3 index b51d582..aa1f8b0 100644 --- a/man/man3/zmq_msg_size.3 +++ b/man/man3/zmq_msg_size.3 @@ -1,4 +1,4 @@ -.TH zmq_msg_size 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_msg_size 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_msg_size \- retrieves size of the message content .SH SYNOPSIS diff --git a/man/man3/zmq_poll.3 b/man/man3/zmq_poll.3 index 9782691..f70bf18 100644 --- a/man/man3/zmq_poll.3 +++ b/man/man3/zmq_poll.3 @@ -1,8 +1,8 @@ -.TH zmq_poll 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_poll 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_poll \- polls for events on a set of 0MQ and POSIX sockets .SH SYNOPSIS -.B int zmq_poll (zmq_pollitem_t *items, int nitems); +.B int zmq_poll (zmq_pollitem_t *items, int nitems, long timeout); .SH DESCRIPTION Waits for the events specified by .IR items @@ -31,7 +31,7 @@ specifies which events to wait for. It's a combination of the values below. Once the call exits, .IR revent will be filled with events that have actually occured on the socket. The field -will contain a combination of the following values. +will contain a combination of the values below. .IP "\fBZMQ_POLLIN\fP" poll for incoming messages. @@ -40,6 +40,12 @@ wait while message can be set socket. Poll will return if a message of at least one byte can be written to the socket. However, there is no guarantee that arbitrarily large message can be sent. +.IR timeout +argument specifies an upper limit on the time for which +.IR zmq_poll +will block, in microseconds. Specifying a negative value in timeout means +an infinite timeout. + .SH RETURN VALUE Function returns number of items signaled or -1 in the case of error. .SH ERRORS diff --git a/man/man3/zmq_recv.3 b/man/man3/zmq_recv.3 index d3cf2fd..37d43d9 100644 --- a/man/man3/zmq_recv.3 +++ b/man/man3/zmq_recv.3 @@ -1,4 +1,4 @@ -.TH zmq_recv 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_recv 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_recv \- retrieves a message from the socket .SH SYNOPSIS diff --git a/man/man3/zmq_send.3 b/man/man3/zmq_send.3 index 0ebbd0c..4924ce0 100644 --- a/man/man3/zmq_send.3 +++ b/man/man3/zmq_send.3 @@ -1,4 +1,4 @@ -.TH zmq_send 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_send 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_send \- sends a message .SH SYNOPSIS diff --git a/man/man3/zmq_setsockopt.3 b/man/man3/zmq_setsockopt.3 index 36b7f08..ffbd345 100644 --- a/man/man3/zmq_setsockopt.3 +++ b/man/man3/zmq_setsockopt.3 @@ -1,4 +1,4 @@ -.TH zmq_setsockopt 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_setsockopt 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_setsockopt \- sets a specified option on a 0MQ socket .SH SYNOPSIS diff --git a/man/man3/zmq_socket.3 b/man/man3/zmq_socket.3 index de32d5f..9eb77c8 100644 --- a/man/man3/zmq_socket.3 +++ b/man/man3/zmq_socket.3 @@ -1,4 +1,4 @@ -.TH zmq_socket 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_socket 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_socket \- creates 0MQ socket .SH SYNOPSIS diff --git a/man/man3/zmq_strerror.3 b/man/man3/zmq_strerror.3 index 343c3ed..1ee2efe 100644 --- a/man/man3/zmq_strerror.3 +++ b/man/man3/zmq_strerror.3 @@ -1,4 +1,4 @@ -.TH zmq_strerror 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_strerror 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_strerror \- returns string describing the error number .SH SYNOPSIS diff --git a/man/man3/zmq_term.3 b/man/man3/zmq_term.3 index 8d822b6..92b4b37 100644 --- a/man/man3/zmq_term.3 +++ b/man/man3/zmq_term.3 @@ -1,4 +1,4 @@ -.TH zmq_term 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_term 3 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME zmq_init \- terminates 0MQ context .SH SYNOPSIS diff --git a/man/man7/zmq.7 b/man/man7/zmq.7 index 584c9ce..740726c 100644 --- a/man/man7/zmq.7 +++ b/man/man7/zmq.7 @@ -1,4 +1,4 @@ -.TH zmq 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME 0MQ \- a lightweight messaging kernel .SH SYNOPSIS diff --git a/man/man7/zmq_cl.7 b/man/man7/zmq_cl.7 index b9dd14f..c4f0162 100644 --- a/man/man7/zmq_cl.7 +++ b/man/man7/zmq_cl.7 @@ -1,4 +1,4 @@ -.TH zmq_cl 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_cl 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME Common Lisp API for 0MQ lightweight messaging kernel .SH SYNOPSIS diff --git a/man/man7/zmq_cpp.7 b/man/man7/zmq_cpp.7 index bcadab9..4df9157 100644 --- a/man/man7/zmq_cpp.7 +++ b/man/man7/zmq_cpp.7 @@ -1,4 +1,4 @@ -.TH zmq_cpp 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_cpp 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME C++ API for 0MQ lightweight messaging kernel .SH SYNOPSIS diff --git a/man/man7/zmq_inproc.7 b/man/man7/zmq_inproc.7 index 63779d9..7f43ca7 100644 --- a/man/man7/zmq_inproc.7 +++ b/man/man7/zmq_inproc.7 @@ -1,4 +1,4 @@ -.TH zmq_inproc 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_inproc 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME In-process (inter-thread) tranport for 0MQ .SH SYNOPSIS diff --git a/man/man7/zmq_pgm.7 b/man/man7/zmq_pgm.7 index 1b46a6b..57af65e 100644 --- a/man/man7/zmq_pgm.7 +++ b/man/man7/zmq_pgm.7 @@ -1,4 +1,4 @@ -.TH zmq_pgm 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_pgm 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME PGM-based tranport for 0MQ .SH SYNOPSIS diff --git a/man/man7/zmq_python.7 b/man/man7/zmq_python.7 index 14f3697..ee339f9 100644 --- a/man/man7/zmq_python.7 +++ b/man/man7/zmq_python.7 @@ -1,4 +1,4 @@ -.TH zmq_python 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_python 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME Python API for 0MQ lightweight messaging kernel .SH SYNOPSIS diff --git a/man/man7/zmq_ruby.7 b/man/man7/zmq_ruby.7 index 8c7bde3..e54a304 100644 --- a/man/man7/zmq_ruby.7 +++ b/man/man7/zmq_ruby.7 @@ -1,4 +1,4 @@ -.TH zmq_ruby 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_ruby 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME Ruby API for 0MQ lightweight messaging kernel .SH SYNOPSIS diff --git a/man/man7/zmq_tcp.7 b/man/man7/zmq_tcp.7 index 5bb867e..0b9a596 100644 --- a/man/man7/zmq_tcp.7 +++ b/man/man7/zmq_tcp.7 @@ -1,4 +1,4 @@ -.TH zmq_tcp 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_tcp 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME TCP-based tranport for 0MQ .SH SYNOPSIS diff --git a/man/man7/zmq_udp.7 b/man/man7/zmq_udp.7 index a6ce447..16cbf08 100644 --- a/man/man7/zmq_udp.7 +++ b/man/man7/zmq_udp.7 @@ -1,4 +1,4 @@ -.TH zmq_udp 7 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.TH zmq_udp 7 "" "(c)2007-2010 iMatix Corporation" "0MQ User Manuals" .SH NAME UDP-based tranport for 0MQ .SH SYNOPSIS |