Man page - termkey_start(3)
Packages contas this manual
- termkey_get_fd(3)
- termkey_canonicalise(3)
- termkey_new(3)
- termkey_set_buffer_size(3)
- termkey_interpret_mouse(3)
- termkey_waitkey(3)
- termkey_start(3)
- termkey_strpkey(3)
- termkey_strfkey(3)
- termkey_lookup_keyname(3)
- termkey_interpret_modereport(3)
- termkey(7)
- termkey_advisereadable(3)
- termkey_set_flags(3)
- termkey_get_buffer_remaining(3)
- termkey_keyname2sym(3)
- termkey_getkey(3)
- termkey_interpret_string(3)
- termkey_set_canonflags(3)
- termkey_set_waittime(3)
- termkey_interpret_position(3)
- termkey_get_keyname(3)
- termkey_interpret_csi(3)
- termkey_keycmp(3)
- termkey_push_bytes(3)
apt-get install libtermkey-dev
Manual
| TERMKEY_START(3) | Library Functions Manual | TERMKEY_START(3) |
NAME
termkey_start, termkey_stop, termkey_is_started - enable or disable terminal operations
SYNOPSIS
#include <termkey.h> int termkey_start(TermKey *tk); int termkey_stop(TermKey *tk); int termkey_is_started(TermKey *tk);
Link with -ltermkey.
DESCRIPTION
termkey_start() enables the terminal IO operations of the given termkey(7) instance, including sending a terminal control sequence and setting the termios(3) modes required.
termkey_stop() disables terminal IO operations, by reversing the steps taken by termkey_start(). A newly-constructed termkey instance will have terminal IO enabled already.
termkey_is_started() enquires whether terminal IO is currently enabled.
RETURN VALUE
If successful, termkey_start() and termkey_stop() return a true value. On failure, zero is returned with errno set to indicate the failure. termkey_is_started() returns true or false to indicate whether terminal IO is currently enabled.
SEE ALSO
termkey_new(3), termkey(7)