From ee4a2c0cdb5cad82a0c5e2825b1275d6fd96deb9 Mon Sep 17 00:00:00 2001
From: leitner <leitner>
Date: Mon, 9 Sep 2013 19:19:52 +0000
Subject: [PATCH] add man pages for buffer_from*

---
 buffer/buffer_fromarray.3 | 19 +++++++++++++++++++
 buffer/buffer_frombuf.3   | 18 ++++++++++++++++++
 buffer/buffer_fromsa.3    |  4 ++--
 3 files changed, 39 insertions(+), 2 deletions(-)
 create mode 100644 buffer/buffer_fromarray.3
 create mode 100644 buffer/buffer_frombuf.3

diff --git a/buffer/buffer_fromarray.3 b/buffer/buffer_fromarray.3
new file mode 100644
index 0000000..8c67b59
--- /dev/null
+++ b/buffer/buffer_fromarray.3
@@ -0,0 +1,19 @@
+.TH buffer_fromarray 3
+.SH NAME
+buffer_fromarray \- initialize buffer structure from array
+.SH SYNTAX
+.B #include <array.h>
+.B #include <buffer.h>
+
+void \fBbuffer_fromarray\fR(buffer* \fIb\fR,array* \fIa\fR);
+.SH DESCRIPTION
+buffer_fromarray makes a virtual read buffer from an array.  The buffer
+reading functions will be able to read until the end of the data in the
+array, then signal EOF.  The buffer does not have its own buffer
+space, it reuses the one in the array.
+
+Do not touch the array until you are done with the buffer!
+
+Reading data from the buffer will not change the stralloc.
+.SH "SEE ALSO"
+buffer_fromsa(3), buffer_init(3), buffer(3), buffer_frombuf(3)
diff --git a/buffer/buffer_frombuf.3 b/buffer/buffer_frombuf.3
new file mode 100644
index 0000000..b65236a
--- /dev/null
+++ b/buffer/buffer_frombuf.3
@@ -0,0 +1,18 @@
+.TH buffer_frombuf 3
+.SH NAME
+buffer_frombuf \- initialize buffer structure from raw memory
+.SH SYNTAX
+.B #include <buffer.h>
+
+void \fBbuffer_frombuf\fR(buffer* \fIb\fR,const char* \fIx\fR, size_t \fIl\fR);
+.SH DESCRIPTION
+buffer_frombuf makes a virtual read buffer from a raw memory area.  The buffer
+reading functions will be able to read until the end of the data in the
+memory area, then signal EOF.  The buffer does not have its own buffer
+space, it reuses the one passed into this function.
+
+Do not touch this memory until you are done with the buffer!
+
+Reading data from the buffer will not change the memory you passed in.
+.SH "SEE ALSO"
+buffer_fromsa(3), buffer_init(3), buffer(3), buffer_frombuf(3)
diff --git a/buffer/buffer_fromsa.3 b/buffer/buffer_fromsa.3
index 6d2c274..a236190 100644
--- a/buffer/buffer_fromsa.3
+++ b/buffer/buffer_fromsa.3
@@ -11,9 +11,9 @@ reading functions will be able to read until the end of the data in the
 stralloc, then signal EOF.  The buffer does not have its own buffer
 space, it reuses the one in the stralloc.
 
-Do not touch the stralloc until your are done with the buffer!  In
+Do not touch the stralloc until you are done with the buffer!  In
 particular, do not call stralloc_free on it!
 
 Reading data from the buffer will not change the stralloc.
 .SH "SEE ALSO"
-buffer_tosa(3), buffer_init(3), buffer(3)
+buffer_tosa(3), buffer_init(3), buffer(3), buffer_frombuf(3), buffer_fromarray(3)