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.31 by root, Tue Jan 17 16:22:41 2006 UTC vs.
Revision 1.53 by root, Sun Jun 24 22:30:52 2007 UTC

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

Diff Legend

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