summaryrefslogtreecommitdiffstats
path: root/upstream/opensuse-tumbleweed/man3/move.3ncurses
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/opensuse-tumbleweed/man3/move.3ncurses')
-rw-r--r--upstream/opensuse-tumbleweed/man3/move.3ncurses70
1 files changed, 41 insertions, 29 deletions
diff --git a/upstream/opensuse-tumbleweed/man3/move.3ncurses b/upstream/opensuse-tumbleweed/man3/move.3ncurses
index 9118504d..586768ad 100644
--- a/upstream/opensuse-tumbleweed/man3/move.3ncurses
+++ b/upstream/opensuse-tumbleweed/man3/move.3ncurses
@@ -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 *
@@ -27,19 +27,8 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_move.3x,v 1.33 2023/12/16 21:33:08 tom Exp $
-.TH move 3NCURSES 2023-12-16 "ncurses 6.4" "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.40 2024/04/27 17:56:05 tom Exp $
+.TH move 3NCURSES 2024-04-27 "ncurses 6.5" "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 \fB\%refresh\fP(3NCURSES) 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(3NCURSES) is called.
+The position
+.RI ( y ,
+.IR x )
+is relative to the upper left-hand corner of the window,
+which has coordinates
+(0,\ 0).
+\fB\%ncurses\fP(3NCURSES) 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\%ncurses\fP(3NCURSES),
\fB\%refresh\fP(3NCURSES)