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.7 by root, Tue Jan 3 01:45:12 2006 UTC vs.
Revision 1.15 by root, Sun Jan 8 00:20:12 2006 UTC

… …
18 <ul> 18 <ul>
19 19
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> 20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
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="#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>
24 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 26 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
25 <li><a href="#rendition">RENDITION</a></li> 27 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
26 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 28 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
27 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 29 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
28 </ul> 30 </ul>
29 31
30 <li><a href="#environment">ENVIRONMENT</a></li> 32 <li><a href="#environment">ENVIRONMENT</a></li>
… …
60 rxvt --perl-lib $HOME -pe grab_test</pre> 62 rxvt --perl-lib $HOME -pe grab_test</pre>
61<p> 63<p>
62</p> 64</p>
63<hr /> 65<hr />
64<h1><a name="description">DESCRIPTION</a></h1> 66<h1><a name="description">DESCRIPTION</a></h1>
65<p>Everytime a terminal object gets created, scripts specified via the 67<p>Everytime a terminal object gets created, extension scripts specified via
66<code>perl</code> resource are loaded and associated with it.</p> 68the <code>perl</code> resource are loaded and associated with it.</p>
67<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 69<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
68thus must be encoded as UTF-8.</p> 70thus must be encoded as UTF-8.</p>
69<p>Each script will only ever be loaded once, even in rxvtd, where 71<p>Each script will only ever be loaded once, even in rxvtd, where
70scripts will be shared (but not enabled) for all terminals.</p> 72scripts will be shared (but not enabled) for all terminals.</p>
71<p> 73<p>
… …
78 rxvt -pe &lt;extensionname&gt;</pre> 80 rxvt -pe &lt;extensionname&gt;</pre>
79<dl> 81<dl>
80<dt><strong><a name="item_selection">selection</a></strong><br /> 82<dt><strong><a name="item_selection">selection</a></strong><br />
81</dt> 83</dt>
82<dd> 84<dd>
83Miscellaneous selection modifications. 85Intelligent selection. This extension tries to be more intelligent when
86the user extends selections (double-click). Right now, it tries to select
87urls and complete shell-quoted arguments, which is very convenient, too,
88if your <em>ls</em> supports <code>--quoting-style=shell</code>.
89</dd>
90<dd>
91<p>It also offers the following bindable event:</p>
84</dd> 92</dd>
85<dl> 93<dl>
86<dt><strong><a name="item_rot13">rot13</a></strong><br /> 94<dt><strong><a name="item_rot13">rot13</a></strong><br />
87</dt> 95</dt>
88<dd> 96<dd>
… …
92<pre> 100<pre>
93 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 101 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
94</dd> 102</dd>
95<p></p></dl> 103<p></p></dl>
96<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 104<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
105</dt>
106<dd>
107Displays a digital clock using the built-in overlay.
108</dd>
109<p></p>
110<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
111</dt>
112<dd>
113Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
114</dd>
115<p></p>
116<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
117</dt>
118<dd>
119A not very useful example of filtering all text output to the terminal,
120by replacing all line-drawing characters (U+2500 .. U+259F) by a
121similar-looking ascii character.
122</dd>
123<p></p>
124<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
97</dt> 125</dt>
98<dd> 126<dd>
99Displays a very simple digital clock in the upper right corner of the 127Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 128window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 129overlays or changes.
102</dd>
103<p></p>
104<dt><strong><a name="item_simple_2doverlay_2dclock">simple-overlay-clock</a></strong><br />
105</dt>
106<dd>
107Displays a digital clock using the built-in overlay (colorful, useless).
108</dd> 130</dd>
109<p></p></dl> 131<p></p></dl>
110<p> 132<p>
111</p> 133</p>
112<h2><a name="general_api_considerations">General API Considerations</a></h2> 134<h2><a name="general_api_considerations">General API Considerations</a></h2>
113<p>All objects (such as terminals, time watchers etc.) are typical 135<p>All objects (such as terminals, time watchers etc.) are typical
114reference-to-hash objects. The hash can be used to store anything you 136reference-to-hash objects. The hash can be used to store anything you
115like. All members starting with an underscore (such as <code>_ptr</code> or 137like. All members starting with an underscore (such as <code>_ptr</code> or
116<code>_hook</code>) are reserved for internal uses and must not be accessed or 138<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
117modified).</p> 139modified).</p>
118<p>When objects are destroyed on the C++ side, the perl object hashes are 140<p>When objects are destroyed on the C++ side, the perl object hashes are
119emptied, so its best to store related objects such as time watchers and 141emptied, so its best to store related objects such as time watchers and
120the like inside the terminal object so they get destroyed as soon as the 142the like inside the terminal object so they get destroyed as soon as the
121terminal is destroyed.</p> 143terminal is destroyed.</p>
144<p>Argument names also often indicate the type of a parameter. Here are some
145hints on what they mean:</p>
146<dl>
147<dt><strong><a name="item__24text">$text</a></strong><br />
148</dt>
149<dd>
150Rxvt-unicodes special way of encoding text, where one ``unicode'' character
151always represents one screen cell. See <em>row_t</em> for a discussion of this format.
152</dd>
153<p></p>
154<dt><strong><a name="item__24string">$string</a></strong><br />
155</dt>
156<dd>
157A perl text string, with an emphasis on <em>text</em>. It can store all unicode
158characters and is to be distinguished with text encoded in a specific
159encoding (often locale-specific) and binary data.
160</dd>
161<p></p>
162<dt><strong><a name="item__24octets">$octets</a></strong><br />
163</dt>
164<dd>
165Either binary data or - more common - a text string encoded in a
166locale-specific way.
167</dd>
168<p></p></dl>
122<p> 169<p>
123</p> 170</p>
124<h2><a name="hooks">Hooks</a></h2> 171<h2><a name="hooks">Hooks</a></h2>
125<p>The following subroutines can be declared in loaded scripts, and will be called 172<p>The following subroutines can be declared in extension files, and will be
126whenever the relevant event happens.</p> 173called whenever the relevant event happens.</p>
174<p>The first argument passed to them is an object private to each terminal
175and extension package. You can call all <code>urxvt::term</code> methods on it, but
176its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
177object that is shared between all packages is stored in the <code>term</code>
178member. It is, however, blessed intot he package of the extension script,
179so for all practical purposes you can treat an extension script as a class.</p>
127<p>All of them must return a boolean value. If it is true, then the event 180<p>All of them must return a boolean value. If it is true, then the event
128counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 181counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
129and the relevant action might not be carried out by the C++ code.</p> 182and the relevant action might not be carried out by the C++ code.</p>
130<p>When in doubt, return a false value (preferably <code>()</code>).</p> 183<p>When in doubt, return a false value (preferably <code>()</code>).</p>
131<dl> 184<dl>
132<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 185<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
133</dt> 186</dt>
134<dd> 187<dd>
135Called after a new terminal object has been initialized, but before 188Called after a new terminal object has been initialized, but before
136windows are created or the command gets run. 189windows are created or the command gets run. Most methods are unsafe to
190call or deliver senseless data, as terminal size and other characteristics
191have not yet been determined. You can safely query and change resources,
192though.
137</dd> 193</dd>
138<p></p> 194<p></p>
139<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 195<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
140</dt> 196</dt>
141<dd> 197<dd>
… …
172</dd> 228</dd>
173<dd> 229<dd>
174<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 230<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
175</dd> 231</dd>
176<p></p> 232<p></p>
177<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 233<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
178</dt> 234</dt>
179<dd>
180Called whenever the window gets the keyboard focus, before urxvt does
181focus in processing.
182</dd> 235<dd>
183<p></p> 236Called whenever the user tries to extend the selection (e.g. with a double
184<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 237click) and is either supposed to return false (normal operation), or
185</dt> 238should extend the selection itelf and return true to suppress the built-in
239processing.
186<dd> 240</dd>
187Called wheneever the window loses keyboard focus, before urxvt does focus 241<dd>
188out processing. 242<p>See the <em>selection</em> example extension.</p>
189</dd> 243</dd>
190<p></p> 244<p></p>
191<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 245<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
192</dt> 246</dt>
193<dd> 247<dd>
… …
211<p></p> 265<p></p>
212<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 266<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
213</dt> 267</dt>
214<dd> 268<dd>
215Called whenever the <code>program(s)</code> running in the urxvt window send output. 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 />
273</dt>
274<dd>
275Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
276operating system command) is processed. Cursor position and other state
277information is up-to-date when this happens. For interoperability, the
278string should start with the extension name and a colon, to distinguish
279it from commands for other extensions, and this might be enforced in the
280future.
281</dd>
282<dd>
283<p>Be careful not ever to trust (in a security sense) the data you receive,
284as its source can not easily be controleld (e-mail content, messages from
285other users on the same system etc.).</p>
286</dd>
287<p></p>
288<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
289</dt>
290<dd>
291Called whenever text is about to be output, with the text as argument. You
292can filter/change and output the text yourself by returning a true value
293and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
294might be very slow, however, as your hook is called for <strong>all</strong> text being
295output.
296</dd>
297<p></p>
298<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
299</dt>
300<dd>
301Called whenever a line was updated or changed. Can be used to filter
302screen output (e.g. underline urls or other useless stuff). Only lines
303that are being shown will be filtered, and, due to performance reasons,
304not always immediately.
305</dd>
306<dd>
307<p>The row number is always the topmost row of the line if the line spans
308multiple rows.</p>
309</dd>
310<dd>
311<p>Please note that, if you change the line, then the hook might get called
312later with the already-modified line (e.g. if unrelated parts change), so
313you cannot just toggle rendition bits, but only set them.</p>
216</dd> 314</dd>
217<p></p> 315<p></p>
218<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 316<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
219</dt> 317</dt>
220<dd> 318<dd>
… …
235<dd> 333<dd>
236Called whenever the user presses a key combination that has a 334Called whenever the user presses a key combination that has a
237<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 335<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
238resource in the <code>rxvt(1)</code> manpage). 336resource in the <code>rxvt(1)</code> manpage).
239</dd> 337</dd>
338<p></p>
339<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
340</dt>
341<dd>
342Called whenever the window gets the keyboard focus, before rxvt-unicode
343does focus in processing.
344</dd>
345<p></p>
346<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
347</dt>
348<dd>
349Called wheneever the window loses keyboard focus, before rxvt-unicode does
350focus out processing.
351</dd>
352<p></p>
353<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br />
354</dt>
355<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br />
356</dt>
357<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
358</dt>
359<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
360</dt>
361<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
362</dt>
363<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
364</dt>
365<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
366</dt>
367<dd>
368Called whenever the corresponding X event is received for the terminal If
369the hook returns true, then the even will be ignored by rxvt-unicode.
370</dd>
371<dd>
372<p>The event is a hash with most values as named by Xlib (see the XEvent
373manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
374and column under the mouse cursor.</p>
375</dd>
376<dd>
377<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
378output, if any, in locale-specific encoding.</p>
379</dd>
380<dd>
381<p>subwindow.</p>
382</dd>
383<p></p></dl>
384<p>
385</p>
386<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
387<dl>
388<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
389</dt>
390<dd>
391The current terminal. This variable stores the current <code>urxvt::term</code>
392object, whenever a callback/hook is executing.
393</dd>
240<p></p></dl> 394<p></p></dl>
241<p> 395<p>
242</p> 396</p>
243<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 397<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
244<dl> 398<dl>
399<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
400</dt>
401<dd>
402Creates a new terminal, very similar as if you had started it with
403<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
404if the new instance couldn't be created. Returns <code>undef</code> if the new
405instance didn't initialise perl, and the terminal object otherwise. The
406<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
407</dd>
408<p></p>
245<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 409<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
246</dt> 410</dt>
247<dd> 411<dd>
248Fatally aborts execution with the given error message. Avoid at all 412Fatally aborts execution with the given error message. Avoid at all
249costs! The only time this is acceptable is when the terminal process 413costs! The only time this is acceptable is when the terminal process
… …
265<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 429<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
266</dt> 430</dt>
267<dd> 431<dd>
268Returns the ``current time'' (as per the event loop). 432Returns the ``current time'' (as per the event loop).
269</dd> 433</dd>
270<p></p></dl> 434<p></p>
271<p> 435<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
272</p>
273<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
274<dl>
275<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
276</dt> 436</dt>
277<dd> 437<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
278Returns the current resource value associated with a given name and 438Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
279optionally sets a new value. Setting values is most useful in the <code>init</code> 439Button4Mask, Button5Mask, AnyModifier</a></strong><br />
280hook. Unset resources are returned and accepted as <code>undef</code>. 440</dt>
281</dd> 441<dd>
282<dd> 442Various constants for use in X events.
283<p>The new value must be properly encoded to a suitable character encoding
284before passing it to this method. Similarly, the returned value may need
285to be converted from the used encoding to text.</p>
286</dd>
287<dd>
288<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified
289as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
290likely change).</p>
291</dd>
292<dd>
293<p>Please note that resource strings will currently only be freed when the
294terminal is destroyed, so changing options frequently will eat memory.</p>
295</dd>
296<dd>
297<p>Here is a a likely non-exhaustive list of resource names, not all of which
298are supported in every build, please see the source to see the actual
299list:</p>
300</dd>
301<dd>
302<pre>
303 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
304 borderLess color cursorBlink cursorUnderline cutchars delete_key
305 display_name embed ext_bwidth fade font geometry hold iconName
306 imFont imLocale inputMethod insecure int_bwidth intensityStyles
307 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
308 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
309 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
310 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
311 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
312 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
313 shade term_name title transparent transparent_all tripleclickwords
314 utmpInhibit visualBell</pre>
315</dd>
316<p></p>
317<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
318</dt>
319<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
320</dt>
321<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
322</dt>
323<dd>
324Return the current values of the selection mark, begin or end positions,
325and optionally set them to new values.
326</dd>
327<p></p>
328<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
329</dt>
330<dd>
331Try to request the primary selection from the server (for example, as set
332by the next method).
333</dd>
334<p></p>
335<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
336</dt>
337<dd>
338Return the current selection text and optionally replace it by <code>$newtext</code>.
339</dd>
340<p></p>
341<dt><strong><a name="item_scr_overlay">$term-&gt;scr_overlay ($x, $y, $text)</a></strong><br />
342</dt>
343<dd>
344Create a simple multi-line overlay box. See the next method for details.
345</dd>
346<p></p>
347<dt><strong><a name="item_scr_overlay_new">$term-&gt;scr_overlay_new ($x, $y, $width, $height)</a></strong><br />
348</dt>
349<dd>
350Create a new (empty) overlay at the given position with the given
351width/height. A border will be put around the box. If either <code>$x</code> or
352<code>$y</code> is negative, then this is counted from the right/bottom side,
353respectively.
354</dd>
355<p></p>
356<dt><strong><a name="item_scr_overlay_off">$term-&gt;scr_overlay_off</a></strong><br />
357</dt>
358<dd>
359Switch the overlay off again.
360</dd>
361<p></p>
362<dt><strong><a name="item_scr_overlay_set_char">$term-&gt;scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br />
363</dt>
364<dd>
365Put a single character (specified numerically) at the given overlay
366position.
367</dd>
368<p></p>
369<dt><strong><a name="item_scr_overlay_set">$term-&gt;scr_overlay_set ($x, $y, $text)</a></strong><br />
370</dt>
371<dd>
372Write a string at the given position into the overlay.
373</dd>
374<p></p>
375<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br />
376</dt>
377<dd>
378Returns the number of screen-cells this string would need. Correctly
379accounts for wide and combining characters.
380</dd>
381<p></p>
382<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br />
383</dt>
384<dd>
385Convert the given text string into the corresponding locale encoding.
386</dd>
387<p></p>
388<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br />
389</dt>
390<dd>
391Convert the given locale-encoded octets into a perl string.
392</dd>
393<p></p>
394<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
395</dt>
396<dd>
397Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
398pass characters instead of octets, you should convert your strings first
399to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
400</dd>
401<p></p>
402<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br />
403</dt>
404<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br />
405</dt>
406<dd>
407Return the number of rows/columns of the terminal window (i.e. as
408specified by <code>-geometry</code>, excluding any scrollback).
409</dd>
410<p></p>
411<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br />
412</dt>
413<dd>
414Returns the number of lines in the scrollback buffer.
415</dd>
416<p></p>
417<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
418</dt>
419<dd>
420Returns the negative row number of the topmost line. Minimum value is
421<code>0</code>, which displays the normal terminal contents. Larger values scroll
422this many lines into the scrollback buffer.
423</dd>
424<p></p>
425<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
426</dt>
427<dd>
428Requests a screen refresh. At the next opportunity, rxvt-unicode will
429compare the on-screen display with its stored representation. If they
430differ, it redraws the differences.
431</dd>
432<dd>
433<p>Used after changing terminal contents to display them.</p>
434</dd>
435<p></p>
436<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
437</dt>
438<dd>
439Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
440is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
441terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
442line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>.
443</dd>
444<dd>
445<p>If <code>$new_text</code> is specified, it will replace characters in the current
446line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
447to replace only parts of a line. The font iindex in the rendition will
448automatically be updated.</p>
449</dd>
450<dd>
451<p><code>$text</code> is in a special encoding: tabs and wide characters that use more
452than one cell when displayed are padded with urxvt::NOCHAR characters
453(<code>chr 65535</code>). Characters with combining characters and other characters
454that do not fit into the normal tetx encoding will be replaced with
455characters in the private use area.</p>
456</dd>
457<dd>
458<p>You have to obey this encoding when changing text. The advantage is
459that <code>substr</code> and similar functions work on screen cells and not on
460characters.</p>
461</dd>
462<dd>
463<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>
464can be used to convert normal strings into this encoding and vice versa.</p>
465</dd>
466<p></p>
467<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
468</dt>
469<dd>
470Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
471bitsets. Rendition bitsets contain information about colour, font, font
472styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
473</dd>
474<dd>
475<p>When setting rendition, the font mask will be ignored.</p>
476</dd>
477<dd>
478<p>See the section on RENDITION, below.</p>
479</dd>
480<p></p>
481<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
482</dt>
483<dd>
484Returns the number of screen cells that are in use (``the line length''). If
485it is <code>-1</code>, then the line is part of a multiple-row logical ``line'', which
486means all characters are in use and it is continued on the next row.
487</dd>
488<p></p>
489<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
490</dt>
491<dd>
492Converts a perl string into the special encoding used by rxvt-unicode,
493where one character corresponds to one screen cell. See
494<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
495</dd>
496<p></p>
497<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
498</dt>
499<dd>
500Converts rxvt-unicodes text reprsentation into a perl string. See
501<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
502</dd> 443</dd>
503<p></p></dl> 444<p></p></dl>
504<p> 445<p>
505</p> 446</p>
506<h2><a name="rendition">RENDITION</a></h2> 447<h2><a name="rendition">RENDITION</a></h2>
… …
513<dl> 454<dl>
514<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> 455<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br />
515</dt> 456</dt>
516<dd> 457<dd>
517Returns the default rendition, as used when the terminal is starting up or 458Returns the default rendition, as used when the terminal is starting up or
518being reset. Useful as a base 459being reset. Useful as a base to start when creating renditions.
460</dd>
461<p></p>
462<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
463</dt>
519</dd> 464<dd>
465Return the rendition mask used for overlays by default.
466</dd>
467<p></p>
468<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
469</dt>
470<dd>
471Return the bit that enabled bold, italic, blink, reverse-video and
472underline, respectively. To enable such a style, just logically OR it into
473the bitset.
474</dd>
475<p></p>
476<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br />
477</dt>
478<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
479</dt>
480<dd>
481Return the foreground/background colour index, respectively.
482</dd>
483<p></p>
484<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br />
485</dt>
486<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br />
487</dt>
488<dd>
489Replace the foreground/background colour in the rendition mask with the
490specified one.
491</dd>
492<p></p>
493<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br />
494</dt>
495<dd>
496Return the ``custom'' value: Every rendition has 5 bits for use by
497extensions. They can be set and changed as you like and are initially
498zero.
499</dd>
500<p></p>
501<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br />
502</dt>
503<dd>
504Change the custom value.
505</dd>
520<p></p></dl> 506<p></p></dl>
507<p>
508</p>
509<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
510<dl>
511<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
512</dt>
513<dd>
514Destroy the terminal object (close the window, free resources etc.).
515</dd>
516<p></p>
517<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
518</dt>
519<dd>
520Returns true if the option specified by <code>$optval</code> is enabled, and
521optionally change it. All option values are stored by name in the hash
522<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
523</dd>
524<dd>
525<p>Here is a a likely non-exhaustive list of option names, please see the
526source file <em>/src/optinc.h</em> to see the actual list:</p>
527</dd>
528<dd>
529<pre>
530 borderLess console cursorBlink cursorUnderline hold iconic insecure
531 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
532 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
533 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
534 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
535 tripleclickwords utmpInhibit visualBell</pre>
536</dd>
537<p></p>
538<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
539</dt>
540<dd>
541Returns the current resource value associated with a given name and
542optionally sets a new value. Setting values is most useful in the <code>init</code>
543hook. Unset resources are returned and accepted as <code>undef</code>.
544</dd>
545<dd>
546<p>The new value must be properly encoded to a suitable character encoding
547before passing it to this method. Similarly, the returned value may need
548to be converted from the used encoding to text.</p>
549</dd>
550<dd>
551<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified
552as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
553likely change).</p>
554</dd>
555<dd>
556<p>Please note that resource strings will currently only be freed when the
557terminal is destroyed, so changing options frequently will eat memory.</p>
558</dd>
559<dd>
560<p>Here is a a likely non-exhaustive list of resource names, not all of which
561are supported in every build, please see the source file <em>/src/rsinc.h</em>
562to see the actual list:</p>
563</dd>
564<dd>
565<pre>
566 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
567 borderLess color cursorBlink cursorUnderline cutchars delete_key
568 display_name embed ext_bwidth fade font geometry hold iconName
569 imFont imLocale inputMethod insecure int_bwidth intensityStyles
570 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
571 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
572 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
573 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
574 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
575 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
576 shade term_name title transparent transparent_all tripleclickwords
577 utmpInhibit visualBell</pre>
578</dd>
579<p></p>
580<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
581</dt>
582<dd>
583Return and optionally change the current rendition. Text that is output by
584the terminal application will use this style.
585</dd>
586<p></p>
587<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
588</dt>
589<dd>
590Return the current coordinates of the text cursor position and optionally
591set it (which is usually bad as applications don't expect that).
592</dd>
593<p></p>
594<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
595</dt>
596<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
597</dt>
598<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
599</dt>
600<dd>
601Return the current values of the selection mark, begin or end positions,
602and optionally set them to new values.
603</dd>
604<p></p>
605<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
606</dt>
607<dd>
608Try to request the primary selection from the server (for example, as set
609by the next method).
610</dd>
611<p></p>
612<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
613</dt>
614<dd>
615Return the current selection text and optionally replace it by <code>$newtext</code>.
616</dd>
617<dd>
618<p>#=item $term-&gt;overlay ($x, $y, $text)
619#
620#Create a simple multi-line overlay box. See the next method for details.
621#
622#=cut
623#
624#sub urxvt::term::scr_overlay {
625# my ($self, $x, $y, $text) = @_;
626#
627# my @lines = split /\n/, $text;
628#
629# my $w = 0;
630# for (map $self-&gt;strwidth ($_), @lines) {
631# $w = $_ if $w &lt; $_;
632# }
633#
634# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
635# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
636#}</p>
637</dd>
638<p></p>
639<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
640</dt>
641<dd>
642Create a new (empty) overlay at the given position with the given
643width/height. <code>$rstyle</code> defines the initial rendition style
644(default: <code>OVERLAY_RSTYLE</code>).
645</dd>
646<dd>
647<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
648around the box.</p>
649</dd>
650<dd>
651<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
652right/bottom side, respectively.</p>
653</dd>
654<dd>
655<p>This method returns an urxvt::overlay object. The overlay will be visible
656as long as the perl object is referenced.</p>
657</dd>
658<dd>
659<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
660</dd>
661<dl>
662<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
663</dt>
664<dd>
665Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
666text in rxvt-unicode's special encoding and an array of rendition values
667at a specific position inside the overlay.
668</dd>
669<p></p>
670<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
671</dt>
672<dd>
673If visible, hide the overlay, but do not destroy it.
674</dd>
675<p></p>
676<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
677</dt>
678<dd>
679If hidden, display the overlay again.
680</dd>
681<p></p></dl>
682<dt><strong><a name="item_popup">$popup = $term-&gt;popup ($event)</a></strong><br />
683</dt>
684<dd>
685Creates 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,
687currently).
688</dd>
689<p></p>
690<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
691</dt>
692<dd>
693Returns the number of screen-cells this string would need. Correctly
694accounts for wide and combining characters.
695</dd>
696<p></p>
697<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
698</dt>
699<dd>
700Convert the given text string into the corresponding locale encoding.
701</dd>
702<p></p>
703<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
704</dt>
705<dd>
706Convert the given locale-encoded octets into a perl string.
707</dd>
708<p></p>
709<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
710</dt>
711<dd>
712Write the given text string to the screen, as if output by the application
713running inside the terminal. It may not contain command sequences (escape
714codes), but is free to use line feeds, carriage returns and tabs. The
715string is a normal text string, not in locale-dependent encoding.
716</dd>
717<dd>
718<p>Normally its not a good idea to use this function, as programs might be
719confused by changes in cursor position or scrolling. Its useful inside a
720<code>on_add_lines</code> hook, though.</p>
721</dd>
722<p></p>
723<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
724</dt>
725<dd>
726Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
727locale-specific encoding of the terminal and can contain command sequences
728(escape codes) that will be interpreted.
729</dd>
730<p></p>
731<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
732</dt>
733<dd>
734Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
735pass characters instead of octets, you should convert your strings first
736to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
737</dd>
738<p></p>
739<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
740</dt>
741<dd>
742Return the window id of the toplevel window.
743</dd>
744<p></p>
745<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
746</dt>
747<dd>
748Return the window id of the terminal window.
749</dd>
750<p></p>
751<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
752</dt>
753<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
754</dt>
755<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
756</dt>
757<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
758</dt>
759<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
760</dt>
761<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
762</dt>
763<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
764</dt>
765<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
766</dt>
767<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
768</dt>
769<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
770</dt>
771<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
772</dt>
773<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
774</dt>
775<dd>
776Return various integers describing terminal characteristics.
777</dd>
778<p></p>
779<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
780</dt>
781<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
782</dt>
783<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
784</dt>
785<dd>
786Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
787AltGr), the meta key (often Alt) and the num lock key, if applicable.
788</dd>
789<p></p>
790<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
791</dt>
792<dd>
793Returns the negative row number of the topmost line. Minimum value is
794<code>0</code>, which displays the normal terminal contents. Larger values scroll
795this many lines into the scrollback buffer.
796</dd>
797<p></p>
798<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
799</dt>
800<dd>
801Requests a screen refresh. At the next opportunity, rxvt-unicode will
802compare the on-screen display with its stored representation. If they
803differ, it redraws the differences.
804</dd>
805<dd>
806<p>Used after changing terminal contents to display them.</p>
807</dd>
808<p></p>
809<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
810</dt>
811<dd>
812Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
813is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
814terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
815line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
816is requested.
817</dd>
818<dd>
819<p>If <code>$new_text</code> is specified, it will replace characters in the current
820line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
821to replace only parts of a line. The font index in the rendition will
822automatically be updated.</p>
823</dd>
824<dd>
825<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
826than one cell when displayed are padded with urxvt::NOCHAR characters
827(<code>chr 65535</code>). Characters with combining characters and other characters
828that do not fit into the normal tetx encoding will be replaced with
829characters in the private use area.</p>
830</dd>
831<dd>
832<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
834characters.</p>
835</dd>
836<dd>
837<p>The methods <code>$term-&gt;special_encode</code> 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>
839</dd>
840<p></p>
841<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
842</dt>
843<dd>
844Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition
845bitsets. Rendition bitsets contain information about colour, font, font
846styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>.
847</dd>
848<dd>
849<p>When setting rendition, the font mask will be ignored.</p>
850</dd>
851<dd>
852<p>See the section on RENDITION, above.</p>
853</dd>
854<p></p>
855<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
856</dt>
857<dd>
858Returns the number of screen cells that are in use (``the line
859length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
860line is joined with the following one.
861</dd>
862<p></p>
863<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
864</dt>
865<dd>
866Returns true if the row is part of a multiple-row logical ``line'' (i.e.
867joined with the following row), which means all characters are in use
868and it is continued on the next row (and possibly a continuation of the
869previous row(s)).
870</dd>
871<p></p>
872<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
873</dt>
874<dd>
875Create and return a new <code>urxvt::line</code> object that stores information
876about the logical line that row <code>$row_number</code> is part of. It supports the
877following methods:
878</dd>
879<dl>
880<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
881</dt>
882<dd>
883Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
884</dd>
885<p></p>
886<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
887</dt>
888<dd>
889Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
890</dd>
891<p></p>
892<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
893</dt>
894<dd>
895Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
896</dd>
897<p></p>
898<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
899</dt>
900<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
901</dt>
902<dd>
903Return the row number of the first/last row of the line, respectively.
904</dd>
905<p></p>
906<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
907</dt>
908<dd>
909Returns the character offset of the given row|col pair within the logical
910line.
911</dd>
912<p></p>
913<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
914</dt>
915<dd>
916Translates a string offset into terminal coordinates again.
917</dd>
918<p></p></dl>
919<dt><strong>($row, $col) = $line-&gt;coord_of ($offset)
920=item $text = $term-&gt;special_encode $string</strong><br />
921</dt>
922<dd>
923Converts a perl string into the special encoding used by rxvt-unicode,
924where one character corresponds to one screen cell. See
925<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
926</dd>
927<p></p>
928<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
929</dt>
930<dd>
931Converts rxvt-unicodes text reprsentation into a perl string. See
932<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
933</dd>
934<p></p></dl>
935<p>
936</p>
937<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
521<p> 938<p>
522</p> 939</p>
523<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 940<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
524<p>This class implements timer watchers/events. Time is represented as a 941<p>This class implements timer watchers/events. Time is represented as a
525fractional number of seconds since the epoch. Example:</p> 942fractional number of seconds since the epoch. Example:</p>
526<pre> 943<pre>
527 # create a digital clock display in upper right corner 944 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
528 $term-&gt;{timer} = urxvt::timer 945 $term-&gt;{timer} = urxvt::timer
529 -&gt;new 946 -&gt;new
530 -&gt;start (urxvt::NOW) 947 -&gt;interval (1)
531 -&gt;cb (sub { 948 -&gt;cb (sub {
532 my ($timer) = @_;
533 my $time = $timer-&gt;at;
534 $timer-&gt;start ($time + 1);
535 $self-&gt;scr_overlay (-1, 0, 949 $term-&gt;{overlay}-&gt;set (0, 0,
536 POSIX::strftime &quot;%H:%M:%S&quot;, localtime $time); 950 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
537 });</pre> 951 });</pre>
538<dl> 952<dl>
539<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 953<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br />
540</dt> 954</dt>
541<dd> 955<dd>
542Create a new timer object in stopped state. 956Create a new timer object in started state. It is scheduled to fire
957immediately.
543</dd> 958</dd>
544<p></p> 959<p></p>
545<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br /> 960<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
546</dt> 961</dt>
547<dd> 962<dd>
… …
552</dt> 967</dt>
553<dd> 968<dd>
554Return the time this watcher will fire next. 969Return the time this watcher will fire next.
555</dd> 970</dd>
556<p></p> 971<p></p>
557<dt><strong><a name="item_set">$timer = $timer-&gt;set ($tstamp)</a></strong><br /> 972<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br />
558</dt> 973</dt>
559<dd> 974<dd>
560Set the time the event is generated to $tstamp. 975Set the time the event is generated to $tstamp.
976</dd>
977<p></p>
978<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
979</dt>
980<dd>
981Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
982stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
983is automatically rescheduled at the given intervals.
561</dd> 984</dd>
562<p></p> 985<p></p>
563<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br /> 986<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
564</dt> 987</dt>
565<dd> 988<dd>
… …
641<p> 1064<p>
642</p> 1065</p>
643<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1066<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
644<p>This variable controls the verbosity level of the perl extension. Higher 1067<p>This variable controls the verbosity level of the perl extension. Higher
645numbers indicate more verbose output.</p> 1068numbers indicate more verbose output.</p>
646<ol> 1069<dl>
647<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1070<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br />
648</li> 1071</dt>
649<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1072<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br />
650</li> 1073</dt>
651<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> 1074<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br />
1075</dt>
652</li> 1076</dl>
653</ol>
654<p> 1077<p>
655</p> 1078</p>
656<hr /> 1079<hr />
657<h1><a name="author">AUTHOR</a></h1> 1080<h1><a name="author">AUTHOR</a></h1>
658<pre> 1081<pre>

Diff Legend

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