ncurses 6.4 - patch 20240420

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

diff --git a/man/curs_move.3x b/man/curs_move.3x
index cb244bd1a24248e7b5606ce545a8052ae5befaef..3966325c4dee841f267e88ee7052999364c01eb7 100644 (file)
--- a/man/curs_move.3x
+++ b/man/curs_move.3x
@@ -27,19 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_move.3x,v 1.35 2024/03/16 15:35:01 tom Exp $
-.TH curs_move 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
-.ie \n(.g \{\
-.ds `` \(lq
-.ds '' \(rq
-.\}
-.el \{\
-.ie t .ds `` ``
-.el   .ds `` ""
-.ie t .ds '' ''
-.el   .ds '' ""
-.\}
-.
+.\" $Id: curs_move.3x,v 1.38 2024/04/20 19:51:33 tom Exp $
+.TH curs_move 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .SH NAME
 \fB\%move\fP,
 \fB\%wmove\fP \-
@@ -52,25 +41,48 @@ move cursor in a \fIcurses\fR window
 \fBint wmove(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP);
 .fi
 .SH DESCRIPTION
-These routines move the cursor associated with the window to line \fIy\fP and
-column \fIx\fP.
-This routine does not move the physical cursor of the terminal
-until \fBrefresh\fP(3X) is called.
-The position specified is relative to the upper
-left-hand corner of the window, which is (0,0).
+.B \%wmove
+relocates the cursor associated with the
+.I curses
+window
+.I win
+to line
+.I y
+and column
+.IR x .
+The terminal's cursor does not move until \fB\%refresh\fP(3X) is called.
+The position
+.RI ( x ,
+.IR y )
+is relative to the upper left-hand corner of the window,
+which has coordinates
+(0,\ 0).
+\fB\%ncurses\fP(3X) describes the
+.B \%move
+variant of this function.
 .SH RETURN VALUE
-These routines return the integer \fBERR\fP upon failure and an \fBOK\fP
-(SVr4 specifies only
-\*(``an integer value other than \fBERR\fP\*('')
-upon successful completion.
+These functions return
+.B OK
+on success and
+.B ERR
+on failure.
 .PP
-Specifically, they return an error
-if the window pointer is null, or
-if the position is outside the window.
+They fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
+.PP
+.B \%wmove
+fails if its
+.I \%WINDOW
+pointer argument is
+.BR NULL .
 .SH NOTES
-Note that \fBmove\fP may be a macro.
+.B \%move
+may be implemented as a macro.
 .SH PORTABILITY
-These functions are described in the XSI Curses standard, Issue 4.
+X/Open Curses,
+Issue 4 describes these functions.
 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_refresh\fP(3X)