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.9 by root, Tue Jan 3 21:15:22 2006 UTC vs.
Revision 1.27 by root, Thu Jan 12 12:15:10 2006 UTC

… …
13<ul> 13<ul>
14 14
15 <li><a href="#name">NAME</a></li> 15 <li><a href="#name">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 16 <li><a href="#synopsis">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 17 <li><a href="#description">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li>
18 <ul> 20 <ul>
19 21
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 22 <li><a href="#general_api_considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li>
22 <li><a href="#hooks">Hooks</a></li> 24 <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> 25 <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> 26 <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> 27 <li><a href="#rendition">RENDITION</a></li>
28 <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> 29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
30 <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> 31 <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> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
29 </ul> 33 </ul>
30 34
31 <li><a href="#environment">ENVIRONMENT</a></li> 35 <li><a href="#environment">ENVIRONMENT</a></li>
… …
61 rxvt --perl-lib $HOME -pe grab_test</pre> 65 rxvt --perl-lib $HOME -pe grab_test</pre>
62<p> 66<p>
63</p> 67</p>
64<hr /> 68<hr />
65<h1><a name="description">DESCRIPTION</a></h1> 69<h1><a name="description">DESCRIPTION</a></h1>
66<p>Everytime a terminal object gets created, scripts specified via the 70<p>Everytime a terminal object gets created, extension scripts specified via
67<code>perl</code> resource are loaded and associated with it.</p> 71the <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 72<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
69thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
70<p>Each script will only ever be loaded once, even in rxvtd, where 74<p>Each script will only ever be loaded once, even in rxvtd, where
71scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
72<p> 76<p>
73</p> 77</p>
74<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
75<p>This section describes the extensiosn delivered with this version. You can 80<p>This section describes the extensions delivered with this release. You can
76find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
77<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
78<pre> 83<pre>
79 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
80<dl> 85<dl>
81<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
82</dt> 87</dt>
83<dd>
84Intelligent selection. This etxension tries to be more intelligent when the user
85extends selections (double-click).
86</dd> 88<dd>
89(More) intelligent selection. This extension tries to be more intelligent
90when the user extends selections (double-click and further clicks). Right
91now, it tries to select words, urls and complete shell-quoted
92arguments, which is very convenient, too, if your <em>ls</em> supports
93<code>--quoting-style=shell</code>.
87<dd> 94</dd>
95<dd>
96<p>A double-click usually selects the word under the cursor, further clicks
97will enlarge the selection.</p>
98</dd>
99<dd>
100<p>The selection works by trying to match a number of regexes and displaying
101them in increasing order of length. You can add your own regexes by
102specifying resources of the form:</p>
103</dd>
104<dd>
105<pre>
106 URxvt.selection.pattern-0: perl-regex
107 URxvt.selection.pattern-1: perl-regex
108 ...</pre>
109</dd>
110<dd>
111<p>The index number (0, 1...) must not have any holes, and each regex must
112contain at least one pair of capturing parentheses, which will be used for
113the match. For example, the followign adds a regex that matches everything
114between two vertical bars:</p>
115</dd>
116<dd>
117<pre>
118 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
119</dd>
120<dd>
121<p>You can look at the source of the selection extension to see more
122interesting uses, such as parsing a line from beginning to end.</p>
123</dd>
124<dd>
88<p>It also offers the following bindable event:</p> 125<p>This extension also offers the following bindable keyboard command:</p>
89</dd> 126</dd>
90<dl> 127<dl>
91<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
92</dt> 129</dt>
93<dd> 130<dd>
… …
96<dd> 133<dd>
97<pre> 134<pre>
98 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
99</dd> 136</dd>
100<p></p></dl> 137<p></p></dl>
138<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
139</dt>
140<dd>
141Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
142runtime.
143</dd>
144<p></p>
145<dt><strong>selection-popup (enabled by default)</strong><br />
146</dt>
147<dd>
148Binds a popup menu to Ctrl-Button3 that lets you convert the selection
149text into various other formats/action (such as uri unescaping, perl
150evalution, web-browser starting etc.), depending on content.
151</dd>
152<p></p>
153<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
154</dt>
155<dd>
156Adds regex search functionality to the scrollback buffer, triggered
157by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
158input/output is suspended and a regex is displayed at the bottom of the
159screen.
160</dd>
161<dd>
162<p>Inputting characters appends them to the regex and continues incremental
163search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
164search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
165bottom. <code>Escape</code> leaves search mode and returns to the point where search
166was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
167additionally stores the first match in the current line into the primary
168selection.</p>
169</dd>
170<p></p>
171<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
172</dt>
173<dd>
174This selection allows you to do automatic transforms on a selection
175whenever a selection is made.
176</dd>
177<dd>
178<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
179operator) that modify <code>$_</code> as resources:</p>
180</dd>
181<dd>
182<pre>
183 URxvt.selection-autotransform.0: transform
184 URxvt.selection-autotransform.1: transform
185 ...</pre>
186</dd>
187<dd>
188<p>For example, the following will transform selections of the form
189<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
190$word</code>:</p>
191</dd>
192<dd>
193<pre>
194 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
195</dd>
196<dd>
197<p>And this example matches the same,but replaces it with vi-commands you can
198paste directly into your (vi :) editor:</p>
199</dd>
200<dd>
201<pre>
202 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
203</dd>
204<dd>
205<p>Of course, this can be modified to suit your needs and your editor :)</p>
206</dd>
207<p></p>
208<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
209</dt>
210<dd>
211Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
212make them clickable. When middle-clicked, the program specified in the
213resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
214the URL as first argument.
215</dd>
216<p></p>
217<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
218</dt>
219<dd>
220A not very useful example of filtering all text output to the terminal,
221by replacing all line-drawing characters (U+2500 .. U+259F) by a
222similar-looking ascii character.
223</dd>
224<p></p>
101<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 225<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
102</dt> 226</dt>
103<dd> 227<dd>
104Displays a digital clock using the built-in overlay. 228Displays a digital clock using the built-in overlay.
105</dd> 229</dd>
… …
110Displays a very simple digital clock in the upper right corner of the 234Displays a very simple digital clock in the upper right corner of the
111window. Illustrates overwriting the refresh callbacks to create your own 235window. Illustrates overwriting the refresh callbacks to create your own
112overlays or changes. 236overlays or changes.
113</dd> 237</dd>
114<p></p></dl> 238<p></p></dl>
239<p>
240</p>
241<hr />
242<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
115<p> 243<p>
116</p> 244</p>
117<h2><a name="general_api_considerations">General API Considerations</a></h2> 245<h2><a name="general_api_considerations">General API Considerations</a></h2>
118<p>All objects (such as terminals, time watchers etc.) are typical 246<p>All objects (such as terminals, time watchers etc.) are typical
119reference-to-hash objects. The hash can be used to store anything you 247reference-to-hash objects. The hash can be used to store anything you
… …
122modified).</p> 250modified).</p>
123<p>When objects are destroyed on the C++ side, the perl object hashes are 251<p>When objects are destroyed on the C++ side, the perl object hashes are
124emptied, so its best to store related objects such as time watchers and 252emptied, so its best to store related objects such as time watchers and
125the like inside the terminal object so they get destroyed as soon as the 253the like inside the terminal object so they get destroyed as soon as the
126terminal is destroyed.</p> 254terminal is destroyed.</p>
255<p>Argument names also often indicate the type of a parameter. Here are some
256hints on what they mean:</p>
257<dl>
258<dt><strong><a name="item__24text">$text</a></strong><br />
259</dt>
260<dd>
261Rxvt-unicodes special way of encoding text, where one ``unicode'' character
262always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
263</dd>
264<p></p>
265<dt><strong><a name="item__24string">$string</a></strong><br />
266</dt>
267<dd>
268A perl text string, with an emphasis on <em>text</em>. It can store all unicode
269characters and is to be distinguished with text encoded in a specific
270encoding (often locale-specific) and binary data.
271</dd>
272<p></p>
273<dt><strong><a name="item__24octets">$octets</a></strong><br />
274</dt>
275<dd>
276Either binary data or - more common - a text string encoded in a
277locale-specific way.
278</dd>
279<p></p></dl>
280<p>
281</p>
282<h2><a name="extension_objects">Extension Objects</a></h2>
283<p>Very perl extension is a perl class. A separate perl object is created
284for each terminal and each extension and passed as the first parameter to
285hooks. So extensions can use their <code>$self</code> object without having to think
286about other extensions, with the exception of methods and members that
287begin with an underscore character <code>_</code>: these are reserved for internal
288use.</p>
289<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
290<code>urxvt::term</code> class on this object.</p>
291<p>It has the following methods and data members:</p>
292<dl>
293<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
294</dt>
295<dd>
296Returns the <code>urxvt::term</code> object associated with this instance of the
297extension. This member <em>must not</em> be changed in any way.
298</dd>
299<p></p>
300<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
301</dt>
302<dd>
303Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
304this extension, replacing any previous hook. This is useful when you want
305to overwrite time-critical hooks only temporarily.
306</dd>
307<p></p>
308<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
309</dt>
310<dd>
311Dynamically disable the given hooks.
312</dd>
313<p></p></dl>
127<p> 314<p>
128</p> 315</p>
129<h2><a name="hooks">Hooks</a></h2> 316<h2><a name="hooks">Hooks</a></h2>
130<p>The following subroutines can be declared in loaded scripts, and will be 317<p>The following subroutines can be declared in extension files, and will be
131called whenever the relevant event happens.</p> 318called whenever the relevant event happens.</p>
132<p>The first argument passed to them is an object private to each terminal 319<p>The first argument passed to them is an extension oject as described in
133and extension package. You can call all <code>urxvt::term</code> methods on it, but 320the in the <code>Extension Objects</code> section.</p>
134its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
135object that is shared between all packages is stored in the <code>term</code>
136member.</p>
137<p>All of them must return a boolean value. If it is true, then the event 321<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
138counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 322event counts as being <em>consumed</em>, and the invocation of other hooks is
139and the relevant action might not be carried out by the C++ code.</p> 323skipped, and the relevant action might not be carried out by the C++ code.</p>
140<p>When in doubt, return a false value (preferably <code>()</code>).</p> 324<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
141<dl> 325<dl>
142<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 326<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
143</dt> 327</dt>
144<dd> 328<dd>
145Called after a new terminal object has been initialized, but before 329Called after a new terminal object has been initialized, but before
146windows are created or the command gets run. 330windows are created or the command gets run. Most methods are unsafe to
331call or deliver senseless data, as terminal size and other characteristics
332have not yet been determined. You can safely query and change resources,
333though.
147</dd> 334</dd>
148<p></p> 335<p></p>
149<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 336<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
150</dt> 337</dt>
151<dd> 338<dd>
… …
188</dt> 375</dt>
189<dd> 376<dd>
190Called whenever the user tries to extend the selection (e.g. with a double 377Called whenever the user tries to extend the selection (e.g. with a double
191click) and is either supposed to return false (normal operation), or 378click) and is either supposed to return false (normal operation), or
192should extend the selection itelf and return true to suppress the built-in 379should extend the selection itelf and return true to suppress the built-in
193processing. 380processing. This can happen multiple times, as long as the callback
381returns true, it will be called on every further click by the user and is
382supposed to enlarge the selection more and more, if possible.
194</dd> 383</dd>
195<dd> 384<dd>
196<p>See the <em>selection</em> example extension.</p> 385<p>See the <em>selection</em> example extension.</p>
197</dd>
198<p></p>
199<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
200</dt>
201<dd>
202Called whenever the window gets the keyboard focus, before urxvt does
203focus in processing.
204</dd>
205<p></p>
206<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
207</dt>
208<dd>
209Called wheneever the window loses keyboard focus, before urxvt does focus
210out processing.
211</dd> 386</dd>
212<p></p> 387<p></p>
213<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 388<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
214</dt> 389</dt>
215<dd> 390<dd>
… …
229<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 404<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
230$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 405$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
231number of lines that will be in the scrollback buffer.</p> 406number of lines that will be in the scrollback buffer.</p>
232</dd> 407</dd>
233<p></p> 408<p></p>
234<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 409<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
235</dt> 410</dt>
411<dd>
412Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
413operating system command) is processed. Cursor position and other state
414information is up-to-date when this happens. For interoperability, the
415string should start with the extension name and a colon, to distinguish
416it from commands for other extensions, and this might be enforced in the
417future.
236<dd> 418</dd>
237Called whenever the <code>program(s)</code> running in the urxvt window send output. 419<dd>
420<p>Be careful not ever to trust (in a security sense) the data you receive,
421as its source can not easily be controleld (e-mail content, messages from
422other users on the same system etc.).</p>
423</dd>
424<p></p>
425<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
426</dt>
427<dd>
428Called whenever text is about to be output, with the text as argument. You
429can filter/change and output the text yourself by returning a true value
430and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
431might be very slow, however, as your hook is called for <strong>all</strong> text being
432output.
433</dd>
434<p></p>
435<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
436</dt>
437<dd>
438Called whenever some data is written to the tty/pty and can be used to
439suppress or filter tty input.
440</dd>
441<p></p>
442<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
443</dt>
444<dd>
445Called whenever a line was updated or changed. Can be used to filter
446screen output (e.g. underline urls or other useless stuff). Only lines
447that are being shown will be filtered, and, due to performance reasons,
448not always immediately.
449</dd>
450<dd>
451<p>The row number is always the topmost row of the line if the line spans
452multiple rows.</p>
453</dd>
454<dd>
455<p>Please note that, if you change the line, then the hook might get called
456later with the already-modified line (e.g. if unrelated parts change), so
457you cannot just toggle rendition bits, but only set them.</p>
238</dd> 458</dd>
239<p></p> 459<p></p>
240<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 460<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
241</dt> 461</dt>
242<dd> 462<dd>
… …
257<dd> 477<dd>
258Called whenever the user presses a key combination that has a 478Called whenever the user presses a key combination that has a
259<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 479<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
260resource in the <code>rxvt(1)</code> manpage). 480resource in the <code>rxvt(1)</code> manpage).
261</dd> 481</dd>
482<p></p>
483<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
484</dt>
485<dd>
486Called whenever the window gets the keyboard focus, before rxvt-unicode
487does focus in processing.
488</dd>
489<p></p>
490<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
491</dt>
492<dd>
493Called wheneever the window loses keyboard focus, before rxvt-unicode does
494focus out processing.
495</dd>
496<p></p>
497<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
498</dt>
499<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
500</dt>
501<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
502</dt>
503<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
504</dt>
505<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
506</dt>
507<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
508</dt>
509<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
510</dt>
511<dd>
512Called whenever the corresponding X event is received for the terminal If
513the hook returns true, then the even will be ignored by rxvt-unicode.
514</dd>
515<dd>
516<p>The event is a hash with most values as named by Xlib (see the XEvent
517manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
518and column under the mouse cursor.</p>
519</dd>
520<dd>
521<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
522output, if any, in locale-specific encoding.</p>
523</dd>
524<dd>
525<p>subwindow.</p>
526</dd>
262<p></p></dl> 527<p></p></dl>
263<p> 528<p>
264</p> 529</p>
265<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 530<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
266<dl> 531<dl>
532<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
533</dt>
534<dd>
535The rxvt-unicode library directory, where, among other things, the perl
536modules and scripts are stored.
537</dd>
538<p></p>
539<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
540</dt>
541<dd>
542The resource class and name rxvt-unicode uses to look up X resources.
543</dd>
544<p></p>
545<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
546</dt>
547<dd>
548The basename of the installed binaries, usually <code>urxvt</code>.
549</dd>
550<p></p>
267<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 551<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
268</dt> 552</dt>
269<dd> 553<dd>
270The current terminal. Whenever a callback/Hook is bein executed, this 554The current terminal. This variable stores the current <code>urxvt::term</code>
271variable stores the current <code>urxvt::term</code> object. 555object, whenever a callback/hook is executing.
272</dd> 556</dd>
273<p></p></dl> 557<p></p></dl>
274<p> 558<p>
275</p> 559</p>
276<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 560<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
… …
292</dd> 576</dd>
293<dd> 577<dd>
294<p>Using this function has the advantage that its output ends up in the 578<p>Using this function has the advantage that its output ends up in the
295correct place, e.g. on stderr of the connecting urxvtc client.</p> 579correct place, e.g. on stderr of the connecting urxvtc client.</p>
296</dd> 580</dd>
581<dd>
582<p>Messages have a size limit of 1023 bytes currently.</p>
583</dd>
584<p></p>
585<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
586</dt>
587<dd>
588Returns true when it is safe to do potentially unsafe things, such as
589evaluating perl code specified by the user. This is true when urxvt was
590started setuid or setgid.
591</dd>
297<p></p> 592<p></p>
298<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 593<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
299</dt> 594</dt>
300<dd> 595<dd>
301Returns the ``current time'' (as per the event loop). 596Returns the ``current time'' (as per the event loop).
597</dd>
598<p></p>
599<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
600</dt>
601<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
602Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
603Button4Mask, Button5Mask, AnyModifier</a></strong><br />
604</dt>
605<dd>
606Various constants for use in X calls and event processing.
302</dd> 607</dd>
303<p></p></dl> 608<p></p></dl>
304<p> 609<p>
305</p> 610</p>
306<h2><a name="rendition">RENDITION</a></h2> 611<h2><a name="rendition">RENDITION</a></h2>
… …
338</dt> 643</dt>
339<dd> 644<dd>
340Return the foreground/background colour index, respectively. 645Return the foreground/background colour index, respectively.
341</dd> 646</dd>
342<p></p> 647<p></p>
343<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 648<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
344</dt> 649</dt>
345<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 650<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
346</dt> 651</dt>
347<dd> 652<dd>
348Replace the foreground/background colour in the rendition mask with the 653Replace the foreground/background colour in the rendition mask with the
349specified one. 654specified one.
350</dd> 655</dd>
351<p></p> 656<p></p>
352<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 657<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
353</dt> 658</dt>
354<dd> 659<dd>
355Return the ``custom'' value: Every rendition has 5 bits for use by 660Return the ``custom'' value: Every rendition has 5 bits for use by
356extensions. They can be set and changed as you like and are initially 661extensions. They can be set and changed as you like and are initially
357zero. 662zero.
358</dd> 663</dd>
359<p></p> 664<p></p>
360<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 665<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
361</dt> 666</dt>
362<dd> 667<dd>
363Change the custom value. 668Change the custom value.
364</dd> 669</dd>
365<p></p></dl> 670<p></p></dl>
671<p>
672</p>
673<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
674<p>The sole purpose of this class is to deliver an interface to the
675<code>AnyEvent</code> module - any module using it will work inside urxvt without
676further programming. The only exception is that you cannot wait on
677condition variables, but non-blocking condvar use is ok. What this means
678is that you cannot use blocking APIs, but the non-blocking variant should
679work.</p>
366<p> 680<p>
367</p> 681</p>
368<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 682<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
369<dl> 683<dl>
684<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
685</dt>
686<dd>
687Creates a new terminal, very similar as if you had started it with system
688<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
689hash which defines the environment of the new terminal.
690</dd>
691<dd>
692<p>Croaks (and probably outputs an error message) if the new instance
693couldn't be created. Returns <code>undef</code> if the new instance didn't
694initialise perl, and the terminal object otherwise. The <code>init</code> and
695<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
696</dd>
697<p></p>
698<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
699</dt>
700<dd>
701Destroy the terminal object (close the window, free resources
702etc.). Please note that rxvt will not exit as long as any event
703watchers (timers, io watchers) are still active.
704</dd>
705<p></p>
706<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
707</dt>
708<dd>
709Returns true if the option specified by <code>$optval</code> is enabled, and
710optionally change it. All option values are stored by name in the hash
711<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
712</dd>
713<dd>
714<p>Here is a a likely non-exhaustive list of option names, please see the
715source file <em>/src/optinc.h</em> to see the actual list:</p>
716</dd>
717<dd>
718<pre>
719 borderLess console cursorBlink cursorUnderline hold iconic insecure
720 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
721 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
722 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
723 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
724 tripleclickwords utmpInhibit visualBell</pre>
725</dd>
726<p></p>
370<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 727<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
371</dt> 728</dt>
372<dd> 729<dd>
373Returns the current resource value associated with a given name and 730Returns the current resource value associated with a given name and
374optionally sets a new value. Setting values is most useful in the <code>init</code> 731optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
388<p>Please note that resource strings will currently only be freed when the 745<p>Please note that resource strings will currently only be freed when the
389terminal is destroyed, so changing options frequently will eat memory.</p> 746terminal is destroyed, so changing options frequently will eat memory.</p>
390</dd> 747</dd>
391<dd> 748<dd>
392<p>Here is a a likely non-exhaustive list of resource names, not all of which 749<p>Here is a a likely non-exhaustive list of resource names, not all of which
393are supported in every build, please see the source to see the actual 750are supported in every build, please see the source file <em>/src/rsinc.h</em>
394list:</p> 751to see the actual list:</p>
395</dd> 752</dd>
396<dd> 753<dd>
397<pre> 754<pre>
398 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 755 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
399 borderLess color cursorBlink cursorUnderline cutchars delete_key 756 borderLess color cursorBlink cursorUnderline cutchars delete_key
400 display_name embed ext_bwidth fade font geometry hold iconName 757 display_name embed ext_bwidth fade font geometry hold iconName
401 imFont imLocale inputMethod insecure int_bwidth intensityStyles 758 imFont imLocale inputMethod insecure int_bwidth intensityStyles
402 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 759 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
403 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 760 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
404 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 761 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
405 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 762 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
406 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 763 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
407 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 764 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
408 shade term_name title transparent transparent_all tripleclickwords 765 shade term_name title transparent transparent_all tripleclickwords
409 utmpInhibit visualBell</pre> 766 utmpInhibit visualBell</pre>
410</dd> 767</dd>
411<p></p> 768<p></p>
769<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
770</dt>
771<dd>
772Returns the X-Resource for the given pattern, excluding the program or
773class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
774same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
775resource with that pattern exists.
776</dd>
777<dd>
778<p>This method should only be called during the <code>on_start</code> hook, as there is
779only one resource database per display, and later invocations might return
780the wrong resources.</p>
781</dd>
782<p></p>
783<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
784</dt>
785<dd>
786Adds a keymap translation exactly as specified via a resource. See the
787<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
788</dd>
789<p></p>
790<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
791</dt>
792<dd>
793Return and optionally change the current rendition. Text that is output by
794the terminal application will use this style.
795</dd>
796<p></p>
797<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
798</dt>
799<dd>
800Return the current coordinates of the text cursor position and optionally
801set it (which is usually bad as applications don't expect that).
802</dd>
803<p></p>
412<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 804<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
413</dt> 805</dt>
414<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 806<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
415</dt> 807</dt>
416<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 808<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
418<dd> 810<dd>
419Return the current values of the selection mark, begin or end positions, 811Return the current values of the selection mark, begin or end positions,
420and optionally set them to new values. 812and optionally set them to new values.
421</dd> 813</dd>
422<p></p> 814<p></p>
815<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
816</dt>
817<dd>
818Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
819<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
820rectangular selection will be made. This is the prefered function to make
821a selection.
822</dd>
823<p></p>
423<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 824<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
424</dt> 825</dt>
425<dd> 826<dd>
426Try to request the primary selection from the server (for example, as set 827Try to request the primary selection text from the server (for example, as
427by the next method). 828set by the next method). No visual feedback will be given. This function
829is mostly useful from within <code>on_sel_grab</code> hooks.
428</dd> 830</dd>
429<p></p> 831<p></p>
430<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 832<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
431</dt> 833</dt>
432<dd> 834<dd>
433Return the current selection text and optionally replace it by <code>$newtext</code>. 835Return the current selection text and optionally replace it by <code>$newtext</code>.
434</dd> 836</dd>
837<p></p>
838<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
839</dt>
435<dd> 840<dd>
436<p>#=item $term-&gt;overlay ($x, $y, $text)
437#
438#Create a simple multi-line overlay box. See the next method for details. 841Create a simple multi-line overlay box. See the next method for details.
439#
440#=cut</p>
441</dd>
442<dd>
443<p>sub urxvt::term::scr_overlay {
444die;
445 my ($self, $x, $y, $text) = @_;</p>
446</dd>
447<dd>
448<pre>
449 my @lines = split /\n/, $text;</pre>
450</dd>
451<dd>
452<pre>
453 my $w = 0;
454 for (map $self-&gt;strwidth ($_), @lines) {
455 $w = $_ if $w &lt; $_;
456 }</pre>
457</dd>
458<dd>
459<pre>
460 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
461 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
462}</pre>
463</dd> 842</dd>
464<p></p> 843<p></p>
465<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 844<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
466</dt> 845</dt>
467<dd> 846<dd>
… …
503</dt> 882</dt>
504<dd> 883<dd>
505If hidden, display the overlay again. 884If hidden, display the overlay again.
506</dd> 885</dd>
507<p></p></dl> 886<p></p></dl>
887<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
888</dt>
889<dd>
890Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
891<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
892currently).
893</dd>
894<p></p>
508<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 895<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
509</dt> 896</dt>
510<dd> 897<dd>
511Returns the number of screen-cells this string would need. Correctly 898Returns the number of screen-cells this string would need. Correctly
512accounts for wide and combining characters. 899accounts for wide and combining characters.
513</dd> 900</dd>
514<p></p> 901<p></p>
515<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 902<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
516</dt> 903</dt>
517<dd> 904<dd>
518Convert the given text string into the corresponding locale encoding. 905Convert the given text string into the corresponding locale encoding.
519</dd> 906</dd>
520<p></p> 907<p></p>
521<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 908<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
522</dt> 909</dt>
523<dd> 910<dd>
524Convert the given locale-encoded octets into a perl string. 911Convert the given locale-encoded octets into a perl string.
912</dd>
913<p></p>
914<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
915</dt>
916<dd>
917XORs the rendition values in the given span with the provided value
918(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
919refresh hooks to provide effects similar to the selection.
920</dd>
921<p></p>
922<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
923</dt>
924<dd>
925Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
926whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
927to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
928it instead. Both styles <em>MUST NOT</em> contain font styles.
929</dd>
930<p></p>
931<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
932</dt>
933<dd>
934Ring the bell!
935</dd>
936<p></p>
937<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
938</dt>
939<dd>
940Write the given text string to the screen, as if output by the application
941running inside the terminal. It may not contain command sequences (escape
942codes), but is free to use line feeds, carriage returns and tabs. The
943string is a normal text string, not in locale-dependent encoding.
944</dd>
945<dd>
946<p>Normally its not a good idea to use this function, as programs might be
947confused by changes in cursor position or scrolling. Its useful inside a
948<code>on_add_lines</code> hook, though.</p>
949</dd>
950<p></p>
951<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
952</dt>
953<dd>
954Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
955locale-specific encoding of the terminal and can contain command sequences
956(escape codes) that will be interpreted.
525</dd> 957</dd>
526<p></p> 958<p></p>
527<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 959<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
528</dt> 960</dt>
529<dd> 961<dd>
530Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 962Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
531pass characters instead of octets, you should convert your strings first 963pass characters instead of octets, you should convert your strings first
532to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 964to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
533</dd> 965</dd>
534<p></p> 966<p></p>
967<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
968</dt>
969<dd>
970Replaces the event mask of the pty watcher by the given event mask. Can
971be used to suppress input and output handling to the pty/tty. See the
972description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
973the previous value.
974</dd>
975<p></p>
976<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
977</dt>
978<dd>
979Return the window id of the toplevel window.
980</dd>
981<p></p>
982<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
983</dt>
984<dd>
985Return the window id of the terminal window.
986</dd>
987<p></p>
988<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
989</dt>
990<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
991</dt>
992<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
993</dt>
994<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
995</dt>
996<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
997</dt>
535<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 998<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
536</dt> 999</dt>
537<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 1000<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
538</dt> 1001</dt>
539<dd> 1002<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
540Return the number of rows/columns of the terminal window (i.e. as 1003</dt>
541specified by <code>-geometry</code>, excluding any scrollback). 1004<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1005</dt>
1006<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1007</dt>
1008<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1009</dt>
1010<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
1011</dt>
542</dd> 1012<dd>
1013Return various integers describing terminal characteristics.
1014</dd>
543<p></p> 1015<p></p>
1016<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1017</dt>
1018<dd>
1019Return the DISPLAY used by rxvt-unicode.
1020</dd>
1021<p></p>
1022<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1023</dt>
1024<dd>
1025Returns the LC_CTYPE category string used by this rxvt-unicode.
1026</dd>
1027<p></p>
544<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 1028<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
545</dt> 1029</dt>
1030<dd>
1031Returns a copy of the environment in effect for the terminal as a hashref
1032similar to <code>\%ENV</code>.
546<dd> 1033</dd>
547Returns the number of lines in the scrollback buffer. 1034<p></p>
1035<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1036</dt>
1037<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1038</dt>
1039<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1040</dt>
1041<dd>
1042Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1043AltGr), the meta key (often Alt) and the num lock key, if applicable.
548</dd> 1044</dd>
549<p></p> 1045<p></p>
550<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1046<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
551</dt> 1047</dt>
552<dd> 1048<dd>
… …
580line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1076line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
581to replace only parts of a line. The font index in the rendition will 1077to replace only parts of a line. The font index in the rendition will
582automatically be updated.</p> 1078automatically be updated.</p>
583</dd> 1079</dd>
584<dd> 1080<dd>
585<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 1081<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
586than one cell when displayed are padded with urxvt::NOCHAR characters 1082than one cell when displayed are padded with urxvt::NOCHAR characters
587(<code>chr 65535</code>). Characters with combining characters and other characters 1083(<code>chr 65535</code>). Characters with combining characters and other characters
588that do not fit into the normal tetx encoding will be replaced with 1084that do not fit into the normal tetx encoding will be replaced with
589characters in the private use area.</p> 1085characters in the private use area.</p>
590</dd> 1086</dd>
… …
592<p>You have to obey this encoding when changing text. The advantage is 1088<p>You have to obey this encoding when changing text. The advantage is
593that <code>substr</code> and similar functions work on screen cells and not on 1089that <code>substr</code> and similar functions work on screen cells and not on
594characters.</p> 1090characters.</p>
595</dd> 1091</dd>
596<dd> 1092<dd>
597<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 1093<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>
598can be used to convert normal strings into this encoding and vice versa.</p> 1094can be used to convert normal strings into this encoding and vice versa.</p>
599</dd> 1095</dd>
600<p></p> 1096<p></p>
601<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1097<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
602</dt> 1098</dt>
… …
635Create and return a new <code>urxvt::line</code> object that stores information 1131Create and return a new <code>urxvt::line</code> object that stores information
636about the logical line that row <code>$row_number</code> is part of. It supports the 1132about the logical line that row <code>$row_number</code> is part of. It supports the
637following methods: 1133following methods:
638</dd> 1134</dd>
639<dl> 1135<dl>
640<dt><strong><a name="item_t">$text = $line-&gt;t</a></strong><br /> 1136<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
641</dt> 1137</dt>
642<dd> 1138<dd>
643Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 1139Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
644</dd> 1140</dd>
645<p></p> 1141<p></p>
646<dt><strong><a name="item_r">$rend = $line-&gt;r</a></strong><br /> 1142<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
647</dt> 1143</dt>
648<dd> 1144<dd>
649Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> 1145Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
650</dd> 1146</dd>
651<p></p> 1147<p></p>
652<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br /> 1148<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
653</dt> 1149</dt>
654<dd> 1150<dd>
… …
665<p></p> 1161<p></p>
666<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1162<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
667</dt> 1163</dt>
668<dd> 1164<dd>
669Returns the character offset of the given row|col pair within the logical 1165Returns the character offset of the given row|col pair within the logical
670line. 1166line. Works for rows outside the line, too, and returns corresponding
1167offsets outside the string.
671</dd> 1168</dd>
672<p></p> 1169<p></p>
673<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1170<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
674</dt> 1171</dt>
675<dd> 1172<dd>
676Translates a string offset into terminal coordinates again. 1173Translates a string offset into terminal coordinates again.
677</dd> 1174</dd>
678<p></p></dl> 1175<p></p></dl>
679<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1176<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
680=item $text = $term-&gt;special_encode $string</strong><br />
681</dt> 1177</dt>
682<dd> 1178<dd>
683Converts a perl string into the special encoding used by rxvt-unicode, 1179Converts a perl string into the special encoding used by rxvt-unicode,
684where one character corresponds to one screen cell. See 1180where one character corresponds to one screen cell. See
685<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1181<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
688<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br /> 1184<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
689</dt> 1185</dt>
690<dd> 1186<dd>
691Converts rxvt-unicodes text reprsentation into a perl string. See 1187Converts rxvt-unicodes text reprsentation into a perl string. See
692<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1188<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1189</dd>
1190<p></p>
1191<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1192</dt>
1193<dd>
1194Registers a synchronous button grab. See the XGrabButton manpage.
1195</dd>
1196<p></p>
1197<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1198</dt>
1199<dd>
1200Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1201synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1202</dd>
1203<p></p>
1204<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1205</dt>
1206<dd>
1207Calls XAllowEvents with AsyncBoth for the most recent grab.
1208</dd>
1209<p></p>
1210<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1211</dt>
1212<dd>
1213Calls XAllowEvents with SyncBoth for the most recent grab.
1214</dd>
1215<p></p>
1216<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1217</dt>
1218<dd>
1219Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1220recent grab.
1221</dd>
1222<p></p>
1223<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1224</dt>
1225<dd>
1226Calls XUngrab for the most recent grab. Is called automatically on
1227evaluation errors, as it is better to lose the grab in the error case as
1228the session.
1229</dd>
1230<p></p></dl>
1231<p>
1232</p>
1233<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1234<dl>
1235<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1236</dt>
1237<dd>
1238Adds a non-clickable title to the popup.
1239</dd>
1240<p></p>
1241<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1242</dt>
1243<dd>
1244Creates a separator, optionally using the character given as <code>$sepchr</code>.
1245</dd>
1246<p></p>
1247<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1248</dt>
1249<dd>
1250Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1251selected.
1252</dd>
1253<p></p>
1254<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1255</dt>
1256<dd>
1257Adds a toggle/checkbox item to the popup. Teh callback gets called
1258whenever it gets toggled, with a boolean indicating its value as its first
1259argument.
1260</dd>
1261<p></p>
1262<dt><strong>$popup-&gt;show</strong><br />
1263</dt>
1264<dd>
1265Displays the popup (which is initially hidden).
693</dd> 1266</dd>
694<p></p></dl> 1267<p></p></dl>
695<p> 1268<p>
696</p> 1269</p>
697<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1270<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
… …
765<pre> 1338<pre>
766 $term-&gt;{socket} = ... 1339 $term-&gt;{socket} = ...
767 $term-&gt;{iow} = urxvt::iow 1340 $term-&gt;{iow} = urxvt::iow
768 -&gt;new 1341 -&gt;new
769 -&gt;fd (fileno $term-&gt;{socket}) 1342 -&gt;fd (fileno $term-&gt;{socket})
770 -&gt;events (1) # wait for read data 1343 -&gt;events (urxvt::EVENT_READ)
771 -&gt;start 1344 -&gt;start
772 -&gt;cb (sub { 1345 -&gt;cb (sub {
773 my ($iow, $revents) = @_; 1346 my ($iow, $revents) = @_;
774 # $revents must be 1 here, no need to check 1347 # $revents must be 1 here, no need to check
775 sysread $term-&gt;{socket}, my $buf, 8192 1348 sysread $term-&gt;{socket}, my $buf, 8192
… …
796</dd> 1369</dd>
797<p></p> 1370<p></p>
798<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1371<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
799</dt> 1372</dt>
800<dd> 1373<dd>
801Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1374Set the event mask to watch. The only allowed values are
802data, Bit #1 (value <code>2</code>) enables watching for write data. 1375<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1376together, or <code>urxvt::EVENT_NONE</code>.
803</dd> 1377</dd>
804<p></p> 1378<p></p>
805<dt><strong>$iow = $iow-&gt;start</strong><br /> 1379<dt><strong>$iow = $iow-&gt;start</strong><br />
806</dt> 1380</dt>
807<dd> 1381<dd>
… …
821<p> 1395<p>
822</p> 1396</p>
823<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1397<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
824<p>This variable controls the verbosity level of the perl extension. Higher 1398<p>This variable controls the verbosity level of the perl extension. Higher
825numbers indicate more verbose output.</p> 1399numbers indicate more verbose output.</p>
826<ol> 1400<dl>
827<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1401<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
828</li> 1402</dt>
829<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1403<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1404</dt>
1405<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1406</dt>
1407<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1408</dt>
830</li> 1409</dl>
831<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br />
832</li>
833</ol>
834<p> 1410<p>
835</p> 1411</p>
836<hr /> 1412<hr />
837<h1><a name="author">AUTHOR</a></h1> 1413<h1><a name="author">AUTHOR</a></h1>
838<pre> 1414<pre>

Diff Legend

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