del_curterm man page on OpenIndiana

Man page or keyword search:  
man Server   20441 pages
apropos Keyword Search (all sections)
Output format
OpenIndiana logo
[printable version]

del_curterm(3XCURSES)	X/Open Curses Library Functions	 del_curterm(3XCURSES)

NAME
       del_curterm,  restartterm,  set_curterm,	 setupterm - interfaces to the
       terminfo database

SYNOPSIS
       cc [ flag... ] file... -I /usr/xpg4/include  -L	/usr/xpg4/lib \
	-R  /usr/xpg4/lib  -lcurses  [ library... ]

       c89 [ flag... ] file... -lcurses [ library... ]

       #include <term.h>

       int del_curterm(TERMINAL *oterm);

       int restartterm(char *term, int fildes, int *errret);

       TERMINAL *set_curterm(TERMINAL *nterm);

       int setupterm(char *term, int fildes, int *errret);

DESCRIPTION
       Within X/Open Curses, the setupterm() function is automatically	called
       by the  initscr (3XC) and newterm (3XC) functions. This function can be
       also be used outside of X/Open Curses  when  a  program	has  to	  deal
       directly	 with  the terminfo database to handle certain terminal	 capa‐
       bilities.  The use of appropriate X/Open	 Curses	 functions  is	recom‐
       mended in all other  situations.

       The  setupterm()	 function  loads  terminal-dependent variables for the
       terminfo layer of X/Open Curses. The setupterm()	 function  initializes
       the  terminfo  variables	 lines and columns such that if use_env(FALSE)
       has been called, the terminfo values assigned in the database are  used
       regardless of the environmental variables LINES and COLUMNS or the pro‐
       gram's window dimensions; when use_env(TRUE) has been called, which  is
       the  default,  the environment variables LINES and COLUMNS are used, if
       they exist.  If the environment variables do not exist and the  program
       is running in a	window, the current window size is used.

       The term parameter of setupterm() specifies the terminal; if null, ter‐
       minal type is taken from the TERM environment variable. All  output  is
       sent  to fildes which is initialized for output. If errret is not null,
       OK or ERR is returned and a status  value  is  stored  in  the  integer
       pointed to by errret.  The following status values may be returned:

       ┌───────────────────────────────────────────────────────────────────┐
       │Value			      Description			   │
       │1			      Normal				   │
       │0			      Terminal could not be found	   │
       │-1			      terminfo database could not be found │
       └───────────────────────────────────────────────────────────────────┘

       If  errret  is  null,  an error message is printed, and the setupterm()
       function calls the exit() function with a non-zero parameter.

       The set_curterm() function sets the cur_term variable  to   nterm.  The
       values  from  nterm as well as other state information for the terminal
       are  used  by  X/Open  Curses   functions   such	  as   beep(3XCURSES),
       flash(3XCURSES),	    mvcur(3XCURSES),	tigetflag(3XCURSES),	tiget‐
       str(3XCURSES), and tigetnum(3XCURSES).

       The del_curterm() function frees the space pointed  to  by  oterm.   If
       oterm  and the cur_term variable are the same, all Boolean, numeric, or
       string terminfo variables will refer to invalid memory locations	 until
       you call setupterm() and specify a new terminal	type.

       The  restartterm()  function  assumes  that  a  call to setupterm() has
       already been made (probably from initscr() or newterm()). It allows you
       to specify a new terminal type in term and updates the data returned by
       baudrate(3XCURSES) based on fildes. Other information  created  by  the
       initscr(), newterm(), and  setupterm() functions is preserved.

PARAMETERS
       oterm	 Is the terminal type for which to free space.

       term	 Is the terminal type for which variables are set.

       fildes	 Is a file descriptor initialized for output.

       errret	 Is  a	pointer	 to  an	 integer  in which the status value is
		 stored.

       nterm	 Is the new terminal to become the current terminal.

RETURN VALUES
       On success, the set_curterm() function returns the  previous  value  of
       cur_term. Otherwise, it returns a null pointer.

       On success, the other functions return OK. Otherwise, they return ERR.

ERRORS
       None.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       ┌─────────────────────────────┬─────────────────────────────┐
       │      ATTRIBUTE TYPE	     │	    ATTRIBUTE VALUE	   │
       ├─────────────────────────────┼─────────────────────────────┤
       │Interface Stability	     │Committed			   │
       ├─────────────────────────────┼─────────────────────────────┤
       │MT-Level		     │Unsafe			   │
       ├─────────────────────────────┼─────────────────────────────┤
       │Standard		     │See standards(5).		   │
       └─────────────────────────────┴─────────────────────────────┘

SEE ALSO
       baudrate(3XCURSES),	    beep(3XCURSES),	    initscr(3XCURSES),
       libcurses(3XCURSES),	  mvcur(3XCURSES),	  tigetflag(3XCURSES),
       use_env(3XCURSES), attributes(5), standards(5)

SunOS 5.11			  5 Jun 2002		 del_curterm(3XCURSES)
[top]

List of man pages available for OpenIndiana

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net