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.13 by root, Wed Jan 4 21:37:55 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>
28 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
27 <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>
28 <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>
29 </ul> 31 </ul>
30 32
31 <li><a href="#environment">ENVIRONMENT</a></li> 33 <li><a href="#environment">ENVIRONMENT</a></li>
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 63 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 64<p>
63</p> 65</p>
64<hr /> 66<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 67<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 68<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 69the <code>perl</code> resource are loaded and associated with it.</p>
68<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 70<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 71thus must be encoded as UTF-8.</p>
70<p>Each script will only ever be loaded once, even in rxvtd, where 72<p>Each script will only ever be loaded once, even in rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p> 73scripts will be shared (but not enabled) for all terminals.</p>
72<p> 74<p>
… …
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 79<p>You can activate them like this:</p>
78<pre> 80<pre>
79 rxvt -pe &lt;extensionname&gt;</pre> 81 rxvt -pe &lt;extensionname&gt;</pre>
80<dl> 82<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 84</dt>
83<dd> 85<dd>
84Intelligent selection. This extension tries to be more intelligent when 86Intelligent selection. This extension tries to be more intelligent when
85the user extends selections (double-click). Right now, it tries to select 87the user extends selections (double-click). Right now, it tries to select
86urls and complete shell-quoted arguments, which is very convenient, too, 88urls and complete shell-quoted arguments, which is very convenient, too,
… …
98<dd> 100<dd>
99<pre> 101<pre>
100 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 102 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
101</dd> 103</dd>
102<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>
103<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 />
104</dt> 120</dt>
105<dd> 121<dd>
106Displays a digital clock using the built-in overlay. 122Displays a digital clock using the built-in overlay.
123</dd>
124<p></p>
125<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
126</dt>
127<dd>
128Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
129</dd>
130<p></p>
131<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
132</dt>
133<dd>
134A not very useful example of filtering all text output to the terminal,
135by replacing all line-drawing characters (U+2500 .. U+259F) by a
136similar-looking ascii character.
107</dd> 137</dd>
108<p></p> 138<p></p>
109<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 139<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
110</dt> 140</dt>
111<dd> 141<dd>
… …
124modified).</p> 154modified).</p>
125<p>When objects are destroyed on the C++ side, the perl object hashes are 155<p>When objects are destroyed on the C++ side, the perl object hashes are
126emptied, so its best to store related objects such as time watchers and 156emptied, so its best to store related objects such as time watchers and
127the like inside the terminal object so they get destroyed as soon as the 157the like inside the terminal object so they get destroyed as soon as the
128terminal is destroyed.</p> 158terminal is destroyed.</p>
159<p>Argument names also often indicate the type of a parameter. Here are some
160hints on what they mean:</p>
161<dl>
162<dt><strong><a name="item__24text">$text</a></strong><br />
163</dt>
164<dd>
165Rxvt-unicodes special way of encoding text, where one ``unicode'' character
166always represents one screen cell. See <em>row_t</em> for a discussion of this format.
167</dd>
168<p></p>
169<dt><strong><a name="item__24string">$string</a></strong><br />
170</dt>
171<dd>
172A perl text string, with an emphasis on <em>text</em>. It can store all unicode
173characters and is to be distinguished with text encoded in a specific
174encoding (often locale-specific) and binary data.
175</dd>
176<p></p>
177<dt><strong><a name="item__24octets">$octets</a></strong><br />
178</dt>
179<dd>
180Either binary data or - more common - a text string encoded in a
181locale-specific way.
182</dd>
183<p></p></dl>
129<p> 184<p>
130</p> 185</p>
131<h2><a name="hooks">Hooks</a></h2> 186<h2><a name="hooks">Hooks</a></h2>
132<p>The following subroutines can be declared in loaded scripts, and will be 187<p>The following subroutines can be declared in extension files, and will be
133called whenever the relevant event happens.</p> 188called whenever the relevant event happens.</p>
134<p>The first argument passed to them is an object private to each terminal 189<p>The first argument passed to them is an object private to each terminal
135and extension package. You can call all <code>urxvt::term</code> methods on it, but 190and extension package. You can call all <code>urxvt::term</code> methods on it, but
136its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> 191its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
137object that is shared between all packages is stored in the <code>term</code> 192object that is shared between all packages is stored in the <code>term</code>
138member.</p> 193member. It is, however, blessed intot he package of the extension script,
194so for all practical purposes you can treat an extension script as a class.</p>
139<p>All of them must return a boolean value. If it is true, then the event 195<p>All of them must return a boolean value. If it is true, then the event
140counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 196counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
141and the relevant action might not be carried out by the C++ code.</p> 197and the relevant action might not be carried out by the C++ code.</p>
142<p>When in doubt, return a false value (preferably <code>()</code>).</p> 198<p>When in doubt, return a false value (preferably <code>()</code>).</p>
143<dl> 199<dl>
144<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 200<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
145</dt> 201</dt>
146<dd> 202<dd>
147Called after a new terminal object has been initialized, but before 203Called after a new terminal object has been initialized, but before
148windows are created or the command gets run. 204windows are created or the command gets run. Most methods are unsafe to
205call or deliver senseless data, as terminal size and other characteristics
206have not yet been determined. You can safely query and change resources,
207though.
149</dd> 208</dd>
150<p></p> 209<p></p>
151<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 210<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
152</dt> 211</dt>
153<dd> 212<dd>
… …
196</dd> 255</dd>
197<dd> 256<dd>
198<p>See the <em>selection</em> example extension.</p> 257<p>See the <em>selection</em> example extension.</p>
199</dd> 258</dd>
200<p></p> 259<p></p>
201<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
202</dt>
203<dd>
204Called whenever the window gets the keyboard focus, before urxvt does
205focus in processing.
206</dd>
207<p></p>
208<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
209</dt>
210<dd>
211Called wheneever the window loses keyboard focus, before urxvt does focus
212out processing.
213</dd>
214<p></p>
215<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 260<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
216</dt> 261</dt>
217<dd> 262<dd>
218Called whenever the view offset changes, i..e the user or program 263Called whenever the view offset changes, i..e the user or program
219scrolls. Offset <code>0</code> means display the normal terminal, positive values 264scrolls. Offset <code>0</code> means display the normal terminal, positive values
… …
229</dd> 274</dd>
230<dd> 275<dd>
231<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,
232$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
233number of lines that will be in the scrollback buffer.</p> 278number of lines that will be in the scrollback buffer.</p>
234</dd>
235<p></p>
236<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
237</dt>
238<dd>
239Called whenever the <code>program(s)</code> running in the urxvt window send output.
240</dd> 279</dd>
241<p></p> 280<p></p>
242<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 />
243</dt> 282</dt>
244<dd> 283<dd>
… …
253<p>Be careful not ever to trust (in a security sense) the data you receive, 292<p>Be careful not ever to trust (in a security sense) the data you receive,
254as its source can not easily be controleld (e-mail content, messages from 293as its source can not easily be controleld (e-mail content, messages from
255other users on the same system etc.).</p> 294other users on the same system etc.).</p>
256</dd> 295</dd>
257<p></p> 296<p></p>
297<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
298</dt>
299<dd>
300Called whenever text is about to be output, with the text as argument. You
301can filter/change and output the text yourself by returning a true value
302and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
303might be very slow, however, as your hook is called for <strong>all</strong> text being
304output.
305</dd>
306<p></p>
307<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
308</dt>
309<dd>
310Called whenever a line was updated or changed. Can be used to filter
311screen output (e.g. underline urls or other useless stuff). Only lines
312that are being shown will be filtered, and, due to performance reasons,
313not always immediately.
314</dd>
315<dd>
316<p>The row number is always the topmost row of the line if the line spans
317multiple rows.</p>
318</dd>
319<dd>
320<p>Please note that, if you change the line, then the hook might get called
321later with the already-modified line (e.g. if unrelated parts change), so
322you cannot just toggle rendition bits, but only set them.</p>
323</dd>
324<p></p>
258<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 325<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
259</dt> 326</dt>
260<dd> 327<dd>
261Called just before the screen gets redrawn. Can be used for overlay 328Called just before the screen gets redrawn. Can be used for overlay
262or similar effects by modify terminal contents in refresh_begin, and 329or similar effects by modify terminal contents in refresh_begin, and
… …
275<dd> 342<dd>
276Called whenever the user presses a key combination that has a 343Called whenever the user presses a key combination that has a
277<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 344<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
278resource in the <code>rxvt(1)</code> manpage). 345resource in the <code>rxvt(1)</code> manpage).
279</dd> 346</dd>
347<p></p>
348<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
349</dt>
350<dd>
351Called whenever the window gets the keyboard focus, before rxvt-unicode
352does focus in processing.
353</dd>
354<p></p>
355<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
356</dt>
357<dd>
358Called wheneever the window loses keyboard focus, before rxvt-unicode does
359focus out processing.
360</dd>
361<p></p>
362<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br />
363</dt>
364<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br />
365</dt>
366<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
367</dt>
368<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
369</dt>
370<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
371</dt>
372<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
373</dt>
374<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
375</dt>
376<dd>
377Called whenever the corresponding X event is received for the terminal If
378the hook returns true, then the even will be ignored by rxvt-unicode.
379</dd>
380<dd>
381<p>The event is a hash with most values as named by Xlib (see the XEvent
382manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
383and column under the mouse cursor.</p>
384</dd>
385<dd>
386<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
387output, if any, in locale-specific encoding.</p>
388</dd>
389<dd>
390<p>subwindow.</p>
391</dd>
280<p></p></dl> 392<p></p></dl>
281<p> 393<p>
282</p> 394</p>
283<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 395<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
284<dl> 396<dl>
285<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 397<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
286</dt> 398</dt>
287<dd> 399<dd>
288The current terminal. Whenever a callback/Hook is bein executed, this 400The current terminal. This variable stores the current <code>urxvt::term</code>
289variable stores the current <code>urxvt::term</code> object. 401object, whenever a callback/hook is executing.
290</dd> 402</dd>
291<p></p></dl> 403<p></p></dl>
292<p> 404<p>
293</p> 405</p>
294<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 406<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
295<dl> 407<dl>
408<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
409</dt>
410<dd>
411Creates a new terminal, very similar as if you had started it with
412<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
413if the new instance couldn't be created. Returns <code>undef</code> if the new
414instance didn't initialise perl, and the terminal object otherwise. The
415<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
416</dd>
417<p></p>
296<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 418<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
297</dt> 419</dt>
298<dd> 420<dd>
299Fatally aborts execution with the given error message. Avoid at all 421Fatally aborts execution with the given error message. Avoid at all
300costs! The only time this is acceptable is when the terminal process 422costs! The only time this is acceptable is when the terminal process
… …
315<p></p> 437<p></p>
316<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 438<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
317</dt> 439</dt>
318<dd> 440<dd>
319Returns the ``current time'' (as per the event loop). 441Returns the ``current time'' (as per the event loop).
442</dd>
443<p></p>
444<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
445</dt>
446<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
447Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
448Button4Mask, Button5Mask, AnyModifier</a></strong><br />
449</dt>
450<dd>
451Various constants for use in X calls and event processing.
320</dd> 452</dd>
321<p></p></dl> 453<p></p></dl>
322<p> 454<p>
323</p> 455</p>
324<h2><a name="rendition">RENDITION</a></h2> 456<h2><a name="rendition">RENDITION</a></h2>
… …
381Change the custom value. 513Change the custom value.
382</dd> 514</dd>
383<p></p></dl> 515<p></p></dl>
384<p> 516<p>
385</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>
524<p>
525</p>
386<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>
387<dl> 527<dl>
528<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
529</dt>
530<dd>
531Destroy the terminal object (close the window, free resources etc.).
532</dd>
533<p></p>
534<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
535</dt>
536<dd>
537Returns true if the option specified by <code>$optval</code> is enabled, and
538optionally change it. All option values are stored by name in the hash
539<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
540</dd>
541<dd>
542<p>Here is a a likely non-exhaustive list of option names, please see the
543source file <em>/src/optinc.h</em> to see the actual list:</p>
544</dd>
545<dd>
546<pre>
547 borderLess console cursorBlink cursorUnderline hold iconic insecure
548 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
549 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
550 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
551 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
552 tripleclickwords utmpInhibit visualBell</pre>
553</dd>
554<p></p>
388<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 555<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
389</dt> 556</dt>
390<dd> 557<dd>
391Returns the current resource value associated with a given name and 558Returns the current resource value associated with a given name and
392optionally sets a new value. Setting values is most useful in the <code>init</code> 559optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
406<p>Please note that resource strings will currently only be freed when the 573<p>Please note that resource strings will currently only be freed when the
407terminal is destroyed, so changing options frequently will eat memory.</p> 574terminal is destroyed, so changing options frequently will eat memory.</p>
408</dd> 575</dd>
409<dd> 576<dd>
410<p>Here is a a likely non-exhaustive list of resource names, not all of which 577<p>Here is a a likely non-exhaustive list of resource names, not all of which
411are supported in every build, please see the source to see the actual 578are supported in every build, please see the source file <em>/src/rsinc.h</em>
412list:</p> 579to see the actual list:</p>
413</dd> 580</dd>
414<dd> 581<dd>
415<pre> 582<pre>
416 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 583 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
417 borderLess color cursorBlink cursorUnderline cutchars delete_key 584 borderLess color cursorBlink cursorUnderline cutchars delete_key
… …
425 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 592 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
426 shade term_name title transparent transparent_all tripleclickwords 593 shade term_name title transparent transparent_all tripleclickwords
427 utmpInhibit visualBell</pre> 594 utmpInhibit visualBell</pre>
428</dd> 595</dd>
429<p></p> 596<p></p>
430<dt><strong><a name="item_screen_rstyle">$rend = $term-&gt;screen_rstyle ([$new_rstyle])</a></strong><br /> 597<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
431</dt> 598</dt>
432<dd> 599<dd>
433Return and optionally change the current rendition. Text thta is output by 600Return and optionally change the current rendition. Text that is output by
434the temrianl application will use this style. 601the terminal application will use this style.
435</dd> 602</dd>
436<p></p> 603<p></p>
437<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br /> 604<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
438</dt> 605</dt>
439<dd> 606<dd>
… …
467<dd> 634<dd>
468<p>#=item $term-&gt;overlay ($x, $y, $text) 635<p>#=item $term-&gt;overlay ($x, $y, $text)
469# 636#
470#Create a simple multi-line overlay box. See the next method for details. 637#Create a simple multi-line overlay box. See the next method for details.
471# 638#
472#=cut</p> 639#=cut
473</dd> 640#
474<dd>
475<p>sub urxvt::term::scr_overlay { 641#sub urxvt::term::scr_overlay {
476die;
477 my ($self, $x, $y, $text) = @_;</p> 642# my ($self, $x, $y, $text) = @_;
478</dd> 643#
479<dd>
480<pre>
481 my @lines = split /\n/, $text;</pre> 644# my @lines = split /\n/, $text;
482</dd> 645#
483<dd>
484<pre>
485 my $w = 0; 646# my $w = 0;
486 for (map $self-&gt;strwidth ($_), @lines) { 647# for (map $self-&gt;strwidth ($_), @lines) {
487 $w = $_ if $w &lt; $_; 648# $w = $_ if $w &lt; $_;
488 }</pre> 649# }
489</dd> 650#
490<dd>
491<pre>
492 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines); 651# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
493 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 652# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
494}</pre> 653#}</p>
495</dd> 654</dd>
496<p></p> 655<p></p>
497<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 656<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
498</dt> 657</dt>
499<dd> 658<dd>
… …
535</dt> 694</dt>
536<dd> 695<dd>
537If hidden, display the overlay again. 696If hidden, display the overlay again.
538</dd> 697</dd>
539<p></p></dl> 698<p></p></dl>
699<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
700</dt>
701<dd>
702Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
703<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
704currently).
705</dd>
706<p></p>
540<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 707<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
541</dt> 708</dt>
542<dd> 709<dd>
543Returns the number of screen-cells this string would need. Correctly 710Returns the number of screen-cells this string would need. Correctly
544accounts for wide and combining characters. 711accounts for wide and combining characters.
545</dd> 712</dd>
546<p></p> 713<p></p>
547<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 714<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
548</dt> 715</dt>
549<dd> 716<dd>
550Convert the given text string into the corresponding locale encoding. 717Convert the given text string into the corresponding locale encoding.
551</dd> 718</dd>
552<p></p> 719<p></p>
553<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 720<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
554</dt> 721</dt>
555<dd> 722<dd>
556Convert the given locale-encoded octets into a perl string. 723Convert the given locale-encoded octets into a perl string.
724</dd>
725<p></p>
726<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
727</dt>
728<dd>
729Write the given text string to the screen, as if output by the application
730running inside the terminal. It may not contain command sequences (escape
731codes), but is free to use line feeds, carriage returns and tabs. The
732string is a normal text string, not in locale-dependent encoding.
733</dd>
734<dd>
735<p>Normally its not a good idea to use this function, as programs might be
736confused by changes in cursor position or scrolling. Its useful inside a
737<code>on_add_lines</code> hook, though.</p>
738</dd>
739<p></p>
740<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
741</dt>
742<dd>
743Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
744locale-specific encoding of the terminal and can contain command sequences
745(escape codes) that will be interpreted.
557</dd> 746</dd>
558<p></p> 747<p></p>
559<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 748<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
560</dt> 749</dt>
561<dd> 750<dd>
562Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 751Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
563pass characters instead of octets, you should convert your strings first 752pass characters instead of octets, you should convert your strings first
564to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 753to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
565</dd> 754</dd>
566<p></p> 755<p></p>
756<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
757</dt>
758<dd>
759Return the window id of the toplevel window.
760</dd>
761<p></p>
762<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
763</dt>
764<dd>
765Return the window id of the terminal window.
766</dd>
767<p></p>
567<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 768<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
568</dt> 769</dt>
569<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 770<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
570</dt> 771</dt>
571<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 772<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
588</dt> 789</dt>
589<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 790<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
590</dt> 791</dt>
591<dd> 792<dd>
592Return various integers describing terminal characteristics. 793Return various integers describing terminal characteristics.
794</dd>
795<p></p>
796<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
797</dt>
798<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
799</dt>
800<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
801</dt>
802<dd>
803Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
804AltGr), the meta key (often Alt) and the num lock key, if applicable.
593</dd> 805</dd>
594<p></p> 806<p></p>
595<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 807<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
596</dt> 808</dt>
597<dd> 809<dd>
… …
625line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 837line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
626to replace only parts of a line. The font index in the rendition will 838to replace only parts of a line. The font index in the rendition will
627automatically be updated.</p> 839automatically be updated.</p>
628</dd> 840</dd>
629<dd> 841<dd>
630<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 842<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
631than one cell when displayed are padded with urxvt::NOCHAR characters 843than one cell when displayed are padded with urxvt::NOCHAR characters
632(<code>chr 65535</code>). Characters with combining characters and other characters 844(<code>chr 65535</code>). Characters with combining characters and other characters
633that do not fit into the normal tetx encoding will be replaced with 845that do not fit into the normal tetx encoding will be replaced with
634characters in the private use area.</p> 846characters in the private use area.</p>
635</dd> 847</dd>
… …
637<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
638that <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
639characters.</p> 851characters.</p>
640</dd> 852</dd>
641<dd> 853<dd>
642<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>
643can 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>
644</dd> 856</dd>
645<p></p> 857<p></p>
646<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 />
647</dt> 859</dt>
… …
680Create and return a new <code>urxvt::line</code> object that stores information 892Create and return a new <code>urxvt::line</code> object that stores information
681about the logical line that row <code>$row_number</code> is part of. It supports the 893about the logical line that row <code>$row_number</code> is part of. It supports the
682following methods: 894following methods:
683</dd> 895</dd>
684<dl> 896<dl>
685<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 897<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
686</dt> 898</dt>
687<dd> 899<dd>
688Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 900Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
689</dd> 901</dd>
690<p></p> 902<p></p>
691<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 903<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
692</dt> 904</dt>
693<dd> 905<dd>
694Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 906Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
695</dd> 907</dd>
696<p></p> 908<p></p>
697<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 909<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
698</dt> 910</dt>
699<dd> 911<dd>
… …
719</dt> 931</dt>
720<dd> 932<dd>
721Translates a string offset into terminal coordinates again. 933Translates a string offset into terminal coordinates again.
722</dd> 934</dd>
723<p></p></dl> 935<p></p></dl>
724<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 />
725=item $text = $term-&gt;special_encode $string</strong><br />
726</dt> 937</dt>
727<dd> 938<dd>
728Converts a perl string into the special encoding used by rxvt-unicode, 939Converts a perl string into the special encoding used by rxvt-unicode,
729where one character corresponds to one screen cell. See 940where one character corresponds to one screen cell. See
730<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.
… …
734</dt> 945</dt>
735<dd> 946<dd>
736Converts rxvt-unicodes text reprsentation into a perl string. See 947Converts rxvt-unicodes text reprsentation into a perl string. See
737<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.
738</dd> 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.
989</dd>
739<p></p></dl> 990<p></p></dl>
991<p>
992</p>
993<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
740<p> 994<p>
741</p> 995</p>
742<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 996<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
743<p>This class implements timer watchers/events. Time is represented as a 997<p>This class implements timer watchers/events. Time is represented as a
744fractional number of seconds since the epoch. Example:</p> 998fractional number of seconds since the epoch. Example:</p>
… …
867</p> 1121</p>
868<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1122<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
869<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
870numbers indicate more verbose output.</p> 1124numbers indicate more verbose output.</p>
871<dl> 1125<dl>
872<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 />
873</dt> 1127</dt>
874<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 />
875</dt> 1129</dt>
876<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 />
877</dt> 1131</dt>
878</dl> 1132</dl>
879<p> 1133<p>
880</p> 1134</p>
881<hr /> 1135<hr />

Diff Legend

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