update to version 25cjannis

1 files changed, 20 insertions, 18 deletions

diff --git a/man/getln.3 b/man/getln.3
index bb4ae7c..01f8b89 100644
--- a/man/getln.3
+++ b/man/getln.3
@@ -4,11 +4,11 @@ getln \ - read one line of data
 .SH SYNTAX
 .B #include \(dqgetln.h\(dq
 
-int \fBgetln\fP(&buffer_0,&sa,&match,sep);
+int \fBgetln\fP(&buf,&sa,&match,sep);
 .br
-int \fBgetln2\fP(&buffer_0,&sa,&cont,&clen,sep);
+int \fBgetln2\fP(&buf,&sa,&cont,&clen,sep);
 
-buffer \fIbuffer_0\fR; 
+buffer \fIbuf\fR; 
 .br
 stralloc \fIsa\fR; 
 .br
@@ -22,7 +22,7 @@ unsigned int \fIclen\fR;
 .SH DESCRIPTION
 .B getln 
 reads a line of characters, terminated by a sep character, from 
-.IR buffer_0 . 
+.IR buf . 
 It returns the line in 
 .I sa 
 and sets match to 
@@ -39,18 +39,18 @@ and sets match to
 .B getln2 
 reads a line of characters, terminated by a 
 .I sep 
-character, from 
-.IR buffer_0 .
+character from 
+.IR buf .
 The line is returned in two pieces. The first piece is stored in 
 .IR sa . 
 The second piece is 
 .IR cont , 
 a pointer to 
 .I clen 
-characters inside the 
-.I buffer_0 
-buffer. The second piece must be copied somewhere else before 
-.I ss 
+characters inside 
+.IR buf .
+The second piece must be copied somewhere else before 
+.I sa 
 is used again.
 If 
 .B getln2 
@@ -64,12 +64,19 @@ and does not set
 .IR cont . 
 It puts the partial line into 
 .IR sa.
+.SH "BUFFER"
+.I buf
+can be a pre-allocated buffer like
+.I buffer_0 
+reading from
+.I STDIN 
+or any other explicitly generated buffer on a given file descriptor.
 .SH "RETURN CODES"
 .B getln 
 normally returns 
 .IR 0 . 
 If it runs out of memory, or encounters an error from 
-.IR ss , 
+.IR sa , 
 it returns 
 .IR -1 , 
 setting 
@@ -80,17 +87,12 @@ appropriately.
 normally returns 
 .IR 0 . 
 If it runs out of memory, or encounters an error from 
-.IR ss , 
+.IR sa , 
 it returns 
 .IR -1 , 
 setting 
 .I errno 
 appropriately.  
-.SH NOTE
-The input buffer
-.I buffer_0
-is already pre-allocated. 
-It can be used without initialization as synonym for STDIN.
 .SH CREDITS
 The
 .B getln 
@@ -99,4 +101,4 @@ and
 man page were taken from Bruce Guenther and 
 originally published by Dan Bernstein for qmail-1.03.
 .SH SEE ALSO
-stralloc(3)
+stralloc(3), buffer(3).