ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.9 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.13 by root, Sun Jan 8 00:20:12 2006 UTC

… …
12 # start a rxvt using it: 12 # start a rxvt using it:
13 13
14 rxvt --perl-lib $HOME -pe grab_test 14 rxvt --perl-lib $HOME -pe grab_test
15 15
16DESCRIPTION 16DESCRIPTION
17 Everytime a terminal object gets created, scripts specified via the 17 Everytime a terminal object gets created, extension scripts specified
18 "perl" resource are loaded and associated with it. 18 via the "perl" resource are loaded and associated with it.
19 19
20 Scripts are compiled in a 'use strict' and 'use utf8' environment, and 20 Scripts are compiled in a 'use strict' and 'use utf8' environment, and
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
… …
44 44
45 URxvt.keysym.C-M-r: perl:selection:rot13 45 URxvt.keysym.C-M-r: perl:selection:rot13
46 46
47 digital-clock 47 digital-clock
48 Displays a digital clock using the built-in overlay. 48 Displays a digital clock using the built-in overlay.
49
50 mark-urls
51 Uses per-line display filtering ("on_line_update") to underline
52 urls.
53
54 block-graphics-to-ascii
55 A not very useful example of filtering all text output to the
56 terminal, by replacing all line-drawing characters (U+2500 ..
57 U+259F) by a similar-looking ascii character.
49 58
50 example-refresh-hooks 59 example-refresh-hooks
51 Displays a very simple digital clock in the upper right corner of 60 Displays a very simple digital clock in the upper right corner of
52 the window. Illustrates overwriting the refresh callbacks to create 61 the window. Illustrates overwriting the refresh callbacks to create
53 your own overlays or changes. 62 your own overlays or changes.
… …
62 When objects are destroyed on the C++ side, the perl object hashes are 71 When objects are destroyed on the C++ side, the perl object hashes are
63 emptied, so its best to store related objects such as time watchers and 72 emptied, so its best to store related objects such as time watchers and
64 the like inside the terminal object so they get destroyed as soon as the 73 the like inside the terminal object so they get destroyed as soon as the
65 terminal is destroyed. 74 terminal is destroyed.
66 75
76 Argument names also often indicate the type of a parameter. Here are
77 some hints on what they mean:
78
79 $text
80 Rxvt-unicodes special way of encoding text, where one "unicode"
81 character always represents one screen cell. See row_t for a
82 discussion of this format.
83
84 $string
85 A perl text string, with an emphasis on *text*. It can store all
86 unicode characters and is to be distinguished with text encoded in a
87 specific encoding (often locale-specific) and binary data.
88
89 $octets
90 Either binary data or - more common - a text string encoded in a
91 locale-specific way.
92
67 Hooks 93 Hooks
68 The following subroutines can be declared in loaded scripts, and will be 94 The following subroutines can be declared in extension files, and will
69 called whenever the relevant event happens. 95 be called whenever the relevant event happens.
70 96
71 The first argument passed to them is an object private to each terminal 97 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 98 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" 99 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" 100 object that is shared between all packages is stored in the "term"
75 member. 101 member. It is, however, blessed intot he package of the extension
102 script, so for all practical purposes you can treat an extension script
103 as a class.
76 104
77 All of them must return a boolean value. If it is true, then the event 105 All of them must return a boolean value. If it is true, then the event
78 counts as being *consumed*, and the invocation of other hooks is 106 counts as being *consumed*, and the invocation of other hooks is
79 skipped, and the relevant action might not be carried out by the C++ 107 skipped, and the relevant action might not be carried out by the C++
80 code. 108 code.
81 109
82 When in doubt, return a false value (preferably "()"). 110 When in doubt, return a false value (preferably "()").
83 111
84 on_init $term 112 on_init $term
85 Called after a new terminal object has been initialized, but before 113 Called after a new terminal object has been initialized, but before
86 windows are created or the command gets run. 114 windows are created or the command gets run. Most methods are unsafe
115 to call or deliver senseless data, as terminal size and other
116 characteristics have not yet been determined. You can safely query
117 and change resources, though.
87 118
88 on_reset $term 119 on_reset $term
89 Called after the screen is "reset" for any reason, such as resizing 120 Called after the screen is "reset" for any reason, such as resizing
90 or control sequences. Here is where you can react on changes to 121 or control sequences. Here is where you can react on changes to
91 size-related variables. 122 size-related variables.
… …
116 double click) and is either supposed to return false (normal 147 double click) and is either supposed to return false (normal
117 operation), or should extend the selection itelf and return true to 148 operation), or should extend the selection itelf and return true to
118 suppress the built-in processing. 149 suppress the built-in processing.
119 150
120 See the selection example extension. 151 See the selection example extension.
121
122 on_focus_in $term
123 Called whenever the window gets the keyboard focus, before urxvt
124 does focus in processing.
125
126 on_focus_out $term
127 Called wheneever the window loses keyboard focus, before urxvt does
128 focus out processing.
129 152
130 on_view_change $term, $offset 153 on_view_change $term, $offset
131 Called whenever the view offset changes, i..e the user or program 154 Called whenever the view offset changes, i..e the user or program
132 scrolls. Offset 0 means display the normal terminal, positive values 155 scrolls. Offset 0 means display the normal terminal, positive values
133 show this many lines of scrollback. 156 show this many lines of scrollback.
… …
155 178
156 Be careful not ever to trust (in a security sense) the data you 179 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, 180 receive, as its source can not easily be controleld (e-mail content,
158 messages from other users on the same system etc.). 181 messages from other users on the same system etc.).
159 182
183 on_add_lines $term, $string
184 Called whenever text is about to be output, with the text as
185 argument. You can filter/change and output the text yourself by
186 returning a true value and calling "$term->scr_add_lines" yourself.
187 Please note that this might be very slow, however, as your hook is
188 called for all text being output.
189
190 on_line_update $term, $row
191 Called whenever a line was updated or changed. Can be used to filter
192 screen output (e.g. underline urls or other useless stuff). Only
193 lines that are being shown will be filtered, and, due to performance
194 reasons, not always immediately.
195
196 The row number is always the topmost row of the line if the line
197 spans multiple rows.
198
199 Please note that, if you change the line, then the hook might get
200 called later with the already-modified line (e.g. if unrelated parts
201 change), so you cannot just toggle rendition bits, but only set
202 them.
203
160 on_refresh_begin $term 204 on_refresh_begin $term
161 Called just before the screen gets redrawn. Can be used for overlay 205 Called just before the screen gets redrawn. Can be used for overlay
162 or similar effects by modify terminal contents in refresh_begin, and 206 or similar effects by modify terminal contents in refresh_begin, and
163 restoring them in refresh_end. The built-in overlay and selection 207 restoring them in refresh_end. The built-in overlay and selection
164 display code is run after this hook, and takes precedence. 208 display code is run after this hook, and takes precedence.
… …
169 on_keyboard_command $term, $string 213 on_keyboard_command $term, $string
170 Called whenever the user presses a key combination that has a 214 Called whenever the user presses a key combination that has a
171 "perl:string" action bound to it (see description of the keysym 215 "perl:string" action bound to it (see description of the keysym
172 resource in the rxvt(1) manpage). 216 resource in the rxvt(1) manpage).
173 217
218 on_focus_in $term
219 Called whenever the window gets the keyboard focus, before
220 rxvt-unicode does focus in processing.
221
222 on_focus_out $term
223 Called wheneever the window loses keyboard focus, before
224 rxvt-unicode does focus out processing.
225
226 on_key_press $term, $event, $octets
227 on_key_release $term, $event
228 on_button_press $term, $event
229 on_button_release $term, $event
230 on_motion_notify $term, $event
231 on_map_notify $term, $event
232 on_unmap_notify $term, $event
233 Called whenever the corresponding X event is received for the
234 terminal If the hook returns true, then the even will be ignored by
235 rxvt-unicode.
236
237 The event is a hash with most values as named by Xlib (see the
238 XEvent manpage), with the additional members "row" and "col", which
239 are the row and column under the mouse cursor.
240
241 "on_key_press" additionally receives the string rxvt-unicode would
242 output, if any, in locale-specific encoding.
243
244 subwindow.
245
174 Variables in the "urxvt" Package 246 Variables in the "urxvt" Package
175 $urxvt::TERM 247 $urxvt::TERM
176 The current terminal. Whenever a callback/Hook is bein executed,
177 this variable stores the current "urxvt::term" object. 248 The current terminal. This variable stores the current "urxvt::term"
249 object, whenever a callback/hook is executing.
178 250
179 Functions in the "urxvt" Package 251 Functions in the "urxvt" Package
252 $term = new urxvt [arg...]
253 Creates a new terminal, very similar as if you had started it with
254 "system $binfile, arg...". Croaks (and probably outputs an error
255 message) if the new instance couldn't be created. Returns "undef" if
256 the new instance didn't initialise perl, and the terminal object
257 otherwise. The "init" and "start" hooks will be called during the
258 call.
259
180 urxvt::fatal $errormessage 260 urxvt::fatal $errormessage
181 Fatally aborts execution with the given error message. Avoid at all 261 Fatally aborts execution with the given error message. Avoid at all
182 costs! The only time this is acceptable is when the terminal process 262 costs! The only time this is acceptable is when the terminal process
183 starts up. 263 starts up.
184 264
… …
191 correct place, e.g. on stderr of the connecting urxvtc client. 271 correct place, e.g. on stderr of the connecting urxvtc client.
192 272
193 $time = urxvt::NOW 273 $time = urxvt::NOW
194 Returns the "current time" (as per the event loop). 274 Returns the "current time" (as per the event loop).
195 275
276 urxvt::CurrentTime
277 urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
278 Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
279 Button5Mask, AnyModifier
280 Various constants for use in X events.
281
196 RENDITION 282 RENDITION
197 Rendition bitsets contain information about colour, font, font styles 283 Rendition bitsets contain information about colour, font, font styles
198 and similar information for each screen cell. 284 and similar information for each screen cell.
199 285
200 The following "macros" deal with changes in rendition sets. You should 286 The following "macros" deal with changes in rendition sets. You should
… …
231 317
232 $rend = urxvt::SET_CUSTOM ($rend, $new_value) 318 $rend = urxvt::SET_CUSTOM ($rend, $new_value)
233 Change the custom value. 319 Change the custom value.
234 320
235 The "urxvt::term" Class 321 The "urxvt::term" Class
322 $term->destroy
323 Destroy the terminal object (close the window, free resources etc.).
324
325 $isset = $term->option ($optval[, $set])
326 Returns true if the option specified by $optval is enabled, and
327 optionally change it. All option values are stored by name in the
328 hash %urxvt::OPTION. Options not enabled in this binary are not in
329 the hash.
330
331 Here is a a likely non-exhaustive list of option names, please see
332 the source file /src/optinc.h to see the actual list:
333
334 borderLess console cursorBlink cursorUnderline hold iconic insecure
335 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
336 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
337 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
338 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
339 tripleclickwords utmpInhibit visualBell
340
236 $value = $term->resource ($name[, $newval]) 341 $value = $term->resource ($name[, $newval])
237 Returns the current resource value associated with a given name and 342 Returns the current resource value associated with a given name and
238 optionally sets a new value. Setting values is most useful in the 343 optionally sets a new value. Setting values is most useful in the
239 "init" hook. Unset resources are returned and accepted as "undef". 344 "init" hook. Unset resources are returned and accepted as "undef".
240 345
… …
249 Please note that resource strings will currently only be freed when 354 Please note that resource strings will currently only be freed when
250 the terminal is destroyed, so changing options frequently will eat 355 the terminal is destroyed, so changing options frequently will eat
251 memory. 356 memory.
252 357
253 Here is a a likely non-exhaustive list of resource names, not all of 358 Here is a a likely non-exhaustive list of resource names, not all of
254 which are supported in every build, please see the source to see the 359 which are supported in every build, please see the source file
255 actual list: 360 /src/rsinc.h to see the actual list:
256 361
257 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 362 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
258 borderLess color cursorBlink cursorUnderline cutchars delete_key 363 borderLess color cursorBlink cursorUnderline cutchars delete_key
259 display_name embed ext_bwidth fade font geometry hold iconName 364 display_name embed ext_bwidth fade font geometry hold iconName
260 imFont imLocale inputMethod insecure int_bwidth intensityStyles 365 imFont imLocale inputMethod insecure int_bwidth intensityStyles
261 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 366 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
262 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 367 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
263 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 368 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
264 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 369 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
265 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 370 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
266 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 371 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
267 shade term_name title transparent transparent_all tripleclickwords 372 shade term_name title transparent transparent_all tripleclickwords
268 utmpInhibit visualBell 373 utmpInhibit visualBell
269 374
375 $rend = $term->rstyle ([$new_rstyle])
376 Return and optionally change the current rendition. Text that is
377 output by the terminal application will use this style.
378
379 ($row, $col) = $term->screen_cur ([$row, $col])
380 Return the current coordinates of the text cursor position and
381 optionally set it (which is usually bad as applications don't expect
382 that).
383
270 ($row, $col) = $term->selection_mark ([$row, $col]) 384 ($row, $col) = $term->selection_mark ([$row, $col])
271 ($row, $col) = $term->selection_beg ([$row, $col]) 385 ($row, $col) = $term->selection_beg ([$row, $col])
272 ($row, $col) = $term->selection_end ([$row, $col]) 386 ($row, $col) = $term->selection_end ([$row, $col])
273 Return the current values of the selection mark, begin or end 387 Return the current values of the selection mark, begin or end
274 positions, and optionally set them to new values. 388 positions, and optionally set them to new values.
… …
280 $oldtext = $term->selection ([$newtext]) 394 $oldtext = $term->selection ([$newtext])
281 Return the current selection text and optionally replace it by 395 Return the current selection text and optionally replace it by
282 $newtext. 396 $newtext.
283 397
284 #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line 398 #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line
285 overlay box. See the next method for details. # #=cut 399 overlay box. See the next method for details. # #=cut # #sub
286
287 sub urxvt::term::scr_overlay { die; my ($self, $x, $y, $text) = @_; 400 urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my
288 401 @lines = split /\n/, $text; # # my $w = 0; # for (map
289 my @lines = split /\n/, $text; 402 $self->strwidth ($_), @lines) { # $w = $_ if $w < $_; # } # #
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); 403 $self->scr_overlay_new ($x, $y, $w, scalar @lines); #
297 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 404 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; #}
298 }
299 405
300 $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 406 $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
301 Create a new (empty) overlay at the given position with the given 407 Create a new (empty) overlay at the given position with the given
302 width/height. $rstyle defines the initial rendition style (default: 408 width/height. $rstyle defines the initial rendition style (default:
303 "OVERLAY_RSTYLE"). 409 "OVERLAY_RSTYLE").
… …
322 If visible, hide the overlay, but do not destroy it. 428 If visible, hide the overlay, but do not destroy it.
323 429
324 $overlay->show 430 $overlay->show
325 If hidden, display the overlay again. 431 If hidden, display the overlay again.
326 432
433 $popup = $term->popup ($event)
434 Creates a new "urxvt::popup" object that implements a popup menu.
435 The $event *must* be the event causing the menu to pop up (a button
436 event, currently).
437
327 $cellwidth = $term->strwidth $string 438 $cellwidth = $term->strwidth ($string)
328 Returns the number of screen-cells this string would need. Correctly 439 Returns the number of screen-cells this string would need. Correctly
329 accounts for wide and combining characters. 440 accounts for wide and combining characters.
330 441
331 $octets = $term->locale_encode $string 442 $octets = $term->locale_encode ($string)
332 Convert the given text string into the corresponding locale 443 Convert the given text string into the corresponding locale
333 encoding. 444 encoding.
334 445
335 $string = $term->locale_decode $octets 446 $string = $term->locale_decode ($octets)
336 Convert the given locale-encoded octets into a perl string. 447 Convert the given locale-encoded octets into a perl string.
448
449 $term->scr_add_lines ($string)
450 Write the given text string to the screen, as if output by the
451 application running inside the terminal. It may not contain command
452 sequences (escape codes), but is free to use line feeds, carriage
453 returns and tabs. The string is a normal text string, not in
454 locale-dependent encoding.
455
456 Normally its not a good idea to use this function, as programs might
457 be confused by changes in cursor position or scrolling. Its useful
458 inside a "on_add_lines" hook, though.
459
460 $term->cmd_parse ($octets)
461 Similar to "scr_add_lines", but the argument must be in the
462 locale-specific encoding of the terminal and can contain command
463 sequences (escape codes) that will be interpreted.
337 464
338 $term->tt_write ($octets) 465 $term->tt_write ($octets)
339 Write the octets given in $data to the tty (i.e. as program input). 466 Write the octets given in $data to the tty (i.e. as program input).
340 To pass characters instead of octets, you should convert your 467 To pass characters instead of octets, you should convert your
341 strings first to the locale-specific encoding using 468 strings first to the locale-specific encoding using
342 "$term->locale_encode". 469 "$term->locale_encode".
343 470
471 $windowid = $term->parent
472 Return the window id of the toplevel window.
473
474 $windowid = $term->vt
475 Return the window id of the terminal window.
476
477 $window_width = $term->width
478 $window_height = $term->height
479 $font_width = $term->fwidth
480 $font_height = $term->fheight
481 $font_ascent = $term->fbase
344 $nrow = $term->nrow 482 $terminal_rows = $term->nrow
345 $ncol = $term->ncol 483 $terminal_columns = $term->ncol
346 Return the number of rows/columns of the terminal window (i.e. as 484 $has_focus = $term->focus
347 specified by "-geometry", excluding any scrollback).
348
349 $nsaved = $term->nsaved 485 $is_mapped = $term->mapped
350 Returns the number of lines in the scrollback buffer. 486 $max_scrollback = $term->saveLines
487 $nrow_plus_saveLines = $term->total_rows
488 $lines_in_scrollback = $term->nsaved
489 Return various integers describing terminal characteristics.
490
491 $modifiermask = $term->ModLevel3Mask
492 $modifiermask = $term->ModMetaMask
493 $modifiermask = $term->ModNumLockMask
494 Return the modifier masks corresponding to the "ISO Level 3 Shift"
495 (often AltGr), the meta key (often Alt) and the num lock key, if
496 applicable.
351 497
352 $view_start = $term->view_start ([$newvalue]) 498 $view_start = $term->view_start ([$newvalue])
353 Returns the negative row number of the topmost line. Minimum value 499 Returns the negative row number of the topmost line. Minimum value
354 is 0, which displays the normal terminal contents. Larger values 500 is 0, which displays the normal terminal contents. Larger values
355 scroll this many lines into the scrollback buffer. 501 scroll this many lines into the scrollback buffer.
… …
409 $line = $term->line ($row_number) 555 $line = $term->line ($row_number)
410 Create and return a new "urxvt::line" object that stores information 556 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 557 about the logical line that row $row_number is part of. It supports
412 the following methods: 558 the following methods:
413 559
414 $text = $line->t 560 $text = $line->t ([$new_text])
415 Returns the full text of the line, similar to "ROW_t" 561 Returns or replaces the full text of the line, similar to
562 "ROW_t"
416 563
417 $rend = $line->r 564 $rend = $line->r ([$new_rend])
418 Returns the full rendition array of the line, similar to "ROW_r" 565 Returns or replaces the full rendition array of the line,
566 similar to "ROW_r"
419 567
420 $length = $line->l 568 $length = $line->l
421 Returns the length of the line in cells, similar to "ROW_l". 569 Returns the length of the line in cells, similar to "ROW_l".
422 570
423 $rownum = $line->beg 571 $rownum = $line->beg
… …
440 588
441 $string = $term->special_decode $text 589 $string = $term->special_decode $text
442 Converts rxvt-unicodes text reprsentation into a perl string. See 590 Converts rxvt-unicodes text reprsentation into a perl string. See
443 "$term->ROW_t" for details. 591 "$term->ROW_t" for details.
444 592
593 The "urxvt::popup" Class
445 The "urxvt::timer" Class 594 The "urxvt::timer" Class
446 This class implements timer watchers/events. Time is represented as a 595 This class implements timer watchers/events. Time is represented as
447 fractional number of seconds since the epoch. Example: 596 a fractional number of seconds since the epoch. Example:
448 597
449 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); 598 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
450 $term->{timer} = urxvt::timer 599 $term->{timer} = urxvt::timer
451 ->new 600 ->new
452 ->interval (1) 601 ->interval (1)
453 ->cb (sub { 602 ->cb (sub {
454 $term->{overlay}->set (0, 0, 603 $term->{overlay}->set (0, 0,
455 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 604 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
456 }); 605 });
457 606
458 $timer = new urxvt::timer 607 $timer = new urxvt::timer
459 Create a new timer object in started state. It is scheduled to fire 608 Create a new timer object in started state. It is scheduled to
460 immediately. 609 fire immediately.
461 610
462 $timer = $timer->cb (sub { my ($timer) = @_; ... }) 611 $timer = $timer->cb (sub { my ($timer) = @_; ... })
463 Set the callback to be called when the timer triggers. 612 Set the callback to be called when the timer triggers.
464 613
465 $tstamp = $timer->at 614 $tstamp = $timer->at
466 Return the time this watcher will fire next. 615 Return the time this watcher will fire next.
467 616
468 $timer = $timer->set ($tstamp) 617 $timer = $timer->set ($tstamp)
469 Set the time the event is generated to $tstamp. 618 Set the time the event is generated to $tstamp.
470 619
471 $timer = $timer->interval ($interval) 620 $timer = $timer->interval ($interval)
472 Normally (and when $interval is 0), the timer will automatically 621 Normally (and when $interval is 0), the timer will automatically
473 stop after it has fired once. If $interval is non-zero, then the 622 stop after it has fired once. If $interval is non-zero, then the
474 timer is automatically rescheduled at the given intervals. 623 timer is automatically rescheduled at the given intervals.
475 624
476 $timer = $timer->start 625 $timer = $timer->start
477 Start the timer. 626 Start the timer.
478 627
479 $timer = $timer->start ($tstamp) 628 $timer = $timer->start ($tstamp)
480 Set the event trigger time to $tstamp and start the timer. 629 Set the event trigger time to $tstamp and start the timer.
481 630
482 $timer = $timer->stop 631 $timer = $timer->stop
483 Stop the timer. 632 Stop the timer.
484 633
485 The "urxvt::iow" Class 634 The "urxvt::iow" Class
486 This class implements io watchers/events. Example: 635 This class implements io watchers/events. Example:
487 636
488 $term->{socket} = ... 637 $term->{socket} = ...
489 $term->{iow} = urxvt::iow 638 $term->{iow} = urxvt::iow
490 ->new 639 ->new
491 ->fd (fileno $term->{socket}) 640 ->fd (fileno $term->{socket})
492 ->events (1) # wait for read data 641 ->events (1) # wait for read data
493 ->start 642 ->start
494 ->cb (sub { 643 ->cb (sub {
495 my ($iow, $revents) = @_; 644 my ($iow, $revents) = @_;
496 # $revents must be 1 here, no need to check 645 # $revents must be 1 here, no need to check
497 sysread $term->{socket}, my $buf, 8192 646 sysread $term->{socket}, my $buf, 8192
498 or end-of-file; 647 or end-of-file;
499 }); 648 });
500 649
501 $iow = new urxvt::iow 650 $iow = new urxvt::iow
502 Create a new io watcher object in stopped state. 651 Create a new io watcher object in stopped state.
503 652
504 $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) 653 $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
505 Set the callback to be called when io events are triggered. 654 Set the callback to be called when io events are triggered.
506 $reventmask is a bitset as described in the "events" method. 655 $reventmask is a bitset as described in the "events" method.
507 656
508 $iow = $iow->fd ($fd) 657 $iow = $iow->fd ($fd)
509 Set the filedescriptor (not handle) to watch. 658 Set the filedescriptor (not handle) to watch.
510 659
511 $iow = $iow->events ($eventmask) 660 $iow = $iow->events ($eventmask)
512 Set the event mask to watch. Bit #0 (value 1) enables watching for 661 Set the event mask to watch. Bit #0 (value 1) enables watching
513 read data, Bit #1 (value 2) enables watching for write data. 662 for read data, Bit #1 (value 2) enables watching for write data.
514 663
515 $iow = $iow->start 664 $iow = $iow->start
516 Start watching for requested events on the given handle. 665 Start watching for requested events on the given handle.
517 666
518 $iow = $iow->stop 667 $iow = $iow->stop
519 Stop watching for events on the given filehandle. 668 Stop watching for events on the given filehandle.
520 669
521ENVIRONMENT 670ENVIRONMENT
522 URXVT_PERL_VERBOSITY 671 URXVT_PERL_VERBOSITY
523 This variable controls the verbosity level of the perl extension. Higher 672 This variable controls the verbosity level of the perl extension.
524 numbers indicate more verbose output. 673 Higher numbers indicate more verbose output.
525 674
526 =0 - only fatal messages 675 =0 - only fatal messages
527 =3 - script loading and management 676 =3 - script loading and management
528 =10 - all events received 677 =10 - all events received
529 678
530AUTHOR 679AUTHOR
531 Marc Lehmann <pcg@goof.com> 680 Marc Lehmann <pcg@goof.com>
532 http://software.schmorp.de/pkg/rxvt-unicode 681 http://software.schmorp.de/pkg/rxvt-unicode
533 682

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines