ncurses 6.5 - patch 20240525

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

diff --git a/man/curs_instr.3x b/man/curs_instr.3x
index 20f42f38a0bf169cc73d344a85dc0ea99cdacddc..ec115efd81d7a0e00b3f443b6d251b85ea0cf480 100644 (file)
--- a/man/curs_instr.3x
+++ b/man/curs_instr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_instr.3x,v 1.44 2023/12/16 20:32:22 tom Exp $
-.TH curs_instr 3X 2023-12-16 "ncurses 6.4" "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
 .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.
 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
 .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
 .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
 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
 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\%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)