From 98f23e10cc1d65da6a7f6c7e4f5665d7afc27a86 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Thu, 15 Mar 2018 08:40:17 -0700
Subject: fixes #286 nng_pair0_open (and all others) need man page fixes #279
 consider restructuring man sections

This represents a rather significant rework, and major editing
effort, for the entire set of manual pages.

All of the pages now have a section number in their filename;
this assists in some other tooling, particularly ebook generation
as every link needs to be programmatically modified when combined
into an ebook.

Section 5 is introduced, and populated with pages for the main
types, and all options are now documented.

Numerous errors have been corrected, including rewriting certain
portions such as the header section of the surveyor protocol.

Much work has been done to facilitate index generation, although
certainly more work remains here.

Every internal link within these pages now resolves; there are no
more dead links.  (This is required to generate Kindle format books.)
---
 docs/man/nng_pub.7.adoc | 70 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 docs/man/nng_pub.7.adoc

(limited to 'docs/man/nng_pub.7.adoc')

diff --git a/docs/man/nng_pub.7.adoc b/docs/man/nng_pub.7.adoc
new file mode 100644
index 00000000..6f88115c
--- /dev/null
+++ b/docs/man/nng_pub.7.adoc
@@ -0,0 +1,70 @@
+= nng_pub(7)
+//
+// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2018 Capitar IT Group BV <info@capitar.com>
+//
+// This document is supplied under the terms of the MIT License, a
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt).  A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
+
+== NAME
+
+nng_pub - publisher protocol
+
+== SYNOPSIS
+
+[source,c]
+----
+#include <nng/protocol/pubsub0/pub.h>
+
+int nng_pub0_open(nng_socket *s);
+----
+
+== DESCRIPTION
+
+(((protocol, _pub_)))
+The ((_pub_ protocol)) is one half of a ((publisher))/subscriber pattern.
+In this pattern, a publisher sends data, which is broadcast to all
+subscribers.
+The subscribing applications only see the data to which
+they have subscribed.
+
+The _pub_ protocol is the publisher side, and the
+<<nng_sub.7#,_sub_>> protocol is the subscriber side.
+
+NOTE: In this implementation, the publisher delivers all messages to all
+subscribers.
+The subscribers maintain their own subscriptions, and filter them locally.
+Thus, this pattern should not be used in an attempt to reduce bandwidth
+consumption.
+
+The topics that subscribers subscribe to is just the first part of
+the message body.
+Applications should construct their messages accordingly.
+
+=== Socket Operations
+
+The <<nng_pub_open.3#,`nng_pub0_open()`>> call creates a publisher socket.
+This socket may be used to send messages, but is unable to receive them.
+Attempts to receive messages will result in `NNG_ENOTSUP`.
+
+=== Protocol Versions
+
+Only version 0 of this protocol is supported.
+(At the time of writing, no other versions of this protocol have been defined.)
+
+=== Protocol Options
+
+The _pub_ protocol has no protocol-specific options.
+
+=== Protocol Headers
+
+The _pub_ protocol has no protocol-specific headers.
+    
+== SEE ALSO
+
+<<nng_pub_open.3#,nng_pub_open(3)>>,
+<<nng_sub.7#,nng_sub(7)>>,
+<<nng.7#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

