aboutsummaryrefslogtreecommitdiff
path: root/termkey_getkey.3.sh
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2011-08-27 19:59:02 +0100
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2011-08-27 19:59:02 +0100
commit46eefda07367e63b7ceffeecb2778409f1d4b387 (patch)
tree811bf778119fa1fc67c803ea8cc22a2e6252dd21 /termkey_getkey.3.sh
parent83ca948d7818b88fa604a39a73465ba6932d4ce5 (diff)
downloadtermo-46eefda07367e63b7ceffeecb2778409f1d4b387.tar.gz
termo-46eefda07367e63b7ceffeecb2778409f1d4b387.tar.xz
termo-46eefda07367e63b7ceffeecb2778409f1d4b387.zip
Provide an explicit termkey_canonicalise() function; canonicalise Space/SP in both directions
Diffstat (limited to 'termkey_getkey.3.sh')
-rw-r--r--termkey_getkey.3.sh2
1 files changed, 2 insertions, 0 deletions
diff --git a/termkey_getkey.3.sh b/termkey_getkey.3.sh
index 55bfca1..022f209 100644
--- a/termkey_getkey.3.sh
+++ b/termkey_getkey.3.sh
@@ -32,6 +32,8 @@ no bytes are waiting in the buffer.
.PP
Neither of these functions will block or perform any IO operations on the underlying filehandle. To use the instance in an asynchronous program, see \fBtermkey_advisereadable\fP(3). For a blocking call suitable for use in a synchronous program, use \fBtermkey_waitkey\fP(3) instead of \fBtermkey_getkey\fP().
.PP
+Before returning, this function canonicalises the \fIkey\fP structure according to the rules given for \fBtermkey_canonicalise\fP(3).
+.PP
The \fITermKeyKey\fP structure is defined as follows:
.PP
.in +4n