[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 43/45] man/curs_{kernel,terminfo}.3x: Relocate material.
From: |
G. Branden Robinson |
Subject: |
[PATCH 43/45] man/curs_{kernel,terminfo}.3x: Relocate material. |
Date: |
Sat, 25 May 2024 12:45:46 -0500 |
Document `mvcur()`, which "is really a curses function" (and is
prototyped in curses.h rather than term.h), in curs_kernel.3x instead of
curs_terminfo.3x.
---
man/curs_kernel.3x | 50 +++++++++++++++++++++++++++++++++++++++
man/curs_terminfo.3x | 56 ++------------------------------------------
2 files changed, 52 insertions(+), 54 deletions(-)
diff --git a/man/curs_kernel.3x b/man/curs_kernel.3x
index 8ec153126..dfcb5bc7f 100644
--- a/man/curs_kernel.3x
+++ b/man/curs_kernel.3x
@@ -54,6 +54,7 @@ .SH NAME
\fB\%getsyx\fP,
\fB\%setsyx\fP,
\fB\%curs_set\fP,
+\fB\%mvcur\fP,
\fB\%napms\fP,
\fB\%ripoffline\fP \-
low-level \fIcurses\fR routines
@@ -74,6 +75,7 @@ .SH SYNOPSIS
\fBvoid setsyx(int \fIy\fP, int \fIx\fP);
.PP
\fBint curs_set(int \fIvisibility\fP);
+\fBint mvcur(int \fIoldrow\fP, int \fIoldcol\fP, int \fInewrow\fP, int
\fInewcol\fP);
\fBint napms(int \fIms\fP);
\fBint ripoffline(int \fIline\fP, int (*\fIinit\fP)(WINDOW *, int));
.fi
@@ -138,6 +140,15 @@ .SS curs_set
If the terminal supports the \fIvisibility\fP requested,
the previous \fIcursor\fP state is returned;
otherwise, \fBERR\fP is returned.
+.SS mvcur
+\fB\%mvcur\fP provides low-level cursor motion.
+It takes effect immediately
+(rather than at the next refresh).
+Unlike the other low-level output functions,
+which either write to the standard output or pass an output function
+parameter,
+\fB\%mvcur\fP uses an output file descriptor derived from
+the output stream parameter of \fB\%newterm\fP(3X).
.SS napms
.B \%napms
sleeps for
@@ -221,6 +232,45 @@ .SH PORTABILITY
This is misleading, as they are macros with no documented semantics
for the return value.
.PP
+X/Open Curses notes that after calling \fB\%mvcur\fP,
+the
+.I curses
+state may not match the actual terminal state,
+and that an application should touch and refresh the window before
+resuming normal
+.I curses
+calls.
+Both
+.I \%ncurses
+and SVr4
+.I curses
+implement \fB\%mvcur\fP using the
+.I SCREEN
+data allocated in either \fB\%initscr\fP or \fB\%newterm\fP.
+So though it is documented as a
+.I \%term\%info
+function,
+\fB\%mvcur\fP is really a
+.I curses
+function that is not well specified.
+.PP
+X/Open Curses states that the old location must be given for
+\fB\%mvcur\fP to accommodate terminals that lack absolute cursor
+positioning.
+.\" X/Open Curses Issue 7, p. 161
+.I \%ncurses
+allows the caller to use \-1 for either or both old coordinates.
+The \-1 tells
+.I \%ncurses
+that the old location is unknown,
+and that it must use only absolute motion,
+as with the
+.B \%cursor_address
+.RB ( cup )
+capability,
+rather than the least costly combination of absolute and relative
+motion.
+.PP
If interrupted, \fI\%ncurses\fP restarts \fBnapms\fP.
That, and the limitation to 30 seconds,
are different from other implementations.
diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index 25e83afd8..16b6a151e 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -48,7 +48,6 @@
.
.SH NAME
\fB\%del_curterm\fP,
-\fB\%mvcur\fP,
\fB\%putp\fP,
\fB\%restartterm\fP,
\fB\%set_curterm\fP,
@@ -100,8 +99,6 @@ .SH SYNOPSIS
\fBint vid_puts(attr_t \fIattrs\fP, short \fIpair\fP, void *\fIopts\fP, int
(*\fIputc\fP)(int));
\fBint vid_attr(attr_t \fIattrs\fP, short \fIpair\fP, void *\fIopts\fP);
.PP
-\fBint mvcur(int \fIoldrow\fP, int \fIoldcol\fP, int \fInewrow\fP, int
\fInewcol\fP);
-.PP
\fBint tigetflag(const char *\fIcap-code\fP);
\fBint tigetnum(const char *\fIcap-code\fP);
\fBchar *tigetstr(const char *\fIcap-code\fP);
@@ -540,21 +537,11 @@ .SS "Output Functions"
saying that applications must provide a null pointer for that argument;
but see section \*(``EXTENSIONS\*('' below.
.PP
-\fB\%mvcur\fP provides low-level cursor motion.
-It takes effect immediately
-(rather than at the next refresh).
-Unlike the other low-level output functions,
-which either write to the standard output or pass an output function
-parameter,
-\fB\%mvcur\fP uses an output file descriptor derived from
-the output stream parameter of \fB\%newterm\fP(3X).
-.PP
-While \fB\%putp\fP and \fB\%mvcur\fP are low-level functions that do not
-use high-level
+While \fB\%putp\fP is a low-level function that does not use high-level
.I curses
state,
.I \%ncurses
-declares them in
+declares it in
.I \%curses.h
because System\ V did this
(see section \*(``HISTORY\*('' below).
@@ -954,45 +941,6 @@ .SS "Other Portability Issues"
from \fB\%tputs\fP.
It instead returns the length of the string,
and does no error checking.
-.PP
-X/Open Curses notes that after calling \fB\%mvcur\fP,
-the
-.I curses
-state may not match the actual terminal state,
-and that an application should touch and refresh the window before
-resuming normal
-.I curses
-calls.
-Both
-.I \%ncurses
-and SVr4
-.I curses
-implement \fB\%mvcur\fP using the
-.I SCREEN
-data allocated in either \fB\%initscr\fP or \fB\%newterm\fP.
-So though it is documented as a
-.I \%term\%info
-function,
-\fB\%mvcur\fP is really a
-.I curses
-function that is not well specified.
-.PP
-X/Open Curses states that the old location must be given for
-\fB\%mvcur\fP to accommodate terminals that lack absolute cursor
-positioning.
-.\" X/Open Curses Issue 7, p. 161
-.I \%ncurses
-allows the caller to use \-1 for either or both old coordinates.
-The \-1 tells
-.I \%ncurses
-that the old location is unknown,
-and that it must use only absolute motion,
-as with the
-.B \%cursor_address
-.RB ( cup )
-capability,
-rather than the least costly combination of absolute and relative
-motion.
.\" ********************************************************************
.SH HISTORY
SVr2 (1984) introduced the
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 43/45] man/curs_{kernel,terminfo}.3x: Relocate material.,
G. Branden Robinson <=