ncurses 6.2 - patch 20210306
[ncurses.git] / man / curs_move.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
3 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: curs_move.3x,v 1.19 2020/10/24 09:39:41 tom Exp $
31 .TH curs_move 3X ""
32 .na
33 .hy 0
34 .SH NAME
35 \fBmove\fR,
36 \fBwmove\fR \- move \fBcurses\fR window cursor
37 .ad
38 .hy
39 .SH SYNOPSIS
40 \fB#include <curses.h>\fR
41 .sp
42 \fBint move(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
43 .br
44 \fBint wmove(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB);\fR
45 .br
46 .SH DESCRIPTION
47 These routines move the cursor associated with the window to line \fIy\fR and
48 column \fIx\fR.
49 This routine does not move the physical cursor of the terminal
50 until \fBrefresh\fR(3X) is called.
51 The position specified is relative to the upper
52 left-hand corner of the window, which is (0,0).
53 .SH RETURN VALUE
54 These routines return \fBERR\fR upon failure and \fBOK\fP (SVr4
55 specifies only "an integer value other than \fBERR\fR") upon successful
56 completion.
57 .PP
58 Specifically, they return an error
59 if the window pointer is null, or
60 if the position is outside the window.
61 .SH NOTES
62 Note that \fBmove\fR may be a macro.
63 .SH PORTABILITY
64 These functions are described in the XSI Curses standard, Issue 4.
65 .SH SEE ALSO
66 \fBcurses\fR(3X), \fBcurs_refresh\fR(3X)