[PATCH 114/177] man/curs_mouse.3x: Revise "NOTES" section.

[G. Branden Robinson]

Content:
* Use the word "capability" when discussing them.

Style:
* Favor present tense over future.
* Favor active voice over passive.
* Bracket code displays with `EX` and `EE` macros.[1]

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).

[1] groff_man(7):

     .EX
     .EE    Begin and end example.  After .EX, filling is disabled (and,
            on typesetters, a monospaced font family is selected).
            Calling .EE enables filling (and restores the previous
            family).

            .EX and .EE are extensions introduced in Ninth Edition Unix.
            Documenter’s Workbench, Heirloom Doctools, and Plan 9
            troffs, and mandoc (since 1.12.2) also support them.
            Solaris troff does not.  See subsection “Use of extensions”
            in groff_man_style(7).
---
 man/curs_mouse.3x | 59 +++++++++++++++++++++++++++++++++--------------
 1 file changed, 42 insertions(+), 17 deletions(-)

diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x
index fcd88ec7a..f690253bc 100644
--- a/man/curs_mouse.3x
+++ b/man/curs_mouse.3x
@@ -460,41 +460,66 @@ .SH NOTES
 .RE
 .PP
 If you are using an unsupported configuration,
-mouse events will not be visible to
-\fI\%ncurses\fP (and the \fB\%mousemask\fP function will always
-return \fB0\fP).
+mouse events are not visible to
+.I \%ncurses
+(and the
+.B \%mousemask
+function always returns
+.BR 0 ")."
 .PP
-If the
+If the terminal type possesses the (nonstandard)
 .I \%term\%info
-entry contains a \fBXM\fP string,
-this is used in the
+string capability
+.BR XM ","
+.IR \%ncurses "'s"
 .I \%xterm
-mouse driver to control the
-way the terminal is initialized for mouse operation.
-The default, if \fBXM\fP is not found,
+mouse driver uses it when initializing the terminal for mouse operation.
+The default,
+if
+.B XM
+is not found,
 corresponds to private mode 1000 of
-.I \%xterm:
+.IR \%xterm "."
 .PP
 .RS 3
+.EX
 \eE[?1000%?%p1%{1}%=%th%el%;
+.EE
 .RE
 .PP
-The mouse driver also recognizes a newer
-.I \%xterm
-private mode 1006,
-e.g.,
+.I \%ncurses
+also recognizes
+.IR \%xterm 's
+newer private mode 1006.
 .PP
 .RS 3
+.EX
 \eE[?1006;1000%?%p1%{1}%=%th%el%;
+.EE
 .RE
 .PP
-The \fIz\fP member in the event structure is not presently used.
+The
+.I id
+member of the mouse event structure is not presently used;
+no terminal type or operating system interface supports reporting events
+from distinguishable pointing devices.
+If you synthesize an
+.IR \%MEVENT ","
+use an
+.I id
+of 0.
+.PP
+The
+.I z
+member of the mouse event structure is not presently used.
 It is intended
 for use with touch screens (which may be pressure-sensitive) or with
 3D-mice/trackballs/power gloves.
 .PP
-The \fB\%ALL_MOUSE_EVENTS\fP class does not
-include \fB\%REPORT_MOUSE_POSITION\fP.
+The
+.B \%ALL_MOUSE_EVENTS
+class does not include
+.BR \%REPORT_MOUSE_POSITION "."
 They are distinct.
 For example,
 in
-- 
2.30.2

signature.asc
Description: PGP signature