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