usr/src/man/man3xcurses/echo.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ECHO 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 echo, noecho \- enable/disable terminal echo
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBecho\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBnoecho\fR(\fBvoid\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBecho()\fR function enables Echo mode for the current screen. The
  31 \fBnoecho()\fR function disables Echo mode for the current screen. Initially,
  32 curses software echo mode is enabled and hardware echo mode of the \fBtty\fR
  33 driver is disabled. The \fBecho()\fR and \fBnoecho()\fR functions control
  34 software echo only. Hardware echo must remain disabled for the duration of the
  35 application, else the behavior is undefined.
  36 .SH RETURN VALUES
  37 .sp
  38 .LP
  39 Upon successful completion, these functions return \fBOK\fR. Otherwise, they
  40 return \fBERR\fR.
  41 .SH ERRORS
  42 .sp
  43 .LP
  44 No errors are defined.
  45 .SH ATTRIBUTES
  46 .sp
  47 .LP
  48 See \fBattributes\fR(5) for descriptions of the following attributes:
  49 .sp
  50
  51 .sp
  52 .TS
  53 box;
  54 c | c
  55 l | l .
  56 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  57 _
  58 Interface Stability     Standard
  59 _
  60 MT-Level        Unsafe
  61 .TE
  62
  63 .SH SEE ALSO
  64 .sp
  65 .LP
  66 \fBgetch\fR(3XCURSES), \fBgetstr\fR(3XCURSES), \fBinitscr\fR(3XCURSES),
  67 \fBlibcurses\fR(3XCURSES), \fBscanw\fR(3XCURSES), \fBattributes\fR(5),
  68 \fBstandards\fR(5)