chiark / gitweb /
Put some more so references in, and tidy the text a little.
authormdw <mdw>
Sun, 16 Jul 2000 18:56:37 +0000 (18:56 +0000)
committermdw <mdw>
Sun, 16 Jul 2000 18:56:37 +0000 (18:56 +0000)
man/lbuf.3
man/selbuf.3

index e238a8cf9ea9d43113a5decde59b1299744d01e7..1fee8359e6cfd06855ca1a53809f3efbf133be2b 100644 (file)
@@ -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
index e15beaab4d4ff6a74daf86ba6ef843a556081a3f..3bd5463ce1acd0680dbf1cd47fe7b228eb456653 100644 (file)
@@ -4,7 +4,9 @@
 selbuf \- line-buffering input selector
 .\" @selbuf_enable
 .\" @selbuf_disable
 selbuf \- line-buffering input selector
 .\" @selbuf_enable
 .\" @selbuf_disable
+.\" @selbuf_setsize
 .\" @selbuf_init
 .\" @selbuf_init
+.\" @selbuf_destroy
 .SH SYNOPSIS
 .nf
 .B "#include <mLib/selbuf.h>"
 .SH SYNOPSIS
 .nf
 .B "#include <mLib/selbuf.h>"
@@ -33,9 +35,7 @@ what gets considered to be a line of text and what doesn't, and the
 exact rules about what your line handling function should and shouldn't
 do.
 .PP
 exact rules about what your line handling function should and shouldn't
 do.
 .PP
-The data for a
-.B selbuf
-selector is stored in an object of type
+The data for a line selector is stored in an object of type
 .BR selbuf .
 This object must be allocated by the caller, and initialized using the
 .B selbuf_init
 .BR selbuf .
 This object must be allocated by the caller, and initialized using the
 .B selbuf_init