ncurses 5.9 - patch 20111217

[ncurses.git] / man / curs_inch.3x

diff --git a/man/curs_inch.3x b/man/curs_inch.3x
index 486d6d614480eddc8ce21e348091c5d1d6184e7d..7e1e3b439177b5694afa9930506c02441138bcbc 100644 (file)
--- a/man/curs_inch.3x
+++ b/man/curs_inch.3x
@@ -27,11 +27,13 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_inch.3x,v 1.14 2010/07/31 16:11:27 tom Exp $
+.\" $Id: curs_inch.3x,v 1.17 2010/12/04 18:36:44 tom Exp $

 .TH curs_inch 3X ""
 .SH NAME
 .TH curs_inch 3X ""
 .SH NAME

-\fBinch\fR, \fBwinch\fR, \fBmvinch\fR, \fBmvwinch\fR
-\- get a character and attributes from a \fBcurses\fR window
+\fBinch\fR,
+\fBwinch\fR,
+\fBmvinch\fR,
+\fBmvwinch\fR \- get a character and attributes from a \fBcurses\fR window

 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .sp
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .sp


@@ -59,6 +61,10 @@ l l .
 \fBA_ATTRIBUTES\fR     Bit-mask to extract attributes
 \fBA_COLOR\fR  Bit-mask to extract color-pair field information
 .TE
 \fBA_ATTRIBUTES\fR     Bit-mask to extract attributes
 \fBA_COLOR\fR  Bit-mask to extract color-pair field information
 .TE

+.SH RETURN VALUE
+Functions with a "mv" prefix first perform a cursor movement using
+\fBwmove\fP, and return an error if the position is outside the window,
+or if the window pointer is null.

 .SH NOTES
 Note that all of these routines may be macros.
 .SH PORTABILITY
 .SH NOTES
 Note that all of these routines may be macros.
 .SH PORTABILITY


@@ -69,9 +75,3 @@ These functions are described in the XSI Curses standard, Issue 4.
 Comparable functions in the wide-character (ncursesw) library are
 described in
 \fBcurs_in_wch\fR(3X).
 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:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: