ncurses 6.4 - patch 20240323

[ncurses.git] / man / curs_move.3x

diff --git a/man/curs_move.3x b/man/curs_move.3x
index 25c47feb482b1455c2e6fbe93ae8e701d7af5cb0..cb244bd1a24248e7b5606ce545a8052ae5befaef 100644 (file)
--- a/man/curs_move.3x
+++ b/man/curs_move.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright 2018-2023,2024 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,50 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_move.3x,v 1.6 1998/03/11 21:12:53 juergen Exp $
-.TH curs_move 3X ""
+.\" $Id: curs_move.3x,v 1.35 2024/03/16 15:35:01 tom Exp $
+.TH curs_move 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
+.
 .SH NAME
-\fBmove\fR, \fBwmove\fR - move \fBcurses\fR window cursor
+\fB\%move\fP,
+\fB\%wmove\fP \-
+move cursor in a \fIcurses\fR window
 .SH SYNOPSIS
-\fB#include <curses.h>\fR
-
-\fBint move(int y, int x);\fR
-.br
-\fBint wmove(WINDOW *win, int y, int x);\fR
-.br
+.nf
+\fB#include <curses.h>
+.PP
+\fBint move(int \fIy\fP, int \fIx\fP);
+\fBint wmove(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP);
+.fi
 .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
-completion.
+These routines return the integer \fBERR\fP upon failure and an \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:
+\fB\%curses\fP(3X),
+\fB\%curs_refresh\fP(3X)