diff options
| author | Garrett D'Amore <garrett@damore.org> | 2020-06-18 19:19:06 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2020-06-18 19:19:06 -0700 |
| commit | dbc61a5038cacc516a49d00a59a669e2617cff51 (patch) | |
| tree | 2b63b03499af29eff7b9c76e352366223ddee1ce /docs/man/nng_zerotier.7.adoc | |
| parent | 2236819226e579058d9f9fd67f3d684630a40634 (diff) | |
| download | nng-dbc61a5038cacc516a49d00a59a669e2617cff51.tar.gz nng-dbc61a5038cacc516a49d00a59a669e2617cff51.tar.bz2 nng-dbc61a5038cacc516a49d00a59a669e2617cff51.zip | |
Language cleanups in the documentation.
Mostly this is removal of the smart quotes, which were
over-used, and misused, and could have been mistaken to
be pejorative. A few other minor nits were fixed while here.
Diffstat (limited to 'docs/man/nng_zerotier.7.adoc')
| -rw-r--r-- | docs/man/nng_zerotier.7.adoc | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/docs/man/nng_zerotier.7.adoc b/docs/man/nng_zerotier.7.adoc index 31988079..3ec5d9e1 100644 --- a/docs/man/nng_zerotier.7.adoc +++ b/docs/man/nng_zerotier.7.adoc @@ -1,6 +1,6 @@ = nng_zerotier(7) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 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 @@ -138,7 +138,7 @@ The network is most likely not available. The following transport options are available: ((`NNG_OPT_ZT_HOME`)):: - (string) This option represents the "`home directory`", where the transport + (string) This option represents the home directory, where the transport can store (and reuse) persistent state, such as key materials, node identity, and federation membership. This option must be set before the ZeroTier transport is first used. @@ -189,12 +189,12 @@ in this fashion. ((`NNG_OPT_ZT_PING_TIME`)):: (xref:nng_duration.5.adoc[`nng_duration`]) If no traffic has been received from the ZeroTier peer after this - period of time, then a "`ping`" message is sent to check if the peer + period of time, then a ping message is sent to check if the peer is still alive. [[NNG_OPT_ZT_PING_TRIES]] ((`NNG_OPT_ZT_PING_TRIES`)):: - (`int`) If this number of consecutive "`ping`" requests are sent to the + (`int`) If this number of consecutive ping requests are sent to the peer with no response (and no other intervening traffic), then the peer is assumed to be dead and the connection is closed. @@ -209,15 +209,14 @@ in this fashion. [[NNG_OPT_ZT_ORBIT]] ((`NNG_OPT_ZT_ORBIT`))(((orbit, ZeroTier)))(((federation,ZeroTier))):: (`uint64_t[2]`) Write-only array of two `uint64_t` values, - indicating the ID of a ZeroTier "`moon`", and the node ID of the root server + indicating the ID of a ZeroTier <em>moon</em>, and the node ID of the root server for that moon. (The ID may be zero if the moon ID is the same as its root server ID, which is conventional.) [[NNG_OPT_ZT_DEORBIT]] ((`NNG_OPT_ZT_DEORBIT`)):: - (`uint64_t`) Write-only option indicating the moon - ID to "`deorbit`". If the node is not already orbiting the moon, then - this has no effect. + (`uint64_t`) Write-only option indicating the moon ID to deorbit. + If the node is not already orbiting the moon, then this has no effect. == SEE ALSO |