From d759d4726ba8ac0fe8f8711a4015de717eb8a4a2 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 17 Mar 2018 17:28:52 -0700 Subject: fixes #294 rename nng_zerotier_xxx to nng_zt_xxx --- docs/man/nng_zt_register.3.adoc | 42 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/man/nng_zt_register.3.adoc (limited to 'docs/man/nng_zt_register.3.adoc') diff --git a/docs/man/nng_zt_register.3.adoc b/docs/man/nng_zt_register.3.adoc new file mode 100644 index 00000000..181429a6 --- /dev/null +++ b/docs/man/nng_zt_register.3.adoc @@ -0,0 +1,42 @@ += nng_zt_register(3) +// +// Copyright 2018 Staysail Systems, Inc. +// Copyright 2018 Capitar IT Group BV +// +// This document 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 + +nng_zt_register - register ZeroTier transport + +== SYNOPSIS + +[source,c] +---- +#include + +int nng_zt_register(void); +---- + +== DESCRIPTION + +The `nng_zt_register()` function registers the +((_zt_ transport))(((transport, _zt_))) for use. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_ENOTSUP`:: The transport is not supported. + +== SEE ALSO + +<>, +<> -- cgit v1.2.3-70-g09d2