… | |
… | |
30 | You can activate them like this: |
30 | You can activate them like this: |
31 | |
31 | |
32 | rxvt -pe <extensionname> |
32 | rxvt -pe <extensionname> |
33 | |
33 | |
34 | selection |
34 | selection |
35 | Miscellaneous selection modifications. |
35 | Intelligent selection. This extension tries to be more intelligent |
|
|
36 | when the user extends selections (double-click). Right now, it tries |
|
|
37 | to select urls and complete shell-quoted arguments, which is very |
|
|
38 | convenient, too, if your ls supports "--quoting-style=shell". |
|
|
39 | |
|
|
40 | It also offers the following bindable event: |
36 | |
41 | |
37 | rot13 |
42 | rot13 |
38 | Rot-13 the selection when activated. Used via keyboard trigger: |
43 | Rot-13 the selection when activated. Used via keyboard trigger: |
39 | |
44 | |
40 | URxvt.keysym.C-M-r: perl:selection:rot13 |
45 | URxvt.keysym.C-M-r: perl:selection:rot13 |
41 | |
46 | |
42 | digital-clock |
47 | digital-clock |
|
|
48 | Displays a digital clock using the built-in overlay. |
|
|
49 | |
|
|
50 | example-refresh-hooks |
43 | Displays a very simple digital clock in the upper right corner of |
51 | Displays a very simple digital clock in the upper right corner of |
44 | the window. Illustrates overwriting the refresh callbacks to create |
52 | the window. Illustrates overwriting the refresh callbacks to create |
45 | your own overlays or changes. |
53 | your own overlays or changes. |
46 | |
|
|
47 | simple-overlay-clock |
|
|
48 | Displays a digital clock using the built-in overlay (colorful, |
|
|
49 | useless). |
|
|
50 | |
54 | |
51 | General API Considerations |
55 | General API Considerations |
52 | All objects (such as terminals, time watchers etc.) are typical |
56 | All objects (such as terminals, time watchers etc.) are typical |
53 | reference-to-hash objects. The hash can be used to store anything you |
57 | reference-to-hash objects. The hash can be used to store anything you |
54 | like. All members starting with an underscore (such as "_ptr" or |
58 | like. All members starting with an underscore (such as "_ptr" or |
55 | "_hook") are reserved for internal uses and must not be accessed or |
59 | "_hook") are reserved for internal uses and MUST NOT be accessed or |
56 | modified). |
60 | modified). |
57 | |
61 | |
58 | When objects are destroyed on the C++ side, the perl object hashes are |
62 | When objects are destroyed on the C++ side, the perl object hashes are |
59 | emptied, so its best to store related objects such as time watchers and |
63 | emptied, so its best to store related objects such as time watchers and |
60 | the like inside the terminal object so they get destroyed as soon as the |
64 | the like inside the terminal object so they get destroyed as soon as the |
… | |
… | |
62 | |
66 | |
63 | Hooks |
67 | Hooks |
64 | The following subroutines can be declared in loaded scripts, and will be |
68 | The following subroutines can be declared in loaded scripts, and will be |
65 | called whenever the relevant event happens. |
69 | called whenever the relevant event happens. |
66 | |
70 | |
|
|
71 | The first argument passed to them is an object private to each terminal |
|
|
72 | and extension package. You can call all "urxvt::term" methods on it, but |
|
|
73 | its not a real "urxvt::term" object. Instead, the real "urxvt::term" |
|
|
74 | object that is shared between all packages is stored in the "term" |
|
|
75 | member. |
|
|
76 | |
67 | All of them must return a boolean value. If it is true, then the event |
77 | All of them must return a boolean value. If it is true, then the event |
68 | counts as being *consumed*, and the invocation of other hooks is |
78 | counts as being *consumed*, and the invocation of other hooks is |
69 | skipped, and the relevant action might not be carried out by the C++ |
79 | skipped, and the relevant action might not be carried out by the C++ |
70 | code. |
80 | code. |
71 | |
81 | |
… | |
… | |
99 | queried and changed by calling "$term->selection". |
109 | queried and changed by calling "$term->selection". |
100 | |
110 | |
101 | Returning a true value aborts selection grabbing. It will still be |
111 | Returning a true value aborts selection grabbing. It will still be |
102 | hilighted. |
112 | hilighted. |
103 | |
113 | |
|
|
114 | on_sel_extend $term |
|
|
115 | Called whenever the user tries to extend the selection (e.g. with a |
|
|
116 | double click) and is either supposed to return false (normal |
|
|
117 | operation), or should extend the selection itelf and return true to |
|
|
118 | suppress the built-in processing. |
|
|
119 | |
|
|
120 | See the selection example extension. |
|
|
121 | |
104 | on_focus_in $term |
122 | on_focus_in $term |
105 | Called whenever the window gets the keyboard focus, before urxvt |
123 | Called whenever the window gets the keyboard focus, before urxvt |
106 | does focus in processing. |
124 | does focus in processing. |
107 | |
125 | |
108 | on_focus_out $term |
126 | on_focus_out $term |
… | |
… | |
124 | the total number of lines that will be in the scrollback buffer. |
142 | the total number of lines that will be in the scrollback buffer. |
125 | |
143 | |
126 | on_tty_activity $term *NYI* |
144 | on_tty_activity $term *NYI* |
127 | Called whenever the program(s) running in the urxvt window send |
145 | Called whenever the program(s) running in the urxvt window send |
128 | output. |
146 | output. |
|
|
147 | |
|
|
148 | on_osc_seq $term, $string |
|
|
149 | Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
|
|
150 | operating system command) is processed. Cursor position and other |
|
|
151 | state information is up-to-date when this happens. For |
|
|
152 | interoperability, the string should start with the extension name |
|
|
153 | and a colon, to distinguish it from commands for other extensions, |
|
|
154 | and this might be enforced in the future. |
|
|
155 | |
|
|
156 | Be careful not ever to trust (in a security sense) the data you |
|
|
157 | receive, as its source can not easily be controleld (e-mail content, |
|
|
158 | messages from other users on the same system etc.). |
129 | |
159 | |
130 | on_refresh_begin $term |
160 | on_refresh_begin $term |
131 | Called just before the screen gets redrawn. Can be used for overlay |
161 | Called just before the screen gets redrawn. Can be used for overlay |
132 | or similar effects by modify terminal contents in refresh_begin, and |
162 | or similar effects by modify terminal contents in refresh_begin, and |
133 | restoring them in refresh_end. The built-in overlay and selection |
163 | restoring them in refresh_end. The built-in overlay and selection |
… | |
… | |
139 | on_keyboard_command $term, $string |
169 | on_keyboard_command $term, $string |
140 | Called whenever the user presses a key combination that has a |
170 | Called whenever the user presses a key combination that has a |
141 | "perl:string" action bound to it (see description of the keysym |
171 | "perl:string" action bound to it (see description of the keysym |
142 | resource in the rxvt(1) manpage). |
172 | resource in the rxvt(1) manpage). |
143 | |
173 | |
|
|
174 | Variables in the "urxvt" Package |
|
|
175 | $urxvt::TERM |
|
|
176 | The current terminal. Whenever a callback/Hook is bein executed, |
|
|
177 | this variable stores the current "urxvt::term" object. |
|
|
178 | |
144 | Functions in the "urxvt" Package |
179 | Functions in the "urxvt" Package |
145 | urxvt::fatal $errormessage |
180 | urxvt::fatal $errormessage |
146 | Fatally aborts execution with the given error message. Avoid at all |
181 | Fatally aborts execution with the given error message. Avoid at all |
147 | costs! The only time this is acceptable is when the terminal process |
182 | costs! The only time this is acceptable is when the terminal process |
148 | starts up. |
183 | starts up. |
… | |
… | |
155 | Using this function has the advantage that its output ends up in the |
190 | Using this function has the advantage that its output ends up in the |
156 | correct place, e.g. on stderr of the connecting urxvtc client. |
191 | correct place, e.g. on stderr of the connecting urxvtc client. |
157 | |
192 | |
158 | $time = urxvt::NOW |
193 | $time = urxvt::NOW |
159 | Returns the "current time" (as per the event loop). |
194 | Returns the "current time" (as per the event loop). |
|
|
195 | |
|
|
196 | RENDITION |
|
|
197 | Rendition bitsets contain information about colour, font, font styles |
|
|
198 | and similar information for each screen cell. |
|
|
199 | |
|
|
200 | The following "macros" deal with changes in rendition sets. You should |
|
|
201 | never just create a bitset, you should always modify an existing one, as |
|
|
202 | they contain important information required for correct operation of |
|
|
203 | rxvt-unicode. |
|
|
204 | |
|
|
205 | $rend = urxvt::DEFAULT_RSTYLE |
|
|
206 | Returns the default rendition, as used when the terminal is starting |
|
|
207 | up or being reset. Useful as a base to start when creating |
|
|
208 | renditions. |
|
|
209 | |
|
|
210 | $rend = urxvt::OVERLAY_RSTYLE |
|
|
211 | Return the rendition mask used for overlays by default. |
|
|
212 | |
|
|
213 | $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
|
|
214 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
215 | underline, respectively. To enable such a style, just logically OR |
|
|
216 | it into the bitset. |
|
|
217 | |
|
|
218 | $foreground = urxvt::GET_BASEFG $rend |
|
|
219 | $background = urxvt::GET_BASEBG $rend |
|
|
220 | Return the foreground/background colour index, respectively. |
|
|
221 | |
|
|
222 | $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
|
|
223 | $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
|
|
224 | Replace the foreground/background colour in the rendition mask with |
|
|
225 | the specified one. |
|
|
226 | |
|
|
227 | $value = urxvt::GET_CUSTOM ($rend) |
|
|
228 | Return the "custom" value: Every rendition has 5 bits for use by |
|
|
229 | extensions. They can be set and changed as you like and are |
|
|
230 | initially zero. |
|
|
231 | |
|
|
232 | $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
|
|
233 | Change the custom value. |
160 | |
234 | |
161 | The "urxvt::term" Class |
235 | The "urxvt::term" Class |
162 | $value = $term->resource ($name[, $newval]) |
236 | $value = $term->resource ($name[, $newval]) |
163 | Returns the current resource value associated with a given name and |
237 | Returns the current resource value associated with a given name and |
164 | optionally sets a new value. Setting values is most useful in the |
238 | optionally sets a new value. Setting values is most useful in the |
… | |
… | |
205 | |
279 | |
206 | $oldtext = $term->selection ([$newtext]) |
280 | $oldtext = $term->selection ([$newtext]) |
207 | Return the current selection text and optionally replace it by |
281 | Return the current selection text and optionally replace it by |
208 | $newtext. |
282 | $newtext. |
209 | |
283 | |
210 | $term->scr_overlay ($x, $y, $text) |
284 | #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line |
211 | Create a simple multi-line overlay box. See the next method for |
285 | overlay box. See the next method for details. # #=cut |
212 | details. |
|
|
213 | |
286 | |
214 | $term->scr_overlay_new ($x, $y, $width, $height) |
287 | sub urxvt::term::scr_overlay { die; my ($self, $x, $y, $text) = @_; |
|
|
288 | |
|
|
289 | my @lines = split /\n/, $text; |
|
|
290 | |
|
|
291 | my $w = 0; |
|
|
292 | for (map $self->strwidth ($_), @lines) { |
|
|
293 | $w = $_ if $w < $_; |
|
|
294 | } |
|
|
295 | |
|
|
296 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
297 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
298 | } |
|
|
299 | |
|
|
300 | $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
215 | Create a new (empty) overlay at the given position with the given |
301 | Create a new (empty) overlay at the given position with the given |
216 | width/height. A border will be put around the box. If either $x or |
302 | width/height. $rstyle defines the initial rendition style (default: |
|
|
303 | "OVERLAY_RSTYLE"). |
|
|
304 | |
|
|
305 | If $border is 2 (default), then a decorative border will be put |
|
|
306 | around the box. |
|
|
307 | |
217 | $y is negative, then this is counted from the right/bottom side, |
308 | If either $x or $y is negative, then this is counted from the |
218 | respectively. |
309 | right/bottom side, respectively. |
219 | |
310 | |
220 | $term->scr_overlay_off |
311 | This method returns an urxvt::overlay object. The overlay will be |
221 | Switch the overlay off again. |
312 | visible as long as the perl object is referenced. |
222 | |
313 | |
223 | $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE) |
314 | The methods currently supported on "urxvt::overlay" objects are: |
224 | Put a single character (specified numerically) at the given overlay |
|
|
225 | position. |
|
|
226 | |
315 | |
227 | $term->scr_overlay_set ($x, $y, $text) |
316 | $overlay->set ($x, $y, $text, $rend) |
228 | Write a string at the given position into the overlay. |
317 | Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts |
|
|
318 | text in rxvt-unicode's special encoding and an array of |
|
|
319 | rendition values at a specific position inside the overlay. |
|
|
320 | |
|
|
321 | $overlay->hide |
|
|
322 | If visible, hide the overlay, but do not destroy it. |
|
|
323 | |
|
|
324 | $overlay->show |
|
|
325 | If hidden, display the overlay again. |
229 | |
326 | |
230 | $cellwidth = $term->strwidth $string |
327 | $cellwidth = $term->strwidth $string |
231 | Returns the number of screen-cells this string would need. Correctly |
328 | Returns the number of screen-cells this string would need. Correctly |
232 | accounts for wide and combining characters. |
329 | accounts for wide and combining characters. |
233 | |
330 | |
… | |
… | |
266 | |
363 | |
267 | $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
364 | $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
268 | Returns the text of the entire row with number $row_number. Row 0 is |
365 | Returns the text of the entire row with number $row_number. Row 0 is |
269 | the topmost terminal line, row "$term->$ncol-1" is the bottommost |
366 | the topmost terminal line, row "$term->$ncol-1" is the bottommost |
270 | terminal line. The scrollback buffer starts at line -1 and extends |
367 | terminal line. The scrollback buffer starts at line -1 and extends |
271 | to line "-$term->nsaved". |
368 | to line "-$term->nsaved". Nothing will be returned if a nonexistent |
|
|
369 | line is requested. |
272 | |
370 | |
273 | If $new_text is specified, it will replace characters in the current |
371 | If $new_text is specified, it will replace characters in the current |
274 | line, starting at column $start_col (default 0), which is useful to |
372 | line, starting at column $start_col (default 0), which is useful to |
275 | replace only parts of a line. The font iindex in the rendition will |
373 | replace only parts of a line. The font index in the rendition will |
276 | automatically be updated. |
374 | automatically be updated. |
277 | |
375 | |
278 | $text is in a special encoding: tabs and wide characters that use |
376 | $text is in a special encoding: tabs and wide characters that use |
279 | more than one cell when displayed are padded with urxvt::NOCHAR |
377 | more than one cell when displayed are padded with urxvt::NOCHAR |
280 | characters ("chr 65535"). Characters with combining characters and |
378 | characters ("chr 65535"). Characters with combining characters and |
… | |
… | |
293 | Rendition bitsets contain information about colour, font, font |
391 | Rendition bitsets contain information about colour, font, font |
294 | styles and similar information. See also "$term->ROW_t". |
392 | styles and similar information. See also "$term->ROW_t". |
295 | |
393 | |
296 | When setting rendition, the font mask will be ignored. |
394 | When setting rendition, the font mask will be ignored. |
297 | |
395 | |
298 | See the section on RENDITION, below. |
396 | See the section on RENDITION, above. |
299 | |
397 | |
300 | $length = $term->ROW_l ($row_number[, $new_length]) |
398 | $length = $term->ROW_l ($row_number[, $new_length]) |
301 | Returns the number of screen cells that are in use ("the line |
399 | Returns the number of screen cells that are in use ("the line |
302 | length"). If it is -1, then the line is part of a multiple-row |
400 | length"). Unlike the urxvt core, this returns "$term->ncol" if the |
303 | logical "line", which means all characters are in use and it is |
401 | line is joined with the following one. |
304 | continued on the next row. |
|
|
305 | |
402 | |
|
|
403 | $bool = $term->is_longer ($row_number) |
|
|
404 | Returns true if the row is part of a multiple-row logical "line" |
|
|
405 | (i.e. joined with the following row), which means all characters are |
|
|
406 | in use and it is continued on the next row (and possibly a |
|
|
407 | continuation of the previous row(s)). |
|
|
408 | |
|
|
409 | $line = $term->line ($row_number) |
|
|
410 | Create and return a new "urxvt::line" object that stores information |
|
|
411 | about the logical line that row $row_number is part of. It supports |
|
|
412 | the following methods: |
|
|
413 | |
|
|
414 | $text = $line->t |
|
|
415 | Returns the full text of the line, similar to "ROW_t" |
|
|
416 | |
|
|
417 | $rend = $line->r |
|
|
418 | Returns the full rendition array of the line, similar to "ROW_r" |
|
|
419 | |
|
|
420 | $length = $line->l |
|
|
421 | Returns the length of the line in cells, similar to "ROW_l". |
|
|
422 | |
|
|
423 | $rownum = $line->beg |
|
|
424 | $rownum = $line->end |
|
|
425 | Return the row number of the first/last row of the line, |
|
|
426 | respectively. |
|
|
427 | |
|
|
428 | $offset = $line->offset_of ($row, $col) |
|
|
429 | Returns the character offset of the given row|col pair within |
|
|
430 | the logical line. |
|
|
431 | |
|
|
432 | ($row, $col) = $line->coord_of ($offset) |
|
|
433 | Translates a string offset into terminal coordinates again. |
|
|
434 | |
|
|
435 | ($row, $col) = $line->coord_of ($offset) =item $text = |
306 | $text = $term->special_encode $string |
436 | $term->special_encode $string |
307 | Converts a perl string into the special encoding used by |
437 | Converts a perl string into the special encoding used by |
308 | rxvt-unicode, where one character corresponds to one screen cell. |
438 | rxvt-unicode, where one character corresponds to one screen cell. |
309 | See "$term->ROW_t" for details. |
439 | See "$term->ROW_t" for details. |
310 | |
440 | |
311 | $string = $term->special_decode $text |
441 | $string = $term->special_decode $text |
312 | Converts rxvt-unicodes text reprsentation into a perl string. See |
442 | Converts rxvt-unicodes text reprsentation into a perl string. See |
313 | "$term->ROW_t" for details. |
443 | "$term->ROW_t" for details. |
314 | |
444 | |
315 | RENDITION |
|
|
316 | Rendition bitsets contain information about colour, font, font styles |
|
|
317 | and similar information for each screen cell. |
|
|
318 | |
|
|
319 | The following "macros" deal with changes in rendition sets. You should |
|
|
320 | never just create a bitset, you should always modify an existing one, as |
|
|
321 | they contain important information required for correct operation of |
|
|
322 | rxvt-unicode. |
|
|
323 | |
|
|
324 | $rend = urxvt::DEFAULT_RSTYLE |
|
|
325 | Returns the default rendition, as used when the terminal is starting |
|
|
326 | up or being reset. Useful as a base |
|
|
327 | |
|
|
328 | The "urxvt::timer" Class |
445 | The "urxvt::timer" Class |
329 | This class implements timer watchers/events. Time is represented as a |
446 | This class implements timer watchers/events. Time is represented as a |
330 | fractional number of seconds since the epoch. Example: |
447 | fractional number of seconds since the epoch. Example: |
331 | |
448 | |
332 | # create a digital clock display in upper right corner |
449 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
333 | $term->{timer} = urxvt::timer |
450 | $term->{timer} = urxvt::timer |
334 | ->new |
451 | ->new |
335 | ->start (urxvt::NOW) |
452 | ->interval (1) |
336 | ->cb (sub { |
453 | ->cb (sub { |
337 | my ($timer) = @_; |
|
|
338 | my $time = $timer->at; |
|
|
339 | $timer->start ($time + 1); |
|
|
340 | $self->scr_overlay (-1, 0, |
454 | $term->{overlay}->set (0, 0, |
341 | POSIX::strftime "%H:%M:%S", localtime $time); |
455 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
342 | }); |
456 | }); |
343 | |
457 | |
344 | $timer = new urxvt::timer |
458 | $timer = new urxvt::timer |
345 | Create a new timer object in stopped state. |
459 | Create a new timer object in started state. It is scheduled to fire |
|
|
460 | immediately. |
346 | |
461 | |
347 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
462 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
348 | Set the callback to be called when the timer triggers. |
463 | Set the callback to be called when the timer triggers. |
349 | |
464 | |
350 | $tstamp = $timer->at |
465 | $tstamp = $timer->at |
351 | Return the time this watcher will fire next. |
466 | Return the time this watcher will fire next. |
352 | |
467 | |
353 | $timer = $timer->set ($tstamp) |
468 | $timer = $timer->set ($tstamp) |
354 | Set the time the event is generated to $tstamp. |
469 | Set the time the event is generated to $tstamp. |
|
|
470 | |
|
|
471 | $timer = $timer->interval ($interval) |
|
|
472 | Normally (and when $interval is 0), the timer will automatically |
|
|
473 | stop after it has fired once. If $interval is non-zero, then the |
|
|
474 | timer is automatically rescheduled at the given intervals. |
355 | |
475 | |
356 | $timer = $timer->start |
476 | $timer = $timer->start |
357 | Start the timer. |
477 | Start the timer. |
358 | |
478 | |
359 | $timer = $timer->start ($tstamp) |
479 | $timer = $timer->start ($tstamp) |
… | |
… | |
401 | ENVIRONMENT |
521 | ENVIRONMENT |
402 | URXVT_PERL_VERBOSITY |
522 | URXVT_PERL_VERBOSITY |
403 | This variable controls the verbosity level of the perl extension. Higher |
523 | This variable controls the verbosity level of the perl extension. Higher |
404 | numbers indicate more verbose output. |
524 | numbers indicate more verbose output. |
405 | |
525 | |
406 | 0 - only fatal messages |
526 | =0 - only fatal messages |
407 | 3 - script loading and management |
527 | =3 - script loading and management |
408 | 10 - all events received |
528 | =10 - all events received |
409 | |
529 | |
410 | AUTHOR |
530 | AUTHOR |
411 | Marc Lehmann <pcg@goof.com> |
531 | Marc Lehmann <pcg@goof.com> |
412 | http://software.schmorp.de/pkg/rxvt-unicode |
532 | http://software.schmorp.de/pkg/rxvt-unicode |
413 | |
533 | |