X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_move.3x;h=05917626287c5e9bf32dff0e3c65596d106bce69;hb=6cd4a712ad4ac58bf801e5dc66648338d2aa294e;hp=25c47feb482b1455c2e6fbe93ae8e701d7af5cb0;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;p=ncurses.git diff --git a/man/curs_move.3x b/man/curs_move.3x index 25c47feb..05917626 100644 --- a/man/curs_move.3x +++ b/man/curs_move.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 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 * @@ -26,38 +27,40 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_move.3x,v 1.6 1998/03/11 21:12:53 juergen Exp $ +.\" $Id: curs_move.3x,v 1.22 2022/02/12 20:05:11 tom Exp $ .TH curs_move 3X "" +.na +.hy 0 .SH NAME -\fBmove\fR, \fBwmove\fR - move \fBcurses\fR window cursor +\fBmove\fP, +\fBwmove\fP \- move \fBcurses\fP window cursor +.ad +.hy .SH SYNOPSIS -\fB#include \fR - -\fBint move(int y, int x);\fR +\fB#include \fP +.sp +\fBint move(int \fIy\fB, int \fIx\fB);\fR .br -\fBint wmove(WINDOW *win, int y, int x);\fR +\fBint wmove(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB);\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 +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 \fBrefresh\fP(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 -specifies only "an integer value other than \fBERR\fR") upon successful +These routines return \fBERR\fP upon failure and \fBOK\fP (SVr4 +specifies only "an integer value other than \fBERR\fP") 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. +Note that \fBmove\fP 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: +\fBcurses\fP(3X), \fBcurs_refresh\fP(3X)