lib/libcurses/curses_screen.3

   1 .\"     $NetBSD: curses_screen.3,v 1.13 2007/07/13 11:16:11 jdc Exp $
   2 .\"
   3 .\" Copyright (c) 2002
   4 .\"     Brett Lymn (blymn@NetBSD.org, brett_lymn@yahoo.com.au)
   5 .\"
   6 .\" This code is donated to the NetBSD Foundation by the Author.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. The name of the Author may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior written
  18 .\"    permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"
  33 .Dd October 24, 2007
  34 .Dt CURSES_SCREEN 3
  35 .Os
  36 .Sh NAME
  37 .Nm curses_screen ,
  38 .Nm newterm ,
  39 .Nm set_term ,
  40 .Nm delscreen ,
  41 .Nm endwin ,
  42 .Nm initscr ,
  43 .Nm isendwin ,
  44 .Nm resizeterm ,
  45 .Nm setterm
  46 .Nd curses terminal and screen routines
  47 .Sh LIBRARY
  48 .Lb libcurses
  49 .Sh SYNOPSIS
  50 .In curses.h
  51 .Ft SCREEN *
  52 .Fn newterm "char *type" "FILE *outfd" "FILE *infd"
  53 .Ft SCREEN *
  54 .Fn set_term "SCREEN *screen"
  55 .Ft void
  56 .Fn delscreen "SCREEN *screen"
  57 .Ft int
  58 .Fn endwin "void"
  59 .Ft WINDOW *
  60 .Fn initscr "void"
  61 .Ft bool
  62 .Fn isendwin "void"
  63 .Ft int
  64 .Fn resizeterm "int lines" "int cols"
  65 .Ft int
  66 .Fn setterm "char *name"
  67 .Pp
  68 .Va extern int LINES ;
  69 .Pp
  70 .Va extern int COLS ;
  71 .Sh DESCRIPTION
  72 These functions initialize terminals and screens.
  73 .Pp
  74 The
  75 .Fn newterm
  76 function initialises the curses data structures and pointers ready for
  77 use by curses.
  78 The
  79 .Fa type
  80 argument points to a
  81 .Xr termcap 5
  82 capability name, or it may be
  83 .Dv NULL
  84 in which case the TERM environment variable is used.
  85 The
  86 .Fa outfd
  87 and
  88 .Fa infd
  89 are the output and input file descriptors for the terminal.
  90 The
  91 .Fn newterm
  92 function must only be called once  per terminal.
  93 .Pp
  94 The
  95 .Fn set_term
  96 function can be used to switch between the screens defined by calling
  97 .Fn newterm ,
  98 a pointer to the previous screen structure that was in use will be
  99 returned on success.
 100 .Pp
 101 Calling
 102 .Fn delscreen
 103 will destroy the given screen and free all allocated resources.
 104 .Pp
 105 Calling
 106 .Fn endwin
 107 will end the curses session and restore the saved terminal settings.
 108 .Pp
 109 The curses session must be initialised by calling
 110 .Fn initscr
 111 which saves the current terminal state and sets up the terminal and
 112 internal data structures to support the curses application.
 113 This
 114 function call must be, with few exceptions, the first Curses library
 115 call made.
 116 The exception to this rule is the
 117 .Fn newterm
 118 call which may be called prior to
 119 .Fn initscr .
 120 The size of the curses screen is determined by checking the
 121 .Xr tty 4
 122 size and then the
 123 .Xr termcap 5
 124 entries for the terminal type.
 125 If the environment variables
 126 .Va LINES
 127 or
 128 .Va COLS
 129 are set, then these will be used instead.
 130 .Pp
 131 When either
 132 .Fn newterm
 133 or
 134 .Fn initscr
 135 are called, the Curses library sets up signal handlers for
 136 .Dv SIGTSTP
 137 and
 138 .Dv SIGWINCH .
 139 If a signal handler is already installed for
 140 .Dv SIGWINCH ,
 141 this will also be called when the Curses library handler is called.
 142 .Pp
 143 The
 144 .Fn isendwin
 145 function can be used to determine whether or not a refresh of the
 146 screen has occurred since the last call to
 147 .Fn endwin .
 148 .Pp
 149 The size of the screen may be changed  by calling
 150 .Fn resizeterm
 151 with the updated number of lines and columns.
 152 This will resize the curses internal data structures to accommodate the
 153 changed terminal geometry.
 154 The
 155 .Dv curscr
 156 and
 157 .Dv stdscr
 158 windows and any of their subwindows will be resized to fit the new
 159 screen size.
 160 The application must redraw the screen after a call to
 161 .Fn resizeterm .
 162 .Pp
 163 The
 164 .Fn setterm
 165 function sets the terminal type for the current screen to the one
 166 passed, initialising all the curses internal data structures with
 167 information related to the named terminal.
 168 The
 169 .Fa name
 170 argument must be a valid name or alias in the
 171 .Xr termcap 5
 172 database for this function to succeed.
 173 .Sh RETURN VALUES
 174 Functions returning pointers will return
 175 .Dv NULL
 176 if an error is detected.
 177 The functions that return an int will return one of the following
 178 values:
 179 .Pp
 180 .Bl -tag -width ERR -compact
 181 .It Er OK
 182 The function completed successfully.
 183 .It Er ERR
 184 An error occurred in the function.
 185 .El
 186 .Sh SEE ALSO
 187 .Xr curses_window 3 ,
 188 .Xr tty 4 ,
 189 .Xr termcap 5 ,
 190 .Xr signal 7
 191 .Sh STANDARDS
 192 The
 193 .Nx
 194 Curses library complies with the X/Open Curses specification, part of the
 195 Single Unix Specification.
 196 .Sh HISTORY
 197 The Curses package appeared in
 198 .Bx 4.0 .
 199 The
 200 .Fn resizeterm
 201 function is a
 202 .Em ncurses
 203 extension to the Curses library and was added in
 204 .Nx 1.6 .