usr/src/man/man3xcurses/def_prog_mode.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 DEF_PROG_MODE 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 def_prog_mode, def_shell_mode, reset_prog_mode, reset_shell_mode \-
   9 save/restore terminal modes
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBdef_prog_mode\fR(\fBvoid\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBdef_shell_mode\fR(\fBvoid\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBreset_prog_mode\fR(\fBvoid\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBreset_shell_mode\fR(\fBvoid\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBdef_prog_mode()\fR and \fBdef_shell_mode()\fR functions save the current
  42 terminal modes as "program" (within X/Open Curses) or "shell" (outside X/Open
  43 Curses).  The modes are saved automatically by \fBinitscr\fR(3XCURSES),
  44 \fBnewterm\fR(3XCURSES), and \fBsetupterm\fR(3XCURSES).
  45 .sp
  46 .LP
  47 The \fBreset_prog_mode()\fR and \fBreset_shell_mode()\fR functions  reset the
  48 current terminal modes to "program" (within X/Open Curses) or "shell" (outside
  49 X/Open Curses). The \fBendwin\fR(3XCURSES) function automatically calls the
  50 \fBreset_shell_mode()\fR function and the \fBdoupdate\fR(3XCURSES) function
  51 calls the \fBreset_prog_mode()\fR function after calling \fBendwin()\fR.
  52 .SH RETURN VALUES
  53 .sp
  54 .LP
  55 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  56 .SH ERRORS
  57 .sp
  58 .LP
  59 None.
  60 .SH ATTRIBUTES
  61 .sp
  62 .LP
  63 See \fBattributes\fR(5) for descriptions of the following attributes:
  64 .sp
  65
  66 .sp
  67 .TS
  68 box;
  69 c | c
  70 l | l .
  71 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  72 _
  73 Interface Stability     Standard
  74 _
  75 MT-Level        Unsafe
  76 .TE
  77
  78 .SH SEE ALSO
  79 .sp
  80 .LP
  81 \fBendwin\fR(3XCURSES), \fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES),
  82 \fBnewterm\fR(3XCURSES), \fBsetupterm\fR(3XCURSES), \fBattributes\fR(5),
  83 \fBstandards\fR(5)