From 87795b46f2bc732bd11067805709161bdc00d6b6 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 25 Feb 2018 17:56:55 -0800 Subject: More man page reorganization. Man pages need special handling, and we can have other kinds of documentation like initial starting guides, etc., which would have different processing applied. So lets move them off into their own directory. --- docs/man/nng_tls_config_server_name.adoc | 49 ++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/man/nng_tls_config_server_name.adoc (limited to 'docs/man/nng_tls_config_server_name.adoc') diff --git a/docs/man/nng_tls_config_server_name.adoc b/docs/man/nng_tls_config_server_name.adoc new file mode 100644 index 00000000..d533a809 --- /dev/null +++ b/docs/man/nng_tls_config_server_name.adoc @@ -0,0 +1,49 @@ += nng_tls_config_server_name(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_tls_config_server_name - configure remote server name + +== SYNOPSIS + +[source, c] +----------- +#include + +int nng_tls_config_server_name(nni_tls_config *cfg, const char *name); +----------- + +== DESCRIPTION + +The `nng_tls_config_server_name()` function configures the remote server name +to be used by a client when connection to a server. The supplied _name_ +is used when comparing the identity in the server's certificate. Furthermore, +when Server Name Indication (SNI) is used, the _name_ may be sent to the server +as a hint to tell it which of several possible certificates should be used. + +TIP: This function is only useful in configuring client behavior. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. + +== SEE ALSO + +<>, +<>, +<>, +<> -- cgit v1.2.3-70-g09d2