TERMKEY_CANONICALISE(3)

💖 TERMKEY_CANONICALISE — canonicalise a key event 💖

okay bestie, welcome to the manual page for termkey_canonicalise, which lives in the Library Functions Manual and is literally just here to make your key events ✨presentable✨. no cap.

🌸 SYNOPSIS 🌸

#include <termkey.h>

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

Link with -ltermkey.

🦋 DESCRIPTION 🦋

so what does termkey_canonicalise(3) actually do? it takes the key event structure you hand it in key and canonicalises it — like, it modifies it according to the canonicalisation flags that are set on the given termkey instance tk. that's the whole vibe. 💅

and here's the thing, bestie: this operation is already happening implicitly inside termkey_getkey(3), termkey_waitkey(3) and termkey_strpkey(3). they do it for you automatically, no asking. but if you wanna run it yourself, by hand, on your own terms? this function is right there. iconic behaviour honestly. 🫶

want the actual list of canonicalisation flags? go read termkey(7), it's all laid out there. i'm not gonna spoil it for you. 😌

✨ RETURN VALUE ✨

termkey_canonicalise() returns no value.

that's it. that's the whole return value section. it gives you nothing back. void. empty. a beautiful little nothing. it just does the thing and dips. 💀

👑 SEE ALSO 👑

• termkey_set_canonflags(3)
• termkey_waitkey(3)
• termkey_strpkey(3)
• termkey(7)

and that's the page, babe 🎀 this was TERMKEY_CANONICALISE(3) from the Library Functions Manual, dated whenever the fine folks who write manpages decided, and honestly? slay. go canonicalise something. you got this. 💜🌈⭐