diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-01 17:11:32 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-01 19:18:37 -0700 |
| commit | 3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch) | |
| tree | d670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_ws.7.adoc | |
| parent | 1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff) | |
| download | nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.gz nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.bz2 nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.zip | |
Markup fixes, ensuring links are colored properly.
It turns out that when creating cross references, we need to
make any text styling (generally literal characters) outside of
the link, to avoid having the styling override the link color.
(We prefer to have links colored for ease of use.)
While here a few other markup, and actual content, errors were fixed.
Diffstat (limited to 'docs/man/nng_ws.7.adoc')
| -rw-r--r-- | docs/man/nng_ws.7.adoc | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/man/nng_ws.7.adoc b/docs/man/nng_ws.7.adoc index d3b68b99..bc0d9d51 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 @@ -82,10 +82,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 @@ -143,7 +143,7 @@ TIP: Use this option when advanced TLS configuration is required. (string) This is a write-only option used to load certificates associated associated private key from a file. -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`)):: @@ -153,7 +153,7 @@ associated private key from a file. The private key used must be unencrypted. (Use the `NNG_OPT_TLS_CONFIG` option to access the underlying TLS configuration if more advanced configuration is needed.) -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`)):: @@ -162,7 +162,7 @@ information. used. It can take an integer with value `NNG_TLS_AUTH_MODE_NONE`, `NNG_TLS_AUTH_MODE_REQUIRED`, or `NNG_TLS_AUTH_MODE_OPTIONAL`. -See <<nng_tls_config_auth_mode.3tls#,`nng_tls_config_auth_mode()`>> for more +See `<<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode()>>` for more details. `NNG_OPT_TLS_VERIFIED`:: |