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.42 by root, Mon Feb 6 06:14:55 2006 UTC vs.
Revision 1.52 by root, Sun Jun 24 22:12:18 2007 UTC

1<?xml version="1.0" encoding="UTF-8"?>
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml"> 3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
3<head> 4<head>
4<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> 5 <title>rxvtperl</title>
5<link rev="made" href="mailto:perl-binary@plan9.de" /> 6 <meta name="description" content="Pod documentation for rxvtperl" />
6</head> 7 <meta name="inputfile" content="&lt;standard input&gt;" />
7 8 <meta name="outputfile" content="&lt;standard output&gt;" />
8<body style="background-color: white"> 9 <meta name="created" content="Mon Jun 25 00:11:18 2007" />
9 10 <meta name="generator" content="Pod::Xhtml 1.57" />
10<p><a name="__index__"></a></p> 11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
12<body>
13<div class="pod">
11<!-- INDEX BEGIN --> 14<!-- INDEX START -->
15<h3 id="TOP">Index</h3>
12 16
13<ul>
14
15 <li><a href="#name">NAME</a></li> 17<ul><li><a href="#NAME">NAME</a></li>
16 <li><a href="#synopsis">SYNOPSIS</a></li> 18<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
17 <li><a href="#description">DESCRIPTION</a></li> 19<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
18 <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li> 20<li><a href="#PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</a></li>
19 <li><a href="#api_documentation">API DOCUMENTATION</a></li> 21<li><a href="#API_DOCUMENTATION">API DOCUMENTATION</a>
20 <ul>
21
22 <li><a href="#general_api_considerations">General API Considerations</a></li> 22<ul><li><a href="#General_API_Considerations">General API Considerations</a></li>
23 <li><a href="#extension_objects">Extension Objects</a></li> 23<li><a href="#Extension_Objects">Extension Objects</a></li>
24 <li><a href="#hooks">Hooks</a></li> 24<li><a href="#Hooks">Hooks</a></li>
25 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> 25<li><a href="#Variables_in_the_code_urxvt_code_Pac">Variables 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> 26<li><a href="#Functions_in_the_code_urxvt_code_Pac">Functions in the <code>urxvt</code> Package</a></li>
27 <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> 28<li><a href="#The_code_urxvt_anyevent_code_Class">The <code>urxvt::anyevent</code> Class</a></li>
29 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 29<li><a href="#The_code_urxvt_term_code_Class">The <code>urxvt::term</code> Class</a></li>
30 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> 30<li><a href="#The_code_urxvt_popup_code_Class">The <code>urxvt::popup</code> Class</a></li>
31 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 31<li><a href="#The_code_urxvt_timer_code_Class">The <code>urxvt::timer</code> Class</a></li>
32 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 32<li><a href="#The_code_urxvt_iow_code_Class">The <code>urxvt::iow</code> Class</a></li>
33 <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> 33<li><a href="#The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</a></li>
34 <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> 34<li><a href="#The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</a></li>
35 </ul>
36
37 <li><a href="#environment">ENVIRONMENT</a></li>
38 <ul>
39
40 <li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li>
41 </ul>
42
43 <li><a href="#author">AUTHOR</a></li>
44</ul> 35</ul>
36</li>
37<li><a href="#ENVIRONMENT">ENVIRONMENT</a>
38<ul><li><a href="#URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</a></li>
39</ul>
40</li>
41<li><a href="#AUTHOR">AUTHOR</a>
42</li>
43</ul><hr />
45<!-- INDEX END --> 44<!-- INDEX END -->
46 45
47<hr /> 46<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
48<p> 47<div id="NAME_CONTENT">
49</p>
50<hr />
51<h1><a name="name">NAME</a></h1>
52<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 48<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
53<p> 49
54</p> 50</div>
55<hr /> 51<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
56<h1><a name="synopsis">SYNOPSIS</a></h1> 52<div id="SYNOPSIS_CONTENT">
57<pre>
58 # create a file grab_test in $HOME:</pre> 53<pre> # create a file grab_test in $HOME:
59<pre> 54
60 sub on_sel_grab { 55 sub on_sel_grab {
61 warn &quot;you selected &quot;, $_[0]-&gt;selection; 56 warn &quot;you selected &quot;, $_[0]-&gt;selection;
62 () 57 ()
63 }</pre> 58 }
64<pre> 59
65 # start a rxvt using it:</pre> 60 # start a rxvt using it:
66<pre> 61
67 rxvt --perl-lib $HOME -pe grab_test</pre> 62 rxvt --perl-lib $HOME -pe grab_test
68<p> 63
69</p> 64</pre>
70<hr /> 65
71<h1><a name="description">DESCRIPTION</a></h1> 66</div>
67<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
68<div id="DESCRIPTION_CONTENT">
72<p>Everytime a terminal object gets created, extension scripts specified via 69<p>Every time a terminal object gets created, extension scripts specified via
73the <code>perl</code> resource are loaded and associated with it.</p> 70the <code>perl</code> resource are loaded and associated with it.</p>
74<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 71<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
75thus must be encoded as UTF-8.</p> 72thus must be encoded as UTF-8.</p>
76<p>Each script will only ever be loaded once, even in rxvtd, where 73<p>Each script will only ever be loaded once, even in rxvtd, where
77scripts will be shared (but not enabled) for all terminals.</p> 74scripts will be shared (but not enabled) for all terminals.</p>
78<p> 75<p>You can disable the embedded perl interpreter by setting both &quot;perl-ext&quot;
79</p> 76and &quot;perl-ext-common&quot; resources to the empty string.</p>
80<hr /> 77
81<h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> 78</div>
79<h1 id="PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
80<div id="PREPACKAGED_EXTENSIONS_CONTENT">
82<p>This section describes the extensions delivered with this release. You can 81<p>This section describes the extensions delivered with this release. You can
83find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 82find them in <cite>/opt/rxvt/lib/urxvt/perl/</cite>.</p>
84<p>You can activate them like this:</p> 83<p>You can activate them like this:</p>
84<pre> rxvt -pe &lt;extensionname&gt;
85
85<pre> 86</pre>
86 rxvt -pe &lt;extensionname&gt;</pre>
87<p>Or by adding them to the resource for extensions loaded by default:</p> 87<p>Or by adding them to the resource for extensions loaded by default:</p>
88<pre>
89 URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> 88<pre> URxvt.perl-ext-common: default,automove-background,selection-autotransform
89
90</pre>
90<dl> 91<dl>
91<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> 92 <dt>selection (enabled by default)</dt>
92</dt>
93<dd> 93 <dd>
94(More) intelligent selection. This extension tries to be more intelligent 94 <p>(More) intelligent selection. This extension tries to be more intelligent
95when the user extends selections (double-click and further clicks). Right 95when the user extends selections (double-click and further clicks). Right
96now, it tries to select words, urls and complete shell-quoted 96now, it tries to select words, urls and complete shell-quoted
97arguments, which is very convenient, too, if your <em>ls</em> supports 97arguments, which is very convenient, too, if your <cite>ls</cite> supports
98<code>--quoting-style=shell</code>. 98<code>--quoting-style=shell</code>.</p>
99</dd>
100<dd>
101<p>A double-click usually selects the word under the cursor, further clicks 99 <p>A double-click usually selects the word under the cursor, further clicks
102will enlarge the selection.</p> 100will enlarge the selection.</p>
103</dd>
104<dd>
105<p>The selection works by trying to match a number of regexes and displaying 101 <p>The selection works by trying to match a number of regexes and displaying
106them in increasing order of length. You can add your own regexes by 102them in increasing order of length. You can add your own regexes by
107specifying resources of the form:</p> 103specifying resources of the form:</p>
108</dd>
109<dd>
110<pre>
111 URxvt.selection.pattern-0: perl-regex 104<pre> URxvt.selection.pattern-0: perl-regex
112 URxvt.selection.pattern-1: perl-regex 105 URxvt.selection.pattern-1: perl-regex
113 ...</pre> 106 ...
114</dd> 107
115<dd> 108</pre>
116<p>The index number (0, 1...) must not have any holes, and each regex must 109 <p>The index number (0, 1...) must not have any holes, and each regex must
117contain at least one pair of capturing parentheses, which will be used for 110contain at least one pair of capturing parentheses, which will be used for
118the match. For example, the followign adds a regex that matches everything 111the match. For example, the following adds a regex that matches everything
119between two vertical bars:</p> 112between two vertical bars:</p>
120</dd> 113<pre> URxvt.selection.pattern-0: \\|([^|]+)\\|
121<dd> 114
122<pre> 115</pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd>
125<dd>
126<p>Another example: Programs I use often output ``absolute path: '' at the 116 <p>Another example: Programs I use often output &quot;absolute path: &quot; at the
127beginning of a line when they process multiple files. The following 117beginning of a line when they process multiple files. The following
128pattern matches the filename (note, there is a single space at the very 118pattern matches the filename (note, there is a single space at the very
129end):</p> 119end):</p>
130</dd> 120<pre> URxvt.selection.pattern-0: ^(/[^:]+):\
131<dd> 121
132<pre> 122</pre>
133 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
134</dd>
135<dd>
136<p>You can look at the source of the selection extension to see more 123 <p>You can look at the source of the selection extension to see more
137interesting uses, such as parsing a line from beginning to end.</p> 124interesting uses, such as parsing a line from beginning to end.</p>
138</dd>
139<dd>
140<p>This extension also offers following bindable keyboard commands:</p> 125 <p>This extension also offers following bindable keyboard commands:</p>
141</dd> 126 <p>
142<dl> 127 <dl>
143<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128 <dt>rot13</dt>
144</dt> 129 <dd>
145<dd>
146Rot-13 the selection when activated. Used via keyboard trigger: 130 <p>Rot-13 the selection when activated. Used via keyboard trigger:</p>
147</dd> 131<pre> URxvt.keysym.C-M-r: perl:selection:rot13
148<dd> 132
149<pre> 133</pre>
150 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 134 </dd>
135 </dl>
136 </p>
151</dd> 137 </dd>
152<p></p></dl> 138 <dt>option-popup (enabled by default)</dt>
153<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
154</dt>
155<dd> 139 <dd>
156Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 140 <p>Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
157runtime. 141runtime.</p>
158</dd>
159<dd>
160<p>Other extensions can extend this popup menu by pushing a code reference 142 <p>Other extensions can extend this popup menu by pushing a code reference
161onto <code>@{ $term-</code>{option_popup_hook} }&gt;, which gets called whenever the 143onto <code>@{ $term-</code>{option_popup_hook} }&gt;, which gets called whenever the
162popup is being displayed.</p> 144popup is being displayed.</p>
163</dd>
164<dd>
165<p>It's sole argument is the popup menu, which can be modified. It should 145 <p>It's sole argument is the popup menu, which can be modified. It should
166either return nothing or a string, the initial boolean value and a code 146either return nothing or a string, the initial boolean value and a code
167reference. The string will be used as button text and the code reference 147reference. The string will be used as button text and the code reference
168will be called when the toggle changes, with the new boolean value as 148will be called when the toggle changes, with the new boolean value as
169first argument.</p> 149first argument.</p>
170</dd>
171<dd>
172<p>The following will add an entry <code>myoption</code> that changes 150 <p>The following will add an entry <code>myoption</code> that changes
173<code>$self-</code>{myoption}&gt;:</p> 151<code>$self-</code>{myoption}&gt;:</p>
174</dd>
175<dd>
176<pre>
177 push @{ $self-&gt;{term}{option_popup_hook} }, sub { 152<pre> push @{ $self-&gt;{term}{option_popup_hook} }, sub {
178 (&quot;my option&quot; =&gt; $myoption, sub { $self-&gt;{myoption} = $_[0] }) 153 (&quot;my option&quot; =&gt; $myoption, sub { $self-&gt;{myoption} = $_[0] })
179 };</pre> 154 };
155
156</pre>
180</dd> 157 </dd>
181<p></p>
182<dt><strong>selection-popup (enabled by default)</strong><br /> 158 <dt>selection-popup (enabled by default)</dt>
183</dt>
184<dd> 159 <dd>
185Binds a popup menu to Ctrl-Button3 that lets you convert the selection 160 <p>Binds a popup menu to Ctrl-Button3 that lets you convert the selection
186text into various other formats/action (such as uri unescaping, perl 161text into various other formats/action (such as uri unescaping, perl
187evaluation, web-browser starting etc.), depending on content. 162evaluation, web-browser starting etc.), depending on content.</p>
188</dd>
189<dd>
190<p>Other extensions can extend this popup menu by pushing a code reference 163 <p>Other extensions can extend this popup menu by pushing a code reference
191onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the 164onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the
192popup is being displayed.</p> 165popup is being displayed.</p>
193</dd>
194<dd>
195<p>It's sole argument is the popup menu, which can be modified. The selection 166 <p>It's sole argument is the popup menu, which can be modified. The selection
196is in <code>$_</code>, which can be used to decide wether to add something or not. 167is in <code>$_</code>, which can be used to decide whether to add something or not.
197It should either return nothing or a string and a code reference. The 168It should either return nothing or a string and a code reference. The
198string will be used as button text and the code reference will be called 169string will be used as button text and the code reference will be called
199when the button gets activated and should transform <code>$_</code>.</p> 170when the button gets activated and should transform <code>$_</code>.</p>
200</dd>
201<dd>
202<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in 171 <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
203the selection to <code>b</code>s, but only if the selection currently contains any 172the selection to <code>b</code>s, but only if the selection currently contains any
204<code>a</code>s:</p> 173<code>a</code>s:</p>
205</dd>
206<dd>
207<pre>
208 push @{ $self-&gt;{term}{selection_popup_hook} }, sub { 174<pre> push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
209 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g } 175 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
210 : () 176 : ()
211 };</pre> 177 };
178
179</pre>
212</dd> 180 </dd>
213<p></p> 181 <dt>searchable-scrollback&lt;hotkey&gt; (enabled by default)</dt>
214<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
215</dt>
216<dd> 182 <dd>
217Adds regex search functionality to the scrollback buffer, triggered 183 <p>Adds regex search functionality to the scrollback buffer, triggered
218by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal 184by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
219input/output is suspended and a regex is displayed at the bottom of the 185input/output is suspended and a regex is displayed at the bottom of the
220screen. 186screen.</p>
221</dd>
222<dd>
223<p>Inputting characters appends them to the regex and continues incremental 187 <p>Inputting characters appends them to the regex and continues incremental
224search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> 188search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
225search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the 189search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
226bottom. <code>Escape</code> leaves search mode and returns to the point where search 190bottom. <code>Escape</code> leaves search mode and returns to the point where search
227was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 191was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
228additionally stores the first match in the current line into the primary 192additionally stores the first match in the current line into the primary
229selection.</p> 193selection.</p>
194 <p>The regex defaults to &quot;(?i)&quot;, resulting in a case-insensitive search. To
195get a case-sensitive search you can delete this prefix using <code>BackSpace</code>
196or simply use an uppercase character which removes the &quot;(?i)&quot; prefix.</p>
197 <p>See <cite>perlre</cite> for more info about perl regular expression syntax.</p>
230</dd> 198 </dd>
231<p></p> 199 <dt>readline (enabled by default)</dt>
232<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
233</dt>
234<dd> 200 <dd>
235A support package that tries to make editing with readline easier. At the 201 <p>A support package that tries to make editing with readline easier. At
236moment, it reacts to clicking with the left mouse button by trying to 202the moment, it reacts to clicking shift-left mouse button by trying to
237move the text cursor to this position. It does so by generating as many 203move the text cursor to this position. It does so by generating as many
238cursor-left or cursor-right keypresses as required (the this only works 204cursor-left or cursor-right keypresses as required (the this only works
239for programs that correctly support wide characters). 205for programs that correctly support wide characters).</p>
240</dd>
241<dd>
242<p>To avoid too many false positives, this is only done when:</p> 206 <p>To avoid too many false positives, this is only done when:</p>
243</dd> 207 <p>
244<dl> 208 <dl>
245<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br /> 209 <dt>- the tty is in ICANON state.</dt>
246</dt> 210 <dt>- the text cursor is visible.</dt>
247<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> 211 <dt>- the primary screen is currently being displayed.</dt>
248</dt> 212 <dt>- the mouse is on the same (multi-row-) line as the text cursor.</dt>
249<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
250</dt>
251<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
252</dt>
253</dl> 213 </dl>
214 </p>
254<p>The normal selection mechanism isn't disabled, so quick successive clicks 215 <p>The normal selection mechanism isn't disabled, so quick successive clicks
255might interfere with selection creation in harmless ways.</p> 216might interfere with selection creation in harmless ways.</p>
256<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 217 </dd>
257</dt> 218 <dt>selection-autotransform</dt>
258<dd> 219 <dd>
259This selection allows you to do automatic transforms on a selection 220 <p>This selection allows you to do automatic transforms on a selection
260whenever a selection is made. 221whenever a selection is made.</p>
261</dd>
262<dd>
263<p>It works by specifying perl snippets (most useful is a single <code>s///</code> 222 <p>It works by specifying perl snippets (most useful is a single <code>s///</code>
264operator) that modify <code>$_</code> as resources:</p> 223operator) that modify <code>$_</code> as resources:</p>
265</dd>
266<dd>
267<pre>
268 URxvt.selection-autotransform.0: transform 224<pre> URxvt.selection-autotransform.0: transform
269 URxvt.selection-autotransform.1: transform 225 URxvt.selection-autotransform.1: transform
270 ...</pre> 226 ...
271</dd> 227
272<dd> 228</pre>
273<p>For example, the following will transform selections of the form 229 <p>For example, the following will transform selections of the form
274<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename 230<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
275$word</code>:</p> 231$word</code>:</p>
276</dd>
277<dd>
278<pre>
279 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> 232<pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
280</dd> 233
281<dd> 234</pre>
282<p>And this example matches the same,but replaces it with vi-commands you can 235 <p>And this example matches the same,but replaces it with vi-commands you can
283paste directly into your (vi :) editor:</p> 236paste directly into your (vi :) editor:</p>
284</dd>
285<dd>
286<pre>
287 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> 237<pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
288</dd> 238
289<dd> 239</pre>
290<p>Of course, this can be modified to suit your needs and your editor :)</p> 240 <p>Of course, this can be modified to suit your needs and your editor :)</p>
291</dd>
292<dd>
293<p>To expand the example above to typical perl error messages (``XXX at 241 <p>To expand the example above to typical perl error messages (&quot;XXX at
294FILENAME line YYY.''), you need a slightly more elaborate solution:</p> 242FILENAME line YYY.&quot;), you need a slightly more elaborate solution:</p>
295</dd>
296<dd>
297<pre>
298 URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) 243<pre> URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
299 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> 244 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
300</dd> 245
301<dd> 246</pre>
302<p>The first line tells the selection code to treat the unchanging part of 247 <p>The first line tells the selection code to treat the unchanging part of
303every error message as a selection pattern, and the second line transforms 248every error message as a selection pattern, and the second line transforms
304the message into vi commands to load the file.</p> 249the message into vi commands to load the file.</p>
305</dd> 250 </dd>
306<p></p> 251 <dt>tabbed</dt>
307<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
308</dt>
309<dd> 252 <dd>
310This transforms the terminal into a tabbar with additional terminals, that 253 <p>This transforms the terminal into a tabbar with additional terminals, that
311is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line 254is, it implements what is commonly referred to as &quot;tabbed terminal&quot;. The topmost line
312displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one 255displays a &quot;[NEW]&quot; button, which, when clicked, will add a new tab, followed by one
313button per tab. 256button per tab.</p>
314</dd>
315<dd>
316<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and 257 <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
317<strong>Shift-Right</strong> will switch to the tab left or right of the current one, 258<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
318while <strong>Shift-Down</strong> creates a new tab.</p> 259while <strong>Shift-Down</strong> creates a new tab.</p>
319</dd>
320<dd>
321<p>The tabbar itself can be configured similarly to a normal terminal, but 260 <p>The tabbar itself can be configured similarly to a normal terminal, but
322with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the 261with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
323following four resources (shown with defaults):</p> 262following four resources (shown with defaults):</p>
324</dd>
325<dd>
326<pre>
327 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt; 263<pre> URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
328 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt; 264 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
329 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt; 265 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
330 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre> 266 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;
331</dd> 267
332<dd> 268</pre>
333<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid 269 <p>See <i>COLOR AND GRAPHICS</i> in the rxvt(1) manpage for valid
334indices.</p> 270indices.</p>
335</dd> 271 </dd>
336<p></p> 272 <dt>matcher</dt>
337<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
338</dt>
339<dd> 273 <dd>
340Uses per-line display filtering (<code>on_line_update</code>) to underline urls and 274 <p>Uses per-line display filtering (<code>on_line_update</code>) to underline text
341make them clickable. When middle-clicked, the program specified in the 275matching a certain pattern and make it clickable. When clicked with the
276mouse button specified in the <code>matcher.button</code> resource (default 2, or
277middle), the program specified in the <code>matcher.launcher</code> resource
342resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 278(default, the <code>urlLauncher</code> resource, <code>sensible-browser</code>) will be started
343the URL as first argument. 279with the matched text as first argument. The default configuration is
280suitable for matching URLs and launching a web browser, like the
281former &quot;mark-urls&quot; extension.</p>
282 <p>The default pattern to match URLs can be overridden with the
283<code>matcher.pattern.0</code> resource, and additional patterns can be specified
284with numbered patterns, in a manner similar to the &quot;selection&quot; extension.
285The launcher can also be overridden on a per-pattern basis.</p>
286 <p>It is possible to activate the most recently seen match from the keyboard.
287Simply bind a keysym to &quot;perl:matcher&quot; as seen in the example below.</p>
288 <p>Example configuration:</p>
289<pre> URxvt.perl-ext: default,matcher
290 URxvt.urlLauncher: sensible-browser
291 URxvt.keysym.C-Delete: perl:matcher
292 URxvt.matcher.button: 1
293 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&amp;@#-]*[\\w/-]
294 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
295 URxvt.matcher.launcher.2: gvim +$2 $1
296
297</pre>
344</dd> 298 </dd>
345<p></p> 299 <dt>xim-onthespot</dt>
346<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
347</dt>
348<dd> 300 <dd>
349This (experimental) perl extension implements OnTheSpot editing. It does 301 <p>This (experimental) perl extension implements OnTheSpot editing. It does
350not work perfectly, and some input methods don't seem to work well with 302not work perfectly, and some input methods don't seem to work well with
351OnTheSpot editing in general, but it seems to work at leats for SCIM and 303OnTheSpot editing in general, but it seems to work at leats for SCIM and
352kinput2. 304kinput2.</p>
353</dd>
354<dd>
355<p>You enable it by specifying this extension and a preedit style of 305 <p>You enable it by specifying this extension and a preedit style of
356<code>OnTheSpot</code>, i.e.:</p> 306<code>OnTheSpot</code>, i.e.:</p>
357</dd> 307<pre> rxvt -pt OnTheSpot -pe xim-onthespot
358<dd> 308
359<pre> 309</pre>
360 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
361</dd> 310 </dd>
362<p></p> 311 <dt>kuake&lt;hotkey&gt;</dt>
363<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
364</dt>
365<dd> 312 <dd>
366This is basically a one-line extension that dynamically changes the background pixmap offset 313 <p>A very primitive quake-console-like extension. It was inspired by a
367to the window position, in effect creating the same effect as pseudo transparency with 314description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the
368a custom pixmap. No scaling is supported in this mode. Exmaple: 315user presses a global accelerator key (by default <code>F10</code>), the terminal
316will show or hide itself. Another press of the accelerator key will hide
317or show it again.</p>
318 <p>Initially, the window will not be shown when using this extension.</p>
319 <p>This is useful if you need a single terminal thats not using any desktop
320space most of the time but is quickly available at the press of a key.</p>
321 <p>The accelerator key is grabbed regardless of any modifiers, so this
322extension will actually grab a physical key just for this function.</p>
323 <p>If you want a quake-like animation, tell your window manager to do so
324(fvwm can do it).</p>
369</dd> 325 </dd>
326 <dt>automove-background</dt>
370<dd> 327 <dd>
328 <p>This is basically a very small extension that dynamically changes the
329background pixmap offset to the window position, in effect creating the
330same effect as pseudo transparency with a custom pixmap. No scaling is
331supported in this mode. Example:</p>
332<pre> rxvt -pixmap background.xpm -pe automove-background
333
371<pre> 334</pre>
372 rxvt -pixmap background.xpm -pe automove-background</pre> 335 <p><a href="http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions">http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions</a>
336shows how this extension can be used to implement an automatically blurred
337transparent background.</p>
373</dd> 338 </dd>
374<p></p> 339 <dt>block-graphics-to-ascii</dt>
375<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
376</dt>
377<dd> 340 <dd>
378A not very useful example of filtering all text output to the terminal, 341 <p>A not very useful example of filtering all text output to the terminal
379by replacing all line-drawing characters (U+2500 .. U+259F) by a 342by replacing all line-drawing characters (U+2500 .. U+259F) by a
380similar-looking ascii character. 343similar-looking ascii character.</p>
381</dd> 344 </dd>
382<p></p> 345 <dt>digital-clock</dt>
383<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
384</dt>
385<dd> 346 <dd>
386Displays a digital clock using the built-in overlay. 347 <p>Displays a digital clock using the built-in overlay.</p>
387</dd> 348 </dd>
388<p></p> 349 <dt>remote-clipboard</dt>
389<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
390</dt>
391<dd> 350 <dd>
392Somewhat of a misnomer, this extension adds two menu entries to the 351 <p>Somewhat of a misnomer, this extension adds two menu entries to the
393selection popup that allows one ti run external commands to store the 352selection popup that allows one ti run external commands to store the
394selection somewhere and fetch it again. 353selection somewhere and fetch it again.</p>
395</dd>
396<dd>
397<p>We use it to implement a ``distributed selection mechanism'', which just 354 <p>We use it to implement a &quot;distributed selection mechanism&quot;, which just
398means that one command uploads the file to a remote server, and another 355means that one command uploads the file to a remote server, and another
399reads it.</p> 356reads it.</p>
400</dd>
401<dd>
402<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and 357 <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
403<code>URxvt.remote-selection.fetch</code> resources. The first should read the 358<code>URxvt.remote-selection.fetch</code> resources. The first should read the
404selection to store from STDIN (always in UTF-8), the second should provide 359selection to store from STDIN (always in UTF-8), the second should provide
405the selection data on STDOUT (also in UTF-8).</p> 360the selection data on STDOUT (also in UTF-8).</p>
406</dd>
407<dd>
408<p>The defaults (which are likely useless to you) use rsh and cat:</p> 361 <p>The defaults (which are likely useless to you) use rsh and cat:</p>
409</dd>
410<dd>
411<pre>
412 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection' 362<pre> URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
413 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> 363 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
364
365</pre>
414</dd> 366 </dd>
415<p></p> 367 <dt>selection-pastebin</dt>
416<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
417</dt>
418<dd> 368 <dd>
419This is a little rarely useful extension that Uploads the selection as 369 <p>This is a little rarely useful extension that Uploads the selection as
420textfile to a remote site (or does other things). (The implementation is 370textfile to a remote site (or does other things). (The implementation is
421not currently secure for use in a multiuser environment as it writes to 371not currently secure for use in a multiuser environment as it writes to
422<em>/tmp</em> directly.). 372<cite>/tmp</cite> directly.).</p>
423</dd>
424<dd>
425<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, 373 <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
426i.e.</p> 374i.e.</p>
427</dd>
428<dd>
429<pre>
430 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> 375<pre> URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
431</dd> 376
432<dd> 377</pre>
433<p>Pressing this combination runs a command with <code>%</code> replaced by the name of 378 <p>Pressing this combination runs a command with <code>%</code> replaced by the name of
434the textfile. This command can be set via a resource:</p> 379the textfile. This command can be set via a resource:</p>
435</dd>
436<dd>
437<pre>
438 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> 380<pre> URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
439</dd> 381
440<dd> 382</pre>
441<p>And the default is likely not useful to anybody but the few people around 383 <p>And the default is likely not useful to anybody but the few people around
442here :)</p> 384here :)</p>
443</dd>
444<dd>
445<p>The name of the textfile is the hex encoded md5 sum of the selection, so 385 <p>The name of the textfile is the hex encoded md5 sum of the selection, so
446the same content should lead to the same filename.</p> 386the same content should lead to the same filename.</p>
447</dd>
448<dd>
449<p>After a successful upload the selection will be replaced by the text given 387 <p>After a successful upload the selection will be replaced by the text given
450in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder 388in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
451for the filename):</p> 389for the filename):</p>
452</dd> 390<pre> URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
453<dd> 391
454<pre> 392</pre>
455 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> 393 <p><i>Note to xrdb users:</i> xrdb uses the C preprocessor, which might interpret
394the double <code>/</code> characters as comment start. Use <code>\057\057</code> instead,
395which works regardless of wether xrdb is used to parse the resource file
396or not.</p>
456</dd> 397 </dd>
457<p></p> 398 <dt>example-refresh-hooks</dt>
458<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
459</dt>
460<dd> 399 <dd>
461Displays a very simple digital clock in the upper right corner of the 400 <p>Displays a very simple digital clock in the upper right corner of the
462window. Illustrates overwriting the refresh callbacks to create your own 401window. Illustrates overwriting the refresh callbacks to create your own
463overlays or changes. 402overlays or changes.</p>
464</dd> 403 </dd>
465<p></p></dl> 404</dl>
466<p> 405
467</p> 406</div>
468<hr /> 407<h1 id="API_DOCUMENTATION">API DOCUMENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
469<h1><a name="api_documentation">API DOCUMENTATION</a></h1> 408<div id="API_DOCUMENTATION_CONTENT">
470<p> 409
471</p> 410</div>
472<h2><a name="general_api_considerations">General API Considerations</a></h2> 411<h2 id="General_API_Considerations">General API Considerations</h2>
412<div id="General_API_Considerations_CONTENT">
473<p>All objects (such as terminals, time watchers etc.) are typical 413<p>All objects (such as terminals, time watchers etc.) are typical
474reference-to-hash objects. The hash can be used to store anything you 414reference-to-hash objects. The hash can be used to store anything you
475like. All members starting with an underscore (such as <code>_ptr</code> or 415like. All members starting with an underscore (such as <code>_ptr</code> or
476<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or 416<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
477modified).</p> 417modified).</p>
… …
480the like inside the terminal object so they get destroyed as soon as the 420the like inside the terminal object so they get destroyed as soon as the
481terminal is destroyed.</p> 421terminal is destroyed.</p>
482<p>Argument names also often indicate the type of a parameter. Here are some 422<p>Argument names also often indicate the type of a parameter. Here are some
483hints on what they mean:</p> 423hints on what they mean:</p>
484<dl> 424<dl>
485<dt><strong><a name="item__24text">$text</a></strong><br /> 425 <dt>$text</dt>
486</dt>
487<dd> 426 <dd>
488Rxvt-unicodes special way of encoding text, where one ``unicode'' character 427 <p>Rxvt-unicodes special way of encoding text, where one &quot;unicode&quot; character
489always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. 428always represents one screen cell. See <cite>ROW_t</cite> for a discussion of this format.</p>
490</dd> 429 </dd>
491<p></p> 430 <dt>$string</dt>
492<dt><strong><a name="item__24string">$string</a></strong><br />
493</dt>
494<dd> 431 <dd>
495A perl text string, with an emphasis on <em>text</em>. It can store all unicode 432 <p>A perl text string, with an emphasis on <i>text</i>. It can store all unicode
496characters and is to be distinguished with text encoded in a specific 433characters and is to be distinguished with text encoded in a specific
497encoding (often locale-specific) and binary data. 434encoding (often locale-specific) and binary data.</p>
498</dd> 435 </dd>
499<p></p> 436 <dt>$octets</dt>
500<dt><strong><a name="item__24octets">$octets</a></strong><br />
501</dt>
502<dd> 437 <dd>
503Either binary data or - more common - a text string encoded in a 438 <p>Either binary data or - more common - a text string encoded in a
504locale-specific way. 439locale-specific way.</p>
505</dd> 440 </dd>
506<p></p></dl> 441</dl>
507<p> 442
508</p> 443</div>
509<h2><a name="extension_objects">Extension Objects</a></h2> 444<h2 id="Extension_Objects">Extension Objects</h2>
445<div id="Extension_Objects_CONTENT">
510<p>Very perl extension is a perl class. A separate perl object is created 446<p>Every perl extension is a perl class. A separate perl object is created
511for each terminal and each extension and passed as the first parameter to 447for each terminal, and each terminal has its own set of extenion objects,
512hooks. So extensions can use their <code>$self</code> object without having to think 448which are passed as the first parameter to hooks. So extensions can use
513about other extensions, with the exception of methods and members that 449their <code>$self</code> object without having to think about clashes with other
450extensions or other terminals, with the exception of methods and members
514begin with an underscore character <code>_</code>: these are reserved for internal 451that begin with an underscore character <code>_</code>: these are reserved for
515use.</p> 452internal use.</p>
516<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the 453<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
517<code>urxvt::term</code> class on this object.</p> 454<code>urxvt::term</code> class on this object.</p>
518<p>It has the following methods and data members:</p> 455<p>It has the following methods and data members:</p>
519<dl> 456<dl>
520<dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self-&gt;{term}</a></strong><br /> 457 <dt>$urxvt_term = $self-&gt;{term}</dt>
521</dt>
522<dd> 458 <dd>
523Returns the <code>urxvt::term</code> object associated with this instance of the 459 <p>Returns the <code>urxvt::term</code> object associated with this instance of the
524extension. This member <em>must not</em> be changed in any way. 460extension. This member <i>must not</i> be changed in any way.</p>
525</dd> 461 </dd>
526<p></p> 462 <dt>$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</dt>
527<dt><strong><a name="item_enable">$self-&gt;enable ($hook_name =&gt; $cb, [$hook_name =&gt; $cb..])</a></strong><br />
528</dt>
529<dd> 463 <dd>
530Dynamically enable the given hooks (named without the <code>on_</code> prefix) for 464 <p>Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
531this extension, replacing any previous hook. This is useful when you want 465this extension, replacing any previous hook. This is useful when you want
532to overwrite time-critical hooks only temporarily. 466to overwrite time-critical hooks only temporarily.</p>
533</dd> 467 </dd>
534<p></p> 468 <dt>$self-&gt;disable ($hook_name[, $hook_name..])</dt>
535<dt><strong><a name="item_disable">$self-&gt;disable ($hook_name[, $hook_name..])</a></strong><br />
536</dt>
537<dd> 469 <dd>
538Dynamically disable the given hooks. 470 <p>Dynamically disable the given hooks.</p>
539</dd> 471 </dd>
540<p></p></dl> 472</dl>
541<p> 473
542</p> 474</div>
543<h2><a name="hooks">Hooks</a></h2> 475<h2 id="Hooks">Hooks</h2>
476<div id="Hooks_CONTENT">
544<p>The following subroutines can be declared in extension files, and will be 477<p>The following subroutines can be declared in extension files, and will be
545called whenever the relevant event happens.</p> 478called whenever the relevant event happens.</p>
546<p>The first argument passed to them is an extension oject as described in 479<p>The first argument passed to them is an extension object as described in
547the in the <code>Extension Objects</code> section.</p> 480the in the <code>Extension Objects</code> section.</p>
548<p><strong>All</strong> of these hooks must return a boolean value. If any of the called 481<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
549hooks returns true, then the event counts as being <em>consumed</em>, and the 482hooks returns true, then the event counts as being <i>consumed</i>, and the
550relevant action might not be carried out by the C++ code.</p> 483relevant action might not be carried out by the C++ code.</p>
551<p><em>When in doubt, return a false value (preferably <code>()</code>). </em>&gt;</p> 484<p><i>When in doubt, return a false value (preferably <code>()</code>).</i></p>
552<dl> 485<dl>
553<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 486 <dt>on_init $term</dt>
554</dt>
555<dd> 487 <dd>
556Called after a new terminal object has been initialized, but before 488 <p>Called after a new terminal object has been initialized, but before
557windows are created or the command gets run. Most methods are unsafe to 489windows are created or the command gets run. Most methods are unsafe to
558call or deliver senseless data, as terminal size and other characteristics 490call or deliver senseless data, as terminal size and other characteristics
559have not yet been determined. You can safely query and change resources 491have not yet been determined. You can safely query and change resources
560and options, though. For many purposes the <code>on_start</code> hook is a better 492and options, though. For many purposes the <code>on_start</code> hook is a better
561place. 493place.</p>
562</dd> 494 </dd>
563<p></p> 495 <dt>on_start $term</dt>
564<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br />
565</dt>
566<dd> 496 <dd>
567Called at the very end of initialisation of a new terminal, just before 497 <p>Called at the very end of initialisation of a new terminal, just before
568trying to map (display) the toplevel and returning to the mainloop. 498trying to map (display) the toplevel and returning to the main loop.</p>
569</dd> 499 </dd>
570<p></p> 500 <dt>on_destroy $term</dt>
571<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
572</dt>
573<dd> 501 <dd>
574Called whenever something tries to destroy terminal, when the terminal is 502 <p>Called whenever something tries to destroy terminal, when the terminal is
575still fully functional (not for long, though). 503still fully functional (not for long, though).</p>
576</dd> 504 </dd>
577<p></p> 505 <dt>on_reset $term</dt>
578<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
579</dt>
580<dd> 506 <dd>
581Called after the screen is ``reset'' for any reason, such as resizing or 507 <p>Called after the screen is &quot;reset&quot; for any reason, such as resizing or
582control sequences. Here is where you can react on changes to size-related 508control sequences. Here is where you can react on changes to size-related
583variables. 509variables.</p>
584</dd> 510 </dd>
585<p></p> 511 <dt>on_child_start $term, $pid</dt>
586<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
587</dt>
588<dd> 512 <dd>
589Called just after the child process has been <code>fork</code>ed. 513 <p>Called just after the child process has been <code>fork</code>ed.</p>
590</dd> 514 </dd>
591<p></p> 515 <dt>on_child_exit $term, $status</dt>
592<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
593</dt>
594<dd> 516 <dd>
595Called just after the child process has exited. <code>$status</code> is the status 517 <p>Called just after the child process has exited. <code>$status</code> is the status
596from <code>waitpid</code>. 518from <code>waitpid</code>.</p>
597</dd> 519 </dd>
598<p></p> 520 <dt>on_sel_make $term, $eventtime</dt>
599<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
600</dt>
601<dd> 521 <dd>
602Called whenever a selection has been made by the user, but before the 522 <p>Called whenever a selection has been made by the user, but before the
603selection text is copied, so changes to the beginning, end or type of the 523selection text is copied, so changes to the beginning, end or type of the
604selection will be honored. 524selection will be honored.</p>
605</dd>
606<dd>
607<p>Returning a true value aborts selection making by urxvt, in which case you 525 <p>Returning a true value aborts selection making by urxvt, in which case you
608have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term-&gt;selection_grab</code></a>.</p> 526have to make a selection yourself by calling <code>$term-&gt;selection_grab</code>.</p>
609</dd> 527 </dd>
610<p></p> 528 <dt>on_sel_grab $term, $eventtime</dt>
611<dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br />
612</dt>
613<dd> 529 <dd>
614Called whenever a selection has been copied, but before the selection is 530 <p>Called whenever a selection has been copied, but before the selection is
615requested from the server. The selection text can be queried and changed 531requested from the server. The selection text can be queried and changed
616by calling <a href="#item_selection"><code>$term-&gt;selection</code></a>. 532by calling <code>$term-&gt;selection</code>.</p>
617</dd>
618<dd>
619<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 533 <p>Returning a true value aborts selection grabbing. It will still be highlighted.</p>
620</dd> 534 </dd>
621<p></p> 535 <dt>on_sel_extend $term</dt>
622<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
623</dt>
624<dd> 536 <dd>
625Called whenever the user tries to extend the selection (e.g. with a double 537 <p>Called whenever the user tries to extend the selection (e.g. with a double
626click) and is either supposed to return false (normal operation), or 538click) and is either supposed to return false (normal operation), or
627should extend the selection itelf and return true to suppress the built-in 539should extend the selection itself and return true to suppress the built-in
628processing. This can happen multiple times, as long as the callback 540processing. This can happen multiple times, as long as the callback
629returns true, it will be called on every further click by the user and is 541returns true, it will be called on every further click by the user and is
630supposed to enlarge the selection more and more, if possible. 542supposed to enlarge the selection more and more, if possible.</p>
631</dd>
632<dd>
633<p>See the <em>selection</em> example extension.</p> 543 <p>See the <cite>selection</cite> example extension.</p>
634</dd> 544 </dd>
635<p></p> 545 <dt>on_view_change $term, $offset</dt>
636<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
637</dt>
638<dd> 546 <dd>
639Called whenever the view offset changes, i..e the user or program 547 <p>Called whenever the view offset changes, i.e. the user or program
640scrolls. Offset <code>0</code> means display the normal terminal, positive values 548scrolls. Offset <code>0</code> means display the normal terminal, positive values
641show this many lines of scrollback. 549show this many lines of scrollback.</p>
642</dd> 550 </dd>
643<p></p> 551 <dt>on_scroll_back $term, $lines, $saved</dt>
644<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br />
645</dt>
646<dd> 552 <dd>
647Called whenever lines scroll out of the terminal area into the scrollback 553 <p>Called whenever lines scroll out of the terminal area into the scrollback
648buffer. <code>$lines</code> is the number of lines scrolled out and may be larger 554buffer. <code>$lines</code> is the number of lines scrolled out and may be larger
649than the scroll back buffer or the terminal. 555than the scroll back buffer or the terminal.</p>
650</dd>
651<dd>
652<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 556 <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
653$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 557$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
654number of lines that will be in the scrollback buffer.</p> 558number of lines that will be in the scrollback buffer.</p>
655</dd> 559 </dd>
656<p></p> 560 <dt>on_osc_seq $term, $op, $args</dt>
657<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
658</dt>
659<dd> 561 <dd>
562 <p>Called on every OSC sequence and can be used to suppress it or modify its
563behaviour. The default should be to return an empty list. A true value
564suppresses execution of the request completely. Make sure you don't get
565confused by recursive invocations when you output an osc sequence within
566this callback.</p>
567 <p><code>on_osc_seq_perl</code> should be used for new behaviour.</p>
568 </dd>
569 <dt>on_osc_seq_perl $term, $string</dt>
570 <dd>
660Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = 571 <p>Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
661operating system command) is processed. Cursor position and other state 572operating system command) is processed. Cursor position and other state
662information is up-to-date when this happens. For interoperability, the 573information is up-to-date when this happens. For interoperability, the
663string should start with the extension name and a colon, to distinguish 574string should start with the extension name and a colon, to distinguish
664it from commands for other extensions, and this might be enforced in the 575it from commands for other extensions, and this might be enforced in the
665future. 576future.</p>
666</dd>
667<dd>
668<p>Be careful not ever to trust (in a security sense) the data you receive, 577 <p>Be careful not ever to trust (in a security sense) the data you receive,
669as its source can not easily be controleld (e-mail content, messages from 578as its source can not easily be controlled (e-mail content, messages from
670other users on the same system etc.).</p> 579other users on the same system etc.).</p>
671</dd> 580 </dd>
672<p></p> 581 <dt>on_add_lines $term, $string</dt>
673<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
674</dt>
675<dd> 582 <dd>
676Called whenever text is about to be output, with the text as argument. You 583 <p>Called whenever text is about to be output, with the text as argument. You
677can filter/change and output the text yourself by returning a true value 584can filter/change and output the text yourself by returning a true value
678and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this 585and calling <code>$term-&gt;scr_add_lines</code> yourself. Please note that this
679might be very slow, however, as your hook is called for <strong>all</strong> text being 586might be very slow, however, as your hook is called for <strong>all</strong> text being
680output. 587output.</p>
681</dd> 588 </dd>
682<p></p> 589 <dt>on_tt_write $term, $octets</dt>
683<dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br />
684</dt>
685<dd> 590 <dd>
686Called whenever some data is written to the tty/pty and can be used to 591 <p>Called whenever some data is written to the tty/pty and can be used to
687suppress or filter tty input. 592suppress or filter tty input.</p>
688</dd> 593 </dd>
689<p></p> 594 <dt>on_line_update $term, $row</dt>
690<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
691</dt>
692<dd> 595 <dd>
693Called whenever a line was updated or changed. Can be used to filter 596 <p>Called whenever a line was updated or changed. Can be used to filter
694screen output (e.g. underline urls or other useless stuff). Only lines 597screen output (e.g. underline urls or other useless stuff). Only lines
695that are being shown will be filtered, and, due to performance reasons, 598that are being shown will be filtered, and, due to performance reasons,
696not always immediately. 599not always immediately.</p>
697</dd>
698<dd>
699<p>The row number is always the topmost row of the line if the line spans 600 <p>The row number is always the topmost row of the line if the line spans
700multiple rows.</p> 601multiple rows.</p>
701</dd>
702<dd>
703<p>Please note that, if you change the line, then the hook might get called 602 <p>Please note that, if you change the line, then the hook might get called
704later with the already-modified line (e.g. if unrelated parts change), so 603later with the already-modified line (e.g. if unrelated parts change), so
705you cannot just toggle rendition bits, but only set them.</p> 604you cannot just toggle rendition bits, but only set them.</p>
706</dd> 605 </dd>
707<p></p> 606 <dt>on_refresh_begin $term</dt>
708<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
709</dt>
710<dd> 607 <dd>
711Called just before the screen gets redrawn. Can be used for overlay 608 <p>Called just before the screen gets redrawn. Can be used for overlay
712or similar effects by modify terminal contents in refresh_begin, and 609or similar effects by modify terminal contents in refresh_begin, and
713restoring them in refresh_end. The built-in overlay and selection display 610restoring them in refresh_end. The built-in overlay and selection display
714code is run after this hook, and takes precedence. 611code is run after this hook, and takes precedence.</p>
715</dd> 612 </dd>
716<p></p> 613 <dt>on_refresh_end $term</dt>
717<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
718</dt>
719<dd> 614 <dd>
720Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 615 <p>Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.</p>
721</dd> 616 </dd>
722<p></p> 617 <dt>on_user_command $term, $string</dt>
723<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
724</dt>
725<dd> 618 <dd>
726Called whenever the a user-configured event is being activated (e.g. via 619 <p>Called whenever a user-configured event is being activated (e.g. via
727a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> 620a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
728resource in the <code>rxvt(1)</code> manpage). 621resource in the rxvt(1) manpage).</p>
729</dd>
730<dd>
731<p>The event is simply the action string. This interface is assumed to change 622 <p>The event is simply the action string. This interface is assumed to change
732slightly in the future.</p> 623slightly in the future.</p>
733</dd> 624 </dd>
734<p></p> 625 <dt>on_resize_all_windows $tern, $new_width, $new_height</dt>
735<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
736</dt>
737<dd> 626 <dd>
627 <p>Called just after the new window size has been calculated, but before
628windows are actually being resized or hints are being set. If this hook
629returns TRUE, setting of the window hints is being skipped.</p>
630 </dd>
631 <dt>on_x_event $term, $event</dt>
632 <dd>
738Called on every X event received on the vt window (and possibly other 633 <p>Called on every X event received on the vt window (and possibly other
739windows). Should only be used as a last resort. Most event structure 634windows). Should only be used as a last resort. Most event structure
740members are not passed. 635members are not passed.</p>
741</dd> 636 </dd>
742<p></p> 637 <dt>on_root_event $term, $event</dt>
743<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
744</dt>
745<dd> 638 <dd>
639 <p>Like <code>on_x_event</code>, but is called for events on the root window.</p>
640 </dd>
641 <dt>on_focus_in $term</dt>
642 <dd>
746Called whenever the window gets the keyboard focus, before rxvt-unicode 643 <p>Called whenever the window gets the keyboard focus, before rxvt-unicode
747does focus in processing. 644does focus in processing.</p>
748</dd> 645 </dd>
749<p></p> 646 <dt>on_focus_out $term</dt>
750<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
751</dt>
752<dd> 647 <dd>
753Called wheneever the window loses keyboard focus, before rxvt-unicode does 648 <p>Called whenever the window loses keyboard focus, before rxvt-unicode does
754focus out processing. 649focus out processing.</p>
755</dd> 650 </dd>
756<p></p> 651 <dt>on_configure_notify $term, $event</dt>
757<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> 652 <dt>on_property_notify $term, $event</dt>
758</dt> 653 <dt>on_key_press $term, $event, $keysym, $octets</dt>
759<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> 654 <dt>on_key_release $term, $event, $keysym</dt>
760</dt> 655 <dt>on_button_press $term, $event</dt>
761<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 656 <dt>on_button_release $term, $event</dt>
762</dt> 657 <dt>on_motion_notify $term, $event</dt>
763<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 658 <dt>on_map_notify $term, $event</dt>
764</dt> 659 <dt>on_unmap_notify $term, $event</dt>
765<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
766</dt>
767<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
768</dt>
769<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
770</dt>
771<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
772</dt>
773<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
774</dt>
775<dd> 660 <dd>
776Called whenever the corresponding X event is received for the terminal If 661 <p>Called whenever the corresponding X event is received for the terminal If
777the hook returns true, then the even will be ignored by rxvt-unicode. 662the hook returns true, then the even will be ignored by rxvt-unicode.</p>
778</dd>
779<dd>
780<p>The event is a hash with most values as named by Xlib (see the XEvent 663 <p>The event is a hash with most values as named by Xlib (see the XEvent
781manpage), with the additional members <code>row</code> and <code>col</code>, which are the 664manpage), with the additional members <code>row</code> and <code>col</code>, which are the
782(real, not screen-based) row and column under the mouse cursor.</p> 665(real, not screen-based) row and column under the mouse cursor.</p>
783</dd>
784<dd>
785<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 666 <p><code>on_key_press</code> additionally receives the string rxvt-unicode would
786output, if any, in locale-specific encoding.</p> 667output, if any, in locale-specific encoding.</p>
787</dd>
788<dd>
789<p>subwindow.</p> 668 <p>subwindow.</p>
790</dd> 669 </dd>
791<p></p> 670 <dt>on_client_message $term, $event</dt>
792<dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> 671 <dt>on_wm_protocols $term, $event</dt>
793</dt> 672 <dt>on_wm_delete_window $term, $event</dt>
794<dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br />
795</dt>
796<dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br />
797</dt>
798<dd> 673 <dd>
799Called when various types of ClientMessage events are received (all with 674 <p>Called when various types of ClientMessage events are received (all with
800format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 675format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p>
801</dd> 676 </dd>
802<p></p></dl> 677</dl>
803<p> 678
804</p> 679</div>
805<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> 680<h2 id="Variables_in_the_code_urxvt_code_Pac">Variables in the <code>urxvt</code> Package</h2>
681<div id="Variables_in_the_code_urxvt_code_Pac-2">
806<dl> 682<dl>
807<dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> 683 <dt>$urxvt::LIBDIR</dt>
808</dt>
809<dd> 684 <dd>
810The rxvt-unicode library directory, where, among other things, the perl 685 <p>The rxvt-unicode library directory, where, among other things, the perl
811modules and scripts are stored. 686modules and scripts are stored.</p>
812</dd> 687 </dd>
813<p></p> 688 <dt>$urxvt::RESCLASS, $urxvt::RESCLASS</dt>
814<dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br />
815</dt>
816<dd> 689 <dd>
817The resource class and name rxvt-unicode uses to look up X resources. 690 <p>The resource class and name rxvt-unicode uses to look up X resources.</p>
818</dd> 691 </dd>
819<p></p> 692 <dt>$urxvt::RXVTNAME</dt>
820<dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br />
821</dt>
822<dd> 693 <dd>
823The basename of the installed binaries, usually <code>urxvt</code>. 694 <p>The basename of the installed binaries, usually <code>urxvt</code>.</p>
824</dd> 695 </dd>
825<p></p> 696 <dt>$urxvt::TERM</dt>
826<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
827</dt>
828<dd> 697 <dd>
829The current terminal. This variable stores the current <code>urxvt::term</code> 698 <p>The current terminal. This variable stores the current <code>urxvt::term</code>
830object, whenever a callback/hook is executing. 699object, whenever a callback/hook is executing.</p>
831</dd> 700 </dd>
832<p></p> 701 <dt>@urxvt::TERM_INIT</dt>
833<dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br />
834</dt>
835<dd> 702 <dd>
836All coderefs in this array will be called as methods of the next newly 703 <p>All code references in this array will be called as methods of the next newly
837created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array 704created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
838gets cleared before the codereferences that were in it are being executed, 705gets cleared before the code references that were in it are being executed,
839so coderefs can push themselves onto it again if they so desire. 706so references can push themselves onto it again if they so desire.</p>
840</dd>
841<dd>
842<p>This complements to the perl-eval commandline option, but gets executed 707 <p>This complements to the perl-eval command line option, but gets executed
843first.</p> 708first.</p>
844</dd> 709 </dd>
845<p></p> 710 <dt>@urxvt::TERM_EXT</dt>
846<dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br />
847</dt>
848<dd> 711 <dd>
849Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which 712 <p>Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
850get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> 713get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
851but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. 714but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.</p>
852</dd> 715 </dd>
853<p></p></dl> 716</dl>
854<p> 717
855</p> 718</div>
856<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 719<h2 id="Functions_in_the_code_urxvt_code_Pac">Functions in the <code>urxvt</code> Package</h2>
720<div id="Functions_in_the_code_urxvt_code_Pac-2">
857<dl> 721<dl>
858<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 722 <dt>urxvt::fatal $errormessage</dt>
859</dt>
860<dd> 723 <dd>
861Fatally aborts execution with the given error message. Avoid at all 724 <p>Fatally aborts execution with the given error message. Avoid at all
862costs! The only time this is acceptable is when the terminal process 725costs! The only time this is acceptable is when the terminal process
863starts up. 726starts up.</p>
864</dd> 727 </dd>
865<p></p> 728 <dt>urxvt::warn $string</dt>
866<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br />
867</dt>
868<dd> 729 <dd>
869Calls <code>rxvt_warn</code> with the given string which should not include a 730 <p>Calls <code>rxvt_warn</code> with the given string which should not include a
870newline. The module also overwrites the <code>warn</code> builtin with a function 731newline. The module also overwrites the <code>warn</code> builtin with a function
871that calls this function. 732that calls this function.</p>
872</dd>
873<dd>
874<p>Using this function has the advantage that its output ends up in the 733 <p>Using this function has the advantage that its output ends up in the
875correct place, e.g. on stderr of the connecting urxvtc client.</p> 734correct place, e.g. on stderr of the connecting urxvtc client.</p>
876</dd>
877<dd>
878<p>Messages have a size limit of 1023 bytes currently.</p> 735 <p>Messages have a size limit of 1023 bytes currently.</p>
879</dd> 736 </dd>
880<p></p> 737 <dt>@terms = urxvt::termlist</dt>
881<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
882</dt>
883<dd> 738 <dd>
884Returns all urxvt::term objects that exist in this process, regardless of 739 <p>Returns all urxvt::term objects that exist in this process, regardless of
885wether they are started, being destroyed etc., so be careful. Only term 740whether they are started, being destroyed etc., so be careful. Only term
886objects that have perl extensions attached will be returned (because there 741objects that have perl extensions attached will be returned (because there
887is no urxvt::term objet associated with others). 742is no urxvt::term objet associated with others).</p>
888</dd> 743 </dd>
889<p></p> 744 <dt>$time = urxvt::NOW</dt>
890<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
891</dt>
892<dd> 745 <dd>
893Returns the ``current time'' (as per the event loop). 746 <p>Returns the &quot;current time&quot; (as per the event loop).</p>
894</dd> 747 </dd>
895<p></p> 748 <dt>urxvt::CurrentTime</dt>
896<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 749 <dt>urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
897</dt>
898<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
899Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 750Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
900Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 751Button4Mask, Button5Mask, AnyModifier</dt>
901</dt> 752 <dt>urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
902<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
903ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, 753ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
904PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, 754PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
905Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, 755Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
906KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, 756KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
907ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, 757ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
908FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> 758FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</dt>
909</dt> 759 <dt>urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
910<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
911EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, 760EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
912GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, 761GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
913UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, 762UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
914ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, 763ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
915CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 764CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
916SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> 765SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</dt>
917</dt>
918<dd> 766 <dd>
919Various constants for use in X calls and event processing. 767 <p>Various constants for use in X calls and event processing.</p>
920</dd> 768 </dd>
921<p></p></dl> 769</dl>
922<p> 770
923</p> 771</div>
924<h2><a name="rendition">RENDITION</a></h2> 772<h2 id="RENDITION">RENDITION</h2>
773<div id="RENDITION_CONTENT">
925<p>Rendition bitsets contain information about colour, font, font styles and 774<p>Rendition bitsets contain information about colour, font, font styles and
926similar information for each screen cell.</p> 775similar information for each screen cell.</p>
927<p>The following ``macros'' deal with changes in rendition sets. You should 776<p>The following &quot;macros&quot; deal with changes in rendition sets. You should
928never just create a bitset, you should always modify an existing one, 777never just create a bitset, you should always modify an existing one,
929as they contain important information required for correct operation of 778as they contain important information required for correct operation of
930rxvt-unicode.</p> 779rxvt-unicode.</p>
931<dl> 780<dl>
932<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> 781 <dt>$rend = urxvt::DEFAULT_RSTYLE</dt>
933</dt>
934<dd> 782 <dd>
935Returns the default rendition, as used when the terminal is starting up or 783 <p>Returns the default rendition, as used when the terminal is starting up or
936being reset. Useful as a base to start when creating renditions. 784being reset. Useful as a base to start when creating renditions.</p>
937</dd> 785 </dd>
938<p></p> 786 <dt>$rend = urxvt::OVERLAY_RSTYLE</dt>
939<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br />
940</dt>
941<dd> 787 <dd>
942Return the rendition mask used for overlays by default. 788 <p>Return the rendition mask used for overlays by default.</p>
943</dd> 789 </dd>
944<p></p> 790 <dt>$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</dt>
945<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br />
946</dt>
947<dd> 791 <dd>
948Return the bit that enabled bold, italic, blink, reverse-video and 792 <p>Return the bit that enabled bold, italic, blink, reverse-video and
949underline, respectively. To enable such a style, just logically OR it into 793underline, respectively. To enable such a style, just logically OR it into
950the bitset. 794the bitset.</p>
951</dd> 795 </dd>
952<p></p> 796 <dt>$foreground = urxvt::GET_BASEFG $rend</dt>
953<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> 797 <dt>$background = urxvt::GET_BASEBG $rend</dt>
954</dt>
955<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br />
956</dt>
957<dd> 798 <dd>
958Return the foreground/background colour index, respectively. 799 <p>Return the foreground/background colour index, respectively.</p>
959</dd> 800 </dd>
960<p></p> 801 <dt>$rend = urxvt::SET_FGCOLOR $rend, $new_colour</dt>
961<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> 802 <dt>$rend = urxvt::SET_BGCOLOR $rend, $new_colour</dt>
962</dt> 803 <dt>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</dt>
963<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
964</dt>
965<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br />
966</dt>
967<dd> 804 <dd>
968Replace the foreground/background colour in the rendition mask with the 805 <p>Replace the foreground/background colour in the rendition mask with the
969specified one. 806specified one.</p>
970</dd> 807 </dd>
971<p></p> 808 <dt>$value = urxvt::GET_CUSTOM $rend</dt>
972<dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br />
973</dt>
974<dd> 809 <dd>
975Return the ``custom'' value: Every rendition has 5 bits for use by 810 <p>Return the &quot;custom&quot; value: Every rendition has 5 bits for use by
976extensions. They can be set and changed as you like and are initially 811extensions. They can be set and changed as you like and are initially
977zero. 812zero.</p>
978</dd> 813 </dd>
979<p></p> 814 <dt>$rend = urxvt::SET_CUSTOM $rend, $new_value</dt>
980<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br />
981</dt>
982<dd> 815 <dd>
983Change the custom value. 816 <p>Change the custom value.</p>
984</dd> 817 </dd>
985<p></p></dl> 818</dl>
986<p> 819
987</p> 820</div>
988<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> 821<h2 id="The_code_urxvt_anyevent_code_Class">The <code>urxvt::anyevent</code> Class</h2>
822<div id="The_code_urxvt_anyevent_code_Class_C">
989<p>The sole purpose of this class is to deliver an interface to the 823<p>The sole purpose of this class is to deliver an interface to the
990<code>AnyEvent</code> module - any module using it will work inside urxvt without 824<code>AnyEvent</code> module - any module using it will work inside urxvt without
991further programming. The only exception is that you cannot wait on 825further programming. The only exception is that you cannot wait on
992condition variables, but non-blocking condvar use is ok. What this means 826condition variables, but non-blocking condvar use is ok. What this means
993is that you cannot use blocking APIs, but the non-blocking variant should 827is that you cannot use blocking APIs, but the non-blocking variant should
994work.</p> 828work.</p>
995<p> 829
996</p> 830</div>
997<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 831<h2 id="The_code_urxvt_term_code_Class">The <code>urxvt::term</code> Class</h2>
832<div id="The_code_urxvt_term_code_Class_CONTE">
998<dl> 833<dl>
999<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> 834 <dt>$term = new urxvt::term $envhashref, $rxvtname, [arg...]</dt>
1000</dt>
1001<dd> 835 <dd>
1002Creates a new terminal, very similar as if you had started it with system 836 <p>Creates a new terminal, very similar as if you had started it with system
1003<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like 837<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
1004hash which defines the environment of the new terminal. 838hash which defines the environment of the new terminal.</p>
1005</dd>
1006<dd>
1007<p>Croaks (and probably outputs an error message) if the new instance 839 <p>Croaks (and probably outputs an error message) if the new instance
1008couldn't be created. Returns <code>undef</code> if the new instance didn't 840couldn't be created. Returns <code>undef</code> if the new instance didn't
1009initialise perl, and the terminal object otherwise. The <code>init</code> and 841initialise perl, and the terminal object otherwise. The <code>init</code> and
1010<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to 842<code>start</code> hooks will be called before this call returns, and are free to
1011refer to global data (which is race free).</p> 843refer to global data (which is race free).</p>
1012</dd> 844 </dd>
1013<p></p> 845 <dt>$term-&gt;destroy</dt>
1014<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
1015</dt>
1016<dd> 846 <dd>
1017Destroy the terminal object (close the window, free resources 847 <p>Destroy the terminal object (close the window, free resources
1018etc.). Please note that rxvt will not exit as long as any event 848etc.). Please note that rxvt will not exit as long as any event
1019watchers (timers, io watchers) are still active. 849watchers (timers, io watchers) are still active.</p>
1020</dd> 850 </dd>
1021<p></p> 851 <dt>$term-&gt;exec_async ($cmd[, @args])</dt>
1022<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
1023</dt>
1024<dd> 852 <dd>
1025Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes 853 <p>Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
1026(``starts'') programs in the background. This function takes care of setting 854(&quot;starts&quot;) programs in the background. This function takes care of setting
1027the user environment before exec'ing the command (e.g. <code>PATH</code>) and should 855the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
1028be preferred over explicit calls to <code>exec</code> or <code>system</code>. 856be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p>
1029</dd>
1030<dd>
1031<p>Returns the pid of the subprocess or <code>undef</code> on error.</p> 857 <p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
1032</dd> 858 </dd>
1033<p></p> 859 <dt>$isset = $term-&gt;option ($optval[, $set])</dt>
1034<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
1035</dt>
1036<dd> 860 <dd>
1037Returns true if the option specified by <code>$optval</code> is enabled, and 861 <p>Returns true if the option specified by <code>$optval</code> is enabled, and
1038optionally change it. All option values are stored by name in the hash 862optionally change it. All option values are stored by name in the hash
1039<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. 863<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p>
1040</dd>
1041<dd>
1042<p>Here is a a likely non-exhaustive list of option names, please see the 864 <p>Here is a likely non-exhaustive list of option names, please see the
1043source file <em>/src/optinc.h</em> to see the actual list:</p> 865source file <cite>/src/optinc.h</cite> to see the actual list:</p>
1044</dd>
1045<dd>
1046<pre>
1047 borderLess console cursorBlink cursorUnderline hold iconic insecure 866<pre> borderLess console cursorBlink cursorUnderline hold iconic insecure
1048 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 867 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1049 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 868 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1050 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 869 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1051 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 870 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1052 transparent tripleclickwords utmpInhibit visualBell</pre> 871 transparent tripleclickwords utmpInhibit visualBell
872
873</pre>
1053</dd> 874 </dd>
1054<p></p> 875 <dt>$value = $term-&gt;resource ($name[, $newval])</dt>
1055<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
1056</dt>
1057<dd> 876 <dd>
1058Returns the current resource value associated with a given name and 877 <p>Returns the current resource value associated with a given name and
1059optionally sets a new value. Setting values is most useful in the <code>init</code> 878optionally sets a new value. Setting values is most useful in the <code>init</code>
1060hook. Unset resources are returned and accepted as <code>undef</code>. 879hook. Unset resources are returned and accepted as <code>undef</code>.</p>
1061</dd>
1062<dd>
1063<p>The new value must be properly encoded to a suitable character encoding 880 <p>The new value must be properly encoded to a suitable character encoding
1064before passing it to this method. Similarly, the returned value may need 881before passing it to this method. Similarly, the returned value may need
1065to be converted from the used encoding to text.</p> 882to be converted from the used encoding to text.</p>
1066</dd>
1067<dd>
1068<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified 883 <p>Resource names are as defined in <cite>src/rsinc.h</cite>. Colours can be specified
1069as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will 884as resource names of the form <code>color+&lt;index&gt;</code>, e.g. <code>color+5</code>. (will
1070likely change).</p> 885likely change).</p>
1071</dd>
1072<dd>
1073<p>Please note that resource strings will currently only be freed when the 886 <p>Please note that resource strings will currently only be freed when the
1074terminal is destroyed, so changing options frequently will eat memory.</p> 887terminal is destroyed, so changing options frequently will eat memory.</p>
1075</dd>
1076<dd>
1077<p>Here is a a likely non-exhaustive list of resource names, not all of which 888 <p>Here is a likely non-exhaustive list of resource names, not all of which
1078are supported in every build, please see the source file <em>/src/rsinc.h</em> 889are supported in every build, please see the source file <cite>/src/rsinc.h</cite>
1079to see the actual list:</p> 890to see the actual list:</p>
1080</dd>
1081<dd>
1082<pre>
1083 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 891<pre> answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1084 borderLess color cursorBlink cursorUnderline cutchars delete_key 892 borderLess color cursorBlink cursorUnderline cutchars delete_key
1085 display_name embed ext_bwidth fade font geometry hold iconName 893 display_name embed ext_bwidth fade font geometry hold iconName
1086 imFont imLocale inputMethod insecure int_bwidth intensityStyles 894 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1087 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 895 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1088 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 896 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
… …
1090 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 898 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1091 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 899 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1092 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 900 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1093 secondaryScreen secondaryScroll selectstyle shade term_name title 901 secondaryScreen secondaryScroll selectstyle shade term_name title
1094 transient_for transparent transparent_all tripleclickwords utmpInhibit 902 transient_for transparent transparent_all tripleclickwords utmpInhibit
1095 visualBell</pre> 903 visualBell
904
905</pre>
1096</dd> 906 </dd>
1097<p></p> 907 <dt>$value = $term-&gt;x_resource ($pattern)</dt>
1098<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
1099</dt>
1100<dd> 908 <dd>
1101Returns the X-Resource for the given pattern, excluding the program or 909 <p>Returns the X-Resource for the given pattern, excluding the program or
1102class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the 910class name, i.e. <code>$term-&gt;x_resource (&quot;boldFont&quot;)</code> should return the
1103same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no 911same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
1104resource with that pattern exists. 912resource with that pattern exists.</p>
1105</dd>
1106<dd>
1107<p>This method should only be called during the <code>on_start</code> hook, as there is 913 <p>This method should only be called during the <code>on_start</code> hook, as there is
1108only one resource database per display, and later invocations might return 914only one resource database per display, and later invocations might return
1109the wrong resources.</p> 915the wrong resources.</p>
1110</dd> 916 </dd>
1111<p></p> 917 <dt>$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</dt>
1112<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
1113</dt>
1114<dd> 918 <dd>
1115Adds a keymap translation exactly as specified via a resource. See the 919 <p>Adds a keymap translation exactly as specified via a resource. See the
1116<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 920<code>keysym</code> resource in the rxvt(1) manpage.</p>
1117</dd> 921 </dd>
1118<p></p> 922 <dt>$rend = $term-&gt;rstyle ([$new_rstyle])</dt>
1119<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
1120</dt>
1121<dd> 923 <dd>
1122Return and optionally change the current rendition. Text that is output by 924 <p>Return and optionally change the current rendition. Text that is output by
1123the terminal application will use this style. 925the terminal application will use this style.</p>
1124</dd> 926 </dd>
1125<p></p> 927 <dt>($row, $col) = $term-&gt;screen_cur ([$row, $col])</dt>
1126<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
1127</dt>
1128<dd> 928 <dd>
1129Return the current coordinates of the text cursor position and optionally 929 <p>Return the current coordinates of the text cursor position and optionally
1130set it (which is usually bad as applications don't expect that). 930set it (which is usually bad as applications don't expect that).</p>
1131</dd> 931 </dd>
1132<p></p> 932 <dt>($row, $col) = $term-&gt;selection_mark ([$row, $col])</dt>
1133<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 933 <dt>($row, $col) = $term-&gt;selection_beg ([$row, $col])</dt>
1134</dt> 934 <dt>($row, $col) = $term-&gt;selection_end ([$row, $col])</dt>
1135<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
1136</dt>
1137<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
1138</dt>
1139<dd> 935 <dd>
1140Return the current values of the selection mark, begin or end positions, 936 <p>Return the current values of the selection mark, begin or end positions,
1141and optionally set them to new values. 937and optionally set them to new values.</p>
1142</dd> 938 </dd>
1143<p></p> 939 <dt>$term-&gt;selection_make ($eventtime[, $rectangular])</dt>
1144<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
1145</dt>
1146<dd> 940 <dd>
1147Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and 941 <p>Tries to make a selection as set by <code>selection_beg</code> and
1148<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a 942<code>selection_end</code>. If <code>$rectangular</code> is true (default: false), a
1149rectangular selection will be made. This is the prefered function to make 943rectangular selection will be made. This is the prefered function to make
1150a selection. 944a selection.</p>
1151</dd> 945 </dd>
1152<p></p> 946 <dt>$success = $term-&gt;selection_grab ($eventtime)</dt>
1153<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
1154</dt>
1155<dd> 947 <dd>
1156Try to request the primary selection text from the server (for example, as 948 <p>Try to request the primary selection text from the server (for example, as
1157set by the next method). No visual feedback will be given. This function 949set by the next method). No visual feedback will be given. This function
1158is mostly useful from within <code>on_sel_grab</code> hooks. 950is mostly useful from within <code>on_sel_grab</code> hooks.</p>
1159</dd> 951 </dd>
1160<p></p>
1161<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 952 <dt>$oldtext = $term-&gt;selection ([$newtext])</dt>
1162</dt>
1163<dd> 953 <dd>
1164Return the current selection text and optionally replace it by <code>$newtext</code>. 954 <p>Return the current selection text and optionally replace it by <code>$newtext</code>.</p>
1165</dd> 955 </dd>
1166<p></p> 956 <dt>$term-&gt;overlay_simple ($x, $y, $text)</dt>
1167<dt><strong><a name="item_overlay_simple">$term-&gt;overlay_simple ($x, $y, $text)</a></strong><br />
1168</dt>
1169<dd> 957 <dd>
1170Create a simple multi-line overlay box. See the next method for details. 958 <p>Create a simple multi-line overlay box. See the next method for details.</p>
1171</dd> 959 </dd>
1172<p></p> 960 <dt>$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</dt>
1173<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
1174</dt>
1175<dd> 961 <dd>
1176Create a new (empty) overlay at the given position with the given 962 <p>Create a new (empty) overlay at the given position with the given
1177width/height. <code>$rstyle</code> defines the initial rendition style 963width/height. <code>$rstyle</code> defines the initial rendition style
1178(default: <code>OVERLAY_RSTYLE</code>). 964(default: <code>OVERLAY_RSTYLE</code>).</p>
1179</dd>
1180<dd>
1181<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put 965 <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
1182around the box.</p> 966around the box.</p>
1183</dd>
1184<dd>
1185<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the 967 <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
1186right/bottom side, respectively.</p> 968right/bottom side, respectively.</p>
1187</dd>
1188<dd>
1189<p>This method returns an urxvt::overlay object. The overlay will be visible 969 <p>This method returns an urxvt::overlay object. The overlay will be visible
1190as long as the perl object is referenced.</p> 970as long as the perl object is referenced.</p>
1191</dd>
1192<dd>
1193<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> 971 <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
1194</dd> 972 <p>
1195<dl> 973 <dl>
1196<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br /> 974 <dt>$overlay-&gt;set ($x, $y, $text, $rend)</dt>
1197</dt> 975 <dd>
1198<dd> 976 <p>Similar to <code>$term-&gt;ROW_t</code> and <code>$term-&gt;ROW_r</code> in that it puts
1199Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
1200text in rxvt-unicode's special encoding and an array of rendition values 977text in rxvt-unicode's special encoding and an array of rendition values
1201at a specific position inside the overlay. 978at a specific position inside the overlay.</p>
979 </dd>
980 <dt>$overlay-&gt;hide</dt>
981 <dd>
982 <p>If visible, hide the overlay, but do not destroy it.</p>
983 </dd>
984 <dt>$overlay-&gt;show</dt>
985 <dd>
986 <p>If hidden, display the overlay again.</p>
987 </dd>
988 </dl>
989 </p>
1202</dd> 990 </dd>
1203<p></p> 991 <dt>$popup = $term-&gt;popup ($event)</dt>
1204<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
1205</dt>
1206<dd> 992 <dd>
1207If visible, hide the overlay, but do not destroy it.
1208</dd>
1209<p></p>
1210<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
1211</dt>
1212<dd>
1213If hidden, display the overlay again.
1214</dd>
1215<p></p></dl>
1216<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
1217</dt>
1218<dd>
1219Creates a new <code>urxvt::popup</code> object that implements a popup menu. The 993 <p>Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
1220<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, 994<code>$event</code> <i>must</i> be the event causing the menu to pop up (a button event,
1221currently). 995currently).</p>
1222</dd> 996 </dd>
1223<p></p> 997 <dt>$cellwidth = $term-&gt;strwidth ($string)</dt>
1224<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
1225</dt>
1226<dd> 998 <dd>
1227Returns the number of screen-cells this string would need. Correctly 999 <p>Returns the number of screen-cells this string would need. Correctly
1228accounts for wide and combining characters. 1000accounts for wide and combining characters.</p>
1229</dd> 1001 </dd>
1230<p></p> 1002 <dt>$octets = $term-&gt;locale_encode ($string)</dt>
1231<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
1232</dt>
1233<dd> 1003 <dd>
1234Convert the given text string into the corresponding locale encoding. 1004 <p>Convert the given text string into the corresponding locale encoding.</p>
1235</dd> 1005 </dd>
1236<p></p> 1006 <dt>$string = $term-&gt;locale_decode ($octets)</dt>
1237<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
1238</dt>
1239<dd> 1007 <dd>
1240Convert the given locale-encoded octets into a perl string. 1008 <p>Convert the given locale-encoded octets into a perl string.</p>
1241</dd> 1009 </dd>
1242<p></p> 1010 <dt>$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</dt>
1243<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 />
1244</dt>
1245<dd> 1011 <dd>
1246XORs the rendition values in the given span with the provided value 1012 <p>XORs the rendition values in the given span with the provided value
1247(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in 1013(default: <code>RS_RVid</code>), which <i>MUST NOT</i> contain font styles. Useful in
1248refresh hooks to provide effects similar to the selection. 1014refresh hooks to provide effects similar to the selection.</p>
1249</dd> 1015 </dd>
1250<p></p>
1251<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 /> 1016 <dt>$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</dt>
1252</dt>
1253<dd> 1017 <dd>
1254Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 1018 <p>Similar to <code>scr_xor_span</code>, but xors a rectangle instead. Trailing
1255whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 1019whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
1256to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines 1020to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
1257it instead. Both styles <em>MUST NOT</em> contain font styles. 1021it instead. Both styles <i>MUST NOT</i> contain font styles.</p>
1258</dd> 1022 </dd>
1259<p></p> 1023 <dt>$term-&gt;scr_bell</dt>
1260<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
1261</dt>
1262<dd> 1024 <dd>
1263Ring the bell! 1025 <p>Ring the bell!</p>
1264</dd> 1026 </dd>
1265<p></p> 1027 <dt>$term-&gt;scr_add_lines ($string)</dt>
1266<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
1267</dt>
1268<dd> 1028 <dd>
1269Write the given text string to the screen, as if output by the application 1029 <p>Write the given text string to the screen, as if output by the application
1270running inside the terminal. It may not contain command sequences (escape 1030running inside the terminal. It may not contain command sequences (escape
1271codes), but is free to use line feeds, carriage returns and tabs. The 1031codes), but is free to use line feeds, carriage returns and tabs. The
1272string is a normal text string, not in locale-dependent encoding. 1032string is a normal text string, not in locale-dependent encoding.</p>
1273</dd>
1274<dd>
1275<p>Normally its not a good idea to use this function, as programs might be 1033 <p>Normally its not a good idea to use this function, as programs might be
1276confused by changes in cursor position or scrolling. Its useful inside a 1034confused by changes in cursor position or scrolling. Its useful inside a
1277<code>on_add_lines</code> hook, though.</p> 1035<code>on_add_lines</code> hook, though.</p>
1278</dd> 1036 </dd>
1279<p></p> 1037 <dt>$term-&gt;scr_change_screen ($screen)</dt>
1280<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1281</dt>
1282<dd> 1038 <dd>
1283Switch to given screen - 0 primary, 1 secondary. 1039 <p>Switch to given screen - 0 primary, 1 secondary.</p>
1284</dd> 1040 </dd>
1285<p></p> 1041 <dt>$term-&gt;cmd_parse ($octets)</dt>
1286<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1287</dt>
1288<dd> 1042 <dd>
1289Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1043 <p>Similar to <code>scr_add_lines</code>, but the argument must be in the
1290locale-specific encoding of the terminal and can contain command sequences 1044locale-specific encoding of the terminal and can contain command sequences
1291(escape codes) that will be interpreted. 1045(escape codes) that will be interpreted.</p>
1292</dd> 1046 </dd>
1293<p></p> 1047 <dt>$term-&gt;tt_write ($octets)</dt>
1294<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
1295</dt>
1296<dd> 1048 <dd>
1297Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 1049 <p>Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
1298pass characters instead of octets, you should convert your strings first 1050pass characters instead of octets, you should convert your strings first
1299to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 1051to the locale-specific encoding using <code>$term-&gt;locale_encode</code>.</p>
1300</dd> 1052 </dd>
1301<p></p> 1053 <dt>$old_events = $term-&gt;pty_ev_events ([$new_events])</dt>
1302<dt><strong><a name="item_pty_ev_events">$old_events = $term-&gt;pty_ev_events ([$new_events])</a></strong><br />
1303</dt>
1304<dd> 1054 <dd>
1305Replaces the event mask of the pty watcher by the given event mask. Can 1055 <p>Replaces the event mask of the pty watcher by the given event mask. Can
1306be used to suppress input and output handling to the pty/tty. See the 1056be used to suppress input and output handling to the pty/tty. See the
1307description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore 1057description of <code>urxvt::timer-&gt;events</code>. Make sure to always restore
1308the previous value. 1058the previous value.</p>
1309</dd> 1059 </dd>
1310<p></p> 1060 <dt>$fd = $term-&gt;pty_fd</dt>
1311<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1312</dt>
1313<dd> 1061 <dd>
1314Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty 1062 <p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1315is used. 1063is used.</p>
1316</dd> 1064 </dd>
1317<p></p> 1065 <dt>$windowid = $term-&gt;parent</dt>
1318<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1319</dt>
1320<dd> 1066 <dd>
1321Return the window id of the toplevel window. 1067 <p>Return the window id of the toplevel window.</p>
1322</dd> 1068 </dd>
1323<p></p> 1069 <dt>$windowid = $term-&gt;vt</dt>
1324<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
1325</dt>
1326<dd> 1070 <dd>
1327Return the window id of the terminal window. 1071 <p>Return the window id of the terminal window.</p>
1328</dd> 1072 </dd>
1329<p></p> 1073 <dt>$term-&gt;vt_emask_add ($x_event_mask)</dt>
1330<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1331</dt>
1332<dd> 1074 <dd>
1333Adds the specified events to the vt event mask. Useful e.g. when you want 1075 <p>Adds the specified events to the vt event mask. Useful e.g. when you want
1334to receive pointer events all the times: 1076to receive pointer events all the times:</p>
1335</dd> 1077<pre> $term-&gt;vt_emask_add (urxvt::PointerMotionMask);
1336<dd> 1078
1337<pre> 1079</pre>
1338 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1339</dd> 1080 </dd>
1340<p></p> 1081 <dt>$term-&gt;focus_in</dt>
1341<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br /> 1082 <dt>$term-&gt;focus_out</dt>
1342</dt> 1083 <dt>$term-&gt;key_press ($state, $keycode[, $time])</dt>
1343<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br /> 1084 <dt>$term-&gt;key_release ($state, $keycode[, $time])</dt>
1344</dt>
1345<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br />
1346</dt>
1347<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br />
1348</dt>
1349<dd> 1085 <dd>
1350Deliver various fake events to to terminal. 1086 <p>Deliver various fake events to to terminal.</p>
1351</dd> 1087 </dd>
1352<p></p> 1088 <dt>$window_width = $term-&gt;width</dt>
1353<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1089 <dt>$window_height = $term-&gt;height</dt>
1354</dt> 1090 <dt>$font_width = $term-&gt;fwidth</dt>
1355<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1091 <dt>$font_height = $term-&gt;fheight</dt>
1356</dt> 1092 <dt>$font_ascent = $term-&gt;fbase</dt>
1357<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1093 <dt>$terminal_rows = $term-&gt;nrow</dt>
1358</dt> 1094 <dt>$terminal_columns = $term-&gt;ncol</dt>
1359<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br /> 1095 <dt>$has_focus = $term-&gt;focus</dt>
1360</dt> 1096 <dt>$is_mapped = $term-&gt;mapped</dt>
1361<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br /> 1097 <dt>$max_scrollback = $term-&gt;saveLines</dt>
1362</dt> 1098 <dt>$nrow_plus_saveLines = $term-&gt;total_rows</dt>
1363<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br /> 1099 <dt>$topmost_scrollback_row = $term-&gt;top_row</dt>
1364</dt>
1365<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
1366</dt>
1367<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
1368</dt>
1369<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
1370</dt>
1371<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1372</dt>
1373<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1374</dt>
1375<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1376</dt>
1377<dd> 1100 <dd>
1378Return various integers describing terminal characteristics. 1101 <p>Return various integers describing terminal characteristics.</p>
1379</dd> 1102 </dd>
1380<p></p> 1103 <dt>$x_display = $term-&gt;display_id</dt>
1381<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1382</dt>
1383<dd> 1104 <dd>
1384Return the DISPLAY used by rxvt-unicode. 1105 <p>Return the DISPLAY used by rxvt-unicode.</p>
1385</dd> 1106 </dd>
1386<p></p> 1107 <dt>$lc_ctype = $term-&gt;locale</dt>
1387<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
1388</dt>
1389<dd> 1108 <dd>
1390Returns the LC_CTYPE category string used by this rxvt-unicode. 1109 <p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p>
1391</dd> 1110 </dd>
1392<p></p> 1111 <dt>$env = $term-&gt;env</dt>
1393<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
1394</dt>
1395<dd> 1112 <dd>
1396Returns a copy of the environment in effect for the terminal as a hashref 1113 <p>Returns a copy of the environment in effect for the terminal as a hashref
1397similar to <code>\%ENV</code>. 1114similar to <code>\%ENV</code>.</p>
1398</dd> 1115 </dd>
1399<p></p> 1116 <dt>@envv = $term-&gt;envv</dt>
1400<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1401</dt>
1402<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1403</dt>
1404<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1405</dt>
1406<dd> 1117 <dd>
1118 <p>Returns the environment as array of strings of the form <code>VAR=VALUE</code>.</p>
1119 </dd>
1120 <dt>@argv = $term-&gt;argv</dt>
1121 <dd>
1122 <p>Return the argument vector as this terminal, similar to @ARGV, but
1123includes the program name as first element.</p>
1124 </dd>
1125 <dt>$modifiermask = $term-&gt;ModLevel3Mask</dt>
1126 <dt>$modifiermask = $term-&gt;ModMetaMask</dt>
1127 <dt>$modifiermask = $term-&gt;ModNumLockMask</dt>
1128 <dd>
1407Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1129 <p>Return the modifier masks corresponding to the &quot;ISO Level 3 Shift&quot; (often
1408AltGr), the meta key (often Alt) and the num lock key, if applicable. 1130AltGr), the meta key (often Alt) and the num lock key, if applicable.</p>
1409</dd> 1131 </dd>
1410<p></p> 1132 <dt>$screen = $term-&gt;current_screen</dt>
1411<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1412</dt>
1413<dd> 1133 <dd>
1414Returns the currently displayed screen (0 primary, 1 secondary). 1134 <p>Returns the currently displayed screen (0 primary, 1 secondary).</p>
1415</dd> 1135 </dd>
1416<p></p> 1136 <dt>$cursor_is_hidden = $term-&gt;hidden_cursor</dt>
1417<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1418</dt>
1419<dd> 1137 <dd>
1420Returns wether the cursor is currently hidden or not. 1138 <p>Returns whether the cursor is currently hidden or not.</p>
1421</dd> 1139 </dd>
1422<p></p> 1140 <dt>$view_start = $term-&gt;view_start ([$newvalue])</dt>
1423<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1424</dt>
1425<dd> 1141 <dd>
1426Returns the row number of the topmost displayed line. Maximum value is 1142 <p>Returns the row number of the topmost displayed line. Maximum value is
1427<code>0</code>, which displays the normal terminal contents. Lower values scroll 1143<code>0</code>, which displays the normal terminal contents. Lower values scroll
1428this many lines into the scrollback buffer. 1144this many lines into the scrollback buffer.</p>
1429</dd> 1145 </dd>
1430<p></p> 1146 <dt>$term-&gt;want_refresh</dt>
1431<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1432</dt>
1433<dd> 1147 <dd>
1434Requests a screen refresh. At the next opportunity, rxvt-unicode will 1148 <p>Requests a screen refresh. At the next opportunity, rxvt-unicode will
1435compare the on-screen display with its stored representation. If they 1149compare the on-screen display with its stored representation. If they
1436differ, it redraws the differences. 1150differ, it redraws the differences.</p>
1437</dd>
1438<dd>
1439<p>Used after changing terminal contents to display them.</p> 1151 <p>Used after changing terminal contents to display them.</p>
1440</dd> 1152 </dd>
1441<p></p> 1153 <dt>$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</dt>
1442<dt><strong><a name="item_row_t">$text = $term-&gt;ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br />
1443</dt>
1444<dd> 1154 <dd>
1445Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1155 <p>Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1446is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1156is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1447terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1157terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1448line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line 1158line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1449is requested. 1159is requested.</p>
1450</dd>
1451<dd>
1452<p>If <code>$new_text</code> is specified, it will replace characters in the current 1160 <p>If <code>$new_text</code> is specified, it will replace characters in the current
1453line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1161line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1454to replace only parts of a line. The font index in the rendition will 1162to replace only parts of a line. The font index in the rendition will
1455automatically be updated.</p> 1163automatically be updated.</p>
1456</dd>
1457<dd>
1458<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1164 <p><code>$text</code> is in a special encoding: tabs and wide characters that use more
1459than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) 1165than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1460characters. Characters with combining characters and other characters that 1166characters. Characters with combining characters and other characters that
1461do not fit into the normal tetx encoding will be replaced with characters 1167do not fit into the normal tetx encoding will be replaced with characters
1462in the private use area.</p> 1168in the private use area.</p>
1463</dd>
1464<dd>
1465<p>You have to obey this encoding when changing text. The advantage is 1169 <p>You have to obey this encoding when changing text. The advantage is
1466that <code>substr</code> and similar functions work on screen cells and not on 1170that <code>substr</code> and similar functions work on screen cells and not on
1467characters.</p> 1171characters.</p>
1468</dd> 1172 <p>The methods <code>$term-&gt;special_encode</code> and <code>$term-&gt;special_decode</code>
1469<dd>
1470<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>
1471can be used to convert normal strings into this encoding and vice versa.</p> 1173can be used to convert normal strings into this encoding and vice versa.</p>
1472</dd> 1174 </dd>
1473<p></p> 1175 <dt>$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</dt>
1474<dt><strong><a name="item_row_r">$rend = $term-&gt;ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br />
1475</dt>
1476<dd> 1176 <dd>
1477Like <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>, but returns an arrayref with rendition 1177 <p>Like <code>$term-&gt;ROW_t</code>, but returns an arrayref with rendition
1478bitsets. Rendition bitsets contain information about colour, font, font 1178bitsets. Rendition bitsets contain information about colour, font, font
1479styles and similar information. See also <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a>. 1179styles and similar information. See also <code>$term-&gt;ROW_t</code>.</p>
1480</dd>
1481<dd>
1482<p>When setting rendition, the font mask will be ignored.</p> 1180 <p>When setting rendition, the font mask will be ignored.</p>
1483</dd>
1484<dd>
1485<p>See the section on RENDITION, above.</p> 1181 <p>See the section on RENDITION, above.</p>
1486</dd> 1182 </dd>
1487<p></p> 1183 <dt>$length = $term-&gt;ROW_l ($row_number[, $new_length])</dt>
1488<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
1489</dt>
1490<dd> 1184 <dd>
1491Returns the number of screen cells that are in use (``the line 1185 <p>Returns the number of screen cells that are in use (&quot;the line
1492length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the 1186length&quot;). Unlike the urxvt core, this returns <code>$term-&gt;ncol</code> if the
1493line is joined with the following one. 1187line is joined with the following one.</p>
1494</dd> 1188 </dd>
1495<p></p> 1189 <dt>$bool = $term-&gt;is_longer ($row_number)</dt>
1496<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
1497</dt>
1498<dd> 1190 <dd>
1499Returns true if the row is part of a multiple-row logical ``line'' (i.e. 1191 <p>Returns true if the row is part of a multiple-row logical &quot;line&quot; (i.e.
1500joined with the following row), which means all characters are in use 1192joined with the following row), which means all characters are in use
1501and it is continued on the next row (and possibly a continuation of the 1193and it is continued on the next row (and possibly a continuation of the
1502previous row(s)). 1194previous row(s)).</p>
1503</dd> 1195 </dd>
1504<p></p> 1196 <dt>$line = $term-&gt;line ($row_number)</dt>
1505<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
1506</dt>
1507<dd> 1197 <dd>
1508Create and return a new <code>urxvt::line</code> object that stores information 1198 <p>Create and return a new <code>urxvt::line</code> object that stores information
1509about the logical line that row <code>$row_number</code> is part of. It supports the 1199about the logical line that row <code>$row_number</code> is part of. It supports the
1510following methods: 1200following methods:</p>
1201 <p>
1202 <dl>
1203 <dt>$text = $line-&gt;t ([$new_text])</dt>
1204 <dd>
1205 <p>Returns or replaces the full text of the line, similar to <code>ROW_t</code></p>
1206 </dd>
1207 <dt>$rend = $line-&gt;r ([$new_rend])</dt>
1208 <dd>
1209 <p>Returns or replaces the full rendition array of the line, similar to <code>ROW_r</code></p>
1210 </dd>
1211 <dt>$length = $line-&gt;l</dt>
1212 <dd>
1213 <p>Returns the length of the line in cells, similar to <code>ROW_l</code>.</p>
1214 </dd>
1215 <dt>$rownum = $line-&gt;beg</dt>
1216 <dt>$rownum = $line-&gt;end</dt>
1217 <dd>
1218 <p>Return the row number of the first/last row of the line, respectively.</p>
1219 </dd>
1220 <dt>$offset = $line-&gt;offset_of ($row, $col)</dt>
1221 <dd>
1222 <p>Returns the character offset of the given row|col pair within the logical
1223line. Works for rows outside the line, too, and returns corresponding
1224offsets outside the string.</p>
1225 </dd>
1226 <dt>($row, $col) = $line-&gt;coord_of ($offset)</dt>
1227 <dd>
1228 <p>Translates a string offset into terminal coordinates again.</p>
1229 </dd>
1230 </dl>
1231 </p>
1511</dd> 1232 </dd>
1233 <dt>$text = $term-&gt;special_encode $string</dt>
1234 <dd>
1235 <p>Converts a perl string into the special encoding used by rxvt-unicode,
1236where one character corresponds to one screen cell. See
1237<code>$term-&gt;ROW_t</code> for details.</p>
1238 </dd>
1239 <dt>$string = $term-&gt;special_decode $text</dt>
1240 <dd>
1241 <p>Converts rxvt-unicodes text representation into a perl string. See
1242<code>$term-&gt;ROW_t</code> for details.</p>
1243 </dd>
1244 <dt>$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</dt>
1245 <dt>$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</dt>
1246 <dd>
1247 <p>Register/unregister a synchronous button grab. See the XGrabButton
1248manpage.</p>
1249 </dd>
1250 <dt>$success = $term-&gt;grab ($eventtime[, $sync])</dt>
1251 <dd>
1252 <p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1253synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p>
1254 </dd>
1255 <dt>$term-&gt;allow_events_async</dt>
1256 <dd>
1257 <p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p>
1258 </dd>
1259 <dt>$term-&gt;allow_events_sync</dt>
1260 <dd>
1261 <p>Calls XAllowEvents with SyncBoth for the most recent grab.</p>
1262 </dd>
1263 <dt>$term-&gt;allow_events_replay</dt>
1264 <dd>
1265 <p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1266recent grab.</p>
1267 </dd>
1268 <dt>$term-&gt;ungrab</dt>
1269 <dd>
1270 <p>Calls XUngrab for the most recent grab. Is called automatically on
1271evaluation errors, as it is better to lose the grab in the error case as
1272the session.</p>
1273 </dd>
1274 <dt>$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</dt>
1275 <dt>$atom_name = $term-&gt;XGetAtomName ($atom)</dt>
1276 <dt>@atoms = $term-&gt;XListProperties ($window)</dt>
1277 <dt>($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</dt>
1278 <dt>$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</dt>
1279 <dt>$term-&gt;XDeleteProperty ($window, $property)</dt>
1280 <dt>$window = $term-&gt;DefaultRootWindow</dt>
1281 <dt>$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</dt>
1282 <dt>$term-&gt;XMapWindow ($window)</dt>
1283 <dt>$term-&gt;XUnmapWindow ($window)</dt>
1284 <dt>$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</dt>
1285 <dt>($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</dt>
1286 <dt>$term-&gt;XChangeInput ($window, $add_events[, $del_events])</dt>
1287 <dd>
1288 <p>Various X or X-related functions. The <code>$term</code> object only serves as
1289the source of the display, otherwise those functions map more-or-less
1290directory onto the X functions of the same name.</p>
1291 </dd>
1292</dl>
1293
1294</div>
1295<h2 id="The_code_urxvt_popup_code_Class">The <code>urxvt::popup</code> Class</h2>
1296<div id="The_code_urxvt_popup_code_Class_CONT">
1512<dl> 1297<dl>
1513<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br /> 1298 <dt>$popup-&gt;add_title ($title)</dt>
1514</dt>
1515<dd> 1299 <dd>
1516Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> 1300 <p>Adds a non-clickable title to the popup.</p>
1517</dd> 1301 </dd>
1518<p></p> 1302 <dt>$popup-&gt;add_separator ([$sepchr])</dt>
1519<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
1520</dt>
1521<dd> 1303 <dd>
1522Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
1523</dd>
1524<p></p>
1525<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
1526</dt>
1527<dd>
1528Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
1529</dd>
1530<p></p>
1531<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
1532</dt>
1533<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
1534</dt>
1535<dd>
1536Return the row number of the first/last row of the line, respectively.
1537</dd>
1538<p></p>
1539<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1540</dt>
1541<dd>
1542Returns the character offset of the given row|col pair within the logical
1543line. Works for rows outside the line, too, and returns corresponding
1544offsets outside the string.
1545</dd>
1546<p></p>
1547<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1548</dt>
1549<dd>
1550Translates a string offset into terminal coordinates again.
1551</dd>
1552<p></p></dl>
1553<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
1554</dt>
1555<dd>
1556Converts a perl string into the special encoding used by rxvt-unicode,
1557where one character corresponds to one screen cell. See
1558<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1559</dd>
1560<p></p>
1561<dt><strong><a name="item_special_decode">$string = $term-&gt;special_decode $text</a></strong><br />
1562</dt>
1563<dd>
1564Converts rxvt-unicodes text reprsentation into a perl string. See
1565<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1566</dd>
1567<p></p>
1568<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1569</dt>
1570<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1571</dt>
1572<dd>
1573Register/unregister a synchronous button grab. See the XGrabButton
1574manpage.
1575</dd>
1576<p></p>
1577<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1578</dt>
1579<dd>
1580Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1581synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
1582</dd>
1583<p></p>
1584<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
1585</dt>
1586<dd>
1587Calls XAllowEvents with AsyncBoth for the most recent grab.
1588</dd>
1589<p></p>
1590<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
1591</dt>
1592<dd>
1593Calls XAllowEvents with SyncBoth for the most recent grab.
1594</dd>
1595<p></p>
1596<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
1597</dt>
1598<dd>
1599Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1600recent grab.
1601</dd>
1602<p></p>
1603<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
1604</dt>
1605<dd>
1606Calls XUngrab for the most recent grab. Is called automatically on
1607evaluation errors, as it is better to lose the grab in the error case as
1608the session.
1609</dd>
1610<p></p>
1611<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1612</dt>
1613<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1614</dt>
1615<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1616</dt>
1617<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1618</dt>
1619<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1620</dt>
1621<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1622</dt>
1623<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1624</dt>
1625<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1626</dt>
1627<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1628</dt>
1629<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1630</dt>
1631<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1632</dt>
1633<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1634</dt>
1635<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1636</dt>
1637<dd>
1638Various X or X-related functions. The <code>$term</code> object only serves as
1639the source of the display, otherwise those functions map more-or-less
1640directory onto the X functions of the same name.
1641</dd>
1642<p></p></dl>
1643<p>
1644</p>
1645<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1646<dl>
1647<dt><strong><a name="item_add_title">$popup-&gt;add_title ($title)</a></strong><br />
1648</dt>
1649<dd>
1650Adds a non-clickable title to the popup.
1651</dd>
1652<p></p>
1653<dt><strong><a name="item_add_separator">$popup-&gt;add_separator ([$sepchr])</a></strong><br />
1654</dt>
1655<dd>
1656Creates a separator, optionally using the character given as <code>$sepchr</code>. 1304 <p>Creates a separator, optionally using the character given as <code>$sepchr</code>.</p>
1657</dd> 1305 </dd>
1658<p></p> 1306 <dt>$popup-&gt;add_button ($text, $cb)</dt>
1659<dt><strong><a name="item_add_button">$popup-&gt;add_button ($text, $cb)</a></strong><br />
1660</dt>
1661<dd> 1307 <dd>
1662Adds a clickable button to the popup. <code>$cb</code> is called whenever it is 1308 <p>Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1663selected. 1309selected.</p>
1664</dd> 1310 </dd>
1665<p></p> 1311 <dt>$popup-&gt;add_toggle ($text, $initial_value, $cb)</dt>
1666<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $initial_value, $cb)</a></strong><br />
1667</dt>
1668<dd> 1312 <dd>
1669Adds a toggle/checkbox item to the popup. The callback gets called 1313 <p>Adds a toggle/checkbox item to the popup. The callback gets called
1670whenever it gets toggled, with a boolean indicating its new value as its 1314whenever it gets toggled, with a boolean indicating its new value as its
1671first argument. 1315first argument.</p>
1672</dd> 1316 </dd>
1673<p></p> 1317 <dt>$popup-&gt;show</dt>
1674<dt><strong>$popup-&gt;show</strong><br />
1675</dt>
1676<dd> 1318 <dd>
1677Displays the popup (which is initially hidden). 1319 <p>Displays the popup (which is initially hidden).</p>
1678</dd> 1320 </dd>
1679<p></p></dl> 1321</dl>
1680<p> 1322
1681</p> 1323</div>
1682<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 1324<h2 id="The_code_urxvt_timer_code_Class">The <code>urxvt::timer</code> Class</h2>
1325<div id="The_code_urxvt_timer_code_Class_CONT">
1683<p>This class implements timer watchers/events. Time is represented as a 1326<p>This class implements timer watchers/events. Time is represented as a
1684fractional number of seconds since the epoch. Example:</p> 1327fractional number of seconds since the epoch. Example:</p>
1685<pre>
1686 $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); 1328<pre> $term-&gt;{overlay} = $term-&gt;overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1687 $term-&gt;{timer} = urxvt::timer 1329 $term-&gt;{timer} = urxvt::timer
1688 -&gt;new 1330 -&gt;new
1689 -&gt;interval (1) 1331 -&gt;interval (1)
1690 -&gt;cb (sub { 1332 -&gt;cb (sub {
1691 $term-&gt;{overlay}-&gt;set (0, 0, 1333 $term-&gt;{overlay}-&gt;set (0, 0,
1692 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]); 1334 sprintf &quot;%2d:%02d:%02d&quot;, (localtime urxvt::NOW)[2,1,0]);
1693 });</pre> 1335 });
1336
1337</pre>
1694<dl> 1338<dl>
1695<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> 1339 <dt>$timer = new urxvt::timer</dt>
1696</dt>
1697<dd> 1340 <dd>
1698Create a new timer object in started state. It is scheduled to fire 1341 <p>Create a new timer object in started state. It is scheduled to fire
1699immediately. 1342immediately.</p>
1700</dd> 1343 </dd>
1701<p></p> 1344 <dt>$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</dt>
1702<dt><strong><a name="item_cb">$timer = $timer-&gt;cb (sub { my ($timer) = @_; ... })</a></strong><br />
1703</dt>
1704<dd> 1345 <dd>
1705Set the callback to be called when the timer triggers. 1346 <p>Set the callback to be called when the timer triggers.</p>
1706</dd> 1347 </dd>
1707<p></p> 1348 <dt>$tstamp = $timer-&gt;at</dt>
1708<dt><strong><a name="item_at">$tstamp = $timer-&gt;at</a></strong><br />
1709</dt>
1710<dd> 1349 <dd>
1711Return the time this watcher will fire next. 1350 <p>Return the time this watcher will fire next.</p>
1712</dd> 1351 </dd>
1713<p></p>
1714<dt><strong>$timer = $timer-&gt;set ($tstamp)</strong><br /> 1352 <dt>$timer = $timer-&gt;set ($tstamp)</dt>
1715</dt>
1716<dd> 1353 <dd>
1717Set the time the event is generated to $tstamp. 1354 <p>Set the time the event is generated to $tstamp.</p>
1718</dd> 1355 </dd>
1719<p></p> 1356 <dt>$timer = $timer-&gt;interval ($interval)</dt>
1720<dt><strong><a name="item_interval">$timer = $timer-&gt;interval ($interval)</a></strong><br />
1721</dt>
1722<dd> 1357 <dd>
1723Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically 1358 <p>Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
1724stop after it has fired once. If <code>$interval</code> is non-zero, then the timer 1359stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
1725is automatically rescheduled at the given intervals. 1360is automatically rescheduled at the given intervals.</p>
1726</dd> 1361 </dd>
1727<p></p> 1362 <dt>$timer = $timer-&gt;start</dt>
1728<dt><strong><a name="item_start">$timer = $timer-&gt;start</a></strong><br />
1729</dt>
1730<dd> 1363 <dd>
1731Start the timer. 1364 <p>Start the timer.</p>
1732</dd> 1365 </dd>
1733<p></p>
1734<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1366 <dt>$timer = $timer-&gt;start ($tstamp)</dt>
1735</dt>
1736<dd> 1367 <dd>
1737Set the event trigger time to <code>$tstamp</code> and start the timer. 1368 <p>Set the event trigger time to <code>$tstamp</code> and start the timer.</p>
1738</dd> 1369 </dd>
1739<p></p> 1370 <dt>$timer = $timer-&gt;after ($delay)</dt>
1740<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1741</dt>
1742<dd> 1371 <dd>
1743Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;. 1372 <p>Like <code>start</code>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.</p>
1744</dd> 1373 </dd>
1745<p></p> 1374 <dt>$timer = $timer-&gt;stop</dt>
1746<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1747</dt>
1748<dd> 1375 <dd>
1749Stop the timer. 1376 <p>Stop the timer.</p>
1750</dd> 1377 </dd>
1751<p></p></dl> 1378</dl>
1752<p> 1379
1753</p> 1380</div>
1754<h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> 1381<h2 id="The_code_urxvt_iow_code_Class">The <code>urxvt::iow</code> Class</h2>
1382<div id="The_code_urxvt_iow_code_Class_CONTEN">
1755<p>This class implements io watchers/events. Example:</p> 1383<p>This class implements io watchers/events. Example:</p>
1756<pre>
1757 $term-&gt;{socket} = ... 1384<pre> $term-&gt;{socket} = ...
1758 $term-&gt;{iow} = urxvt::iow 1385 $term-&gt;{iow} = urxvt::iow
1759 -&gt;new 1386 -&gt;new
1760 -&gt;fd (fileno $term-&gt;{socket}) 1387 -&gt;fd (fileno $term-&gt;{socket})
1761 -&gt;events (urxvt::EVENT_READ) 1388 -&gt;events (urxvt::EVENT_READ)
1762 -&gt;start 1389 -&gt;start
1763 -&gt;cb (sub { 1390 -&gt;cb (sub {
1764 my ($iow, $revents) = @_; 1391 my ($iow, $revents) = @_;
1765 # $revents must be 1 here, no need to check 1392 # $revents must be 1 here, no need to check
1766 sysread $term-&gt;{socket}, my $buf, 8192 1393 sysread $term-&gt;{socket}, my $buf, 8192
1767 or end-of-file; 1394 or end-of-file;
1768 });</pre> 1395 });
1396
1397
1398
1399
1400</pre>
1769<dl> 1401<dl>
1770<dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br /> 1402 <dt>$iow = new urxvt::iow</dt>
1771</dt>
1772<dd> 1403 <dd>
1773Create a new io watcher object in stopped state. 1404 <p>Create a new io watcher object in stopped state.</p>
1774</dd> 1405 </dd>
1775<p></p>
1776<dt><strong>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> 1406 <dt>$iow = $iow-&gt;cb (sub { my ($iow, $reventmask) = @_; ... })</dt>
1777</dt>
1778<dd> 1407 <dd>
1779Set the callback to be called when io events are triggered. <code>$reventmask</code> 1408 <p>Set the callback to be called when io events are triggered. <code>$reventmask</code>
1780is a bitset as described in the <a href="#item_events"><code>events</code></a> method. 1409is a bitset as described in the <code>events</code> method.</p>
1781</dd> 1410 </dd>
1782<p></p> 1411 <dt>$iow = $iow-&gt;fd ($fd)</dt>
1783<dt><strong><a name="item_fd">$iow = $iow-&gt;fd ($fd)</a></strong><br />
1784</dt>
1785<dd> 1412 <dd>
1786Set the filedescriptor (not handle) to watch. 1413 <p>Set the file descriptor (not handle) to watch.</p>
1787</dd> 1414 </dd>
1788<p></p> 1415 <dt>$iow = $iow-&gt;events ($eventmask)</dt>
1789<dt><strong><a name="item_events">$iow = $iow-&gt;events ($eventmask)</a></strong><br />
1790</dt>
1791<dd> 1416 <dd>
1792Set the event mask to watch. The only allowed values are 1417 <p>Set the event mask to watch. The only allowed values are
1793<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed 1418<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed
1794together, or <code>urxvt::EVENT_NONE</code>. 1419together, or <code>urxvt::EVENT_NONE</code>.</p>
1795</dd> 1420 </dd>
1796<p></p> 1421 <dt>$iow = $iow-&gt;start</dt>
1797<dt><strong>$iow = $iow-&gt;start</strong><br />
1798</dt>
1799<dd> 1422 <dd>
1800Start watching for requested events on the given handle. 1423 <p>Start watching for requested events on the given handle.</p>
1801</dd> 1424 </dd>
1802<p></p> 1425 <dt>$iow = $iow-&gt;stop</dt>
1803<dt><strong>$iow = $iow-&gt;stop</strong><br />
1804</dt>
1805<dd> 1426 <dd>
1806Stop watching for events on the given filehandle. 1427 <p>Stop watching for events on the given file handle.</p>
1807</dd> 1428 </dd>
1808<p></p></dl> 1429</dl>
1809<p> 1430
1810</p> 1431</div>
1811<h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> 1432<h2 id="The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</h2>
1433<div id="The_code_urxvt_iw_code_Class_CONTENT">
1812<p>This class implements idle watchers, that get called automatically when 1434<p>This class implements idle watchers, that get called automatically when
1813the process is idle. They should return as fast as possible, after doing 1435the process is idle. They should return as fast as possible, after doing
1814some useful work.</p> 1436some useful work.</p>
1815<dl> 1437<dl>
1816<dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> 1438 <dt>$iw = new urxvt::iw</dt>
1817</dt>
1818<dd> 1439 <dd>
1819Create a new idle watcher object in stopped state. 1440 <p>Create a new idle watcher object in stopped state.</p>
1820</dd> 1441 </dd>
1821<p></p>
1822<dt><strong>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</strong><br /> 1442 <dt>$iw = $iw-&gt;cb (sub { my ($iw) = @_; ... })</dt>
1823</dt>
1824<dd> 1443 <dd>
1825Set the callback to be called when the watcher triggers. 1444 <p>Set the callback to be called when the watcher triggers.</p>
1826</dd> 1445 </dd>
1827<p></p>
1828<dt><strong>$timer = $timer-&gt;start</strong><br /> 1446 <dt>$timer = $timer-&gt;start</dt>
1829</dt>
1830<dd> 1447 <dd>
1831Start the watcher. 1448 <p>Start the watcher.</p>
1832</dd> 1449 </dd>
1833<p></p>
1834<dt><strong>$timer = $timer-&gt;stop</strong><br /> 1450 <dt>$timer = $timer-&gt;stop</dt>
1835</dt>
1836<dd> 1451 <dd>
1837Stop the watcher. 1452 <p>Stop the watcher.</p>
1838</dd> 1453 </dd>
1839<p></p></dl> 1454</dl>
1840<p> 1455
1841</p> 1456</div>
1842<h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> 1457<h2 id="The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</h2>
1458<div id="The_code_urxvt_pw_code_Class_CONTENT">
1843<p>This class implements process watchers. They create an event whenever a 1459<p>This class implements process watchers. They create an event whenever a
1844process exits, after which they stop automatically.</p> 1460process exits, after which they stop automatically.</p>
1845<pre>
1846 my $pid = fork; 1461<pre> my $pid = fork;
1847 ... 1462 ...
1848 $term-&gt;{pw} = urxvt::pw 1463 $term-&gt;{pw} = urxvt::pw
1849 -&gt;new 1464 -&gt;new
1850 -&gt;start ($pid) 1465 -&gt;start ($pid)
1851 -&gt;cb (sub { 1466 -&gt;cb (sub {
1852 my ($pw, $exit_status) = @_; 1467 my ($pw, $exit_status) = @_;
1853 ... 1468 ...
1854 });</pre> 1469 });
1470
1471</pre>
1855<dl> 1472<dl>
1856<dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> 1473 <dt>$pw = new urxvt::pw</dt>
1857</dt>
1858<dd> 1474 <dd>
1859Create a new process watcher in stopped state. 1475 <p>Create a new process watcher in stopped state.</p>
1860</dd> 1476 </dd>
1861<p></p>
1862<dt><strong>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> 1477 <dt>$pw = $pw-&gt;cb (sub { my ($pw, $exit_status) = @_; ... })</dt>
1863</dt>
1864<dd> 1478 <dd>
1865Set the callback to be called when the timer triggers. 1479 <p>Set the callback to be called when the timer triggers.</p>
1866</dd> 1480 </dd>
1867<p></p>
1868<dt><strong>$pw = $timer-&gt;start ($pid)</strong><br /> 1481 <dt>$pw = $timer-&gt;start ($pid)</dt>
1869</dt>
1870<dd> 1482 <dd>
1871Tells the wqtcher to start watching for process <code>$pid</code>. 1483 <p>Tells the watcher to start watching for process <code>$pid</code>.</p>
1872</dd> 1484 </dd>
1873<p></p> 1485 <dt>$pw = $pw-&gt;stop</dt>
1874<dt><strong>$pw = $pw-&gt;stop</strong><br />
1875</dt>
1876<dd> 1486 <dd>
1877Stop the watcher. 1487 <p>Stop the watcher.</p>
1878</dd> 1488 </dd>
1879<p></p></dl> 1489</dl>
1880<p> 1490
1881</p> 1491</div>
1882<hr /> 1492<h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p>
1883<h1><a name="environment">ENVIRONMENT</a></h1> 1493<div id="ENVIRONMENT_CONTENT">
1884<p> 1494
1885</p> 1495</div>
1886<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1496<h2 id="URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</h2>
1497<div id="URXVT_PERL_VERBOSITY_CONTENT">
1887<p>This variable controls the verbosity level of the perl extension. Higher 1498<p>This variable controls the verbosity level of the perl extension. Higher
1888numbers indicate more verbose output.</p> 1499numbers indicate more verbose output.</p>
1889<dl> 1500<dl>
1890<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1501 <dt>== 0 - fatal messages</dt>
1891</dt> 1502 <dt>&gt;= 3 - script loading and management</dt>
1892<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1503 <dt>&gt;=10 - all called hooks</dt>
1893</dt> 1504 <dt>&gt;=11 - hook return values</dt>
1894<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1895</dt>
1896<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1897</dt>
1898</dl> 1505</dl>
1899<p> 1506
1900</p> 1507</div>
1901<hr /> 1508<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
1902<h1><a name="author">AUTHOR</a></h1> 1509<div id="AUTHOR_CONTENT">
1903<pre>
1904 Marc Lehmann &lt;pcg@goof.com&gt; 1510<pre> Marc Lehmann &lt;pcg@goof.com&gt;
1905 <a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre> 1511 http://software.schmorp.de/pkg/rxvt-unicode
1906 1512
1907</body> 1513</pre>
1908 1514
1515</div>
1516</div></body>
1909</html> 1517</html>

Diff Legend

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