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