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