ncurses 6.1 - patch 20200111

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

diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index 5bac9d3d58d96106319285a899f0b1aed5596d76..dda9f2487311edb9eb06d74a7278821fc46bc30c 100644 (file)
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 2002,2005 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 2002-2018,2019 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,8 +26,12 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_in_wchstr.3x,v 1.5 2005/05/15 16:57:17 tom Exp $
+.\" $Id: curs_in_wchstr.3x,v 1.12 2019/11/30 21:06:30 tom Exp $

 .TH curs_in_wchstr 3X ""
 .TH curs_in_wchstr 3X ""

+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''

 .na
 .hy 0
 .SH NAME
 .na
 .hy 0
 .SH NAME


@@ -92,30 +96,30 @@ with
 \fBmvwin_wchstr\fR
 or
 \fBwin_wchstr\fR
 \fBmvwin_wchstr\fR
 or
 \fBwin_wchstr\fR

-causes undefined results. Therefore, the use of
+causes undefined results.
+Therefore, the use of

 \fBin_wchnstr\fR,
 \fBmvin_wchnstr\fR,
 \fBmvwin_wchnstr\fR, or
 \fBwin_wchnstr\fR
 is recommended.
 \fBin_wchnstr\fR,
 \fBmvin_wchnstr\fR,
 \fBmvwin_wchnstr\fR, or
 \fBwin_wchnstr\fR
 is recommended.

-.SH RETURN VALUES
+.SH RETURN VALUE

 Upon successful completion, these functions return
 \fBOK\fR.
 Otherwise, they return
 \fBERR\fR.
 Upon successful completion, these functions return
 \fBOK\fR.
 Otherwise, they return
 \fBERR\fR.

+.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.

 .SH PORTABILITY
 The XSI Curses defines no error conditions.
 This implementation checks for null pointers,
 .SH PORTABILITY
 The XSI Curses defines no error conditions.
 This implementation checks for null pointers,

-returning ERR in that case.
+returning \fBERR\fP in that case.

 .SH SEE ALSO
 Functions:
 \fBcurses\fR(3X),
 \fBcurs_in_wch\fR(3X),
 \fBcurs_instr\fR(3X),
 \fBcurs_inwstr\fR(3X)
 .SH SEE ALSO
 Functions:
 \fBcurses\fR(3X),
 \fBcurs_in_wch\fR(3X),
 \fBcurs_instr\fR(3X),
 \fBcurs_inwstr\fR(3X)

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+\fBcurs_inchstr\fR(3X)