aboutsummaryrefslogtreecommitdiff
path: root/docs/nng_strerror.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-01-23 15:48:46 -0800
committerGarrett D'Amore <garrett@damore.org>2018-01-23 15:48:46 -0800
commitb2800c58d63dc1b53557ea9294b323c3b1f90dab (patch)
tree86404a3611af3730f8e431e7a97c0c03fc5d3afe /docs/nng_strerror.adoc
parent35e05eb93404be5bd2c6ae8000336486a2e26d05 (diff)
downloadnng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.tar.gz
nng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.tar.bz2
nng-b2800c58d63dc1b53557ea9294b323c3b1f90dab.zip
Add message handling man pages.
Note that we're also no longer overriding the source formatter or the icons for new pages, since we can supply that on the command line in the script that generates output.
Diffstat (limited to 'docs/nng_strerror.adoc')
-rw-r--r--docs/nng_strerror.adoc28
1 files changed, 8 insertions, 20 deletions
diff --git a/docs/nng_strerror.adoc b/docs/nng_strerror.adoc
index c78a1279..568f1150 100644
--- a/docs/nng_strerror.adoc
+++ b/docs/nng_strerror.adoc
@@ -1,10 +1,7 @@
-nng_strerror(3)
-===============
+= nng_strerror(3)
:doctype: manpage
:manmanual: nng
:mansource: nng
-:icons: font
-:source-highlighter: pygments
:copyright: Copyright 2018 Garrett D'Amore <garrett@damore.org> \
Copyright 2018 Capitar IT Group BV <info@capitar.com> \
This software is supplied under the terms of the MIT License, a \
@@ -12,12 +9,11 @@ nng_strerror(3)
file was obtained (LICENSE.txt). A copy of the license may also \
be found online at https://opensource.org/licenses/MIT.
-NAME
-----
+== NAME
+
nng_strerror - return an error description
-SYNOPSIS
---------
+== SYNOPSIS
[source, c]
-----------
@@ -26,9 +22,7 @@ SYNOPSIS
const char * nng_strerror(int err);
-----------
-
-DESCRIPTION
------------
+== DESCRIPTION
The `nng_strerror()` returns the human-readable description of the
given _nng_ error in `err`.
@@ -41,23 +35,17 @@ 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
--------------
+== RETURN VALUES
This function returns the human-readable error message, terminated
by a `NUL` byte.
-
-SEE ALSO
---------
+== SEE ALSO
<<libnng#,libnng(3)>>,
<<nng#,nng(7)>>
-
-COPYRIGHT
----------
+== COPYRIGHT
Copyright 2018 mailto:garrett@damore.org[Garrett D'Amore] +
Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]