Put some more so references in, and tidy the text a little.

[mLib] / man / lbuf.3

diff --git a/man/lbuf.3 b/man/lbuf.3
index e238a8cf9ea9d43113a5decde59b1299744d01e7..1fee8359e6cfd06855ca1a53809f3efbf133be2b 100644 (file)
--- a/man/lbuf.3
+++ b/man/lbuf.3
@@ -6,7 +6,9 @@ lbuf \- split lines out of asynchronously received blocks
 .\" @lbuf_close
 .\" @lbuf_free
 .\" @lbuf_snarf
 .\" @lbuf_close
 .\" @lbuf_free
 .\" @lbuf_snarf

+.\" @lbuf_setsize

 .\" @lbuf_init
 .\" @lbuf_init

+.\" @lbuf_destroy

 .SH "SYNOPSIS"
 .nf
 .B "#include <mLib/lbuf.h>"
 .SH "SYNOPSIS"
 .nf
 .B "#include <mLib/lbuf.h>"


@@ -45,8 +47,9 @@ The function
 initializes a line buffer ready for use.  It is given three arguments:
 .TP
 .BI "lbuf *" b
 initializes a line buffer ready for use.  It is given three arguments:
 .TP
 .BI "lbuf *" b

-A pointer to the block of memory to use for the line buffer.  This is
-all the memory the line buffer requires.
+A pointer to the block of memory to use for the line buffer.  The line
+buffer will allocate memory to store incoming data automatically: this
+structure just contains bookkeeping information.

 .TP
 .BI "void (*" func ")(char *" s ", void *" p )
 The
 .TP
 .BI "void (*" func ")(char *" s ", void *" p )
 The


@@ -97,7 +100,7 @@ The
 function returns the address and size of a free portion of the line
 buffer's memory into which data may be written.  The function is passed
 the address 
 function returns the address and size of a free portion of the line
 buffer's memory into which data may be written.  The function is passed
 the address 

-.I l
+.I b

 of the line buffer.  Its result is the size of the free area, and it
 writes the base address of this free space to the location pointed to by
 the argument
 of the line buffer.  Its result is the size of the free area, and it
 writes the base address of this free space to the location pointed to by
 the argument