From 25c56f7aa0e1652d565ed372b4b10cf99b733141 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Mon, 30 Oct 2017 17:25:36 -0700
Subject: New strerror document.

---
 docs/nng_strerror.adoc | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)
 create mode 100644 docs/nng_strerror.adoc

(limited to 'docs/nng_strerror.adoc')

diff --git a/docs/nng_strerror.adoc b/docs/nng_strerror.adoc
new file mode 100644
index 00000000..e8ef5517
--- /dev/null
+++ b/docs/nng_strerror.adoc
@@ -0,0 +1,72 @@
+nng_strerror(3)
+===============
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:icons: font
+:source-highlighter: pygments
+:copyright: Copyright 2017 Garrett D'Amore <garrett@damore.org> \
+            Copyright 2017 Capitar IT Group BV <info@capitar.com> \
+            This software 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_strerror - return an error description
+
+SYNOPSIS
+--------
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+const char * nng_strerror(int err);
+-----------
+
+
+DESCRIPTION
+-----------
+
+The `nng_strerror()` returns the human-readable description of the
+given _nng_ error in `err`.
+
+NOTE: The returned error message is provided in US English, but in the
+future locale-specific strings may be presented instead.
+
+NOTE: The specific strings associated with specific error messages are
+subject to change.  Therefore applications must not depend on the message,
+but may use them verbatim when supplying information to end-users, such
+as in diagnostic messages or log entries.
+
+
+RETURN VALUES
+-------------
+
+This function returns the human-readable error message, terminated
+by a `NUL` byte.
+
+
+AUTHORS
+-------
+
+link:mailto:garrett@damore.org[Garrett D'Amore]
+
+
+SEE ALSO
+--------
+
+<<libnng#,libnng(3)>>
+<<nng#,nng(7)>>
+
+
+COPYRIGHT
+---------
+
+Copyright 2017 mailto:garrett@damore.org[Garrett D'Amore] +
+Copyright 2017 mailto:info@capitar.com[Capitar IT Group BV]
+
+This document is supplied under the terms of the
+https://opensource.org/licenses/LICENSE.txt[MIT License].
-- 
cgit v1.2.3-70-g09d2

