ncurses 6.5 - patch 20240525

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

diff --git a/man/curs_instr.3x b/man/curs_instr.3x
index d35a3615b47c32f44144118770fcd23225fc1703..ec115efd81d7a0e00b3f443b6d251b85ea0cf480 100644 (file)
--- a/man/curs_instr.3x
+++ b/man/curs_instr.3x
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_instr.3x,v 1.46 2024/03/16 15:35:01 tom Exp $
-.TH curs_instr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.\" $Id: curs_instr.3x,v 1.53 2024/05/25 20:10:58 tom Exp $
+.TH curs_instr 3X 2024-05-25 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
@@ -83,15 +83,18 @@ All of the functions return \fBERR\fP upon failure,
 or the number of characters actually read into the string.
 .PP
 X/Open Curses defines no error conditions.
-This implementation returns an error
+This implementation returns
+.B ERR
 .bP
 if the \fIwin\fP parameter is null or
 .bP
 if the \fIchstr\fP parameter is null.
 .PP
-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.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All routines except \fBwinnstr\fP may be macros.
 .PP
@@ -114,12 +117,15 @@ is recommended.
 SVr4 does not
 document whether a length limit includes or excludes the trailing NUL.
 .PP
-The \fI\%ncurses\fP library extends the XSI description by allowing a
+The \fI\%ncurses\fP library extends the X/Open Curses description by allowing a
 negative value for \fIn\fP.
 In this case, the functions return the string ending at the right margin.
 .SH SEE ALSO
+\fB\%curs_ins_wstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its wide-character configuration
+.RI ( \%ncursesw ).
+.PP
 \fB\%curses\fP(3X),
 \fB\%curs_inch\fP(3X),
-\fB\%curs_inchstr\fP(3X),
-\fB\%curs_inwstr\fP(3X),
-\fB\%curs_in_wchstr\fP(3X)
+\fB\%curs_inchstr\fP(3X)