From b2800c58d63dc1b53557ea9294b323c3b1f90dab Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Tue, 23 Jan 2018 15:48:46 -0800
Subject: 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.
---
 docs/nng_msg_header_trim.adoc | 62 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 docs/nng_msg_header_trim.adoc

(limited to 'docs/nng_msg_header_trim.adoc')

diff --git a/docs/nng_msg_header_trim.adoc b/docs/nng_msg_header_trim.adoc
new file mode 100644
index 00000000..8c59272c
--- /dev/null
+++ b/docs/nng_msg_header_trim.adoc
@@ -0,0 +1,62 @@
+= nng_msg_header_trim(3)
+:doctype: manpage
+:manmanual: nng
+:mansource: nng
+:manvolnum: 3
+:copyright: Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> \
+            Copyright 2018 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_msg_header_trim, nng_msg_header_trim_u32 - remove data from start of message header
+
+== SYNOPSIS
+
+[source, c]
+-----------
+#include <nng/nng.h>
+
+int nng_msg_header_trim(nng_msg *msg, size_t size);
+int nng_msg_header_trim_u32(nng_msg *msg, uint32_t *val32);
+-----------
+
+== DESCRIPTION
+
+The `nng_msg_header_trim()` and `nng_msg_header_trim_u32()` functions remove
+data from the start of the header of message _msg_. 
+The first function removes _size_ bytes.
+The second function removes 4 bytes, and stores them in the value _val32_,
+after converting them from network-byte order (big-endian) to native
+byte order.
+
+== RETURN VALUES
+
+This function returns 0 on success, and non-zero otherwise.
+
+== ERRORS
+
+`NNG_EINVAL`:: The message header is too short to remove the requested data.
+
+== SEE ALSO
+
+<<nng_msg_alloc#,nng_msg_alloc(3)>>,
+<<nng_msg_header#,nng_msg_header(3)>>,
+<<nng_msg_header_append#,nng_msg_header_append(3)>>,
+<<nng_msg_header_chop#,nng_msg_header_chop(3)>>,
+<<nng_msg_header_insert#,nng_msg_header_insert(3)>>,
+<<nng_msg_header_len#,nng_msg_header_len(3)>>,
+<<nng_msg_free#,nng_msg_free(3)>>,
+<<nng_strerror#,nng_strerror(3)>>,
+<<nng#,nng(7)>>
+
+== COPYRIGHT
+
+Copyright 2018 mailto:info@staysail.tech[Staysail Systems, Inc.] +
+Copyright 2018 mailto:info@capitar.com[Capitar IT Group BV]
+
+This document is supplied under the terms of the
+https://opensource.org/licenses/MIT[MIT License].
-- 
cgit v1.2.3-70-g09d2