… | |
… | |
21 | thus must be encoded as UTF-8. |
21 | thus must be encoded as UTF-8. |
22 | |
22 | |
23 | Each script will only ever be loaded once, even in rxvtd, where scripts |
23 | Each script will only ever be loaded once, even in rxvtd, where scripts |
24 | will be shared (but not enabled) for all terminals. |
24 | will be shared (but not enabled) for all terminals. |
25 | |
25 | |
26 | Prepackaged Extensions |
26 | PREPACKAGED EXTENSIONS |
27 | This section describes the extensiosn delivered with this version. You |
27 | This section describes the extensions delivered with this release. You |
28 | can find them in /opt/rxvt/lib/urxvt/perl/. |
28 | can find them in /opt/rxvt/lib/urxvt/perl/. |
29 | |
29 | |
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 (enabled by default) |
34 | selection (enabled by default) |
35 | Intelligent selection. This extension tries to be more intelligent |
35 | (More) intelligent selection. This extension tries to be more |
36 | when the user extends selections (double-click). Right now, it tries |
36 | intelligent when the user extends selections (double-click and |
37 | to select urls and complete shell-quoted arguments, which is very |
37 | further clicks). Right now, it tries to select words, urls and |
|
|
38 | complete shell-quoted arguments, which is very convenient, too, if |
38 | convenient, too, if your ls supports "--quoting-style=shell". |
39 | your ls supports "--quoting-style=shell". |
39 | |
40 | |
|
|
41 | A double-click usually selects the word under the cursor, further |
|
|
42 | clicks will enlarge the selection. |
|
|
43 | |
40 | It also offers the following bindable event: |
44 | It also offers the following bindable keyboard command: |
41 | |
45 | |
42 | rot13 |
46 | rot13 |
43 | Rot-13 the selection when activated. Used via keyboard trigger: |
47 | Rot-13 the selection when activated. Used via keyboard trigger: |
44 | |
48 | |
45 | URxvt.keysym.C-M-r: perl:selection:rot13 |
49 | URxvt.keysym.C-M-r: perl:selection:rot13 |
… | |
… | |
48 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
52 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
49 | options at runtime. |
53 | options at runtime. |
50 | |
54 | |
51 | selection-popup (enabled by default) |
55 | selection-popup (enabled by default) |
52 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
56 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
53 | selection text into various other formats/action. |
57 | selection text into various other formats/action (such as uri |
|
|
58 | unescaping, perl evalution, web-browser starting etc.), depending on |
|
|
59 | content. |
54 | |
60 | |
55 | searchable-scrollback<hotkey> (enabled by default) |
61 | searchable-scrollback<hotkey> (enabled by default) |
56 | Adds regex search functionality to the scrollback buffer, triggered |
62 | Adds regex search functionality to the scrollback buffer, triggered |
57 | by a hotkey (default: "M-s"). When in search mode, normal terminal |
63 | by a hotkey (default: "M-s"). While in search mode, normal terminal |
58 | input/output is suspended. |
64 | input/output is suspended and a regex is displayed at the bottom of |
|
|
65 | the screen. |
59 | |
66 | |
60 | "/" starts an incremental regex search, "n" searches further, "p" or |
67 | Inputting characters appends them to the regex and continues |
61 | "N" jump to the previous match, "G" jumps to the bottom and clears |
68 | incremental search. "BackSpace" removes a character from the regex, |
62 | the history, "enter" leaves search mode at the current position and |
69 | "Up" and "Down" search upwards/downwards in the scrollback buffer, |
63 | "escape" returns to the original position. |
70 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
|
|
71 | to the point where search was started, while "Enter" or "Return" |
|
|
72 | stay at the current position and additionally stores the first match |
|
|
73 | in the current line into the primary selection. |
64 | |
74 | |
65 | digital-clock |
75 | digital-clock |
66 | Displays a digital clock using the built-in overlay. |
76 | Displays a digital clock using the built-in overlay. |
67 | |
77 | |
68 | mark-urls |
78 | mark-urls |
69 | Uses per-line display filtering ("on_line_update") to underline |
79 | Uses per-line display filtering ("on_line_update") to underline urls |
70 | urls. |
80 | and make them clickable. When middle-clicked, the program specified |
|
|
81 | in the resource "urlLauncher" (default "x-www-browser") will be |
|
|
82 | started with the URL as first argument. |
71 | |
83 | |
72 | block-graphics-to-ascii |
84 | block-graphics-to-ascii |
73 | A not very useful example of filtering all text output to the |
85 | A not very useful example of filtering all text output to the |
74 | terminal, by replacing all line-drawing characters (U+2500 .. |
86 | terminal, by replacing all line-drawing characters (U+2500 .. |
75 | U+259F) by a similar-looking ascii character. |
87 | U+259F) by a similar-looking ascii character. |
… | |
… | |
77 | example-refresh-hooks |
89 | example-refresh-hooks |
78 | Displays a very simple digital clock in the upper right corner of |
90 | Displays a very simple digital clock in the upper right corner of |
79 | the window. Illustrates overwriting the refresh callbacks to create |
91 | the window. Illustrates overwriting the refresh callbacks to create |
80 | your own overlays or changes. |
92 | your own overlays or changes. |
81 | |
93 | |
|
|
94 | API DOCUMENTATION |
82 | General API Considerations |
95 | General API Considerations |
83 | All objects (such as terminals, time watchers etc.) are typical |
96 | All objects (such as terminals, time watchers etc.) are typical |
84 | reference-to-hash objects. The hash can be used to store anything you |
97 | reference-to-hash objects. The hash can be used to store anything you |
85 | like. All members starting with an underscore (such as "_ptr" or |
98 | like. All members starting with an underscore (such as "_ptr" or |
86 | "_hook") are reserved for internal uses and MUST NOT be accessed or |
99 | "_hook") are reserved for internal uses and MUST NOT be accessed or |
… | |
… | |
94 | Argument names also often indicate the type of a parameter. Here are |
107 | Argument names also often indicate the type of a parameter. Here are |
95 | some hints on what they mean: |
108 | some hints on what they mean: |
96 | |
109 | |
97 | $text |
110 | $text |
98 | Rxvt-unicodes special way of encoding text, where one "unicode" |
111 | Rxvt-unicodes special way of encoding text, where one "unicode" |
99 | character always represents one screen cell. See row_t for a |
112 | character always represents one screen cell. See ROW_t for a |
100 | discussion of this format. |
113 | discussion of this format. |
101 | |
114 | |
102 | $string |
115 | $string |
103 | A perl text string, with an emphasis on *text*. It can store all |
116 | A perl text string, with an emphasis on *text*. It can store all |
104 | unicode characters and is to be distinguished with text encoded in a |
117 | unicode characters and is to be distinguished with text encoded in a |
… | |
… | |
182 | |
195 | |
183 | on_sel_extend $term |
196 | on_sel_extend $term |
184 | Called whenever the user tries to extend the selection (e.g. with a |
197 | Called whenever the user tries to extend the selection (e.g. with a |
185 | double click) and is either supposed to return false (normal |
198 | double click) and is either supposed to return false (normal |
186 | operation), or should extend the selection itelf and return true to |
199 | operation), or should extend the selection itelf and return true to |
187 | suppress the built-in processing. |
200 | suppress the built-in processing. This can happen multiple times, as |
|
|
201 | long as the callback returns true, it will be called on every |
|
|
202 | further click by the user and is supposed to enlarge the selection |
|
|
203 | more and more, if possible. |
188 | |
204 | |
189 | See the selection example extension. |
205 | See the selection example extension. |
190 | |
206 | |
191 | on_view_change $term, $offset |
207 | on_view_change $term, $offset |
192 | Called whenever the view offset changes, i..e the user or program |
208 | Called whenever the view offset changes, i..e the user or program |
… | |
… | |
280 | output, if any, in locale-specific encoding. |
296 | output, if any, in locale-specific encoding. |
281 | |
297 | |
282 | subwindow. |
298 | subwindow. |
283 | |
299 | |
284 | Variables in the "urxvt" Package |
300 | Variables in the "urxvt" Package |
|
|
301 | $urxvt::LIBDIR |
|
|
302 | The rxvt-unicode library directory, where, among other things, the |
|
|
303 | perl modules and scripts are stored. |
|
|
304 | |
|
|
305 | $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
306 | The resource class and name rxvt-unicode uses to look up X |
|
|
307 | resources. |
|
|
308 | |
|
|
309 | $urxvt::RXVTNAME |
|
|
310 | The basename of the installed binaries, usually "urxvt". |
|
|
311 | |
285 | $urxvt::TERM |
312 | $urxvt::TERM |
286 | The current terminal. This variable stores the current "urxvt::term" |
313 | The current terminal. This variable stores the current "urxvt::term" |
287 | object, whenever a callback/hook is executing. |
314 | object, whenever a callback/hook is executing. |
288 | |
315 | |
289 | Functions in the "urxvt" Package |
316 | Functions in the "urxvt" Package |
290 | $term = new urxvt [arg...] |
|
|
291 | Creates a new terminal, very similar as if you had started it with |
|
|
292 | "system $binfile, arg...". Croaks (and probably outputs an error |
|
|
293 | message) if the new instance couldn't be created. Returns "undef" if |
|
|
294 | the new instance didn't initialise perl, and the terminal object |
|
|
295 | otherwise. The "init" and "start" hooks will be called during the |
|
|
296 | call. |
|
|
297 | |
|
|
298 | urxvt::fatal $errormessage |
317 | urxvt::fatal $errormessage |
299 | Fatally aborts execution with the given error message. Avoid at all |
318 | Fatally aborts execution with the given error message. Avoid at all |
300 | costs! The only time this is acceptable is when the terminal process |
319 | costs! The only time this is acceptable is when the terminal process |
301 | starts up. |
320 | starts up. |
302 | |
321 | |
… | |
… | |
305 | newline. The module also overwrites the "warn" builtin with a |
324 | newline. The module also overwrites the "warn" builtin with a |
306 | function that calls this function. |
325 | function that calls this function. |
307 | |
326 | |
308 | Using this function has the advantage that its output ends up in the |
327 | Using this function has the advantage that its output ends up in the |
309 | correct place, e.g. on stderr of the connecting urxvtc client. |
328 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
329 | |
|
|
330 | Messages have a size limit of 1023 bytes currently. |
310 | |
331 | |
311 | $is_safe = urxvt::safe |
332 | $is_safe = urxvt::safe |
312 | Returns true when it is safe to do potentially unsafe things, such |
333 | Returns true when it is safe to do potentially unsafe things, such |
313 | as evaluating perl code specified by the user. This is true when |
334 | as evaluating perl code specified by the user. This is true when |
314 | urxvt was started setuid or setgid. |
335 | urxvt was started setuid or setgid. |
… | |
… | |
346 | |
367 | |
347 | $foreground = urxvt::GET_BASEFG $rend |
368 | $foreground = urxvt::GET_BASEFG $rend |
348 | $background = urxvt::GET_BASEBG $rend |
369 | $background = urxvt::GET_BASEBG $rend |
349 | Return the foreground/background colour index, respectively. |
370 | Return the foreground/background colour index, respectively. |
350 | |
371 | |
351 | $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
372 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
352 | $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
373 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
353 | Replace the foreground/background colour in the rendition mask with |
374 | Replace the foreground/background colour in the rendition mask with |
354 | the specified one. |
375 | the specified one. |
355 | |
376 | |
356 | $value = urxvt::GET_CUSTOM ($rend) |
377 | $value = urxvt::GET_CUSTOM $rend |
357 | Return the "custom" value: Every rendition has 5 bits for use by |
378 | Return the "custom" value: Every rendition has 5 bits for use by |
358 | extensions. They can be set and changed as you like and are |
379 | extensions. They can be set and changed as you like and are |
359 | initially zero. |
380 | initially zero. |
360 | |
381 | |
361 | $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
382 | $rend = urxvt::SET_CUSTOM $rend, $new_value |
362 | Change the custom value. |
383 | Change the custom value. |
363 | |
384 | |
364 | The "urxvt::anyevent" Class |
385 | The "urxvt::anyevent" Class |
365 | The sole purpose of this class is to deliver an interface to the |
386 | The sole purpose of this class is to deliver an interface to the |
366 | "AnyEvent" module - any module using it will work inside urxvt without |
387 | "AnyEvent" module - any module using it will work inside urxvt without |
367 | further work. The only exception is that you cannot wait on condition |
388 | further programming. The only exception is that you cannot wait on |
368 | variables, but non-blocking condvar use is ok. What this means is that |
389 | condition variables, but non-blocking condvar use is ok. What this means |
369 | you cannot use blocking APIs, but the non-blocking variant should work. |
390 | is that you cannot use blocking APIs, but the non-blocking variant |
|
|
391 | should work. |
370 | |
392 | |
371 | The "urxvt::term" Class |
393 | The "urxvt::term" Class |
|
|
394 | $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
395 | Creates a new terminal, very similar as if you had started it with |
|
|
396 | system "$rxvtname, arg...". $envhashref must be a reference to a |
|
|
397 | %ENV-like hash which defines the environment of the new terminal. |
|
|
398 | |
|
|
399 | Croaks (and probably outputs an error message) if the new instance |
|
|
400 | couldn't be created. Returns "undef" if the new instance didn't |
|
|
401 | initialise perl, and the terminal object otherwise. The "init" and |
|
|
402 | "start" hooks will be called during this call. |
|
|
403 | |
372 | $term->destroy |
404 | $term->destroy |
373 | Destroy the terminal object (close the window, free resources etc.). |
405 | Destroy the terminal object (close the window, free resources etc.). |
|
|
406 | Please note that rxvt will not exit as long as any event watchers |
|
|
407 | (timers, io watchers) are still active. |
374 | |
408 | |
375 | $isset = $term->option ($optval[, $set]) |
409 | $isset = $term->option ($optval[, $set]) |
376 | Returns true if the option specified by $optval is enabled, and |
410 | Returns true if the option specified by $optval is enabled, and |
377 | optionally change it. All option values are stored by name in the |
411 | optionally change it. All option values are stored by name in the |
378 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
412 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
… | |
… | |
420 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
454 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
421 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
455 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
422 | shade term_name title transparent transparent_all tripleclickwords |
456 | shade term_name title transparent transparent_all tripleclickwords |
423 | utmpInhibit visualBell |
457 | utmpInhibit visualBell |
424 | |
458 | |
|
|
459 | $value = $term->x_resource ($pattern) |
|
|
460 | Returns the X-Resource for the given pattern, excluding the program |
|
|
461 | or class name, i.e. "$term->x_resource ("boldFont")" should return |
|
|
462 | the same value as used by this instance of rxvt-unicode. Returns |
|
|
463 | "undef" if no resource with that pattern exists. |
|
|
464 | |
|
|
465 | This method should only be called during the "on_start" hook, as |
|
|
466 | there is only one resource database per display, and later |
|
|
467 | invocations might return the wrong resources. |
|
|
468 | |
425 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
469 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
426 | Adds a keymap translation exactly as specified via a resource. See |
470 | Adds a keymap translation exactly as specified via a resource. See |
427 | the "keysym" resource in the rxvt(1) manpage. |
471 | the "keysym" resource in the rxvt(1) manpage. |
428 | |
472 | |
429 | $rend = $term->rstyle ([$new_rstyle]) |
473 | $rend = $term->rstyle ([$new_rstyle]) |
… | |
… | |
439 | ($row, $col) = $term->selection_beg ([$row, $col]) |
483 | ($row, $col) = $term->selection_beg ([$row, $col]) |
440 | ($row, $col) = $term->selection_end ([$row, $col]) |
484 | ($row, $col) = $term->selection_end ([$row, $col]) |
441 | Return the current values of the selection mark, begin or end |
485 | Return the current values of the selection mark, begin or end |
442 | positions, and optionally set them to new values. |
486 | positions, and optionally set them to new values. |
443 | |
487 | |
|
|
488 | $term->selection_make ($eventtime[, $rectangular]) |
|
|
489 | Tries to make a selection as set by "selection_beg" and |
|
|
490 | "selection_end". If $rectangular is true (default: false), a |
|
|
491 | rectangular selection will be made. This is the prefered function to |
|
|
492 | make a selection. |
|
|
493 | |
444 | $success = $term->selection_grab ($eventtime) |
494 | $success = $term->selection_grab ($eventtime) |
445 | Try to request the primary selection from the server (for example, |
495 | Try to request the primary selection text from the server (for |
446 | as set by the next method). |
496 | example, as set by the next method). No visual feedback will be |
|
|
497 | given. This function is mostly useful from within "on_sel_grab" |
|
|
498 | hooks. |
447 | |
499 | |
448 | $oldtext = $term->selection ([$newtext]) |
500 | $oldtext = $term->selection ([$newtext]) |
449 | Return the current selection text and optionally replace it by |
501 | Return the current selection text and optionally replace it by |
450 | $newtext. |
502 | $newtext. |
451 | |
503 | |
… | |
… | |
496 | $string = $term->locale_decode ($octets) |
548 | $string = $term->locale_decode ($octets) |
497 | Convert the given locale-encoded octets into a perl string. |
549 | Convert the given locale-encoded octets into a perl string. |
498 | |
550 | |
499 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
551 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
500 | XORs the rendition values in the given span with the provided value |
552 | XORs the rendition values in the given span with the provided value |
501 | (default: "RS_RVid"). Useful in refresh hooks to provide effects |
553 | (default: "RS_RVid"), which *MUST NOT* contain font styles. Useful |
502 | similar to the selection. |
554 | in refresh hooks to provide effects similar to the selection. |
503 | |
555 | |
504 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
556 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
505 | $rstyle2]]) |
557 | $rstyle2]]) |
506 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
558 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
507 | whitespace will additionally be xored with the $rstyle2, which |
559 | whitespace will additionally be xored with the $rstyle2, which |
508 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
560 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
509 | and underlines it instead. |
561 | and underlines it instead. Both styles *MUST NOT* contain font |
|
|
562 | styles. |
510 | |
563 | |
511 | $term->scr_bell |
564 | $term->scr_bell |
512 | Ring the bell! |
565 | Ring the bell! |
513 | |
566 | |
514 | $term->scr_add_lines ($string) |
567 | $term->scr_add_lines ($string) |
… | |
… | |
557 | $max_scrollback = $term->saveLines |
610 | $max_scrollback = $term->saveLines |
558 | $nrow_plus_saveLines = $term->total_rows |
611 | $nrow_plus_saveLines = $term->total_rows |
559 | $lines_in_scrollback = $term->nsaved |
612 | $lines_in_scrollback = $term->nsaved |
560 | Return various integers describing terminal characteristics. |
613 | Return various integers describing terminal characteristics. |
561 | |
614 | |
|
|
615 | $x_display = $term->display_id |
|
|
616 | Return the DISPLAY used by rxvt-unicode. |
|
|
617 | |
562 | $lc_ctype = $term->locale |
618 | $lc_ctype = $term->locale |
563 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
619 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
564 | |
620 | |
565 | $x_display = $term->display_id |
621 | $env = $term->env |
566 | Return the DISPLAY used by rxvt-unicode. |
622 | Returns a copy of the environment in effect for the terminal as a |
|
|
623 | hashref similar to "\%ENV". |
567 | |
624 | |
568 | $modifiermask = $term->ModLevel3Mask |
625 | $modifiermask = $term->ModLevel3Mask |
569 | $modifiermask = $term->ModMetaMask |
626 | $modifiermask = $term->ModMetaMask |
570 | $modifiermask = $term->ModNumLockMask |
627 | $modifiermask = $term->ModNumLockMask |
571 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
628 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
… | |
… | |
650 | Return the row number of the first/last row of the line, |
707 | Return the row number of the first/last row of the line, |
651 | respectively. |
708 | respectively. |
652 | |
709 | |
653 | $offset = $line->offset_of ($row, $col) |
710 | $offset = $line->offset_of ($row, $col) |
654 | Returns the character offset of the given row|col pair within |
711 | Returns the character offset of the given row|col pair within |
655 | the logical line. |
712 | the logical line. Works for rows outside the line, too, and |
|
|
713 | returns corresponding offsets outside the string. |
656 | |
714 | |
657 | ($row, $col) = $line->coord_of ($offset) |
715 | ($row, $col) = $line->coord_of ($offset) |
658 | Translates a string offset into terminal coordinates again. |
716 | Translates a string offset into terminal coordinates again. |
659 | |
717 | |
660 | $text = $term->special_encode $string |
718 | $text = $term->special_encode $string |
… | |
… | |
687 | Calls XUngrab for the most recent grab. Is called automatically on |
745 | Calls XUngrab for the most recent grab. Is called automatically on |
688 | evaluation errors, as it is better to lose the grab in the error |
746 | evaluation errors, as it is better to lose the grab in the error |
689 | case as the session. |
747 | case as the session. |
690 | |
748 | |
691 | The "urxvt::popup" Class |
749 | The "urxvt::popup" Class |
|
|
750 | $popup->add_title ($title) |
|
|
751 | Adds a non-clickable title to the popup. |
|
|
752 | |
|
|
753 | $popup->add_separator ([$sepchr]) |
|
|
754 | Creates a separator, optionally using the character given as |
|
|
755 | $sepchr. |
|
|
756 | |
|
|
757 | $popup->add_button ($text, $cb) |
|
|
758 | Adds a clickable button to the popup. $cb is called whenever it is |
|
|
759 | selected. |
|
|
760 | |
|
|
761 | $popup->add_toggle ($text, $cb, $initial_value) |
|
|
762 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
763 | whenever it gets toggled, with a boolean indicating its value as its |
|
|
764 | first argument. |
|
|
765 | |
|
|
766 | $popup->show |
|
|
767 | Displays the popup (which is initially hidden). |
|
|
768 | |
692 | The "urxvt::timer" Class |
769 | The "urxvt::timer" Class |
693 | This class implements timer watchers/events. Time is represented as |
770 | This class implements timer watchers/events. Time is represented as a |
694 | a fractional number of seconds since the epoch. Example: |
771 | fractional number of seconds since the epoch. Example: |
695 | |
772 | |
696 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
773 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
697 | $term->{timer} = urxvt::timer |
774 | $term->{timer} = urxvt::timer |
698 | ->new |
775 | ->new |
699 | ->interval (1) |
776 | ->interval (1) |
700 | ->cb (sub { |
777 | ->cb (sub { |
701 | $term->{overlay}->set (0, 0, |
778 | $term->{overlay}->set (0, 0, |
702 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
779 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
703 | }); |
780 | }); |
704 | |
781 | |
705 | $timer = new urxvt::timer |
782 | $timer = new urxvt::timer |
706 | Create a new timer object in started state. It is scheduled to |
783 | Create a new timer object in started state. It is scheduled to fire |
707 | fire immediately. |
784 | immediately. |
708 | |
785 | |
709 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
786 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
710 | Set the callback to be called when the timer triggers. |
787 | Set the callback to be called when the timer triggers. |
711 | |
788 | |
712 | $tstamp = $timer->at |
789 | $tstamp = $timer->at |
713 | Return the time this watcher will fire next. |
790 | Return the time this watcher will fire next. |
714 | |
791 | |
715 | $timer = $timer->set ($tstamp) |
792 | $timer = $timer->set ($tstamp) |
716 | Set the time the event is generated to $tstamp. |
793 | Set the time the event is generated to $tstamp. |
717 | |
794 | |
718 | $timer = $timer->interval ($interval) |
795 | $timer = $timer->interval ($interval) |
719 | Normally (and when $interval is 0), the timer will automatically |
796 | Normally (and when $interval is 0), the timer will automatically |
720 | stop after it has fired once. If $interval is non-zero, then the |
797 | stop after it has fired once. If $interval is non-zero, then the |
721 | timer is automatically rescheduled at the given intervals. |
798 | timer is automatically rescheduled at the given intervals. |
722 | |
799 | |
723 | $timer = $timer->start |
800 | $timer = $timer->start |
724 | Start the timer. |
801 | Start the timer. |
725 | |
802 | |
726 | $timer = $timer->start ($tstamp) |
803 | $timer = $timer->start ($tstamp) |
727 | Set the event trigger time to $tstamp and start the timer. |
804 | Set the event trigger time to $tstamp and start the timer. |
728 | |
805 | |
729 | $timer = $timer->stop |
806 | $timer = $timer->stop |
730 | Stop the timer. |
807 | Stop the timer. |
731 | |
808 | |
732 | The "urxvt::iow" Class |
809 | The "urxvt::iow" Class |
733 | This class implements io watchers/events. Example: |
810 | This class implements io watchers/events. Example: |
734 | |
811 | |
735 | $term->{socket} = ... |
812 | $term->{socket} = ... |
736 | $term->{iow} = urxvt::iow |
813 | $term->{iow} = urxvt::iow |
737 | ->new |
814 | ->new |
738 | ->fd (fileno $term->{socket}) |
815 | ->fd (fileno $term->{socket}) |
739 | ->events (urxvt::EVENT_READ) |
816 | ->events (urxvt::EVENT_READ) |
740 | ->start |
817 | ->start |
741 | ->cb (sub { |
818 | ->cb (sub { |
742 | my ($iow, $revents) = @_; |
819 | my ($iow, $revents) = @_; |
743 | # $revents must be 1 here, no need to check |
820 | # $revents must be 1 here, no need to check |
744 | sysread $term->{socket}, my $buf, 8192 |
821 | sysread $term->{socket}, my $buf, 8192 |
745 | or end-of-file; |
822 | or end-of-file; |
746 | }); |
823 | }); |
747 | |
824 | |
748 | $iow = new urxvt::iow |
825 | $iow = new urxvt::iow |
749 | Create a new io watcher object in stopped state. |
826 | Create a new io watcher object in stopped state. |
750 | |
827 | |
751 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
828 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
752 | Set the callback to be called when io events are triggered. |
829 | Set the callback to be called when io events are triggered. |
753 | $reventmask is a bitset as described in the "events" method. |
830 | $reventmask is a bitset as described in the "events" method. |
754 | |
831 | |
755 | $iow = $iow->fd ($fd) |
832 | $iow = $iow->fd ($fd) |
756 | Set the filedescriptor (not handle) to watch. |
833 | Set the filedescriptor (not handle) to watch. |
757 | |
834 | |
758 | $iow = $iow->events ($eventmask) |
835 | $iow = $iow->events ($eventmask) |
759 | Set the event mask to watch. The only allowed values are |
836 | Set the event mask to watch. The only allowed values are |
760 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be |
837 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed |
761 | ORed together, or "urxvt::EVENT_NONE". |
838 | together, or "urxvt::EVENT_NONE". |
762 | |
839 | |
763 | $iow = $iow->start |
840 | $iow = $iow->start |
764 | Start watching for requested events on the given handle. |
841 | Start watching for requested events on the given handle. |
765 | |
842 | |
766 | $iow = $iow->stop |
843 | $iow = $iow->stop |
767 | Stop watching for events on the given filehandle. |
844 | Stop watching for events on the given filehandle. |
768 | |
845 | |
769 | ENVIRONMENT |
846 | ENVIRONMENT |
770 | URXVT_PERL_VERBOSITY |
847 | URXVT_PERL_VERBOSITY |
771 | This variable controls the verbosity level of the perl extension. |
848 | This variable controls the verbosity level of the perl extension. Higher |
772 | Higher numbers indicate more verbose output. |
849 | numbers indicate more verbose output. |
773 | |
850 | |
774 | == 0 - fatal messages |
851 | == 0 - fatal messages |
775 | >= 3 - script loading and management |
852 | >= 3 - script loading and management |
776 | >=10 - all events received |
853 | >=10 - all called hooks |
|
|
854 | >=11 - hook reutrn values |
777 | |
855 | |
778 | AUTHOR |
856 | AUTHOR |
779 | Marc Lehmann <pcg@goof.com> |
857 | Marc Lehmann <pcg@goof.com> |
780 | http://software.schmorp.de/pkg/rxvt-unicode |
858 | http://software.schmorp.de/pkg/rxvt-unicode |
781 | |
859 | |