diff options
| author | Garrett D'Amore <garrett@damore.org> | 2019-07-06 13:33:55 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2019-07-06 13:33:55 -0700 |
| commit | dcb962389c5f71bc25cdb84f3363eed95bad9bdd (patch) | |
| tree | 2a94b72596df4ff76081eb74632af0ce273517b1 /docs/man/nng_socket_get.3.adoc | |
| parent | 7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (diff) | |
| download | nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.tar.gz nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.tar.bz2 nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.zip | |
fixes #861 Man pages need to use .adoc suffix
Diffstat (limited to 'docs/man/nng_socket_get.3.adoc')
| -rw-r--r-- | docs/man/nng_socket_get.3.adoc | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/man/nng_socket_get.3.adoc b/docs/man/nng_socket_get.3.adoc index d077207d..6c2ec87e 100644 --- a/docs/man/nng_socket_get.3.adoc +++ b/docs/man/nng_socket_get.3.adoc @@ -43,9 +43,9 @@ int nng_socket_get_addr(nng_socket s, const char *opt, nng_sockaddr *addrp); (((options, socket))) The `nng_socket_get()` functions are used to retrieve option values for -the <<nng_socket.5#,socket>> _s_. +the xref:nng_socket.5.adoc[socket] _s_. 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)]. Additionally transport-specific options and protocol-specific options are documented with the transports and protocols themselves. @@ -87,7 +87,7 @@ This function is for options which take an integer (`int`). The value will be stored at _ivalp_. `nng_socket_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.) @@ -104,9 +104,9 @@ typically for buffer sizes, message maximum sizes, and similar options. `nng_socket_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_socket_get_uint64()`:: This function is used to retrieve a 64-bit unsigned value into the value @@ -131,14 +131,14 @@ These functions return 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<<nng_dialer_get.3#,nng_dialer_get(3)>>, -<<nng_listener_get.3#,nng_listener_get(3)>>, -<<nng_pipe_get.3#,nng_pipe_get(3)>>, -<<nng_socket_set.3#,nng_socket_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_options.5#,nng_options(5)>>, -<<nng_socket.5#,nng_socket(5)>>, -<<nng.7#,nng(7)>> +xref:nng_dialer_get.3.adoc[nng_dialer_get(3)], +xref:nng_listener_get.3.adoc[nng_listener_get(3)], +xref:nng_pipe_get.3.adoc[nng_pipe_get(3)], +xref:nng_socket_set.3.adoc[nng_socket_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_options.5.adoc[nng_options(5)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] |
