1 |
root |
1.1 |
NAME |
2 |
|
|
rxvtperl - rxvt-unicode's embedded perl interpreter |
3 |
|
|
|
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.3 |
# start a rxvt using it: |
13 |
|
|
|
14 |
|
|
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 |
|
|
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.4 |
can find them in /opt/rxvt/lib/urxvt/perl/. |
29 |
|
|
|
30 |
|
|
You can activate them like this: |
31 |
|
|
|
32 |
|
|
rxvt -pe <extensionname> |
33 |
|
|
|
34 |
root |
1.14 |
selection (enabled by default) |
35 |
root |
1.18 |
(More) intelligent selection. This extension tries to be more |
36 |
|
|
intelligent when the user extends selections (double-click). Right |
37 |
|
|
now, it tries to select urls and complete shell-quoted arguments, |
38 |
|
|
which is very convenient, too, if your ls supports |
39 |
|
|
"--quoting-style=shell". |
40 |
root |
1.7 |
|
41 |
root |
1.18 |
It also offers the following bindable keyboard command: |
42 |
root |
1.4 |
|
43 |
|
|
rot13 |
44 |
|
|
Rot-13 the selection when activated. Used via keyboard trigger: |
45 |
|
|
|
46 |
|
|
URxvt.keysym.C-M-r: perl:selection:rot13 |
47 |
|
|
|
48 |
root |
1.14 |
option-popup (enabled by default) |
49 |
root |
1.15 |
Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
50 |
root |
1.14 |
options at runtime. |
51 |
|
|
|
52 |
root |
1.15 |
selection-popup (enabled by default) |
53 |
|
|
Binds a popup menu to Ctrl-Button3 that lets you convert the |
54 |
root |
1.18 |
selection text into various other formats/action (such as uri |
55 |
|
|
unescaping, perl evalution, web-browser starting etc.), depending on |
56 |
|
|
content. |
57 |
root |
1.15 |
|
58 |
root |
1.17 |
searchable-scrollback<hotkey> (enabled by default) |
59 |
|
|
Adds regex search functionality to the scrollback buffer, triggered |
60 |
|
|
by a hotkey (default: "M-s"). When in search mode, normal terminal |
61 |
|
|
input/output is suspended. |
62 |
|
|
|
63 |
|
|
"/" starts an incremental regex search, "n" searches further, "p" or |
64 |
|
|
"N" jump to the previous match, "G" jumps to the bottom and clears |
65 |
|
|
the history, "enter" leaves search mode at the current position and |
66 |
|
|
"escape" returns to the original position. |
67 |
|
|
|
68 |
root |
1.4 |
digital-clock |
69 |
root |
1.6 |
Displays a digital clock using the built-in overlay. |
70 |
|
|
|
71 |
root |
1.12 |
mark-urls |
72 |
root |
1.22 |
Uses per-line display filtering ("on_line_update") to underline urls |
73 |
|
|
and make them clickable. When clicked, the program specified in the |
74 |
|
|
resource "urlLauncher" (default "x-www-browser") will be started. |
75 |
root |
1.12 |
|
76 |
|
|
block-graphics-to-ascii |
77 |
|
|
A not very useful example of filtering all text output to the |
78 |
|
|
terminal, by replacing all line-drawing characters (U+2500 .. |
79 |
|
|
U+259F) by a similar-looking ascii character. |
80 |
|
|
|
81 |
root |
1.6 |
example-refresh-hooks |
82 |
root |
1.4 |
Displays a very simple digital clock in the upper right corner of |
83 |
|
|
the window. Illustrates overwriting the refresh callbacks to create |
84 |
|
|
your own overlays or changes. |
85 |
|
|
|
86 |
root |
1.18 |
API DOCUMENTATION |
87 |
root |
1.1 |
General API Considerations |
88 |
|
|
All objects (such as terminals, time watchers etc.) are typical |
89 |
|
|
reference-to-hash objects. The hash can be used to store anything you |
90 |
|
|
like. All members starting with an underscore (such as "_ptr" or |
91 |
root |
1.7 |
"_hook") are reserved for internal uses and MUST NOT be accessed or |
92 |
root |
1.1 |
modified). |
93 |
|
|
|
94 |
|
|
When objects are destroyed on the C++ side, the perl object hashes are |
95 |
|
|
emptied, so its best to store related objects such as time watchers and |
96 |
|
|
the like inside the terminal object so they get destroyed as soon as the |
97 |
|
|
terminal is destroyed. |
98 |
|
|
|
99 |
root |
1.12 |
Argument names also often indicate the type of a parameter. Here are |
100 |
|
|
some hints on what they mean: |
101 |
|
|
|
102 |
|
|
$text |
103 |
|
|
Rxvt-unicodes special way of encoding text, where one "unicode" |
104 |
root |
1.21 |
character always represents one screen cell. See ROW_t for a |
105 |
root |
1.12 |
discussion of this format. |
106 |
|
|
|
107 |
|
|
$string |
108 |
|
|
A perl text string, with an emphasis on *text*. It can store all |
109 |
|
|
unicode characters and is to be distinguished with text encoded in a |
110 |
|
|
specific encoding (often locale-specific) and binary data. |
111 |
|
|
|
112 |
|
|
$octets |
113 |
|
|
Either binary data or - more common - a text string encoded in a |
114 |
|
|
locale-specific way. |
115 |
|
|
|
116 |
root |
1.17 |
Extension Objects |
117 |
|
|
Very perl extension is a perl class. A separate perl object is created |
118 |
|
|
for each terminal and each extension and passed as the first parameter |
119 |
|
|
to hooks. So extensions can use their $self object without having to |
120 |
|
|
think about other extensions, with the exception of methods and members |
121 |
|
|
that begin with an underscore character "_": these are reserved for |
122 |
|
|
internal use. |
123 |
|
|
|
124 |
|
|
Although it isn't a "urxvt::term" object, you can call all methods of |
125 |
|
|
the "urxvt::term" class on this object. |
126 |
|
|
|
127 |
|
|
It has the following methods and data members: |
128 |
|
|
|
129 |
|
|
$urxvt_term = $self->{term} |
130 |
|
|
Returns the "urxvt::term" object associated with this instance of |
131 |
|
|
the extension. This member *must not* be changed in any way. |
132 |
|
|
|
133 |
|
|
$self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
134 |
|
|
Dynamically enable the given hooks (named without the "on_" prefix) |
135 |
|
|
for this extension, replacing any previous hook. This is useful when |
136 |
|
|
you want to overwrite time-critical hooks only temporarily. |
137 |
|
|
|
138 |
|
|
$self->disable ($hook_name[, $hook_name..]) |
139 |
|
|
Dynamically disable the given hooks. |
140 |
|
|
|
141 |
root |
1.1 |
Hooks |
142 |
root |
1.12 |
The following subroutines can be declared in extension files, and will |
143 |
|
|
be called whenever the relevant event happens. |
144 |
root |
1.1 |
|
145 |
root |
1.17 |
The first argument passed to them is an extension oject as described in |
146 |
|
|
the in the "Extension Objects" section. |
147 |
root |
1.7 |
|
148 |
root |
1.17 |
All of these hooks must return a boolean value. If it is true, then the |
149 |
|
|
event counts as being *consumed*, and the invocation of other hooks is |
150 |
root |
1.1 |
skipped, and the relevant action might not be carried out by the C++ |
151 |
|
|
code. |
152 |
|
|
|
153 |
root |
1.17 |
*When in doubt, return a false value (preferably "()").* |
154 |
root |
1.1 |
|
155 |
|
|
on_init $term |
156 |
|
|
Called after a new terminal object has been initialized, but before |
157 |
root |
1.12 |
windows are created or the command gets run. Most methods are unsafe |
158 |
|
|
to call or deliver senseless data, as terminal size and other |
159 |
|
|
characteristics have not yet been determined. You can safely query |
160 |
|
|
and change resources, though. |
161 |
root |
1.1 |
|
162 |
|
|
on_reset $term |
163 |
|
|
Called after the screen is "reset" for any reason, such as resizing |
164 |
|
|
or control sequences. Here is where you can react on changes to |
165 |
|
|
size-related variables. |
166 |
|
|
|
167 |
|
|
on_start $term |
168 |
|
|
Called at the very end of initialisation of a new terminal, just |
169 |
|
|
before returning to the mainloop. |
170 |
|
|
|
171 |
|
|
on_sel_make $term, $eventtime |
172 |
|
|
Called whenever a selection has been made by the user, but before |
173 |
|
|
the selection text is copied, so changes to the beginning, end or |
174 |
|
|
type of the selection will be honored. |
175 |
|
|
|
176 |
|
|
Returning a true value aborts selection making by urxvt, in which |
177 |
|
|
case you have to make a selection yourself by calling |
178 |
|
|
"$term->selection_grab". |
179 |
|
|
|
180 |
|
|
on_sel_grab $term, $eventtime |
181 |
|
|
Called whenever a selection has been copied, but before the |
182 |
|
|
selection is requested from the server. The selection text can be |
183 |
|
|
queried and changed by calling "$term->selection". |
184 |
|
|
|
185 |
|
|
Returning a true value aborts selection grabbing. It will still be |
186 |
|
|
hilighted. |
187 |
|
|
|
188 |
root |
1.7 |
on_sel_extend $term |
189 |
|
|
Called whenever the user tries to extend the selection (e.g. with a |
190 |
|
|
double click) and is either supposed to return false (normal |
191 |
|
|
operation), or should extend the selection itelf and return true to |
192 |
|
|
suppress the built-in processing. |
193 |
|
|
|
194 |
|
|
See the selection example extension. |
195 |
|
|
|
196 |
root |
1.1 |
on_view_change $term, $offset |
197 |
|
|
Called whenever the view offset changes, i..e the user or program |
198 |
|
|
scrolls. Offset 0 means display the normal terminal, positive values |
199 |
|
|
show this many lines of scrollback. |
200 |
|
|
|
201 |
|
|
on_scroll_back $term, $lines, $saved |
202 |
|
|
Called whenever lines scroll out of the terminal area into the |
203 |
|
|
scrollback buffer. $lines is the number of lines scrolled out and |
204 |
|
|
may be larger than the scroll back buffer or the terminal. |
205 |
|
|
|
206 |
|
|
It is called before lines are scrolled out (so rows 0 .. min ($lines |
207 |
|
|
- 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
208 |
|
|
the total number of lines that will be in the scrollback buffer. |
209 |
|
|
|
210 |
root |
1.9 |
on_osc_seq $term, $string |
211 |
|
|
Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
212 |
|
|
operating system command) is processed. Cursor position and other |
213 |
|
|
state information is up-to-date when this happens. For |
214 |
|
|
interoperability, the string should start with the extension name |
215 |
|
|
and a colon, to distinguish it from commands for other extensions, |
216 |
|
|
and this might be enforced in the future. |
217 |
|
|
|
218 |
|
|
Be careful not ever to trust (in a security sense) the data you |
219 |
|
|
receive, as its source can not easily be controleld (e-mail content, |
220 |
|
|
messages from other users on the same system etc.). |
221 |
|
|
|
222 |
root |
1.12 |
on_add_lines $term, $string |
223 |
|
|
Called whenever text is about to be output, with the text as |
224 |
|
|
argument. You can filter/change and output the text yourself by |
225 |
|
|
returning a true value and calling "$term->scr_add_lines" yourself. |
226 |
|
|
Please note that this might be very slow, however, as your hook is |
227 |
|
|
called for all text being output. |
228 |
|
|
|
229 |
root |
1.17 |
on_tt_write $term, $octets |
230 |
|
|
Called whenever some data is written to the tty/pty and can be used |
231 |
|
|
to suppress or filter tty input. |
232 |
|
|
|
233 |
root |
1.12 |
on_line_update $term, $row |
234 |
|
|
Called whenever a line was updated or changed. Can be used to filter |
235 |
|
|
screen output (e.g. underline urls or other useless stuff). Only |
236 |
|
|
lines that are being shown will be filtered, and, due to performance |
237 |
|
|
reasons, not always immediately. |
238 |
|
|
|
239 |
|
|
The row number is always the topmost row of the line if the line |
240 |
|
|
spans multiple rows. |
241 |
|
|
|
242 |
|
|
Please note that, if you change the line, then the hook might get |
243 |
|
|
called later with the already-modified line (e.g. if unrelated parts |
244 |
|
|
change), so you cannot just toggle rendition bits, but only set |
245 |
|
|
them. |
246 |
|
|
|
247 |
root |
1.1 |
on_refresh_begin $term |
248 |
|
|
Called just before the screen gets redrawn. Can be used for overlay |
249 |
|
|
or similar effects by modify terminal contents in refresh_begin, and |
250 |
|
|
restoring them in refresh_end. The built-in overlay and selection |
251 |
|
|
display code is run after this hook, and takes precedence. |
252 |
|
|
|
253 |
|
|
on_refresh_end $term |
254 |
|
|
Called just after the screen gets redrawn. See "on_refresh_begin". |
255 |
|
|
|
256 |
root |
1.3 |
on_keyboard_command $term, $string |
257 |
|
|
Called whenever the user presses a key combination that has a |
258 |
|
|
"perl:string" action bound to it (see description of the keysym |
259 |
|
|
resource in the rxvt(1) manpage). |
260 |
|
|
|
261 |
root |
1.13 |
on_focus_in $term |
262 |
|
|
Called whenever the window gets the keyboard focus, before |
263 |
|
|
rxvt-unicode does focus in processing. |
264 |
|
|
|
265 |
|
|
on_focus_out $term |
266 |
|
|
Called wheneever the window loses keyboard focus, before |
267 |
|
|
rxvt-unicode does focus out processing. |
268 |
|
|
|
269 |
root |
1.17 |
on_key_press $term, $event, $keysym, $octets |
270 |
|
|
on_key_release $term, $event, $keysym |
271 |
root |
1.12 |
on_button_press $term, $event |
272 |
|
|
on_button_release $term, $event |
273 |
|
|
on_motion_notify $term, $event |
274 |
root |
1.13 |
on_map_notify $term, $event |
275 |
|
|
on_unmap_notify $term, $event |
276 |
root |
1.12 |
Called whenever the corresponding X event is received for the |
277 |
|
|
terminal If the hook returns true, then the even will be ignored by |
278 |
|
|
rxvt-unicode. |
279 |
|
|
|
280 |
|
|
The event is a hash with most values as named by Xlib (see the |
281 |
|
|
XEvent manpage), with the additional members "row" and "col", which |
282 |
|
|
are the row and column under the mouse cursor. |
283 |
|
|
|
284 |
|
|
"on_key_press" additionally receives the string rxvt-unicode would |
285 |
|
|
output, if any, in locale-specific encoding. |
286 |
|
|
|
287 |
|
|
subwindow. |
288 |
|
|
|
289 |
root |
1.7 |
Variables in the "urxvt" Package |
290 |
root |
1.19 |
$urxvt::LIBDIR |
291 |
|
|
The rxvt-unicode library directory, where, among other things, the |
292 |
|
|
perl modules and scripts are stored. |
293 |
|
|
|
294 |
|
|
$urxvt::RESCLASS, $urxvt::RESCLASS |
295 |
|
|
The resource class and name rxvt-unicode uses to look up X |
296 |
|
|
resources. |
297 |
|
|
|
298 |
|
|
$urxvt::RXVTNAME |
299 |
|
|
The basename of the installed binaries, usually "urxvt". |
300 |
|
|
|
301 |
root |
1.7 |
$urxvt::TERM |
302 |
root |
1.12 |
The current terminal. This variable stores the current "urxvt::term" |
303 |
|
|
object, whenever a callback/hook is executing. |
304 |
root |
1.7 |
|
305 |
root |
1.1 |
Functions in the "urxvt" Package |
306 |
|
|
urxvt::fatal $errormessage |
307 |
|
|
Fatally aborts execution with the given error message. Avoid at all |
308 |
|
|
costs! The only time this is acceptable is when the terminal process |
309 |
|
|
starts up. |
310 |
|
|
|
311 |
|
|
urxvt::warn $string |
312 |
|
|
Calls "rxvt_warn" with the given string which should not include a |
313 |
|
|
newline. The module also overwrites the "warn" builtin with a |
314 |
|
|
function that calls this function. |
315 |
|
|
|
316 |
|
|
Using this function has the advantage that its output ends up in the |
317 |
|
|
correct place, e.g. on stderr of the connecting urxvtc client. |
318 |
|
|
|
319 |
root |
1.20 |
Messages have a size limit of 1023 bytes currently. |
320 |
|
|
|
321 |
root |
1.16 |
$is_safe = urxvt::safe |
322 |
|
|
Returns true when it is safe to do potentially unsafe things, such |
323 |
|
|
as evaluating perl code specified by the user. This is true when |
324 |
|
|
urxvt was started setuid or setgid. |
325 |
|
|
|
326 |
root |
1.1 |
$time = urxvt::NOW |
327 |
|
|
Returns the "current time" (as per the event loop). |
328 |
|
|
|
329 |
root |
1.13 |
urxvt::CurrentTime |
330 |
|
|
urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
331 |
|
|
Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
332 |
|
|
Button5Mask, AnyModifier |
333 |
root |
1.14 |
Various constants for use in X calls and event processing. |
334 |
root |
1.13 |
|
335 |
root |
1.6 |
RENDITION |
336 |
|
|
Rendition bitsets contain information about colour, font, font styles |
337 |
|
|
and similar information for each screen cell. |
338 |
|
|
|
339 |
|
|
The following "macros" deal with changes in rendition sets. You should |
340 |
|
|
never just create a bitset, you should always modify an existing one, as |
341 |
|
|
they contain important information required for correct operation of |
342 |
|
|
rxvt-unicode. |
343 |
|
|
|
344 |
|
|
$rend = urxvt::DEFAULT_RSTYLE |
345 |
|
|
Returns the default rendition, as used when the terminal is starting |
346 |
|
|
up or being reset. Useful as a base to start when creating |
347 |
|
|
renditions. |
348 |
|
|
|
349 |
|
|
$rend = urxvt::OVERLAY_RSTYLE |
350 |
|
|
Return the rendition mask used for overlays by default. |
351 |
|
|
|
352 |
|
|
$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
353 |
|
|
Return the bit that enabled bold, italic, blink, reverse-video and |
354 |
|
|
underline, respectively. To enable such a style, just logically OR |
355 |
|
|
it into the bitset. |
356 |
|
|
|
357 |
|
|
$foreground = urxvt::GET_BASEFG $rend |
358 |
|
|
$background = urxvt::GET_BASEBG $rend |
359 |
|
|
Return the foreground/background colour index, respectively. |
360 |
|
|
|
361 |
root |
1.19 |
$rend = urxvt::SET_FGCOLOR $rend, $new_colour |
362 |
|
|
$rend = urxvt::SET_BGCOLOR $rend, $new_colour |
363 |
root |
1.6 |
Replace the foreground/background colour in the rendition mask with |
364 |
|
|
the specified one. |
365 |
|
|
|
366 |
root |
1.19 |
$value = urxvt::GET_CUSTOM $rend |
367 |
root |
1.6 |
Return the "custom" value: Every rendition has 5 bits for use by |
368 |
|
|
extensions. They can be set and changed as you like and are |
369 |
|
|
initially zero. |
370 |
|
|
|
371 |
root |
1.19 |
$rend = urxvt::SET_CUSTOM $rend, $new_value |
372 |
root |
1.6 |
Change the custom value. |
373 |
|
|
|
374 |
root |
1.14 |
The "urxvt::anyevent" Class |
375 |
|
|
The sole purpose of this class is to deliver an interface to the |
376 |
|
|
"AnyEvent" module - any module using it will work inside urxvt without |
377 |
root |
1.19 |
further programming. The only exception is that you cannot wait on |
378 |
|
|
condition variables, but non-blocking condvar use is ok. What this means |
379 |
|
|
is that you cannot use blocking APIs, but the non-blocking variant |
380 |
|
|
should work. |
381 |
root |
1.14 |
|
382 |
root |
1.1 |
The "urxvt::term" Class |
383 |
root |
1.20 |
$term = new urxvt::term $envhashref, $rxvtname, [arg...] |
384 |
|
|
Creates a new terminal, very similar as if you had started it with |
385 |
|
|
system "$rxvtname, arg...". $envhashref must be a reference to a |
386 |
root |
1.21 |
%ENV-like hash which defines the environment of the new terminal. |
387 |
root |
1.20 |
|
388 |
root |
1.21 |
Croaks (and probably outputs an error message) if the new instance |
389 |
root |
1.20 |
couldn't be created. Returns "undef" if the new instance didn't |
390 |
|
|
initialise perl, and the terminal object otherwise. The "init" and |
391 |
|
|
"start" hooks will be called during this call. |
392 |
|
|
|
393 |
root |
1.12 |
$term->destroy |
394 |
|
|
Destroy the terminal object (close the window, free resources etc.). |
395 |
root |
1.19 |
Please note that rxvt will not exit as long as any event watchers |
396 |
|
|
(timers, io watchers) are still active. |
397 |
root |
1.12 |
|
398 |
root |
1.13 |
$isset = $term->option ($optval[, $set]) |
399 |
|
|
Returns true if the option specified by $optval is enabled, and |
400 |
|
|
optionally change it. All option values are stored by name in the |
401 |
|
|
hash %urxvt::OPTION. Options not enabled in this binary are not in |
402 |
|
|
the hash. |
403 |
|
|
|
404 |
|
|
Here is a a likely non-exhaustive list of option names, please see |
405 |
|
|
the source file /src/optinc.h to see the actual list: |
406 |
|
|
|
407 |
|
|
borderLess console cursorBlink cursorUnderline hold iconic insecure |
408 |
|
|
intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
409 |
|
|
pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
410 |
|
|
scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
411 |
|
|
secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
412 |
|
|
tripleclickwords utmpInhibit visualBell |
413 |
|
|
|
414 |
root |
1.1 |
$value = $term->resource ($name[, $newval]) |
415 |
|
|
Returns the current resource value associated with a given name and |
416 |
|
|
optionally sets a new value. Setting values is most useful in the |
417 |
|
|
"init" hook. Unset resources are returned and accepted as "undef". |
418 |
|
|
|
419 |
|
|
The new value must be properly encoded to a suitable character |
420 |
|
|
encoding before passing it to this method. Similarly, the returned |
421 |
|
|
value may need to be converted from the used encoding to text. |
422 |
|
|
|
423 |
|
|
Resource names are as defined in src/rsinc.h. Colours can be |
424 |
|
|
specified as resource names of the form "color+<index>", e.g. |
425 |
|
|
"color+5". (will likely change). |
426 |
|
|
|
427 |
|
|
Please note that resource strings will currently only be freed when |
428 |
|
|
the terminal is destroyed, so changing options frequently will eat |
429 |
|
|
memory. |
430 |
|
|
|
431 |
|
|
Here is a a likely non-exhaustive list of resource names, not all of |
432 |
root |
1.13 |
which are supported in every build, please see the source file |
433 |
|
|
/src/rsinc.h to see the actual list: |
434 |
root |
1.1 |
|
435 |
|
|
answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
436 |
|
|
borderLess color cursorBlink cursorUnderline cutchars delete_key |
437 |
|
|
display_name embed ext_bwidth fade font geometry hold iconName |
438 |
|
|
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
439 |
root |
1.2 |
italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
440 |
root |
1.10 |
mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
441 |
root |
1.1 |
perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
442 |
|
|
reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
443 |
|
|
scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
444 |
|
|
scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
445 |
|
|
shade term_name title transparent transparent_all tripleclickwords |
446 |
|
|
utmpInhibit visualBell |
447 |
|
|
|
448 |
root |
1.22 |
$value = $term->x_resource ($pattern) |
449 |
|
|
Returns the X-Resource for the given pattern, excluding the program |
450 |
|
|
or class name, i.e. "$term->x_resource ("boldFont")" should return |
451 |
|
|
the same value as used by this instance of rxvt-unicode. Returns |
452 |
|
|
"undef" if no resource with that pattern exists. |
453 |
|
|
|
454 |
|
|
This method should only be called during the "on_start" hook, as |
455 |
|
|
there is only one resource database per display, and later |
456 |
|
|
invocations might return the wrong resources. |
457 |
|
|
|
458 |
root |
1.17 |
$success = $term->parse_keysym ($keysym_spec, $command_string) |
459 |
|
|
Adds a keymap translation exactly as specified via a resource. See |
460 |
|
|
the "keysym" resource in the rxvt(1) manpage. |
461 |
|
|
|
462 |
root |
1.12 |
$rend = $term->rstyle ([$new_rstyle]) |
463 |
|
|
Return and optionally change the current rendition. Text that is |
464 |
|
|
output by the terminal application will use this style. |
465 |
root |
1.11 |
|
466 |
|
|
($row, $col) = $term->screen_cur ([$row, $col]) |
467 |
|
|
Return the current coordinates of the text cursor position and |
468 |
|
|
optionally set it (which is usually bad as applications don't expect |
469 |
|
|
that). |
470 |
|
|
|
471 |
root |
1.1 |
($row, $col) = $term->selection_mark ([$row, $col]) |
472 |
|
|
($row, $col) = $term->selection_beg ([$row, $col]) |
473 |
|
|
($row, $col) = $term->selection_end ([$row, $col]) |
474 |
|
|
Return the current values of the selection mark, begin or end |
475 |
|
|
positions, and optionally set them to new values. |
476 |
|
|
|
477 |
|
|
$success = $term->selection_grab ($eventtime) |
478 |
|
|
Try to request the primary selection from the server (for example, |
479 |
|
|
as set by the next method). |
480 |
|
|
|
481 |
|
|
$oldtext = $term->selection ([$newtext]) |
482 |
|
|
Return the current selection text and optionally replace it by |
483 |
|
|
$newtext. |
484 |
|
|
|
485 |
root |
1.17 |
$term->overlay_simple ($x, $y, $text) |
486 |
|
|
Create a simple multi-line overlay box. See the next method for |
487 |
|
|
details. |
488 |
root |
1.6 |
|
489 |
|
|
$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
490 |
root |
1.1 |
Create a new (empty) overlay at the given position with the given |
491 |
root |
1.6 |
width/height. $rstyle defines the initial rendition style (default: |
492 |
|
|
"OVERLAY_RSTYLE"). |
493 |
|
|
|
494 |
|
|
If $border is 2 (default), then a decorative border will be put |
495 |
|
|
around the box. |
496 |
|
|
|
497 |
|
|
If either $x or $y is negative, then this is counted from the |
498 |
|
|
right/bottom side, respectively. |
499 |
|
|
|
500 |
|
|
This method returns an urxvt::overlay object. The overlay will be |
501 |
|
|
visible as long as the perl object is referenced. |
502 |
root |
1.1 |
|
503 |
root |
1.7 |
The methods currently supported on "urxvt::overlay" objects are: |
504 |
root |
1.6 |
|
505 |
root |
1.7 |
$overlay->set ($x, $y, $text, $rend) |
506 |
|
|
Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts |
507 |
|
|
text in rxvt-unicode's special encoding and an array of |
508 |
|
|
rendition values at a specific position inside the overlay. |
509 |
|
|
|
510 |
|
|
$overlay->hide |
511 |
|
|
If visible, hide the overlay, but do not destroy it. |
512 |
|
|
|
513 |
|
|
$overlay->show |
514 |
|
|
If hidden, display the overlay again. |
515 |
root |
1.1 |
|
516 |
root |
1.13 |
$popup = $term->popup ($event) |
517 |
|
|
Creates a new "urxvt::popup" object that implements a popup menu. |
518 |
|
|
The $event *must* be the event causing the menu to pop up (a button |
519 |
|
|
event, currently). |
520 |
|
|
|
521 |
root |
1.12 |
$cellwidth = $term->strwidth ($string) |
522 |
root |
1.1 |
Returns the number of screen-cells this string would need. Correctly |
523 |
|
|
accounts for wide and combining characters. |
524 |
|
|
|
525 |
root |
1.12 |
$octets = $term->locale_encode ($string) |
526 |
root |
1.1 |
Convert the given text string into the corresponding locale |
527 |
|
|
encoding. |
528 |
|
|
|
529 |
root |
1.12 |
$string = $term->locale_decode ($octets) |
530 |
root |
1.1 |
Convert the given locale-encoded octets into a perl string. |
531 |
|
|
|
532 |
root |
1.17 |
$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
533 |
|
|
XORs the rendition values in the given span with the provided value |
534 |
|
|
(default: "RS_RVid"). Useful in refresh hooks to provide effects |
535 |
|
|
similar to the selection. |
536 |
|
|
|
537 |
|
|
$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
538 |
|
|
$rstyle2]]) |
539 |
|
|
Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
540 |
|
|
whitespace will additionally be xored with the $rstyle2, which |
541 |
|
|
defaults to "RS_RVid | RS_Uline", which removes reverse video again |
542 |
|
|
and underlines it instead. |
543 |
|
|
|
544 |
|
|
$term->scr_bell |
545 |
|
|
Ring the bell! |
546 |
|
|
|
547 |
root |
1.12 |
$term->scr_add_lines ($string) |
548 |
|
|
Write the given text string to the screen, as if output by the |
549 |
|
|
application running inside the terminal. It may not contain command |
550 |
|
|
sequences (escape codes), but is free to use line feeds, carriage |
551 |
|
|
returns and tabs. The string is a normal text string, not in |
552 |
|
|
locale-dependent encoding. |
553 |
|
|
|
554 |
|
|
Normally its not a good idea to use this function, as programs might |
555 |
|
|
be confused by changes in cursor position or scrolling. Its useful |
556 |
|
|
inside a "on_add_lines" hook, though. |
557 |
|
|
|
558 |
|
|
$term->cmd_parse ($octets) |
559 |
|
|
Similar to "scr_add_lines", but the argument must be in the |
560 |
|
|
locale-specific encoding of the terminal and can contain command |
561 |
|
|
sequences (escape codes) that will be interpreted. |
562 |
|
|
|
563 |
root |
1.1 |
$term->tt_write ($octets) |
564 |
|
|
Write the octets given in $data to the tty (i.e. as program input). |
565 |
root |
1.4 |
To pass characters instead of octets, you should convert your |
566 |
|
|
strings first to the locale-specific encoding using |
567 |
|
|
"$term->locale_encode". |
568 |
|
|
|
569 |
root |
1.17 |
$old_events = $term->pty_ev_events ([$new_events]) |
570 |
|
|
Replaces the event mask of the pty watcher by the given event mask. |
571 |
|
|
Can be used to suppress input and output handling to the pty/tty. |
572 |
|
|
See the description of "urxvt::timer->events". Make sure to always |
573 |
|
|
restore the previous value. |
574 |
|
|
|
575 |
root |
1.12 |
$windowid = $term->parent |
576 |
|
|
Return the window id of the toplevel window. |
577 |
|
|
|
578 |
|
|
$windowid = $term->vt |
579 |
|
|
Return the window id of the terminal window. |
580 |
|
|
|
581 |
root |
1.11 |
$window_width = $term->width |
582 |
|
|
$window_height = $term->height |
583 |
|
|
$font_width = $term->fwidth |
584 |
|
|
$font_height = $term->fheight |
585 |
|
|
$font_ascent = $term->fbase |
586 |
|
|
$terminal_rows = $term->nrow |
587 |
|
|
$terminal_columns = $term->ncol |
588 |
|
|
$has_focus = $term->focus |
589 |
|
|
$is_mapped = $term->mapped |
590 |
|
|
$max_scrollback = $term->saveLines |
591 |
|
|
$nrow_plus_saveLines = $term->total_rows |
592 |
|
|
$lines_in_scrollback = $term->nsaved |
593 |
|
|
Return various integers describing terminal characteristics. |
594 |
root |
1.4 |
|
595 |
root |
1.20 |
$x_display = $term->display_id |
596 |
|
|
Return the DISPLAY used by rxvt-unicode. |
597 |
|
|
|
598 |
root |
1.17 |
$lc_ctype = $term->locale |
599 |
|
|
Returns the LC_CTYPE category string used by this rxvt-unicode. |
600 |
|
|
|
601 |
root |
1.20 |
$env = $term->env |
602 |
|
|
Returns a copy of the environment in effect for the terminal as a |
603 |
|
|
hashref similar to "\%ENV". |
604 |
root |
1.17 |
|
605 |
root |
1.13 |
$modifiermask = $term->ModLevel3Mask |
606 |
|
|
$modifiermask = $term->ModMetaMask |
607 |
|
|
$modifiermask = $term->ModNumLockMask |
608 |
|
|
Return the modifier masks corresponding to the "ISO Level 3 Shift" |
609 |
|
|
(often AltGr), the meta key (often Alt) and the num lock key, if |
610 |
|
|
applicable. |
611 |
|
|
|
612 |
root |
1.4 |
$view_start = $term->view_start ([$newvalue]) |
613 |
|
|
Returns the negative row number of the topmost line. Minimum value |
614 |
|
|
is 0, which displays the normal terminal contents. Larger values |
615 |
|
|
scroll this many lines into the scrollback buffer. |
616 |
|
|
|
617 |
|
|
$term->want_refresh |
618 |
|
|
Requests a screen refresh. At the next opportunity, rxvt-unicode |
619 |
|
|
will compare the on-screen display with its stored representation. |
620 |
|
|
If they differ, it redraws the differences. |
621 |
|
|
|
622 |
|
|
Used after changing terminal contents to display them. |
623 |
|
|
|
624 |
|
|
$text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
625 |
|
|
Returns the text of the entire row with number $row_number. Row 0 is |
626 |
|
|
the topmost terminal line, row "$term->$ncol-1" is the bottommost |
627 |
|
|
terminal line. The scrollback buffer starts at line -1 and extends |
628 |
root |
1.7 |
to line "-$term->nsaved". Nothing will be returned if a nonexistent |
629 |
|
|
line is requested. |
630 |
root |
1.4 |
|
631 |
|
|
If $new_text is specified, it will replace characters in the current |
632 |
|
|
line, starting at column $start_col (default 0), which is useful to |
633 |
root |
1.6 |
replace only parts of a line. The font index in the rendition will |
634 |
root |
1.4 |
automatically be updated. |
635 |
|
|
|
636 |
|
|
$text is in a special encoding: tabs and wide characters that use |
637 |
|
|
more than one cell when displayed are padded with urxvt::NOCHAR |
638 |
|
|
characters ("chr 65535"). Characters with combining characters and |
639 |
|
|
other characters that do not fit into the normal tetx encoding will |
640 |
|
|
be replaced with characters in the private use area. |
641 |
|
|
|
642 |
|
|
You have to obey this encoding when changing text. The advantage is |
643 |
|
|
that "substr" and similar functions work on screen cells and not on |
644 |
|
|
characters. |
645 |
|
|
|
646 |
|
|
The methods "$term->special_encode" and "$term->special_decode" can |
647 |
|
|
be used to convert normal strings into this encoding and vice versa. |
648 |
|
|
|
649 |
|
|
$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]]) |
650 |
|
|
Like "$term->ROW_t", but returns an arrayref with rendition bitsets. |
651 |
|
|
Rendition bitsets contain information about colour, font, font |
652 |
|
|
styles and similar information. See also "$term->ROW_t". |
653 |
|
|
|
654 |
|
|
When setting rendition, the font mask will be ignored. |
655 |
|
|
|
656 |
root |
1.6 |
See the section on RENDITION, above. |
657 |
root |
1.4 |
|
658 |
|
|
$length = $term->ROW_l ($row_number[, $new_length]) |
659 |
|
|
Returns the number of screen cells that are in use ("the line |
660 |
root |
1.7 |
length"). Unlike the urxvt core, this returns "$term->ncol" if the |
661 |
|
|
line is joined with the following one. |
662 |
|
|
|
663 |
|
|
$bool = $term->is_longer ($row_number) |
664 |
|
|
Returns true if the row is part of a multiple-row logical "line" |
665 |
|
|
(i.e. joined with the following row), which means all characters are |
666 |
|
|
in use and it is continued on the next row (and possibly a |
667 |
|
|
continuation of the previous row(s)). |
668 |
|
|
|
669 |
|
|
$line = $term->line ($row_number) |
670 |
|
|
Create and return a new "urxvt::line" object that stores information |
671 |
|
|
about the logical line that row $row_number is part of. It supports |
672 |
|
|
the following methods: |
673 |
|
|
|
674 |
root |
1.12 |
$text = $line->t ([$new_text]) |
675 |
|
|
Returns or replaces the full text of the line, similar to |
676 |
|
|
"ROW_t" |
677 |
|
|
|
678 |
|
|
$rend = $line->r ([$new_rend]) |
679 |
|
|
Returns or replaces the full rendition array of the line, |
680 |
|
|
similar to "ROW_r" |
681 |
root |
1.7 |
|
682 |
|
|
$length = $line->l |
683 |
|
|
Returns the length of the line in cells, similar to "ROW_l". |
684 |
|
|
|
685 |
|
|
$rownum = $line->beg |
686 |
|
|
$rownum = $line->end |
687 |
|
|
Return the row number of the first/last row of the line, |
688 |
|
|
respectively. |
689 |
|
|
|
690 |
|
|
$offset = $line->offset_of ($row, $col) |
691 |
|
|
Returns the character offset of the given row|col pair within |
692 |
|
|
the logical line. |
693 |
|
|
|
694 |
|
|
($row, $col) = $line->coord_of ($offset) |
695 |
|
|
Translates a string offset into terminal coordinates again. |
696 |
root |
1.4 |
|
697 |
root |
1.15 |
$text = $term->special_encode $string |
698 |
root |
1.4 |
Converts a perl string into the special encoding used by |
699 |
|
|
rxvt-unicode, where one character corresponds to one screen cell. |
700 |
|
|
See "$term->ROW_t" for details. |
701 |
|
|
|
702 |
|
|
$string = $term->special_decode $text |
703 |
|
|
Converts rxvt-unicodes text reprsentation into a perl string. See |
704 |
|
|
"$term->ROW_t" for details. |
705 |
|
|
|
706 |
root |
1.15 |
$success = $term->grab_button ($button, $modifiermask) |
707 |
root |
1.16 |
Registers a synchronous button grab. See the XGrabButton manpage. |
708 |
root |
1.15 |
|
709 |
|
|
$success = $term->grab ($eventtime[, $sync]) |
710 |
|
|
Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
711 |
|
|
synchronous ($sync is true). Also remembers the grab timestampe. |
712 |
|
|
|
713 |
|
|
$term->allow_events_async |
714 |
|
|
Calls XAllowEvents with AsyncBoth for the most recent grab. |
715 |
|
|
|
716 |
|
|
$term->allow_events_sync |
717 |
|
|
Calls XAllowEvents with SyncBoth for the most recent grab. |
718 |
|
|
|
719 |
|
|
$term->allow_events_replay |
720 |
|
|
Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for |
721 |
|
|
the most recent grab. |
722 |
|
|
|
723 |
|
|
$term->ungrab |
724 |
|
|
Calls XUngrab for the most recent grab. Is called automatically on |
725 |
|
|
evaluation errors, as it is better to lose the grab in the error |
726 |
|
|
case as the session. |
727 |
|
|
|
728 |
root |
1.13 |
The "urxvt::popup" Class |
729 |
root |
1.19 |
$popup->add_title ($title) |
730 |
|
|
Adds a non-clickable title to the popup. |
731 |
|
|
|
732 |
|
|
$popup->add_separator ([$sepchr]) |
733 |
|
|
Creates a separator, optionally using the character given as |
734 |
|
|
$sepchr. |
735 |
|
|
|
736 |
|
|
$popup->add_button ($text, $cb) |
737 |
|
|
Adds a clickable button to the popup. $cb is called whenever it is |
738 |
|
|
selected. |
739 |
|
|
|
740 |
|
|
$popup->add_toggle ($text, $cb, $initial_value) |
741 |
|
|
Adds a toggle/checkbox item to the popup. Teh callback gets called |
742 |
|
|
whenever it gets toggled, with a boolean indicating its value as its |
743 |
|
|
first argument. |
744 |
|
|
|
745 |
|
|
$popup->show |
746 |
|
|
Displays the popup (which is initially hidden). |
747 |
|
|
|
748 |
root |
1.1 |
The "urxvt::timer" Class |
749 |
root |
1.21 |
This class implements timer watchers/events. Time is represented as a |
750 |
|
|
fractional number of seconds since the epoch. Example: |
751 |
root |
1.1 |
|
752 |
root |
1.21 |
$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
753 |
|
|
$term->{timer} = urxvt::timer |
754 |
|
|
->new |
755 |
|
|
->interval (1) |
756 |
|
|
->cb (sub { |
757 |
|
|
$term->{overlay}->set (0, 0, |
758 |
|
|
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
759 |
|
|
}); |
760 |
|
|
|
761 |
|
|
$timer = new urxvt::timer |
762 |
|
|
Create a new timer object in started state. It is scheduled to fire |
763 |
|
|
immediately. |
764 |
|
|
|
765 |
|
|
$timer = $timer->cb (sub { my ($timer) = @_; ... }) |
766 |
|
|
Set the callback to be called when the timer triggers. |
767 |
|
|
|
768 |
|
|
$tstamp = $timer->at |
769 |
|
|
Return the time this watcher will fire next. |
770 |
|
|
|
771 |
|
|
$timer = $timer->set ($tstamp) |
772 |
|
|
Set the time the event is generated to $tstamp. |
773 |
|
|
|
774 |
|
|
$timer = $timer->interval ($interval) |
775 |
|
|
Normally (and when $interval is 0), the timer will automatically |
776 |
|
|
stop after it has fired once. If $interval is non-zero, then the |
777 |
|
|
timer is automatically rescheduled at the given intervals. |
778 |
root |
1.6 |
|
779 |
root |
1.21 |
$timer = $timer->start |
780 |
|
|
Start the timer. |
781 |
root |
1.1 |
|
782 |
root |
1.21 |
$timer = $timer->start ($tstamp) |
783 |
|
|
Set the event trigger time to $tstamp and start the timer. |
784 |
root |
1.1 |
|
785 |
root |
1.21 |
$timer = $timer->stop |
786 |
|
|
Stop the timer. |
787 |
root |
1.1 |
|
788 |
|
|
The "urxvt::iow" Class |
789 |
root |
1.21 |
This class implements io watchers/events. Example: |
790 |
root |
1.1 |
|
791 |
root |
1.21 |
$term->{socket} = ... |
792 |
|
|
$term->{iow} = urxvt::iow |
793 |
|
|
->new |
794 |
|
|
->fd (fileno $term->{socket}) |
795 |
|
|
->events (urxvt::EVENT_READ) |
796 |
|
|
->start |
797 |
|
|
->cb (sub { |
798 |
|
|
my ($iow, $revents) = @_; |
799 |
|
|
# $revents must be 1 here, no need to check |
800 |
|
|
sysread $term->{socket}, my $buf, 8192 |
801 |
|
|
or end-of-file; |
802 |
|
|
}); |
803 |
|
|
|
804 |
|
|
$iow = new urxvt::iow |
805 |
|
|
Create a new io watcher object in stopped state. |
806 |
|
|
|
807 |
|
|
$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
808 |
|
|
Set the callback to be called when io events are triggered. |
809 |
|
|
$reventmask is a bitset as described in the "events" method. |
810 |
|
|
|
811 |
|
|
$iow = $iow->fd ($fd) |
812 |
|
|
Set the filedescriptor (not handle) to watch. |
813 |
|
|
|
814 |
|
|
$iow = $iow->events ($eventmask) |
815 |
|
|
Set the event mask to watch. The only allowed values are |
816 |
|
|
"urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed |
817 |
|
|
together, or "urxvt::EVENT_NONE". |
818 |
root |
1.1 |
|
819 |
root |
1.21 |
$iow = $iow->start |
820 |
|
|
Start watching for requested events on the given handle. |
821 |
root |
1.1 |
|
822 |
root |
1.21 |
$iow = $iow->stop |
823 |
|
|
Stop watching for events on the given filehandle. |
824 |
root |
1.1 |
|
825 |
|
|
ENVIRONMENT |
826 |
|
|
URXVT_PERL_VERBOSITY |
827 |
root |
1.21 |
This variable controls the verbosity level of the perl extension. Higher |
828 |
|
|
numbers indicate more verbose output. |
829 |
root |
1.1 |
|
830 |
root |
1.21 |
== 0 - fatal messages |
831 |
|
|
>= 3 - script loading and management |
832 |
|
|
>=10 - all events received |
833 |
root |
1.1 |
|
834 |
|
|
AUTHOR |
835 |
root |
1.21 |
Marc Lehmann <pcg@goof.com> |
836 |
|
|
http://software.schmorp.de/pkg/rxvt-unicode |
837 |
root |
1.1 |
|