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.16 by root, Sun Jan 8 06:35:38 2006 UTC vs.
Revision 1.18 by root, Mon Jan 9 07:17:24 2006 UTC

… …
103</dd> 103</dd>
104<p></p></dl> 104<p></p></dl>
105<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> 105<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
106</dt> 106</dt>
107<dd> 107<dd>
108Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at 108Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
109runtime. 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.
110</dd> 117</dd>
111<p></p> 118<p></p>
112<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 />
113</dt> 120</dt>
114<dd> 121<dd>
… …
269<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,
270$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
271number of lines that will be in the scrollback buffer.</p> 278number of lines that will be in the scrollback buffer.</p>
272</dd> 279</dd>
273<p></p> 280<p></p>
274<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
275</dt>
276<dd>
277Called whenever the <code>program(s)</code> running in the urxvt window send output.
278</dd>
279<p></p>
280<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 />
281</dt> 282</dt>
282<dd> 283<dd>
283Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = 284Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
284operating system command) is processed. Cursor position and other state 285operating system command) is processed. Cursor position and other state
… …
430that calls this function. 431that calls this function.
431</dd> 432</dd>
432<dd> 433<dd>
433<p>Using this function has the advantage that its output ends up in the 434<p>Using this function has the advantage that its output ends up in the
434correct place, e.g. on stderr of the connecting urxvtc client.</p> 435correct place, e.g. on stderr of the connecting urxvtc client.</p>
436</dd>
437<p></p>
438<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
439</dt>
440<dd>
441Returns true when it is safe to do potentially unsafe things, such as
442evaluating perl code specified by the user. This is true when urxvt was
443started setuid or setgid.
435</dd> 444</dd>
436<p></p> 445<p></p>
437<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 446<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
438</dt> 447</dt>
439<dd> 448<dd>
… …
848<p>You have to obey this encoding when changing text. The advantage is 857<p>You have to obey this encoding when changing text. The advantage is
849that <code>substr</code> and similar functions work on screen cells and not on 858that <code>substr</code> and similar functions work on screen cells and not on
850characters.</p> 859characters.</p>
851</dd> 860</dd>
852<dd> 861<dd>
853<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 862<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>
854can be used to convert normal strings into this encoding and vice versa.</p> 863can be used to convert normal strings into this encoding and vice versa.</p>
855</dd> 864</dd>
856<p></p> 865<p></p>
857<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 866<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
858</dt> 867</dt>
… …
930</dt> 939</dt>
931<dd> 940<dd>
932Translates a string offset into terminal coordinates again. 941Translates a string offset into terminal coordinates again.
933</dd> 942</dd>
934<p></p></dl> 943<p></p></dl>
935<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 944<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
936=item $text = $term-&gt;special_encode $string</strong><br />
937</dt> 945</dt>
938<dd> 946<dd>
939Converts a perl string into the special encoding used by rxvt-unicode, 947Converts a perl string into the special encoding used by rxvt-unicode,
940where one character corresponds to one screen cell. See 948where one character corresponds to one screen cell. See
941<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 949<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
944<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 952<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
945</dt> 953</dt>
946<dd> 954<dd>
947Converts rxvt-unicodes text reprsentation into a perl string. See 955Converts rxvt-unicodes text reprsentation into a perl string. See
948<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 956<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
957</dd>
958<p></p>
959<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
960</dt>
961<dd>
962Registers a synchronous button grab. See the XGrabButton manpage.
963</dd>
964<p></p>
965<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
966</dt>
967<dd>
968Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
969synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
970</dd>
971<p></p>
972<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
973</dt>
974<dd>
975Calls XAllowEvents with AsyncBoth for the most recent grab.
976</dd>
977<p></p>
978<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
979</dt>
980<dd>
981Calls XAllowEvents with SyncBoth for the most recent grab.
982</dd>
983<p></p>
984<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
985</dt>
986<dd>
987Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
988recent grab.
989</dd>
990<p></p>
991<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
992</dt>
993<dd>
994Calls XUngrab for the most recent grab. Is called automatically on
995evaluation errors, as it is better to lose the grab in the error case as
996the session.
949</dd> 997</dd>
950<p></p></dl> 998<p></p></dl>
951<p> 999<p>
952</p> 1000</p>
953<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1001<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
… …
1081</p> 1129</p>
1082<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1130<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1083<p>This variable controls the verbosity level of the perl extension. Higher 1131<p>This variable controls the verbosity level of the perl extension. Higher
1084numbers indicate more verbose output.</p> 1132numbers indicate more verbose output.</p>
1085<dl> 1133<dl>
1086<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1134<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1087</dt> 1135</dt>
1088<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1136<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1089</dt> 1137</dt>
1090<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1138<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1091</dt> 1139</dt>
1092</dl> 1140</dl>
1093<p> 1141<p>
1094</p> 1142</p>
1095<hr /> 1143<hr />

Diff Legend

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