usr/src/man/man3xcurses/putp.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 PUTP 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 putp, tputs \- apply padding information and output string
   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 \fBputp\fR(\fBconst char *\fR\fIstr\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBtputs\fR(\fBconst char *\fR\fIstr\fR, \fBint\fR \fIaffcnt\fR, \fBint (*\fR\fIputfunc\fR) (int));
  25 .fi
  26
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIstr\fR\fR
  32 .ad
  33 .RS 11n
  34 Is a pointer to a \fBterminfo\fR variable or return value from
  35 \fBtgetstr\fR(3XCURSES), \fBtgoto\fR(3XCURSES), \fBtigetstr\fR(3XCURSES), or
  36 \fBtparm\fR(3XCURSES).
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIaffcnt\fR\fR
  43 .ad
  44 .RS 11n
  45 Is the number of lines affected, or 1 if not relevant.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIputfunc\fR\fR
  52 .ad
  53 .RS 11n
  54 Is the output function.
  55 .RE
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBputp()\fR and \fBtputs()\fR functions are low-level functions used  to
  61 deal directly with the \fBterminfo\fR database.  The use of appropriate X/Open
  62 Curses functions is recommended for most situations.
  63 .sp
  64 .LP
  65 The \fBtputs()\fR function adds padding information and then outputs \fIstr\fR.
  66 \fIstr\fR must be a \fBterminfo\fR string variable or the result value from
  67 \fBtgetstr()\fR, \fBtgoto()\fR, \fBtigetstr()\fR, or \fBtparm()\fR.  The
  68 \fBtputs()\fR function replaces the padding specification (if one exists) with
  69 enough characters to produce the specified delay.  Characters are output one at
  70 a time to \fIputfunc\fR, a user-specified function similar to
  71 \fBputchar\fR(3C).
  72 .sp
  73 .LP
  74 The \fBputp()\fR function calls \fBtputs()\fR as follows:
  75 .sp
  76 .LP
  77 \fBtputs(\fR\fIstr\fR, 1, putchar)
  78 .SH RETURN VALUES
  79 .sp
  80 .LP
  81 On success, these functions return \fBOK\fR.
  82 .SH ERRORS
  83 .sp
  84 .LP
  85 None.
  86 .SH USAGE
  87 .sp
  88 .LP
  89 The output of \fBputp()\fR goes to \fBstdout\fR, not to the file descriptor,
  90 \fIfildes\fR, specified in \fBsetupterm\fR(3XCURSES).
  91 .SH ATTRIBUTES
  92 .sp
  93 .LP
  94 See \fBattributes\fR(5) for descriptions of the following attributes:
  95 .sp
  96
  97 .sp
  98 .TS
  99 box;
 100 c | c
 101 l | l .
 102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 103 _
 104 Interface Stability     Standard
 105 _
 106 MT-Level        Unsafe
 107 .TE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBlibcurses\fR(3XCURSES), \fBputchar\fR(3C), \fBsetupterm\fR(3XCURSES),
 113 \fBtgetent\fR(3XCURSES), \fBtigetflag\fR(3XCURSES), \fBterminfo\fR(4),
 114 \fBattributes\fR(5), \fBstandards\fR(5)