X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_move.3x;h=02e733eb8e2b11d08403ba33891176f355986688;hp=25c47feb482b1455c2e6fbe93ae8e701d7af5cb0;hb=97cb42f22c43eb31a4bf11475bd73ab0e0b10923;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/curs_move.3x b/man/curs_move.3x index 25c47feb..02e733eb 100644 --- a/man/curs_move.3x +++ b/man/curs_move.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2017,2018 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 * @@ -26,38 +26,40 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_move.3x,v 1.6 1998/03/11 21:12:53 juergen Exp $ +.\" $Id: curs_move.3x,v 1.17 2018/07/28 21:34:56 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 \fR - +.sp \fBint move(int y, int x);\fR .br \fBint wmove(WINDOW *win, int y, int x);\fR .br .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 +column \fIx\fR. +This routine does not move the physical cursor of the terminal +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: