aboutsummaryrefslogtreecommitdiff
path: root/termkey_get_keyname.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-18 12:01:38 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-18 12:01:38 +0000
commit082b49f0f8790e2cf98346a03c53f492d9d5dcba (patch)
tree91d657db23e92b6b658dd4e73cecf1fb18c79188 /termkey_get_keyname.3
parentd64ba87edae62894ca74cfb9d6d8cdd88c213397 (diff)
downloadtermo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.tar.gz
termo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.tar.xz
termo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.zip
Move the growing collection of manpages into their own man/ subdirectory
Diffstat (limited to 'termkey_get_keyname.3')
-rw-r--r--termkey_get_keyname.322
1 files changed, 0 insertions, 22 deletions
diff --git a/termkey_get_keyname.3 b/termkey_get_keyname.3
deleted file mode 100644
index 5f0119f..0000000
--- a/termkey_get_keyname.3
+++ /dev/null
@@ -1,22 +0,0 @@
-.TH TERMKEY_GET_KEYNAME 3
-.SH NAME
-termkey_get_keyname \- return a string name for a symbolic key
-.SH SYNOPSIS
-.nf
-.B #include <termkey.h>
-.sp
-.BI "const char *termkey_get_keyname(TermKey *" tk ", TermKeySym " sym );
-.fi
-.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_destroy\fP(3). This function is the inverse of \fBtermkey_keyname2sym\fP(3).
-.SH "RETURN VALUE"
-\fBtermkey_get_key\fP() returns a pointer to a string.
-.SH "SEE ALSO"
-.BR termkey_new (3),
-.BR termkey_getkey (3),
-.BR termkey_waitkey (3),
-.BR termkey_lookup_keyname (3),
-.BR termkey_keyname2sym (3),
-.BR termkey_strfkey (3)