summaryrefslogtreecommitdiff
path: root/docs/nng_tls_config_alloc.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nng_tls_config_alloc.adoc')
-rw-r--r--docs/nng_tls_config_alloc.adoc49
1 files changed, 16 insertions, 33 deletions
diff --git a/docs/nng_tls_config_alloc.adoc b/docs/nng_tls_config_alloc.adoc
index a5823e65..98884f70 100644
--- a/docs/nng_tls_config_alloc.adoc
+++ b/docs/nng_tls_config_alloc.adoc
@@ -1,24 +1,19 @@
-nng_tls_config_alloc(3)
-=======================
+= nng_tls_config_alloc(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
:manvolnum: 3
-:icons: font
-:source-highlighter: pygments
-:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \
- Copyright 2018 Capitar IT Group BV <info@capitar.com> \
- 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_tls_config_alloc - allocate TLS configuration object
-SYNOPSIS
---------
+== SYNOPSIS
[source, c]
-----------
@@ -32,8 +27,7 @@ typedef enum nng_tls_mode {
int nng_tls_config_alloc(nni_tls_config **cfgp, nng_tls_mode mode);
-----------
-DESCRIPTION
------------
+== DESCRIPTION
The `nng_tls_config_alloc()` function creates a newly initialized
https://tools.ietf.org/html/rfc5246[Transport Layer Security])
@@ -56,21 +50,16 @@ is first used with a service. After this points, attempts to apply
further changes to the configuration will result in `NNG_EBUSY`.
-RETURN VALUES
--------------
+== RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
-
-ERRORS
-------
+== ERRORS
`NNG_ENOMEM`:: Insufficient memory is available to allocate the object.
`NNG_EINVAL`:: An invalid 'mode' was specified.
-
-SEE ALSO
---------
+== SEE ALSO
<<nng_strerror#,nng_strerror(3)>>,
<<nng_tls_config_auth_mode#,nng_tls_config_auth_mode(3)>>,
@@ -80,12 +69,6 @@ SEE ALSO
<<nng_tls_config_server_name#,nng_tls_config_server_name(3)>>,
<<nng#,nng(7)>>
+== COPYRIGHT
-COPYRIGHT
----------
-
-Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] +
-Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]
-
-This document is supplied under the terms of the
-https://opensource.org/licenses/MIT[MIT License].
+{copyright}