usr/src/man/man3xcurses/meta.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 META 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 meta \- enable/disable meta keys
   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 \fBmeta\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIwin\fR\fR
  27 .ad
  28 .RS 7n
  29 Is an ignored parameter.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIbf\fR\fR
  36 .ad
  37 .RS 7n
  38 Is a Boolean expression.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 Whether a terminal returns 7 or 8 significant bits initially depends on the
  45 control mode of the terminal driver.  The \fBmeta()\fR function forces the
  46 number of bits to be returned by  \fBgetch\fR(3XCURSES) to be 7 (if \fIbf\fR is
  47 \fBFALSE\fR) or 8 (if \fIbf\fR is  \fBTRUE\fR).
  48 .sp
  49 .LP
  50 If the program handling the data can only pass 7-bit characters or strips the
  51 8th bit, 8 bits cannot be handled.
  52 .sp
  53 .LP
  54 If the \fBterminfo\fR capabilities \fBsmm\fR (meta_on) and \fBrmm\fR (meta_off)
  55 are defined for the terminal, \fBsmm\fR is sent to the terminal  when
  56 \fBmeta(\fR\fIwin\fR\fB, TRUE)\fR is called, and \fBrmm\fR is sent when
  57 \fBmeta(\fR\fIwin\fR\fB, FALSE)\fR is called.
  58 .sp
  59 .LP
  60 This function is useful when extending the non-text command set in applications
  61 where the META key is used.
  62 .SH RETURN VALUES
  63 .sp
  64 .LP
  65 On success, the \fBmeta()\fR function returns \fBOK\fR. Otherwise, it returns
  66 \fBERR\fR.
  67 .SH ERRORS
  68 .sp
  69 .LP
  70 None.
  71 .SH ATTRIBUTES
  72 .sp
  73 .LP
  74 See \fBattributes\fR(5) for descriptions of the following attributes:
  75 .sp
  76
  77 .sp
  78 .TS
  79 box;
  80 c | c
  81 l | l .
  82 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  83 _
  84 Interface Stability     Standard
  85 _
  86 MT-Level        Unsafe
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBgetch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
  93 \fBstandards\fR(5)