nng message header converted to mdbook

8 files changed, 7 insertions, 395 deletions

diff --git a/docs/man/libnng.3.adoc b/docs/man/libnng.3.adoc
index e13ddf0b..7f1850cc 100644
--- a/docs/man/libnng.3.adoc
+++ b/docs/man/libnng.3.adoc
@@ -99,20 +99,20 @@ Most applications will only interact with the body.
 
 |===
 // |xref:nng_msg_alloc.3.adoc[nng_msg_alloc()]|allocate a message
-|xref:nng_msg_append.3.adoc[nng_msg_append()]|append to message body
-|xref:nng_msg_body.3.adoc[nng_msg_body()]|return message body
+// |xref:nng_msg_append.3.adoc[nng_msg_append()]|append to message body
+// |xref:nng_msg_body.3.adoc[nng_msg_body()]|return message body
 // |xref:nng_msg_capacity.3.adoc[nng_msg_capacity()]|return capacity allocated for message body
-|xref:nng_msg_chop.3.adoc[nng_msg_chop()]|remove data from end of message body
-|xref:nng_msg_clear.3.adoc[nng_msg_clear()]|clear message body
+// |xref:nng_msg_chop.3.adoc[nng_msg_chop()]|remove data from end of message body
+// |xref:nng_msg_clear.3.adoc[nng_msg_clear()]|clear message body
 // |xref:nng_msg_dup.3.adoc[nng_msg_dup()]|duplicate a message
 // |xref:nng_msg_free.3.adoc[nng_msg_free()]|free a message
 |xref:nng_msg_get_pipe.3.adoc[nng_msg_get_pipe()]|get pipe for message
-|xref:nng_msg_insert.3.adoc[nng_msg_insert()]|prepend to message body
-|xref:nng_msg_len.3.adoc[nng_msg_len()]|return the message body length
+// |xref:nng_msg_insert.3.adoc[nng_msg_insert()]|prepend to message body
+// |xref:nng_msg_len.3.adoc[nng_msg_len()]|return the message body length
 // |xref:nng_msg_realloc.3.adoc[nng_msg_realloc()]|reallocate a message
 // |xref:nng_msg_reserve.3.adoc[nng_msg_reserve()]|reserve storage for message body
 |xref:nng_msg_set_pipe.3.adoc[nng_msg_set_pipe()]|set pipe for message
-|xref:nng_msg_trim.3.adoc[nng_msg_trim()]|remove data from start of message body
+// |xref:nng_msg_trim.3.adoc[nng_msg_trim()]|remove data from start of message body
 |xref:nng_recvmsg.3.adoc[nng_recvmsg()]|receive a message
 |xref:nng_sendmsg.3.adoc[nng_sendmsg()]|send a message
 |===
