termkey_canonicalise(3)

termkey_canonicalise3

Canonicalise a key event

Usage

#include <termkey.h>

void termkey_canonicalise(TermKey *tk, TermKeyKey *key);

Link with -ltermkey.

Overview

termkey_canonicalise(3) modifies the key event structure given by key according to the canonicalisation flags set on the given termkey instance. This operation is performed implicitly by termkey_getkey(3), termkey_waitkey(3) and termkey_strpkey(3), and is also provided explicitly by this function.

See termkey(7) for a list of canonicalisation flags.

Return value

termkey_canonicalise() returns no value.

From libtermkey-dev 0.22-2+b1 in Debian 13 (Trixie). Parsed by carta from the page's man source.