[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 113/177] man/curs_mouse.3x: Revise "RETURN VALUE" section.
From: |
G. Branden Robinson |
Subject: |
[PATCH 113/177] man/curs_mouse.3x: Revise "RETURN VALUE" section. |
Date: |
Mon, 13 Jan 2025 11:33:06 -0600 |
Style:
* Slightly recast.
Markup:
* Favor man(7) font style macros over *roff font selection escape
sequences, except for man page cross references (because
man/make_sed.sh recognizes only certain patterns when rewriting such
cross references) and terms in the "NAME" section (because the
generated edit_man.sh script expects font selection escape sequences
when scraping terms thence to gather names for man page aliases).
---
man/curs_mouse.3x | 41 ++++++++++++++++++++++++++++-------------
1 file changed, 28 insertions(+), 13 deletions(-)
diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x
index 27197a5e3..fcd88ec7a 100644
--- a/man/curs_mouse.3x
+++ b/man/curs_mouse.3x
@@ -394,39 +394,54 @@ .SS mouseinterval
when the corresponding screen is initialized,
e.g., in \fBinitscr\fP(3X) or \fBsetupterm\fP(3X).
.SH RETURN VALUE
-\fB\%has_mouse\fP,
-\fB\%wenclose\fP,
-\fB\%mouse_trafo\fP,
+.BR \%has_mouse ","
+.BR \%wenclose ","
+.BR \%mouse_trafo ","
and
-\fB\%wmouse_trafo\fP
-return \fBTRUE\fP or \fBFALSE\fP as noted above.
+.B \%wmouse_trafo
+return
+.B TRUE
+or
+.B FALSE
+as noted above.
.PP
-\fB\%getmouse\fP and \fB\%ungetmouse\fP
-return \fBERR\fP upon failure and \fBOK\fP upon success.
+.B \%getmouse
+and
+.B \%ungetmouse
+return
+.B ERR
+upon failure and
+.B OK
+upon success.
.PP
-\fB\%getmouse\fP fails if:
+.B \%getmouse
+fails if:
.bP
no mouse driver was initialized,
.bP
the mask of reportable events is zero,
.bP
a mouse event was detected that does not match the mask,
+or
.bP
-or if no more events remain in the queue.
+no more events remain in the queue.
.PP
-\fB\%ungetmouse\fP returns
+.B \%ungetmouse
+returns
.B ERR
if the event queue is full.
.PP
-\fB\%mousemask\fP
+.B \%mousemask
returns the mask of reportable events.
.PP
-\fB\%mouseinterval\fP
+.B \%mouseinterval
returns the previous interval value, unless
the terminal was not initialized.
In that case, it returns the maximum interval value (166).
.SH NOTES
-The order of the \fB\%MEVENT\fP structure members is not guaranteed.
+The order of the
+.B \%MEVENT
+structure members is not guaranteed.
Additional fields may be added to the structure in the future.
.PP
Under
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 113/177] man/curs_mouse.3x: Revise "RETURN VALUE" section.,
G. Branden Robinson <=