ncurses 5.6 - patch 20070128
[ncurses.git] / man / legacy_coding.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 2005,2006 Free Software Foundation, Inc.                   *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" Author: Thomas E. Dickey
30 .\"
31 .\" $Id: legacy_coding.3x,v 1.3 2006/12/24 15:12:55 tom Exp $
32 .TH legacy_coding 3X ""
33 .SH NAME
34 \fBuse_legacy_coding\fR \- use terminal's default colors
35 .SH SYNOPSIS
36 \fB#include <curses.h>\fP
37 .sp
38 \fBint use_legacy_coding(int level);\fP
39 .SH DESCRIPTION
40 The
41 .I use_legacy_coding()
42 function is an extension to the curses library.
43 It allows the caller to change the result of \fBunctrl\fP,
44 and suppress related checks within the library that would normally
45 cause nonprinting characters to be rendered in visible form.
46 This affects only 8-bit characters.
47 .PP
48 The \fIlevel\fP parameter controls the result:
49 .RS
50 .TP 5
51 0
52 the library functions normally,
53 rendering nonprinting characters as described in \fBunctrl\fP.
54 .TP
55 1
56 the library ignores \fBisprintf\fP for codes in the range 160-255.
57 .TP
58 2
59 the library ignores \fBisprintf\fP for codes in the range 128-255.
60 It also modifies the output of \fBunctrl\fP, showing codes in the
61 range 128-159 as is.
62 .RE
63 .SH RETURN VALUE
64 If the screen has not been initialized,
65 or the \fIlevel\fP parameter is out of range,
66 the function returns \fBERR\fP.
67 Otherwise, it returns the previous level: \fB0\fP, \fB1\fP or \fB2\fP.
68 .SH PORTABILITY
69 This routine is specific to ncurses.
70 It was not supported on Version 7, BSD or System V implementations.
71 It is recommended that any code depending on ncurses extensions
72 be conditioned using NCURSES_VERSION.
73 .SH SEE ALSO
74 \fBunctrl\fR.
75 .SH AUTHOR
76 Thomas Dickey (to support lynx's font-switching feature).
77 .\"#
78 .\"# The following sets edit modes for GNU EMACS
79 .\"# Local Variables:
80 .\"# mode:nroff
81 .\"# fill-column:79
82 .\"# End: