aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_waitkey.3.sh
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-03-08 21:58:27 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-03-08 21:58:27 +0000
commit775806d32b73ebfe7abaec6e172de336431eca0d (patch)
tree1fec79956d839ac318999c39132b57505453ca0a /man/termkey_waitkey.3.sh
parent24fd4f668d96c4297429bf7a6746b1ff3aec12b5 (diff)
downloadtermo-775806d32b73ebfe7abaec6e172de336431eca0d.tar.gz
termo-775806d32b73ebfe7abaec6e172de336431eca0d.tar.xz
termo-775806d32b73ebfe7abaec6e172de336431eca0d.zip
Added documentation for termkey_{start,stop}, termkey_is_started
Diffstat (limited to 'man/termkey_waitkey.3.sh')
-rw-r--r--man/termkey_waitkey.3.sh2
1 files changed, 1 insertions, 1 deletions
diff --git a/man/termkey_waitkey.3.sh b/man/termkey_waitkey.3.sh
index 8e59e24..5a219b4 100644
--- a/man/termkey_waitkey.3.sh
+++ b/man/termkey_waitkey.3.sh
@@ -27,7 +27,7 @@ A key event as been provided.
No key events are ready and the terminal has been closed, so no more will arrive.
.TP
.B TERMKEY_RES_ERROR
-An IO error occured. \fIerrno\fP will be preserved. If the error is \fBEINTR\fP then this will only be returned if \fBTERMKEY_FLAG_EINTR\fP flag is not set; if it is then the IO operation will be retried instead.
+An IO error occured. \fIerrno\fP will be preserved. If the error is \fBEINTR\fP then this will only be returned if \fBTERMKEY_FLAG_EINTR\fP flag is not set; if it is then the IO operation will be retried instead. If this is called with terminal IO stopped, due to \fBtermkey_stop\fP(3) then \fIerrno\fP will be set to \fBEINVAL\fP.
.SH EXAMPLE
The following example program prints details of every keypress until the user presses "Ctrl-C".
.PP