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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.16 by root, Sun Jan 8 06:35:38 2006 UTC vs.
Revision 1.31 by root, Tue Jan 17 16:22:41 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>
26 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> 28 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
… …
71thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
72<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
73scripts will be shared (but not enabled) for all terminals.</p> 75scripts will be shared (but not enabled) for all terminals.</p>
74<p> 76<p>
75</p> 77</p>
76<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> 78<hr />
79<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1>
77<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
78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
79<p>You can activate them like this:</p> 82<p>You can activate them like this:</p>
80<pre> 83<pre>
81 rxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</pre>
82<dl> 85<dl>
83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 86<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
84</dt> 87</dt>
85<dd> 88<dd>
86Intelligent selection. This extension tries to be more intelligent when 89(More) intelligent selection. This extension tries to be more intelligent
87the user extends selections (double-click). Right now, it tries to select 90when the user extends selections (double-click and further clicks). Right
88urls and complete shell-quoted arguments, which is very convenient, too, 91now, it tries to select words, urls and complete shell-quoted
89if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92arguments, which is very convenient, too, if your <em>ls</em> supports
90</dd> 93<code>--quoting-style=shell</code>.
91<dd> 94</dd>
92<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>
93</dd> 126</dd>
94<dl> 127<dl>
95<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
96</dt> 129</dt>
97<dd> 130<dd>
… …
99</dd> 132</dd>
100<dd> 133<dd>
101<pre> 134<pre>
102 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
103</dd> 136</dd>
137<p></p>
138<dt><strong><a name="item_remote_2dpastebin">remote-pastebin</a></strong><br />
139</dt>
140<dd>
141Upload the selection as textfile to a remote site.
142</dd>
143<dd>
144<pre>
145 URxvt.keysym.C-M-e: perl:selection:remote-pastebin</pre>
146</dd>
147<dd>
148<p>To set the command to upload the file set this resource:</p>
149</dd>
150<dd>
151<pre>
152 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
153</dd>
154<dd>
155<p>The % is the placeholder for the textfile. The name of the textfile is the hex encoded
156md5 sum of the selection.
157After an successful upload the selection will be replaced by the following url
158(the % is the placeholder for the filename):</p>
159</dd>
160<dd>
161<pre>
162 URxvt.selection-pastebin-url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
163</dd>
104<p></p></dl> 164<p></p></dl>
105<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> 165<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
106</dt> 166</dt>
107<dd> 167<dd>
108Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at 168Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
109runtime. 169runtime.
110</dd> 170</dd>
111<p></p> 171<p></p>
112<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 172<dt><strong>selection-popup (enabled by default)</strong><br />
113</dt> 173</dt>
174<dd>
175Binds a popup menu to Ctrl-Button3 that lets you convert the selection
176text into various other formats/action (such as uri unescaping, perl
177evalution, web-browser starting etc.), depending on content.
114<dd> 178</dd>
115Displays a digital clock using the built-in overlay. 179<p></p>
180<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
181</dt>
182<dd>
183Adds regex search functionality to the scrollback buffer, triggered
184by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
185input/output is suspended and a regex is displayed at the bottom of the
186screen.
187</dd>
188<dd>
189<p>Inputting characters appends them to the regex and continues incremental
190search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
191search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
192bottom. <code>Escape</code> leaves search mode and returns to the point where search
193was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
194additionally stores the first match in the current line into the primary
195selection.</p>
196</dd>
197<p></p>
198<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
199</dt>
200<dd>
201This selection allows you to do automatic transforms on a selection
202whenever a selection is made.
203</dd>
204<dd>
205<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
206operator) that modify <code>$_</code> as resources:</p>
207</dd>
208<dd>
209<pre>
210 URxvt.selection-autotransform.0: transform
211 URxvt.selection-autotransform.1: transform
212 ...</pre>
213</dd>
214<dd>
215<p>For example, the following will transform selections of the form
216<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
217$word</code>:</p>
218</dd>
219<dd>
220<pre>
221 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
222</dd>
223<dd>
224<p>And this example matches the same,but replaces it with vi-commands you can
225paste directly into your (vi :) editor:</p>
226</dd>
227<dd>
228<pre>
229 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
230</dd>
231<dd>
232<p>Of course, this can be modified to suit your needs and your editor :)</p>
233</dd>
234<dd>
235<p>To expand the example above to typical perl error messages (``XXX at
236FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
237</dd>
238<dd>
239<pre>
240 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
241 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre>
242</dd>
243<dd>
244<p>The first line tells the selection code to treat the unchanging part of
245every error message as a selection pattern, and the second line transforms
246the message into vi commands to load the file.</p>
116</dd> 247</dd>
117<p></p> 248<p></p>
118<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 249<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
119</dt> 250</dt>
120<dd> 251<dd>
121Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 252Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
253make them clickable. When middle-clicked, the program specified in the
254resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
255the URL as first argument.
122</dd> 256</dd>
123<p></p> 257<p></p>
124<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 258<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
125</dt> 259</dt>
126<dd> 260<dd>
127A not very useful example of filtering all text output to the terminal, 261A not very useful example of filtering all text output to the terminal,
128by replacing all line-drawing characters (U+2500 .. U+259F) by a 262by replacing all line-drawing characters (U+2500 .. U+259F) by a
129similar-looking ascii character. 263similar-looking ascii character.
130</dd> 264</dd>
131<p></p> 265<p></p>
266<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
267</dt>
268<dd>
269Displays a digital clock using the built-in overlay.
270</dd>
271<p></p>
132<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 272<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
133</dt> 273</dt>
134<dd> 274<dd>
135Displays a very simple digital clock in the upper right corner of the 275Displays a very simple digital clock in the upper right corner of the
136window. Illustrates overwriting the refresh callbacks to create your own 276window. Illustrates overwriting the refresh callbacks to create your own
137overlays or changes. 277overlays or changes.
138</dd> 278</dd>
139<p></p></dl> 279<p></p></dl>
280<p>
281</p>
282<hr />
283<h1><a name="api_documentation">API DOCUMENTATION</a></h1>
140<p> 284<p>
141</p> 285</p>
142<h2><a name="general_api_considerations">General API Considerations</a></h2> 286<h2><a name="general_api_considerations">General API Considerations</a></h2>
143<p>All objects (such as terminals, time watchers etc.) are typical 287<p>All objects (such as terminals, time watchers etc.) are typical
144reference-to-hash objects. The hash can be used to store anything you 288reference-to-hash objects. The hash can be used to store anything you
… …
154<dl> 298<dl>
155<dt><strong><a name="item__24text">$text</a></strong><br /> 299<dt><strong><a name="item__24text">$text</a></strong><br />
156</dt> 300</dt>
157<dd> 301<dd>
158Rxvt-unicodes special way of encoding text, where one ``unicode'' character 302Rxvt-unicodes special way of encoding text, where one ``unicode'' character
159always represents one screen cell. See <em>row_t</em> for a discussion of this format. 303always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
160</dd> 304</dd>
161<p></p> 305<p></p>
162<dt><strong><a name="item__24string">$string</a></strong><br /> 306<dt><strong><a name="item__24string">$string</a></strong><br />
163</dt> 307</dt>
164<dd> 308<dd>
… …
174locale-specific way. 318locale-specific way.
175</dd> 319</dd>
176<p></p></dl> 320<p></p></dl>
177<p> 321<p>
178</p> 322</p>
323<h2><a name="extension_objects">Extension Objects</a></h2>
324<p>Very perl extension is a perl class. A separate perl object is created
325for each terminal and each extension and passed as the first parameter to
326hooks. So extensions can use their <code>$self</code> object without having to think
327about other extensions, with the exception of methods and members that
328begin with an underscore character <code>_</code>: these are reserved for internal
329use.</p>
330<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
331<code>urxvt::term</code> class on this object.</p>
332<p>It has the following methods and data members:</p>
333<dl>
334<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br />
335</dt>
336<dd>
337Returns the <code>urxvt::term</code> object associated with this instance of the
338extension. This member <em>must not</em> be changed in any way.
339</dd>
340<p></p>
341<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
342</dt>
343<dd>
344Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
345this extension, replacing any previous hook. This is useful when you want
346to overwrite time-critical hooks only temporarily.
347</dd>
348<p></p>
349<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
350</dt>
351<dd>
352Dynamically disable the given hooks.
353</dd>
354<p></p></dl>
355<p>
356</p>
179<h2><a name="hooks">Hooks</a></h2> 357<h2><a name="hooks">Hooks</a></h2>
180<p>The following subroutines can be declared in extension files, and will be 358<p>The following subroutines can be declared in extension files, and will be
181called whenever the relevant event happens.</p> 359called whenever the relevant event happens.</p>
182<p>The first argument passed to them is an object private to each terminal 360<p>The first argument passed to them is an extension oject as described in
183and extension package. You can call all <code>urxvt::term</code> methods on it, but 361the in the <code>Extension Objects</code> section.</p>
184its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
185object that is shared between all packages is stored in the <code>term</code>
186member. It is, however, blessed intot he package of the extension script,
187so for all practical purposes you can treat an extension script as a class.</p>
188<p>All of them must return a boolean value. If it is true, then the event 362<p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the
189counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 363event counts as being <em>consumed</em>, and the invocation of other hooks is
190and the relevant action might not be carried out by the C++ code.</p> 364skipped, and the relevant action might not be carried out by the C++ code.</p>
191<p>When in doubt, return a false value (preferably <code>()</code>).</p> 365<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p>
192<dl> 366<dl>
193<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 367<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
194</dt> 368</dt>
195<dd> 369<dd>
196Called after a new terminal object has been initialized, but before 370Called after a new terminal object has been initialized, but before
… …
242</dt> 416</dt>
243<dd> 417<dd>
244Called whenever the user tries to extend the selection (e.g. with a double 418Called whenever the user tries to extend the selection (e.g. with a double
245click) and is either supposed to return false (normal operation), or 419click) and is either supposed to return false (normal operation), or
246should extend the selection itelf and return true to suppress the built-in 420should extend the selection itelf and return true to suppress the built-in
247processing. 421processing. This can happen multiple times, as long as the callback
422returns true, it will be called on every further click by the user and is
423supposed to enlarge the selection more and more, if possible.
248</dd> 424</dd>
249<dd> 425<dd>
250<p>See the <em>selection</em> example extension.</p> 426<p>See the <em>selection</em> example extension.</p>
251</dd> 427</dd>
252<p></p> 428<p></p>
… …
267</dd> 443</dd>
268<dd> 444<dd>
269<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 445<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
270$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 446$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
271number of lines that will be in the scrollback buffer.</p> 447number of lines that will be in the scrollback buffer.</p>
272</dd>
273<p></p>
274<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br />
275</dt>
276<dd>
277Called whenever the <code>program(s)</code> running in the urxvt window send output.
278</dd> 448</dd>
279<p></p> 449<p></p>
280<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> 450<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
281</dt> 451</dt>
282<dd> 452<dd>
… …
301and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 471and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
302might be very slow, however, as your hook is called for <strong>all</strong> text being 472might be very slow, however, as your hook is called for <strong>all</strong> text being
303output. 473output.
304</dd> 474</dd>
305<p></p> 475<p></p>
476<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
477</dt>
478<dd>
479Called whenever some data is written to the tty/pty and can be used to
480suppress or filter tty input.
481</dd>
482<p></p>
306<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> 483<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
307</dt> 484</dt>
308<dd> 485<dd>
309Called whenever a line was updated or changed. Can be used to filter 486Called whenever a line was updated or changed. Can be used to filter
310screen output (e.g. underline urls or other useless stuff). Only lines 487screen output (e.g. underline urls or other useless stuff). Only lines
… …
342Called whenever the user presses a key combination that has a 519Called whenever the user presses a key combination that has a
343<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 520<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
344resource in the <code>rxvt(1)</code> manpage). 521resource in the <code>rxvt(1)</code> manpage).
345</dd> 522</dd>
346<p></p> 523<p></p>
524<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
525</dt>
526<dd>
527Called on every X event received on the vt window (and possibly other
528windows). Should only be used as a last resort. Most event structure
529members are not passed.
530</dd>
531<p></p>
347<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 532<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
348</dt> 533</dt>
349<dd> 534<dd>
350Called whenever the window gets the keyboard focus, before rxvt-unicode 535Called whenever the window gets the keyboard focus, before rxvt-unicode
351does focus in processing. 536does focus in processing.
… …
356<dd> 541<dd>
357Called wheneever the window loses keyboard focus, before rxvt-unicode does 542Called wheneever the window loses keyboard focus, before rxvt-unicode does
358focus out processing. 543focus out processing.
359</dd> 544</dd>
360<p></p> 545<p></p>
361<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> 546<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
362</dt> 547</dt>
363<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> 548<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
364</dt> 549</dt>
365<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 550<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
366</dt> 551</dt>
367<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> 552<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
368</dt> 553</dt>
… …
391<p></p></dl> 576<p></p></dl>
392<p> 577<p>
393</p> 578</p>
394<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 579<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
395<dl> 580<dl>
581<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br />
582</dt>
583<dd>
584The rxvt-unicode library directory, where, among other things, the perl
585modules and scripts are stored.
586</dd>
587<p></p>
588<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
589</dt>
590<dd>
591The resource class and name rxvt-unicode uses to look up X resources.
592</dd>
593<p></p>
594<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
595</dt>
596<dd>
597The basename of the installed binaries, usually <code>urxvt</code>.
598</dd>
599<p></p>
396<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> 600<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
397</dt> 601</dt>
398<dd> 602<dd>
399The current terminal. This variable stores the current <code>urxvt::term</code> 603The current terminal. This variable stores the current <code>urxvt::term</code>
400object, whenever a callback/hook is executing. 604object, whenever a callback/hook is executing.
… …
402<p></p></dl> 606<p></p></dl>
403<p> 607<p>
404</p> 608</p>
405<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 609<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
406<dl> 610<dl>
407<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
408</dt>
409<dd>
410Creates a new terminal, very similar as if you had started it with
411<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
412if the new instance couldn't be created. Returns <code>undef</code> if the new
413instance didn't initialise perl, and the terminal object otherwise. The
414<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
415</dd>
416<p></p>
417<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 611<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
418</dt> 612</dt>
419<dd> 613<dd>
420Fatally aborts execution with the given error message. Avoid at all 614Fatally aborts execution with the given error message. Avoid at all
421costs! The only time this is acceptable is when the terminal process 615costs! The only time this is acceptable is when the terminal process
… …
431</dd> 625</dd>
432<dd> 626<dd>
433<p>Using this function has the advantage that its output ends up in the 627<p>Using this function has the advantage that its output ends up in the
434correct place, e.g. on stderr of the connecting urxvtc client.</p> 628correct place, e.g. on stderr of the connecting urxvtc client.</p>
435</dd> 629</dd>
630<dd>
631<p>Messages have a size limit of 1023 bytes currently.</p>
632</dd>
436<p></p> 633<p></p>
437<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 634<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
438</dt> 635</dt>
439<dd> 636<dd>
440Returns the ``current time'' (as per the event loop). 637Returns the ``current time'' (as per the event loop).
… …
443<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 640<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
444</dt> 641</dt>
445<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 642<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
446Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 643Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
447Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 644Button4Mask, Button5Mask, AnyModifier</a></strong><br />
645</dt>
646<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
647ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
648PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
649Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
650KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
651ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
652FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
653</dt>
654<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
655EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
656GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
657UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
658ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
659CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
660SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
448</dt> 661</dt>
449<dd> 662<dd>
450Various constants for use in X calls and event processing. 663Various constants for use in X calls and event processing.
451</dd> 664</dd>
452<p></p></dl> 665<p></p></dl>
… …
487</dt> 700</dt>
488<dd> 701<dd>
489Return the foreground/background colour index, respectively. 702Return the foreground/background colour index, respectively.
490</dd> 703</dd>
491<p></p> 704<p></p>
492<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> 705<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
493</dt> 706</dt>
494<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> 707<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
495</dt> 708</dt>
496<dd> 709<dd>
497Replace the foreground/background colour in the rendition mask with the 710Replace the foreground/background colour in the rendition mask with the
498specified one. 711specified one.
499</dd> 712</dd>
500<p></p> 713<p></p>
501<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> 714<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
502</dt> 715</dt>
503<dd> 716<dd>
504Return the ``custom'' value: Every rendition has 5 bits for use by 717Return the ``custom'' value: Every rendition has 5 bits for use by
505extensions. They can be set and changed as you like and are initially 718extensions. They can be set and changed as you like and are initially
506zero. 719zero.
507</dd> 720</dd>
508<p></p> 721<p></p>
509<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> 722<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
510</dt> 723</dt>
511<dd> 724<dd>
512Change the custom value. 725Change the custom value.
513</dd> 726</dd>
514<p></p></dl> 727<p></p></dl>
515<p> 728<p>
516</p> 729</p>
517<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 730<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
518<p>The sole purpose of this class is to deliver an interface to the 731<p>The sole purpose of this class is to deliver an interface to the
519<code>AnyEvent</code> module - any module using it will work inside urxvt without 732<code>AnyEvent</code> module - any module using it will work inside urxvt without
520further work. The only exception is that you cannot wait on condition 733further programming. The only exception is that you cannot wait on
521variables, but non-blocking condvar use is ok. What this means is that you 734condition variables, but non-blocking condvar use is ok. What this means
522cannot use blocking APIs, but the non-blocking variant should work.</p> 735is that you cannot use blocking APIs, but the non-blocking variant should
736work.</p>
523<p> 737<p>
524</p> 738</p>
525<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 739<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
526<dl> 740<dl>
741<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
742</dt>
743<dd>
744Creates a new terminal, very similar as if you had started it with system
745<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
746hash which defines the environment of the new terminal.
747</dd>
748<dd>
749<p>Croaks (and probably outputs an error message) if the new instance
750couldn't be created. Returns <code>undef</code> if the new instance didn't
751initialise perl, and the terminal object otherwise. The <code>init</code> and
752<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
753</dd>
754<p></p>
527<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 755<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
528</dt> 756</dt>
529<dd> 757<dd>
530Destroy the terminal object (close the window, free resources etc.). 758Destroy the terminal object (close the window, free resources
759etc.). Please note that rxvt will not exit as long as any event
760watchers (timers, io watchers) are still active.
531</dd> 761</dd>
532<p></p> 762<p></p>
533<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 763<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
534</dt> 764</dt>
535<dd> 765<dd>
… …
591 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 821 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
592 shade term_name title transparent transparent_all tripleclickwords 822 shade term_name title transparent transparent_all tripleclickwords
593 utmpInhibit visualBell</pre> 823 utmpInhibit visualBell</pre>
594</dd> 824</dd>
595<p></p> 825<p></p>
826<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
827</dt>
828<dd>
829Returns the X-Resource for the given pattern, excluding the program or
830class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
831same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
832resource with that pattern exists.
833</dd>
834<dd>
835<p>This method should only be called during the <code>on_start</code> hook, as there is
836only one resource database per display, and later invocations might return
837the wrong resources.</p>
838</dd>
839<p></p>
840<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
841</dt>
842<dd>
843Adds a keymap translation exactly as specified via a resource. See the
844<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
845</dd>
846<p></p>
596<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 847<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
597</dt> 848</dt>
598<dd> 849<dd>
599Return and optionally change the current rendition. Text that is output by 850Return and optionally change the current rendition. Text that is output by
600the terminal application will use this style. 851the terminal application will use this style.
… …
616<dd> 867<dd>
617Return the current values of the selection mark, begin or end positions, 868Return the current values of the selection mark, begin or end positions,
618and optionally set them to new values. 869and optionally set them to new values.
619</dd> 870</dd>
620<p></p> 871<p></p>
872<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
873</dt>
874<dd>
875Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
876<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
877rectangular selection will be made. This is the prefered function to make
878a selection.
879</dd>
880<p></p>
621<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 881<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
622</dt> 882</dt>
623<dd> 883<dd>
624Try to request the primary selection from the server (for example, as set 884Try to request the primary selection text from the server (for example, as
625by the next method). 885set by the next method). No visual feedback will be given. This function
886is mostly useful from within <code>on_sel_grab</code> hooks.
626</dd> 887</dd>
627<p></p> 888<p></p>
628<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 889<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
629</dt> 890</dt>
630<dd> 891<dd>
631Return the current selection text and optionally replace it by <code>$newtext</code>. 892Return the current selection text and optionally replace it by <code>$newtext</code>.
632</dd> 893</dd>
894<p></p>
895<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
896</dt>
633<dd> 897<dd>
634<p>#=item $term-&gt;overlay ($x, $y, $text)
635#
636#Create a simple multi-line overlay box. See the next method for details. 898Create a simple multi-line overlay box. See the next method for details.
637#
638#=cut
639#
640#sub urxvt::term::scr_overlay {
641# my ($self, $x, $y, $text) = @_;
642#
643# my @lines = split /\n/, $text;
644#
645# my $w = 0;
646# for (map $self-&gt;strwidth ($_), @lines) {
647# $w = $_ if $w &lt; $_;
648# }
649#
650# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
651# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
652#}</p>
653</dd> 899</dd>
654<p></p> 900<p></p>
655<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 901<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
656</dt> 902</dt>
657<dd> 903<dd>
… …
718<p></p> 964<p></p>
719<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br /> 965<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
720</dt> 966</dt>
721<dd> 967<dd>
722Convert the given locale-encoded octets into a perl string. 968Convert the given locale-encoded octets into a perl string.
969</dd>
970<p></p>
971<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 />
972</dt>
973<dd>
974XORs the rendition values in the given span with the provided value
975(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
976refresh hooks to provide effects similar to the selection.
977</dd>
978<p></p>
979<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 />
980</dt>
981<dd>
982Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
983whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
984to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
985it instead. Both styles <em>MUST NOT</em> contain font styles.
986</dd>
987<p></p>
988<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
989</dt>
990<dd>
991Ring the bell!
723</dd> 992</dd>
724<p></p> 993<p></p>
725<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br /> 994<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
726</dt> 995</dt>
727<dd> 996<dd>
… …
750Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1019Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
751pass characters instead of octets, you should convert your strings first 1020pass characters instead of octets, you should convert your strings first
752to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1021to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
753</dd> 1022</dd>
754<p></p> 1023<p></p>
1024<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1025</dt>
1026<dd>
1027Replaces the event mask of the pty watcher by the given event mask. Can
1028be used to suppress input and output handling to the pty/tty. See the
1029description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1030the previous value.
1031</dd>
1032<p></p>
755<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1033<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
756</dt> 1034</dt>
757<dd> 1035<dd>
758Return the window id of the toplevel window. 1036Return the window id of the toplevel window.
759</dd> 1037</dd>
… …
762</dt> 1040</dt>
763<dd> 1041<dd>
764Return the window id of the terminal window. 1042Return the window id of the terminal window.
765</dd> 1043</dd>
766<p></p> 1044<p></p>
1045<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1046</dt>
1047<dd>
1048Adds the specified events to the vt event mask. Useful e.g. when you want
1049to receive pointer events all the times:
1050</dd>
1051<dd>
1052<pre>
1053 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1054</dd>
1055<p></p>
767<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1056<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
768</dt> 1057</dt>
769<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1058<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
770</dt> 1059</dt>
771<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1060<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
784</dt> 1073</dt>
785<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1074<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
786</dt> 1075</dt>
787<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1076<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
788</dt> 1077</dt>
789<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1078<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
790</dt> 1079</dt>
791<dd> 1080<dd>
792Return various integers describing terminal characteristics. 1081Return various integers describing terminal characteristics.
1082</dd>
1083<p></p>
1084<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1085</dt>
1086<dd>
1087Return the DISPLAY used by rxvt-unicode.
1088</dd>
1089<p></p>
1090<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1091</dt>
1092<dd>
1093Returns the LC_CTYPE category string used by this rxvt-unicode.
1094</dd>
1095<p></p>
1096<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1097</dt>
1098<dd>
1099Returns a copy of the environment in effect for the terminal as a hashref
1100similar to <code>\%ENV</code>.
793</dd> 1101</dd>
794<p></p> 1102<p></p>
795<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1103<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
796</dt> 1104</dt>
797<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1105<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
804</dd> 1112</dd>
805<p></p> 1113<p></p>
806<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1114<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
807</dt> 1115</dt>
808<dd> 1116<dd>
809Returns the negative row number of the topmost line. Minimum value is 1117Returns the row number of the topmost displayed line. Maximum value is
810<code>0</code>, which displays the normal terminal contents. Larger values scroll 1118<code>0</code>, which displays the normal terminal contents. Lower values scroll
811this many lines into the scrollback buffer. 1119this many lines into the scrollback buffer.
812</dd> 1120</dd>
813<p></p> 1121<p></p>
814<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1122<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
815</dt> 1123</dt>
… …
826</dt> 1134</dt>
827<dd> 1135<dd>
828Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1136Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
829is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1137is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
830terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1138terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
831line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1139line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
832is requested. 1140is requested.
833</dd> 1141</dd>
834<dd> 1142<dd>
835<p>If <code>$new_text</code> is specified, it will replace characters in the current 1143<p>If <code>$new_text</code> is specified, it will replace characters in the current
836line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1144line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
… …
848<p>You have to obey this encoding when changing text. The advantage is 1156<p>You have to obey this encoding when changing text. The advantage is
849that <code>substr</code> and similar functions work on screen cells and not on 1157that <code>substr</code> and similar functions work on screen cells and not on
850characters.</p> 1158characters.</p>
851</dd> 1159</dd>
852<dd> 1160<dd>
853<p>The methods <code>$term-&gt;special_encode</code> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a> 1161<p>The methods <a href="#item_special_encode"><code>$term-&gt;special_encode</code></a> and <a href="#item_special_decode"><code>$term-&gt;special_decode</code></a>
854can be used to convert normal strings into this encoding and vice versa.</p> 1162can be used to convert normal strings into this encoding and vice versa.</p>
855</dd> 1163</dd>
856<p></p> 1164<p></p>
857<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> 1165<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
858</dt> 1166</dt>
… …
921<p></p> 1229<p></p>
922<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1230<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
923</dt> 1231</dt>
924<dd> 1232<dd>
925Returns the character offset of the given row|col pair within the logical 1233Returns the character offset of the given row|col pair within the logical
926line. 1234line. Works for rows outside the line, too, and returns corresponding
1235offsets outside the string.
927</dd> 1236</dd>
928<p></p> 1237<p></p>
929<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1238<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
930</dt> 1239</dt>
931<dd> 1240<dd>
932Translates a string offset into terminal coordinates again. 1241Translates a string offset into terminal coordinates again.
933</dd> 1242</dd>
934<p></p></dl> 1243<p></p></dl>
935<dt><strong>($row, $col) = $line-&gt;coord_of ($offset) 1244<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
936=item $text = $term-&gt;special_encode $string</strong><br />
937</dt> 1245</dt>
938<dd> 1246<dd>
939Converts a perl string into the special encoding used by rxvt-unicode, 1247Converts a perl string into the special encoding used by rxvt-unicode,
940where one character corresponds to one screen cell. See 1248where one character corresponds to one screen cell. See
941<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1249<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
… …
945</dt> 1253</dt>
946<dd> 1254<dd>
947Converts rxvt-unicodes text reprsentation into a perl string. See 1255Converts rxvt-unicodes text reprsentation into a perl string. See
948<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1256<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
949</dd> 1257</dd>
1258<p></p>
1259<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
1260</dt>
1261<dd>
1262Registers a synchronous button grab. See the XGrabButton manpage.
1263</dd>
1264<p></p>
1265<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1266</dt>
1267<dd>
1268Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1269synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1270</dd>
1271<p></p>
1272<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1273</dt>
1274<dd>
1275Calls XAllowEvents with AsyncBoth for the most recent grab.
1276</dd>
1277<p></p>
1278<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1279</dt>
1280<dd>
1281Calls XAllowEvents with SyncBoth for the most recent grab.
1282</dd>
1283<p></p>
1284<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1285</dt>
1286<dd>
1287Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1288recent grab.
1289</dd>
1290<p></p>
1291<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1292</dt>
1293<dd>
1294Calls XUngrab for the most recent grab. Is called automatically on
1295evaluation errors, as it is better to lose the grab in the error case as
1296the session.
1297</dd>
950<p></p></dl> 1298<p></p></dl>
951<p> 1299<p>
952</p> 1300</p>
953<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1301<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1302<dl>
1303<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1304</dt>
1305<dd>
1306Adds a non-clickable title to the popup.
1307</dd>
1308<p></p>
1309<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1310</dt>
1311<dd>
1312Creates a separator, optionally using the character given as <code>$sepchr</code>.
1313</dd>
1314<p></p>
1315<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1316</dt>
1317<dd>
1318Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1319selected.
1320</dd>
1321<p></p>
1322<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br />
1323</dt>
1324<dd>
1325Adds a toggle/checkbox item to the popup. Teh callback gets called
1326whenever it gets toggled, with a boolean indicating its value as its first
1327argument.
1328</dd>
1329<p></p>
1330<dt><strong>$popup-&gt;show</strong><br />
1331</dt>
1332<dd>
1333Displays the popup (which is initially hidden).
1334</dd>
1335<p></p></dl>
954<p> 1336<p>
955</p> 1337</p>
956<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1338<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
957<p>This class implements timer watchers/events. Time is represented as a 1339<p>This class implements timer watchers/events. Time is represented as a
958fractional number of seconds since the epoch. Example:</p> 1340fractional number of seconds since the epoch. Example:</p>
… …
1024<pre> 1406<pre>
1025 $term-&gt;{socket} = ... 1407 $term-&gt;{socket} = ...
1026 $term-&gt;{iow} = urxvt::iow 1408 $term-&gt;{iow} = urxvt::iow
1027 -&gt;new 1409 -&gt;new
1028 -&gt;fd (fileno $term-&gt;{socket}) 1410 -&gt;fd (fileno $term-&gt;{socket})
1029 -&gt;events (1) # wait for read data 1411 -&gt;events (urxvt::EVENT_READ)
1030 -&gt;start 1412 -&gt;start
1031 -&gt;cb (sub { 1413 -&gt;cb (sub {
1032 my ($iow, $revents) = @_; 1414 my ($iow, $revents) = @_;
1033 # $revents must be 1 here, no need to check 1415 # $revents must be 1 here, no need to check
1034 sysread $term-&gt;{socket}, my $buf, 8192 1416 sysread $term-&gt;{socket}, my $buf, 8192
… …
1055</dd> 1437</dd>
1056<p></p> 1438<p></p>
1057<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br /> 1439<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1058</dt> 1440</dt>
1059<dd> 1441<dd>
1060Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read 1442Set the event mask to watch. The only allowed values are
1061data, Bit #1 (value <code>2</code>) enables watching for write data. 1443<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1444together, or <code>urxvt::EVENT_NONE</code>.
1062</dd> 1445</dd>
1063<p></p> 1446<p></p>
1064<dt><strong>$iow = $iow-&gt;start</strong><br /> 1447<dt><strong>$iow = $iow-&gt;start</strong><br />
1065</dt> 1448</dt>
1066<dd> 1449<dd>
… …
1081</p> 1464</p>
1082<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1465<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
1083<p>This variable controls the verbosity level of the perl extension. Higher 1466<p>This variable controls the verbosity level of the perl extension. Higher
1084numbers indicate more verbose output.</p> 1467numbers indicate more verbose output.</p>
1085<dl> 1468<dl>
1086<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> 1469<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1087</dt> 1470</dt>
1088<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> 1471<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1089</dt> 1472</dt>
1090<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> 1473<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1474</dt>
1475<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1091</dt> 1476</dt>
1092</dl> 1477</dl>
1093<p> 1478<p>
1094</p> 1479</p>
1095<hr /> 1480<hr />

Diff Legend

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