diff options
author | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-11-22 10:25:53 +0100 |
---|---|---|
committer | Martin Sustrik <sustrik@fastmq.commkdir> | 2009-11-22 10:25:53 +0100 |
commit | ed5563f75285197aa0cdbe8a0dc6f80c5bb1f89c (patch) | |
tree | 3416a368cdf6755e2e512f9e38a65ccd18d76eae | |
parent | 55b64a02e7f3b1ce9e512240a9f9a337ead3b54c (diff) |
man pages (dummy) added for zmq_msg_* functions
-rw-r--r-- | man/Makefile.am | 5 | ||||
-rw-r--r-- | man/convert2pdf.sh | 16 | ||||
-rw-r--r-- | man/man3/zmq_msg_close.3 | 12 | ||||
-rw-r--r-- | man/man3/zmq_msg_copy.3 | 12 | ||||
-rw-r--r-- | man/man3/zmq_msg_data.3 | 12 | ||||
-rw-r--r-- | man/man3/zmq_msg_init.3 | 12 | ||||
-rw-r--r-- | man/man3/zmq_msg_init_data.3 | 15 | ||||
-rw-r--r-- | man/man3/zmq_msg_init_size.3 | 12 | ||||
-rw-r--r-- | man/man3/zmq_msg_move.3 | 12 | ||||
-rw-r--r-- | man/man3/zmq_msg_size.3 | 12 |
10 files changed, 119 insertions, 1 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index 84e0e47..9477351 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,7 +1,10 @@ dist_man_MANS = man1/zmq_forwarder.1 man3/zmq_init.3 man3/zmq_term.3 \ man3/zmq_socket.3 man3/zmq_close.3 man3/zmq_setsockopt.3 man3/zmq_bind.3 \ man3/zmq_connect.3 man3/zmq_send.3 man3/zmq_flush.3 man3/zmq_recv.3 \ - man3/zmq_poll.3 man7/zmq.7 + man3/zmq_poll.3 man3/zmq_msg_init.3 man3/zmq_msg_init_size.3 \ + man3/zmq_msg_data.3 man3/zmq_msg_close.3 man3/zmq_msg_move.3 \ + man3/zmq_msg_copy.3 man3/zmq_msg_data.3 man3/zmq_msg_size.3 \ + man7/zmq.7 distclean-local: -rm *.pdf diff --git a/man/convert2pdf.sh b/man/convert2pdf.sh index 6a7029f..f47854a 100644 --- a/man/convert2pdf.sh +++ b/man/convert2pdf.sh @@ -42,6 +42,22 @@ groff -man -Tps man3/zmq_recv.3 > man3/zmq_recv.3.ps ps2pdf man3/zmq_recv.3.ps zmq_recv.pdf groff -man -Tps man3/zmq_poll.3 > man3/zmq_poll.3.ps ps2pdf man3/zmq_poll.3.ps zmq_poll.pdf +groff -man -Tps man3/zmq_msg_init.3 > man3/zmq_msg_init.3.ps +ps2pdf man3/zmq_msg_init.3.ps zmq_msg_init.pdf +groff -man -Tps man3/zmq_msg_init_size.3 > man3/zmq_msg_init_size.3.ps +ps2pdf man3/zmq_msg_init_size.3.ps zmq_msg_init_size.pdf +groff -man -Tps man3/zmq_msg_init_data.3 > man3/zmq_msg_init_data.3.ps +ps2pdf man3/zmq_msg_init_data.3.ps zmq_msg_init_data.pdf +groff -man -Tps man3/zmq_msg_close.3 > man3/zmq_msg_close.3.ps +ps2pdf man3/zmq_msg_close.3.ps zmq_msg_close.pdf +groff -man -Tps man3/zmq_msg_move.3 > man3/zmq_msg_move.3.ps +ps2pdf man3/zmq_msg_move.3.ps zmq_msg_move.pdf +groff -man -Tps man3/zmq_msg_copy.3 > man3/zmq_msg_copy.3.ps +ps2pdf man3/zmq_msg_copy.3.ps zmq_msg_copy.pdf +groff -man -Tps man3/zmq_msg_data.3 > man3/zmq_msg_data.3.ps +ps2pdf man3/zmq_msg_data.3.ps zmq_msg_data.pdf +groff -man -Tps man3/zmq_msg_size.3 > man3/zmq_msg_size.3.ps +ps2pdf man3/zmq_msg_size.3.ps zmq_msg_size.pdf groff -man -Tps man7/zmq.7 > man7/zmq.7.ps ps2pdf man7/zmq.7.ps zmq.pdf diff --git a/man/man3/zmq_msg_close.3 b/man/man3/zmq_msg_close.3 new file mode 100644 index 0000000..ee9d009 --- /dev/null +++ b/man/man3/zmq_msg_close.3 @@ -0,0 +1,12 @@ +.TH zmq_msg_close 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.SH NAME +zmq_msg_close \- destroys 0MQ message +.SH SYNOPSIS +.B int zmq_msg_close (zmq_msg_t *msg); +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH EXAMPLE +.SH SEE ALSO +.SH AUTHOR +Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_copy.3 b/man/man3/zmq_msg_copy.3 new file mode 100644 index 0000000..239203b --- /dev/null +++ b/man/man3/zmq_msg_copy.3 @@ -0,0 +1,12 @@ +.TH zmq_msg_copy 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.SH NAME +zmq_msg_copy \- copies content of a message to another message +.SH SYNOPSIS +.B int zmq_msg_copy (zmq_msg_t *dest, zmq_msg_t *src); +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH EXAMPLE +.SH SEE ALSO +.SH AUTHOR +Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_data.3 b/man/man3/zmq_msg_data.3 new file mode 100644 index 0000000..647e9e9 --- /dev/null +++ b/man/man3/zmq_msg_data.3 @@ -0,0 +1,12 @@ +.TH zmq_msg_data 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.SH NAME +zmq_msg_data \- retrieves pointer to the message content +.SH SYNOPSIS +.B void *zmq_msg_data (zmq_msg_t *msg); +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH EXAMPLE +.SH SEE ALSO +.SH AUTHOR +Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_init.3 b/man/man3/zmq_msg_init.3 new file mode 100644 index 0000000..8b18207 --- /dev/null +++ b/man/man3/zmq_msg_init.3 @@ -0,0 +1,12 @@ +.TH zmq_msg_init 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.SH NAME +zmq_msg_init \- initialises empty 0MQ message +.SH SYNOPSIS +.B int zmq_msg_init (zmq_msg_t *msg); +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH EXAMPLE +.SH SEE ALSO +.SH AUTHOR +Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_init_data.3 b/man/man3/zmq_msg_init_data.3 new file mode 100644 index 0000000..d00ed9c --- /dev/null +++ b/man/man3/zmq_msg_init_data.3 @@ -0,0 +1,15 @@ +.TH zmq_msg_init_data 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.SH NAME +zmq_msg_init \- initialises 0MQ message from the given data +.SH SYNOPSIS +.nf +.B typedef void (zmq_free_fn) (void *data); +.B int zmq_msg_init_data (zmq_msg_t *msg, void *data, size_t size, zmq_free_fn *ffn); +.fi +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH EXAMPLE +.SH SEE ALSO +.SH AUTHOR +Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_init_size.3 b/man/man3/zmq_msg_init_size.3 new file mode 100644 index 0000000..b1baa75 --- /dev/null +++ b/man/man3/zmq_msg_init_size.3 @@ -0,0 +1,12 @@ +.TH zmq_msg_init_size 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.SH NAME +zmq_msg_init \- initialises 0MQ message of a specified size +.SH SYNOPSIS +.B int zmq_msg_init_size (zmq_msg_t *msg, size_t size); +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH EXAMPLE +.SH SEE ALSO +.SH AUTHOR +Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_move.3 b/man/man3/zmq_msg_move.3 new file mode 100644 index 0000000..0daf2f7 --- /dev/null +++ b/man/man3/zmq_msg_move.3 @@ -0,0 +1,12 @@ +.TH zmq_msg_move 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.SH NAME +zmq_msg_move \- moves content of a message to another message +.SH SYNOPSIS +.B int zmq_msg_move (zmq_msg_t *dest, zmq_msg_t *src); +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH EXAMPLE +.SH SEE ALSO +.SH AUTHOR +Martin Sustrik <sustrik at 250bpm dot com> diff --git a/man/man3/zmq_msg_size.3 b/man/man3/zmq_msg_size.3 new file mode 100644 index 0000000..d8bbc53 --- /dev/null +++ b/man/man3/zmq_msg_size.3 @@ -0,0 +1,12 @@ +.TH zmq_msg_size 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals" +.SH NAME +zmq_msg_size \- retrieves size of the message content +.SH SYNOPSIS +.B size_t zmq_msg_size (zmq_msg_t *msg); +.SH DESCRIPTION +.SH RETURN VALUE +.SH ERRORS +.SH EXAMPLE +.SH SEE ALSO +.SH AUTHOR +Martin Sustrik <sustrik at 250bpm dot com> |