aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_ipc.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-02-02 15:43:43 -0800
committerGarrett D'Amore <garrett@damore.org>2018-02-02 17:02:40 -0800
commitc2deb4a479be750b054372e83154f4b3b051c95a (patch)
treea6909733d8d56fcfa192b16c0c05b07e15e1ad7f /docs/nng_ipc.adoc
parent4f1029f8f4c582d1f04632b0c50f4c374284fa16 (diff)
downloadnng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.gz
nng-c2deb4a479be750b054372e83154f4b3b051c95a.tar.bz2
nng-c2deb4a479be750b054372e83154f4b3b051c95a.zip
Update markup with simpler copyright and new-style asciidoctor.
Diffstat (limited to 'docs/nng_ipc.adoc')
-rw-r--r--docs/nng_ipc.adoc53
1 files changed, 19 insertions, 34 deletions
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 <garrett@damore.org> \
- Copyright 2018 Capitar IT Group BV <info@capitar.com> \
- 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
---------
-<<nng#,nng(7)>>
+== SEE ALSO
-COPYRIGHT
----------
+<<nng#,nng(7)>>
-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}