aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_ws.7.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-01-07 23:14:51 -0800
committerGarrett D'Amore <garrett@damore.org>2019-01-14 20:25:40 -0800
commitd0a26bbd1caf3de2132855d7936fed8ac1f1488c (patch)
tree5133c92dbb88df393df670555613d2f4e1a9018a /docs/man/nng_ws.7.adoc
parent099d89877aca6a7236254e39d9c9f5c46083cee7 (diff)
downloadnng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.tar.gz
nng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.tar.bz2
nng-d0a26bbd1caf3de2132855d7936fed8ac1f1488c.zip
fixes #858 Document the TLS public API
This also includes a number of the documentation improvements. The options document has been broken up into separate pages for each of the transport specific options. We have made various other minor improvements, fixes to markup, and cross-references.
Diffstat (limited to 'docs/man/nng_ws.7.adoc')
-rw-r--r--docs/man/nng_ws.7.adoc18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc
index d5c7d40a..1895eaf1 100644
--- a/docs/man/nng_ws.7.adoc
+++ b/docs/man/nng_ws.7.adoc
@@ -37,11 +37,11 @@ http://nanomsg.org/rfcs/sp-websocket-v1.html[WebSocket Mapping for Scalability P
=== Registration
Depending upon how the library was built, it may be necessary to
-register the transport by calling `<<nng_ws_register.3#,nng_ws_register()>>`.
+register the transport by calling <<nng_ws_register.3#,`nng_ws_register()`>>.
If ((TLS)) support is enabled in the library, secure WebSockets (over TLS v1.2)
can be used as well, but the secure transport may have to be registered using
-the `<<nng_wss_register.3#,nng_wss_register()>>` function.
+the <<nng_wss_register.3#,`nng_wss_register()`>> function.
=== URI Format
@@ -77,10 +77,10 @@ permitted, with IPv4 addresses mapped to IPv6 addresses.)
=== Socket Address
-When using an `<<nng_sockaddr.5#,nng_sockaddr>>` structure,
+When using an <<nng_sockaddr.5#,`nng_sockaddr`>> structure,
the actual structure is either of type
-`<<nng_sockaddr_in.5#,nng_sockaddr_in>>` (for IPv4) or
-`<<nng_sockaddr_in6.5#,nng_sockaddr_in6>>` (for IPv6).
+<<nng_sockaddr_in.5#,`nng_sockaddr_in`>> (for IPv4) or
+<<nng_sockaddr_in6.5#,`nng_sockaddr_in6`>> (for IPv6).
=== Server Instances
@@ -133,7 +133,7 @@ configuration object for `wss://` endpoints.
A hold is placed on the underlying
configuration object before returning it.
The caller should release the object with
-`<<nng_tls_config_free.3tls#,nng_tls_config_free()>>` when it no
+<<nng_tls_config_free.3tls#,`nng_tls_config_free()`>> when it no
longer needs the TLS configuration.
TIP: Use this option when advanced TLS configuration is required.
@@ -141,19 +141,19 @@ TIP: Use this option when advanced TLS configuration is required.
((`NNG_OPT_TLS_CA_FILE`))::
(string) Write-only option naming a file containing certificates to
use for peer validation.
-See `<<nng_tls_config_ca_file.3tls#,nng_tls_config_ca_file()>>` for more
+See <<nng_tls_config_ca_file.3tls#,`nng_tls_config_ca_file()`>> for more
information.
((`NNG_OPT_TLS_CERT_KEY_FILE`))::
(string) Write-only option naming a file containing the local certificate and
associated private key.
The private key used must be unencrypted.
-See `<<nng_tls_config_own_cert.3tls#,nng_tls_config_own_cert()>>` for more
+See <<nng_tls_config_own_cert.3tls#,`nng_tls_config_own_cert()`>> for more
information.
((`NNG_OPT_TLS_AUTH_MODE`))::
(`int`) Write-only option used to configure the authentication mode used.
-See `<<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode()>>` for
+See <<nng_tls_config_auth_mode.3tls#,`nng_tls_config_auth_mode()`>> for
more details.
`NNG_OPT_TLS_VERIFIED`::