[PATCH 100/100] man/*.3x: Apply consistent `mv*()` failure boilerplate.

[G. Branden Robinson]

---
 man/curs_add_wch.3x    |  9 +++++----
 man/curs_add_wchstr.3x |  9 +++++----
 man/curs_addchstr.3x   |  9 +++++----
 man/curs_addstr.3x     | 13 +++++--------
 man/curs_addwstr.3x    | 13 +++++--------
 man/curs_attr.3x       |  8 ++++----
 man/curs_border.3x     |  9 +++++----
 man/curs_border_set.3x |  9 +++++----
 man/curs_get_wch.3x    | 13 +++++--------
 man/curs_get_wstr.3x   |  9 +++++----
 man/curs_getch.3x      |  8 +++++---
 man/curs_getstr.3x     |  9 +++++----
 man/curs_in_wch.3x     |  9 +++++----
 man/curs_in_wchstr.3x  |  9 +++++----
 man/curs_inch.3x       |  9 +++++----
 man/curs_inchstr.3x    |  9 +++++----
 man/curs_ins_wch.3x    |  4 ++--
 man/curs_ins_wstr.3x   |  9 +++++----
 man/curs_insstr.3x     |  9 +++++----
 man/curs_instr.3x      |  9 +++++----
 man/curs_inwstr.3x     |  9 +++++----
 man/curs_printw.3x     |  8 +++++---
 man/curs_scanw.3x      |  8 +++++---
 man/ncurses.3x         |  8 +++++---
 24 files changed, 116 insertions(+), 102 deletions(-)

diff --git a/man/curs_add_wch.3x b/man/curs_add_wch.3x
index 401f1143d..4e25eba29 100644
--- a/man/curs_add_wch.3x
+++ b/man/curs_add_wch.3x
@@ -312,10 +312,11 @@ .SH RETURN VALUE
 or if it is not possible to add all of the resulting bytes in the window,
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 Note that
 \fBadd_wch\fP,
diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x
index db8d7aa81..667fb9fb3 100644
--- a/man/curs_add_wchstr.3x
+++ b/man/curs_add_wchstr.3x
@@ -109,10 +109,11 @@ .SH RETURN VALUE
 .bP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All functions except \fBwadd_wchnstr\fP may be macros.
 .SH PORTABILITY
diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x
index 85ebd15ec..9406d02c1 100644
--- a/man/curs_addchstr.3x
+++ b/man/curs_addchstr.3x
@@ -103,10 +103,11 @@ .SH RETURN VALUE
 .bP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All functions except \fBwaddchnstr\fP may be macros.
 .SH PORTABILITY
diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x
index ac9bd79ad..fbac6f880 100644
--- a/man/curs_addstr.3x
+++ b/man/curs_addstr.3x
@@ -114,14 +114,11 @@ .SH RETURN VALUE
 .bP
 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
-boundaries,
-or
-(for \*(``mvw\*('' functions)
-if the
-.I \%WINDOW
-pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All of these functions except \fBwaddnstr\fP may be macros.
 .SH PORTABILITY
diff --git a/man/curs_addwstr.3x b/man/curs_addwstr.3x
index cb6015f2e..4c4fac13c 100644
--- a/man/curs_addwstr.3x
+++ b/man/curs_addwstr.3x
@@ -124,14 +124,11 @@ .SH RETURN VALUE
 .bP
 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
-boundaries,
-or
-(for \*(``mvw\*('' functions)
-if the
-.I \%WINDOW
-pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All of these functions except
 .B waddnwstr
diff --git a/man/curs_attr.3x b/man/curs_attr.3x
index fedb3c8fb..87f1b2b4a 100644
--- a/man/curs_attr.3x
+++ b/man/curs_attr.3x
@@ -308,10 +308,10 @@ .SH RETURN VALUE
 does not return an error if either of the parameters of \fBwattr_get\fP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
 .\" ---------------------------------------------------------------------------
 .SH NOTES
 These functions may be macros:
diff --git a/man/curs_border.3x b/man/curs_border.3x
index d070194ec..58da932fe 100644
--- a/man/curs_border.3x
+++ b/man/curs_border.3x
@@ -145,10 +145,11 @@ .SH RETURN VALUE
 This implementation returns an error
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 The borders generated by these functions are \fIinside\fP borders (this
 is also true of SVr4 curses, though the fact is not documented).
diff --git a/man/curs_border_set.3x b/man/curs_border_set.3x
index 2e251e513..5e0d6e2e3 100644
--- a/man/curs_border_set.3x
+++ b/man/curs_border_set.3x
@@ -179,10 +179,11 @@ .SH RETURN VALUE
 .PP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 Note that
 \fBborder_set\fP,
diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index bfc94ba59..528b9c31d 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -190,14 +190,11 @@ .SH RETURN VALUE
 is set to
 .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
-boundaries,
-or
-(for \*(``mvw\*('' functions)
-if the
-.I win
-parameter is a null pointer.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .PP
 .B \%unget_wch
 returns
diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x
index c3413f9e0..a45129f5e 100644
--- a/man/curs_get_wstr.3x
+++ b/man/curs_get_wstr.3x
@@ -147,10 +147,11 @@ .SH RETURN VALUE
 \fBwget_wch\fP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 Any of these functions other than
 \fBwgetn_wstr\fP
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index 98725bd53..c7381a73c 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -436,9 +436,11 @@ .SH RETURN VALUE
 pointer argument fail if the pointer is
 .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
-boundaries.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .PP
 .B \%wgetch
 also fails if
diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x
index 1b0ab2b3d..993348817 100644
--- a/man/curs_getstr.3x
+++ b/man/curs_getstr.3x
@@ -149,10 +149,11 @@ .SH RETURN VALUE
 If a \fBSIGWINCH\fP interrupts the function, it will return \fBKEY_RESIZE\fP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 Any of these functions other than
 \fBwgetnstr\fP
diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x
index 60b7557a1..9b7d18343 100644
--- a/man/curs_in_wch.3x
+++ b/man/curs_in_wch.3x
@@ -66,10 +66,11 @@ .SH RETURN VALUE
 returning \fBERR\fP in that case.
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 Note that all of these routines may be macros.
 .SH PORTABILITY
diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index d533081c3..3ef06549c 100644
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -95,10 +95,11 @@ .SH RETURN VALUE
 .bP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All routines except \fBwin_wchnstr\fP may be macros.
 .PP
diff --git a/man/curs_inch.3x b/man/curs_inch.3x
index 8c03e5fec..fb21b556e 100644
--- a/man/curs_inch.3x
+++ b/man/curs_inch.3x
@@ -83,10 +83,11 @@ .SS Attributes
 A_COLOR        Extract color pair information
 .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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .PP
 The \fBwinch\fP function does not return an error if the window contains
 characters larger than 8-bits (255).
diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x
index f5c1b33a9..f3f4c2a5f 100644
--- a/man/curs_inchstr.3x
+++ b/man/curs_inchstr.3x
@@ -94,10 +94,11 @@ .SH RETURN VALUE
 .bP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All routines except \fBwinchnstr\fP may be macros.
 .PP
diff --git a/man/curs_ins_wch.3x b/man/curs_ins_wch.3x
index 4b36a1da8..c42bf12c4 100644
--- a/man/curs_ins_wch.3x
+++ b/man/curs_ins_wch.3x
@@ -75,8 +75,8 @@ .SH "RETURN VALUE"
 pointer argument fail if the pointer is
 .BR NULL .
 .PP
-Functions prefixed with \*(``mv\*('' first perform cursor movement using
-\fB\%wmove\fP and fail if the position
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
 .RI ( y ,
 .IR x )
 is outside the window boundaries.
diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x
index 3fc8c239e..90ba3d20a 100644
--- a/man/curs_ins_wstr.3x
+++ b/man/curs_ins_wstr.3x
@@ -98,10 +98,11 @@ .SH RETURN VALUE
 .bP
 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 boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All but \fBwins_nwstr\fP may be macros.
 .PP
diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x
index 9a778129a..4f80cec17 100644
--- a/man/curs_insstr.3x
+++ b/man/curs_insstr.3x
@@ -97,10 +97,11 @@ .SH RETURN VALUE
 .bP
 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 boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All but \fBwinsnstr\fP may be macros.
 .SH PORTABILITY
diff --git a/man/curs_instr.3x b/man/curs_instr.3x
index 708877948..c72e11693 100644
--- a/man/curs_instr.3x
+++ b/man/curs_instr.3x
@@ -89,10 +89,11 @@ .SH RETURN VALUE
 .bP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All routines except \fBwinnstr\fP may be macros.
 .PP
diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x
index 7683bc488..63c71aa2d 100644
--- a/man/curs_inwstr.3x
+++ b/man/curs_inwstr.3x
@@ -99,10 +99,11 @@ .SH RETURN VALUE
 .bP
 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
-boundaries,
-or if the window pointer is null.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 All routines except
 \fBwinnwstr\fP
diff --git a/man/curs_printw.3x b/man/curs_printw.3x
index 35ee0ac2c..9f20fee54 100644
--- a/man/curs_printw.3x
+++ b/man/curs_printw.3x
@@ -103,9 +103,11 @@ .SH RETURN VALUE
 .I win
 is null.
 .PP
-Functions with a \*(``mv\*('' prefix first perform a cursor movement
-using \fB\%wmove\fP,
-and fail if the position is outside the window boundaries.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+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 aa5534d4f..48e0e54e2 100644
--- a/man/curs_scanw.3x
+++ b/man/curs_scanw.3x
@@ -104,9 +104,11 @@ .SH RETURN VALUE
 .I win
 is null.
 .PP
-Functions with a \*(``mv\*('' prefix first perform a cursor movement
-using \fB\%wmove\fP,
-and fail if the position is outside the window boundaries.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 No wide character counterpart functions are defined by the
 \*(``wide\*(''
diff --git a/man/ncurses.3x b/man/ncurses.3x
index fc751df34..051167e8f 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -1046,9 +1046,11 @@ .SH RETURN VALUE
 Typically,
 .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
-boundaries.
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH ENVIRONMENT
 The following symbols from the process environment customize the
 runtime behavior of
-- 
2.30.2

signature.asc
Description: PGP signature