summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorPaul "LeoNerd" Evans <leonerd@leonerd.org.uk>2020-05-14 19:41:57 +0100
committerPaul "LeoNerd" Evans <leonerd@leonerd.org.uk>2020-05-14 19:41:57 +0100
commit7fe3f7fe9356bbe0243d5418bbed9862cf2004de (patch)
tree99e60815af32f7ca0d7a7482a3d142a22dbaede2 /man
parent1644704a7517ffe597500726e258d3db8e365cb4 (diff)
Add a TickitTermBuilder field for output buffer size
Diffstat (limited to 'man')
-rw-r--r--man/tickit_term_build.33
1 files changed, 3 insertions, 0 deletions
diff --git a/man/tickit_term_build.3 b/man/tickit_term_build.3
index 36ce7fc..c8146b6 100644
--- a/man/tickit_term_build.3
+++ b/man/tickit_term_build.3
@@ -9,6 +9,7 @@ tickit_term_build \- create a new terminal instance with arguments
.BI " const char *" termtype ;
.BI " enum ... " open ;
.BI " int " input_fd ", " output_fd ;
+.BI " size_t " output_buffersize ;
.BI " ..."
.BI "};"
.sp
@@ -35,6 +36,8 @@ The terminal will use the standard input and output streams.
.B TICKIT_OPEN_STDTTY
The terminal will use the first file descriptor of standard input, output or error for which \fBisatty\fP(3) returns true.
.PP
+The \fIoutput_buffersize\fP field sets the initial size of the output buffer. It defaults to zero, meaning no buffer will be allocated.
+.PP
The reference count of a newly-constructed terminal instance will be one. This can be incremented or decremented using \fBtickit_term_ref\fP(3) and \fBtickit_term_unref\fP(3). When its reference count reaches zero it is destroyed.
.SH "RETURN VALUE"
If successful, \fBtickit_term_build\fP() returns a pointer to the new instance. On failure, \fBNULL\fP is returned with \fIerrno\fP set to indicate the failure.