aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nng_tcp.5.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-07-06 13:33:55 -0700
committerGarrett D'Amore <garrett@damore.org>2019-07-06 13:33:55 -0700
commitdcb962389c5f71bc25cdb84f3363eed95bad9bdd (patch)
tree2a94b72596df4ff76081eb74632af0ce273517b1 /docs/man/nng_tcp.5.adoc
parent7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (diff)
downloadnng-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_tcp.5.adoc')
-rw-r--r--docs/man/nng_tcp.5.adoc54
1 files changed, 27 insertions, 27 deletions
diff --git a/docs/man/nng_tcp.5.adoc b/docs/man/nng_tcp.5.adoc
index 12cb8399..6f424239 100644
--- a/docs/man/nng_tcp.5.adoc
+++ b/docs/man/nng_tcp.5.adoc
@@ -31,54 +31,54 @@ TCP stream objects can be used to send or receive data.
NOTE: The `nng_tcp` object is used for raw TCP connections, and
should not be confused with a pipe object created using the
-<<nng_tcp.7#,nng_tcp(7)>> transport.
+xref:nng_tcp.7.adoc[nng_tcp(7)] transport.
TIP: Most NNG applications should not use this, but instead use the
-<<nng_tcp.7#,nng_tcp(7)>> transport instead.
+xref:nng_tcp.7.adoc[nng_tcp(7)] transport instead.
These objects are created either establishing an outgoing connection
-with <<nng_tcp_dialer_dial.3tcp#,`nng_tcp_dialer_dial()`>> or by
+with xref:nng_tcp_dialer_dial.3tcp.adoc[`nng_tcp_dialer_dial()`] or by
accepting in incoming connection with
-<<nng_tcp_listener_accept.3tcp#,`nng_tcp_listener_accept()`>>.
+xref:nng_tcp_listener_accept.3tcp.adoc[`nng_tcp_listener_accept()`].
TCP connections are byte streams, and are "`reliable`" in that data
will not be delivered out of order, or with portions missing.
-Data can be sent using <<nng_tcp_send.3tcp#,`nng_tcp_send()`>> or
-received with <<nng_tcp_recv.3tcp#,`nng_tcp_recv()`>>.
+Data can be sent using xref:nng_tcp_send.3tcp.adoc[`nng_tcp_send()`] or
+received with xref:nng_tcp_recv.3tcp.adoc[`nng_tcp_recv()`].
When the connection is no longer needed, it should be freed with
-<<nng_tcp_free.3tcp#,`nng_tcp_free()`>>.
+xref:nng_tcp_free.3tcp.adoc[`nng_tcp_free()`].
TIP: It is possible to close the connection, without freeing it, by
-using <<nng_tcp_close.3tcp#,`nng_tcp_close()`>>.
+using xref:nng_tcp_close.3tcp.adoc[`nng_tcp_close()`].
=== Options
The following options are applicable to TCP connections, and may be
-accessed using the <<nng_tcp_getopt.3tcp#,`nng_tcp_getopt()`>> and
-<<nng_tcp_setopt.3tcp#,`nng_tcp_setopt()`>> functions.
+accessed using the xref:nng_tcp_getopt.3tcp.adoc[`nng_tcp_getopt()`] and
+xref:nng_tcp_setopt.3tcp.adoc[`nng_tcp_setopt()`] functions.
-* <<nng_options.5#NNG_OPT_LOCADDR,`NNG_OPT_LOCADDR`>>
-* <<nng_options.5#NNG_OPT_REMADDR,`NNG_OPT_REMADDR`>>
-* <<nng_tcp_options.5#NNG_OPT_TCP_NO_DELAY,`NNG_OPT_TCP_NODELAY`>>
-* <<nng_tcp_options.5#NNG_OPT_TCP_KEEPALIVE,`NNG_OPT_TCP_KEEPALIVE`>>
-* <<nng_tcp_options.5#NNG_OPT_TCP_BOUND_PORT,`NNG_OPT_TCP_BOUND_PORT`>>
+* xref:nng_options.5.adoc#NNG_OPT_LOCADDR[`NNG_OPT_LOCADDR`]
+* xref:nng_options.5.adoc#NNG_OPT_REMADDR[`NNG_OPT_REMADDR`]
+* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_NO_DELAY[`NNG_OPT_TCP_NODELAY`]
+* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_KEEPALIVE[`NNG_OPT_TCP_KEEPALIVE`]
+* xref:nng_tcp_options.5.adoc#NNG_OPT_TCP_BOUND_PORT[`NNG_OPT_TCP_BOUND_PORT`]
Other platform specific options may be available as well.
== SEE ALSO
[.text-left]
-<<libnng.3#,libnng(3)>>,
-<<nng_tcp_close.3tcp#,nng_tcp_close(3tcp)>>,
-<<nng_tcp_dialer_dial.3tcp#,nng_tcp_dialer_dial(3tcp)>>,
-<<nng_tcp_free.3tcp#,nng_tcp_free(3tcp)>>,
-<<nng_tcp_getopt.3tcp#,nng_tcp_getopt(3tcp)>>,
-<<nng_tcp_listener_accept.3tcp#,nng_tcp_listener_accept(3tcp)>>,
-<<nng_tcp_recv.3tcp#,nng_tcp_recv(3tcp)>>,
-<<nng_tcp_send.3tcp#,nng_tcp_send(3tcp)>>,
-<<nng_tcp_setopt.3tcp#,nng_tcp_setopt(3tcp)>>,
-<<nng_options.5#,nng_options(5)>>,
-<<nng_tcp_options.5#,nng_tcp_options(5)>>,
-<<nng.7#,nng(7)>>
+xref:libnng.3.adoc[libnng(3)],
+xref:nng_tcp_close.3tcp.adoc[nng_tcp_close(3tcp)],
+xref:nng_tcp_dialer_dial.3tcp.adoc[nng_tcp_dialer_dial(3tcp)],
+xref:nng_tcp_free.3tcp.adoc[nng_tcp_free(3tcp)],
+xref:nng_tcp_getopt.3tcp.adoc[nng_tcp_getopt(3tcp)],
+xref:nng_tcp_listener_accept.3tcp.adoc[nng_tcp_listener_accept(3tcp)],
+xref:nng_tcp_recv.3tcp.adoc[nng_tcp_recv(3tcp)],
+xref:nng_tcp_send.3tcp.adoc[nng_tcp_send(3tcp)],
+xref:nng_tcp_setopt.3tcp.adoc[nng_tcp_setopt(3tcp)],
+xref:nng_options.5.adoc[nng_options(5)],
+xref:nng_tcp_options.5.adoc[nng_tcp_options(5)],
+xref:nng.7.adoc[nng(7)]