1 |
root |
1.1 |
NAME |
2 |
root |
1.28 |
rxvtperl - rxvt-unicode's embedded perl interpreter |
3 |
root |
1.1 |
|
4 |
|
|
SYNOPSIS |
5 |
root |
1.3 |
# create a file grab_test in $HOME: |
6 |
root |
1.1 |
|
7 |
|
|
sub on_sel_grab { |
8 |
|
|
warn "you selected ", $_[0]->selection; |
9 |
|
|
() |
10 |
|
|
} |
11 |
|
|
|
12 |
root |
1.28 |
# start a rxvt using it: |
13 |
root |
1.3 |
|
14 |
root |
1.28 |
rxvt --perl-lib $HOME -pe grab_test |
15 |
root |
1.1 |
|
16 |
|
|
DESCRIPTION |
17 |
root |
1.13 |
Everytime a terminal object gets created, extension scripts specified |
18 |
|
|
via the "perl" resource are loaded and associated with it. |
19 |
root |
1.3 |
|
20 |
|
|
Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
21 |
|
|
thus must be encoded as UTF-8. |
22 |
root |
1.1 |
|
23 |
root |
1.28 |
Each script will only ever be loaded once, even in rxvtd, where scripts |
24 |
root |
1.5 |
will be shared (but not enabled) for all terminals. |
25 |
root |
1.1 |
|
26 |
root |
1.18 |
PREPACKAGED EXTENSIONS |
27 |
|
|
This section describes the extensions delivered with this release. You |
28 |
root |
1.28 |
can find them in /opt/rxvt/lib/urxvt/perl/. |
29 |
root |
1.4 |
|
30 |
|
|
You can activate them like this: |
31 |
|
|
|
32 |
root |
1.28 |
rxvt -pe <extensionname> |
33 |
root |
1.4 |
|
34 |
root |
1.32 |
Or by adding them to the resource for extensions loaded by default: |
35 |
|
|
|
36 |
|
|
URxvt.perl-ext-common: default,automove-background,selection-autotransform |
37 |
|
|
|
38 |
root |
1.14 |
selection (enabled by default) |
39 |
root |
1.18 |
(More) intelligent selection. This extension tries to be more |
40 |
root |
1.23 |
intelligent when the user extends selections (double-click and |
41 |
|
|
further clicks). Right now, it tries to select words, urls and |
42 |
|
|
complete shell-quoted arguments, which is very convenient, too, if |
43 |
|
|
your ls supports "--quoting-style=shell". |
44 |
|
|
|
45 |
|
|
A double-click usually selects the word under the cursor, further |
46 |
|
|
clicks will enlarge the selection. |
47 |
root |
1.7 |
|
48 |
root |
1.24 |
The selection works by trying to match a number of regexes and |
49 |
|
|
displaying them in increasing order of length. You can add your own |
50 |
|
|
regexes by specifying resources of the form: |
51 |
|
|
|
52 |
|
|
URxvt.selection.pattern-0: perl-regex |
53 |
|
|
URxvt.selection.pattern-1: perl-regex |
54 |
|
|
... |
55 |
|
|
|
56 |
|
|
The index number (0, 1...) must not have any holes, and each regex |
57 |
|
|
must contain at least one pair of capturing parentheses, which will |
58 |
|
|
be used for the match. For example, the followign adds a regex that |
59 |
|
|
matches everything between two vertical bars: |
60 |
|
|
|
61 |
|
|
URxvt.selection.pattern-0: \\|([^|]+)\\| |
62 |
|
|
|
63 |
|
|
You can look at the source of the selection extension to see more |
64 |
|
|
interesting uses, such as parsing a line from beginning to end. |
65 |
|
|
|
66 |
root |
1.29 |
This extension also offers following bindable keyboard commands: |
67 |
root |
1.4 |
|
68 |
|
|
rot13 |
69 |
|
|
Rot-13 the selection when activated. Used via keyboard trigger: |
70 |
|
|
|
71 |
|
|
URxvt.keysym.C-M-r: perl:selection:rot13 |
72 |
|
|
|
73 |
root |
1.14 |
option-popup (enabled by default) |
74 |
root |
1.15 |
Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
75 |
root |
1.14 |
options at runtime. |
76 |
|
|
|
77 |
root |
1.15 |
selection-popup (enabled by default) |
78 |
|
|
Binds a popup menu to Ctrl-Button3 that lets you convert the |
79 |
root |
1.18 |
selection text into various other formats/action (such as uri |
80 |
|
|
unescaping, perl evalution, web-browser starting etc.), depending on |
81 |
|
|
content. |
82 |
root |
1.15 |
|
83 |
root |
1.31 |
Other extensions can extend this popup menu by pushing a code |
84 |
|
|
reference onto "@{ $term-"{selection_popup_hook} }>, that is called |
85 |
|
|
whenever the popup is displayed. |
86 |
|
|
|
87 |
|
|
It's sole argument is the popup menu, which can be modified. The |
88 |
|
|
selection is in $_, which can be used to decide wether to add |
89 |
|
|
something or not. It should either return nothing or a string and a |
90 |
|
|
code reference. The string will be used as button text and the code |
91 |
|
|
reference will be called when the button gets activated and should |
92 |
|
|
transform $_. |
93 |
|
|
|
94 |
|
|
The following will add an entry "a to b" that transforms all "a"s in |
95 |
|
|
the selection to "b"s, but only if the selection currently contains |
96 |
|
|
any "a"s: |
97 |
|
|
|
98 |
|
|
push @{ $self->{term}{selection_popup_hook} }, sub { |
99 |
|
|
/a/ ? ("a to be" => sub { s/a/b/g } |
100 |
|
|
: () |
101 |
|
|
}; |
102 |
|
|
|
103 |
root |
1.17 |
searchable-scrollback<hotkey> (enabled by default) |
104 |
|
|
Adds regex search functionality to the scrollback buffer, triggered |
105 |
root |
1.23 |
by a hotkey (default: "M-s"). While in search mode, normal terminal |
106 |
|
|
input/output is suspended and a regex is displayed at the bottom of |
107 |
|
|
the screen. |
108 |
|
|
|
109 |
|
|
Inputting characters appends them to the regex and continues |
110 |
|
|
incremental search. "BackSpace" removes a character from the regex, |
111 |
|
|
"Up" and "Down" search upwards/downwards in the scrollback buffer, |
112 |
|
|
"End" jumps to the bottom. "Escape" leaves search mode and returns |
113 |
|
|
to the point where search was started, while "Enter" or "Return" |
114 |
|
|
stay at the current position and additionally stores the first match |
115 |
|
|
in the current line into the primary selection. |
116 |
root |
1.17 |
|
117 |
root |
1.24 |
selection-autotransform |
118 |
|
|
This selection allows you to do automatic transforms on a selection |
119 |
|
|
whenever a selection is made. |
120 |
|
|
|
121 |
|
|
It works by specifying perl snippets (most useful is a single "s///" |
122 |
|
|
operator) that modify $_ as resources: |
123 |
|
|
|
124 |
|
|
URxvt.selection-autotransform.0: transform |
125 |
|
|
URxvt.selection-autotransform.1: transform |
126 |
|
|
... |
127 |
|
|
|
128 |
|
|
For example, the following will transform selections of the form |
129 |
|
|
"filename:number", often seen in compiler messages, into "vi |
130 |
|
|
+$filename $word": |
131 |
|
|
|
132 |
root |
1.27 |
URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
133 |
root |
1.24 |
|
134 |
|
|
And this example matches the same,but replaces it with vi-commands |
135 |
|
|
you can paste directly into your (vi :) editor: |
136 |
|
|
|
137 |
root |
1.31 |
URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
138 |
root |
1.6 |
|
139 |
root |
1.25 |
Of course, this can be modified to suit your needs and your editor |
140 |
|
|
:) |
141 |
|
|
|
142 |
root |
1.26 |
To expand the example above to typical perl error messages ("XXX at |
143 |
|
|
FILENAME line YYY."), you need a slightly more elaborate solution: |
144 |
|
|
|
145 |
root |
1.31 |
URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
146 |
|
|
URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
147 |
root |
1.26 |
|
148 |
|
|
The first line tells the selection code to treat the unchanging part |
149 |
|
|
of every error message as a selection pattern, and the second line |
150 |
|
|
transforms the message into vi commands to load the file. |
151 |
|
|
|
152 |
root |
1.32 |
tabbed |
153 |
|
|
This transforms the terminal into a tabbar with additional |
154 |
|
|
terminals, that is, it implements what is commonly refered to as |
155 |
|
|
"tabbed terminal". The topmost line displays a "[NEW]" button, |
156 |
|
|
which, when clicked, will add a new tab, followed by one button per |
157 |
|
|
tab. |
158 |
|
|
|
159 |
|
|
Clicking a button will activate that tab. Pressing Shift-Left and |
160 |
|
|
Shift-Right will switch to the tab left or right of the current one. |
161 |
|
|
|
162 |
root |
1.12 |
mark-urls |
163 |
root |
1.22 |
Uses per-line display filtering ("on_line_update") to underline urls |
164 |
root |
1.23 |
and make them clickable. When middle-clicked, the program specified |
165 |
|
|
in the resource "urlLauncher" (default "x-www-browser") will be |
166 |
|
|
started with the URL as first argument. |
167 |
root |
1.12 |
|
168 |
root |
1.31 |
automove-background |
169 |
|
|
This is basically a one-line extension that dynamically changes the |
170 |
|
|
background pixmap offset to the window position, in effect creating |
171 |
|
|
the same effect as pseudo transparency with a custom pixmap. No |
172 |
|
|
scaling is supported in this mode. Exmaple: |
173 |
|
|
|
174 |
|
|
rxvt -pixmap background.xpm -pe automove-background |
175 |
|
|
|
176 |
root |
1.12 |
block-graphics-to-ascii |
177 |
|
|
A not very useful example of filtering all text output to the |
178 |
|
|
terminal, by replacing all line-drawing characters (U+2500 .. |
179 |
|
|
U+259F) by a similar-looking ascii character. |
180 |
|
|
|
181 |
root |
1.24 |
digital-clock |
182 |
|
|
Displays a digital clock using the built-in overlay. |
183 |
|
|
|
184 |
root |
1.6 |
example-refresh-hooks |
185 |
root |
1.4 |
Displays a very simple digital clock in the upper right corner of |
186 |
|
|
the window. Illustrates overwriting the refresh callbacks to create |
187 |
|
|
your own overlays or changes. |
188 |
|
|
|
189 |
root |
1.30 |
selection-pastebin |
190 |
|
|
This is a little rarely useful extension that Uploads the selection |
191 |
|
|
as textfile to a remote site (or does other things). (The |
192 |
|
|
implementation is not currently secure for use in a multiuser |
193 |
|
|
environment as it writes to /tmp directly.). |
194 |
|
|
|
195 |
|
|
It listens to the "selection-pastebin:remote-pastebin" keyboard |
196 |
|
|
command, i.e. |
197 |
|
|
|
198 |
|
|
URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
199 |
|
|
|
200 |
|
|
Pressing this combination runs a command with "%" replaced by the |
201 |
|
|
name of the textfile. This command can be set via a resource: |
202 |
|
|
|
203 |
|
|
URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
204 |
|
|
|
205 |
|
|
And the default is likely not useful to anybody but the few people |
206 |
|
|
around here :) |
207 |
|
|
|
208 |
|
|
The name of the textfile is the hex encoded md5 sum of the |
209 |
|
|
selection, so the same content should lead to the same filename. |
210 |
|
|
|
211 |
|
|
After a successful upload the selection will be replaced by the text |
212 |
|
|
given in the "selection-pastebin-url" resource (again, the % is the |
213 |
|
|
placeholder for the filename): |
214 |
|
|
|
215 |
|
|
URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
216 |
|
|
|
217 |
root |
1.18 |
API DOCUMENTATION |
218 |
root |
1.1 |
General API Considerations |
219 |
|
|
All objects (such as terminals, time watchers etc.) are typical |
220 |
|
|
reference-to-hash objects. The hash can be used to store anything you |
221 |
|
|
like. All members starting with an underscore (such as "_ptr" or |
222 |
root |
1.7 |
"_hook") are reserved for internal uses and MUST NOT be accessed or |
223 |
root |
1.1 |
modified). |
224 |
|
|
|
225 |
|
|
When objects are destroyed on the C++ side, the perl object hashes are |
226 |
|
|
emptied, so its best to store related objects such as time watchers and |
227 |
|
|
the like inside the terminal object so they get destroyed as soon as the |
228 |
|
|
terminal is destroyed. |
229 |
|
|
|
230 |
root |
1.12 |
Argument names also often indicate the type of a parameter. Here are |
231 |
|
|
some hints on what they mean: |
232 |
|
|
|
233 |
|
|
$text |
234 |
|
|
Rxvt-unicodes special way of encoding text, where one "unicode" |
235 |
root |
1.21 |
character always represents one screen cell. See ROW_t for a |
236 |
root |
1.12 |
discussion of this format. |
237 |
|
|
|
238 |
|
|
$string |
239 |
|
|
A perl text string, with an emphasis on *text*. It can store all |
240 |
|
|
unicode characters and is to be distinguished with text encoded in a |
241 |
|
|
specific encoding (often locale-specific) and binary data. |
242 |
|
|
|
243 |
|
|
$octets |
244 |
|
|
Either binary data or - more common - a text string encoded in a |
245 |
|
|
locale-specific way. |
246 |
|
|
|
247 |
root |
1.17 |
Extension Objects |
248 |
|
|
Very perl extension is a perl class. A separate perl object is created |
249 |
|
|
for each terminal and each extension and passed as the first parameter |
250 |
|
|
to hooks. So extensions can use their $self object without having to |
251 |
|
|
think about other extensions, with the exception of methods and members |
252 |
|
|
that begin with an underscore character "_": these are reserved for |
253 |
|
|
internal use. |
254 |
|
|
|
255 |
|
|
Although it isn't a "urxvt::term" object, you can call all methods of |
256 |
|
|
the "urxvt::term" class on this object. |
257 |
|
|
|
258 |
|
|
It has the following methods and data members: |
259 |
|
|
|
260 |
|
|
$urxvt_term = $self->{term} |
261 |
|
|
Returns the "urxvt::term" object associated with this instance of |
262 |
|
|
the extension. This member *must not* be changed in any way. |
263 |
|
|
|
264 |
|
|
$self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
265 |
|
|
Dynamically enable the given hooks (named without the "on_" prefix) |
266 |
|
|
for this extension, replacing any previous hook. This is useful when |
267 |
|
|
you want to overwrite time-critical hooks only temporarily. |
268 |
|
|
|
269 |
|
|
$self->disable ($hook_name[, $hook_name..]) |
270 |
|
|
Dynamically disable the given hooks. |
271 |
|
|
|
272 |
root |
1.1 |
Hooks |
273 |
root |
1.12 |
The following subroutines can be declared in extension files, and will |
274 |
|
|
be called whenever the relevant event happens. |
275 |
root |
1.1 |
|
276 |
root |
1.17 |
The first argument passed to them is an extension oject as described in |
277 |
|
|
the in the "Extension Objects" section. |
278 |
root |
1.7 |
|
279 |
root |
1.32 |
All of these hooks must return a boolean value. If any of the called |
280 |
|
|
hooks returns true, then the event counts as being *consumed*, and the |
281 |
|
|
relevant action might not be carried out by the C++ code. |
282 |
root |
1.1 |
|
283 |
root |
1.17 |
*When in doubt, return a false value (preferably "()").* |
284 |
root |
1.1 |
|
285 |
|
|
on_init $term |
286 |
|
|
Called after a new terminal object has been initialized, but before |
287 |
root |
1.12 |
windows are created or the command gets run. Most methods are unsafe |
288 |
|
|
to call or deliver senseless data, as terminal size and other |
289 |
|
|
characteristics have not yet been determined. You can safely query |
290 |
root |
1.32 |
and change resources and options, though. For many purposes the |
291 |
|
|
"on_start" hook is a better place. |
292 |
|
|
|
293 |
|
|
on_start $term |
294 |
|
|
Called at the very end of initialisation of a new terminal, just |
295 |
|
|
before trying to map (display) the toplevel and returning to the |
296 |
|
|
mainloop. |
297 |
|
|
|
298 |
|
|
on_destroy $term |
299 |
|
|
Called whenever something tries to destroy terminal, before doing |
300 |
|
|
anything yet. If this hook returns true, then destruction is |
301 |
|
|
skipped, but this is rarely a good idea. |
302 |
root |
1.1 |
|
303 |
|
|
on_reset $term |
304 |
|
|
Called after the screen is "reset" for any reason, such as resizing |
305 |
|
|
or control sequences. Here is where you can react on changes to |
306 |
|
|
size-related variables. |
307 |
|
|
|
308 |
root |
1.31 |
on_child_start $term, $pid |
309 |
|
|
Called just after the child process has been "fork"ed. |
310 |
|
|
|
311 |
|
|
on_child_exit $term, $status |
312 |
|
|
Called just after the child process has exited. $status is the |
313 |
|
|
status from "waitpid". |
314 |
|
|
|
315 |
root |
1.1 |
on_sel_make $term, $eventtime |
316 |
|
|
Called whenever a selection has been made by the user, but before |
317 |
|
|
the selection text is copied, so changes to the beginning, end or |
318 |
|
|
type of the selection will be honored. |
319 |
|
|
|
320 |
|
|
Returning a true value aborts selection making by urxvt, in which |
321 |
|
|
case you have to make a selection yourself by calling |
322 |
|
|
"$term->selection_grab". |
323 |
|
|
|
324 |
|
|
on_sel_grab $term, $eventtime |
325 |
|
|
Called whenever a selection has been copied, but before the |
326 |
|
|
selection is requested from the server. The selection text can be |
327 |
|
|
queried and changed by calling "$term->selection". |
328 |
|
|
|
329 |
|
|
Returning a true value aborts selection grabbing. It will still be |
330 |
|
|
hilighted. |
331 |
|
|
|
332 |
root |
1.7 |
on_sel_extend $term |
333 |
|
|
Called whenever the user tries to extend the selection (e.g. with a |
334 |
|
|
double click) and is either supposed to return false (normal |
335 |
|
|
operation), or should extend the selection itelf and return true to |
336 |
root |
1.23 |
suppress the built-in processing. This can happen multiple times, as |
337 |
|
|
long as the callback returns true, it will be called on every |
338 |
|
|
further click by the user and is supposed to enlarge the selection |
339 |
|
|
more and more, if possible. |
340 |
root |
1.7 |
|
341 |
|
|
See the selection example extension. |
342 |
|
|
|
343 |
root |
1.1 |
on_view_change $term, $offset |
344 |
|
|
Called whenever the view offset changes, i..e the user or program |
345 |
|
|
scrolls. Offset 0 means display the normal terminal, positive values |
346 |
|
|
show this many lines of scrollback. |
347 |
|
|
|
348 |
|
|
on_scroll_back $term, $lines, $saved |
349 |
|
|
Called whenever lines scroll out of the terminal area into the |
350 |
|
|
scrollback buffer. $lines is the number of lines scrolled out and |
351 |
|
|
may be larger than the scroll back buffer or the terminal. |
352 |
|
|
|
353 |
|
|
It is called before lines are scrolled out (so rows 0 .. min ($lines |
354 |
|
|
- 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
355 |
|
|
the total number of lines that will be in the scrollback buffer. |
356 |
|
|
|
357 |
root |
1.9 |
on_osc_seq $term, $string |
358 |
|
|
Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
359 |
|
|
operating system command) is processed. Cursor position and other |
360 |
|
|
state information is up-to-date when this happens. For |
361 |
|
|
interoperability, the string should start with the extension name |
362 |
|
|
and a colon, to distinguish it from commands for other extensions, |
363 |
|
|
and this might be enforced in the future. |
364 |
|
|
|
365 |
|
|
Be careful not ever to trust (in a security sense) the data you |
366 |
|
|
receive, as its source can not easily be controleld (e-mail content, |
367 |
|
|
messages from other users on the same system etc.). |
368 |
|
|
|
369 |
root |
1.12 |
on_add_lines $term, $string |
370 |
|
|
Called whenever text is about to be output, with the text as |
371 |
|
|
argument. You can filter/change and output the text yourself by |
372 |
|
|
returning a true value and calling "$term->scr_add_lines" yourself. |
373 |
|
|
Please note that this might be very slow, however, as your hook is |
374 |
|
|
called for all text being output. |
375 |
|
|
|
376 |
root |
1.17 |
on_tt_write $term, $octets |
377 |
|
|
Called whenever some data is written to the tty/pty and can be used |
378 |
|
|
to suppress or filter tty input. |
379 |
|
|
|
380 |
root |
1.12 |
on_line_update $term, $row |
381 |
|
|
Called whenever a line was updated or changed. Can be used to filter |
382 |
|
|
screen output (e.g. underline urls or other useless stuff). Only |
383 |
|
|
lines that are being shown will be filtered, and, due to performance |
384 |
|
|
reasons, not always immediately. |
385 |
|
|
|
386 |
|
|
The row number is always the topmost row of the line if the line |
387 |
|
|
spans multiple rows. |
388 |
|
|
|
389 |
|
|
Please note that, if you change the line, then the hook might get |
390 |
|
|
called later with the already-modified line (e.g. if unrelated parts |
391 |
|
|
change), so you cannot just toggle rendition bits, but only set |
392 |
|
|
them. |
393 |
|
|
|
394 |
root |
1.1 |
on_refresh_begin $term |
395 |
|
|
Called just before the screen gets redrawn. Can be used for overlay |
396 |
|
|
or similar effects by modify terminal contents in refresh_begin, and |
397 |
|
|
restoring them in refresh_end. The built-in overlay and selection |
398 |
|
|
display code is run after this hook, and takes precedence. |
399 |
|
|
|
400 |
|
|
on_refresh_end $term |
401 |
|
|
Called just after the screen gets redrawn. See "on_refresh_begin". |
402 |
|
|
|
403 |
root |
1.3 |
on_keyboard_command $term, $string |
404 |
|
|
Called whenever the user presses a key combination that has a |
405 |
|
|
"perl:string" action bound to it (see description of the keysym |
406 |
root |
1.28 |
resource in the rxvt(1) manpage). |
407 |
root |
1.27 |
|
408 |
|
|
on_x_event $term, $event |
409 |
|
|
Called on every X event received on the vt window (and possibly |
410 |
|
|
other windows). Should only be used as a last resort. Most event |
411 |
|
|
structure members are not passed. |
412 |
root |
1.3 |
|
413 |
root |
1.13 |
on_focus_in $term |
414 |
|
|
Called whenever the window gets the keyboard focus, before |
415 |
|
|
rxvt-unicode does focus in processing. |
416 |
|
|
|
417 |
|
|
on_focus_out $term |
418 |
|
|
Called wheneever the window loses keyboard focus, before |
419 |
|
|
rxvt-unicode does focus out processing. |
420 |
|
|
|
421 |
root |
1.31 |
on_configure_notify $term, $event |
422 |
root |
1.17 |
on_key_press $term, $event, $keysym, $octets |
423 |
|
|
on_key_release $term, $event, $keysym |
424 |
root |
1.12 |
on_button_press $term, $event |
425 |
|
|
on_button_release $term, $event |
426 |
|
|
on_motion_notify $term, $event |
427 |
root |
1.13 |
on_map_notify $term, $event |
428 |
|
|
on_unmap_notify $term, $event |
429 |
root |
1.12 |
Called whenever the corresponding X event is received for the |
430 |
|
|
terminal If the hook returns true, then the even will be ignored by |
431 |
|
|
rxvt-unicode. |
432 |
|
|
|
433 |
|
|
The event is a hash with most values as named by Xlib (see the |
434 |
|
|
XEvent manpage), with the additional members "row" and "col", which |
435 |
|
|
are the row and column under the mouse cursor. |
436 |
|
|
|
437 |
|
|
"on_key_press" additionally receives the string rxvt-unicode would |
438 |
|
|
output, if any, in locale-specific encoding. |
439 |
|
|
|
440 |
|
|
subwindow. |
441 |
|
|
|
442 |
root |
1.32 |
on_client_message $term, $event |
443 |
|
|
on_wm_protocols $term, $event |
444 |
|
|
on_wm_delete_window $term, $event |
445 |
|
|
Called when various types of ClientMessage events are received (all |
446 |
|
|
with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
447 |
|
|
|
448 |
root |
1.7 |
Variables in the "urxvt" Package |
449 |
root |
1.19 |
$urxvt::LIBDIR |
450 |
|
|
The rxvt-unicode library directory, where, among other things, the |
451 |
|
|
perl modules and scripts are stored. |
452 |
|
|
|
453 |
|
|
$urxvt::RESCLASS, $urxvt::RESCLASS |
454 |
|
|
The resource class and name rxvt-unicode uses to look up X |
455 |
|
|
resources. |
456 |
|
|
|
457 |
|
|
$urxvt::RXVTNAME |
458 |
|
|
The basename of the installed binaries, usually "urxvt". |
459 |
|
|
|
460 |
root |
1.7 |
$urxvt::TERM |
461 |
root |
1.12 |
The current terminal. This variable stores the current "urxvt::term" |
462 |
|
|
object, whenever a callback/hook is executing. |
463 |
root |
1.7 |
|
464 |
root |
1.32 |
@urxvt::TERM_INIT |
465 |
|
|
All coderefs in this array will be called as methods of the next |
466 |
|
|
newly created "urxvt::term" object (during the "on_init" phase). The |
467 |
|
|
array gets cleared before the codereferences that were in it are |
468 |
|
|
being executed, so coderefs can push themselves onto it again if |
469 |
|
|
they so desire. |
470 |
|
|
|
471 |
|
|
This complements to the perl-eval commandline option, but gets |
472 |
|
|
executed first. |
473 |
|
|
|
474 |
|
|
@urxvt::TERM_EXT |
475 |
|
|
Works similar to @TERM_INIT, but contains perl package/class names, |
476 |
|
|
which get registered as normal extensions after calling the hooks in |
477 |
|
|
@TERM_INIT but before other extensions. Gets cleared just like |
478 |
|
|
@TERM_INIT. |
479 |
|
|
|
480 |
root |
1.1 |
Functions in the "urxvt" Package |
481 |
|
|
urxvt::fatal $errormessage |
482 |
|
|
Fatally aborts execution with the given error message. Avoid at all |
483 |
|
|
costs! The only time this is acceptable is when the terminal process |
484 |
|
|
starts up. |
485 |
|
|
|
486 |
|
|
urxvt::warn $string |
487 |
|
|
Calls "rxvt_warn" with the given string which should not include a |
488 |
|
|
newline. The module also overwrites the "warn" builtin with a |
489 |
|
|
function that calls this function. |
490 |
|
|
|
491 |
|
|
Using this function has the advantage that its output ends up in the |
492 |
|
|
correct place, e.g. on stderr of the connecting urxvtc client. |
493 |
|
|
|
494 |
root |
1.20 |
Messages have a size limit of 1023 bytes currently. |
495 |
|
|
|
496 |
root |
1.1 |
$time = urxvt::NOW |
497 |
|
|
Returns the "current time" (as per the event loop). |
498 |
|
|
|
499 |
root |
1.13 |
urxvt::CurrentTime |
500 |
|
|
urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
501 |
|
|
Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
502 |
|
|
Button5Mask, AnyModifier |
503 |
root |
1.27 |
urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, |
504 |
|
|
ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, |
505 |
|
|
PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
506 |
|
|
Button3MotionMask, Button4MotionMask, Button5MotionMask, |
507 |
|
|
ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, |
508 |
|
|
StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, |
509 |
|
|
SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, |
510 |
|
|
ColormapChangeMask, OwnerGrabButtonMask |
511 |
|
|
urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
512 |
|
|
EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
513 |
|
|
GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
514 |
|
|
UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
515 |
|
|
ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
516 |
|
|
CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
517 |
|
|
SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
518 |
root |
1.14 |
Various constants for use in X calls and event processing. |
519 |
root |
1.13 |
|
520 |
root |
1.6 |
RENDITION |
521 |
|
|
Rendition bitsets contain information about colour, font, font styles |
522 |
|
|
and similar information for each screen cell. |
523 |
|
|
|
524 |
|
|
The following "macros" deal with changes in rendition sets. You should |
525 |
|
|
never just create a bitset, you should always modify an existing one, as |
526 |
|
|
they contain important information required for correct operation of |
527 |
|
|
rxvt-unicode. |
528 |
|
|
|
529 |
|
|
$rend = urxvt::DEFAULT_RSTYLE |
530 |
|
|
Returns the default rendition, as used when the terminal is starting |
531 |
|
|
up or being reset. Useful as a base to start when creating |
532 |
|
|
renditions. |
533 |
|
|
|
534 |
|
|
$rend = urxvt::OVERLAY_RSTYLE |
535 |
|
|
Return the rendition mask used for overlays by default. |
536 |
|
|
|
537 |
|
|
$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
538 |
|
|
Return the bit that enabled bold, italic, blink, reverse-video and |
539 |
|
|
underline, respectively. To enable such a style, just logically OR |
540 |
|
|
it into the bitset. |
541 |
|
|
|
542 |
|
|
$foreground = urxvt::GET_BASEFG $rend |
543 |
|
|
$background = urxvt::GET_BASEBG $rend |
544 |
|
|
Return the foreground/background colour index, respectively. |
545 |
|
|
|
546 |
root |
1.19 |
$rend = urxvt::SET_FGCOLOR $rend, $new_colour |
547 |
|
|
$rend = urxvt::SET_BGCOLOR $rend, $new_colour |
548 |
root |
1.6 |
Replace the foreground/background colour in the rendition mask with |
549 |
|
|
the specified one. |
550 |
|
|
|
551 |
root |
1.19 |
$value = urxvt::GET_CUSTOM $rend |
552 |
root |
1.6 |
Return the "custom" value: Every rendition has 5 bits for use by |
553 |
|
|
extensions. They can be set and changed as you like and are |
554 |
|
|
initially zero. |
555 |
|
|
|
556 |
root |
1.19 |
$rend = urxvt::SET_CUSTOM $rend, $new_value |
557 |
root |
1.6 |
Change the custom value. |
558 |
|
|
|
559 |
root |
1.14 |
The "urxvt::anyevent" Class |
560 |
|
|
The sole purpose of this class is to deliver an interface to the |
561 |
|
|
"AnyEvent" module - any module using it will work inside urxvt without |
562 |
root |
1.19 |
further programming. The only exception is that you cannot wait on |
563 |
|
|
condition variables, but non-blocking condvar use is ok. What this means |
564 |
|
|
is that you cannot use blocking APIs, but the non-blocking variant |
565 |
|
|
should work. |
566 |
root |
1.14 |
|
567 |
root |
1.1 |
The "urxvt::term" Class |
568 |
root |
1.20 |
$term = new urxvt::term $envhashref, $rxvtname, [arg...] |
569 |
|
|
Creates a new terminal, very similar as if you had started it with |
570 |
|
|
system "$rxvtname, arg...". $envhashref must be a reference to a |
571 |
root |
1.21 |
%ENV-like hash which defines the environment of the new terminal. |
572 |
root |
1.20 |
|
573 |
root |
1.21 |
Croaks (and probably outputs an error message) if the new instance |
574 |
root |
1.20 |
couldn't be created. Returns "undef" if the new instance didn't |
575 |
|
|
initialise perl, and the terminal object otherwise. The "init" and |
576 |
|
|
"start" hooks will be called during this call. |
577 |
|
|
|
578 |
root |
1.12 |
$term->destroy |
579 |
|
|
Destroy the terminal object (close the window, free resources etc.). |
580 |
root |
1.28 |
Please note that rxvt will not exit as long as any event watchers |
581 |
root |
1.19 |
(timers, io watchers) are still active. |
582 |
root |
1.12 |
|
583 |
root |
1.31 |
$term->exec_async ($cmd[, @args]) |
584 |
|
|
Works like the combination of the "fork"/"exec" builtins, which |
585 |
|
|
executes ("starts") programs in the background. This function takes |
586 |
|
|
care of setting the user environment before exec'ing the command |
587 |
|
|
(e.g. "PATH") and should be preferred over explicit calls to "exec" |
588 |
|
|
or "system". |
589 |
|
|
|
590 |
|
|
Returns the pid of the subprocess or "undef" on error. |
591 |
|
|
|
592 |
root |
1.13 |
$isset = $term->option ($optval[, $set]) |
593 |
|
|
Returns true if the option specified by $optval is enabled, and |
594 |
|
|
optionally change it. All option values are stored by name in the |
595 |
|
|
hash %urxvt::OPTION. Options not enabled in this binary are not in |
596 |
|
|
the hash. |
597 |
|
|
|
598 |
|
|
Here is a a likely non-exhaustive list of option names, please see |
599 |
|
|
the source file /src/optinc.h to see the actual list: |
600 |
|
|
|
601 |
|
|
borderLess console cursorBlink cursorUnderline hold iconic insecure |
602 |
|
|
intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
603 |
root |
1.31 |
override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
604 |
|
|
scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
605 |
|
|
scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
606 |
|
|
transparent tripleclickwords utmpInhibit visualBell |
607 |
root |
1.13 |
|
608 |
root |
1.1 |
$value = $term->resource ($name[, $newval]) |
609 |
|
|
Returns the current resource value associated with a given name and |
610 |
|
|
optionally sets a new value. Setting values is most useful in the |
611 |
|
|
"init" hook. Unset resources are returned and accepted as "undef". |
612 |
|
|
|
613 |
|
|
The new value must be properly encoded to a suitable character |
614 |
|
|
encoding before passing it to this method. Similarly, the returned |
615 |
|
|
value may need to be converted from the used encoding to text. |
616 |
|
|
|
617 |
|
|
Resource names are as defined in src/rsinc.h. Colours can be |
618 |
|
|
specified as resource names of the form "color+<index>", e.g. |
619 |
|
|
"color+5". (will likely change). |
620 |
|
|
|
621 |
|
|
Please note that resource strings will currently only be freed when |
622 |
|
|
the terminal is destroyed, so changing options frequently will eat |
623 |
|
|
memory. |
624 |
|
|
|
625 |
|
|
Here is a a likely non-exhaustive list of resource names, not all of |
626 |
root |
1.13 |
which are supported in every build, please see the source file |
627 |
|
|
/src/rsinc.h to see the actual list: |
628 |
root |
1.1 |
|
629 |
|
|
answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
630 |
|
|
borderLess color cursorBlink cursorUnderline cutchars delete_key |
631 |
|
|
display_name embed ext_bwidth fade font geometry hold iconName |
632 |
|
|
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
633 |
root |
1.31 |
italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
634 |
|
|
mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
635 |
|
|
perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
636 |
|
|
preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
637 |
|
|
scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
638 |
|
|
scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
639 |
|
|
secondaryScreen secondaryScroll selectstyle shade term_name title |
640 |
|
|
transient_for transparent transparent_all tripleclickwords utmpInhibit |
641 |
|
|
visualBell |
642 |
root |
1.1 |
|
643 |
root |
1.22 |
$value = $term->x_resource ($pattern) |
644 |
|
|
Returns the X-Resource for the given pattern, excluding the program |
645 |
|
|
or class name, i.e. "$term->x_resource ("boldFont")" should return |
646 |
|
|
the same value as used by this instance of rxvt-unicode. Returns |
647 |
|
|
"undef" if no resource with that pattern exists. |
648 |
|
|
|
649 |
|
|
This method should only be called during the "on_start" hook, as |
650 |
|
|
there is only one resource database per display, and later |
651 |
|
|
invocations might return the wrong resources. |
652 |
|
|
|
653 |
root |
1.17 |
$success = $term->parse_keysym ($keysym_spec, $command_string) |
654 |
|
|
Adds a keymap translation exactly as specified via a resource. See |
655 |
root |
1.28 |
the "keysym" resource in the rxvt(1) manpage. |
656 |
root |
1.17 |
|
657 |
root |
1.12 |
$rend = $term->rstyle ([$new_rstyle]) |
658 |
|
|
Return and optionally change the current rendition. Text that is |
659 |
|
|
output by the terminal application will use this style. |
660 |
root |
1.11 |
|
661 |
|
|
($row, $col) = $term->screen_cur ([$row, $col]) |
662 |
|
|
Return the current coordinates of the text cursor position and |
663 |
|
|
optionally set it (which is usually bad as applications don't expect |
664 |
|
|
that). |
665 |
|
|
|
666 |
root |
1.1 |
($row, $col) = $term->selection_mark ([$row, $col]) |
667 |
|
|
($row, $col) = $term->selection_beg ([$row, $col]) |
668 |
|
|
($row, $col) = $term->selection_end ([$row, $col]) |
669 |
|
|
Return the current values of the selection mark, begin or end |
670 |
|
|
positions, and optionally set them to new values. |
671 |
|
|
|
672 |
root |
1.23 |
$term->selection_make ($eventtime[, $rectangular]) |
673 |
|
|
Tries to make a selection as set by "selection_beg" and |
674 |
|
|
"selection_end". If $rectangular is true (default: false), a |
675 |
|
|
rectangular selection will be made. This is the prefered function to |
676 |
|
|
make a selection. |
677 |
|
|
|
678 |
root |
1.1 |
$success = $term->selection_grab ($eventtime) |
679 |
root |
1.23 |
Try to request the primary selection text from the server (for |
680 |
|
|
example, as set by the next method). No visual feedback will be |
681 |
|
|
given. This function is mostly useful from within "on_sel_grab" |
682 |
|
|
hooks. |
683 |
root |
1.1 |
|
684 |
|
|
$oldtext = $term->selection ([$newtext]) |
685 |
|
|
Return the current selection text and optionally replace it by |
686 |
|
|
$newtext. |
687 |
|
|
|
688 |
root |
1.17 |
$term->overlay_simple ($x, $y, $text) |
689 |
|
|
Create a simple multi-line overlay box. See the next method for |
690 |
|
|
details. |
691 |
root |
1.6 |
|
692 |
|
|
$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
693 |
root |
1.1 |
Create a new (empty) overlay at the given position with the given |
694 |
root |
1.6 |
width/height. $rstyle defines the initial rendition style (default: |
695 |
|
|
"OVERLAY_RSTYLE"). |
696 |
|
|
|
697 |
|
|
If $border is 2 (default), then a decorative border will be put |
698 |
|
|
around the box. |
699 |
|
|
|
700 |
|
|
If either $x or $y is negative, then this is counted from the |
701 |
|
|
right/bottom side, respectively. |
702 |
|
|
|
703 |
|
|
This method returns an urxvt::overlay object. The overlay will be |
704 |
|
|
visible as long as the perl object is referenced. |
705 |
root |
1.1 |
|
706 |
root |
1.7 |
The methods currently supported on "urxvt::overlay" objects are: |
707 |
root |
1.6 |
|
708 |
root |
1.7 |
$overlay->set ($x, $y, $text, $rend) |
709 |
|
|
Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts |
710 |
|
|
text in rxvt-unicode's special encoding and an array of |
711 |
|
|
rendition values at a specific position inside the overlay. |
712 |
|
|
|
713 |
|
|
$overlay->hide |
714 |
|
|
If visible, hide the overlay, but do not destroy it. |
715 |
|
|
|
716 |
|
|
$overlay->show |
717 |
|
|
If hidden, display the overlay again. |
718 |
root |
1.1 |
|
719 |
root |
1.13 |
$popup = $term->popup ($event) |
720 |
|
|
Creates a new "urxvt::popup" object that implements a popup menu. |
721 |
|
|
The $event *must* be the event causing the menu to pop up (a button |
722 |
|
|
event, currently). |
723 |
|
|
|
724 |
root |
1.12 |
$cellwidth = $term->strwidth ($string) |
725 |
root |
1.1 |
Returns the number of screen-cells this string would need. Correctly |
726 |
|
|
accounts for wide and combining characters. |
727 |
|
|
|
728 |
root |
1.12 |
$octets = $term->locale_encode ($string) |
729 |
root |
1.1 |
Convert the given text string into the corresponding locale |
730 |
|
|
encoding. |
731 |
|
|
|
732 |
root |
1.12 |
$string = $term->locale_decode ($octets) |
733 |
root |
1.1 |
Convert the given locale-encoded octets into a perl string. |
734 |
|
|
|
735 |
root |
1.17 |
$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
736 |
|
|
XORs the rendition values in the given span with the provided value |
737 |
root |
1.23 |
(default: "RS_RVid"), which *MUST NOT* contain font styles. Useful |
738 |
|
|
in refresh hooks to provide effects similar to the selection. |
739 |
root |
1.17 |
|
740 |
|
|
$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
741 |
|
|
$rstyle2]]) |
742 |
|
|
Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
743 |
|
|
whitespace will additionally be xored with the $rstyle2, which |
744 |
|
|
defaults to "RS_RVid | RS_Uline", which removes reverse video again |
745 |
root |
1.23 |
and underlines it instead. Both styles *MUST NOT* contain font |
746 |
|
|
styles. |
747 |
root |
1.17 |
|
748 |
|
|
$term->scr_bell |
749 |
|
|
Ring the bell! |
750 |
|
|
|
751 |
root |
1.12 |
$term->scr_add_lines ($string) |
752 |
|
|
Write the given text string to the screen, as if output by the |
753 |
|
|
application running inside the terminal. It may not contain command |
754 |
|
|
sequences (escape codes), but is free to use line feeds, carriage |
755 |
|
|
returns and tabs. The string is a normal text string, not in |
756 |
|
|
locale-dependent encoding. |
757 |
|
|
|
758 |
|
|
Normally its not a good idea to use this function, as programs might |
759 |
|
|
be confused by changes in cursor position or scrolling. Its useful |
760 |
|
|
inside a "on_add_lines" hook, though. |
761 |
|
|
|
762 |
|
|
$term->cmd_parse ($octets) |
763 |
|
|
Similar to "scr_add_lines", but the argument must be in the |
764 |
|
|
locale-specific encoding of the terminal and can contain command |
765 |
|
|
sequences (escape codes) that will be interpreted. |
766 |
|
|
|
767 |
root |
1.1 |
$term->tt_write ($octets) |
768 |
|
|
Write the octets given in $data to the tty (i.e. as program input). |
769 |
root |
1.4 |
To pass characters instead of octets, you should convert your |
770 |
|
|
strings first to the locale-specific encoding using |
771 |
|
|
"$term->locale_encode". |
772 |
|
|
|
773 |
root |
1.17 |
$old_events = $term->pty_ev_events ([$new_events]) |
774 |
|
|
Replaces the event mask of the pty watcher by the given event mask. |
775 |
|
|
Can be used to suppress input and output handling to the pty/tty. |
776 |
|
|
See the description of "urxvt::timer->events". Make sure to always |
777 |
|
|
restore the previous value. |
778 |
|
|
|
779 |
root |
1.12 |
$windowid = $term->parent |
780 |
|
|
Return the window id of the toplevel window. |
781 |
|
|
|
782 |
|
|
$windowid = $term->vt |
783 |
|
|
Return the window id of the terminal window. |
784 |
|
|
|
785 |
root |
1.27 |
$term->vt_emask_add ($x_event_mask) |
786 |
|
|
Adds the specified events to the vt event mask. Useful e.g. when you |
787 |
|
|
want to receive pointer events all the times: |
788 |
|
|
|
789 |
|
|
$term->vt_emask_add (urxvt::PointerMotionMask); |
790 |
|
|
|
791 |
root |
1.11 |
$window_width = $term->width |
792 |
|
|
$window_height = $term->height |
793 |
|
|
$font_width = $term->fwidth |
794 |
|
|
$font_height = $term->fheight |
795 |
|
|
$font_ascent = $term->fbase |
796 |
|
|
$terminal_rows = $term->nrow |
797 |
|
|
$terminal_columns = $term->ncol |
798 |
|
|
$has_focus = $term->focus |
799 |
|
|
$is_mapped = $term->mapped |
800 |
|
|
$max_scrollback = $term->saveLines |
801 |
|
|
$nrow_plus_saveLines = $term->total_rows |
802 |
root |
1.28 |
$topmost_scrollback_row = $term->top_row |
803 |
root |
1.11 |
Return various integers describing terminal characteristics. |
804 |
root |
1.4 |
|
805 |
root |
1.20 |
$x_display = $term->display_id |
806 |
|
|
Return the DISPLAY used by rxvt-unicode. |
807 |
|
|
|
808 |
root |
1.17 |
$lc_ctype = $term->locale |
809 |
|
|
Returns the LC_CTYPE category string used by this rxvt-unicode. |
810 |
|
|
|
811 |
root |
1.20 |
$env = $term->env |
812 |
|
|
Returns a copy of the environment in effect for the terminal as a |
813 |
|
|
hashref similar to "\%ENV". |
814 |
root |
1.17 |
|
815 |
root |
1.13 |
$modifiermask = $term->ModLevel3Mask |
816 |
|
|
$modifiermask = $term->ModMetaMask |
817 |
|
|
$modifiermask = $term->ModNumLockMask |
818 |
|
|
Return the modifier masks corresponding to the "ISO Level 3 Shift" |
819 |
|
|
(often AltGr), the meta key (often Alt) and the num lock key, if |
820 |
|
|
applicable. |
821 |
|
|
|
822 |
root |
1.4 |
$view_start = $term->view_start ([$newvalue]) |
823 |
root |
1.28 |
Returns the row number of the topmost displayed line. Maximum value |
824 |
|
|
is 0, which displays the normal terminal contents. Lower values |
825 |
root |
1.4 |
scroll this many lines into the scrollback buffer. |
826 |
|
|
|
827 |
|
|
$term->want_refresh |
828 |
|
|
Requests a screen refresh. At the next opportunity, rxvt-unicode |
829 |
|
|
will compare the on-screen display with its stored representation. |
830 |
|
|
If they differ, it redraws the differences. |
831 |
|
|
|
832 |
|
|
Used after changing terminal contents to display them. |
833 |
|
|
|
834 |
|
|
$text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
835 |
|
|
Returns the text of the entire row with number $row_number. Row 0 is |
836 |
|
|
the topmost terminal line, row "$term->$ncol-1" is the bottommost |
837 |
|
|
terminal line. The scrollback buffer starts at line -1 and extends |
838 |
root |
1.7 |
to line "-$term->nsaved". Nothing will be returned if a nonexistent |
839 |
|
|
line is requested. |
840 |
root |
1.4 |
|
841 |
|
|
If $new_text is specified, it will replace characters in the current |
842 |
|
|
line, starting at column $start_col (default 0), which is useful to |
843 |
root |
1.6 |
replace only parts of a line. The font index in the rendition will |
844 |
root |
1.4 |
automatically be updated. |
845 |
|
|
|
846 |
|
|
$text is in a special encoding: tabs and wide characters that use |
847 |
|
|
more than one cell when displayed are padded with urxvt::NOCHAR |
848 |
|
|
characters ("chr 65535"). Characters with combining characters and |
849 |
|
|
other characters that do not fit into the normal tetx encoding will |
850 |
|
|
be replaced with characters in the private use area. |
851 |
|
|
|
852 |
|
|
You have to obey this encoding when changing text. The advantage is |
853 |
|
|
that "substr" and similar functions work on screen cells and not on |
854 |
|
|
characters. |
855 |
|
|
|
856 |
|
|
The methods "$term->special_encode" and "$term->special_decode" can |
857 |
|
|
be used to convert normal strings into this encoding and vice versa. |
858 |
|
|
|
859 |
|
|
$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
860 |
|
|
Like "$term->ROW_t", but returns an arrayref with rendition bitsets. |
861 |
|
|
Rendition bitsets contain information about colour, font, font |
862 |
|
|
styles and similar information. See also "$term->ROW_t". |
863 |
|
|
|
864 |
|
|
When setting rendition, the font mask will be ignored. |
865 |
|
|
|
866 |
root |
1.6 |
See the section on RENDITION, above. |
867 |
root |
1.4 |
|
868 |
|
|
$length = $term->ROW_l ($row_number[, $new_length]) |
869 |
|
|
Returns the number of screen cells that are in use ("the line |
870 |
root |
1.7 |
length"). Unlike the urxvt core, this returns "$term->ncol" if the |
871 |
|
|
line is joined with the following one. |
872 |
|
|
|
873 |
|
|
$bool = $term->is_longer ($row_number) |
874 |
|
|
Returns true if the row is part of a multiple-row logical "line" |
875 |
|
|
(i.e. joined with the following row), which means all characters are |
876 |
|
|
in use and it is continued on the next row (and possibly a |
877 |
|
|
continuation of the previous row(s)). |
878 |
|
|
|
879 |
|
|
$line = $term->line ($row_number) |
880 |
|
|
Create and return a new "urxvt::line" object that stores information |
881 |
|
|
about the logical line that row $row_number is part of. It supports |
882 |
|
|
the following methods: |
883 |
|
|
|
884 |
root |
1.12 |
$text = $line->t ([$new_text]) |
885 |
|
|
Returns or replaces the full text of the line, similar to |
886 |
|
|
"ROW_t" |
887 |
|
|
|
888 |
|
|
$rend = $line->r ([$new_rend]) |
889 |
|
|
Returns or replaces the full rendition array of the line, |
890 |
|
|
similar to "ROW_r" |
891 |
root |
1.7 |
|
892 |
|
|
$length = $line->l |
893 |
|
|
Returns the length of the line in cells, similar to "ROW_l". |
894 |
|
|
|
895 |
|
|
$rownum = $line->beg |
896 |
|
|
$rownum = $line->end |
897 |
|
|
Return the row number of the first/last row of the line, |
898 |
|
|
respectively. |
899 |
|
|
|
900 |
|
|
$offset = $line->offset_of ($row, $col) |
901 |
|
|
Returns the character offset of the given row|col pair within |
902 |
root |
1.23 |
the logical line. Works for rows outside the line, too, and |
903 |
|
|
returns corresponding offsets outside the string. |
904 |
root |
1.7 |
|
905 |
|
|
($row, $col) = $line->coord_of ($offset) |
906 |
|
|
Translates a string offset into terminal coordinates again. |
907 |
root |
1.4 |
|
908 |
root |
1.15 |
$text = $term->special_encode $string |
909 |
root |
1.4 |
Converts a perl string into the special encoding used by |
910 |
|
|
rxvt-unicode, where one character corresponds to one screen cell. |
911 |
|
|
See "$term->ROW_t" for details. |
912 |
|
|
|
913 |
|
|
$string = $term->special_decode $text |
914 |
|
|
Converts rxvt-unicodes text reprsentation into a perl string. See |
915 |
|
|
"$term->ROW_t" for details. |
916 |
|
|
|
917 |
root |
1.15 |
$success = $term->grab_button ($button, $modifiermask) |
918 |
root |
1.16 |
Registers a synchronous button grab. See the XGrabButton manpage. |
919 |
root |
1.15 |
|
920 |
|
|
$success = $term->grab ($eventtime[, $sync]) |
921 |
|
|
Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
922 |
|
|
synchronous ($sync is true). Also remembers the grab timestampe. |
923 |
|
|
|
924 |
|
|
$term->allow_events_async |
925 |
|
|
Calls XAllowEvents with AsyncBoth for the most recent grab. |
926 |
|
|
|
927 |
|
|
$term->allow_events_sync |
928 |
|
|
Calls XAllowEvents with SyncBoth for the most recent grab. |
929 |
|
|
|
930 |
|
|
$term->allow_events_replay |
931 |
|
|
Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for |
932 |
|
|
the most recent grab. |
933 |
|
|
|
934 |
|
|
$term->ungrab |
935 |
|
|
Calls XUngrab for the most recent grab. Is called automatically on |
936 |
|
|
evaluation errors, as it is better to lose the grab in the error |
937 |
|
|
case as the session. |
938 |
|
|
|
939 |
root |
1.13 |
The "urxvt::popup" Class |
940 |
root |
1.19 |
$popup->add_title ($title) |
941 |
|
|
Adds a non-clickable title to the popup. |
942 |
|
|
|
943 |
|
|
$popup->add_separator ([$sepchr]) |
944 |
|
|
Creates a separator, optionally using the character given as |
945 |
|
|
$sepchr. |
946 |
|
|
|
947 |
|
|
$popup->add_button ($text, $cb) |
948 |
|
|
Adds a clickable button to the popup. $cb is called whenever it is |
949 |
|
|
selected. |
950 |
|
|
|
951 |
|
|
$popup->add_toggle ($text, $cb, $initial_value) |
952 |
|
|
Adds a toggle/checkbox item to the popup. Teh callback gets called |
953 |
|
|
whenever it gets toggled, with a boolean indicating its value as its |
954 |
|
|
first argument. |
955 |
|
|
|
956 |
|
|
$popup->show |
957 |
|
|
Displays the popup (which is initially hidden). |
958 |
|
|
|
959 |
root |
1.1 |
The "urxvt::timer" Class |
960 |
root |
1.21 |
This class implements timer watchers/events. Time is represented as a |
961 |
|
|
fractional number of seconds since the epoch. Example: |
962 |
root |
1.1 |
|
963 |
root |
1.21 |
$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
964 |
|
|
$term->{timer} = urxvt::timer |
965 |
|
|
->new |
966 |
|
|
->interval (1) |
967 |
|
|
->cb (sub { |
968 |
|
|
$term->{overlay}->set (0, 0, |
969 |
|
|
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
970 |
|
|
}); |
971 |
|
|
|
972 |
|
|
$timer = new urxvt::timer |
973 |
|
|
Create a new timer object in started state. It is scheduled to fire |
974 |
|
|
immediately. |
975 |
|
|
|
976 |
|
|
$timer = $timer->cb (sub { my ($timer) = @_; ... }) |
977 |
|
|
Set the callback to be called when the timer triggers. |
978 |
|
|
|
979 |
|
|
$tstamp = $timer->at |
980 |
|
|
Return the time this watcher will fire next. |
981 |
|
|
|
982 |
|
|
$timer = $timer->set ($tstamp) |
983 |
|
|
Set the time the event is generated to $tstamp. |
984 |
|
|
|
985 |
|
|
$timer = $timer->interval ($interval) |
986 |
|
|
Normally (and when $interval is 0), the timer will automatically |
987 |
|
|
stop after it has fired once. If $interval is non-zero, then the |
988 |
|
|
timer is automatically rescheduled at the given intervals. |
989 |
root |
1.6 |
|
990 |
root |
1.21 |
$timer = $timer->start |
991 |
|
|
Start the timer. |
992 |
root |
1.1 |
|
993 |
root |
1.21 |
$timer = $timer->start ($tstamp) |
994 |
|
|
Set the event trigger time to $tstamp and start the timer. |
995 |
root |
1.1 |
|
996 |
root |
1.31 |
$timer = $timer->after ($delay) |
997 |
|
|
Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>. |
998 |
|
|
|
999 |
root |
1.21 |
$timer = $timer->stop |
1000 |
|
|
Stop the timer. |
1001 |
root |
1.1 |
|
1002 |
|
|
The "urxvt::iow" Class |
1003 |
root |
1.21 |
This class implements io watchers/events. Example: |
1004 |
root |
1.1 |
|
1005 |
root |
1.21 |
$term->{socket} = ... |
1006 |
|
|
$term->{iow} = urxvt::iow |
1007 |
|
|
->new |
1008 |
|
|
->fd (fileno $term->{socket}) |
1009 |
|
|
->events (urxvt::EVENT_READ) |
1010 |
|
|
->start |
1011 |
|
|
->cb (sub { |
1012 |
|
|
my ($iow, $revents) = @_; |
1013 |
|
|
# $revents must be 1 here, no need to check |
1014 |
|
|
sysread $term->{socket}, my $buf, 8192 |
1015 |
|
|
or end-of-file; |
1016 |
|
|
}); |
1017 |
|
|
|
1018 |
|
|
$iow = new urxvt::iow |
1019 |
|
|
Create a new io watcher object in stopped state. |
1020 |
|
|
|
1021 |
|
|
$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
1022 |
|
|
Set the callback to be called when io events are triggered. |
1023 |
|
|
$reventmask is a bitset as described in the "events" method. |
1024 |
|
|
|
1025 |
|
|
$iow = $iow->fd ($fd) |
1026 |
|
|
Set the filedescriptor (not handle) to watch. |
1027 |
|
|
|
1028 |
|
|
$iow = $iow->events ($eventmask) |
1029 |
|
|
Set the event mask to watch. The only allowed values are |
1030 |
|
|
"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed |
1031 |
|
|
together, or "urxvt::EVENT_NONE". |
1032 |
root |
1.1 |
|
1033 |
root |
1.21 |
$iow = $iow->start |
1034 |
|
|
Start watching for requested events on the given handle. |
1035 |
root |
1.1 |
|
1036 |
root |
1.21 |
$iow = $iow->stop |
1037 |
|
|
Stop watching for events on the given filehandle. |
1038 |
root |
1.1 |
|
1039 |
root |
1.32 |
The "urxvt::iw" Class |
1040 |
|
|
This class implements idle watchers, that get called automatically when |
1041 |
|
|
the process is idle. They should return as fast as possible, after doing |
1042 |
|
|
some useful work. |
1043 |
|
|
|
1044 |
|
|
$iw = new urxvt::iw |
1045 |
|
|
Create a new idle watcher object in stopped state. |
1046 |
|
|
|
1047 |
|
|
$iw = $iw->cb (sub { my ($iw) = @_; ... }) |
1048 |
|
|
Set the callback to be called when the watcher triggers. |
1049 |
|
|
|
1050 |
|
|
$timer = $timer->start |
1051 |
|
|
Start the watcher. |
1052 |
|
|
|
1053 |
|
|
$timer = $timer->stop |
1054 |
|
|
Stop the watcher. |
1055 |
|
|
|
1056 |
|
|
The "urxvt::pw" Class |
1057 |
|
|
This class implements process watchers. They create an event whenever a |
1058 |
|
|
process exits, after which they stop automatically. |
1059 |
|
|
|
1060 |
|
|
my $pid = fork; |
1061 |
|
|
... |
1062 |
|
|
$term->{pw} = urxvt::pw |
1063 |
|
|
->new |
1064 |
|
|
->start ($pid) |
1065 |
|
|
->cb (sub { |
1066 |
|
|
my ($pw, $exit_status) = @_; |
1067 |
|
|
... |
1068 |
|
|
}); |
1069 |
|
|
|
1070 |
|
|
$pw = new urxvt::pw |
1071 |
|
|
Create a new process watcher in stopped state. |
1072 |
|
|
|
1073 |
|
|
$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
1074 |
|
|
Set the callback to be called when the timer triggers. |
1075 |
|
|
|
1076 |
|
|
$pw = $timer->start ($pid) |
1077 |
|
|
Tells the wqtcher to start watching for process $pid. |
1078 |
|
|
|
1079 |
|
|
$pw = $pw->stop |
1080 |
|
|
Stop the watcher. |
1081 |
|
|
|
1082 |
root |
1.1 |
ENVIRONMENT |
1083 |
|
|
URXVT_PERL_VERBOSITY |
1084 |
root |
1.21 |
This variable controls the verbosity level of the perl extension. Higher |
1085 |
|
|
numbers indicate more verbose output. |
1086 |
root |
1.1 |
|
1087 |
root |
1.21 |
== 0 - fatal messages |
1088 |
|
|
>= 3 - script loading and management |
1089 |
root |
1.23 |
>=10 - all called hooks |
1090 |
|
|
>=11 - hook reutrn values |
1091 |
root |
1.1 |
|
1092 |
|
|
AUTHOR |
1093 |
root |
1.21 |
Marc Lehmann <pcg@goof.com> |
1094 |
|
|
http://software.schmorp.de/pkg/rxvt-unicode |
1095 |
root |
1.1 |
|