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.10 |
Intelligent selection. This extension tries to be more intelligent when |
85 |
|
|
the user extends selections (double-click). Right now, it tries to select |
86 |
|
|
urls and complete shell-quoted arguments, which is very convenient, too, |
87 |
|
|
if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
88 |
root |
1.9 |
</dd> |
89 |
|
|
<dd> |
90 |
|
|
<p>It also offers the following bindable event:</p> |
91 |
root |
1.6 |
</dd> |
92 |
|
|
<dl> |
93 |
|
|
<dt><strong><a name="item_rot13">rot13</a></strong><br /> |
94 |
|
|
</dt> |
95 |
|
|
<dd> |
96 |
|
|
Rot-13 the selection when activated. Used via keyboard trigger: |
97 |
|
|
</dd> |
98 |
|
|
<dd> |
99 |
|
|
<pre> |
100 |
|
|
URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
101 |
|
|
</dd> |
102 |
|
|
<p></p></dl> |
103 |
|
|
<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
104 |
|
|
</dt> |
105 |
|
|
<dd> |
106 |
root |
1.8 |
Displays a digital clock using the built-in overlay. |
107 |
root |
1.6 |
</dd> |
108 |
|
|
<p></p> |
109 |
root |
1.14 |
<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
110 |
|
|
</dt> |
111 |
|
|
<dd> |
112 |
|
|
Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
113 |
|
|
</dd> |
114 |
|
|
<p></p> |
115 |
|
|
<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
116 |
|
|
</dt> |
117 |
|
|
<dd> |
118 |
|
|
A not very useful example of filtering all text output to the terminal, |
119 |
|
|
by replacing all line-drawing characters (U+2500 .. U+259F) by a |
120 |
|
|
similar-looking ascii character. |
121 |
|
|
</dd> |
122 |
|
|
<p></p> |
123 |
root |
1.8 |
<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
124 |
root |
1.6 |
</dt> |
125 |
|
|
<dd> |
126 |
root |
1.8 |
Displays a very simple digital clock in the upper right corner of the |
127 |
|
|
window. Illustrates overwriting the refresh callbacks to create your own |
128 |
|
|
overlays or changes. |
129 |
root |
1.6 |
</dd> |
130 |
|
|
<p></p></dl> |
131 |
|
|
<p> |
132 |
|
|
</p> |
133 |
root |
1.3 |
<h2><a name="general_api_considerations">General API Considerations</a></h2> |
134 |
|
|
<p>All objects (such as terminals, time watchers etc.) are typical |
135 |
|
|
reference-to-hash objects. The hash can be used to store anything you |
136 |
|
|
like. All members starting with an underscore (such as <code>_ptr</code> or |
137 |
root |
1.9 |
<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
138 |
root |
1.3 |
modified).</p> |
139 |
|
|
<p>When objects are destroyed on the C++ side, the perl object hashes are |
140 |
|
|
emptied, so its best to store related objects such as time watchers and |
141 |
|
|
the like inside the terminal object so they get destroyed as soon as the |
142 |
|
|
terminal is destroyed.</p> |
143 |
root |
1.14 |
<p>Argument names also often indicate the type of a parameter. Here are some |
144 |
|
|
hints on what they mean:</p> |
145 |
|
|
<dl> |
146 |
|
|
<dt><strong><a name="item__24text">$text</a></strong><br /> |
147 |
|
|
</dt> |
148 |
|
|
<dd> |
149 |
|
|
Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
150 |
|
|
always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
151 |
|
|
</dd> |
152 |
|
|
<p></p> |
153 |
|
|
<dt><strong><a name="item__24string">$string</a></strong><br /> |
154 |
|
|
</dt> |
155 |
|
|
<dd> |
156 |
|
|
A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
157 |
|
|
characters and is to be distinguished with text encoded in a specific |
158 |
|
|
encoding (often locale-specific) and binary data. |
159 |
|
|
</dd> |
160 |
|
|
<p></p> |
161 |
|
|
<dt><strong><a name="item__24octets">$octets</a></strong><br /> |
162 |
|
|
</dt> |
163 |
|
|
<dd> |
164 |
|
|
Either binary data or - more common - a text string encoded in a |
165 |
|
|
locale-specific way. |
166 |
|
|
</dd> |
167 |
|
|
<p></p></dl> |
168 |
root |
1.1 |
<p> |
169 |
|
|
</p> |
170 |
|
|
<h2><a name="hooks">Hooks</a></h2> |
171 |
root |
1.14 |
<p>The following subroutines can be declared in extension files, and will be |
172 |
root |
1.9 |
called whenever the relevant event happens.</p> |
173 |
|
|
<p>The first argument passed to them is an object private to each terminal |
174 |
|
|
and extension package. You can call all <code>urxvt::term</code> methods on it, but |
175 |
|
|
its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
176 |
|
|
object that is shared between all packages is stored in the <code>term</code> |
177 |
|
|
member.</p> |
178 |
root |
1.1 |
<p>All of them must return a boolean value. If it is true, then the event |
179 |
|
|
counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
180 |
|
|
and the relevant action might not be carried out by the C++ code.</p> |
181 |
|
|
<p>When in doubt, return a false value (preferably <code>()</code>).</p> |
182 |
|
|
<dl> |
183 |
|
|
<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
184 |
|
|
</dt> |
185 |
|
|
<dd> |
186 |
|
|
Called after a new terminal object has been initialized, but before |
187 |
root |
1.14 |
windows are created or the command gets run. Most methods are unsafe to |
188 |
|
|
call or deliver senseless data, as terminal size and other characteristics |
189 |
|
|
have not yet been determined. You can safely query and change resources, |
190 |
|
|
though. |
191 |
root |
1.1 |
</dd> |
192 |
|
|
<p></p> |
193 |
|
|
<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
194 |
|
|
</dt> |
195 |
|
|
<dd> |
196 |
|
|
Called after the screen is ``reset'' for any reason, such as resizing or |
197 |
|
|
control sequences. Here is where you can react on changes to size-related |
198 |
|
|
variables. |
199 |
|
|
</dd> |
200 |
|
|
<p></p> |
201 |
|
|
<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
202 |
|
|
</dt> |
203 |
|
|
<dd> |
204 |
|
|
Called at the very end of initialisation of a new terminal, just before |
205 |
|
|
returning to the mainloop. |
206 |
|
|
</dd> |
207 |
|
|
<p></p> |
208 |
|
|
<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
209 |
|
|
</dt> |
210 |
|
|
<dd> |
211 |
|
|
Called whenever a selection has been made by the user, but before the |
212 |
|
|
selection text is copied, so changes to the beginning, end or type of the |
213 |
|
|
selection will be honored. |
214 |
|
|
</dd> |
215 |
|
|
<dd> |
216 |
|
|
<p>Returning a true value aborts selection making by urxvt, in which case you |
217 |
|
|
have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term->selection_grab</code></a>.</p> |
218 |
|
|
</dd> |
219 |
|
|
<p></p> |
220 |
|
|
<dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br /> |
221 |
|
|
</dt> |
222 |
|
|
<dd> |
223 |
|
|
Called whenever a selection has been copied, but before the selection is |
224 |
|
|
requested from the server. The selection text can be queried and changed |
225 |
|
|
by calling <a href="#item_selection"><code>$term->selection</code></a>. |
226 |
|
|
</dd> |
227 |
|
|
<dd> |
228 |
|
|
<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
229 |
|
|
</dd> |
230 |
|
|
<p></p> |
231 |
root |
1.9 |
<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
232 |
|
|
</dt> |
233 |
|
|
<dd> |
234 |
|
|
Called whenever the user tries to extend the selection (e.g. with a double |
235 |
|
|
click) and is either supposed to return false (normal operation), or |
236 |
|
|
should extend the selection itelf and return true to suppress the built-in |
237 |
|
|
processing. |
238 |
|
|
</dd> |
239 |
|
|
<dd> |
240 |
|
|
<p>See the <em>selection</em> example extension.</p> |
241 |
|
|
</dd> |
242 |
|
|
<p></p> |
243 |
root |
1.1 |
<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
244 |
|
|
</dt> |
245 |
|
|
<dd> |
246 |
|
|
Called whenever the window gets the keyboard focus, before urxvt does |
247 |
|
|
focus in processing. |
248 |
|
|
</dd> |
249 |
|
|
<p></p> |
250 |
|
|
<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
251 |
|
|
</dt> |
252 |
|
|
<dd> |
253 |
|
|
Called wheneever the window loses keyboard focus, before urxvt does focus |
254 |
|
|
out processing. |
255 |
|
|
</dd> |
256 |
|
|
<p></p> |
257 |
|
|
<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
258 |
|
|
</dt> |
259 |
|
|
<dd> |
260 |
|
|
Called whenever the view offset changes, i..e the user or program |
261 |
|
|
scrolls. Offset <code>0</code> means display the normal terminal, positive values |
262 |
|
|
show this many lines of scrollback. |
263 |
|
|
</dd> |
264 |
|
|
<p></p> |
265 |
|
|
<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br /> |
266 |
|
|
</dt> |
267 |
|
|
<dd> |
268 |
|
|
Called whenever lines scroll out of the terminal area into the scrollback |
269 |
|
|
buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
270 |
|
|
than the scroll back buffer or the terminal. |
271 |
|
|
</dd> |
272 |
|
|
<dd> |
273 |
|
|
<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
274 |
|
|
$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
275 |
|
|
number of lines that will be in the scrollback buffer.</p> |
276 |
|
|
</dd> |
277 |
|
|
<p></p> |
278 |
|
|
<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
279 |
|
|
</dt> |
280 |
|
|
<dd> |
281 |
|
|
Called whenever the <code>program(s)</code> running in the urxvt window send output. |
282 |
|
|
</dd> |
283 |
|
|
<p></p> |
284 |
root |
1.11 |
<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
285 |
|
|
</dt> |
286 |
|
|
<dd> |
287 |
|
|
Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
288 |
|
|
operating system command) is processed. Cursor position and other state |
289 |
|
|
information is up-to-date when this happens. For interoperability, the |
290 |
|
|
string should start with the extension name and a colon, to distinguish |
291 |
|
|
it from commands for other extensions, and this might be enforced in the |
292 |
|
|
future. |
293 |
|
|
</dd> |
294 |
|
|
<dd> |
295 |
|
|
<p>Be careful not ever to trust (in a security sense) the data you receive, |
296 |
|
|
as its source can not easily be controleld (e-mail content, messages from |
297 |
|
|
other users on the same system etc.).</p> |
298 |
|
|
</dd> |
299 |
|
|
<p></p> |
300 |
root |
1.14 |
<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
301 |
|
|
</dt> |
302 |
|
|
<dd> |
303 |
|
|
Called whenever text is about to be output, with the text as argument. You |
304 |
|
|
can filter/change and output the text yourself by returning a true value |
305 |
|
|
and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
306 |
|
|
might be very slow, however, as your hook is called for <strong>all</strong> text being |
307 |
|
|
output. |
308 |
|
|
</dd> |
309 |
|
|
<p></p> |
310 |
|
|
<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
311 |
|
|
</dt> |
312 |
|
|
<dd> |
313 |
|
|
Called whenever a line was updated or changed. Can be used to filter |
314 |
|
|
screen output (e.g. underline urls or other useless stuff). Only lines |
315 |
|
|
that are being shown will be filtered, and, due to performance reasons, |
316 |
|
|
not always immediately. |
317 |
|
|
</dd> |
318 |
|
|
<dd> |
319 |
|
|
<p>The row number is always the topmost row of the line if the line spans |
320 |
|
|
multiple rows.</p> |
321 |
|
|
</dd> |
322 |
|
|
<dd> |
323 |
|
|
<p>Please note that, if you change the line, then the hook might get called |
324 |
|
|
later with the already-modified line (e.g. if unrelated parts change), so |
325 |
|
|
you cannot just toggle rendition bits, but only set them.</p> |
326 |
|
|
</dd> |
327 |
|
|
<p></p> |
328 |
root |
1.1 |
<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
329 |
|
|
</dt> |
330 |
|
|
<dd> |
331 |
|
|
Called just before the screen gets redrawn. Can be used for overlay |
332 |
|
|
or similar effects by modify terminal contents in refresh_begin, and |
333 |
|
|
restoring them in refresh_end. The built-in overlay and selection display |
334 |
|
|
code is run after this hook, and takes precedence. |
335 |
|
|
</dd> |
336 |
|
|
<p></p> |
337 |
|
|
<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> |
338 |
|
|
</dt> |
339 |
|
|
<dd> |
340 |
|
|
Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
341 |
|
|
</dd> |
342 |
root |
1.5 |
<p></p> |
343 |
|
|
<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
344 |
|
|
</dt> |
345 |
|
|
<dd> |
346 |
|
|
Called whenever the user presses a key combination that has a |
347 |
|
|
<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
348 |
|
|
resource in the <code>rxvt(1)</code> manpage). |
349 |
|
|
</dd> |
350 |
root |
1.14 |
<p></p> |
351 |
|
|
<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
352 |
|
|
</dt> |
353 |
|
|
<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
354 |
|
|
</dt> |
355 |
|
|
<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
356 |
|
|
</dt> |
357 |
|
|
<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
358 |
|
|
</dt> |
359 |
|
|
<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
360 |
|
|
</dt> |
361 |
|
|
<dd> |
362 |
|
|
Called whenever the corresponding X event is received for the terminal If |
363 |
|
|
the hook returns true, then the even will be ignored by rxvt-unicode. |
364 |
|
|
</dd> |
365 |
|
|
<dd> |
366 |
|
|
<p>The event is a hash with most values as named by Xlib (see the XEvent |
367 |
|
|
manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
368 |
|
|
and column under the mouse cursor.</p> |
369 |
|
|
</dd> |
370 |
|
|
<dd> |
371 |
|
|
<p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
372 |
|
|
output, if any, in locale-specific encoding.</p> |
373 |
|
|
</dd> |
374 |
|
|
<dd> |
375 |
|
|
<p>subwindow.</p> |
376 |
|
|
</dd> |
377 |
root |
1.1 |
<p></p></dl> |
378 |
|
|
<p> |
379 |
|
|
</p> |
380 |
root |
1.9 |
<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
381 |
|
|
<dl> |
382 |
|
|
<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
383 |
|
|
</dt> |
384 |
|
|
<dd> |
385 |
root |
1.14 |
The current terminal. This variable stores the current <code>urxvt::term</code> |
386 |
|
|
object, whenever a callback/hook is executing. |
387 |
root |
1.9 |
</dd> |
388 |
|
|
<p></p></dl> |
389 |
|
|
<p> |
390 |
|
|
</p> |
391 |
root |
1.1 |
<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
392 |
|
|
<dl> |
393 |
root |
1.14 |
<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
394 |
|
|
</dt> |
395 |
|
|
<dd> |
396 |
|
|
Creates a new terminal, very similar as if you had started it with |
397 |
|
|
<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
398 |
|
|
if the new instance couldn't be created. Returns <code>undef</code> if the new |
399 |
|
|
instance didn't initialise perl, and the terminal object otherwise. The |
400 |
|
|
<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
401 |
|
|
</dd> |
402 |
|
|
<p></p> |
403 |
root |
1.1 |
<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
404 |
|
|
</dt> |
405 |
|
|
<dd> |
406 |
|
|
Fatally aborts execution with the given error message. Avoid at all |
407 |
|
|
costs! The only time this is acceptable is when the terminal process |
408 |
|
|
starts up. |
409 |
|
|
</dd> |
410 |
|
|
<p></p> |
411 |
|
|
<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> |
412 |
|
|
</dt> |
413 |
|
|
<dd> |
414 |
root |
1.3 |
Calls <code>rxvt_warn</code> with the given string which should not include a |
415 |
root |
1.1 |
newline. The module also overwrites the <code>warn</code> builtin with a function |
416 |
|
|
that calls this function. |
417 |
|
|
</dd> |
418 |
|
|
<dd> |
419 |
|
|
<p>Using this function has the advantage that its output ends up in the |
420 |
|
|
correct place, e.g. on stderr of the connecting urxvtc client.</p> |
421 |
|
|
</dd> |
422 |
|
|
<p></p> |
423 |
|
|
<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
424 |
|
|
</dt> |
425 |
|
|
<dd> |
426 |
|
|
Returns the ``current time'' (as per the event loop). |
427 |
|
|
</dd> |
428 |
|
|
<p></p></dl> |
429 |
|
|
<p> |
430 |
|
|
</p> |
431 |
root |
1.8 |
<h2><a name="rendition">RENDITION</a></h2> |
432 |
|
|
<p>Rendition bitsets contain information about colour, font, font styles and |
433 |
|
|
similar information for each screen cell.</p> |
434 |
|
|
<p>The following ``macros'' deal with changes in rendition sets. You should |
435 |
|
|
never just create a bitset, you should always modify an existing one, |
436 |
|
|
as they contain important information required for correct operation of |
437 |
|
|
rxvt-unicode.</p> |
438 |
|
|
<dl> |
439 |
|
|
<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
440 |
|
|
</dt> |
441 |
|
|
<dd> |
442 |
|
|
Returns the default rendition, as used when the terminal is starting up or |
443 |
|
|
being reset. Useful as a base to start when creating renditions. |
444 |
|
|
</dd> |
445 |
|
|
<p></p> |
446 |
|
|
<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
447 |
|
|
</dt> |
448 |
|
|
<dd> |
449 |
|
|
Return the rendition mask used for overlays by default. |
450 |
|
|
</dd> |
451 |
|
|
<p></p> |
452 |
|
|
<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 /> |
453 |
|
|
</dt> |
454 |
|
|
<dd> |
455 |
|
|
Return the bit that enabled bold, italic, blink, reverse-video and |
456 |
|
|
underline, respectively. To enable such a style, just logically OR it into |
457 |
|
|
the bitset. |
458 |
|
|
</dd> |
459 |
|
|
<p></p> |
460 |
|
|
<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
461 |
|
|
</dt> |
462 |
|
|
<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
463 |
|
|
</dt> |
464 |
|
|
<dd> |
465 |
|
|
Return the foreground/background colour index, respectively. |
466 |
|
|
</dd> |
467 |
|
|
<p></p> |
468 |
|
|
<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
469 |
|
|
</dt> |
470 |
|
|
<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
471 |
|
|
</dt> |
472 |
|
|
<dd> |
473 |
|
|
Replace the foreground/background colour in the rendition mask with the |
474 |
|
|
specified one. |
475 |
|
|
</dd> |
476 |
|
|
<p></p> |
477 |
|
|
<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
478 |
|
|
</dt> |
479 |
|
|
<dd> |
480 |
|
|
Return the ``custom'' value: Every rendition has 5 bits for use by |
481 |
|
|
extensions. They can be set and changed as you like and are initially |
482 |
|
|
zero. |
483 |
|
|
</dd> |
484 |
|
|
<p></p> |
485 |
|
|
<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
486 |
|
|
</dt> |
487 |
|
|
<dd> |
488 |
|
|
Change the custom value. |
489 |
|
|
</dd> |
490 |
|
|
<p></p></dl> |
491 |
|
|
<p> |
492 |
|
|
</p> |
493 |
root |
1.1 |
<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
494 |
|
|
<dl> |
495 |
root |
1.14 |
<dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
496 |
|
|
</dt> |
497 |
|
|
<dd> |
498 |
|
|
Destroy the terminal object (close the window, free resources etc.). |
499 |
|
|
</dd> |
500 |
|
|
<p></p> |
501 |
root |
1.2 |
<dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
502 |
|
|
</dt> |
503 |
|
|
<dd> |
504 |
|
|
Returns the current resource value associated with a given name and |
505 |
|
|
optionally sets a new value. Setting values is most useful in the <code>init</code> |
506 |
|
|
hook. Unset resources are returned and accepted as <code>undef</code>. |
507 |
|
|
</dd> |
508 |
|
|
<dd> |
509 |
|
|
<p>The new value must be properly encoded to a suitable character encoding |
510 |
|
|
before passing it to this method. Similarly, the returned value may need |
511 |
|
|
to be converted from the used encoding to text.</p> |
512 |
|
|
</dd> |
513 |
|
|
<dd> |
514 |
|
|
<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified |
515 |
|
|
as resource names of the form <code>color+<index></code>, e.g. <code>color+5</code>. (will |
516 |
|
|
likely change).</p> |
517 |
|
|
</dd> |
518 |
|
|
<dd> |
519 |
|
|
<p>Please note that resource strings will currently only be freed when the |
520 |
|
|
terminal is destroyed, so changing options frequently will eat memory.</p> |
521 |
|
|
</dd> |
522 |
|
|
<dd> |
523 |
|
|
<p>Here is a a likely non-exhaustive list of resource names, not all of which |
524 |
|
|
are supported in every build, please see the source to see the actual |
525 |
|
|
list:</p> |
526 |
|
|
</dd> |
527 |
|
|
<dd> |
528 |
|
|
<pre> |
529 |
|
|
answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
530 |
|
|
borderLess color cursorBlink cursorUnderline cutchars delete_key |
531 |
|
|
display_name embed ext_bwidth fade font geometry hold iconName |
532 |
|
|
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
533 |
root |
1.4 |
italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
534 |
root |
1.12 |
mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
535 |
root |
1.3 |
perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
536 |
|
|
reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
537 |
|
|
scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
538 |
|
|
scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
539 |
|
|
shade term_name title transparent transparent_all tripleclickwords |
540 |
|
|
utmpInhibit visualBell</pre> |
541 |
root |
1.2 |
</dd> |
542 |
|
|
<p></p> |
543 |
root |
1.14 |
<dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
544 |
root |
1.13 |
</dt> |
545 |
|
|
<dd> |
546 |
root |
1.14 |
Return and optionally change the current rendition. Text that is output by |
547 |
|
|
the terminal application will use this style. |
548 |
root |
1.13 |
</dd> |
549 |
|
|
<p></p> |
550 |
|
|
<dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
551 |
|
|
</dt> |
552 |
|
|
<dd> |
553 |
|
|
Return the current coordinates of the text cursor position and optionally |
554 |
|
|
set it (which is usually bad as applications don't expect that). |
555 |
|
|
</dd> |
556 |
|
|
<p></p> |
557 |
root |
1.1 |
<dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
558 |
|
|
</dt> |
559 |
|
|
<dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
560 |
|
|
</dt> |
561 |
|
|
<dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
562 |
|
|
</dt> |
563 |
|
|
<dd> |
564 |
|
|
Return the current values of the selection mark, begin or end positions, |
565 |
|
|
and optionally set them to new values. |
566 |
|
|
</dd> |
567 |
|
|
<p></p> |
568 |
|
|
<dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
569 |
|
|
</dt> |
570 |
|
|
<dd> |
571 |
|
|
Try to request the primary selection from the server (for example, as set |
572 |
|
|
by the next method). |
573 |
|
|
</dd> |
574 |
|
|
<p></p> |
575 |
root |
1.6 |
<dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
576 |
root |
1.1 |
</dt> |
577 |
|
|
<dd> |
578 |
|
|
Return the current selection text and optionally replace it by <code>$newtext</code>. |
579 |
|
|
</dd> |
580 |
|
|
<dd> |
581 |
root |
1.8 |
<p>#=item $term->overlay ($x, $y, $text) |
582 |
|
|
# |
583 |
|
|
#Create a simple multi-line overlay box. See the next method for details. |
584 |
|
|
# |
585 |
root |
1.14 |
#=cut |
586 |
|
|
# |
587 |
|
|
#sub urxvt::term::scr_overlay { |
588 |
|
|
# my ($self, $x, $y, $text) = @_; |
589 |
|
|
# |
590 |
|
|
# my @lines = split /\n/, $text; |
591 |
|
|
# |
592 |
|
|
# my $w = 0; |
593 |
|
|
# for (map $self->strwidth ($_), @lines) { |
594 |
|
|
# $w = $_ if $w < $_; |
595 |
|
|
# } |
596 |
|
|
# |
597 |
|
|
# $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
598 |
|
|
# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
599 |
|
|
#}</p> |
600 |
root |
1.1 |
</dd> |
601 |
|
|
<p></p> |
602 |
root |
1.8 |
<dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
603 |
root |
1.1 |
</dt> |
604 |
|
|
<dd> |
605 |
|
|
Create a new (empty) overlay at the given position with the given |
606 |
root |
1.8 |
width/height. <code>$rstyle</code> defines the initial rendition style |
607 |
|
|
(default: <code>OVERLAY_RSTYLE</code>). |
608 |
|
|
</dd> |
609 |
|
|
<dd> |
610 |
|
|
<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
611 |
|
|
around the box.</p> |
612 |
|
|
</dd> |
613 |
|
|
<dd> |
614 |
|
|
<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
615 |
|
|
right/bottom side, respectively.</p> |
616 |
root |
1.1 |
</dd> |
617 |
|
|
<dd> |
618 |
root |
1.8 |
<p>This method returns an urxvt::overlay object. The overlay will be visible |
619 |
|
|
as long as the perl object is referenced.</p> |
620 |
root |
1.1 |
</dd> |
621 |
|
|
<dd> |
622 |
root |
1.9 |
<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
623 |
root |
1.1 |
</dd> |
624 |
root |
1.9 |
<dl> |
625 |
root |
1.8 |
<dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
626 |
root |
1.1 |
</dt> |
627 |
|
|
<dd> |
628 |
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 |
629 |
|
|
text in rxvt-unicode's special encoding and an array of rendition values |
630 |
|
|
at a specific position inside the overlay. |
631 |
root |
1.1 |
</dd> |
632 |
root |
1.3 |
<p></p> |
633 |
root |
1.9 |
<dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
634 |
|
|
</dt> |
635 |
|
|
<dd> |
636 |
|
|
If visible, hide the overlay, but do not destroy it. |
637 |
|
|
</dd> |
638 |
|
|
<p></p> |
639 |
|
|
<dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
640 |
|
|
</dt> |
641 |
|
|
<dd> |
642 |
|
|
If hidden, display the overlay again. |
643 |
|
|
</dd> |
644 |
|
|
<p></p></dl> |
645 |
root |
1.14 |
<dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
646 |
root |
1.3 |
</dt> |
647 |
|
|
<dd> |
648 |
|
|
Returns the number of screen-cells this string would need. Correctly |
649 |
|
|
accounts for wide and combining characters. |
650 |
|
|
</dd> |
651 |
|
|
<p></p> |
652 |
root |
1.14 |
<dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
653 |
root |
1.3 |
</dt> |
654 |
|
|
<dd> |
655 |
|
|
Convert the given text string into the corresponding locale encoding. |
656 |
|
|
</dd> |
657 |
|
|
<p></p> |
658 |
root |
1.14 |
<dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
659 |
root |
1.3 |
</dt> |
660 |
|
|
<dd> |
661 |
|
|
Convert the given locale-encoded octets into a perl string. |
662 |
|
|
</dd> |
663 |
|
|
<p></p> |
664 |
root |
1.14 |
<dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
665 |
|
|
</dt> |
666 |
|
|
<dd> |
667 |
|
|
Write the given text string to the screen, as if output by the application |
668 |
|
|
running inside the terminal. It may not contain command sequences (escape |
669 |
|
|
codes), but is free to use line feeds, carriage returns and tabs. The |
670 |
|
|
string is a normal text string, not in locale-dependent encoding. |
671 |
|
|
</dd> |
672 |
|
|
<dd> |
673 |
|
|
<p>Normally its not a good idea to use this function, as programs might be |
674 |
|
|
confused by changes in cursor position or scrolling. Its useful inside a |
675 |
|
|
<code>on_add_lines</code> hook, though.</p> |
676 |
|
|
</dd> |
677 |
|
|
<p></p> |
678 |
|
|
<dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
679 |
|
|
</dt> |
680 |
|
|
<dd> |
681 |
|
|
Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
682 |
|
|
locale-specific encoding of the terminal and can contain command sequences |
683 |
|
|
(escape codes) that will be interpreted. |
684 |
|
|
</dd> |
685 |
|
|
<p></p> |
686 |
root |
1.3 |
<dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
687 |
|
|
</dt> |
688 |
|
|
<dd> |
689 |
|
|
Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
690 |
root |
1.6 |
pass characters instead of octets, you should convert your strings first |
691 |
|
|
to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
692 |
|
|
</dd> |
693 |
|
|
<p></p> |
694 |
root |
1.14 |
<dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
695 |
|
|
</dt> |
696 |
|
|
<dd> |
697 |
|
|
Return the window id of the toplevel window. |
698 |
|
|
</dd> |
699 |
|
|
<p></p> |
700 |
|
|
<dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
701 |
|
|
</dt> |
702 |
|
|
<dd> |
703 |
|
|
Return the window id of the terminal window. |
704 |
|
|
</dd> |
705 |
|
|
<p></p> |
706 |
root |
1.13 |
<dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
707 |
|
|
</dt> |
708 |
|
|
<dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
709 |
|
|
</dt> |
710 |
|
|
<dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
711 |
root |
1.6 |
</dt> |
712 |
root |
1.13 |
<dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
713 |
root |
1.6 |
</dt> |
714 |
root |
1.13 |
<dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
715 |
|
|
</dt> |
716 |
|
|
<dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
717 |
|
|
</dt> |
718 |
|
|
<dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
719 |
|
|
</dt> |
720 |
|
|
<dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
721 |
|
|
</dt> |
722 |
|
|
<dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
723 |
|
|
</dt> |
724 |
|
|
<dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
725 |
|
|
</dt> |
726 |
|
|
<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
727 |
|
|
</dt> |
728 |
|
|
<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
729 |
root |
1.6 |
</dt> |
730 |
|
|
<dd> |
731 |
root |
1.13 |
Return various integers describing terminal characteristics. |
732 |
root |
1.6 |
</dd> |
733 |
|
|
<p></p> |
734 |
|
|
<dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
735 |
|
|
</dt> |
736 |
|
|
<dd> |
737 |
|
|
Returns the negative row number of the topmost line. Minimum value is |
738 |
|
|
<code>0</code>, which displays the normal terminal contents. Larger values scroll |
739 |
|
|
this many lines into the scrollback buffer. |
740 |
|
|
</dd> |
741 |
|
|
<p></p> |
742 |
|
|
<dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
743 |
|
|
</dt> |
744 |
|
|
<dd> |
745 |
|
|
Requests a screen refresh. At the next opportunity, rxvt-unicode will |
746 |
|
|
compare the on-screen display with its stored representation. If they |
747 |
|
|
differ, it redraws the differences. |
748 |
|
|
</dd> |
749 |
|
|
<dd> |
750 |
|
|
<p>Used after changing terminal contents to display them.</p> |
751 |
|
|
</dd> |
752 |
|
|
<p></p> |
753 |
|
|
<dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
754 |
|
|
</dt> |
755 |
|
|
<dd> |
756 |
|
|
Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
757 |
|
|
is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
758 |
|
|
terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
759 |
root |
1.9 |
line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
760 |
|
|
is requested. |
761 |
root |
1.6 |
</dd> |
762 |
|
|
<dd> |
763 |
|
|
<p>If <code>$new_text</code> is specified, it will replace characters in the current |
764 |
|
|
line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
765 |
root |
1.8 |
to replace only parts of a line. The font index in the rendition will |
766 |
root |
1.6 |
automatically be updated.</p> |
767 |
|
|
</dd> |
768 |
|
|
<dd> |
769 |
root |
1.14 |
<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
770 |
root |
1.6 |
than one cell when displayed are padded with urxvt::NOCHAR characters |
771 |
|
|
(<code>chr 65535</code>). Characters with combining characters and other characters |
772 |
|
|
that do not fit into the normal tetx encoding will be replaced with |
773 |
|
|
characters in the private use area.</p> |
774 |
|
|
</dd> |
775 |
|
|
<dd> |
776 |
|
|
<p>You have to obey this encoding when changing text. The advantage is |
777 |
|
|
that <code>substr</code> and similar functions work on screen cells and not on |
778 |
|
|
characters.</p> |
779 |
|
|
</dd> |
780 |
|
|
<dd> |
781 |
root |
1.9 |
<p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
782 |
root |
1.6 |
can be used to convert normal strings into this encoding and vice versa.</p> |
783 |
|
|
</dd> |
784 |
|
|
<p></p> |
785 |
|
|
<dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
786 |
|
|
</dt> |
787 |
|
|
<dd> |
788 |
|
|
Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
789 |
|
|
bitsets. Rendition bitsets contain information about colour, font, font |
790 |
|
|
styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
791 |
|
|
</dd> |
792 |
|
|
<dd> |
793 |
|
|
<p>When setting rendition, the font mask will be ignored.</p> |
794 |
|
|
</dd> |
795 |
|
|
<dd> |
796 |
root |
1.8 |
<p>See the section on RENDITION, above.</p> |
797 |
root |
1.6 |
</dd> |
798 |
|
|
<p></p> |
799 |
|
|
<dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
800 |
|
|
</dt> |
801 |
|
|
<dd> |
802 |
root |
1.9 |
Returns the number of screen cells that are in use (``the line |
803 |
|
|
length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
804 |
|
|
line is joined with the following one. |
805 |
|
|
</dd> |
806 |
|
|
<p></p> |
807 |
|
|
<dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
808 |
|
|
</dt> |
809 |
|
|
<dd> |
810 |
|
|
Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
811 |
|
|
joined with the following row), which means all characters are in use |
812 |
|
|
and it is continued on the next row (and possibly a continuation of the |
813 |
|
|
previous row(s)). |
814 |
root |
1.6 |
</dd> |
815 |
|
|
<p></p> |
816 |
root |
1.9 |
<dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
817 |
|
|
</dt> |
818 |
|
|
<dd> |
819 |
|
|
Create and return a new <code>urxvt::line</code> object that stores information |
820 |
|
|
about the logical line that row <code>$row_number</code> is part of. It supports the |
821 |
|
|
following methods: |
822 |
|
|
</dd> |
823 |
|
|
<dl> |
824 |
root |
1.14 |
<dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
825 |
root |
1.9 |
</dt> |
826 |
|
|
<dd> |
827 |
root |
1.14 |
Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
828 |
root |
1.9 |
</dd> |
829 |
|
|
<p></p> |
830 |
root |
1.14 |
<dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
831 |
root |
1.9 |
</dt> |
832 |
|
|
<dd> |
833 |
root |
1.14 |
Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
834 |
root |
1.9 |
</dd> |
835 |
|
|
<p></p> |
836 |
|
|
<dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
837 |
|
|
</dt> |
838 |
|
|
<dd> |
839 |
|
|
Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
840 |
|
|
</dd> |
841 |
|
|
<p></p> |
842 |
|
|
<dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
843 |
|
|
</dt> |
844 |
|
|
<dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
845 |
|
|
</dt> |
846 |
|
|
<dd> |
847 |
|
|
Return the row number of the first/last row of the line, respectively. |
848 |
|
|
</dd> |
849 |
|
|
<p></p> |
850 |
|
|
<dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
851 |
|
|
</dt> |
852 |
|
|
<dd> |
853 |
|
|
Returns the character offset of the given row|col pair within the logical |
854 |
|
|
line. |
855 |
|
|
</dd> |
856 |
|
|
<p></p> |
857 |
|
|
<dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
858 |
|
|
</dt> |
859 |
|
|
<dd> |
860 |
|
|
Translates a string offset into terminal coordinates again. |
861 |
|
|
</dd> |
862 |
|
|
<p></p></dl> |
863 |
|
|
<dt><strong>($row, $col) = $line->coord_of ($offset) |
864 |
|
|
=item $text = $term->special_encode $string</strong><br /> |
865 |
root |
1.6 |
</dt> |
866 |
|
|
<dd> |
867 |
|
|
Converts a perl string into the special encoding used by rxvt-unicode, |
868 |
|
|
where one character corresponds to one screen cell. See |
869 |
|
|
<a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
870 |
|
|
</dd> |
871 |
|
|
<p></p> |
872 |
|
|
<dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
873 |
|
|
</dt> |
874 |
|
|
<dd> |
875 |
|
|
Converts rxvt-unicodes text reprsentation into a perl string. See |
876 |
|
|
<a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
877 |
|
|
</dd> |
878 |
|
|
<p></p></dl> |
879 |
|
|
<p> |
880 |
|
|
</p> |
881 |
root |
1.1 |
<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
882 |
|
|
<p>This class implements timer watchers/events. Time is represented as a |
883 |
|
|
fractional number of seconds since the epoch. Example:</p> |
884 |
|
|
<pre> |
885 |
root |
1.8 |
$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
886 |
root |
1.1 |
$term->{timer} = urxvt::timer |
887 |
|
|
->new |
888 |
root |
1.8 |
->interval (1) |
889 |
root |
1.1 |
->cb (sub { |
890 |
root |
1.8 |
$term->{overlay}->set (0, 0, |
891 |
|
|
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
892 |
root |
1.1 |
});</pre> |
893 |
|
|
<dl> |
894 |
|
|
<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
895 |
|
|
</dt> |
896 |
|
|
<dd> |
897 |
root |
1.8 |
Create a new timer object in started state. It is scheduled to fire |
898 |
|
|
immediately. |
899 |
root |
1.1 |
</dd> |
900 |
|
|
<p></p> |
901 |
|
|
<dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
902 |
|
|
</dt> |
903 |
|
|
<dd> |
904 |
|
|
Set the callback to be called when the timer triggers. |
905 |
|
|
</dd> |
906 |
|
|
<p></p> |
907 |
|
|
<dt><strong><a name="item_at">$tstamp = $timer->at</a></strong><br /> |
908 |
|
|
</dt> |
909 |
|
|
<dd> |
910 |
|
|
Return the time this watcher will fire next. |
911 |
|
|
</dd> |
912 |
|
|
<p></p> |
913 |
root |
1.8 |
<dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
914 |
root |
1.1 |
</dt> |
915 |
|
|
<dd> |
916 |
|
|
Set the time the event is generated to $tstamp. |
917 |
|
|
</dd> |
918 |
|
|
<p></p> |
919 |
root |
1.8 |
<dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
920 |
|
|
</dt> |
921 |
|
|
<dd> |
922 |
|
|
Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
923 |
|
|
stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
924 |
|
|
is automatically rescheduled at the given intervals. |
925 |
|
|
</dd> |
926 |
|
|
<p></p> |
927 |
root |
1.1 |
<dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
928 |
|
|
</dt> |
929 |
|
|
<dd> |
930 |
|
|
Start the timer. |
931 |
|
|
</dd> |
932 |
|
|
<p></p> |
933 |
|
|
<dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
934 |
|
|
</dt> |
935 |
|
|
<dd> |
936 |
|
|
Set the event trigger time to <code>$tstamp</code> and start the timer. |
937 |
|
|
</dd> |
938 |
|
|
<p></p> |
939 |
|
|
<dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
940 |
|
|
</dt> |
941 |
|
|
<dd> |
942 |
|
|
Stop the timer. |
943 |
|
|
</dd> |
944 |
|
|
<p></p></dl> |
945 |
|
|
<p> |
946 |
|
|
</p> |
947 |
|
|
<h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> |
948 |
|
|
<p>This class implements io watchers/events. Example:</p> |
949 |
|
|
<pre> |
950 |
|
|
$term->{socket} = ... |
951 |
|
|
$term->{iow} = urxvt::iow |
952 |
|
|
->new |
953 |
|
|
->fd (fileno $term->{socket}) |
954 |
|
|
->events (1) # wait for read data |
955 |
|
|
->start |
956 |
|
|
->cb (sub { |
957 |
|
|
my ($iow, $revents) = @_; |
958 |
|
|
# $revents must be 1 here, no need to check |
959 |
|
|
sysread $term->{socket}, my $buf, 8192 |
960 |
|
|
or end-of-file; |
961 |
|
|
});</pre> |
962 |
|
|
<dl> |
963 |
|
|
<dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br /> |
964 |
|
|
</dt> |
965 |
|
|
<dd> |
966 |
|
|
Create a new io watcher object in stopped state. |
967 |
|
|
</dd> |
968 |
|
|
<p></p> |
969 |
|
|
<dt><strong>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> |
970 |
|
|
</dt> |
971 |
|
|
<dd> |
972 |
|
|
Set the callback to be called when io events are triggered. <code>$reventmask</code> |
973 |
|
|
is a bitset as described in the <a href="#item_events"><code>events</code></a> method. |
974 |
|
|
</dd> |
975 |
|
|
<p></p> |
976 |
|
|
<dt><strong><a name="item_fd">$iow = $iow->fd ($fd)</a></strong><br /> |
977 |
|
|
</dt> |
978 |
|
|
<dd> |
979 |
|
|
Set the filedescriptor (not handle) to watch. |
980 |
|
|
</dd> |
981 |
|
|
<p></p> |
982 |
|
|
<dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
983 |
|
|
</dt> |
984 |
|
|
<dd> |
985 |
|
|
Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
986 |
|
|
data, Bit #1 (value <code>2</code>) enables watching for write data. |
987 |
|
|
</dd> |
988 |
|
|
<p></p> |
989 |
|
|
<dt><strong>$iow = $iow->start</strong><br /> |
990 |
|
|
</dt> |
991 |
|
|
<dd> |
992 |
|
|
Start watching for requested events on the given handle. |
993 |
|
|
</dd> |
994 |
|
|
<p></p> |
995 |
|
|
<dt><strong>$iow = $iow->stop</strong><br /> |
996 |
|
|
</dt> |
997 |
|
|
<dd> |
998 |
|
|
Stop watching for events on the given filehandle. |
999 |
|
|
</dd> |
1000 |
|
|
<p></p></dl> |
1001 |
|
|
<p> |
1002 |
|
|
</p> |
1003 |
|
|
<hr /> |
1004 |
root |
1.2 |
<h1><a name="environment">ENVIRONMENT</a></h1> |
1005 |
|
|
<p> |
1006 |
|
|
</p> |
1007 |
|
|
<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1008 |
|
|
<p>This variable controls the verbosity level of the perl extension. Higher |
1009 |
|
|
numbers indicate more verbose output.</p> |
1010 |
root |
1.10 |
<dl> |
1011 |
|
|
<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1012 |
|
|
</dt> |
1013 |
|
|
<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1014 |
|
|
</dt> |
1015 |
|
|
<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1016 |
|
|
</dt> |
1017 |
|
|
</dl> |
1018 |
root |
1.2 |
<p> |
1019 |
|
|
</p> |
1020 |
|
|
<hr /> |
1021 |
root |
1.1 |
<h1><a name="author">AUTHOR</a></h1> |
1022 |
|
|
<pre> |
1023 |
|
|
Marc Lehmann <pcg@goof.com> |
1024 |
|
|
<a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre> |
1025 |
|
|
|
1026 |
|
|
</body> |
1027 |
|
|
|
1028 |
|
|
</html> |