From 55b64a02e7f3b1ce9e512240a9f9a337ead3b54c Mon Sep 17 00:00:00 2001
From: Martin Sustrik <sustrik@fastmq.commkdir>
Date: Sun, 22 Nov 2009 08:47:06 +0100
Subject: man pages - initial (dummy) version

---
 man/man3/zmq_bind.3       | 12 ++++++++++++
 man/man3/zmq_close.3      | 12 ++++++++++++
 man/man3/zmq_connect.3    | 12 ++++++++++++
 man/man3/zmq_flush.3      | 12 ++++++++++++
 man/man3/zmq_init.3       | 12 ++++++++++++
 man/man3/zmq_poll.3       | 12 ++++++++++++
 man/man3/zmq_recv.3       | 12 ++++++++++++
 man/man3/zmq_send.3       | 12 ++++++++++++
 man/man3/zmq_setsockopt.3 | 12 ++++++++++++
 man/man3/zmq_socket.3     | 12 ++++++++++++
 man/man3/zmq_term.3       | 12 ++++++++++++
 11 files changed, 132 insertions(+)
 create mode 100644 man/man3/zmq_bind.3
 create mode 100644 man/man3/zmq_close.3
 create mode 100644 man/man3/zmq_connect.3
 create mode 100644 man/man3/zmq_flush.3
 create mode 100644 man/man3/zmq_init.3
 create mode 100644 man/man3/zmq_poll.3
 create mode 100644 man/man3/zmq_recv.3
 create mode 100644 man/man3/zmq_send.3
 create mode 100644 man/man3/zmq_setsockopt.3
 create mode 100644 man/man3/zmq_socket.3
 create mode 100644 man/man3/zmq_term.3

(limited to 'man/man3')

diff --git a/man/man3/zmq_bind.3 b/man/man3/zmq_bind.3
new file mode 100644
index 0000000..70f1df7
--- /dev/null
+++ b/man/man3/zmq_bind.3
@@ -0,0 +1,12 @@
+.TH zmq_bind 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_bind \- binds the socket to the specified address
+.SH SYNOPSIS
+.B int zmq_bind (void *s, const char *addr);
+.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_close.3 b/man/man3/zmq_close.3
new file mode 100644
index 0000000..c04f97a
--- /dev/null
+++ b/man/man3/zmq_close.3
@@ -0,0 +1,12 @@
+.TH zmq_close 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_close \- destroys 0MQ socket
+.SH SYNOPSIS
+.B int zmq_close (void *s);
+.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_connect.3 b/man/man3/zmq_connect.3
new file mode 100644
index 0000000..c68101c
--- /dev/null
+++ b/man/man3/zmq_connect.3
@@ -0,0 +1,12 @@
+.TH zmq_connect 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_connect \- connects the socket to the specified address
+.SH SYNOPSIS
+.B int zmq_connect (void *s, const char *addr);
+.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_flush.3 b/man/man3/zmq_flush.3
new file mode 100644
index 0000000..f84c561
--- /dev/null
+++ b/man/man3/zmq_flush.3
@@ -0,0 +1,12 @@
+.TH zmq_flush 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_flush \- flushes pre-sent messages to the socket
+.SH SYNOPSIS
+.B int zmq_flush (void *s);
+.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_init.3 b/man/man3/zmq_init.3
new file mode 100644
index 0000000..04f04ef
--- /dev/null
+++ b/man/man3/zmq_init.3
@@ -0,0 +1,12 @@
+.TH zmq_init 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_init \- initialises 0MQ context
+.SH SYNOPSIS
+.B void *zmq_init (int app_threads, int io_threads, int flags);
+.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_poll.3 b/man/man3/zmq_poll.3
new file mode 100644
index 0000000..d821e9f
--- /dev/null
+++ b/man/man3/zmq_poll.3
@@ -0,0 +1,12 @@
+.TH zmq_poll 3 "" "(c)2007-2009 FastMQ Inc." "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);
+.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_recv.3 b/man/man3/zmq_recv.3
new file mode 100644
index 0000000..8308f79
--- /dev/null
+++ b/man/man3/zmq_recv.3
@@ -0,0 +1,12 @@
+.TH zmq_recv 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_recv \- retrieves a message from the socket
+.SH SYNOPSIS
+.B int zmq_recv (void *s, zmq_msg_t *msg, int flags);
+.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_send.3 b/man/man3/zmq_send.3
new file mode 100644
index 0000000..ff6e429
--- /dev/null
+++ b/man/man3/zmq_send.3
@@ -0,0 +1,12 @@
+.TH zmq_send 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_send \- sends a message
+.SH SYNOPSIS
+.B int zmq_send (void *s, zmq_msg_t *msg, int flags);
+.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_setsockopt.3 b/man/man3/zmq_setsockopt.3
new file mode 100644
index 0000000..da528cf
--- /dev/null
+++ b/man/man3/zmq_setsockopt.3
@@ -0,0 +1,12 @@
+.TH zmq_setsockopt 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_setsockopt \- sets a specified option on a 0MQ socket
+.SH SYNOPSIS
+.B int zmq_setsockopt (void *s, int option, const void *optval, size_t optvallen); 
+.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_socket.3 b/man/man3/zmq_socket.3
new file mode 100644
index 0000000..f404b6b
--- /dev/null
+++ b/man/man3/zmq_socket.3
@@ -0,0 +1,12 @@
+.TH zmq_socket 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_socket \- creates 0MQ socket
+.SH SYNOPSIS
+.B void *zmq_socket (void *context, int type);
+.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_term.3 b/man/man3/zmq_term.3
new file mode 100644
index 0000000..afd3273
--- /dev/null
+++ b/man/man3/zmq_term.3
@@ -0,0 +1,12 @@
+.TH zmq_term 3 "" "(c)2007-2009 FastMQ Inc." "0MQ User Manuals"
+.SH NAME
+zmq_init \- terminates 0MQ context
+.SH SYNOPSIS
+.B int zmq_term (void *context);
+.SH DESCRIPTION
+.SH RETURN VALUE
+.SH ERRORS
+.SH EXAMPLE
+.SH SEE ALSO
+.SH AUTHOR
+Martin Sustrik <sustrik at 250bpm dot com>
-- 
cgit v1.2.3