diff --git a/docs/man/nng_msg_append.3.adoc b/docs/man/nng_msg_append.3.adoc
deleted file mode 100644
index 9ed3741d..00000000
--- a/docs/man/nng_msg_append.3.adoc
+++ /dev/null
@@ -1,58 +0,0 @@
-= nng_msg_append(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// 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_msg_append - append to message body
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_msg_append(nng_msg *msg, const void *val, size_t size);
-int nng_msg_append_u16(nng_msg *msg, uint16_t val16);
-int nng_msg_append_u32(nng_msg *msg, uint32_t val32);
-int nng_msg_append_u64(nng_msg *msg, uint64_t val64);
-----
-
-== DESCRIPTION
-
-The `nng_msg_append()` family of functions appends data to
-the end of the body of message _msg_, reallocating it if necessary.
-The first function appends _size_ bytes, copying them from _val_.
-The remaining functions append the value specified (such as _val32_) in
-network-byte order (big-endian).
-
-== RETURN VALUES
-
-These functions return 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_ENOMEM`:: Insufficient free memory exists.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_msg_body.3.adoc[nng_msg_body(3)],
-xref:nng_msg_chop.3.adoc[nng_msg_chop(3)],
-xref:nng_msg_free.3.adoc[nng_msg_free(3)],
-xref:nng_msg_insert.3.adoc[nng_msg_insert(3)],
-xref:nng_msg_len.3.adoc[nng_msg_len(3)],
-xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)],
-xref:nng_msg_trim.3.adoc[nng_msg_trim(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_msg_body.3.adoc b/docs/man/nng_msg_body.3.adoc
deleted file mode 100644
index ad0fa7b3..00000000
--- a/docs/man/nng_msg_body.3.adoc
+++ /dev/null
@@ -1,62 +0,0 @@
-= nng_msg_body(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// 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_msg_body - return message body
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void *nng_msg_body(nng_msg *msg);
-----
-
-== DESCRIPTION
-
-The `nng_msg_body()` function returns a pointer to the start of the body
-content of the message _msg_.
-
-NOTE: The value returned by this is invalidated by a call to any of the
-functions that modify the message itself.
-Such functions are
-xref:nng_msg_free.3.adoc[`nng_msg_free()`],
-xref:nng_msg_realloc.3.adoc[`nng_msg_realloc()`],
-any of the xref:nng_msg_trim.3.adoc[`nng_msg_trim()`],
-xref:nng_msg_chop.3.adoc[`nng_msg_chop()`],
-xref:nng_msg_append.3.adoc[`nng_msg_append()`],
-or xref:nng_msg_insert.3.adoc[`nng_msg_insert()`] variants.
-
-== RETURN VALUES
-
-Pointer to start of message body.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_msg_append.3.adoc[nng_msg_append(3)],
-xref:nng_msg_chop.3.adoc[nng_msg_chop(3)],
-xref:nng_msg_free.3.adoc[nng_msg_free(3)],
-xref:nng_msg_insert.3.adoc[nng_msg_insert(3)],
-xref:nng_msg_len.3.adoc[nng_msg_len(3)],
-xref:nng_msg_capacity.3.adoc[nng_msg_capacity(3)],
-xref:nng_msg_reserve.3.adoc[nng_msg_reserve(3)],
-xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)],
-xref:nng_msg_trim.3.adoc[nng_msg_trim(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_msg_chop.3.adoc b/docs/man/nng_msg_chop.3.adoc
deleted file mode 100644
index b945f0bb..00000000
--- a/docs/man/nng_msg_chop.3.adoc
+++ /dev/null
@@ -1,61 +0,0 @@
-= nng_msg_chop(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// 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_msg_chop - remove data from end of message body
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_msg_chop(nng_msg *msg, size_t size);
-int nng_msg_chop_u16(nng_msg *msg, uint16_t *val16);
-int nng_msg_chop_u32(nng_msg *msg, uint32_t *val32);
-int nng_msg_chop_u64(nng_msg *msg, uint64_t *val64);
-----
-
-== DESCRIPTION
-
-The `nng_msg_chop()` family of functions removes data from
-the end of the body of message _msg_.
-The first function removes _size_ bytes.
-The remaining functions remove 2, 4, or 8 bytes, and stores them in the value
-(such as _val32_),
-after converting them from network-byte order (big-endian) to native byte order.
-
-== RETURN VALUES
-
-These functions return 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_EINVAL`:: The message body is too short to remove the requested data.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_msg_append.3.adoc[nng_msg_append(3)],
-xref:nng_msg_body.3.adoc[nng_msg_body(3)],
-xref:nng_msg_free.3.adoc[nng_msg_free(3)],
-xref:nng_msg_insert.3.adoc[nng_msg_insert(3)],
-xref:nng_msg_len.3.adoc[nng_msg_len(3)],
-xref:nng_msg_capacity.3.adoc[nng_msg_capacity(3)],
-xref:nng_msg_reserve.3.adoc[nng_msg_reserve(3)],
-xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)],
-xref:nng_msg_trim.3.adoc[nng_msg_trim(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_msg_clear.3.adoc b/docs/man/nng_msg_clear.3.adoc
deleted file mode 100644
index e5b3bf47..00000000
--- a/docs/man/nng_msg_clear.3.adoc
+++ /dev/null
@@ -1,41 +0,0 @@
-= nng_msg_clear(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// 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_msg_clear - clear message body content
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-void nng_msg_clear(nng_msg *msg);
-----
-
-== DESCRIPTION
-
-The `nng_msg_clear()` function resets the body length of _msg_ to zero.
-
-== RETURN VALUES
-
-None.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_msg_insert.3.adoc b/docs/man/nng_msg_insert.3.adoc
deleted file mode 100644
index 25f98fce..00000000
--- a/docs/man/nng_msg_insert.3.adoc
+++ /dev/null
@@ -1,63 +0,0 @@
-= nng_msg_insert(3)
-//
-// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// 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_msg_insert - prepend to message body
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_msg_insert(nng_msg *msg, const void *val, size_t size);
-int nng_msg_insert_u16(nng_msg *msg, uint16_t val16);
-int nng_msg_insert_u32(nng_msg *msg, uint32_t val32);
-int nng_msg_insert_u64(nng_msg *msg, uint64_t val64);
-----
-
-== DESCRIPTION
-
-The `nng_msg_insert()` family of functions prepends data to
-the front of the body of message _msg_, reallocating it if necessary.
-The first function prepends _size_ bytes, copying them from _val_.
-The remaining functions prepend the specified value (such as _val32_)
-in network-byte order (big-endian).
-
-TIP: These functions make use of space pre-allocated in front of the
-message body if available, so they can often avoid performing any reallocation.
-Applications should use these instead of reallocating and copying message
-content themselves, in order to benefit from this capability.
-
-== RETURN VALUES
-
-These functions return 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_ENOMEM`:: Insufficient free memory exists.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_msg_append.3.adoc[nng_msg_append(3)],
-xref:nng_msg_body.3.adoc[nng_msg_body(3)],
-xref:nng_msg_chop.3.adoc[nng_msg_chop(3)],
-xref:nng_msg_free.3.adoc[nng_msg_free(3)],
-xref:nng_msg_len.3.adoc[nng_msg_len(3)],
-xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)],
-xref:nng_msg_trim.3.adoc[nng_msg_trim(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_msg_len.3.adoc b/docs/man/nng_msg_len.3.adoc
deleted file mode 100644
index 2a3dfe67..00000000
--- a/docs/man/nng_msg_len.3.adoc
+++ /dev/null
@@ -1,43 +0,0 @@
-= nng_msg_len(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// 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_msg_len - return message body length
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-size_t nng_msg_len(nng_msg *msg);
-----
-
-== DESCRIPTION
-
-The `nng_msg_len()` returns the length of the body of message _msg_.
-
-== RETURN VALUES
-
-Length of message body.
-
-== ERRORS
-
-None.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_msg_body.3.adoc[nng_msg_body(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng.7.adoc[nng(7)]
diff --git a/docs/man/nng_msg_trim.3.adoc b/docs/man/nng_msg_trim.3.adoc
deleted file mode 100644
index aa482958..00000000
--- a/docs/man/nng_msg_trim.3.adoc
+++ /dev/null
@@ -1,60 +0,0 @@
-= nng_msg_trim(3)
-//
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
-// Copyright 2018 Capitar IT Group BV <info@capitar.com>
-//
-// 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_msg_trim - remove data from start of message body
-
-== SYNOPSIS
-
-[source, c]
-----
-#include <nng/nng.h>
-
-int nng_msg_trim(nng_msg *msg, size_t size);
-int nng_msg_trim_u16(nng_msg *msg, uint16_t *val16);
-int nng_msg_trim_u32(nng_msg *msg, uint32_t *val32);
-int nng_msg_trim_u64(nng_msg *msg, uint64_t *val64);
-----
-
-== DESCRIPTION
-
-The `nng_msg_trim()` family of functions removes data from
-the start of the body of message _msg_.
-The first function removes _size_ bytes.
-The remaining functions remove 2, 4, or 8 bytes, and stores them in the value
-(such as _val32_),
-after converting them from network-byte order (big-endian) to native
-byte order.
-
-== RETURN VALUES
-
-These functions return 0 on success, and non-zero otherwise.
-
-== ERRORS
-
-[horizontal]
-`NNG_EINVAL`:: The message body is too short to remove the requested data.
-
-== SEE ALSO
-
-[.text-left]
-xref:nng_msg_alloc.3.adoc[nng_msg_alloc(3)],
-xref:nng_msg_append.3.adoc[nng_msg_append(3)],
-xref:nng_msg_body.3.adoc[nng_msg_body(3)],
-xref:nng_msg_chop.3.adoc[nng_msg_chop(3)],
-xref:nng_msg_free.3.adoc[nng_msg_free(3)],
-xref:nng_msg_insert.3.adoc[nng_msg_insert(3)],
-xref:nng_msg_len.3.adoc[nng_msg_len(3)],
-xref:nng_msg_realloc.3.adoc[nng_msg_realloc(3)],
-xref:nng_strerror.3.adoc[nng_strerror(3)],
-xref:nng_msg.5.adoc[nng_msg(5)],
-xref:nng.7.adoc[nng(7)]