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_inproc.adoc | 84 ------------------------------------------------
 1 file changed, 84 deletions(-)
 delete mode 100644 docs/man/nng_inproc.adoc

(limited to 'docs/man/nng_inproc.adoc')

diff --git a/docs/man/nng_inproc.adoc b/docs/man/nng_inproc.adoc
deleted file mode 100644
index 5123c3a3..00000000
--- a/docs/man/nng_inproc.adoc
+++ /dev/null
@@ -1,84 +0,0 @@
-= nng_inproc(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_inproc - intra-process transport for nng
-
-== SYNOPSIS
-
-[source,c]
-----------
-#include <nng/transport/inproc/inproc.h>
-
-int nng_inproc_register(void);
-----------
-
-== DESCRIPTION
-
-The _nng_inproc_ transport provides communication support between
-_nng_ sockets within the same process. This may be used as an alternative
-to slower transports when data must be moved within the same process.
-
-This transport tries hard to avoid copying data, and thus is very
-light-weight.
-
-=== Registration
-
-The _inproc_ transport is generally built-in to the _nng_ core, so
-no extra steps to use it should be necessary.
-
-=== URI Format
-
-This transport uses URIs using the scheme `inproc://`, followed by
-an arbitrary string of text, terminated by a `NUL` byte.
-
-Multiple URIs can be used within the
-same application, and they will not interfere with one another.
-
-Two applications may also use the same URI without interfering with each
-other, and they will be unable to communicate with each other using
-that URI.
-
-=== Socket Address
-
-When using an `nng_sockaddr` structure, the actual structure is of type
-`struct nng_sockaddr_inproc`.
-This type has the following definition:
-
-[source,c]
---------
-#define NNG_AF_INPROC 1 <1>
-#define NNG_MAXADDRLEN 128
-
-typedef nng_sockaddr_inproc {
-    // <2>
-    uint16_t sa_family;                  // must be NNG_AF_INPROC
-    char     sa_name[NNG_MAXADDRLEN];    // arbitrary "name"
-    //
-} nng_sockaddr_inproc;
---------
-<1> The values of these macros may change, so applications
-should avoid depending upon their values and instead use them symbolically.
-<2> Other members may be present, but only those listed here
-are suitable for application use.
-
-The `sa_family` member will have the value `NNG_AF_INPROC`.
-The `sa_path` member is an ASCIIZ string, and may contain any characters,
-terminated by a `NUL` byte.
-
-=== Transport Options
-
-The _inproc_ transport has no special options.
-    
-== SEE ALSO
-
-<<nng#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

