8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3xcurses / delay_output.3xcurses
blobc709f816782b910c481ed7540955460d1fede7cc
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 DELAY_OUTPUT 3XCURSES "Jun 5, 2002"
7 .SH NAME
8 delay_output \- delays output
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... ]
15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
17 #include <curses.h>
19 \fBint\fR \fBdelay_output\fR(\fBint\fR \fIms\fR);
20 .fi
22 .SH DESCRIPTION
23 .sp
24 .LP
25 The \fBdelay_output()\fR function delays output for \fIms\fR milliseconds by
26 inserting pad characters in the output stream.
27 .SH PARAMETERS
28 .sp
29 .ne 2
30 .na
31 \fB\fIms\fR\fR
32 .ad
33 .RS 6n
34 Is the number of milliseconds to delay the output.
35 .RE
37 .SH RETURN VALUES
38 .sp
39 .LP
40 On success, the \fBdelay_output()\fR function returns \fBOK\fR. Otherwise, it
41 returns \fBERR\fR.
42 .SH ERRORS
43 .sp
44 .LP
45 None.
46 .SH ATTRIBUTES
47 .sp
48 .LP
49 See \fBattributes\fR(5) for descriptions of the following attributes:
50 .sp
52 .sp
53 .TS
54 box;
55 c | c
56 l | l .
57 ATTRIBUTE TYPE  ATTRIBUTE VALUE
59 Interface Stability     Standard
61 MT-Level        Unsafe
62 .TE
64 .SH SEE ALSO
65 .sp
66 .LP
67 \fBlibcurses\fR(3XCURSES), \fBnapms\fR(3XCURSES), \fBattributes\fR(5),
68 \fBstandards\fR(5)