aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_ctx_get.3.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-06-29 17:26:04 -0700
committerGarrett D'Amore <garrett@damore.org>2019-06-29 17:26:04 -0700
commit7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (patch)
tree7b78decbdc3bbdfac1b80d13a145aa640f2a7504 /docs/man/nng_ctx_get.3.adoc
parent3e8522a8c766deeb97158cdeb2cd35470063f35f (diff)
downloadnng-7b6e73f23104a50b898da1065cf9d3bf8b6a3bca.tar.gz
nng-7b6e73f23104a50b898da1065cf9d3bf8b6a3bca.tar.bz2
nng-7b6e73f23104a50b898da1065cf9d3bf8b6a3bca.zip
more .adoc markup fixes.
This is mostly mechanical-ish fixups to adjust markup style for cross references. A bit of care and feeding needed, so we haven't finished the list, but this gets a significant chunk of them.
Diffstat (limited to 'docs/man/nng_ctx_get.3.adoc')
-rw-r--r--docs/man/nng_ctx_get.3.adoc26
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/man/nng_ctx_get.3.adoc b/docs/man/nng_ctx_get.3.adoc
index e6e9cc1f..3ba3f072 100644
--- a/docs/man/nng_ctx_get.3.adoc
+++ b/docs/man/nng_ctx_get.3.adoc
@@ -39,9 +39,9 @@ int nng_ctx_get_uint64(nng_ctx ctx, const char *opt, uint64_t *u64p);
(((options, context)))
The `nng_ctx_get()` functions are used to retrieve option values for
-the <<nng_ctx.5#,context>> _ctx_.
+the xref:nng_ctx.5.adoc[context] _ctx_.
The actual options that may be retrieved in this way vary.
-A number of them are documented in <<nng_options.5#,nng_options(5)>>.
+A number of them are documented in xref:nng_options.5.adoc[nng_options(5)].
NOTE: Context options are protocol specific.
The details will be documented with the protocol.
@@ -83,7 +83,7 @@ This function is for options which take an integer (`int`).
The value will be stored at _ivalp_.
`nng_ctx_get_ms()`::
-This function is used to retrieve time <<nng_duration.5#,durations>>
+This function is used to retrieve time xref:nng_duration.5.adoc[durations]
(such as timeouts), stored in _durp_ as a number of milliseconds.
(The special value ((`NNG_DUR_INFINITE`)) means an infinite amount of time, and
the special value ((`NNG_DUR_DEFAULT`)) means a context-specific default.)
@@ -94,9 +94,9 @@ typically for buffer sizes, message maximum sizes, and similar options.
`nng_ctx_get_string()`::
This function is used to retrieve a string into _strp_.
-This string is created from the source using `<<nng_strdup.3#,nng_strdup()>>`
+This string is created from the source using xref:nng_strdup.3.adoc[`nng_strdup()`]
and consequently must be freed by the caller using
-`<<nng_strfree.3#,nng_strfree()>>` when it is no longer needed.
+xref:nng_strfree.3.adoc[`nng_strfree()`] when it is no longer needed.
`nng_ctx_get_uint64()`::
This function is used to retrieve a 64-bit unsigned value into the value
@@ -121,11 +121,11 @@ These functions return 0 on success, and non-zero otherwise.
== SEE ALSO
[.text-left]
-<<nng_ctx_set.3#,nng_ctx_set(3)>>,
-<<nng_strdup.3#,nng_strdup(3)>>,
-<<nng_strerror.3#,nng_strerror(3)>>,
-<<nng_strfree.3#,nng_strfree(3)>>,
-<<nng_duration.5#,nng_duration(5)>>,
-<<nng_ctx.5#,nng_ctx(5)>>,
-<<nng_options.5#,nng_options(5)>>,
-<<nng.7#,nng(7)>>
+xref:nng_ctx_set.3.adoc[nng_ctx_set(3)],
+xref:nng_strdup.3.adoc[nng_strdup(3)],
+xref:nng_strerror.3.adoc[nng_strerror(3)],
+xref:nng_strfree.3.adoc[nng_strfree(3)],
+xref:nng_duration.5.adoc[nng_duration(5)],
+xref:nng_ctx.5.adoc[nng_ctx(5)],
+xref:nng_options.5.adoc[nng_options(5)],
+xref:nng.7.adoc[nng(7)]