add man page

This commit is contained in:
Felix von Leitner 2009-02-28 00:12:49 +00:00
parent 97161ed0df
commit d94fec77d0
2 changed files with 20 additions and 1 deletions

View File

@ -16,4 +16,4 @@ particular, do not call stralloc_free on it!
Reading data from the buffer will not change the stralloc.
buffer_init(3), buffer(3)
buffer_tosa(3), buffer_init(3), buffer(3)

buffer/buffer_tosa.3 Normal file
View File

@ -0,0 +1,19 @@
.TH buffer_tosa 3
buffer_tosa \- initialize buffer for writing to stralloc
.B #include <buffer.h>
int \fBbuffer_tosa\fR(buffer* \fIb\fR,stralloc* \fIsa\fR);
buffer_tosa makes a virtual write buffer from a stralloc. The buffer
writing functions will append data to the stralloc until the stralloc
fails to allocate more memory. You still need to flush the buffer.
Note that in the end the stralloc will have allocated more memory than
is needed to hold the actual contents. The waste is 1024 bytes.
buffer_tosa returns 0 if everything was fine, -1 if it failed to
allocate space for the initial data in the stralloc.
buffer_tosa(3), buffer_init(3), buffer(3)