diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/nng_stream.5.adoc | 6 | ||||
| -rw-r--r-- | docs/man/nng_stream_dialer_get.3str.adoc | 4 | ||||
| -rw-r--r-- | docs/man/nng_stream_dialer_set.3str.adoc | 4 | ||||
| -rw-r--r-- | docs/man/nng_stream_listener_set.3str.adoc | 4 | ||||
| -rw-r--r-- | docs/man/nng_stream_send.3str.adoc | 6 | ||||
| -rw-r--r-- | docs/man/nng_stream_set.3str.adoc | 4 | ||||
| -rw-r--r-- | docs/man/nng_tls_engine_description.3tls.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_tls_engine_fips_mode.3tls.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_tls_engine_name.3tls.adoc | 2 | ||||
| -rw-r--r-- | docs/man/nng_tls_options.5.adoc | 2 |
10 files changed, 18 insertions, 18 deletions
diff --git a/docs/man/nng_stream.5.adoc b/docs/man/nng_stream.5.adoc index 3e815da4..7d426a92 100644 --- a/docs/man/nng_stream.5.adoc +++ b/docs/man/nng_stream.5.adoc @@ -1,6 +1,6 @@ = nng_stream(5) // -// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2019 Devolutions <info@devolutions.net> // @@ -71,10 +71,10 @@ xref:libnng.3.adoc[libnng(3)], xref:nng_stream_close.3str.adoc[nng_stream_close(3str)], xref:nng_stream_dialer_dial.3str.adoc[nng_stream_dialer_dial(3str)], xref:nng_stream_free.3str.adoc[nng_stream_free(3str)], -xref:nng_stream_getopt.3str.adoc[nng_stream_getopt(3str)], +xref:nng_stream_get.3str.adoc[nng_stream_get(3str)], xref:nng_stream_listener_accept.3str.adoc[nng_stream_listener_accept(3str)], xref:nng_stream_recv.3str.adoc[nng_stream_recv(3str)], xref:nng_stream_send.3str.adoc[nng_stream_send(3str)], -xref:nng_stream_setopt.3str.adoc[nng_stream_setopt(3str)], +xref:nng_stream_set.3str.adoc[nng_stream_set(3str)], xref:nng_options.5.adoc[nng_options(5)], xref:nng.7.adoc[nng(7)], diff --git a/docs/man/nng_stream_dialer_get.3str.adoc b/docs/man/nng_stream_dialer_get.3str.adoc index b7043c74..c1e24b93 100644 --- a/docs/man/nng_stream_dialer_get.3str.adoc +++ b/docs/man/nng_stream_dialer_get.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_dialer_get(3str) // -// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2019 Devolutions <info@devolutions.net> // @@ -98,7 +98,7 @@ Note that this form is somewhat special in that the object is generally not copied, but instead the *pointer* to the object is copied. + NOTE: Care must be taken to ensure that the application respects any -considerations about the lifetime of the underyling object. +considerations about the lifetime of the underlying object. See the documentation for the option for more specific guidance. `nng_stream_dialer_get_size()`:: diff --git a/docs/man/nng_stream_dialer_set.3str.adoc b/docs/man/nng_stream_dialer_set.3str.adoc index 7afc83b5..bd4ac478 100644 --- a/docs/man/nng_stream_dialer_set.3str.adoc +++ b/docs/man/nng_stream_dialer_set.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_dialer_set(3str) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2019 Devolutions <info@devolutions.net> // @@ -80,7 +80,7 @@ The duration is an integer number of milliseconds. This function is used to pass a pointer to structured data. The data referenced by is generally managed by other functions. For example, TLS configuration objects created with -xref:nng_tls_config.3tls.adoc[`nng_tls_config_alloc()`] +xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`] can be passed this way. + NOTE: This form is somewhat special in that the object is generally diff --git a/docs/man/nng_stream_listener_set.3str.adoc b/docs/man/nng_stream_listener_set.3str.adoc index 386c6d87..ccabe5ca 100644 --- a/docs/man/nng_stream_listener_set.3str.adoc +++ b/docs/man/nng_stream_listener_set.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_listener_set(3str) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2019 Devolutions <info@devolutions.net> // @@ -80,7 +80,7 @@ The duration is an integer number of milliseconds. This function is used to pass a pointer to structured data. The data referenced by is generally managed by other functions. For example, TLS configuration objects created with -xref:nng_tls_config.3tls.adoc[`nng_tls_config_alloc()`] +xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`] can be passed this way. + NOTE: This form is somewhat special in that the object is generally diff --git a/docs/man/nng_stream_send.3str.adoc b/docs/man/nng_stream_send.3str.adoc index 2ae7355a..5a53e63c 100644 --- a/docs/man/nng_stream_send.3str.adoc +++ b/docs/man/nng_stream_send.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_send(3str) // -// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2019 Devolutions <info@devolutions.net> // @@ -69,6 +69,6 @@ xref:nng_aio_count.3.adoc[nng_aio_count(3)], xref:nng_aio_result.3.adoc[nng_aio_result(3)], xref:nng_aio_set_iov.3.adoc[nng_aio_set_iov(3)], xref:nng_strerror.3.adoc[nng_strerror(3)], -xref:nng_stream_close.3str.adoc#[nng_stream_close(3str)], -xref:nng_stream_recv.3str.adoc#[nng_stream_recv(3str)], +xref:nng_stream_close.3str.adoc[nng_stream_close(3str)], +xref:nng_stream_recv.3str.adoc[nng_stream_recv(3str)], xref:nng_stream.5.adoc[nng_stream(5)] diff --git a/docs/man/nng_stream_set.3str.adoc b/docs/man/nng_stream_set.3str.adoc index eb19c349..e4a82a1a 100644 --- a/docs/man/nng_stream_set.3str.adoc +++ b/docs/man/nng_stream_set.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_set(3str) // -// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> // Copyright 2018 Capitar IT Group BV <info@capitar.com> // Copyright 2019 Devolutions <info@devolutions.net> // @@ -80,7 +80,7 @@ The duration is an integer number of milliseconds. This function is used to pass a pointer to structured data. The data referenced by is generally managed by other functions. For example, TLS configuration objects created with -xref:nng_tls_config.3tls.adoc[`nng_tls_config_alloc()`] +xref:nng_tls_config_alloc.3tls.adoc[`nng_tls_config_alloc()`] can be passed this way. + NOTE: This form is somewhat special in that the object is generally diff --git a/docs/man/nng_tls_engine_description.3tls.adoc b/docs/man/nng_tls_engine_description.3tls.adoc index 2b742d94..afe4af24 100644 --- a/docs/man/nng_tls_engine_description.3tls.adoc +++ b/docs/man/nng_tls_engine_description.3tls.adoc @@ -24,7 +24,7 @@ const char *nng_tls_engine_description(void); == DESCRIPTION The `nng_tls_engine_description()` returns a short description for the current -xref:tls_engine.5.adoc[TLS engine]. +xref:nng_tls_engine.5.adoc[TLS engine]. If no engine is registered, then the empty string ("") is returned. This is principally useful for diagnostic purposes. diff --git a/docs/man/nng_tls_engine_fips_mode.3tls.adoc b/docs/man/nng_tls_engine_fips_mode.3tls.adoc index 68aaef2c..6a1afc3d 100644 --- a/docs/man/nng_tls_engine_fips_mode.3tls.adoc +++ b/docs/man/nng_tls_engine_fips_mode.3tls.adoc @@ -24,7 +24,7 @@ bool nng_tls_engine_fips_mode(void); == DESCRIPTION The `nng_tls_engine_fips_mode()` returns `true` if the -xref:tls_engine.5.adoc[TLS engine] is operating in FIPS 140-2 mode, +xref:nng_tls_engine.5.adoc[TLS engine] is operating in FIPS 140-2 mode, and `false` otherwise. TIP: FIPS 140-2 references a United States standard for the use diff --git a/docs/man/nng_tls_engine_name.3tls.adoc b/docs/man/nng_tls_engine_name.3tls.adoc index 6ba87ea9..73df06e6 100644 --- a/docs/man/nng_tls_engine_name.3tls.adoc +++ b/docs/man/nng_tls_engine_name.3tls.adoc @@ -24,7 +24,7 @@ const char *nng_tls_engine_name(void); == DESCRIPTION The `nng_tls_engine_name()` returns a short name for the current -xref:tls_engine.5.adoc[TLS engine]. +xref:nng_tls_engine.5.adoc[TLS engine]. If no engine is registered, then the special name "none" is returned. == RETURN VALUES diff --git a/docs/man/nng_tls_options.5.adoc b/docs/man/nng_tls_options.5.adoc index 9be88f97..52800290 100644 --- a/docs/man/nng_tls_options.5.adoc +++ b/docs/man/nng_tls_options.5.adoc @@ -85,7 +85,7 @@ indication, which is used as a hint by a multihosting server to choose the appropriate certificate to provide) and also is used to validate the name presented in the server's x509 certificate. -[[NNT_OPT_TLS_VERIFIED]]((`NNG_OPT_TLS_VERIFIED`)):: +[[NNG_OPT_TLS_VERIFIED]]((`NNG_OPT_TLS_VERIFIED`)):: (`bool`) This read-only option indicates whether the remote peer has been properly verified using TLS authentication. |
