diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-06-29 17:26:04 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-06-29 17:26:04 -0700 |
| commit | 7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (patch) | |
| tree | 7b78decbdc3bbdfac1b80d13a145aa640f2a7504 /docs/man/nng_dialer_getopt.3.adoc | |
| parent | 3e8522a8c766deeb97158cdeb2cd35470063f35f (diff) | |
| download | nng-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_dialer_getopt.3.adoc')
| -rw-r--r-- | docs/man/nng_dialer_getopt.3.adoc | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/man/nng_dialer_getopt.3.adoc b/docs/man/nng_dialer_getopt.3.adoc index ea7529dc..4f8b3a3e 100644 --- a/docs/man/nng_dialer_getopt.3.adoc +++ b/docs/man/nng_dialer_getopt.3.adoc @@ -45,9 +45,9 @@ NOTE: These functions are deprecated. Please see xref:nng_dialer_get.3.adoc[nng (((options, dialer))) The `nng_dialer_getopt()` functions are used to retrieve option values for -the <<nng_dialer.5#,dialer>> _d_. +the xref:nng_dialer.5.adoc[dialer] _d_. The actual options that may be retrieved in this way -vary, and many are documented in <<nng_options.5#,nng_options(5)>>. +vary, and many are documented in xref:nng_options.5.adoc[nng_options(5)]. Additionally some transport-specific options and protocol-specific options are documented with the transports and protocols themselves. @@ -89,7 +89,7 @@ This function is for options which take an integer (`int`). The value will be stored at _ivalp_. `nng_dialer_getopt_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.) @@ -105,14 +105,14 @@ This function is used to retrieve a size into the pointer _zp_, typically for buffer sizes, message maximum sizes, and similar options. `nng_dialer_getopt_sockaddr()`:: -This function is used to retrieve an `<<nng_sockaddr.5#,nng_sockaddr>>` +This function is used to retrieve an xref:nng_sockaddr.5.adoc[`nng_sockaddr`] into the value referenced by _sap_. `nng_dialer_getopt_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_dialer_getopt_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -137,13 +137,13 @@ These functions returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dialer_create.3#,nng_dialer_create(3)>> -<<nng_dialer_setopt.3#,nng_dialer_setopt(3)>> -<<nng_strdup.3#,nng_strdup(3)>>, -<<nng_strerror.3#,nng_strerror(3)>>, -<<nng_strfree.3#,nng_strfree(3)>>, -<<nng_dialer.5#,nng_dialer(5)>>, -<<nng_duration.5#,nng_duration(5)>>, -<<nng_options.5#,nng_options(5)>>, -<<nng_sockaddr.5#,nng_sockaddr(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer_create.3.adoc[nng_dialer_create(3)] +xref:nng_dialer_setopt.3.adoc[nng_dialer_setopt(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_dialer.5.adoc[nng_dialer(5)], +xref:nng_duration.5.adoc[nng_duration(5)], +xref:nng_options.5.adoc[nng_options(5)], +xref:nng_sockaddr.5.adoc[nng_sockaddr(5)], +xref:nng.7.adoc[nng(7)] |
