ncurses 5.7 - patch 20100731
[ncurses.git] / man / curs_inch.3x
index 9cfb6cef45a55d08ade1f0f1304db7c3d9b24dc4..486d6d614480eddc8ce21e348091c5d1d6184e7d 100644 (file)
@@ -1,11 +1,40 @@
-.\" $Id: curs_inch.3x,v 1.7 1997/01/05 01:29:23 tom Exp $
+'\" t
+.\"***************************************************************************
+.\" Copyright (c) 1998-2006,2010 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.                                                           *
+.\"***************************************************************************
+.\"
+.\" $Id: curs_inch.3x,v 1.14 2010/07/31 16:11:27 tom Exp $
 .TH curs_inch 3X ""
 .SH NAME
 \fBinch\fR, \fBwinch\fR, \fBmvinch\fR, \fBmvwinch\fR
-- get a character and attributes from a \fBcurses\fR window
+\- get a character and attributes from a \fBcurses\fR window
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBchtype inch(void);\fR
 .br
 \fBchtype winch(WINDOW *win);\fR
@@ -20,15 +49,15 @@ position in the named window.  If any attributes are set for that position,
 their values are OR'ed into the value returned.  Constants defined in
 \fB<curses.h>\fR can be used with the \fB&\fR (logical AND) operator to
 extract the character or attributes alone.
-
+.
 .SS Attributes
 The following bit-masks may be AND-ed with characters returned by \fBwinch\fR.
-
+.
 .TS
 l l .
 \fBA_CHARTEXT\fR       Bit-mask to extract character
 \fBA_ATTRIBUTES\fR     Bit-mask to extract attributes
-\fBA_COLOR\fR          Bit-mask to extract color-pair field information
+\fBA_COLOR\fR  Bit-mask to extract color-pair field information
 .TE
 .SH NOTES
 Note that all of these routines may be macros.
@@ -36,6 +65,10 @@ Note that all of these routines may be macros.
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
 \fBcurses\fR(3X).
+.PP
+Comparable functions in the wide-character (ncursesw) library are
+described in
+\fBcurs_in_wch\fR(3X).
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables: