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

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 2005-2006,2010 Free Software Foundation, Inc.              *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * Author: Thomas E. Dickey
  30   * @Id: legacy_coding.3x,v 1.4 2010/12/04 18:49:20 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>legacy_coding 3x</TITLE>
  38 <link rev=made href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">legacy_coding 3x</H1>
  43 <PRE>
  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><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>use_legacy_coding</STRONG> - use terminal's default colors
  52
  53
  54 </PRE>
  55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></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><a name="h2-DESCRIPTION">DESCRIPTION</a></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><a name="h2-RETURN-VALUE">RETURN VALUE</a></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><a name="h2-PORTABILITY">PORTABILITY</a></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><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 101        <STRONG>unctrl</STRONG>.
 102
 103
 104 </PRE>
 105 <H2><a name="h2-AUTHOR">AUTHOR</a></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 <div class="nav">
 113 <ul>
 114 <li><a href="#h2-NAME">NAME</a></li>
 115 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 116 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 117 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 118 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 119 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 120 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
 121 </ul>
 122 </div>
 123 </BODY>
 124 </HTML>