X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fuser_caps.5.html;h=3c3a90243221945c0b1e3169f8b30a230652d8f4;hp=7e6101d39e0c605263c7140acb122925ef7993eb;hb=c55d387cebf1cee4757ca2c2ef4fbeae59ee4175;hpb=96a4663880a73a00b11700da8a404fdd56833925
diff --git a/doc/html/man/user_caps.5.html b/doc/html/man/user_caps.5.html
index 7e6101d3..3c3a9024 100644
--- a/doc/html/man/user_caps.5.html
+++ b/doc/html/man/user_caps.5.html
@@ -1,6 +1,6 @@
@@ -237,6 +237,72 @@
XM string, override ncurses's built-in string which enables/disables
xterm mouse mode.
+ ncurses sends a character sequence to the terminal to initialize
+ mouse mode, and when the user clicks the mouse buttons or (in
+ certain modes) moves the mouse, handles the characters sent back
+ by the terminal to tell it what was done with the mouse.
+
+ The mouse protocol is enabled when the mask passed in the mouse-
+ mask function is nonzero. By default, ncurses handles the
+ responses for the X11 xterm mouse protocol. It also knows about
+ the SGR 1006 xterm mouse protocol, but must to be told to look
+ for this specifically. It will not be able to guess which mode
+ is used, because the responses are enough alike that only confu-
+ sion would result.
+
+ The XM capability has a single parameter. If nonzero, the mouse
+ protocol should be enabled. If zero, the mouse protocol should
+ be disabled. ncurses inspects this capability if it is present,
+ to see whether the 1006 protocol is used. If so, it expects the
+ responses to use the SGR 1006 xterm mouse protocol.
+
+ The xterm mouse protocol is used by other terminal emulators.
+ The terminal database uses building-blocks for the various xterm
+ mouse protocols which can be used in customized terminal descrip-
+ tions.
+
+ The terminal database building blocks for this mouse feature also
+ have an experimental capability xm. The "xm" capability
+ describes the mouse response. Currently there is no interpreter
+ which would use this information to make the mouse support com-
+ pletely data-driven.
+
+ xm shows the format of the mouse responses. In this experimental
+ capability, the parameters are
+
+ p1 y-ordinate
+
+ p2 x-ordinate
+
+ p3 button
+
+ p4 state, e.g., pressed or released
+
+ p5 y-ordinate starting region
+
+ p6 x-ordinate starting region
+
+ p7 y-ordinate ending region
+
+ p8 x-ordinate ending region
+
+ Here are examples from the terminal database for the most com-
+ monly used xterm mouse protocols:
+
+ xterm+x11mouse|X11 xterm mouse protocol,
+ kmous=\E[M, XM=\E[?1000%?%p1%{1}%=%th%el%;,
+ xm=\E[M
+ %?%p4%t%p3%e%{3}%;%' '%+%c
+ %p2%'!'%+%c
+ %p1%'!'%+%c,
+
+ xterm+sm+1006|xterm SGR-mouse,
+ kmous=\E[<, XM=\E[?1006;1000%?%p1%{1}%=%th%el%;,
+ xm=\E[<%i%p3%d;
+ %p1%d;
+ %p2%d;
+ %?%p4%tM%em%;,
+
Several terminals provide the ability to send distinct strings for com-