From 546c9b45556d2491c510f01246daf49d9d2f6b87 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Mon, 25 May 2020 17:44:47 -0700
Subject: Added nng_url.5 man page.

---
 docs/man/nng_url.5.adoc | 66 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 docs/man/nng_url.5.adoc

(limited to 'docs/man/nng_url.5.adoc')

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)]
-- 
cgit v1.2.3-70-g09d2

