From 7af3747a3579eea07080df2693d89e2061520392 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 24 May 2020 22:38:13 -0700 Subject: Clean up section descriptions --- docs/man/man3compat.desc | 6 +++--- docs/man/man3http.desc | 4 +++- docs/man/man3tls.desc | 6 +++--- docs/man/man7.desc | 4 ++-- 4 files changed, 11 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/man/man3compat.desc b/docs/man/man3compat.desc index a35173c0..2b0b4b3f 100644 --- a/docs/man/man3compat.desc +++ b/docs/man/man3compat.desc @@ -6,8 +6,8 @@ from use in new applications. TIP: While this is discouraged for long term use, as a transition aid applications may use the value returned by the -<> in these functions just like a -socket descriptor (as if the socket were opened -via <>). +xref:nng_socket_id.3.adoc[`nng_socket_id()`] in these functions just like a +socket descriptor (as if the socket were opened via +xref:nn_socket.3compat.adoc[`nn_socket()`]). This sort of API intermixing should only be used during transition from the legacy API to the new API. diff --git a/docs/man/man3http.desc b/docs/man/man3http.desc index 97323e40..b6659eb8 100644 --- a/docs/man/man3http.desc +++ b/docs/man/man3http.desc @@ -2,10 +2,12 @@ This section documents supplemental HTTP (HyperText Transport Protocol) support functions that are available. These functions can be used in conjunction with the -<> transport for Scalability Protocols, or they +xref:nng_ws.7.adoc[WebSocket] transport for Scalability Protocols, or they may be used to construct other types of applications that communicate using HTTP. It is also possible to combine the two, such that an HTTP server providing static or dynamic content can also be used to host one or more Scalability Protocols sockets. + +NOTE: At present NNG only supports HTTP/1.0 and HTTP/1.1. diff --git a/docs/man/man3tls.desc b/docs/man/man3tls.desc index 72af1013..48b20d3e 100644 --- a/docs/man/man3tls.desc +++ b/docs/man/man3tls.desc @@ -1,8 +1,8 @@ This section documents supplemental TLS (Transport Layer Security) functions that are available. TLS support is available when using Scalability Protocols with -the <> transport, or when using WebSocket, either -with the <> transport for Scalability Protocols, +the xref:nng_tls.7.adoc[TLS] transport, or when using WebSocket, either +with the xref:nng_ws.7.adoc[WebSocket] transport for Scalability Protocols, or combined with other HTTP capabilities. These functions depend on library support that is not included directly @@ -12,6 +12,6 @@ additional support was present and enabled with _libnng_ was built. Currently, this extra support can be provided by the https://tls.mbed.org[mbedTLS library] or by external plug-ins. -TIP: Contact xref:https://staysail.tech[Staysail Systems, Inc.] for +TIP: Contact https://staysail.tech[Staysail Systems, Inc.] for details about commercially available options, including support for FIPS 140-2 validated cryptography and TLS v1.3. diff --git a/docs/man/man7.desc b/docs/man/man7.desc index 46977870..0be7f47b 100644 --- a/docs/man/man7.desc +++ b/docs/man/man7.desc @@ -4,11 +4,11 @@ available in the distribution. (((protocol))) Protocols represent "`patterns`" of communication, such as request/reply, publish/subscribe, and so forth. -A given <> is created with exactly one protocol, and that +A given xref:nng_socket.5.adoc[socket] is created with exactly one protocol, and that protocol defines the key behavior of the socket. (((transport))) Conversely, transports are the underlying mechansims by which messages are moved between participants, such as TCP/IP or UNIX domain IPC. -A given <> may be using several transports at the same +A given xref:nng_socket.5.adoc[socket] may be using several transports at the same time. -- cgit v1.2.3-70-g09d2