bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 091/100] man/*.3x: Fix content nit.


From: G. Branden Robinson
Subject: [PATCH 091/100] man/*.3x: Fix content nit.
Date: Sat, 30 Mar 2024 17:02:50 -0500

Distingush the WINDOW object from its properties.
---
 man/curs_add_wch.3x    | 3 ++-
 man/curs_add_wchstr.3x | 3 ++-
 man/curs_addch.3x      | 2 +-
 man/curs_addchstr.3x   | 3 ++-
 man/curs_addstr.3x     | 3 ++-
 man/curs_addwstr.3x    | 3 ++-
 man/curs_attr.3x       | 3 ++-
 man/curs_border.3x     | 3 ++-
 man/curs_border_set.3x | 3 ++-
 man/curs_delch.3x      | 2 +-
 man/curs_get_wch.3x    | 3 ++-
 man/curs_get_wstr.3x   | 3 ++-
 man/curs_getch.3x      | 3 ++-
 man/curs_getstr.3x     | 3 ++-
 man/curs_in_wch.3x     | 3 ++-
 man/curs_in_wchstr.3x  | 3 ++-
 man/curs_inch.3x       | 3 ++-
 man/curs_inchstr.3x    | 3 ++-
 man/curs_ins_wch.3x    | 2 +-
 man/curs_ins_wstr.3x   | 3 ++-
 man/curs_insch.3x      | 2 +-
 man/curs_insstr.3x     | 3 ++-
 man/curs_instr.3x      | 3 ++-
 man/curs_inwstr.3x     | 3 ++-
 man/curs_move.3x       | 2 +-
 man/curs_outopts.3x    | 3 ++-
 man/curs_printw.3x     | 2 +-
 man/curs_scanw.3x      | 2 +-
 man/curs_touch.3x      | 4 ++--
 man/ncurses.3x         | 3 ++-
 30 files changed, 53 insertions(+), 31 deletions(-)

diff --git a/man/curs_add_wch.3x b/man/curs_add_wch.3x
index 87606aaa4..401f1143d 100644
--- a/man/curs_add_wch.3x
+++ b/man/curs_add_wch.3x
@@ -313,7 +313,8 @@ .SH RETURN VALUE
 an error is returned.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 Note that
diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x
index 23e80a6be..db8d7aa81 100644
--- a/man/curs_add_wchstr.3x
+++ b/man/curs_add_wchstr.3x
@@ -110,7 +110,8 @@ .SH RETURN VALUE
 if the \fIwchstr\fP parameter is null.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 All functions except \fBwadd_wchnstr\fP may be macros.
diff --git a/man/curs_addch.3x b/man/curs_addch.3x
index 4464cabef..9b2836eb9 100644
--- a/man/curs_addch.3x
+++ b/man/curs_addch.3x
@@ -257,7 +257,7 @@ .SH RETURN VALUE
 fail if the position
 .RI ( y ,
 .IR x )
-is outside the window.
+is outside the window boundaries.
 .SH NOTES
 .BR \%addch ,
 .BR \%mvaddch ,
diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x
index 75e0eab5c..85ebd15ec 100644
--- a/man/curs_addchstr.3x
+++ b/man/curs_addchstr.3x
@@ -104,7 +104,8 @@ .SH RETURN VALUE
 if the \fIwchstr\fP parameter is null.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 All functions except \fBwaddchnstr\fP may be macros.
diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x
index 38a8f396a..ac9bd79ad 100644
--- a/man/curs_addstr.3x
+++ b/man/curs_addstr.3x
@@ -115,7 +115,8 @@ .SH RETURN VALUE
 if an internal \fB\%waddch\fP(3X) call returns an error.
 .PP
 Functions with a \*(``mv\*('' prefix first perform cursor movement using
-\fB\%wmove\fP(3X) and fail if the position is outside the window,
+\fB\%wmove\fP(3X) and fail if the position is outside the window
+boundaries,
 or
 (for \*(``mvw\*('' functions)
 if the
diff --git a/man/curs_addwstr.3x b/man/curs_addwstr.3x
index 53895e33f..cb6015f2e 100644
--- a/man/curs_addwstr.3x
+++ b/man/curs_addwstr.3x
@@ -125,7 +125,8 @@ .SH RETURN VALUE
 if an internal \fB\%wadd_wch\fP(3X) call returns an error.
 .PP
 Functions with a \*(``mv\*('' prefix first perform cursor movement using
-\fB\%wmove\fP(3X) and fail if the position is outside the window,
+\fB\%wmove\fP(3X) and fail if the position is outside the window
+boundaries,
 or
 (for \*(``mvw\*('' functions)
 if the
diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index 7ff66bbb0..fedb3c8fb 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -309,7 +309,8 @@ .SH RETURN VALUE
 used for retrieving attribute or color pair values is \fBNULL\fP.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .\" ---------------------------------------------------------------------------
 .SH NOTES
diff --git a/man/curs_border.3x b/man/curs_border.3x
index bd6f040c8..d070194ec 100644
--- a/man/curs_border.3x
+++ b/man/curs_border.3x
@@ -146,7 +146,8 @@ .SH RETURN VALUE
 if the window pointer is null.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 The borders generated by these functions are \fIinside\fP borders (this
diff --git a/man/curs_border_set.3x b/man/curs_border_set.3x
index da9b14480..2e251e513 100644
--- a/man/curs_border_set.3x
+++ b/man/curs_border_set.3x
@@ -180,7 +180,8 @@ .SH RETURN VALUE
 Functions using a window parameter return an error if it is null.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 Note that
diff --git a/man/curs_delch.3x b/man/curs_delch.3x
index 88ad92c02..5057bc160 100644
--- a/man/curs_delch.3x
+++ b/man/curs_delch.3x
@@ -89,7 +89,7 @@ .SH RETURN VALUE
 fail if the position
 .RI ( y ,
 .IR x )
-is outside the window.
+is outside the window boundaries.
 .SH NOTES
 .BR \%delch ,
 .BR \%mvdelch ,
diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index 46a37b821..bfc94ba59 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -191,7 +191,8 @@ .SH RETURN VALUE
 .BR \%EINTR .
 .PP
 Functions with a \*(``mv\*('' prefix first perform cursor movement using
-\fB\%wmove\fP(3X) and fail if the position is outside the window,
+\fB\%wmove\fP(3X) and fail if the position is outside the window
+boundaries,
 or
 (for \*(``mvw\*('' functions)
 if the
diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x
index aee02743d..c3413f9e0 100644
--- a/man/curs_get_wstr.3x
+++ b/man/curs_get_wstr.3x
@@ -148,7 +148,8 @@ .SH RETURN VALUE
 failed.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 Any of these functions other than
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index de19e6223..98725bd53 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -437,7 +437,8 @@ .SH RETURN VALUE
 .BR NULL .
 .PP
 Functions with a \*(``mv\*('' prefix first perform cursor movement using
-\fB\%wmove\fP(3X) and fail if the position is outside the window.
+\fB\%wmove\fP(3X) and fail if the position is outside the window
+boundaries.
 .PP
 .B \%wgetch
 also fails if
diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x
index 2526336e4..1b0ab2b3d 100644
--- a/man/curs_getstr.3x
+++ b/man/curs_getstr.3x
@@ -150,7 +150,8 @@ .SH RETURN VALUE
 rather than \fBOK\fP or \fBERR\fP.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 Any of these functions other than
diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x
index b88d37629..60b7557a1 100644
--- a/man/curs_in_wch.3x
+++ b/man/curs_in_wch.3x
@@ -67,7 +67,8 @@ .SH RETURN VALUE
 Otherwise they return \fBOK\fP.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 Note that all of these routines may be macros.
diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index d5a116ca6..d533081c3 100644
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -96,7 +96,8 @@ .SH RETURN VALUE
 if the \fIwchstr\fP parameter is null.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 All routines except \fBwin_wchnstr\fP may be macros.
diff --git a/man/curs_inch.3x b/man/curs_inch.3x
index 91cea7575..8c03e5fec 100644
--- a/man/curs_inch.3x
+++ b/man/curs_inch.3x
@@ -84,7 +84,8 @@ .SS Attributes
 .TE
 .SH RETURN VALUE
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .PP
 The \fBwinch\fP function does not return an error if the window contains
diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x
index d019fc618..f5c1b33a9 100644
--- a/man/curs_inchstr.3x
+++ b/man/curs_inchstr.3x
@@ -95,7 +95,8 @@ .SH RETURN VALUE
 if the \fIchstr\fP parameter is null.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 All routines except \fBwinchnstr\fP may be macros.
diff --git a/man/curs_ins_wch.3x b/man/curs_ins_wch.3x
index 3bc11ad46..4b36a1da8 100644
--- a/man/curs_ins_wch.3x
+++ b/man/curs_ins_wch.3x
@@ -79,7 +79,7 @@ .SH "RETURN VALUE"
 \fB\%wmove\fP and fail if the position
 .RI ( y ,
 .IR x )
-is outside the window.
+is outside the window boundaries.
 .SH NOTES
 A terminal's
 .B \%insert_character
diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x
index 32ce107e4..3fc8c239e 100644
--- a/man/curs_ins_wstr.3x
+++ b/man/curs_ins_wstr.3x
@@ -99,7 +99,8 @@ .SH RETURN VALUE
 if the \fBwins_wch\fP function returns an error.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP(3X), and return an error if the position is outside the window,
+\fBwmove\fP(3X), and return an error if the position is outside the
+window boundaries,
 or if the window pointer is null.
 .SH NOTES
 All but \fBwins_nwstr\fP may be macros.
diff --git a/man/curs_insch.3x b/man/curs_insch.3x
index aab235858..c71a43550 100644
--- a/man/curs_insch.3x
+++ b/man/curs_insch.3x
@@ -83,7 +83,7 @@ .SH "RETURN VALUE"
 fail if the position
 .RI ( y ,
 .IR x )
-is outside the window.
+is outside the window boundaries.
 .SH NOTES
 .BR \%insch ,
 .BR \%mvinsch ,
diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x
index 6c7035365..9a778129a 100644
--- a/man/curs_insstr.3x
+++ b/man/curs_insstr.3x
@@ -98,7 +98,8 @@ .SH RETURN VALUE
 the \fBwinsch\fP(3X) function returns an error.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP(3X), and return an error if the position is outside the window,
+\fBwmove\fP(3X), and return an error if the position is outside the
+window boundaries,
 or if the window pointer is null.
 .SH NOTES
 All but \fBwinsnstr\fP may be macros.
diff --git a/man/curs_instr.3x b/man/curs_instr.3x
index 41129d72d..708877948 100644
--- a/man/curs_instr.3x
+++ b/man/curs_instr.3x
@@ -90,7 +90,8 @@ .SH RETURN VALUE
 if the \fIchstr\fP parameter is null.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 All routines except \fBwinnstr\fP may be macros.
diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x
index 095c2fa1c..7683bc488 100644
--- a/man/curs_inwstr.3x
+++ b/man/curs_inwstr.3x
@@ -100,7 +100,8 @@ .SH RETURN VALUE
 if no characters could be read.
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
+\fBwmove\fP, and return an error if the position is outside the window
+boundaries,
 or if the window pointer is null.
 .SH NOTES
 All routines except
diff --git a/man/curs_move.3x b/man/curs_move.3x
index cb244bd1a..089538d7d 100644
--- a/man/curs_move.3x
+++ b/man/curs_move.3x
@@ -66,7 +66,7 @@ .SH RETURN VALUE
 .PP
 Specifically, they return an error
 if the window pointer is null, or
-if the position is outside the window.
+if the position is outside the window boundaries.
 .SH NOTES
 Note that \fBmove\fP may be a macro.
 .SH PORTABILITY
diff --git a/man/curs_outopts.3x b/man/curs_outopts.3x
index 31ac749ff..4cb60721e 100644
--- a/man/curs_outopts.3x
+++ b/man/curs_outopts.3x
@@ -151,7 +151,8 @@ .SH RETURN VALUE
 will return an error if the window pointer is null
 .bP
 \fBwsetscrreg\fP
-returns an error if the scrolling region limits extend outside the window.
+returns an error if the scrolling region limits extend outside the
+window boundaries.
 .SH NOTES
 Note that
 \fBclearok\fP,
diff --git a/man/curs_printw.3x b/man/curs_printw.3x
index a0a274513..35ee0ac2c 100644
--- a/man/curs_printw.3x
+++ b/man/curs_printw.3x
@@ -105,7 +105,7 @@ .SH RETURN VALUE
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement
 using \fB\%wmove\fP,
-and fail if the position is outside the window.
+and fail if the position is outside the window boundaries.
 .SH NOTES
 No wide character counterpart functions are defined by the
 \*(``wide\*(''
diff --git a/man/curs_scanw.3x b/man/curs_scanw.3x
index 599ace95c..aa5534d4f 100644
--- a/man/curs_scanw.3x
+++ b/man/curs_scanw.3x
@@ -106,7 +106,7 @@ .SH RETURN VALUE
 .PP
 Functions with a \*(``mv\*('' prefix first perform a cursor movement
 using \fB\%wmove\fP,
-and fail if the position is outside the window.
+and fail if the position is outside the window boundaries.
 .SH NOTES
 No wide character counterpart functions are defined by the
 \*(``wide\*(''
diff --git a/man/curs_touch.3x b/man/curs_touch.3x
index 22391fd66..4512456b5 100644
--- a/man/curs_touch.3x
+++ b/man/curs_touch.3x
@@ -88,7 +88,7 @@ .SH RETURN VALUE
 \fBis_linetouched\fP
 returns an error
 if the window pointer is null, or
-if the line number is outside the window.
+if the line number is outside the window boundaries.
 .IP
 The constant \fBERR\fP is distinct from \fBTRUE\fP and \fBFALSE\fP,
 which are the normal return values of this function.
@@ -103,7 +103,7 @@ .SH RETURN VALUE
 \fBwtouchln\fP
 returns an error
 if the window pointer is null, or
-if the line number is outside the window.
+if the line number is outside the window boundaries.
 .RE
 .SH NOTES
 All of these routines except \fB\%wtouchln\fP may be macros.
diff --git a/man/ncurses.3x b/man/ncurses.3x
index 2132d65b7..d0586a9a8 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -1045,7 +1045,8 @@ .SH RETURN VALUE
 .I \%ncurses
 treats a null pointer passed as a function parameter as a failure.
 Functions with a \*(``mv\*('' prefix first perform cursor movement using
-\fB\%wmove\fP(3X) and fail if the position is outside the window.
+\fB\%wmove\fP(3X) and fail if the position is outside the window
+boundaries.
 .SH ENVIRONMENT
 The following symbols from the process environment customize the
 runtime behavior of
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]