lib/libcurses/PSD.doc/doc.IV

   1 .\"     $NetBSD: doc.IV,v 1.5 2003/08/07 16:44:27 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)doc.IV      8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Ds
  33 .Fd gettmode
  34 .De
  35 Get the tty stats.
  36 This is normally called by
  37 .Fn initscr .
  38 .Ds
  39 .Fd mvcur lasty\*,lastx\*,newy\*,newx
  40 int     lasty\*,lastx\*,newy\*,newx;
  41 .De
  42 Moves the terminal's cursor from
  43 .Vn lasty\*,lastx ) (
  44 to
  45 .Vn newy\*,newx ) (
  46 in an approximation of optimal fashion.
  47 This routine uses the functions borrowed from
  48 .i ex
  49 version 2.6.
  50 It is possible to use this optimization
  51 without the benefit of the screen routines.
  52 With the screen routines, this should not be called by the user.
  53 .Fn move
  54 and
  55 .Fn refresh
  56 should be used to move the cursor position,
  57 so that the routines know what's going on.
  58 .Ds
  59 .Fd scroll win
  60 WINDOW  *win;
  61 .De
  62 Scroll the window upward one line.
  63 This is normally not used by the user.
  64 .Ds
  65 .Fd savetty "" \*m
  66 .Fd resetty "" \*m
  67 .De
  68 .Fn savetty
  69 saves the current tty characteristic flags.
  70 .Fn resetty
  71 restores them to what
  72 .Fn savetty
  73 stored.
  74 These functions are performed automatically by
  75 .Fn initscr
  76 and
  77 .Fn endwin .
  78 .Ds
  79 .Fd setterm name
  80 char    *name;
  81 .De
  82 Set the terminal characteristics to be those of the terminal named
  83 .Vn name ,
  84 getting the terminal size from the
  85 .b TIOCGWINSZ
  86 .Fn ioctl "" "" 2
  87 if it exists,
  88 otherwise from the environment.
  89 This is normally called by
  90 .Fn initscr .
  91 .Ds
  92 .Fd tstp
  93 .De
  94 If the new
  95 .b tty (4)
  96 driver is in use,
  97 this function
  98 will save the current tty state
  99 and then put the process to sleep.
 100 When the process gets restarted,
 101 it restores the tty state
 102 and then calls
 103 .Fn wrefresh "" "" curscr
 104 to redraw the screen.
 105 .Fn initscr
 106 sets the signal
 107 SIGTSTP
 108 to trap to this routine.