Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

newterm(3) [netbsd man page]

CURSES_SCREEN(3)					   BSD Library Functions Manual 					  CURSES_SCREEN(3)

curses_screen, newterm, set_term, delscreen, endwin, initscr, isendwin, resizeterm, setterm -- curses terminal and screen routines LIBRARY
Curses Library (libcurses, -lcurses) SYNOPSIS
#include <curses.h> SCREEN * newterm(char *type, FILE *outfd, FILE *infd); SCREEN * set_term(SCREEN *screen); void delscreen(SCREEN *screen); int endwin(void); WINDOW * initscr(void); bool isendwin(void); int resizeterm(int lines, int cols); int setterm(char *name); extern int LINES; extern int COLS; DESCRIPTION
These functions initialize terminals and screens. The newterm() function initialises the curses data structures and pointers ready for use by curses. The type argument points to a termcap(5) capability name, or it may be NULL in which case the TERM environment variable is used. The outfd and infd are the output and input file descriptors for the terminal. The newterm() function must only be called once per terminal. The set_term() function can be used to switch between the screens defined by calling newterm(), a pointer to the previous screen structure that was in use will be returned on success. Calling delscreen() will destroy the given screen and free all allocated resources. Calling endwin() will end the curses session and restore the saved terminal settings. The curses session must be initialised by calling initscr() which saves the current terminal state and sets up the terminal and internal data structures to support the curses application. This function call must be, with few exceptions, the first Curses library call made. The exception to this rule is the newterm() call which may be called prior to initscr(). The size of the curses screen is determined by checking the tty(4) size and then the termcap(5) entries for the terminal type. If the environment variables LINES or COLS are set, then these will be used instead. When either newterm() or initscr() are called, the Curses library sets up signal handlers for SIGTSTP and SIGWINCH. If a signal handler is already installed for SIGWINCH, this will also be called when the Curses library handler is called. The isendwin() function can be used to determine whether or not a refresh of the screen has occurred since the last call to endwin(). The size of the screen may be changed by calling resizeterm() with the updated number of lines and columns. This will resize the curses internal data structures to accommodate the changed terminal geometry. The curscr and stdscr windows and any of their subwindows will be resized to fit the new screen size. The application must redraw the screen after a call to resizeterm(). The setterm() function sets the terminal type for the current screen to the one passed, initialising all the curses internal data structures with information related to the named terminal. The name argument must be a valid name or alias in the termcap(5) database for this function to succeed. RETURN VALUES
Functions returning pointers will return NULL if an error is detected. The functions that return an int will return one of the following values: OK The function completed successfully. ERR An error occurred in the function. SEE ALSO
curses_window(3), tty(4), termcap(5), signal(7) STANDARDS
The NetBSD Curses library complies with the X/Open Curses specification, part of the Single Unix Specification. HISTORY
The Curses package appeared in 4.0BSD. The resizeterm() function is a ncurses extension to the Curses library and was added in NetBSD 1.6. BSD
October 24, 2007 BSD

Check Out this Related Man Page

curs_initscr(3X)														  curs_initscr(3X)

initscr, newterm, endwin, isendwin, set_term, delscreen - curses screen initialization and manipulation routines SYNOPSIS
#include <curses.h> WINDOW *initscr(void); int endwin(void); bool isendwin(void); SCREEN *newterm(char *type, FILE *outfd, FILE *infd); SCREEN *set_term(SCREEN *new); void delscreen(SCREEN* sp); DESCRIPTION
initscr is normally the first curses routine to call when initializing a program. A few special routines sometimes need to be called before it; these are slk_init, filter, ripoffline, use_env. For multiple-terminal applications, newterm may be called before initscr. The initscr code determines the terminal type and initializes all curses data structures. initscr also causes the first call to refresh to clear the screen. If errors occur, initscr writes an appropriate error message to standard error and exits; otherwise, a pointer is returned to stdscr. A program that outputs to more than one terminal should use the newterm routine for each terminal instead of initscr. A program that needs to inspect capabilities, so it can continue to run in a line-oriented mode if the terminal cannot support a screen-oriented program, would also use newterm. The routine newterm should be called once for each terminal. It returns a variable of type SCREEN * which should be saved as a reference to that terminal. The arguments are the type of the terminal to be used in place of $TERM, a file pointer for output to the terminal, and another file pointer for input from the terminal (if type is NULL, $TERM will be used). The program must also call endwin for each terminal being used before exiting from curses. If newterm is called more than once for the same terminal, the first ter- minal referred to must be the last one for which endwin is called. A program should always call endwin before exiting or escaping from curses mode temporarily. This routine restores tty modes, moves the cursor to the lower left-hand corner of the screen and resets the terminal into the proper non-visual mode. Calling refresh or doupdate after a temporary escape causes the program to resume visual mode. The isendwin routine returns TRUE if endwin has been called without any subsequent calls to wrefresh, and FALSE otherwise. The set_term routine is used to switch between different terminals. The screen reference new becomes the new current terminal. The previ- ous terminal is returned by the routine. This is the only routine which manipulates SCREEN pointers; all other routines affect only the current terminal. The delscreen routine frees storage associated with the SCREEN data structure. The endwin routine does not do this, so delscreen should be called after endwin if a particular SCREEN is no longer needed. RETURN VALUE
endwin returns the integer ERR upon failure and OK upon successful completion. Routines that return pointers always return NULL on error. NOTES
Note that initscr and newterm may be macros. PORTABILITY
These functions are described in the XSI Curses standard, Issue 4. It specifies that portable applications must not call initscr more than once. Old versions of curses, e.g., BSD 4.4, may have returned a null pointer from initscr when an error is detected, rather than exiting. It is safe but redundant to check the return value of initscr in XSI Curses. SEE ALSO
curses(3X), curs_kernel(3X), curs_refresh(3X), curs_slk(3X), curs_util(3X) curs_initscr(3X)
Man Page