aboutsummaryrefslogtreecommitdiff
path: root/termkey_get_keyname.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2008-11-06 19:50:53 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2008-11-06 19:50:53 +0000
commit023943c7389cd1ece50bb92bb8bd1af42b62c580 (patch)
treec76129191d80bb98c0c53e465bee0291c6d20824 /termkey_get_keyname.3
parent9aaf16888c9bd1ab63f0336f6becca87525118c6 (diff)
downloadtermo-023943c7389cd1ece50bb92bb8bd1af42b62c580.tar.gz
termo-023943c7389cd1ece50bb92bb8bd1af42b62c580.tar.xz
termo-023943c7389cd1ece50bb92bb8bd1af42b62c580.zip
Don't document the termkey_free() function as it doesn't restore termios; document termkey_destroy() instead
Diffstat (limited to 'termkey_get_keyname.3')
-rw-r--r--termkey_get_keyname.32
1 files changed, 1 insertions, 1 deletions
diff --git a/termkey_get_keyname.3 b/termkey_get_keyname.3
index cc46460..c1f0d79 100644
--- a/termkey_get_keyname.3
+++ b/termkey_get_keyname.3
@@ -10,7 +10,7 @@ termkey_get_keyname \- return a string name for a symbolic key
.sp
Link with \fI-ltermkey\fP.
.SH DESCRIPTION
-\fBtermkey_get_keyname\fP returns a human-readable string name for the symbolic key value given by \fBsym\fP. The returned string is owned by the termkey instance \fItk\fP so should not be modified or freed. The returned pointer is guaranteed to be valid until the termkey instance is released using \fBtermkey_free\fP(3).
+\fBtermkey_get_keyname\fP returns a human-readable string name for the symbolic key value given by \fBsym\fP. The returned string is owned by the termkey instance \fItk\fP so should not be modified or freed. The returned pointer is guaranteed to be valid until the termkey instance is released using \fBtermkey_destroy\fP(3).
.SH "RETURN VALUE"
\fBtermkey_get_key\fP() returns a pointer to a string.
.SH "SEE ALSO"