DragonFly On-Line Manual Pages

TERMKEY_START(3)      DragonFly 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)

                                                              TERMKEY_START(3)