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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.15 by root, Sun Jan 8 00:20:12 2006 UTC vs.
Revision 1.33 by root, Thu Jan 19 19:26:31 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>
27 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
28 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
29 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
30 </ul> 33 </ul>
… …
70thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
71<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
72scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
73<p> 76<p>
74</p> 77</p>
75<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
76<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
77find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
78<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
79<pre> 83<pre>
80 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
81<dl> 85<dl>
82<dt><strong><a name="item_selection">selection</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
83</dt> 87</dt>
84<dd>
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> 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>.
90<dd> 94</dd>
91<p>It also offers the following bindable event:</p> 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>
125<p>This extension also offers following bindable keyboard commands:</p>
92</dd> 126</dd>
93<dl> 127<dl>
94<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
95</dt> 129</dt>
96<dd> 130<dd>
… …
99<dd> 133<dd>
100<pre> 134<pre>
101 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
102</dd> 136</dd>
103<p></p></dl> 137<p></p></dl>
104<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 138<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
105</dt> 139</dt>
140<dd>
141Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
142runtime.
106<dd> 143</dd>
107Displays a digital clock using the built-in overlay. 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<dd>
153<p>Other extensions can extend this popup menu by pushing a code reference
154onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
155popup is displayed.</p>
156</dd>
157<dd>
158<p>It's sole argument is the popup menu, which can be modified. The selection
159is in <code>$_</code>, which can be used to decide wether to add something or not.
160It should either return nothing or a string and a code reference. The
161string will be used as button text and the code reference will be called
162when the button gets activated and should transform <code>$_</code>.</p>
163</dd>
164<dd>
165<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
166the selection to <code>b</code>s, but only if the selection currently contains any
167<code>a</code>s:</p>
168</dd>
169<dd>
170<pre>
171 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
172 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
173 : ()
174 };</pre>
175</dd>
176<p></p>
177<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
178</dt>
179<dd>
180Adds regex search functionality to the scrollback buffer, triggered
181by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
182input/output is suspended and a regex is displayed at the bottom of the
183screen.
184</dd>
185<dd>
186<p>Inputting characters appends them to the regex and continues incremental
187search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
188search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
189bottom. <code>Escape</code> leaves search mode and returns to the point where search
190was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
191additionally stores the first match in the current line into the primary
192selection.</p>
193</dd>
194<p></p>
195<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
196</dt>
197<dd>
198This selection allows you to do automatic transforms on a selection
199whenever a selection is made.
200</dd>
201<dd>
202<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
203operator) that modify <code>$_</code> as resources:</p>
204</dd>
205<dd>
206<pre>
207 URxvt.selection-autotransform.0: transform
208 URxvt.selection-autotransform.1: transform
209 ...</pre>
210</dd>
211<dd>
212<p>For example, the following will transform selections of the form
213<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
214$word</code>:</p>
215</dd>
216<dd>
217<pre>
218 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
219</dd>
220<dd>
221<p>And this example matches the same,but replaces it with vi-commands you can
222paste directly into your (vi :) editor:</p>
223</dd>
224<dd>
225<pre>
226 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
227</dd>
228<dd>
229<p>Of course, this can be modified to suit your needs and your editor :)</p>
230</dd>
231<dd>
232<p>To expand the example above to typical perl error messages (``XXX at
233FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
234</dd>
235<dd>
236<pre>
237 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
238 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
239</dd>
240<dd>
241<p>The first line tells the selection code to treat the unchanging part of
242every error message as a selection pattern, and the second line transforms
243the message into vi commands to load the file.</p>
108</dd> 244</dd>
109<p></p> 245<p></p>
110<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 246<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
111</dt> 247</dt>
112<dd> 248<dd>
113Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 249Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
250make them clickable. When middle-clicked, the program specified in the
251resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
252the URL as first argument.
253</dd>
254<p></p>
255<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
256</dt>
257<dd>
258This is basically a one-line extension that dynamically changes the background pixmap offset
259to the window position, in effect creating the same effect as pseudo transparency with
260a custom pixmap. No scaling is supported in this mode. Exmaple:
261</dd>
262<dd>
263<pre>
264 rxvt -pixmap background.xpm -pe automove-background</pre>
114</dd> 265</dd>
115<p></p> 266<p></p>
116<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 267<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
117</dt> 268</dt>
118<dd> 269<dd>
119A not very useful example of filtering all text output to the terminal, 270A not very useful example of filtering all text output to the terminal,
120by replacing all line-drawing characters (U+2500 .. U+259F) by a 271by replacing all line-drawing characters (U+2500 .. U+259F) by a
121similar-looking ascii character. 272similar-looking ascii character.
122</dd> 273</dd>
123<p></p> 274<p></p>
275<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
276</dt>
277<dd>
278Displays a digital clock using the built-in overlay.
279</dd>
280<p></p>
124<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 281<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
125</dt> 282</dt>
126<dd> 283<dd>
127Displays a very simple digital clock in the upper right corner of the 284Displays a very simple digital clock in the upper right corner of the
128window. Illustrates overwriting the refresh callbacks to create your own 285window. Illustrates overwriting the refresh callbacks to create your own
129overlays or changes. 286overlays or changes.
130</dd> 287</dd>
288<p></p>
289<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
290</dt>
291<dd>
292This is a little rarely useful extension that Uploads the selection as
293textfile to a remote site (or does other things). (The implementation is
294not currently secure for use in a multiuser environment as it writes to
295<em>/tmp</em> directly.).
296</dd>
297<dd>
298<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
299i.e.</p>
300</dd>
301<dd>
302<pre>
303 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
304</dd>
305<dd>
306<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
307the textfile. This command can be set via a resource:</p>
308</dd>
309<dd>
310<pre>
311 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
312</dd>
313<dd>
314<p>And the default is likely not useful to anybody but the few people around
315here :)</p>
316</dd>
317<dd>
318<p>The name of the textfile is the hex encoded md5 sum of the selection, so
319the same content should lead to the same filename.</p>
320</dd>
321<dd>
322<p>After a successful upload the selection will be replaced by the text given
323in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
324for the filename):</p>
325</dd>
326<dd>
327<pre>
328 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
329</dd>
131<p></p></dl> 330<p></p></dl>
331<p>
332</p>
333<hr />
334<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
132<p> 335<p>
133</p> 336</p>
134<h2><a name="general_api_considerations">General API Considerations</a></h2> 337<h2><a name="general_api_considerations">General API Considerations</a></h2>
135<p>All objects (such as terminals, time watchers etc.) are typical 338<p>All objects (such as terminals, time watchers etc.) are typical
136reference-to-hash objects. The hash can be used to store anything you 339reference-to-hash objects. The hash can be used to store anything you
… …
146<dl> 349<dl>
147<dt><strong><a name="item__24text">$text</a></strong><br /> 350<dt><strong><a name="item__24text">$text</a></strong><br />
148</dt> 351</dt>
149<dd> 352<dd>
150Rxvt-unicodes special way of encoding text, where one ``unicode'' character 353Rxvt-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. 354always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
152</dd> 355</dd>
153<p></p> 356<p></p>
154<dt><strong><a name="item__24string">$string</a></strong><br /> 357<dt><strong><a name="item__24string">$string</a></strong><br />
155</dt> 358</dt>
156<dd> 359<dd>
… …
166locale-specific way. 369locale-specific way.
167</dd> 370</dd>
168<p></p></dl> 371<p></p></dl>
169<p> 372<p>
170</p> 373</p>
374<h2><a name="extension_objects">Extension Objects</a></h2>
375<p>Very perl extension is a perl class. A separate perl object is created
376for each terminal and each extension and passed as the first parameter to
377hooks. So extensions can use their <code>$self</code> object without having to think
378about other extensions, with the exception of methods and members that
379begin with an underscore character <code>_</code>: these are reserved for internal
380use.</p>
381<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
382<code>urxvt::term</code> class on this object.</p>
383<p>It has the following methods and data members:</p>
384<dl>
385<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
386</dt>
387<dd>
388Returns the <code>urxvt::term</code> object associated with this instance of the
389extension. This member <em>must not</em> be changed in any way.
390</dd>
391<p></p>
392<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
393</dt>
394<dd>
395Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
396this extension, replacing any previous hook. This is useful when you want
397to overwrite time-critical hooks only temporarily.
398</dd>
399<p></p>
400<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
401</dt>
402<dd>
403Dynamically disable the given hooks.
404</dd>
405<p></p></dl>
406<p>
407</p>
171<h2><a name="hooks">Hooks</a></h2> 408<h2><a name="hooks">Hooks</a></h2>
172<p>The following subroutines can be declared in extension files, and will be 409<p>The following subroutines can be declared in extension files, and will be
173called whenever the relevant event happens.</p> 410called whenever the relevant event happens.</p>
174<p>The first argument passed to them is an object private to each terminal 411<p>The first argument passed to them is an extension oject as described in
175and extension package. You can call all <code>urxvt::term</code> methods on it, but 412the in the <code>Extension Objects</code> section.</p>
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>
180<p>All of them must return a boolean value. If it is true, then the event 413<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
181counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 414event counts as being <em>consumed</em>, and the invocation of other hooks is
182and the relevant action might not be carried out by the C++ code.</p> 415skipped, and the relevant action might not be carried out by the C++ code.</p>
183<p>When in doubt, return a false value (preferably <code>()</code>).</p> 416<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
184<dl> 417<dl>
185<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 418<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
186</dt> 419</dt>
187<dd> 420<dd>
188Called after a new terminal object has been initialized, but before 421Called after a new terminal object has been initialized, but before
… …
205<dd> 438<dd>
206Called at the very end of initialisation of a new terminal, just before 439Called at the very end of initialisation of a new terminal, just before
207returning to the mainloop. 440returning to the mainloop.
208</dd> 441</dd>
209<p></p> 442<p></p>
443<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
444</dt>
445<dd>
446Called just after the child process has been <code>fork</code>ed.
447</dd>
448<p></p>
449<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
450</dt>
451<dd>
452Called just after the child process has exited. <code>$status</code> is the status
453from <code>waitpid</code>.
454</dd>
455<p></p>
210<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 456<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
211</dt> 457</dt>
212<dd> 458<dd>
213Called whenever a selection has been made by the user, but before the 459Called whenever a selection has been made by the user, but before the
214selection text is copied, so changes to the beginning, end or type of the 460selection text is copied, so changes to the beginning, end or type of the
… …
234</dt> 480</dt>
235<dd> 481<dd>
236Called whenever the user tries to extend the selection (e.g. with a double 482Called whenever the user tries to extend the selection (e.g. with a double
237click) and is either supposed to return false (normal operation), or 483click) and is either supposed to return false (normal operation), or
238should extend the selection itelf and return true to suppress the built-in 484should extend the selection itelf and return true to suppress the built-in
239processing. 485processing. This can happen multiple times, as long as the callback
486returns true, it will be called on every further click by the user and is
487supposed to enlarge the selection more and more, if possible.
240</dd> 488</dd>
241<dd> 489<dd>
242<p>See the <em>selection</em> example extension.</p> 490<p>See the <em>selection</em> example extension.</p>
243</dd> 491</dd>
244<p></p> 492<p></p>
… …
259</dd> 507</dd>
260<dd> 508<dd>
261<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 509<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
262$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 510$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
263number of lines that will be in the scrollback buffer.</p> 511number of lines that will be in the scrollback buffer.</p>
264</dd>
265<p></p>
266<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
267</dt>
268<dd>
269Called whenever the <code>program(s)</code> running in the urxvt window send output.
270</dd> 512</dd>
271<p></p> 513<p></p>
272<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 514<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
273</dt> 515</dt>
274<dd> 516<dd>
… …
293and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 535and 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 536might be very slow, however, as your hook is called for <strong>all</strong> text being
295output. 537output.
296</dd> 538</dd>
297<p></p> 539<p></p>
540<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
541</dt>
542<dd>
543Called whenever some data is written to the tty/pty and can be used to
544suppress or filter tty input.
545</dd>
546<p></p>
298<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 547<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
299</dt> 548</dt>
300<dd> 549<dd>
301Called whenever a line was updated or changed. Can be used to filter 550Called whenever a line was updated or changed. Can be used to filter
302screen output (e.g. underline urls or other useless stuff). Only lines 551screen output (e.g. underline urls or other useless stuff). Only lines
… …
334Called whenever the user presses a key combination that has a 583Called whenever the user presses a key combination that has a
335<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 584<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
336resource in the <code>rxvt(1)</code> manpage). 585resource in the <code>rxvt(1)</code> manpage).
337</dd> 586</dd>
338<p></p> 587<p></p>
588<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
589</dt>
590<dd>
591Called on every X event received on the vt window (and possibly other
592windows). Should only be used as a last resort. Most event structure
593members are not passed.
594</dd>
595<p></p>
339<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 596<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
340</dt> 597</dt>
341<dd> 598<dd>
342Called whenever the window gets the keyboard focus, before rxvt-unicode 599Called whenever the window gets the keyboard focus, before rxvt-unicode
343does focus in processing. 600does focus in processing.
… …
348<dd> 605<dd>
349Called wheneever the window loses keyboard focus, before rxvt-unicode does 606Called wheneever the window loses keyboard focus, before rxvt-unicode does
350focus out processing. 607focus out processing.
351</dd> 608</dd>
352<p></p> 609<p></p>
610<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
611</dt>
353<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 612<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
354</dt> 613</dt>
355<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 614<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
356</dt> 615</dt>
357<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 616<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
358</dt> 617</dt>
359<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 618<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
360</dt> 619</dt>
… …
383<p></p></dl> 642<p></p></dl>
384<p> 643<p>
385</p> 644</p>
386<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 645<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
387<dl> 646<dl>
647<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
648</dt>
649<dd>
650The rxvt-unicode library directory, where, among other things, the perl
651modules and scripts are stored.
652</dd>
653<p></p>
654<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
655</dt>
656<dd>
657The resource class and name rxvt-unicode uses to look up X resources.
658</dd>
659<p></p>
660<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
661</dt>
662<dd>
663The basename of the installed binaries, usually <code>urxvt</code>.
664</dd>
665<p></p>
388<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 666<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
389</dt> 667</dt>
390<dd> 668<dd>
391The current terminal. This variable stores the current <code>urxvt::term</code> 669The current terminal. This variable stores the current <code>urxvt::term</code>
392object, whenever a callback/hook is executing. 670object, whenever a callback/hook is executing.
… …
394<p></p></dl> 672<p></p></dl>
395<p> 673<p>
396</p> 674</p>
397<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 675<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
398<dl> 676<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>
409<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 677<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
410</dt> 678</dt>
411<dd> 679<dd>
412Fatally aborts execution with the given error message. Avoid at all 680Fatally aborts execution with the given error message. Avoid at all
413costs! The only time this is acceptable is when the terminal process 681costs! The only time this is acceptable is when the terminal process
… …
423</dd> 691</dd>
424<dd> 692<dd>
425<p>Using this function has the advantage that its output ends up in the 693<p>Using this function has the advantage that its output ends up in the
426correct place, e.g. on stderr of the connecting urxvtc client.</p> 694correct place, e.g. on stderr of the connecting urxvtc client.</p>
427</dd> 695</dd>
696<dd>
697<p>Messages have a size limit of 1023 bytes currently.</p>
698</dd>
428<p></p> 699<p></p>
429<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 700<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
430</dt> 701</dt>
431<dd> 702<dd>
432Returns the ``current time'' (as per the event loop). 703Returns the ``current time'' (as per the event loop).
… …
436</dt> 707</dt>
437<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 708<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
438Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 709Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
439Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 710Button4Mask, Button5Mask, AnyModifier</a></strong><br />
440</dt> 711</dt>
712<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
713ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
714PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
715Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
716KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
717ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
718FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
719</dt>
720<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
721EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
722GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
723UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
724ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
725CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
726SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
727</dt>
441<dd> 728<dd>
442Various constants for use in X events. 729Various constants for use in X calls and event processing.
443</dd> 730</dd>
444<p></p></dl> 731<p></p></dl>
445<p> 732<p>
446</p> 733</p>
447<h2><a name="rendition">RENDITION</a></h2> 734<h2><a name="rendition">RENDITION</a></h2>
… …
479</dt> 766</dt>
480<dd> 767<dd>
481Return the foreground/background colour index, respectively. 768Return the foreground/background colour index, respectively.
482</dd> 769</dd>
483<p></p> 770<p></p>
484<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 771<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
485</dt> 772</dt>
486<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 773<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
487</dt> 774</dt>
488<dd> 775<dd>
489Replace the foreground/background colour in the rendition mask with the 776Replace the foreground/background colour in the rendition mask with the
490specified one. 777specified one.
491</dd> 778</dd>
492<p></p> 779<p></p>
493<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 780<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
494</dt> 781</dt>
495<dd> 782<dd>
496Return the ``custom'' value: Every rendition has 5 bits for use by 783Return the ``custom'' value: Every rendition has 5 bits for use by
497extensions. They can be set and changed as you like and are initially 784extensions. They can be set and changed as you like and are initially
498zero. 785zero.
499</dd> 786</dd>
500<p></p> 787<p></p>
501<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 788<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
502</dt> 789</dt>
503<dd> 790<dd>
504Change the custom value. 791Change the custom value.
505</dd> 792</dd>
506<p></p></dl> 793<p></p></dl>
794<p>
795</p>
796<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
797<p>The sole purpose of this class is to deliver an interface to the
798<code>AnyEvent</code> module - any module using it will work inside urxvt without
799further programming. The only exception is that you cannot wait on
800condition variables, but non-blocking condvar use is ok. What this means
801is that you cannot use blocking APIs, but the non-blocking variant should
802work.</p>
507<p> 803<p>
508</p> 804</p>
509<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 805<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
510<dl> 806<dl>
807<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
808</dt>
809<dd>
810Creates a new terminal, very similar as if you had started it with system
811<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
812hash which defines the environment of the new terminal.
813</dd>
814<dd>
815<p>Croaks (and probably outputs an error message) if the new instance
816couldn't be created. Returns <code>undef</code> if the new instance didn't
817initialise perl, and the terminal object otherwise. The <code>init</code> and
818<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
819</dd>
820<p></p>
511<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 821<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
512</dt> 822</dt>
513<dd> 823<dd>
514Destroy the terminal object (close the window, free resources etc.). 824Destroy the terminal object (close the window, free resources
825etc.). Please note that rxvt will not exit as long as any event
826watchers (timers, io watchers) are still active.
827</dd>
828<p></p>
829<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
830</dt>
831<dd>
832Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
833(``starts'') programs in the background. This function takes care of setting
834the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
835be preferred over explicit calls to <code>exec</code> or <code>system</code>.
836</dd>
837<dd>
838<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
515</dd> 839</dd>
516<p></p> 840<p></p>
517<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 841<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
518</dt> 842</dt>
519<dd> 843<dd>
… …
527</dd> 851</dd>
528<dd> 852<dd>
529<pre> 853<pre>
530 borderLess console cursorBlink cursorUnderline hold iconic insecure 854 borderLess console cursorBlink cursorUnderline hold iconic insecure
531 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 855 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
532 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 856 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
533 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 857 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
534 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 858 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
535 tripleclickwords utmpInhibit visualBell</pre> 859 transparent tripleclickwords utmpInhibit visualBell</pre>
536</dd> 860</dd>
537<p></p> 861<p></p>
538<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 862<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
539</dt> 863</dt>
540<dd> 864<dd>
… …
565<pre> 889<pre>
566 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 890 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
567 borderLess color cursorBlink cursorUnderline cutchars delete_key 891 borderLess color cursorBlink cursorUnderline cutchars delete_key
568 display_name embed ext_bwidth fade font geometry hold iconName 892 display_name embed ext_bwidth fade font geometry hold iconName
569 imFont imLocale inputMethod insecure int_bwidth intensityStyles 893 imFont imLocale inputMethod insecure int_bwidth intensityStyles
570 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 894 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
571 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 895 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
572 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 896 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
573 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 897 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
574 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 898 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
575 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 899 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
576 shade term_name title transparent transparent_all tripleclickwords 900 secondaryScreen secondaryScroll selectstyle shade term_name title
901 transient_for transparent transparent_all tripleclickwords utmpInhibit
577 utmpInhibit visualBell</pre> 902 visualBell</pre>
903</dd>
904<p></p>
905<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
906</dt>
907<dd>
908Returns the X-Resource for the given pattern, excluding the program or
909class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
910same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
911resource with that pattern exists.
912</dd>
913<dd>
914<p>This method should only be called during the <code>on_start</code> hook, as there is
915only one resource database per display, and later invocations might return
916the wrong resources.</p>
917</dd>
918<p></p>
919<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
920</dt>
921<dd>
922Adds a keymap translation exactly as specified via a resource. See the
923<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
578</dd> 924</dd>
579<p></p> 925<p></p>
580<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 926<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
581</dt> 927</dt>
582<dd> 928<dd>
… …
600<dd> 946<dd>
601Return the current values of the selection mark, begin or end positions, 947Return the current values of the selection mark, begin or end positions,
602and optionally set them to new values. 948and optionally set them to new values.
603</dd> 949</dd>
604<p></p> 950<p></p>
951<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
952</dt>
953<dd>
954Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
955<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
956rectangular selection will be made. This is the prefered function to make
957a selection.
958</dd>
959<p></p>
605<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 960<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
606</dt> 961</dt>
607<dd> 962<dd>
608Try to request the primary selection from the server (for example, as set 963Try to request the primary selection text from the server (for example, as
609by the next method). 964set by the next method). No visual feedback will be given. This function
965is mostly useful from within <code>on_sel_grab</code> hooks.
610</dd> 966</dd>
611<p></p> 967<p></p>
612<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 968<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
613</dt> 969</dt>
614<dd> 970<dd>
615Return the current selection text and optionally replace it by <code>$newtext</code>. 971Return the current selection text and optionally replace it by <code>$newtext</code>.
616</dd> 972</dd>
973<p></p>
974<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
975</dt>
617<dd> 976<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. 977Create 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> 978</dd>
638<p></p> 979<p></p>
639<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 980<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
640</dt> 981</dt>
641<dd> 982<dd>
… …
677</dt> 1018</dt>
678<dd> 1019<dd>
679If hidden, display the overlay again. 1020If hidden, display the overlay again.
680</dd> 1021</dd>
681<p></p></dl> 1022<p></p></dl>
682<dt><strong><a name="item_popup">$popup = $term-&gt;popup ($event)</a></strong><br /> 1023<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
683</dt> 1024</dt>
684<dd> 1025<dd>
685Creates a new <code>urxvt::popup</code> object that implements a popup menu. The 1026Creates 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, 1027<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
687currently). 1028currently).
… …
702<p></p> 1043<p></p>
703<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 1044<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
704</dt> 1045</dt>
705<dd> 1046<dd>
706Convert the given locale-encoded octets into a perl string. 1047Convert the given locale-encoded octets into a perl string.
1048</dd>
1049<p></p>
1050<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 />
1051</dt>
1052<dd>
1053XORs the rendition values in the given span with the provided value
1054(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
1055refresh hooks to provide effects similar to the selection.
1056</dd>
1057<p></p>
1058<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 />
1059</dt>
1060<dd>
1061Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
1062whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1063to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1064it instead. Both styles <em>MUST NOT</em> contain font styles.
1065</dd>
1066<p></p>
1067<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1068</dt>
1069<dd>
1070Ring the bell!
707</dd> 1071</dd>
708<p></p> 1072<p></p>
709<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 1073<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
710</dt> 1074</dt>
711<dd> 1075<dd>
… …
734Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1098Write 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 1099pass 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>. 1100to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
737</dd> 1101</dd>
738<p></p> 1102<p></p>
1103<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1104</dt>
1105<dd>
1106Replaces the event mask of the pty watcher by the given event mask. Can
1107be used to suppress input and output handling to the pty/tty. See the
1108description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1109the previous value.
1110</dd>
1111<p></p>
739<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1112<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
740</dt> 1113</dt>
741<dd> 1114<dd>
742Return the window id of the toplevel window. 1115Return the window id of the toplevel window.
743</dd> 1116</dd>
… …
746</dt> 1119</dt>
747<dd> 1120<dd>
748Return the window id of the terminal window. 1121Return the window id of the terminal window.
749</dd> 1122</dd>
750<p></p> 1123<p></p>
1124<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1125</dt>
1126<dd>
1127Adds the specified events to the vt event mask. Useful e.g. when you want
1128to receive pointer events all the times:
1129</dd>
1130<dd>
1131<pre>
1132 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1133</dd>
1134<p></p>
751<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1135<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
752</dt> 1136</dt>
753<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1137<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
754</dt> 1138</dt>
755<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1139<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
768</dt> 1152</dt>
769<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1153<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
770</dt> 1154</dt>
771<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1155<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
772</dt> 1156</dt>
773<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1157<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
774</dt> 1158</dt>
775<dd> 1159<dd>
776Return various integers describing terminal characteristics. 1160Return various integers describing terminal characteristics.
1161</dd>
1162<p></p>
1163<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1164</dt>
1165<dd>
1166Return the DISPLAY used by rxvt-unicode.
1167</dd>
1168<p></p>
1169<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1170</dt>
1171<dd>
1172Returns the LC_CTYPE category string used by this rxvt-unicode.
1173</dd>
1174<p></p>
1175<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1176</dt>
1177<dd>
1178Returns a copy of the environment in effect for the terminal as a hashref
1179similar to <code>\%ENV</code>.
777</dd> 1180</dd>
778<p></p> 1181<p></p>
779<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1182<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
780</dt> 1183</dt>
781<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1184<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
788</dd> 1191</dd>
789<p></p> 1192<p></p>
790<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1193<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
791</dt> 1194</dt>
792<dd> 1195<dd>
793Returns the negative row number of the topmost line. Minimum value is 1196Returns the row number of the topmost displayed line. Maximum value is
794<code>0</code>, which displays the normal terminal contents. Larger values scroll 1197<code>0</code>, which displays the normal terminal contents. Lower values scroll
795this many lines into the scrollback buffer. 1198this many lines into the scrollback buffer.
796</dd> 1199</dd>
797<p></p> 1200<p></p>
798<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1201<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
799</dt> 1202</dt>
… …
810</dt> 1213</dt>
811<dd> 1214<dd>
812Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1215Returns 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 1216is 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 1217terminal 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 1218line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
816is requested. 1219is requested.
817</dd> 1220</dd>
818<dd> 1221<dd>
819<p>If <code>$new_text</code> is specified, it will replace characters in the current 1222<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 1223line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
… …
832<p>You have to obey this encoding when changing text. The advantage is 1235<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 1236that <code>substr</code> and similar functions work on screen cells and not on
834characters.</p> 1237characters.</p>
835</dd> 1238</dd>
836<dd> 1239<dd>
837<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 1240<p>The methods <a href="#item_special_encode"><code>$term-&gt;special_encode</code></a> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
838can be used to convert normal strings into this encoding and vice versa.</p> 1241can be used to convert normal strings into this encoding and vice versa.</p>
839</dd> 1242</dd>
840<p></p> 1243<p></p>
841<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1244<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
842</dt> 1245</dt>
… …
905<p></p> 1308<p></p>
906<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1309<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
907</dt> 1310</dt>
908<dd> 1311<dd>
909Returns the character offset of the given row|col pair within the logical 1312Returns the character offset of the given row|col pair within the logical
910line. 1313line. Works for rows outside the line, too, and returns corresponding
1314offsets outside the string.
911</dd> 1315</dd>
912<p></p> 1316<p></p>
913<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1317<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
914</dt> 1318</dt>
915<dd> 1319<dd>
916Translates a string offset into terminal coordinates again. 1320Translates a string offset into terminal coordinates again.
917</dd> 1321</dd>
918<p></p></dl> 1322<p></p></dl>
919<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1323<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
920=item $text = $term-&gt;special_encode $string</strong><br />
921</dt> 1324</dt>
922<dd> 1325<dd>
923Converts a perl string into the special encoding used by rxvt-unicode, 1326Converts a perl string into the special encoding used by rxvt-unicode,
924where one character corresponds to one screen cell. See 1327where one character corresponds to one screen cell. See
925<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1328<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
929</dt> 1332</dt>
930<dd> 1333<dd>
931Converts rxvt-unicodes text reprsentation into a perl string. See 1334Converts rxvt-unicodes text reprsentation into a perl string. See
932<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1335<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
933</dd> 1336</dd>
1337<p></p>
1338<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1339</dt>
1340<dd>
1341Registers a synchronous button grab. See the XGrabButton manpage.
1342</dd>
1343<p></p>
1344<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1345</dt>
1346<dd>
1347Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1348synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1349</dd>
1350<p></p>
1351<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1352</dt>
1353<dd>
1354Calls XAllowEvents with AsyncBoth for the most recent grab.
1355</dd>
1356<p></p>
1357<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1358</dt>
1359<dd>
1360Calls XAllowEvents with SyncBoth for the most recent grab.
1361</dd>
1362<p></p>
1363<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1364</dt>
1365<dd>
1366Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1367recent grab.
1368</dd>
1369<p></p>
1370<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1371</dt>
1372<dd>
1373Calls XUngrab for the most recent grab. Is called automatically on
1374evaluation errors, as it is better to lose the grab in the error case as
1375the session.
1376</dd>
934<p></p></dl> 1377<p></p></dl>
935<p> 1378<p>
936</p> 1379</p>
937<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1380<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1381<dl>
1382<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1383</dt>
1384<dd>
1385Adds a non-clickable title to the popup.
1386</dd>
1387<p></p>
1388<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1389</dt>
1390<dd>
1391Creates a separator, optionally using the character given as <code>$sepchr</code>.
1392</dd>
1393<p></p>
1394<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1395</dt>
1396<dd>
1397Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1398selected.
1399</dd>
1400<p></p>
1401<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1402</dt>
1403<dd>
1404Adds a toggle/checkbox item to the popup. Teh callback gets called
1405whenever it gets toggled, with a boolean indicating its value as its first
1406argument.
1407</dd>
1408<p></p>
1409<dt><strong>$popup-&gt;show</strong><br />
1410</dt>
1411<dd>
1412Displays the popup (which is initially hidden).
1413</dd>
1414<p></p></dl>
938<p> 1415<p>
939</p> 1416</p>
940<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1417<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
941<p>This class implements timer watchers/events. Time is represented as a 1418<p>This class implements timer watchers/events. Time is represented as a
942fractional number of seconds since the epoch. Example:</p> 1419fractional number of seconds since the epoch. Example:</p>
… …
993</dt> 1470</dt>
994<dd> 1471<dd>
995Set the event trigger time to <code>$tstamp</code> and start the timer. 1472Set the event trigger time to <code>$tstamp</code> and start the timer.
996</dd> 1473</dd>
997<p></p> 1474<p></p>
1475<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1476</dt>
1477<dd>
1478Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1479</dd>
1480<p></p>
998<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1481<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
999</dt> 1482</dt>
1000<dd> 1483<dd>
1001Stop the timer. 1484Stop the timer.
1002</dd> 1485</dd>
… …
1008<pre> 1491<pre>
1009 $term-&gt;{socket} = ... 1492 $term-&gt;{socket} = ...
1010 $term-&gt;{iow} = urxvt::iow 1493 $term-&gt;{iow} = urxvt::iow
1011 -&gt;new 1494 -&gt;new
1012 -&gt;fd (fileno $term-&gt;{socket}) 1495 -&gt;fd (fileno $term-&gt;{socket})
1013 -&gt;events (1) # wait for read data 1496 -&gt;events (urxvt::EVENT_READ)
1014 -&gt;start 1497 -&gt;start
1015 -&gt;cb (sub { 1498 -&gt;cb (sub {
1016 my ($iow, $revents) = @_; 1499 my ($iow, $revents) = @_;
1017 # $revents must be 1 here, no need to check 1500 # $revents must be 1 here, no need to check
1018 sysread $term-&gt;{socket}, my $buf, 8192 1501 sysread $term-&gt;{socket}, my $buf, 8192
… …
1039</dd> 1522</dd>
1040<p></p> 1523<p></p>
1041<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1524<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1042</dt> 1525</dt>
1043<dd> 1526<dd>
1044Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1527Set the event mask to watch. The only allowed values are
1045data, Bit #1 (value <code>2</code>) enables watching for write data. 1528<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1529together, or <code>urxvt::EVENT_NONE</code>.
1046</dd> 1530</dd>
1047<p></p> 1531<p></p>
1048<dt><strong>$iow = $iow-&gt;start</strong><br /> 1532<dt><strong>$iow = $iow-&gt;start</strong><br />
1049</dt> 1533</dt>
1050<dd> 1534<dd>
… …
1065</p> 1549</p>
1066<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1550<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1067<p>This variable controls the verbosity level of the perl extension. Higher 1551<p>This variable controls the verbosity level of the perl extension. Higher
1068numbers indicate more verbose output.</p> 1552numbers indicate more verbose output.</p>
1069<dl> 1553<dl>
1070<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1554<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1071</dt> 1555</dt>
1072<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1556<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1073</dt> 1557</dt>
1074<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1558<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1559</dt>
1560<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1075</dt> 1561</dt>
1076</dl> 1562</dl>
1077<p> 1563<p>
1078</p> 1564</p>
1079<hr /> 1565<hr />

Diff Legend

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