aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_tls.7.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-05-01 17:11:32 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-01 19:18:37 -0700
commit3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch)
treed670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_tls.7.adoc
parent1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff)
downloadnng-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_tls.7.adoc')
-rw-r--r--docs/man/nng_tls.7.adoc14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/man/nng_tls.7.adoc b/docs/man/nng_tls.7.adoc
index c783f739..249159b7 100644
--- a/docs/man/nng_tls.7.adoc
+++ b/docs/man/nng_tls.7.adoc
@@ -38,7 +38,7 @@ http://nanomsg.org/rfcs/sp-tls-v1.html[TLS Mapping for Scalability Protocols].
Depending upon how the library was built, it may be necessary to
register the transport by calling
-<<nng_tls_register.3#,`nng_tls_register()`>>.
+`<<nng_tls_register.3#,nng_tls_register()>>`.
=== Availability
@@ -100,10 +100,10 @@ The entire URI must be less than `NNG_MAXADDRLEN` bytes long.
=== 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).
=== Transport Options
@@ -138,7 +138,7 @@ TIP: Use this option when advanced TLS configuration is required.
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`))::
@@ -147,7 +147,7 @@ This is a write-only option used to load the local certificate and
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`))::
@@ -155,7 +155,7 @@ information.
This is a write-only option used to configure the authentication mode
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
+See `<<nng_tls_config_auth_mode.3tls#,nng_tls_config_auth_mode()>>` for
more details.
((`NNG_OPT_TLS_VERIFIED`))::