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

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, 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 HALFDELAY 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 halfdelay \- enable/disable half-delay mode
   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 \fBhalfdelay\fR(\fBint\fR \fItenths\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBhalfdelay()\fR function is similar to \fBcbreak\fR(3XCURSES) in that
  26 when set, characters typed by the user are immediately processed by the
  27 program.  The difference is that \fBERR\fR is returned if no input is received
  28 after \fItenths\fR tenths seconds.
  29 .sp
  30 .LP
  31 The \fBnocbreak\fR(3XCURSES) function should be used to leave half-delay mode.
  32 .SH PARAMETERS
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fItenths\fR\fR
  37 .ad
  38 .RS 10n
  39 Is the number of tenths of seconds for which to block input (1 to 255).
  40 .RE
  41
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 On success, the \fBhalfdelay()\fR function returns \fBOK\fR. Otherwise, it
  46 returns \fBERR\fR.
  47 .SH ERRORS
  48 .sp
  49 .LP
  50 None.
  51 .SH ATTRIBUTES
  52 .sp
  53 .LP
  54 See \fBattributes\fR(5) for descriptions of the following attributes:
  55 .sp
  56
  57 .sp
  58 .TS
  59 box;
  60 c | c
  61 l | l .
  62 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  63 _
  64 Interface Stability     Standard
  65 _
  66 MT-Level        Unsafe
  67 .TE
  68
  69 .SH SEE ALSO
  70 .sp
  71 .LP
  72 \fBcbreak\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
  73 \fBstandards\fR(5)