diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-29 17:03:51 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-29 18:14:55 -0700 |
| commit | 0ddaee41ec753805fa12eeabd679870802528dac (patch) | |
| tree | 3418859f4f22e9857b5ae979b3bc4eb53fd70035 /docs/man/nng_tls_config_auth_mode.3tls.adoc | |
| parent | 33dc5d611f578ace9833a80dc006a34b09da18af (diff) | |
| download | nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.gz nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.bz2 nng-0ddaee41ec753805fa12eeabd679870802528dac.zip | |
fixes #495 SEE ALSO should use [align=left]
fixes #494 ERRORS section should use [horizontal]
These changes address some basic formatting consistency things,
and ultimately (when combined with other tooling changes that are
not part of this repo) lead to vastly improved layout in the
printed documentation.
While here we removed trailing whitespace, and did certain other
minor markup tweaks.
Diffstat (limited to 'docs/man/nng_tls_config_auth_mode.3tls.adoc')
| -rw-r--r-- | docs/man/nng_tls_config_auth_mode.3tls.adoc | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/man/nng_tls_config_auth_mode.3tls.adoc b/docs/man/nng_tls_config_auth_mode.3tls.adoc index 4a790130..edd4235b 100644 --- a/docs/man/nng_tls_config_auth_mode.3tls.adoc +++ b/docs/man/nng_tls_config_auth_mode.3tls.adoc @@ -16,7 +16,7 @@ nng_tls_config_auth_mode - configure authentication mode == SYNOPSIS [source, c] ------------ +---- #include <nng/nng.h> #include <nng/supplemental/tls/tls.h> @@ -27,7 +27,7 @@ typedef enum nng_tls_auth_mode { } nng_tls_auth_mode; int nng_tls_config_auth_mode(nni_tls_config *cfg, nng_tls_auth_mode mode); ------------ +---- == DESCRIPTION @@ -48,7 +48,7 @@ then the sesssion is allowed to proceed without authentication. ((`NNG_TLS_AUTH_MODE_REQUIRED`)):: A check is made to ensure that the peer has presented a valid certificate -used for the session. +used for the session. If the peer's certificate is invalid or missing, then the session is refused. This is the default for clients. @@ -58,6 +58,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS +[horizontal] `NNG_ENOMEM`:: Insufficient memory is available. `NNG_EINVAL`:: An invalid _mode_ was specified. `NNG_EBUSY`:: The configuration _cfg_ is already in use, and cannot be modified. @@ -65,6 +66,7 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO +[.text-left] <<nng_strerror.3#,nng_strerror(3)>>, <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, <<nng_tls_config_ca_chain.3tls#,nng_tls_config_ca_chain(3tls)>>, |