Added nng_url.5 man page.

4 files changed, 69 insertions, 86 deletions

diff --git a/docs/man/CMakeLists.txt b/docs/man/CMakeLists.txt
index b4d85fd1..d17a1cfe 100644
--- a/docs/man/CMakeLists.txt
+++ b/docs/man/CMakeLists.txt
@@ -360,6 +360,7 @@ if (NNG_ENABLE_DOC)
             nng_sockaddr_zt
             nng_socket
             nng_stat
+            nng_url
 
             nng_stream
             nng_stream_dialer
diff --git a/docs/man/nng_tcp.5.adoc b/docs/man/nng_tcp.5.adoc
deleted file mode 100644
index 6f424239..00000000
--- a/docs/man/nng_tcp.5.adoc
+++ /dev/null
@@ -1,84 +0,0 @@
-= nng_tcp(5)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-// Copyright 2019 Devolutions <info@devolutions.net>
-//
-// This document is supplied under the terms of the MIT License, a
-// copy of which should be located in the distribution where this
-// file was obtained (LICENSE.txt).  A copy of the license may also be
-// found online at https://opensource.org/licenses/MIT.
-//
-
-== NAME
-
-nng_tcp - TCP connection
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-#include <nng/supplemental/tcp/tcp.h>
-
-typedef struct nng_tcp_s nng_tcp;
-----
-
-== DESCRIPTION
-
-An `nng_tcp` (((TCP connection))) represents a connected stream.
-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
-xref:nng_tcp.7.adoc[nng_tcp(7)] transport.
-
-TIP: Most NNG applications should not use this, but instead use the
-xref:nng_tcp.7.adoc[nng_tcp(7)] transport instead.
-
-These objects are created either establishing an outgoing connection
-with xref:nng_tcp_dialer_dial.3tcp.adoc[`nng_tcp_dialer_dial()`] or by
-accepting in incoming connection with
-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 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
-xref:nng_tcp_free.3tcp.adoc[`nng_tcp_free()`].
-
-TIP: It is possible to close the connection, without freeing it, by
-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 xref:nng_tcp_getopt.3tcp.adoc[`nng_tcp_getopt()`] and
-xref:nng_tcp_setopt.3tcp.adoc[`nng_tcp_setopt()`] functions.
-
-* 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]
-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)]
diff --git a/docs/man/nng_tcp_options.5.adoc b/docs/man/nng_tcp_options.5.adoc
index 1ca31a32..ef2e3ae5 100644
--- a/docs/man/nng_tcp_options.5.adoc
+++ b/docs/man/nng_tcp_options.5.adoc
@@ -1,6 +1,6 @@
 = nng_tcp_options(5)
 //
-// Copyright 2019 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
 // Copyright 2018 Capitar IT Group BV <info@capitar.com>
 // Copyright 2019 Devolutions <info@devolutions.net>
 //
@@ -12,7 +12,7 @@
 
 == NAME
 
-nng_tcp_options - TTCP-specific options
+nng_tcp_options - TCP-specific options
 
 == SYNOPSIS
 
diff --git a/docs/man/nng_url.5.adoc b/docs/man/nng_url.5.adoc
new file mode 100644
index 00000000..e9e59bbc
--- /dev/null
+++ b/docs/man/nng_url.5.adoc
@@ -0,0 +1,66 @@
+= nng_sockaddr(5)
+//
+// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
+//
+// This document is supplied under the terms of the MIT License, a
+// copy of which should be located in the distribution where this
+// file was obtained (LICENSE.txt).  A copy of the license may also be
+// found online at https://opensource.org/licenses/MIT.
+//
+
+== NAME
+
+nng_url - Universal Resource Locator object
+
+== SYNOPSIS
+
+[source, c]
+----
+#include <nng/nng.h>
+
+typedef struct nng_url {
+    char *u_rawurl;   // never NULL
+    char *u_scheme;   // never NULL
+    char *u_userinfo; // will be NULL if not specified
+    char *u_host;     // including colon and port
+    char *u_hostname; // name only, will be "" if not specified
+    char *u_port;     // port, will be "" if not specified
+    char *u_path;     // path, will be "" if not specified
+    char *u_query;    // without '?', will be NULL if not specified
+    char *u_fragment; // without '#', will be NULL if not specified
+    char *u_requri;   // includes query and fragment, "" if not specified
+} nng_url;
+----
+
+== DESCRIPTION
+
+(((URL)))(((address, socket)))
+An `nng_url` is a structure used for
+representing URLs.
+These structures are created by parsing string formatted URLs with
+xref:nng_url_parse.3.adoc[`nng_url_parse()`].
+
+Applications may access individual fields, but must not free or
+alter them, as the underlying memory is managed by the library.
+
+The fields are as follows:
+
+[horizontal]
+`u_rawurl`:: The raw URL string, un-modified.  This will never be `NULL`.
+`u_scheme`:: The URL scheme, such as "`http`" or "`inproc`".  This will never be `NULL`.
+`u_userinfo`:: This username and password if supplied in the URL string.  Will be `NULL` when not present.
+`u_host`:: The full host and port, separated by a colon.
+`u_hostname`:: The name of the host, and may be the empty string in some cases.
+`u_port`:: The port.  May be empty if irrelevant or not specified.
+`u_path`:: The extended path, typically used with HTTP or WebSockets.  Will be empty string if not specified.
+`u_query`:: The query string (typically following `?` in the URL.)  Will be `NULL` if not present.
+`u_fragment`:: This is used for specifying an anchor, the part after `#` in a URL.  Will be `NULL` if not present.
+`u_requri`:: The full URI (the part after the host and port). Will be the empty string if not specified.
+
+== SEE ALSO
+
+[.text-left]
+xref:nng_url_clone.3.adoc[nng_url_clone(3)],
+xref:nng_url_free.3.adoc[nng_url_free(3)],
+xref:nng_url_parse.3.adoc[nng_url_parse(3)],
+xref:nng.7.adoc[nng(7)]