lib/libcurses/PSD.doc/doc.II

   1 .\"     $NetBSD: doc.II,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.II      8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Ds
  33 .Fd cbreak "" \*m
  34 .Fd nocbreak "" \*m
  35 .Fd crmode "" \*m
  36 .Fd nocrmode "" \*m
  37 .De
  38 Set or unset the terminal to/from cbreak mode.
  39 The misnamed macros
  40 .Fn crmode
  41 and
  42 .Fn nocrmode
  43 are retained for backwards compatibility
  44 with ealier versions of the library.
  45 .Ds
  46 .Fd echo "" \*m
  47 .Fd noecho "" \*m
  48 .De
  49 Sets the terminal to echo or not echo characters.
  50 .Ds
  51 .Fd getch "" \*m
  52 .Fd wgetch win
  53 WINDOW  *win;
  54 .De
  55 Gets a character from the terminal and (if necessary)
  56 echos it on the window.
  57 \*(Es
  58 Otherwise, the character gotten is returned.
  59 If
  60 .i noecho
  61 has been set, then the window is left unaltered.
  62 In order to retain control of the terminal,
  63 it is necessary to have one of
  64 .i noecho ,
  65 .i cbreak ,
  66 or
  67 .i rawmode
  68 set.
  69 If you do not set one,
  70 whatever routine you call to read characters will set
  71 .i cbreak
  72 for you,
  73 and then reset to the original mode when finished.
  74 .Ds
  75 .Fd getstr str \*m
  76 char    *str;
  77 .Fd wgetstr win\*,str
  78 WINDOW  *win;
  79 char    *str;
  80 .De
  81 Get a string through the window
  82 and put it in the location pointed to by
  83 .Vn str ,
  84 which is assumed to be large enough to handle it.
  85 It sets tty modes if necessary,
  86 and then calls
  87 .Fn getch
  88 (or
  89 .Fn wgetch ) "" win
  90 to get the characters needed to fill in the string
  91 until a newline or EOF is encountered.
  92 The newline stripped off the string.
  93 \*(Es
  94 .Ds
  95 .Fd \*_putchar c
  96 char    c;
  97 .De
  98 Put out a character using the
  99 .Fn putchar
 100 macro.
 101 This function is used to output every character
 102 that
 103 .b curses
 104 generates.
 105 Thus,
 106 it can be redefined by the user who wants to do non-standard things
 107 with the output.
 108 It is named with an initial \*(lq\*_\*(rq
 109 because it usually should be invisible to the programmer.
 110 .Ds
 111 .Fd raw "" \*m
 112 .Fd noraw "" \*m
 113 .De
 114 Set or unset the terminal to/from raw mode.
 115 On version 7
 116 .Un \**
 117 .(f
 118 \**
 119 .Un
 120 is a trademark of Bell Laboratories.
 121 .)f
 122 this also turns of newline mapping
 123 (see
 124 .Fn nl ).
 125 .Ds
 126 .Fd scanw fmt\*,arg1\*,arg2\*,...
 127 char    *fmt;
 128 .Fd wscanw win\*,fmt\*,arg1\*,arg2\*,...
 129 WINDOW  *win;
 130 char    *fmt;
 131 .De
 132 Perform a
 133 .Fn scanf
 134 through the window using
 135 .Vn fmt .
 136 It does this using consecutive
 137 .Fn getch 's
 138 (or
 139 .Fn wgetch 's). "" win
 140 \*(Es