p
/
termo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added manpage for termkey_{get,set}_buffer_size

This commit is contained in:
Paul LeoNerd Evans 2012-02-13 23:56:59 +00:00
parent e252c497ae
commit 5d44c08ecf
5 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile
View File

@ -81,6 +81,7 @@ install-man:
ln -sf termkey_set_waittime.3.gz $(DESTDIR)$(MAN3DIR)/termkey_get_waittime.3.gz ln -sf termkey_set_waittime.3.gz $(DESTDIR)$(MAN3DIR)/termkey_get_waittime.3.gz
ln -sf termkey_set_flags.3.gz $(DESTDIR)$(MAN3DIR)/termkey_get_flags.3.gz ln -sf termkey_set_flags.3.gz $(DESTDIR)$(MAN3DIR)/termkey_get_flags.3.gz
ln -sf termkey_set_canonflags.3.gz $(DESTDIR)$(MAN3DIR)/termkey_get_canonflags.3.gz ln -sf termkey_set_canonflags.3.gz $(DESTDIR)$(MAN3DIR)/termkey_get_canonflags.3.gz
ln -sf termkey_set_buffer_size.3.gz $(DESTDIR)$(MAN3DIR)/termkey_get_buffer_size.3.gz
# DIST CUT # DIST CUT

1
man/also
View File

@ -2,5 +2,6 @@ termkey_destroy.3 = termkey_new.3
termkey_new_abstract.3 = termkey_new.3 termkey_new_abstract.3 = termkey_new.3
termkey_get_flags.3 = termkey_set_flags.3 termkey_get_flags.3 = termkey_set_flags.3
termkey_get_canonflags.3 = termkey_set_canonflags.3 termkey_get_canonflags.3 = termkey_set_canonflags.3
termkey_get_buffer_size.3 = termkey_set_buffer_size.3
termkey_get_waittime.3 = termkey_set_waittime.3 termkey_get_waittime.3 = termkey_set_waittime.3
termkey_getkey_force.3 = termkey_getkey.3 termkey_getkey_force.3 = termkey_getkey.3

2
man/termkey_get_buffer_remaining.3
View File

@ -17,5 +17,7 @@ Link with \fI-ltermkey\fP.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR termkey_push_bytes (3), .BR termkey_push_bytes (3),
.BR termkey_advisereadable (3), .BR termkey_advisereadable (3),
.BR termkey_set_buffer_size (3),
.BR termkey_get_buffer_size (3),
.BR termkey_getkey (3), .BR termkey_getkey (3),
.BR termkey (7) .BR termkey (7)

1
man/termkey_new.3
View File

@ -42,4 +42,5 @@ Additionally, \fBtermkey_new\fP() may fail if \fBfstat\fP(2) or \fBwrite\fP(2) f
.BR termkey_get_flags (3), .BR termkey_get_flags (3),
.BR termkey_get_fd (3), .BR termkey_get_fd (3),
.BR termkey_get_buffer_remaining (3), .BR termkey_get_buffer_remaining (3),
.BR termkey_get_buffer_size (3),
.BR termkey (7) .BR termkey (7)

22
man/termkey_set_buffer_size.3 Normal file
View File

@ -0,0 +1,22 @@
.TH TERMKEY_SET_BUFFER_SIZE 3
.SH NAME
termkey_set_buffer_size, termkey_get_buffer_size \- control the buffer size
.SH SYNOPSIS
.nf
.B #include <termkey.h>
.sp
.BI "int termkey_set_buffer_size(TermKey *" tk ", size_t " size );
.BI "size_t termkey_get_buffer_size(TermKey *" tk );
.fi
.sp
Link with \fI-ltermkey\fP.
.SH DESCRIPTION
\fBtermkey_set_buffer_size\fP() changes the size of the buffer space in the \fBtermkey\fP(7) instance to that given by \fIsize\fP. Any bytes pending in the buffer will be preserved when resizing, though they will be truncated if the new size is smaller than the total number of bytes in the buffer.
.PP
\fBtermkey_get_buffer_size\fP() returns the size of the buffer set by the last call to \fBtermkey_set_buffer_size\fP(), or the default initial size of 256 bytes.
.SH "RETURN VALUE"
\fBtermkey_set_buffer_size\fP() returns a true value, or zero if an error occurs. \fBtermkey_get_buffer_size\fP() returns the current buffer size in bytes.
.SH "SEE ALSO"
.BR termkey_new (3),
.BR termkey_get_buffer_remaining (3),
.BR termkey (7)