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.48 by root, Thu Dec 7 21:31:01 2006 UTC vs.
Revision 1.52 by root, Sun Jun 24 22:12:18 2007 UTC

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

Diff Legend

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