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_zerotier.adoc | 57 ++++++++++++++++++-------------------------------- 1 file changed, 20 insertions(+), 37 deletions(-) (limited to 'docs/nng_zerotier.adoc') diff --git a/docs/nng_zerotier.adoc b/docs/nng_zerotier.adoc index 16bb647c..cc452931 100644 --- a/docs/nng_zerotier.adoc +++ b/docs/nng_zerotier.adoc @@ -1,23 +1,18 @@ -nng_zerotier(7) -=============== += nng_zerotier(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_zerotier - ZeroTier transport for nng -SYNOPSIS --------- +== SYNOPSIS [source,c] ---------- @@ -26,8 +21,7 @@ SYNOPSIS int nng_zt_register(void); ---------- -DESCRIPTION ------------ +== DESCRIPTION The _nng_zerotier_ transport provides communication support for _nng_ applications over a http://www.zerotier.com[ZeroTier] network, @@ -53,16 +47,14 @@ network. NOTE: This document assumes that the reader is familiar with ZeroTier concepts and administration. -Registration -~~~~~~~~~~~~ +=== Registration Depending upon how the library was built, it may be necessary to register the transport by calling `nng_zt_register`. This function returns zero on success, or an nng error value if the transport cannot be initialized for any reason. -URI Format -~~~~~~~~~~ +=== URI Format This transport uses URIs using the scheme `zt://`, followed by a node number (ten hexadecimal digits) followed by a `.` delimited, and then @@ -78,8 +70,7 @@ Listeners may use port 0 to indicate that a suitable port number be selected automatically. Applications using this must determine the selected port number using the `nng_listener_getopt` function. -Socket Address -~~~~~~~~~~~~~~ +=== Socket Address When using an `nng_sockaddr` structure, the actual structure is of type `struct nng_sockaddr_zt`. This type has the following definition: @@ -101,8 +92,7 @@ members are, unlike TCP socket address, in native byte order. Only the lower 24-bits of the `sa_port` may be used. Likewise only the lower 40-bits of the `sa_nodeid` may be used. -Node Presence -~~~~~~~~~~~~~ +=== Node Presence By default this transport creates an "ephemeral" node, and used the same ephemeral node for any additional endpoints created. As this node @@ -114,9 +104,7 @@ below. It is possible for a single application to join multiple networks using the same node, or using separate nodes. - -Transport Options -~~~~~~~~~~~~~~~~~ +=== Transport Options The following transport options are available: @@ -215,15 +203,10 @@ in this fashion. ID to "deorbit". If the node is not already orbiting the moon, then this has no effect. -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