From f93dfcfaebad0a995e18298f0588a5cbfc0c1d8f Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 10 Mar 2018 23:10:18 -0800 Subject: man page updates for tip --- man/tip/nng_tcp.html | 8 ++--- man/tip/nng_tls.html | 8 ++--- man/tip/nng_ws.html | 8 ++--- man/tip/nng_zerotier.html | 78 +++++++++++++++++++++++++++-------------------- man/tip/nngcat.html | 12 ++++---- 5 files changed, 63 insertions(+), 51 deletions(-) (limited to 'man') diff --git a/man/tip/nng_tcp.html b/man/tip/nng_tcp.html index b44311fe..4127e7aa 100644 --- a/man/tip/nng_tcp.html +++ b/man/tip/nng_tcp.html @@ -625,16 +625,16 @@ These are struct types with the following definitions:

typedef struct { // ... (2) - uint16_t sa_family; // must be NNG_AF_INET - uint16_t sa_port; // TCP port number + uint16_t sa_family; // must be NNG_AF_INET + uint16_t sa_port; // TCP port number uint32_t sa_addr; // ... } nng_sockaddr_in; typedef struct { // ... (2) - uint16_t sa_family; // must be NNG_AF_INET6 - uint16_t sa_port; // TCP port number + uint16_t sa_family; // must be NNG_AF_INET6 + uint16_t sa_port; // TCP port number uint8_t sa_addr[16]; // ... } nng_sockaddr_in6; diff --git a/man/tip/nng_tls.html b/man/tip/nng_tls.html index 94bc3f92..daa0c3b7 100644 --- a/man/tip/nng_tls.html +++ b/man/tip/nng_tls.html @@ -688,16 +688,16 @@ These are struct types with the following definitions:

typedef struct { // ... (2) - uint16_t sa_family; // must be NNG_AF_INET - uint16_t sa_port; // TCP port number + uint16_t sa_family; // must be NNG_AF_INET + uint16_t sa_port; // TCP port number uint32_t sa_addr; // ... } nng_sockaddr_in; typedef struct { // ... (2) - uint16_t sa_family; // must be NNG_AF_INET6 - uint16_t sa_port; // TCP port number + uint16_t sa_family; // must be NNG_AF_INET6 + uint16_t sa_port; // TCP port number uint8_t sa_addr[16]; // ... } nng_sockaddr_in6; diff --git a/man/tip/nng_ws.html b/man/tip/nng_ws.html index 46695cfc..f35fe386 100644 --- a/man/tip/nng_ws.html +++ b/man/tip/nng_ws.html @@ -644,16 +644,16 @@ These are struct types with the following definitions:

typedef struct { // ... (2) - uint16_t sa_family; // must be NNG_AF_INET - uint16_t sa_port; // TCP port number + uint16_t sa_family; // must be NNG_AF_INET + uint16_t sa_port; // TCP port number uint32_t sa_addr; // ... } nng_sockaddr_in; typedef struct { // ... (2) - uint16_t sa_family; // must be NNG_AF_INET6 - uint16_t sa_port; // TCP port number + uint16_t sa_family; // must be NNG_AF_INET6 + uint16_t sa_port; // TCP port number uint8_t sa_addr[16]; // ... } nng_sockaddr_in6; diff --git a/man/tip/nng_zerotier.html b/man/tip/nng_zerotier.html index d5eeb948..07b215e3 100644 --- a/man/tip/nng_zerotier.html +++ b/man/tip/nng_zerotier.html @@ -514,6 +514,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • URI Format
  • Socket Address
  • Node Presence
    • +
  • Network Status
  • Transport Options
    • @@ -698,6 +699,49 @@ using the same node, or using separate nodes.

    +

    Network Status

    +
    +

    A ZeroTier node can be in one of the following states, which +can be obtained with the NNG_OPT_ZT_NETWORK_STATUS option:

    +
    +
    +
    +
    NNG_ZT_STATUS_UP
    +
    +

    The ZeroTier network is up. This is the only state where it is +possible to communicate with peers, and the only state where +the network name (NNG_OPT_ZT_NETWORK_NAME) is available.

    +
    +
    NNG_ZT_STATUS_CONFIG
    +
    +

    The ZeroTier node is still configuring, network services are not available.

    +
    +
    NNG_ZT_STATUS_DENIED
    +
    +

    The node does not have permission to join the ZeroTier network.

    +
    +
    NNG_ZT_STATUS_NOTFOUND
    +
    +

    The ZeroTier network is not found.

    +
    +
    NNG_ZT_STATUS_ERROR
    +
    +

    Some other ZeroTier error has occurred; the network is not available.

    +
    +
    NNG_ZT_STATUS_OBSOLETE
    +
    +

    The node is running obsolete software; the network is not available.

    +
    +
    NNG_ZT_STATUS_UNKNOWN
    +
    +

    The network is in an unknown state. This should not happen, as it +indicates that the ZeroTier software is reporting an unexpected status. +The network is most likely not available.

    +
    +
    +
    +
    +

    Transport Options

    The following transport options are available:

    @@ -743,39 +787,7 @@ provides a uint64_t in native byte order representing the ZeroTier
    NNG_OPT_ZT_NETWORK_STATUS

    This is a read-only integer, representing the ZeroTier network status. -Valid values for this are:

    - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

    nng_zt_network_status_configuring

    The ZeroTier node is still configuring, network services are not available.

    nng_zt_network_status_ok

    The ZeroTier network is up.

    nng_zt_network_status_denied

    The node does not have permission to join the ZeroTier network.

    nng_zt_network_status_notfound

    The ZeroTier network is not found.

    nng_zt_network_status_error

    Some other ZeroTier error has occurred; the network is not available.

    nng_zt_network_status_obsolete

    The node is running obsolete software; the network is not available.

    +See Network Status for an explanation of this option.

    NNG_OPT_ZT_NETWORK_NAME
    diff --git a/man/tip/nngcat.html b/man/tip/nngcat.html index 08bf4442..bdaaa33e 100644 --- a/man/tip/nngcat.html +++ b/man/tip/nngcat.html @@ -511,9 +511,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • DESCRIPTION
  • OPTIONS
    • -

    Generic

    +

    Generic Options

    -h, --help
    @@ -633,7 +633,7 @@ not specified at all, then a default subscription to everything is assumed.

    -

    Protocol Selection

    +

    Protocol Selection Options

    @@ -721,7 +721,7 @@ version 0 peers, and can send a reply to them.

    -

    Peer Selection

    +

    Peer Selection Options

    -- cgit v1.2.3-70-g09d2