diff options
author | Nicholas Marriott <nicm@cvs.openbsd.org> | 2016-09-16 17:24:21 +0000 |
---|---|---|
committer | Nicholas Marriott <nicm@cvs.openbsd.org> | 2016-09-16 17:24:21 +0000 |
commit | e244eaf5bc43b1f0976c189248aa727201204e69 (patch) | |
tree | 5c5acbcc6acbba5500dbd9812b3a5d8a8cbbc34b /lib/libcurses/legacy_coding.3 | |
parent | c39288e5896e7c9b20dd9f07aab343e8863481c6 (diff) |
Include the legacy_coding(3) page which documents use_legacy_coding(),
probably missed at one update or another. Reported by Anthony Coulter,
discussed with jmc.
Diffstat (limited to 'lib/libcurses/legacy_coding.3')
-rw-r--r-- | lib/libcurses/legacy_coding.3 | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/lib/libcurses/legacy_coding.3 b/lib/libcurses/legacy_coding.3 new file mode 100644 index 00000000000..fe490540fdb --- /dev/null +++ b/lib/libcurses/legacy_coding.3 @@ -0,0 +1,82 @@ +.\"*************************************************************************** +.\" Copyright (c) 2005,2006 Free Software Foundation, Inc. * +.\" * +.\" Permission is hereby granted, free of charge, to any person obtaining a * +.\" copy of this software and associated documentation files (the * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" Author: Thomas E. Dickey +.\" +.\" $Id: legacy_coding.3,v 1.1 2016/09/16 17:24:20 nicm Exp $ +.TH legacy_coding 3 "" +.SH NAME +\fBuse_legacy_coding\fR \- use terminal's default colors +.SH SYNOPSIS +\fB#include <curses.h>\fP +.sp +\fBint use_legacy_coding(int level);\fP +.SH DESCRIPTION +The +.I use_legacy_coding() +function is an extension to the curses library. +It allows the caller to change the result of \fBunctrl\fP, +and suppress related checks within the library that would normally +cause nonprinting characters to be rendered in visible form. +This affects only 8-bit characters. +.PP +The \fIlevel\fP parameter controls the result: +.RS +.TP 5 +0 +the library functions normally, +rendering nonprinting characters as described in \fBunctrl\fP. +.TP +1 +the library ignores \fBisprintf\fP for codes in the range 160-255. +.TP +2 +the library ignores \fBisprintf\fP for codes in the range 128-255. +It also modifies the output of \fBunctrl\fP, showing codes in the +range 128-159 as is. +.RE +.SH RETURN VALUE +If the screen has not been initialized, +or the \fIlevel\fP parameter is out of range, +the function returns \fBERR\fP. +Otherwise, it returns the previous level: \fB0\fP, \fB1\fP or \fB2\fP. +.SH PORTABILITY +This routine is specific to ncurses. +It was not supported on Version 7, BSD or System V implementations. +It is recommended that any code depending on ncurses extensions +be conditioned using NCURSES_VERSION. +.SH SEE ALSO +\fBunctrl\fR(3). +.SH AUTHOR +Thomas Dickey (to support lynx's font-switching feature). +.\"# +.\"# The following sets edit modes for GNU EMACS +.\"# Local Variables: +.\"# mode:nroff +.\"# fill-column:79 +.\"# End: |