From c2deb4a479be750b054372e83154f4b3b051c95a Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Fri, 2 Feb 2018 15:43:43 -0800 Subject: Update markup with simpler copyright and new-style asciidoctor. --- docs/nng_ipc.adoc | 53 +++++++++++++++++++---------------------------------- 1 file changed, 19 insertions(+), 34 deletions(-) (limited to 'docs/nng_ipc.adoc') diff --git a/docs/nng_ipc.adoc b/docs/nng_ipc.adoc index c1fcd5c4..7fa376f4 100644 --- a/docs/nng_ipc.adoc +++ b/docs/nng_ipc.adoc @@ -1,23 +1,18 @@ -nng_ipc(7) -========== += nng_ipc(7) :doctype: manpage :manmanual: nng :mansource: nng -:icons: font -:source-highlighter: pygments -:copyright: Copyright 2018 Garrett D'Amore \ - Copyright 2018 Capitar IT Group BV \ - This software 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 ----- +:copyright: Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] + \ + Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] + \ + {blank} + \ + This document is supplied under the terms of the \ + https://opensource.org/licenses/MIT[MIT License]. + +== NAME + nng_ipc - IPC transport for nng -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_ipc_register(void); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_ipc_ transport provides communication support between _nng_ sockets within different processes on the same host. For POSIX @@ -37,14 +31,12 @@ have different implementation strategies. // We need to insert a reference to the nanomsg RFC. -Registration -~~~~~~~~~~~~ +=== Registration The _ipc_ transport is generally built-in to the _nng_ core, so no extra steps to use it should be necessary. -URI Format -~~~~~~~~~~ +=== URI Format This transport uses URIs using the scheme `ipc://`, followed by a an absolute path name in the file system where the socket or named pipe @@ -54,8 +46,7 @@ TIP: On Windows, all names are prefixed by `\.\pipe\` and do not occupy the normal file system. On POSIX platforms, the path is taken literally, and is relative to the root directory. -Socket Address -~~~~~~~~~~~~~~ +=== Socket Address When using an `nng_sockaddr` structure, the actual structure is of type `nng_sockaddr_ipc`. This is a `struct` type with the following definition: @@ -81,21 +72,15 @@ The `sa_family` member will have the value `NNG_AF_IPC`. The `sa_path` member is an ASCIIZ string, and may contain any legal path name (platform-dependent), terminated by a `NUL` byte. -Transport Options -~~~~~~~~~~~~~~~~~ +=== Transport Options The _ipc_ transport has no special options.footnote:[Options for security attributes and credentials are planned.] -SEE ALSO --------- -<> +== SEE ALSO -COPYRIGHT ---------- +<> -Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] + -Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV] +== COPYRIGHT -This document is supplied under the terms of the -https://opensource.org/licenses/MIT[MIT License]. +{copyright} -- cgit v1.2.3-70-g09d2