ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.247 by root, Sat Aug 8 23:39:25 2020 UTC vs.
Revision 1.248 by sf-exg, Fri May 7 19:03:11 2021 UTC

… …
1959Unlike XTerm, coordinates larger than 2015 will work fine. 1959Unlike XTerm, coordinates larger than 2015 will work fine.
1960 1960
1961=begin table 1961=begin table
1962 1962
1963 B<< C<h> >> Enable mouse coordinates in locale-specific encoding. 1963 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1964 B<< C<l> >> Enable mouse coordinates as binary octets. 1964 B<< C<l> >> Disable mouse coordinates in locale-specific encoding.
1965
1966=end table
1967
1968=item B<< C<Pm = 1006> >> (X11 XTerm SGR mouse mode) (Compile frills)
1969
1970=begin table
1971
1972 B<< C<h> >> Enable xterm SGR mouse coordinate reporting.
1973 B<< C<l> >> Disable xterm SGR mouse coordinate reporting.
1965 1974
1966=end table 1975=end table
1967 1976
1968=item B<< C<Pm = 1010> >> (B<rxvt>) 1977=item B<< C<Pm = 1010> >> (B<rxvt>)
1969 1978
… …
1986=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills) 1995=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
1987 1996
1988=begin table 1997=begin table
1989 1998
1990 B<< C<h> >> Enable urxvt mouse coordinate reporting. 1999 B<< C<h> >> Enable urxvt mouse coordinate reporting.
1991 B<< C<l> >> Use old-style C<CSI M C C C> encoding. 2000 B<< C<l> >> Disable urxvt mouse coordinate reporting.
1992 2001
1993=end table 2002=end table
1994
1995Changes all mouse reporting codes to use decimal parameters instead of
1996octets or characters.
1997
1998This mode should be enabled I<before> actually enabling mouse reporting,
1999for semi-obvious reasons.
2000
2001The sequences received for various modes are as follows:
2002
2003 ESC [ M o o o !1005, !1015 (three octets)
2004 ESC [ M c c c 1005, !1015 (three characters)
2005 ESC [ Pm M 1015 (three or more numeric parameters)
2006
2007The first three parameters are C<code>, C<x> and C<y>. Code is the numeric
2008code as for the other modes (but encoded as a decimal number, including
2009the additional offset of 32, so you have to subtract 32 first), C<x> and
2010C<y> are the coordinates (1|1 is the upper left corner, just as with
2011cursor positioning).
2012
2013Example: Shift-Button-1 press at top row, column 80.
2014
2015 ESC [ 37 ; 80 ; 1 M
2016
2017One can use this feature by simply enabling it and then looking for
2018parameters to the C<ESC [ M> reply - if there are any, this mode is
2019active, otherwise one of the old reporting styles is used.
2020
2021Other (to be implemented) reply sequences will use a similar encoding.
2022
2023In the future, more parameters might get added (pixel coordinates for
2024example - anybody out there who needs this?).
2025 2003
2026=item B<< C<Pm = 1021> >> (B<rxvt>) 2004=item B<< C<Pm = 1021> >> (B<rxvt>)
2027 2005
2028=begin table 2006=begin table
2029 2007
… …
2127 2105
2128X<Mouse> 2106X<Mouse>
2129 2107
2130=head1 Mouse Reporting 2108=head1 Mouse Reporting
2131 2109
2110When mouse reporting is enabled and none of the extended mouse modes
2111(1005, 1006, 1015) is active, urxvt sends the following sequence on a
2112mouse event:
2113
2132=over 4 2114=over 4
2133 2115
2134=item B<< C<< ESC [ M <b> <x> <y> >> >> 2116=item B<< C<< ESC [ M <b> <x> <y> >> >>
2135
2136report mouse position
2137 2117
2138=back 2118=back
2139 2119
2140The lower 2 bits of B<< C<< <b> >> >> indicate the button: 2120The lower 2 bits of B<< C<< <b> >> >> indicate the button:
2141 2121
… …
2170 32 Double Click I<(rxvt extension)>, disabled by default 2150 32 Double Click I<(rxvt extension)>, disabled by default
2171 64 Button1 is actually Button4, Button2 is actually Button5 etc. 2151 64 Button1 is actually Button4, Button2 is actually Button5 etc.
2172 2152
2173=end table 2153=end table
2174 2154
2175Col = B<< C<< <x> - SPACE >> >>
2176
2177Row = B<< C<< <y> - SPACE >> >>
2178
2179=back 2155=back
2156
2157C<x> and C<y> encode the coordinates (1|1 is the upper left corner,
2158just as with cursor positioning):
2159
2160=over 4
2161
2162=item Col = B<< C<< <x> - SPACE >> >>
2163
2164=item Row = B<< C<< <y> - SPACE >> >>
2165
2166=back
2167
2168The parameters include an offset of 32 to ensure that they are
2169printable characters.
2170
2171Example: Shift-Button-1 press at top row, column 80.
2172
2173 ESC [ M $ p !
2174
2175The largest coordinate that can be represented in this encoding is
2176223. The range can be extended by using one of the extended mouse
2177modes, which should be enabled I<before> enabling mouse reporting, for
2178semi-obvious reasons.
2179
2180=head2 Mode 1005
2181
2182If mode 1005 is active, urxvt sends the sequence
2183
2184=over 4
2185
2186=item B<< C<< ESC [ M <b> <x> <y> >> >>
2187
2188=back
2189
2190with the coordinates provided as characters in locale-encoding instead
2191of 1 byte octets. This mode does not work sensibly in non-UTF-8
2192locales and should therefore be avoided.
2193
2194=head2 Mode 1006
2195
2196If mode 1006 is active, urxvt sends the following sequences:
2197
2198=over 4
2199
2200=item B<< C<< ESC [ < <b>;<x>;<y> M >> >>
2201
2202button press and motion
2203
2204=item B<< C<< ESC [ < <b>;<x>;<y> m >> >>
2205
2206button release
2207
2208=back
2209
2210where the parameters are provided as decimal numbers instead of
2211octets and do not include an offset of 32.
2212
2213The lower 2 bits of C<b> encode the button number also on button
2214release (instead of the value C<3>). The final character of the
2215sequence (M or m) specifies the event type (press/motion or release).
2216
2217Example: Shift-Button-1 press at top row, column 80.
2218
2219 ESC [ < 4 ; 80 ; 1 M
2220
2221=head2 Mode 1015
2222
2223If mode 1015 is active, urxvt sends the sequence
2224
2225=over 4
2226
2227=item B<< C<< ESC [ <b>;<x>;<y> M >> >>
2228
2229=back
2230
2231where the parameters are provided as decimal numbers instead of
2232octets and only C<b> includes an offset of 32.
2233
2234Example: Shift-Button-1 press at top row, column 80.
2235
2236 ESC [ 36 ; 80 ; 1 M
2180 2237
2181=head1 Key Codes 2238=head1 Key Codes
2182 2239
2183X<KeyCodes> 2240X<KeyCodes>
2184 2241
… …
2458 hold on exit (-hold) 2515 hold on exit (-hold)
2459 compile in built-in block graphics 2516 compile in built-in block graphics
2460 skip builtin block graphics (-sbg) 2517 skip builtin block graphics (-sbg)
2461 separate highlight colour (-highlightColor, -highlightTextColor) 2518 separate highlight colour (-highlightColor, -highlightTextColor)
2462 focus reporting mode (1004). 2519 focus reporting mode (1004).
2463 extended mouse reporting modes (1005 and 1015). 2520 extended mouse reporting modes (1005, 1006 and 1015).
2464 visual selection via -visual and -depth. 2521 visual selection via -visual and -depth.
2465 2522
2466It also enables some non-essential features otherwise disabled, such as: 2523It also enables some non-essential features otherwise disabled, such as:
2467 2524
2468 some round-trip time optimisations 2525 some round-trip time optimisations

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines