aboutsummaryrefslogtreecommitdiff
path: root/termkey_set_waittime.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2008-11-06 20:29:50 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2008-11-06 20:29:50 +0000
commit9cd46fcea30691cd5ab73a43498534bf93b8ca39 (patch)
treec45109fc1ec076c67d7a0dcbfb26b5df9582992e /termkey_set_waittime.3
parent023943c7389cd1ece50bb92bb8bd1af42b62c580 (diff)
downloadtermo-9cd46fcea30691cd5ab73a43498534bf93b8ca39.tar.gz
termo-9cd46fcea30691cd5ab73a43498534bf93b8ca39.tar.xz
termo-9cd46fcea30691cd5ab73a43498534bf93b8ca39.zip
Renamed termkey_{set,get}waittime() to termkey_{set,get}_waittime() to be more consistent
Diffstat (limited to 'termkey_set_waittime.3')
-rw-r--r--termkey_set_waittime.323
1 files changed, 23 insertions, 0 deletions
diff --git a/termkey_set_waittime.3 b/termkey_set_waittime.3
new file mode 100644
index 0000000..87fc82b
--- /dev/null
+++ b/termkey_set_waittime.3
@@ -0,0 +1,23 @@
+.TH TERMKEY_SET_WAITTIME 3
+.SH NAME
+termkey_set_waittime, termkey_get_waittime \- control the wait time for multibyte sequences
+.SH SYNOPSIS
+.nf
+.B #include <termkey.h>
+.sp
+.BI "void termkey_set_waittime(termkey_t *" tk ", int " msec );
+.br
+.BI "int termkey_get_waittime(termkey_t *" tk );
+.fi
+.sp
+Link with \fI-ltermkey\fP.
+.SH DESCRIPTION
+\fBtermkey_set_waittime\fP sets the number of miliseconds that \fBtermkey_wait\fP(3) will wait for the remaining bytes of a multibyte sequence if it detects the start of a partially-complete one.
+.PP
+\fBtermkey_get_waittime\fP returns the value set by the last call to \fBtermkey_set_waittime\fP(), or the default value if a different has not been set.
+.SH "RETURN VALUE"
+\fBtermkey_set_waittime\fP() returns no value. \fBtermkey_get_waittime\fP() returns the current wait time in miliseconds.
+.SH "SEE ALSO"
+.BR termkey_new (3),
+.BR termkey_getkey (3),
+.BR termkey_waitkey (3)