Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
TICKIT_TERM_PAUSE(3)	   Library Functions Manual	  TICKIT_TERM_PAUSE(3)

NAME
       tickit_term_pause, tickit_term_resume - pause and resume	a terminal in-
       stance

SYNOPSIS
       #include	<tickit.h>

       void tickit_term_pause(TickitTerm *tt);
       void tickit_term_resume(TickitTerm *tt);

       void tickit_term_teardown(TickitTerm *tt);

       Link with -ltickit.

DESCRIPTION
       tickit_term_pause() suspends the	operation of the terminal by resetting
       any  modes  or  other  persistent  state	on it as if shutting down. Any
       modes set within	the object instance are	remembered however.

       tickit_term_resume() returns the	terminal back to the state it was  op-
       erating	in before tickit_term_pause() was called, allowing the program
       to continue as normal.

       It is intended these functions be used to create	a program-wide suspend
       feature,	where the terminal can be handed back  over  to	 the  invoking
       shell  while  the process backgrounds itself. Typically this is done by
       the process sending itself a SIGSTOP signal via raise(3). After calling
       tickit_term_pause(), no	other  terminal-related	 functions  should  be
       called,	nor  other  IO	operations attempted, until after a subsequent
       tickit_term_resume(3).

       tickit_term_teardown() is similar to tickit_term_stop() except that  it
       is intended to be used for final	shutdown before	the application	itself
       terminates.  This ensures that the terminal is restored to its original
       state, ahead of the application outputting any final exit  message  for
       the  user to read. After	this function has returned, no other functions
       on the terminal instance	may be called.

SEE ALSO
       tickit_term_build(3),	tickit_term_setctl_int(3),     tickit_term(7),
       tickit(7)

							  TICKIT_TERM_PAUSE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=tickit_term_pause&sektion=3&manpath=FreeBSD+Ports+15.0>

home | help