doc/html/man/legacy_coding.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 2005,2006 Free Software Foundation, Inc.                   *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * Author: Thomas E. Dickey
  31   * @Id: legacy_coding.3x,v 1.3 2006/12/24 15:12:55 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>legacy_coding 3x</TITLE>
  36 <link rev=made href="mailto:bug-ncurses@gnu.org">
  37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38 </HEAD>
  39 <BODY>
  40 <H1>legacy_coding 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44 <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>                                     <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>use_legacy_coding</STRONG> - use terminal's default colors
  52
  53
  54 </PRE>
  55 <H2>SYNOPSIS</H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  57
  58        <STRONG>int</STRONG> <STRONG>use_legacy_coding(int</STRONG> <STRONG>level);</STRONG>
  59
  60
  61 </PRE>
  62 <H2>DESCRIPTION</H2><PRE>
  63        The  <EM>use</EM><STRONG>_</STRONG><EM>legacy</EM><STRONG>_</STRONG><EM>coding()</EM>  function  is an extension to the
  64        curses library.  It allows the caller to change the result
  65        of  <STRONG>unctrl</STRONG>, and suppress related checks within the library
  66        that would normally cause  nonprinting  characters  to  be
  67        rendered in visible form.  This affects only 8-bit charac-
  68        ters.
  69
  70        The <EM>level</EM> parameter controls the result:
  71
  72               0    the library functions normally, rendering non-
  73                    printing characters as described in <STRONG>unctrl</STRONG>.
  74
  75               1    the  library ignores <STRONG>isprintf</STRONG> for codes in the
  76                    range 160-255.
  77
  78               2    the library ignores <STRONG>isprintf</STRONG> for codes in  the
  79                    range 128-255.  It also modifies the output of
  80                    <STRONG>unctrl</STRONG>, showing codes in the range 128-159  as
  81                    is.
  82
  83
  84 </PRE>
  85 <H2>RETURN VALUE</H2><PRE>
  86        If  the  screen  has  not  been  initialized, or the <EM>level</EM>
  87        parameter is out of range, the function returns <STRONG>ERR</STRONG>.  Oth-
  88        erwise, it returns the previous level: <STRONG>0</STRONG>, <STRONG>1</STRONG> or <STRONG>2</STRONG>.
  89
  90
  91 </PRE>
  92 <H2>PORTABILITY</H2><PRE>
  93        This routine is specific to ncurses.  It was not supported
  94        on Version 7, BSD or System V implementations.  It is rec-
  95        ommended  that any code depending on ncurses extensions be
  96        conditioned using NCURSES_VERSION.
  97
  98
  99 </PRE>
 100 <H2>SEE ALSO</H2><PRE>
 101        <STRONG>unctrl</STRONG>.
 102
 103
 104 </PRE>
 105 <H2>AUTHOR</H2><PRE>
 106        Thomas Dickey (to support lynx's font-switching  feature).
 107
 108
 109
 110                                                       <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>
 111 </PRE>
 112 <HR>
 113 <ADDRESS>
 114 Man(1) output converted with
 115 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 116 </ADDRESS>
 117 </BODY>
 118 </HTML>