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_sockaddr.adoc | 93 ----------------------------------------------
 1 file changed, 93 deletions(-)
 delete mode 100644 docs/man/nng_sockaddr.adoc

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

diff --git a/docs/man/nng_sockaddr.adoc b/docs/man/nng_sockaddr.adoc
deleted file mode 100644
index 396844e6..00000000
--- a/docs/man/nng_sockaddr.adoc
+++ /dev/null
@@ -1,93 +0,0 @@
-= nng_sockaddr(5)
-//
-// 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_sockaddr - socket address
-
-== SYNOPSIS
-
-[source, c]
------------
-#include <nng/nng.h>
-
-union nng_sockaddr {
-        uint16_t            s_family;
-        nng_sockaddr_ipc    s_ipc;
-        nng_sockaddr_inproc s_inproc;
-        nng_sockaddr_in     s_in;
-        nng_sockaddr_in6    s_in6;
-        nng_sockaddr_zt     s_zt;
-};
-typedef union nng_sockaddr nng_sockaddr;
-
-enum sockaddr_family {
-        NNG_AF_UNSPEC = 0,
-        NNG_AF_INPROC = 1,
-        NNG_AF_IPC    = 2,
-        NNG_AF_INET   = 3,
-        NNG_AF_INET6  = 4,
-        NNG_AF_ZT     = 5,        
-};
------------
-
-== DESCRIPTION
-
-An ((`nng_sockaddr`))(((socket, address))) is a structure used for
-representing the addresses used by underlying transports, such as TCP/IP
-addresses, IPC paths, and so forth.
-
-***
-The name `sockaddr` is based on it's similarity with POSIX `struct sockaddr`,
-but in the _nng_ library, these addreses are more closely affiliated with
-instances of <<nng_pipe#,`nng_pipe`>>
-than of <<nng_socket#,`nng_socket`>>.
-The naming confusion is unfortunate.
-***
-
-This structure is actually a union, with different members for different
-types of addreses.
-
-Every member structure has as its first element a `uint16_t` field
-containing the "`address family`"(((address family))).
-This overlaps the `s_family` member of the union, and indicates which
-specific member should be used.
-
-The values of `s_family` are as follows:
-
-`NNG_AF_UNSPEC`::
-    Invalid address, no other valid fields.
-`NNG_AF_INPROC`::
-    Address for intraprocess communication (<<nng_inproc#,nng_inproc(7)>>).
-    The `s_inproc` member is valid.
-`NNG_AF_IPC`::
-    Address for interprocess communication (<<nng_ipc#,nng_ipc(7)>>).
-    The `s_path` member is valid.
-`NNG_AF_INET`::
-    Address for TCP/IP (v4) communication.
-    The `s_in` member is valid.
-`NNG_AF_INET6`::
-    Address for TCP/IP (v6) communication.
-    The `s_in6` member is valid.
-`NNG_AF_ZT`::
-    Address for ZeroTier transport (<<nng_zerotier#,nng_zerotier(7)>>).
-    The `s_zt` member is valid.
-
-Please see the manual pages for each individual type for more information.
-
-== SEE ALSO
-[.text-left]
-<<nng_sockaddr_in#,nng_sockaddr_in(5)>>,
-<<nng_sockaddr_in6#,nng_sockaddr_in6(5)>>,
-<<nng_sockaddr_inproc#,nng_sockaddr_inproc(5)>>,
-<<nng_sockaddr_path#,nng_sockaddr_path(5)>>,
-<<nng_sockaddr_zt#,nng_sockaddr_zt(5)>>,
-<<nng#,nng(7)>>
-- 
cgit v1.2.3-70-g09d2

