Content: * Clarify that the mouse procotol supported by the terminal determines which event types are reportable. * Say that events are "removed" from the queue, not "pop[ped]"; the queue is not a stack.
Style: * Favor active voice over passive. --- man/curs_mouse.3x | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x index e1dfa3a94..50c45b687 100644 --- a/man/curs_mouse.3x +++ b/man/curs_mouse.3x @@ -147,7 +147,8 @@ .SS mousemask .bP The function returns an updated copy of .I new-mask -indicating which of the specified mouse events can be reported. +indicating which event types of interest +are reportable by the terminal's mouse protocol. .IP If the screen is not initialized, or the terminal interface does not report mouse events, @@ -218,11 +219,11 @@ .SS "Mouse Events" _ .TE .SS getmouse -Once a class of mouse events has been made visible in a window, +When a window is configured to report a non-empty set of event types, calling the input character reading function on that window may return .B \%KEY_MOUSE -as an indicator that a mouse event is enqueued. -To read the event data and pop the event off the queue, +to indicate availability of an enqueued mouse event. +To read the event data and remove it from the queue, call .BR \%getmouse "," which returns -- 2.30.2
signature.asc
Description: PGP signature
