ncurses 6.5 - patch 20240519

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

diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x
index 8c20d8217315f3cfe9ffbac44757b34b64be2700..eec361d77af95bbd0c2b6a8bd06433e3d4d9c9ec 100644 (file)
--- a/man/curs_inwstr.3x
+++ b/man/curs_inwstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
 .\" Copyright 2002-2012,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_inwstr.3x,v 1.33 2023/11/19 00:10:50 tom Exp $
-.TH curs_inwstr 3X 2023-11-18 "ncurses 6.4" "Library calls"
+.\" $Id: curs_inwstr.3x,v 1.41 2024/04/20 21:20:07 tom Exp $
+.TH curs_inwstr 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
@@ -99,16 +99,19 @@ if the \fIwstr\fP parameter is null, or
 .bP
 if no characters could be read.
 .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
 \fBwinnwstr\fP
 may be macros.
 .PP
-Each cell in the window holds a complex character (i.e., base-
-and combining-characters) together with attributes and color.
+Each cell in the window holds a complex character
+(a spacing character and zero or more non-spacing characters)
+together with attributes and color.
 These functions store only the wide characters,
 ignoring attributes and color.
 Use \fBin_wchstr\fP to return the complex characters from a window.
@@ -128,6 +131,8 @@ Therefore, the use of
 \fBmvwinnwstr\fP, or
 \fBwinnwstr\fP
 is recommended.
+.SH PORTABILITY
+These functions are described in X/Open Curses, Issue 4.
 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_inch\fP(3X),