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