[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 54/61] Relocate "RETURN VALUE" section after "DESCRIPTION" in man
From: |
G. Branden Robinson |
Subject: |
[PATCH 54/61] Relocate "RETURN VALUE" section after "DESCRIPTION" in man pages. |
Date: |
Fri, 24 Nov 2023 12:10:36 -0600 |
* man/curs_getstr.3x:
* man/curs_get_wstr.3x: Do it.
---
man/curs_get_wstr.3x | 40 ++++++++++++++++++++--------------------
man/curs_getstr.3x | 42 +++++++++++++++++++++---------------------
2 files changed, 41 insertions(+), 41 deletions(-)
diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x
index 72a08dbc..62ffddb4 100644
--- a/man/curs_get_wstr.3x
+++ b/man/curs_get_wstr.3x
@@ -130,6 +130,26 @@ .SH DESCRIPTION
\fIn\fP
characters, letting the application prevent overflow of the
input buffer.
+.SH RETURN VALUE
+All of these functions return the integer \fBOK\fP upon successful completion.
+If unsuccessful, they return \fBERR\fP.
+.PP
+X/Open defines no error conditions.
+.PP
+In this implementation,
+these functions return an error
+.bP
+if the window pointer is null,
+.bP
+if its timeout expires without having any data, or
+.bP
+if the associated call to
+\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,
+or if the window pointer is null.
.SH NOTES
Any of these functions other than
\fBwgetn_wstr\fP
@@ -154,26 +174,6 @@ .SH NOTES
.PP
These functions cannot return \fBKEY_\fP values because there
is no way to distinguish a \fBKEY_\fP value from a valid \fBwchar_t\fP value.
-.SH RETURN VALUE
-All of these functions return the integer \fBOK\fP upon successful completion.
-If unsuccessful, they return \fBERR\fP.
-.PP
-X/Open defines no error conditions.
-.PP
-In this implementation,
-these functions return an error
-.bP
-if the window pointer is null,
-.bP
-if its timeout expires without having any data, or
-.bP
-if the associated call to
-\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,
-or if the window pointer is null.
.SH PORTABILITY
These functions are described in The Single Unix Specification, Version 2.
No error conditions are defined.
diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x
index 0aea21bf..6ca74127 100644
--- a/man/curs_getstr.3x
+++ b/man/curs_getstr.3x
@@ -127,27 +127,6 @@ .SH DESCRIPTION
\fIn\fP
characters, letting the application prevent overflow of the
input buffer.
-.SH NOTES
-Any of these functions other than
-\fBwgetnstr\fP
-may be macros.
-.PP
-Using
-\fBgetstr\fP,
-\fBmvgetstr\fP,
-\fBmvwgetstr\fP, or
-\fBwgetstr\fP
-to read a line that
-overflows the array pointed to by
-\fBstr\fP
-causes undefined
-results.
-The use of
-\fBgetnstr\fP,
-\fBmvgetnstr\fP,
-\fBmvwgetnstr\fP, or
-\fBwgetnstr\fP,
-respectively, is recommended.
.SH RETURN VALUE
All of these functions return the integer \fBOK\fP upon successful completion.
(SVr4 specifies only \*(``an integer value other than \fBERR\fP\*('')
@@ -173,6 +152,27 @@ .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,
or if the window pointer is null.
+.SH NOTES
+Any of these functions other than
+\fBwgetnstr\fP
+may be macros.
+.PP
+Using
+\fBgetstr\fP,
+\fBmvgetstr\fP,
+\fBmvwgetstr\fP, or
+\fBwgetstr\fP
+to read a line that
+overflows the array pointed to by
+\fBstr\fP
+causes undefined
+results.
+The use of
+\fBgetnstr\fP,
+\fBmvgetnstr\fP,
+\fBmvwgetnstr\fP, or
+\fBwgetnstr\fP,
+respectively, is recommended.
.SH PORTABILITY
These functions are described in The Single Unix Specification, Version 2.
No error conditions are defined.
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 54/61] Relocate "RETURN VALUE" section after "DESCRIPTION" in man pages.,
G. Branden Robinson <=