From 46eefda07367e63b7ceffeecb2778409f1d4b387 Mon Sep 17 00:00:00 2001
From: Paul LeoNerd Evans <leonerd@leonerd.org.uk>
Date: Sat, 27 Aug 2011 19:59:02 +0100
Subject: Provide an explicit termkey_canonicalise() function; canonicalise
 Space/SP in both directions

---
 termkey_getkey.3.sh | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'termkey_getkey.3.sh')

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
-- 
cgit v1.2.3-54-g00ecf