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_compat.3compat.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_compat.3compat.adoc')
| -rw-r--r-- | docs/man/nng_compat.3compat.adoc | 102 |
1 files changed, 51 insertions, 51 deletions
diff --git a/docs/man/nng_compat.3compat.adoc b/docs/man/nng_compat.3compat.adoc index 0276663c..c70e1752 100644 --- a/docs/man/nng_compat.3compat.adoc +++ b/docs/man/nng_compat.3compat.adoc @@ -35,24 +35,24 @@ nng_compat - compatibility with nanomsg 1.0 == DESCRIPTION (((compatibility layer))) -The <<nng.7#,_nng_>> library provides source-level compatibility for +The xref:nng.7.adoc[_nng_] library provides source-level compatibility for most _nanomsg_ 1.0 applications. IMPORTANT: This is intended to facilitate converting ((legacy applications)) to use the _nng_ library. -New applications should use the newer <<nng.7#,_nng_>> API instead. +New applications should use the newer xref:nng.7.adoc[_nng_] API instead. Applications making use of this must take care -to link with <<libnng.3#,_libnng_>> instead of _libnn_. +to link with xref:libnng.3.adoc[_libnng_] instead of _libnn_. TIP: While not recommended for long term use, the value returned by -<<nng_socket_id.3#,nng_socket_id()>> can be used with these functions -just like a value returned by <<nn_socket.3compat#,nn_socket()>>. +xref:nng_socket_id.3.adoc[`nng_socket_id()`] can be used with these functions +just like a value returned by xref:nn_socket.3compat.adoc[`nn_socket()`]. This can be way to facilitate incremental transition to the new API. NOTE: Some capabilities, protocols, and transports, will not be accessible using this API, as the compatible API has no provision for expression -of certain concepts introduced in the newer <<nng.7#,_nng_>> API. +of certain concepts introduced in the newer xref:nng.7.adoc[_nng_] API. NOTE: While reasonable efforts have been made to provide for compatibility, some things may behave differently, and some less common parts of the @@ -99,53 +99,53 @@ The following functions are provided: // this and use tables there -- it looks ugly otherwise. ifndef::backend-pdf[] [horizontal] -`<<nn_socket.3compat#,nn_socket()>>`:: create socket -`<<nn_getsockopt.3compat#,nn_getsockopt()>>`:: get socket option -`<<nn_setsockopt.3compat#,nn_setsockopt()>>`:: set socket option -`<<nn_bind.3compat#,nn_bind()>>`:: accept connections from remote peers -`<<nn_connect.3compat#,nn_connect()>>`:: connect to remote peer -`<<nn_send.3compat#,nn_send()>>`:: send data -`<<nn_recv.3compat#,nn_recv()>>`:: receive data -`<<nn_shutdown.3compat#,nn_shutdown()>>`:: shut down endpoint -`<<nn_close.3compat#,nn_close()>>`:: close socket -`<<nn_poll.3compat#,nn_poll()>>`:: poll sockets -`<<nn_device.3compat#,nn_device()>>`:: create forwarding device -`<<nn_recvmsg.3compat#,nn_recvmsg()>>`:: receive message -`<<nn_sendmsg.3compat#,nn_sendmsg()>>`:: send message -`<<nn_cmsg.3compat#,nn_cmsg()>>`:: message control data -`<<nn_get_statistic.3compat#,nn_get_statistic()>>`:: get statistic (stub) -`<<nn_allocmsg.3compat#,nn_allocmsg()>>`:: allocate message -`<<nn_reallocmsg.3compat#,nn_reallocmsg()>>`:: reallocate message -`<<nn_freemsg.3compat#,nn_freemsg()>>`:: free message -`<<nn_errno.3compat#,nn_errno()>>`:: return most recent error -`<<nn_strerror.3compat#,nn_strerror()>>`:: return message for error -`<<nn_term.3compat#,nn_term()>>`:: terminate library +xref:nn_socket.3compat.adoc[`nn_socket()`]:: create socket +xref:nn_getsockopt.3compat.adoc[`nn_getsockopt()`]:: get socket option +xref:nn_setsockopt.3compat.adoc[`nn_setsockopt()`]:: set socket option +xref:nn_bind.3compat.adoc[`nn_bind()`]:: accept connections from remote peers +xref:nn_connect.3compat.adoc[`nn_connect()`]:: connect to remote peer +xref:nn_send.3compat.adoc[`nn_send()`]:: send data +xref:nn_recv.3compat.adoc[`nn_recv()`]:: receive data +xref:nn_shutdown.3compat.adoc[`nn_shutdown()`]:: shut down endpoint +xref:nn_close.3compat.adoc[`nn_close()`]:: close socket +xref:nn_poll.3compat.adoc[`nn_poll()`]:: poll sockets +xref:nn_device.3compat.adoc[`nn_device()`]:: create forwarding device +xref:nn_recvmsg.3compat.adoc[`nn_recvmsg()`]:: receive message +xref:nn_sendmsg.3compat.adoc[`nn_sendmsg()`]:: send message +xref:nn_cmsg.3compat.adoc[`nn_cmsg()`]:: message control data +xref:nn_get_statistic.3compat.adoc[`nn_get_statistic()`]:: get statistic (stub) +xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`]:: allocate message +xref:nn_reallocmsg.3compat.adoc[`nn_reallocmsg()`]:: reallocate message +xref:nn_freemsg.3compat.adoc[`nn_freemsg()`]:: free message +xref:nn_errno.3compat.adoc[`nn_errno()`]:: return most recent error +xref:nn_strerror.3compat.adoc[`nn_strerror()`]:: return message for error +xref:nn_term.3compat.adoc[`nn_term()`]:: terminate library endif::[] ifdef::backend-pdf[] // Add links for the following as they are written. [.hdlist,width=90%, grid=rows,cols="1,2", align="center"] |=== -|`<<nn_socket.3compat#,nn_socket()>>`|create socket -|`<<nn_getsockopt.3compat#,nn_getsockopt()>>`|get socket option -|`<<nn_setsockopt.3compat#,nn_setsockopt()>>`|set socket option -|`<<nn_bind.3compat#,nn_bind()>>`|accept connections from remote peers -|`<<nn_connect.3compat#,nn_connect()>>`|connect to remote peer -|`<<nn_send.3compat#,nn_send()>>`|send data -|`<<nn_recv.3compat#,nn_recv()>>`|receive data -|`<<nn_shutdown.3compat#,nn_shutdown()>>`|shut down endpoint -|`<<nn_close.3compat#,nn_close()>>`|close socket -|`<<nn_poll.3compat#,nn_poll()>>`|poll sockets -|`<<nn_device.3compat#,nn_device()>>`|create forwarding device -|`<<nn_recvmsg.3compat#,nn_recvmsg()>>`|receive message -|`<<nn_sendmsg.3compat#,nn_sendmsg()>>`|send message -|`<<nn_cmsg.3compat#,nn_cmsg()>>`|message control data -|`<<nn_get_statistic.3compat#,nn_get_statistic()>>`|get statistic (stub) -|`<<nn_allocmsg.3compat#,nn_allocmsg()>>`|allocate message -|`<<nn_reallocmsg.3compat#,nn_reallocmsg()>>`|reallocate message -|`<<nn_freemsg.3compat#,nn_freemsg()>>`|free message -|`<<nn_errno.3compat#,nn_errno()>>`|return most recent error -|`<<nn_strerror.3compat#,nn_strerror()>>`|return message for error -|`<<nn_term.3compat#,nn_term()>>`|terminate library +|xref:nn_socket.3compat.adoc[`nn_socket()`]|create socket +|xref:nn_getsockopt.3compat.adoc[`nn_getsockopt()`]|get socket option +|xref:nn_setsockopt.3compat.adoc[`nn_setsockopt()`]|set socket option +|xref:nn_bind.3compat.adoc[`nn_bind()`]|accept connections from remote peers +|xref:nn_connect.3compat.adoc[`nn_connect()`]|connect to remote peer +|xref:nn_send.3compat.adoc[`nn_send()`]|send data +|xref:nn_recv.3compat.adoc[`nn_recv()`]|receive data +|xref:nn_shutdown.3compat.adoc[`nn_shutdown()`]|shut down endpoint +|xref:nn_close.3compat.adoc[`nn_close()`]|close socket +|xref:nn_poll.3compat.adoc[`nn_poll()`]|poll sockets +|xref:nn_device.3compat.adoc[`nn_device()`]|create forwarding device +|xref:nn_recvmsg.3compat.adoc[`nn_recvmsg()`]|receive message +|xref:nn_sendmsg.3compat.adoc[`nn_sendmsg()`]|send message +|xref:nn_cmsg.3compat.adoc[`nn_cmsg()`]|message control data +|xref:nn_get_statistic.3compat.adoc[`nn_get_statistic()`]|get statistic (stub) +|xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`]|allocate message +|xref:nn_reallocmsg.3compat.adoc[`nn_reallocmsg()`]|reallocate message +|xref:nn_freemsg.3compat.adoc[`nn_freemsg()`]|free message +|xref:nn_errno.3compat.adoc[`nn_errno()`]|return most recent error +|xref:nn_strerror.3compat.adoc[`nn_strerror()`]|return message for error +|xref:nn_term.3compat.adoc[`nn_term()`]|terminate library |=== endif::[] @@ -167,7 +167,7 @@ The following caveats apply when using the legacy API with _nng_. the underlying capability is present in _nng_. * Access to statistics using this legacy API - (`<<nn_get_statistic.3compat#,nn_get_statistic()>>`) is unsupported. + (xref:nn_get_statistic.3compat.adoc[`nn_get_statistic()`]) is unsupported. * Some transports can support longer URLs than legacy _libnanomsg_ can. It is a good idea to use short pathnames in URLs if interoperability @@ -210,5 +210,5 @@ The following caveats apply when using the legacy API with _nng_. == SEE ALSO [.text-left] -<<libnng.3#,libnng(3)>>, -<<nng.7#,nng(7)>> +xref:libnng.3.adoc[libnng(3)], +xref:nng.7.adoc[nng(7)] |
