ncurses 6.0 - patch 20171125
[ncurses.git] / man / curs_move.3x
index 25c47feb482b1455c2e6fbe93ae8e701d7af5cb0..c1f3f77e6f4929f0c498166b7fa78e6341c23759 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2010,2017 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_move.3x,v 1.6 1998/03/11 21:12:53 juergen Exp $
+.\" $Id: curs_move.3x,v 1.16 2017/11/21 00:46:31 tom Exp $
 .TH curs_move 3X ""
+.na
+.hy 0
 .SH NAME
-\fBmove\fR, \fBwmove\fR - move \fBcurses\fR window cursor
+\fBmove\fR,
+\fBwmove\fR \- move \fBcurses\fR window cursor
+.ad
+.hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBint move(int y, int x);\fR
 .br
 \fBint wmove(WINDOW *win, int y, int x);\fR
 .SH DESCRIPTION
 These routines move the cursor associated with the window to line \fIy\fR and
 column \fIx\fR.  This routine does not move the physical cursor of the terminal
-until \fBrefresh\fR is called.  The position specified is relative to the upper
+until \fBrefresh\fR(3X) is called.  The position specified is relative to the upper
 left-hand corner of the window, which is (0,0).
 .SH RETURN VALUE
-These routines return \fBERR\fR upon failure and OK (SVr4
+These routines return \fBERR\fR upon failure and \fBOK\fP (SVr4
 specifies only "an integer value other than \fBERR\fR") upon successful
 completion.
+.PP
+Specifically, they return an error
+if the window pointer is null, or
+if the position is outside the window.
 .SH NOTES
 Note that \fBmove\fR may be a macro.
 .SH PORTABILITY
-These functions are described in the XSI Curses standard, Issue 4.  The
-standard specifies that if (y,x) is within a multi-column character, the cursor
-is moved to the first column of that character; however, this implementation
-does not yet support the extended-level XSI multi-byte characters.
+These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_refresh\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: