termkey_start - Man Page

enable or disable terminal operations


#include <termkey.h>

int termkey_start(TermKey *tk);
int termkey_stop(TermKey *tk);

int termkey_is_started(TermKey *tk);

Link with -ltermkey.


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)

Referenced By

termkey(7), termkey_new(3).