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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.15 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.17 by root, Mon Jan 9 01:36:56 2006 UTC

… …
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 21 <li><a href="#general_api_considerations">General API Considerations</a></li>
22 <li><a href="#hooks">Hooks</a></li> 22 <li><a href="#hooks">Hooks</a></li>
23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> 23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
25 <li><a href="#rendition">RENDITION</a></li> 25 <li><a href="#rendition">RENDITION</a></li>
26 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 27 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
27 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 28 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
28 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 29 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
29 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 30 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
30 </ul> 31 </ul>
… …
77find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
78<p>You can activate them like this:</p> 79<p>You can activate them like this:</p>
79<pre> 80<pre>
80 rxvt -pe &lt;extensionname&gt;</pre> 81 rxvt -pe &lt;extensionname&gt;</pre>
81<dl> 82<dl>
82<dt><strong><a name="item_selection">selection</a></strong><br /> 83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
83</dt> 84</dt>
84<dd> 85<dd>
85Intelligent selection. This extension tries to be more intelligent when 86Intelligent selection. This extension tries to be more intelligent when
86the user extends selections (double-click). Right now, it tries to select 87the user extends selections (double-click). Right now, it tries to select
87urls and complete shell-quoted arguments, which is very convenient, too, 88urls and complete shell-quoted arguments, which is very convenient, too,
… …
99<dd> 100<dd>
100<pre> 101<pre>
101 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 102 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
102</dd> 103</dd>
103<p></p></dl> 104<p></p></dl>
105<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
106</dt>
107<dd>
108Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
109runtime.
110</dd>
111<p></p>
112<dt><strong>selection-popup (enabled by default)</strong><br />
113</dt>
114<dd>
115Binds a popup menu to Ctrl-Button3 that lets you convert the selection
116text into various other formats/action.
117</dd>
118<p></p>
104<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 119<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
105</dt> 120</dt>
106<dd> 121<dd>
107Displays a digital clock using the built-in overlay. 122Displays a digital clock using the built-in overlay.
108</dd> 123</dd>
… …
261<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 276<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
262$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 277$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
263number of lines that will be in the scrollback buffer.</p> 278number of lines that will be in the scrollback buffer.</p>
264</dd> 279</dd>
265<p></p> 280<p></p>
266<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
267</dt>
268<dd>
269Called whenever the <code>program(s)</code> running in the urxvt window send output.
270</dd>
271<p></p>
272<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 281<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
273</dt> 282</dt>
274<dd> 283<dd>
275Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = 284Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
276operating system command) is processed. Cursor position and other state 285operating system command) is processed. Cursor position and other state
… …
437<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 446<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
438Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 447Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
439Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 448Button4Mask, Button5Mask, AnyModifier</a></strong><br />
440</dt> 449</dt>
441<dd> 450<dd>
442Various constants for use in X events. 451Various constants for use in X calls and event processing.
443</dd> 452</dd>
444<p></p></dl> 453<p></p></dl>
445<p> 454<p>
446</p> 455</p>
447<h2><a name="rendition">RENDITION</a></h2> 456<h2><a name="rendition">RENDITION</a></h2>
… …
502</dt> 511</dt>
503<dd> 512<dd>
504Change the custom value. 513Change the custom value.
505</dd> 514</dd>
506<p></p></dl> 515<p></p></dl>
516<p>
517</p>
518<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
519<p>The sole purpose of this class is to deliver an interface to the
520<code>AnyEvent</code> module - any module using it will work inside urxvt without
521further work. The only exception is that you cannot wait on condition
522variables, but non-blocking condvar use is ok. What this means is that you
523cannot use blocking APIs, but the non-blocking variant should work.</p>
507<p> 524<p>
508</p> 525</p>
509<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 526<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
510<dl> 527<dl>
511<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 528<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
… …
677</dt> 694</dt>
678<dd> 695<dd>
679If hidden, display the overlay again. 696If hidden, display the overlay again.
680</dd> 697</dd>
681<p></p></dl> 698<p></p></dl>
682<dt><strong><a name="item_popup">$popup = $term-&gt;popup ($event)</a></strong><br /> 699<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
683</dt> 700</dt>
684<dd> 701<dd>
685Creates a new <code>urxvt::popup</code> object that implements a popup menu. The 702Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
686<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, 703<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
687currently). 704currently).
… …
832<p>You have to obey this encoding when changing text. The advantage is 849<p>You have to obey this encoding when changing text. The advantage is
833that <code>substr</code> and similar functions work on screen cells and not on 850that <code>substr</code> and similar functions work on screen cells and not on
834characters.</p> 851characters.</p>
835</dd> 852</dd>
836<dd> 853<dd>
837<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 854<p>The methods <a href="#item_special_encode"><code>$term-&gt;special_encode</code></a> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
838can be used to convert normal strings into this encoding and vice versa.</p> 855can be used to convert normal strings into this encoding and vice versa.</p>
839</dd> 856</dd>
840<p></p> 857<p></p>
841<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 858<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
842</dt> 859</dt>
… …
914</dt> 931</dt>
915<dd> 932<dd>
916Translates a string offset into terminal coordinates again. 933Translates a string offset into terminal coordinates again.
917</dd> 934</dd>
918<p></p></dl> 935<p></p></dl>
919<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 936<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
920=item $text = $term-&gt;special_encode $string</strong><br />
921</dt> 937</dt>
922<dd> 938<dd>
923Converts a perl string into the special encoding used by rxvt-unicode, 939Converts a perl string into the special encoding used by rxvt-unicode,
924where one character corresponds to one screen cell. See 940where one character corresponds to one screen cell. See
925<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 941<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
928<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 944<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
929</dt> 945</dt>
930<dd> 946<dd>
931Converts rxvt-unicodes text reprsentation into a perl string. See 947Converts rxvt-unicodes text reprsentation into a perl string. See
932<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 948<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
949</dd>
950<p></p>
951<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
952</dt>
953<dd>
954Registers a synchronous button grab. See XGrabButton.
955</dd>
956<p></p>
957<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
958</dt>
959<dd>
960Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
961synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
962</dd>
963<p></p>
964<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
965</dt>
966<dd>
967Calls XAllowEvents with AsyncBoth for the most recent grab.
968</dd>
969<p></p>
970<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
971</dt>
972<dd>
973Calls XAllowEvents with SyncBoth for the most recent grab.
974</dd>
975<p></p>
976<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
977</dt>
978<dd>
979Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
980recent grab.
981</dd>
982<p></p>
983<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
984</dt>
985<dd>
986Calls XUngrab for the most recent grab. Is called automatically on
987evaluation errors, as it is better to lose the grab in the error case as
988the session.
933</dd> 989</dd>
934<p></p></dl> 990<p></p></dl>
935<p> 991<p>
936</p> 992</p>
937<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 993<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
… …
1065</p> 1121</p>
1066<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1122<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1067<p>This variable controls the verbosity level of the perl extension. Higher 1123<p>This variable controls the verbosity level of the perl extension. Higher
1068numbers indicate more verbose output.</p> 1124numbers indicate more verbose output.</p>
1069<dl> 1125<dl>
1070<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1126<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1071</dt> 1127</dt>
1072<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1128<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1073</dt> 1129</dt>
1074<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1130<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1075</dt> 1131</dt>
1076</dl> 1132</dl>
1077<p> 1133<p>
1078</p> 1134</p>
1079<hr /> 1135<hr />

Diff Legend

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