1 |
root |
1.1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
2 |
|
|
<html xmlns="http://www.w3.org/1999/xhtml"> |
3 |
|
|
<head> |
4 |
|
|
<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> |
5 |
|
|
<link rev="made" href="mailto:perl-binary@plan9.de" /> |
6 |
|
|
</head> |
7 |
|
|
|
8 |
|
|
<body style="background-color: white"> |
9 |
|
|
|
10 |
|
|
<p><a name="__index__"></a></p> |
11 |
|
|
<!-- INDEX BEGIN --> |
12 |
|
|
|
13 |
|
|
<ul> |
14 |
|
|
|
15 |
|
|
<li><a href="#name">NAME</a></li> |
16 |
|
|
<li><a href="#synopsis">SYNOPSIS</a></li> |
17 |
|
|
<li><a href="#description">DESCRIPTION</a></li> |
18 |
|
|
<ul> |
19 |
|
|
|
20 |
root |
1.7 |
<li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
21 |
root |
1.3 |
<li><a href="#general_api_considerations">General API Considerations</a></li> |
22 |
root |
1.1 |
<li><a href="#hooks">Hooks</a></li> |
23 |
root |
1.9 |
<li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
24 |
root |
1.1 |
<li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
25 |
root |
1.8 |
<li><a href="#rendition">RENDITION</a></li> |
26 |
root |
1.1 |
<li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
27 |
|
|
<li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
28 |
|
|
<li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
29 |
|
|
</ul> |
30 |
|
|
|
31 |
root |
1.2 |
<li><a href="#environment">ENVIRONMENT</a></li> |
32 |
|
|
<ul> |
33 |
|
|
|
34 |
|
|
<li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li> |
35 |
|
|
</ul> |
36 |
|
|
|
37 |
root |
1.1 |
<li><a href="#author">AUTHOR</a></li> |
38 |
|
|
</ul> |
39 |
|
|
<!-- INDEX END --> |
40 |
|
|
|
41 |
|
|
<hr /> |
42 |
|
|
<p> |
43 |
|
|
</p> |
44 |
root |
1.7 |
<hr /> |
45 |
root |
1.1 |
<h1><a name="name">NAME</a></h1> |
46 |
|
|
<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
47 |
|
|
<p> |
48 |
|
|
</p> |
49 |
|
|
<hr /> |
50 |
|
|
<h1><a name="synopsis">SYNOPSIS</a></h1> |
51 |
root |
1.5 |
<pre> |
52 |
|
|
# create a file grab_test in $HOME:</pre> |
53 |
root |
1.1 |
<pre> |
54 |
|
|
sub on_sel_grab { |
55 |
|
|
warn "you selected ", $_[0]->selection; |
56 |
|
|
() |
57 |
|
|
}</pre> |
58 |
|
|
<pre> |
59 |
root |
1.5 |
# start a rxvt using it:</pre> |
60 |
|
|
<pre> |
61 |
|
|
rxvt --perl-lib $HOME -pe grab_test</pre> |
62 |
root |
1.1 |
<p> |
63 |
|
|
</p> |
64 |
|
|
<hr /> |
65 |
|
|
<h1><a name="description">DESCRIPTION</a></h1> |
66 |
root |
1.4 |
<p>Everytime a terminal object gets created, scripts specified via the |
67 |
root |
1.5 |
<code>perl</code> resource are loaded and associated with it.</p> |
68 |
|
|
<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
69 |
|
|
thus must be encoded as UTF-8.</p> |
70 |
root |
1.3 |
<p>Each script will only ever be loaded once, even in rxvtd, where |
71 |
root |
1.7 |
scripts will be shared (but not enabled) for all terminals.</p> |
72 |
root |
1.3 |
<p> |
73 |
|
|
</p> |
74 |
root |
1.7 |
<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
75 |
root |
1.6 |
<p>This section describes the extensiosn delivered with this version. You can |
76 |
|
|
find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
77 |
|
|
<p>You can activate them like this:</p> |
78 |
|
|
<pre> |
79 |
|
|
rxvt -pe <extensionname></pre> |
80 |
|
|
<dl> |
81 |
|
|
<dt><strong><a name="item_selection">selection</a></strong><br /> |
82 |
|
|
</dt> |
83 |
|
|
<dd> |
84 |
root |
1.9 |
Intelligent selection. This etxension tries to be more intelligent when the user |
85 |
|
|
extends selections (double-click). |
86 |
|
|
</dd> |
87 |
|
|
<dd> |
88 |
|
|
<p>It also offers the following bindable event:</p> |
89 |
root |
1.6 |
</dd> |
90 |
|
|
<dl> |
91 |
|
|
<dt><strong><a name="item_rot13">rot13</a></strong><br /> |
92 |
|
|
</dt> |
93 |
|
|
<dd> |
94 |
|
|
Rot-13 the selection when activated. Used via keyboard trigger: |
95 |
|
|
</dd> |
96 |
|
|
<dd> |
97 |
|
|
<pre> |
98 |
|
|
URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
99 |
|
|
</dd> |
100 |
|
|
<p></p></dl> |
101 |
|
|
<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
102 |
|
|
</dt> |
103 |
|
|
<dd> |
104 |
root |
1.8 |
Displays a digital clock using the built-in overlay. |
105 |
root |
1.6 |
</dd> |
106 |
|
|
<p></p> |
107 |
root |
1.8 |
<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
108 |
root |
1.6 |
</dt> |
109 |
|
|
<dd> |
110 |
root |
1.8 |
Displays a very simple digital clock in the upper right corner of the |
111 |
|
|
window. Illustrates overwriting the refresh callbacks to create your own |
112 |
|
|
overlays or changes. |
113 |
root |
1.6 |
</dd> |
114 |
|
|
<p></p></dl> |
115 |
|
|
<p> |
116 |
|
|
</p> |
117 |
root |
1.3 |
<h2><a name="general_api_considerations">General API Considerations</a></h2> |
118 |
|
|
<p>All objects (such as terminals, time watchers etc.) are typical |
119 |
|
|
reference-to-hash objects. The hash can be used to store anything you |
120 |
|
|
like. All members starting with an underscore (such as <code>_ptr</code> or |
121 |
root |
1.9 |
<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
122 |
root |
1.3 |
modified).</p> |
123 |
|
|
<p>When objects are destroyed on the C++ side, the perl object hashes are |
124 |
|
|
emptied, so its best to store related objects such as time watchers and |
125 |
|
|
the like inside the terminal object so they get destroyed as soon as the |
126 |
|
|
terminal is destroyed.</p> |
127 |
root |
1.1 |
<p> |
128 |
|
|
</p> |
129 |
|
|
<h2><a name="hooks">Hooks</a></h2> |
130 |
root |
1.9 |
<p>The following subroutines can be declared in loaded scripts, and will be |
131 |
|
|
called whenever the relevant event happens.</p> |
132 |
|
|
<p>The first argument passed to them is an object private to each terminal |
133 |
|
|
and extension package. You can call all <code>urxvt::term</code> methods on it, but |
134 |
|
|
its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
135 |
|
|
object that is shared between all packages is stored in the <code>term</code> |
136 |
|
|
member.</p> |
137 |
root |
1.1 |
<p>All of them must return a boolean value. If it is true, then the event |
138 |
|
|
counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
139 |
|
|
and the relevant action might not be carried out by the C++ code.</p> |
140 |
|
|
<p>When in doubt, return a false value (preferably <code>()</code>).</p> |
141 |
|
|
<dl> |
142 |
|
|
<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
143 |
|
|
</dt> |
144 |
|
|
<dd> |
145 |
|
|
Called after a new terminal object has been initialized, but before |
146 |
|
|
windows are created or the command gets run. |
147 |
|
|
</dd> |
148 |
|
|
<p></p> |
149 |
|
|
<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
150 |
|
|
</dt> |
151 |
|
|
<dd> |
152 |
|
|
Called after the screen is ``reset'' for any reason, such as resizing or |
153 |
|
|
control sequences. Here is where you can react on changes to size-related |
154 |
|
|
variables. |
155 |
|
|
</dd> |
156 |
|
|
<p></p> |
157 |
|
|
<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
158 |
|
|
</dt> |
159 |
|
|
<dd> |
160 |
|
|
Called at the very end of initialisation of a new terminal, just before |
161 |
|
|
returning to the mainloop. |
162 |
|
|
</dd> |
163 |
|
|
<p></p> |
164 |
|
|
<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
165 |
|
|
</dt> |
166 |
|
|
<dd> |
167 |
|
|
Called whenever a selection has been made by the user, but before the |
168 |
|
|
selection text is copied, so changes to the beginning, end or type of the |
169 |
|
|
selection will be honored. |
170 |
|
|
</dd> |
171 |
|
|
<dd> |
172 |
|
|
<p>Returning a true value aborts selection making by urxvt, in which case you |
173 |
|
|
have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term->selection_grab</code></a>.</p> |
174 |
|
|
</dd> |
175 |
|
|
<p></p> |
176 |
|
|
<dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br /> |
177 |
|
|
</dt> |
178 |
|
|
<dd> |
179 |
|
|
Called whenever a selection has been copied, but before the selection is |
180 |
|
|
requested from the server. The selection text can be queried and changed |
181 |
|
|
by calling <a href="#item_selection"><code>$term->selection</code></a>. |
182 |
|
|
</dd> |
183 |
|
|
<dd> |
184 |
|
|
<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
185 |
|
|
</dd> |
186 |
|
|
<p></p> |
187 |
root |
1.9 |
<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
188 |
|
|
</dt> |
189 |
|
|
<dd> |
190 |
|
|
Called whenever the user tries to extend the selection (e.g. with a double |
191 |
|
|
click) and is either supposed to return false (normal operation), or |
192 |
|
|
should extend the selection itelf and return true to suppress the built-in |
193 |
|
|
processing. |
194 |
|
|
</dd> |
195 |
|
|
<dd> |
196 |
|
|
<p>See the <em>selection</em> example extension.</p> |
197 |
|
|
</dd> |
198 |
|
|
<p></p> |
199 |
root |
1.1 |
<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
200 |
|
|
</dt> |
201 |
|
|
<dd> |
202 |
|
|
Called whenever the window gets the keyboard focus, before urxvt does |
203 |
|
|
focus in processing. |
204 |
|
|
</dd> |
205 |
|
|
<p></p> |
206 |
|
|
<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
207 |
|
|
</dt> |
208 |
|
|
<dd> |
209 |
|
|
Called wheneever the window loses keyboard focus, before urxvt does focus |
210 |
|
|
out processing. |
211 |
|
|
</dd> |
212 |
|
|
<p></p> |
213 |
|
|
<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
214 |
|
|
</dt> |
215 |
|
|
<dd> |
216 |
|
|
Called whenever the view offset changes, i..e the user or program |
217 |
|
|
scrolls. Offset <code>0</code> means display the normal terminal, positive values |
218 |
|
|
show this many lines of scrollback. |
219 |
|
|
</dd> |
220 |
|
|
<p></p> |
221 |
|
|
<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br /> |
222 |
|
|
</dt> |
223 |
|
|
<dd> |
224 |
|
|
Called whenever lines scroll out of the terminal area into the scrollback |
225 |
|
|
buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
226 |
|
|
than the scroll back buffer or the terminal. |
227 |
|
|
</dd> |
228 |
|
|
<dd> |
229 |
|
|
<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
230 |
|
|
$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
231 |
|
|
number of lines that will be in the scrollback buffer.</p> |
232 |
|
|
</dd> |
233 |
|
|
<p></p> |
234 |
|
|
<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
235 |
|
|
</dt> |
236 |
|
|
<dd> |
237 |
|
|
Called whenever the <code>program(s)</code> running in the urxvt window send output. |
238 |
|
|
</dd> |
239 |
|
|
<p></p> |
240 |
|
|
<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
241 |
|
|
</dt> |
242 |
|
|
<dd> |
243 |
|
|
Called just before the screen gets redrawn. Can be used for overlay |
244 |
|
|
or similar effects by modify terminal contents in refresh_begin, and |
245 |
|
|
restoring them in refresh_end. The built-in overlay and selection display |
246 |
|
|
code is run after this hook, and takes precedence. |
247 |
|
|
</dd> |
248 |
|
|
<p></p> |
249 |
|
|
<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> |
250 |
|
|
</dt> |
251 |
|
|
<dd> |
252 |
|
|
Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
253 |
|
|
</dd> |
254 |
root |
1.5 |
<p></p> |
255 |
|
|
<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
256 |
|
|
</dt> |
257 |
|
|
<dd> |
258 |
|
|
Called whenever the user presses a key combination that has a |
259 |
|
|
<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
260 |
|
|
resource in the <code>rxvt(1)</code> manpage). |
261 |
|
|
</dd> |
262 |
root |
1.1 |
<p></p></dl> |
263 |
|
|
<p> |
264 |
|
|
</p> |
265 |
root |
1.9 |
<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
266 |
|
|
<dl> |
267 |
|
|
<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
268 |
|
|
</dt> |
269 |
|
|
<dd> |
270 |
|
|
The current terminal. Whenever a callback/Hook is bein executed, this |
271 |
|
|
variable stores the current <code>urxvt::term</code> object. |
272 |
|
|
</dd> |
273 |
|
|
<p></p></dl> |
274 |
|
|
<p> |
275 |
|
|
</p> |
276 |
root |
1.1 |
<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
277 |
|
|
<dl> |
278 |
|
|
<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
279 |
|
|
</dt> |
280 |
|
|
<dd> |
281 |
|
|
Fatally aborts execution with the given error message. Avoid at all |
282 |
|
|
costs! The only time this is acceptable is when the terminal process |
283 |
|
|
starts up. |
284 |
|
|
</dd> |
285 |
|
|
<p></p> |
286 |
|
|
<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> |
287 |
|
|
</dt> |
288 |
|
|
<dd> |
289 |
root |
1.3 |
Calls <code>rxvt_warn</code> with the given string which should not include a |
290 |
root |
1.1 |
newline. The module also overwrites the <code>warn</code> builtin with a function |
291 |
|
|
that calls this function. |
292 |
|
|
</dd> |
293 |
|
|
<dd> |
294 |
|
|
<p>Using this function has the advantage that its output ends up in the |
295 |
|
|
correct place, e.g. on stderr of the connecting urxvtc client.</p> |
296 |
|
|
</dd> |
297 |
|
|
<p></p> |
298 |
|
|
<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
299 |
|
|
</dt> |
300 |
|
|
<dd> |
301 |
|
|
Returns the ``current time'' (as per the event loop). |
302 |
|
|
</dd> |
303 |
|
|
<p></p></dl> |
304 |
|
|
<p> |
305 |
|
|
</p> |
306 |
root |
1.8 |
<h2><a name="rendition">RENDITION</a></h2> |
307 |
|
|
<p>Rendition bitsets contain information about colour, font, font styles and |
308 |
|
|
similar information for each screen cell.</p> |
309 |
|
|
<p>The following ``macros'' deal with changes in rendition sets. You should |
310 |
|
|
never just create a bitset, you should always modify an existing one, |
311 |
|
|
as they contain important information required for correct operation of |
312 |
|
|
rxvt-unicode.</p> |
313 |
|
|
<dl> |
314 |
|
|
<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
315 |
|
|
</dt> |
316 |
|
|
<dd> |
317 |
|
|
Returns the default rendition, as used when the terminal is starting up or |
318 |
|
|
being reset. Useful as a base to start when creating renditions. |
319 |
|
|
</dd> |
320 |
|
|
<p></p> |
321 |
|
|
<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
322 |
|
|
</dt> |
323 |
|
|
<dd> |
324 |
|
|
Return the rendition mask used for overlays by default. |
325 |
|
|
</dd> |
326 |
|
|
<p></p> |
327 |
|
|
<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br /> |
328 |
|
|
</dt> |
329 |
|
|
<dd> |
330 |
|
|
Return the bit that enabled bold, italic, blink, reverse-video and |
331 |
|
|
underline, respectively. To enable such a style, just logically OR it into |
332 |
|
|
the bitset. |
333 |
|
|
</dd> |
334 |
|
|
<p></p> |
335 |
|
|
<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
336 |
|
|
</dt> |
337 |
|
|
<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
338 |
|
|
</dt> |
339 |
|
|
<dd> |
340 |
|
|
Return the foreground/background colour index, respectively. |
341 |
|
|
</dd> |
342 |
|
|
<p></p> |
343 |
|
|
<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
344 |
|
|
</dt> |
345 |
|
|
<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
346 |
|
|
</dt> |
347 |
|
|
<dd> |
348 |
|
|
Replace the foreground/background colour in the rendition mask with the |
349 |
|
|
specified one. |
350 |
|
|
</dd> |
351 |
|
|
<p></p> |
352 |
|
|
<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
353 |
|
|
</dt> |
354 |
|
|
<dd> |
355 |
|
|
Return the ``custom'' value: Every rendition has 5 bits for use by |
356 |
|
|
extensions. They can be set and changed as you like and are initially |
357 |
|
|
zero. |
358 |
|
|
</dd> |
359 |
|
|
<p></p> |
360 |
|
|
<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
361 |
|
|
</dt> |
362 |
|
|
<dd> |
363 |
|
|
Change the custom value. |
364 |
|
|
</dd> |
365 |
|
|
<p></p></dl> |
366 |
|
|
<p> |
367 |
|
|
</p> |
368 |
root |
1.1 |
<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
369 |
|
|
<dl> |
370 |
root |
1.2 |
<dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
371 |
|
|
</dt> |
372 |
|
|
<dd> |
373 |
|
|
Returns the current resource value associated with a given name and |
374 |
|
|
optionally sets a new value. Setting values is most useful in the <code>init</code> |
375 |
|
|
hook. Unset resources are returned and accepted as <code>undef</code>. |
376 |
|
|
</dd> |
377 |
|
|
<dd> |
378 |
|
|
<p>The new value must be properly encoded to a suitable character encoding |
379 |
|
|
before passing it to this method. Similarly, the returned value may need |
380 |
|
|
to be converted from the used encoding to text.</p> |
381 |
|
|
</dd> |
382 |
|
|
<dd> |
383 |
|
|
<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified |
384 |
|
|
as resource names of the form <code>color+<index></code>, e.g. <code>color+5</code>. (will |
385 |
|
|
likely change).</p> |
386 |
|
|
</dd> |
387 |
|
|
<dd> |
388 |
|
|
<p>Please note that resource strings will currently only be freed when the |
389 |
|
|
terminal is destroyed, so changing options frequently will eat memory.</p> |
390 |
|
|
</dd> |
391 |
|
|
<dd> |
392 |
|
|
<p>Here is a a likely non-exhaustive list of resource names, not all of which |
393 |
|
|
are supported in every build, please see the source to see the actual |
394 |
|
|
list:</p> |
395 |
|
|
</dd> |
396 |
|
|
<dd> |
397 |
|
|
<pre> |
398 |
|
|
answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
399 |
|
|
borderLess color cursorBlink cursorUnderline cutchars delete_key |
400 |
|
|
display_name embed ext_bwidth fade font geometry hold iconName |
401 |
|
|
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
402 |
root |
1.4 |
italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
403 |
|
|
mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
404 |
root |
1.3 |
perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
405 |
|
|
reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
406 |
|
|
scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
407 |
|
|
scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
408 |
|
|
shade term_name title transparent transparent_all tripleclickwords |
409 |
|
|
utmpInhibit visualBell</pre> |
410 |
root |
1.2 |
</dd> |
411 |
|
|
<p></p> |
412 |
root |
1.1 |
<dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
413 |
|
|
</dt> |
414 |
|
|
<dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
415 |
|
|
</dt> |
416 |
|
|
<dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
417 |
|
|
</dt> |
418 |
|
|
<dd> |
419 |
|
|
Return the current values of the selection mark, begin or end positions, |
420 |
|
|
and optionally set them to new values. |
421 |
|
|
</dd> |
422 |
|
|
<p></p> |
423 |
|
|
<dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
424 |
|
|
</dt> |
425 |
|
|
<dd> |
426 |
|
|
Try to request the primary selection from the server (for example, as set |
427 |
|
|
by the next method). |
428 |
|
|
</dd> |
429 |
|
|
<p></p> |
430 |
root |
1.6 |
<dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
431 |
root |
1.1 |
</dt> |
432 |
|
|
<dd> |
433 |
|
|
Return the current selection text and optionally replace it by <code>$newtext</code>. |
434 |
|
|
</dd> |
435 |
|
|
<dd> |
436 |
root |
1.8 |
<p>#=item $term->overlay ($x, $y, $text) |
437 |
|
|
# |
438 |
|
|
#Create a simple multi-line overlay box. See the next method for details. |
439 |
|
|
# |
440 |
|
|
#=cut</p> |
441 |
|
|
</dd> |
442 |
|
|
<dd> |
443 |
|
|
<p>sub urxvt::term::scr_overlay { |
444 |
|
|
die; |
445 |
|
|
my ($self, $x, $y, $text) = @_;</p> |
446 |
|
|
</dd> |
447 |
|
|
<dd> |
448 |
|
|
<pre> |
449 |
|
|
my @lines = split /\n/, $text;</pre> |
450 |
|
|
</dd> |
451 |
|
|
<dd> |
452 |
|
|
<pre> |
453 |
|
|
my $w = 0; |
454 |
|
|
for (map $self->strwidth ($_), @lines) { |
455 |
|
|
$w = $_ if $w < $_; |
456 |
|
|
}</pre> |
457 |
|
|
</dd> |
458 |
|
|
<dd> |
459 |
|
|
<pre> |
460 |
|
|
$self->scr_overlay_new ($x, $y, $w, scalar @lines); |
461 |
|
|
$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
462 |
|
|
}</pre> |
463 |
root |
1.1 |
</dd> |
464 |
|
|
<p></p> |
465 |
root |
1.8 |
<dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
466 |
root |
1.1 |
</dt> |
467 |
|
|
<dd> |
468 |
|
|
Create a new (empty) overlay at the given position with the given |
469 |
root |
1.8 |
width/height. <code>$rstyle</code> defines the initial rendition style |
470 |
|
|
(default: <code>OVERLAY_RSTYLE</code>). |
471 |
|
|
</dd> |
472 |
|
|
<dd> |
473 |
|
|
<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
474 |
|
|
around the box.</p> |
475 |
|
|
</dd> |
476 |
|
|
<dd> |
477 |
|
|
<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
478 |
|
|
right/bottom side, respectively.</p> |
479 |
root |
1.1 |
</dd> |
480 |
|
|
<dd> |
481 |
root |
1.8 |
<p>This method returns an urxvt::overlay object. The overlay will be visible |
482 |
|
|
as long as the perl object is referenced.</p> |
483 |
root |
1.1 |
</dd> |
484 |
|
|
<dd> |
485 |
root |
1.9 |
<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
486 |
root |
1.1 |
</dd> |
487 |
root |
1.9 |
<dl> |
488 |
root |
1.8 |
<dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
489 |
root |
1.1 |
</dt> |
490 |
|
|
<dd> |
491 |
root |
1.8 |
Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts |
492 |
|
|
text in rxvt-unicode's special encoding and an array of rendition values |
493 |
|
|
at a specific position inside the overlay. |
494 |
root |
1.1 |
</dd> |
495 |
root |
1.3 |
<p></p> |
496 |
root |
1.9 |
<dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
497 |
|
|
</dt> |
498 |
|
|
<dd> |
499 |
|
|
If visible, hide the overlay, but do not destroy it. |
500 |
|
|
</dd> |
501 |
|
|
<p></p> |
502 |
|
|
<dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
503 |
|
|
</dt> |
504 |
|
|
<dd> |
505 |
|
|
If hidden, display the overlay again. |
506 |
|
|
</dd> |
507 |
|
|
<p></p></dl> |
508 |
root |
1.3 |
<dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth $string</a></strong><br /> |
509 |
|
|
</dt> |
510 |
|
|
<dd> |
511 |
|
|
Returns the number of screen-cells this string would need. Correctly |
512 |
|
|
accounts for wide and combining characters. |
513 |
|
|
</dd> |
514 |
|
|
<p></p> |
515 |
|
|
<dt><strong><a name="item_locale_encode">$octets = $term->locale_encode $string</a></strong><br /> |
516 |
|
|
</dt> |
517 |
|
|
<dd> |
518 |
|
|
Convert the given text string into the corresponding locale encoding. |
519 |
|
|
</dd> |
520 |
|
|
<p></p> |
521 |
|
|
<dt><strong><a name="item_locale_decode">$string = $term->locale_decode $octets</a></strong><br /> |
522 |
|
|
</dt> |
523 |
|
|
<dd> |
524 |
|
|
Convert the given locale-encoded octets into a perl string. |
525 |
|
|
</dd> |
526 |
|
|
<p></p> |
527 |
|
|
<dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
528 |
|
|
</dt> |
529 |
|
|
<dd> |
530 |
|
|
Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
531 |
root |
1.6 |
pass characters instead of octets, you should convert your strings first |
532 |
|
|
to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
533 |
|
|
</dd> |
534 |
|
|
<p></p> |
535 |
|
|
<dt><strong><a name="item_nrow">$nrow = $term->nrow</a></strong><br /> |
536 |
|
|
</dt> |
537 |
|
|
<dt><strong><a name="item_ncol">$ncol = $term->ncol</a></strong><br /> |
538 |
|
|
</dt> |
539 |
|
|
<dd> |
540 |
|
|
Return the number of rows/columns of the terminal window (i.e. as |
541 |
|
|
specified by <code>-geometry</code>, excluding any scrollback). |
542 |
|
|
</dd> |
543 |
|
|
<p></p> |
544 |
|
|
<dt><strong><a name="item_nsaved">$nsaved = $term->nsaved</a></strong><br /> |
545 |
|
|
</dt> |
546 |
|
|
<dd> |
547 |
|
|
Returns the number of lines in the scrollback buffer. |
548 |
|
|
</dd> |
549 |
|
|
<p></p> |
550 |
|
|
<dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
551 |
|
|
</dt> |
552 |
|
|
<dd> |
553 |
|
|
Returns the negative row number of the topmost line. Minimum value is |
554 |
|
|
<code>0</code>, which displays the normal terminal contents. Larger values scroll |
555 |
|
|
this many lines into the scrollback buffer. |
556 |
|
|
</dd> |
557 |
|
|
<p></p> |
558 |
|
|
<dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
559 |
|
|
</dt> |
560 |
|
|
<dd> |
561 |
|
|
Requests a screen refresh. At the next opportunity, rxvt-unicode will |
562 |
|
|
compare the on-screen display with its stored representation. If they |
563 |
|
|
differ, it redraws the differences. |
564 |
|
|
</dd> |
565 |
|
|
<dd> |
566 |
|
|
<p>Used after changing terminal contents to display them.</p> |
567 |
|
|
</dd> |
568 |
|
|
<p></p> |
569 |
|
|
<dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
570 |
|
|
</dt> |
571 |
|
|
<dd> |
572 |
|
|
Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
573 |
|
|
is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
574 |
|
|
terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
575 |
root |
1.9 |
line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
576 |
|
|
is requested. |
577 |
root |
1.6 |
</dd> |
578 |
|
|
<dd> |
579 |
|
|
<p>If <code>$new_text</code> is specified, it will replace characters in the current |
580 |
|
|
line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
581 |
root |
1.8 |
to replace only parts of a line. The font index in the rendition will |
582 |
root |
1.6 |
automatically be updated.</p> |
583 |
|
|
</dd> |
584 |
|
|
<dd> |
585 |
|
|
<p><code>$text</code> is in a special encoding: tabs and wide characters that use more |
586 |
|
|
than one cell when displayed are padded with urxvt::NOCHAR characters |
587 |
|
|
(<code>chr 65535</code>). Characters with combining characters and other characters |
588 |
|
|
that do not fit into the normal tetx encoding will be replaced with |
589 |
|
|
characters in the private use area.</p> |
590 |
|
|
</dd> |
591 |
|
|
<dd> |
592 |
|
|
<p>You have to obey this encoding when changing text. The advantage is |
593 |
|
|
that <code>substr</code> and similar functions work on screen cells and not on |
594 |
|
|
characters.</p> |
595 |
|
|
</dd> |
596 |
|
|
<dd> |
597 |
root |
1.9 |
<p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
598 |
root |
1.6 |
can be used to convert normal strings into this encoding and vice versa.</p> |
599 |
|
|
</dd> |
600 |
|
|
<p></p> |
601 |
|
|
<dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
602 |
|
|
</dt> |
603 |
|
|
<dd> |
604 |
|
|
Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
605 |
|
|
bitsets. Rendition bitsets contain information about colour, font, font |
606 |
|
|
styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
607 |
|
|
</dd> |
608 |
|
|
<dd> |
609 |
|
|
<p>When setting rendition, the font mask will be ignored.</p> |
610 |
|
|
</dd> |
611 |
|
|
<dd> |
612 |
root |
1.8 |
<p>See the section on RENDITION, above.</p> |
613 |
root |
1.6 |
</dd> |
614 |
|
|
<p></p> |
615 |
|
|
<dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
616 |
|
|
</dt> |
617 |
|
|
<dd> |
618 |
root |
1.9 |
Returns the number of screen cells that are in use (``the line |
619 |
|
|
length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
620 |
|
|
line is joined with the following one. |
621 |
|
|
</dd> |
622 |
|
|
<p></p> |
623 |
|
|
<dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
624 |
|
|
</dt> |
625 |
|
|
<dd> |
626 |
|
|
Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
627 |
|
|
joined with the following row), which means all characters are in use |
628 |
|
|
and it is continued on the next row (and possibly a continuation of the |
629 |
|
|
previous row(s)). |
630 |
root |
1.6 |
</dd> |
631 |
|
|
<p></p> |
632 |
root |
1.9 |
<dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
633 |
|
|
</dt> |
634 |
|
|
<dd> |
635 |
|
|
Create and return a new <code>urxvt::line</code> object that stores information |
636 |
|
|
about the logical line that row <code>$row_number</code> is part of. It supports the |
637 |
|
|
following methods: |
638 |
|
|
</dd> |
639 |
|
|
<dl> |
640 |
|
|
<dt><strong><a name="item_t">$text = $line->t</a></strong><br /> |
641 |
|
|
</dt> |
642 |
|
|
<dd> |
643 |
|
|
Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
644 |
|
|
</dd> |
645 |
|
|
<p></p> |
646 |
|
|
<dt><strong><a name="item_r">$rend = $line->r</a></strong><br /> |
647 |
|
|
</dt> |
648 |
|
|
<dd> |
649 |
|
|
Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
650 |
|
|
</dd> |
651 |
|
|
<p></p> |
652 |
|
|
<dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
653 |
|
|
</dt> |
654 |
|
|
<dd> |
655 |
|
|
Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
656 |
|
|
</dd> |
657 |
|
|
<p></p> |
658 |
|
|
<dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
659 |
|
|
</dt> |
660 |
|
|
<dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
661 |
|
|
</dt> |
662 |
|
|
<dd> |
663 |
|
|
Return the row number of the first/last row of the line, respectively. |
664 |
|
|
</dd> |
665 |
|
|
<p></p> |
666 |
|
|
<dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
667 |
|
|
</dt> |
668 |
|
|
<dd> |
669 |
|
|
Returns the character offset of the given row|col pair within the logical |
670 |
|
|
line. |
671 |
|
|
</dd> |
672 |
|
|
<p></p> |
673 |
|
|
<dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
674 |
|
|
</dt> |
675 |
|
|
<dd> |
676 |
|
|
Translates a string offset into terminal coordinates again. |
677 |
|
|
</dd> |
678 |
|
|
<p></p></dl> |
679 |
|
|
<dt><strong>($row, $col) = $line->coord_of ($offset) |
680 |
|
|
=item $text = $term->special_encode $string</strong><br /> |
681 |
root |
1.6 |
</dt> |
682 |
|
|
<dd> |
683 |
|
|
Converts a perl string into the special encoding used by rxvt-unicode, |
684 |
|
|
where one character corresponds to one screen cell. See |
685 |
|
|
<a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
686 |
|
|
</dd> |
687 |
|
|
<p></p> |
688 |
|
|
<dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
689 |
|
|
</dt> |
690 |
|
|
<dd> |
691 |
|
|
Converts rxvt-unicodes text reprsentation into a perl string. See |
692 |
|
|
<a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
693 |
|
|
</dd> |
694 |
|
|
<p></p></dl> |
695 |
|
|
<p> |
696 |
|
|
</p> |
697 |
root |
1.1 |
<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
698 |
|
|
<p>This class implements timer watchers/events. Time is represented as a |
699 |
|
|
fractional number of seconds since the epoch. Example:</p> |
700 |
|
|
<pre> |
701 |
root |
1.8 |
$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
702 |
root |
1.1 |
$term->{timer} = urxvt::timer |
703 |
|
|
->new |
704 |
root |
1.8 |
->interval (1) |
705 |
root |
1.1 |
->cb (sub { |
706 |
root |
1.8 |
$term->{overlay}->set (0, 0, |
707 |
|
|
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
708 |
root |
1.1 |
});</pre> |
709 |
|
|
<dl> |
710 |
|
|
<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
711 |
|
|
</dt> |
712 |
|
|
<dd> |
713 |
root |
1.8 |
Create a new timer object in started state. It is scheduled to fire |
714 |
|
|
immediately. |
715 |
root |
1.1 |
</dd> |
716 |
|
|
<p></p> |
717 |
|
|
<dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
718 |
|
|
</dt> |
719 |
|
|
<dd> |
720 |
|
|
Set the callback to be called when the timer triggers. |
721 |
|
|
</dd> |
722 |
|
|
<p></p> |
723 |
|
|
<dt><strong><a name="item_at">$tstamp = $timer->at</a></strong><br /> |
724 |
|
|
</dt> |
725 |
|
|
<dd> |
726 |
|
|
Return the time this watcher will fire next. |
727 |
|
|
</dd> |
728 |
|
|
<p></p> |
729 |
root |
1.8 |
<dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
730 |
root |
1.1 |
</dt> |
731 |
|
|
<dd> |
732 |
|
|
Set the time the event is generated to $tstamp. |
733 |
|
|
</dd> |
734 |
|
|
<p></p> |
735 |
root |
1.8 |
<dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
736 |
|
|
</dt> |
737 |
|
|
<dd> |
738 |
|
|
Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
739 |
|
|
stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
740 |
|
|
is automatically rescheduled at the given intervals. |
741 |
|
|
</dd> |
742 |
|
|
<p></p> |
743 |
root |
1.1 |
<dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
744 |
|
|
</dt> |
745 |
|
|
<dd> |
746 |
|
|
Start the timer. |
747 |
|
|
</dd> |
748 |
|
|
<p></p> |
749 |
|
|
<dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
750 |
|
|
</dt> |
751 |
|
|
<dd> |
752 |
|
|
Set the event trigger time to <code>$tstamp</code> and start the timer. |
753 |
|
|
</dd> |
754 |
|
|
<p></p> |
755 |
|
|
<dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
756 |
|
|
</dt> |
757 |
|
|
<dd> |
758 |
|
|
Stop the timer. |
759 |
|
|
</dd> |
760 |
|
|
<p></p></dl> |
761 |
|
|
<p> |
762 |
|
|
</p> |
763 |
|
|
<h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> |
764 |
|
|
<p>This class implements io watchers/events. Example:</p> |
765 |
|
|
<pre> |
766 |
|
|
$term->{socket} = ... |
767 |
|
|
$term->{iow} = urxvt::iow |
768 |
|
|
->new |
769 |
|
|
->fd (fileno $term->{socket}) |
770 |
|
|
->events (1) # wait for read data |
771 |
|
|
->start |
772 |
|
|
->cb (sub { |
773 |
|
|
my ($iow, $revents) = @_; |
774 |
|
|
# $revents must be 1 here, no need to check |
775 |
|
|
sysread $term->{socket}, my $buf, 8192 |
776 |
|
|
or end-of-file; |
777 |
|
|
});</pre> |
778 |
|
|
<dl> |
779 |
|
|
<dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br /> |
780 |
|
|
</dt> |
781 |
|
|
<dd> |
782 |
|
|
Create a new io watcher object in stopped state. |
783 |
|
|
</dd> |
784 |
|
|
<p></p> |
785 |
|
|
<dt><strong>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> |
786 |
|
|
</dt> |
787 |
|
|
<dd> |
788 |
|
|
Set the callback to be called when io events are triggered. <code>$reventmask</code> |
789 |
|
|
is a bitset as described in the <a href="#item_events"><code>events</code></a> method. |
790 |
|
|
</dd> |
791 |
|
|
<p></p> |
792 |
|
|
<dt><strong><a name="item_fd">$iow = $iow->fd ($fd)</a></strong><br /> |
793 |
|
|
</dt> |
794 |
|
|
<dd> |
795 |
|
|
Set the filedescriptor (not handle) to watch. |
796 |
|
|
</dd> |
797 |
|
|
<p></p> |
798 |
|
|
<dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
799 |
|
|
</dt> |
800 |
|
|
<dd> |
801 |
|
|
Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
802 |
|
|
data, Bit #1 (value <code>2</code>) enables watching for write data. |
803 |
|
|
</dd> |
804 |
|
|
<p></p> |
805 |
|
|
<dt><strong>$iow = $iow->start</strong><br /> |
806 |
|
|
</dt> |
807 |
|
|
<dd> |
808 |
|
|
Start watching for requested events on the given handle. |
809 |
|
|
</dd> |
810 |
|
|
<p></p> |
811 |
|
|
<dt><strong>$iow = $iow->stop</strong><br /> |
812 |
|
|
</dt> |
813 |
|
|
<dd> |
814 |
|
|
Stop watching for events on the given filehandle. |
815 |
|
|
</dd> |
816 |
|
|
<p></p></dl> |
817 |
|
|
<p> |
818 |
|
|
</p> |
819 |
|
|
<hr /> |
820 |
root |
1.2 |
<h1><a name="environment">ENVIRONMENT</a></h1> |
821 |
|
|
<p> |
822 |
|
|
</p> |
823 |
|
|
<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
824 |
|
|
<p>This variable controls the verbosity level of the perl extension. Higher |
825 |
|
|
numbers indicate more verbose output.</p> |
826 |
|
|
<ol> |
827 |
|
|
<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> |
828 |
|
|
</li> |
829 |
|
|
<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> |
830 |
|
|
</li> |
831 |
|
|
<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> |
832 |
|
|
</li> |
833 |
|
|
</ol> |
834 |
|
|
<p> |
835 |
|
|
</p> |
836 |
|
|
<hr /> |
837 |
root |
1.1 |
<h1><a name="author">AUTHOR</a></h1> |
838 |
|
|
<pre> |
839 |
|
|
Marc Lehmann <pcg@goof.com> |
840 |
|
|
<a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre> |
841 |
|
|
|
842 |
|
|
</body> |
843 |
|
|
|
844 |
|
|
</html> |