usr/src/man/man3xcurses/longname.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 LONGNAME 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 longname \- return full terminal type name
   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 \fBconst char *\fR\fBlongname\fR(\fBvoid\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBlongname()\fR function returns a pointer to a static area containing a
  26 verbose description (128 characters or fewer) of the terminal.  The area is
  27 defined after calls to \fBinitscr\fR(3XCURSES), \fBnewterm\fR(3XCURSES), or
  28 \fBsetupterm\fR(3XCURSES). The value should be saved if \fBlongname()\fR is
  29 going to be used with  multiple terminals since it will be overwritten with a
  30 new value after each  call to \fBnewterm()\fR or \fB setupterm()\fR.
  31 .SH RETURN VALUES
  32 .sp
  33 .LP
  34 On success, the \fBlongname()\fR function returns a pointer to a verbose
  35 description of the terminal. Otherwise, it returns a null pointer.
  36 .SH ERRORS
  37 .sp
  38 .LP
  39 None.
  40 .SH ATTRIBUTES
  41 .sp
  42 .LP
  43 See \fBattributes\fR(5) for descriptions of the following attributes:
  44 .sp
  45
  46 .sp
  47 .TS
  48 box;
  49 c | c
  50 l | l .
  51 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  52 _
  53 Interface Stability     Standard
  54 _
  55 MT-Level        Unsafe
  56 .TE
  57
  58 .SH SEE ALSO
  59 .sp
  60 .LP
  61 \fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewterm\fR(3XCURSES),
  62 \fBsetupterm\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)