diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2008-11-06 00:02:41 +0000 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2008-11-06 00:02:41 +0000 |
| commit | 388782b89be0bf8144ae3dc2a590b466c96d3d6d (patch) | |
| tree | e8d41f72cc32be131ea088ef1b0dc60d740a2a37 /termkey_setwaittime.3 | |
| parent | 6adbb40f6eb112b4a34b7696301421ec7aa212bb (diff) | |
| download | termo-388782b89be0bf8144ae3dc2a590b466c96d3d6d.tar.gz termo-388782b89be0bf8144ae3dc2a590b466c96d3d6d.tar.xz termo-388782b89be0bf8144ae3dc2a590b466c96d3d6d.zip | |
Added manpages for (most of) the external API functions
Diffstat (limited to 'termkey_setwaittime.3')
| -rw-r--r-- | termkey_setwaittime.3 | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/termkey_setwaittime.3 b/termkey_setwaittime.3 new file mode 100644 index 0000000..d97e3ea --- /dev/null +++ b/termkey_setwaittime.3 @@ -0,0 +1,23 @@ +.TH TERMKEY_SETWAITTIME 3 +.SH NAME +termkey_setwaittime, termkey_getwaittime \- control the wait time for multibyte sequences +.SH SYNOPSIS +.nf +.B #include <termkey.h> +.sp +.BI "void termkey_setwaittime(termkey_t *" tk ", int " msec ); +.br +.BI "int termkey_getwaittime(termkey_t *" tk ); +.fi +.sp +Link with \fI-ltermkey\fP. +.SH DESCRIPTION +\fBtermkey_setwaittime\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_getwaittime\fP returns the value set by the last call to \fBtermkey_setwaittime\fP(), or the default value if a different has not been set. +.SH "RETURN VALUE" +\fBtermkey_setwaittime\fP() returns no value. \fBtermkey_getwaittime\fP() returns the current wait time in miliseconds. +.SH "SEE ALSO" +.BR termkey_new (3), +.BR termkey_getkey (3), +.BR termkey_waitkey (3) |