TERMKEY\_CANONICALISE(3) Library Functions Manual TERMKEY\_CANONICALISE(3)

# [NAME](#NAME)

termkey\_canonicalise - canonicalise a key event

# [SYNOPSIS](#SYNOPSIS)

```
#include <termkey.h>

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

Link with *-ltermkey*.

# [DESCRIPTION](#DESCRIPTION)

[**termkey\_canonicalise**(3)](/man/os/libtermkey/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)](/man/os/libtermkey/termkey_getkey.3), [**termkey\_waitkey**(3)](/man/os/libtermkey/termkey_waitkey.3) and [**termkey\_strpkey**(3)](/man/os/libtermkey/termkey_strpkey.3), and is also provided explicitly by this function.

See [**termkey**(7)](/man/os/libtermkey/termkey.7) for a list of canonicalisation flags.

# [RETURN VALUE](#RETURN_VALUE)

**termkey\_canonicalise**() returns no value.

# [SEE ALSO](#SEE_ALSO)

[**termkey\_set\_canonflags**(3)](/man/os/libtermkey/termkey_set_canonflags.3), [**termkey\_waitkey**(3)](/man/os/libtermkey/termkey_waitkey.3), [**termkey\_strpkey**(3)](/man/os/libtermkey/termkey_strpkey.3), [**termkey**(7)](/man/os/libtermkey/termkey.7)

---

Document: termkey_canonicalise(3) from libtermkey 0.22-r8 (Chainguard OS)