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.22 by root, Wed Jan 11 02:13:56 2006 UTC vs.
Revision 1.31 by root, Thu Jan 19 19:26:31 2006 UTC

… …
31 31
32 rxvt -pe <extensionname> 32 rxvt -pe <extensionname>
33 33
34 selection (enabled by default) 34 selection (enabled by default)
35 (More) intelligent selection. This extension tries to be more 35 (More) intelligent selection. This extension tries to be more
36 intelligent when the user extends selections (double-click). Right 36 intelligent when the user extends selections (double-click and
37 now, it tries to select urls and complete shell-quoted arguments, 37 further clicks). Right now, it tries to select words, urls and
38 which is very convenient, too, if your ls supports 38 complete shell-quoted arguments, which is very convenient, too, if
39 "--quoting-style=shell". 39 your ls supports "--quoting-style=shell".
40 40
41 A double-click usually selects the word under the cursor, further
42 clicks will enlarge the selection.
43
44 The selection works by trying to match a number of regexes and
45 displaying them in increasing order of length. You can add your own
46 regexes by specifying resources of the form:
47
48 URxvt.selection.pattern-0: perl-regex
49 URxvt.selection.pattern-1: perl-regex
50 ...
51
52 The index number (0, 1...) must not have any holes, and each regex
53 must contain at least one pair of capturing parentheses, which will
54 be used for the match. For example, the followign adds a regex that
55 matches everything between two vertical bars:
56
57 URxvt.selection.pattern-0: \\|([^|]+)\\|
58
59 You can look at the source of the selection extension to see more
60 interesting uses, such as parsing a line from beginning to end.
61
41 It also offers the following bindable keyboard command: 62 This extension also offers following bindable keyboard commands:
42 63
43 rot13 64 rot13
44 Rot-13 the selection when activated. Used via keyboard trigger: 65 Rot-13 the selection when activated. Used via keyboard trigger:
45 66
46 URxvt.keysym.C-M-r: perl:selection:rot13 67 URxvt.keysym.C-M-r: perl:selection:rot13
… …
53 Binds a popup menu to Ctrl-Button3 that lets you convert the 74 Binds a popup menu to Ctrl-Button3 that lets you convert the
54 selection text into various other formats/action (such as uri 75 selection text into various other formats/action (such as uri
55 unescaping, perl evalution, web-browser starting etc.), depending on 76 unescaping, perl evalution, web-browser starting etc.), depending on
56 content. 77 content.
57 78
79 Other extensions can extend this popup menu by pushing a code
80 reference onto "@{ $term-"{selection_popup_hook} }>, that is called
81 whenever the popup is displayed.
82
83 It's sole argument is the popup menu, which can be modified. The
84 selection is in $_, which can be used to decide wether to add
85 something or not. It should either return nothing or a string and a
86 code reference. The string will be used as button text and the code
87 reference will be called when the button gets activated and should
88 transform $_.
89
90 The following will add an entry "a to b" that transforms all "a"s in
91 the selection to "b"s, but only if the selection currently contains
92 any "a"s:
93
94 push @{ $self->{term}{selection_popup_hook} }, sub {
95 /a/ ? ("a to be" => sub { s/a/b/g }
96 : ()
97 };
98
58 searchable-scrollback<hotkey> (enabled by default) 99 searchable-scrollback<hotkey> (enabled by default)
59 Adds regex search functionality to the scrollback buffer, triggered 100 Adds regex search functionality to the scrollback buffer, triggered
60 by a hotkey (default: "M-s"). When in search mode, normal terminal 101 by a hotkey (default: "M-s"). While in search mode, normal terminal
61 input/output is suspended. 102 input/output is suspended and a regex is displayed at the bottom of
103 the screen.
62 104
63 "/" starts an incremental regex search, "n" searches further, "p" or 105 Inputting characters appends them to the regex and continues
64 "N" jump to the previous match, "G" jumps to the bottom and clears 106 incremental search. "BackSpace" removes a character from the regex,
65 the history, "enter" leaves search mode at the current position and 107 "Up" and "Down" search upwards/downwards in the scrollback buffer,
66 "escape" returns to the original position. 108 "End" jumps to the bottom. "Escape" leaves search mode and returns
109 to the point where search was started, while "Enter" or "Return"
110 stay at the current position and additionally stores the first match
111 in the current line into the primary selection.
67 112
68 digital-clock 113 selection-autotransform
69 Displays a digital clock using the built-in overlay. 114 This selection allows you to do automatic transforms on a selection
115 whenever a selection is made.
116
117 It works by specifying perl snippets (most useful is a single "s///"
118 operator) that modify $_ as resources:
119
120 URxvt.selection-autotransform.0: transform
121 URxvt.selection-autotransform.1: transform
122 ...
123
124 For example, the following will transform selections of the form
125 "filename:number", often seen in compiler messages, into "vi
126 +$filename $word":
127
128 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
129
130 And this example matches the same,but replaces it with vi-commands
131 you can paste directly into your (vi :) editor:
132
133 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
134
135 Of course, this can be modified to suit your needs and your editor
136 :)
137
138 To expand the example above to typical perl error messages ("XXX at
139 FILENAME line YYY."), you need a slightly more elaborate solution:
140
141 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
142 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
143
144 The first line tells the selection code to treat the unchanging part
145 of every error message as a selection pattern, and the second line
146 transforms the message into vi commands to load the file.
70 147
71 mark-urls 148 mark-urls
72 Uses per-line display filtering ("on_line_update") to underline urls 149 Uses per-line display filtering ("on_line_update") to underline urls
73 and make them clickable. When clicked, the program specified in the 150 and make them clickable. When middle-clicked, the program specified
74 resource "urlLauncher" (default "x-www-browser") will be started. 151 in the resource "urlLauncher" (default "x-www-browser") will be
152 started with the URL as first argument.
153
154 automove-background
155 This is basically a one-line extension that dynamically changes the
156 background pixmap offset to the window position, in effect creating
157 the same effect as pseudo transparency with a custom pixmap. No
158 scaling is supported in this mode. Exmaple:
159
160 rxvt -pixmap background.xpm -pe automove-background
75 161
76 block-graphics-to-ascii 162 block-graphics-to-ascii
77 A not very useful example of filtering all text output to the 163 A not very useful example of filtering all text output to the
78 terminal, by replacing all line-drawing characters (U+2500 .. 164 terminal, by replacing all line-drawing characters (U+2500 ..
79 U+259F) by a similar-looking ascii character. 165 U+259F) by a similar-looking ascii character.
80 166
167 digital-clock
168 Displays a digital clock using the built-in overlay.
169
81 example-refresh-hooks 170 example-refresh-hooks
82 Displays a very simple digital clock in the upper right corner of 171 Displays a very simple digital clock in the upper right corner of
83 the window. Illustrates overwriting the refresh callbacks to create 172 the window. Illustrates overwriting the refresh callbacks to create
84 your own overlays or changes. 173 your own overlays or changes.
174
175 selection-pastebin
176 This is a little rarely useful extension that Uploads the selection
177 as textfile to a remote site (or does other things). (The
178 implementation is not currently secure for use in a multiuser
179 environment as it writes to /tmp directly.).
180
181 It listens to the "selection-pastebin:remote-pastebin" keyboard
182 command, i.e.
183
184 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
185
186 Pressing this combination runs a command with "%" replaced by the
187 name of the textfile. This command can be set via a resource:
188
189 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
190
191 And the default is likely not useful to anybody but the few people
192 around here :)
193
194 The name of the textfile is the hex encoded md5 sum of the
195 selection, so the same content should lead to the same filename.
196
197 After a successful upload the selection will be replaced by the text
198 given in the "selection-pastebin-url" resource (again, the % is the
199 placeholder for the filename):
200
201 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
85 202
86API DOCUMENTATION 203API DOCUMENTATION
87 General API Considerations 204 General API Considerations
88 All objects (such as terminals, time watchers etc.) are typical 205 All objects (such as terminals, time watchers etc.) are typical
89 reference-to-hash objects. The hash can be used to store anything you 206 reference-to-hash objects. The hash can be used to store anything you
… …
166 283
167 on_start $term 284 on_start $term
168 Called at the very end of initialisation of a new terminal, just 285 Called at the very end of initialisation of a new terminal, just
169 before returning to the mainloop. 286 before returning to the mainloop.
170 287
288 on_child_start $term, $pid
289 Called just after the child process has been "fork"ed.
290
291 on_child_exit $term, $status
292 Called just after the child process has exited. $status is the
293 status from "waitpid".
294
171 on_sel_make $term, $eventtime 295 on_sel_make $term, $eventtime
172 Called whenever a selection has been made by the user, but before 296 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 297 the selection text is copied, so changes to the beginning, end or
174 type of the selection will be honored. 298 type of the selection will be honored.
175 299
… …
187 311
188 on_sel_extend $term 312 on_sel_extend $term
189 Called whenever the user tries to extend the selection (e.g. with a 313 Called whenever the user tries to extend the selection (e.g. with a
190 double click) and is either supposed to return false (normal 314 double click) and is either supposed to return false (normal
191 operation), or should extend the selection itelf and return true to 315 operation), or should extend the selection itelf and return true to
192 suppress the built-in processing. 316 suppress the built-in processing. This can happen multiple times, as
317 long as the callback returns true, it will be called on every
318 further click by the user and is supposed to enlarge the selection
319 more and more, if possible.
193 320
194 See the selection example extension. 321 See the selection example extension.
195 322
196 on_view_change $term, $offset 323 on_view_change $term, $offset
197 Called whenever the view offset changes, i..e the user or program 324 Called whenever the view offset changes, i..e the user or program
… …
256 on_keyboard_command $term, $string 383 on_keyboard_command $term, $string
257 Called whenever the user presses a key combination that has a 384 Called whenever the user presses a key combination that has a
258 "perl:string" action bound to it (see description of the keysym 385 "perl:string" action bound to it (see description of the keysym
259 resource in the rxvt(1) manpage). 386 resource in the rxvt(1) manpage).
260 387
388 on_x_event $term, $event
389 Called on every X event received on the vt window (and possibly
390 other windows). Should only be used as a last resort. Most event
391 structure members are not passed.
392
261 on_focus_in $term 393 on_focus_in $term
262 Called whenever the window gets the keyboard focus, before 394 Called whenever the window gets the keyboard focus, before
263 rxvt-unicode does focus in processing. 395 rxvt-unicode does focus in processing.
264 396
265 on_focus_out $term 397 on_focus_out $term
266 Called wheneever the window loses keyboard focus, before 398 Called wheneever the window loses keyboard focus, before
267 rxvt-unicode does focus out processing. 399 rxvt-unicode does focus out processing.
268 400
401 on_configure_notify $term, $event
269 on_key_press $term, $event, $keysym, $octets 402 on_key_press $term, $event, $keysym, $octets
270 on_key_release $term, $event, $keysym 403 on_key_release $term, $event, $keysym
271 on_button_press $term, $event 404 on_button_press $term, $event
272 on_button_release $term, $event 405 on_button_release $term, $event
273 on_motion_notify $term, $event 406 on_motion_notify $term, $event
… …
316 Using this function has the advantage that its output ends up in the 449 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. 450 correct place, e.g. on stderr of the connecting urxvtc client.
318 451
319 Messages have a size limit of 1023 bytes currently. 452 Messages have a size limit of 1023 bytes currently.
320 453
321 $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 $time = urxvt::NOW 454 $time = urxvt::NOW
327 Returns the "current time" (as per the event loop). 455 Returns the "current time" (as per the event loop).
328 456
329 urxvt::CurrentTime 457 urxvt::CurrentTime
330 urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, 458 urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
331 Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, 459 Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
332 Button5Mask, AnyModifier 460 Button5Mask, AnyModifier
461 urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
462 ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
463 PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
464 Button3MotionMask, Button4MotionMask, Button5MotionMask,
465 ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
466 StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
467 SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
468 ColormapChangeMask, OwnerGrabButtonMask
469 urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
470 EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
471 GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
472 UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
473 ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
474 CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
475 SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
333 Various constants for use in X calls and event processing. 476 Various constants for use in X calls and event processing.
334 477
335 RENDITION 478 RENDITION
336 Rendition bitsets contain information about colour, font, font styles 479 Rendition bitsets contain information about colour, font, font styles
337 and similar information for each screen cell. 480 and similar information for each screen cell.
… …
393 $term->destroy 536 $term->destroy
394 Destroy the terminal object (close the window, free resources etc.). 537 Destroy the terminal object (close the window, free resources etc.).
395 Please note that rxvt will not exit as long as any event watchers 538 Please note that rxvt will not exit as long as any event watchers
396 (timers, io watchers) are still active. 539 (timers, io watchers) are still active.
397 540
541 $term->exec_async ($cmd[, @args])
542 Works like the combination of the "fork"/"exec" builtins, which
543 executes ("starts") programs in the background. This function takes
544 care of setting the user environment before exec'ing the command
545 (e.g. "PATH") and should be preferred over explicit calls to "exec"
546 or "system".
547
548 Returns the pid of the subprocess or "undef" on error.
549
398 $isset = $term->option ($optval[, $set]) 550 $isset = $term->option ($optval[, $set])
399 Returns true if the option specified by $optval is enabled, and 551 Returns true if the option specified by $optval is enabled, and
400 optionally change it. All option values are stored by name in the 552 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 553 hash %urxvt::OPTION. Options not enabled in this binary are not in
402 the hash. 554 the hash.
… …
404 Here is a a likely non-exhaustive list of option names, please see 556 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: 557 the source file /src/optinc.h to see the actual list:
406 558
407 borderLess console cursorBlink cursorUnderline hold iconic insecure 559 borderLess console cursorBlink cursorUnderline hold iconic insecure
408 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 560 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
409 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 561 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
410 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 562 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
411 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 563 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
412 tripleclickwords utmpInhibit visualBell 564 transparent tripleclickwords utmpInhibit visualBell
413 565
414 $value = $term->resource ($name[, $newval]) 566 $value = $term->resource ($name[, $newval])
415 Returns the current resource value associated with a given name and 567 Returns the current resource value associated with a given name and
416 optionally sets a new value. Setting values is most useful in the 568 optionally sets a new value. Setting values is most useful in the
417 "init" hook. Unset resources are returned and accepted as "undef". 569 "init" hook. Unset resources are returned and accepted as "undef".
… …
434 586
435 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 587 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
436 borderLess color cursorBlink cursorUnderline cutchars delete_key 588 borderLess color cursorBlink cursorUnderline cutchars delete_key
437 display_name embed ext_bwidth fade font geometry hold iconName 589 display_name embed ext_bwidth fade font geometry hold iconName
438 imFont imLocale inputMethod insecure int_bwidth intensityStyles 590 imFont imLocale inputMethod insecure int_bwidth intensityStyles
439 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 591 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
440 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 592 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
441 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 593 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
442 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 594 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
443 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 595 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
444 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 596 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
597 secondaryScreen secondaryScroll selectstyle shade term_name title
445 shade term_name title transparent transparent_all tripleclickwords 598 transient_for transparent transparent_all tripleclickwords utmpInhibit
446 utmpInhibit visualBell 599 visualBell
447 600
448 $value = $term->x_resource ($pattern) 601 $value = $term->x_resource ($pattern)
449 Returns the X-Resource for the given pattern, excluding the program 602 Returns the X-Resource for the given pattern, excluding the program
450 or class name, i.e. "$term->x_resource ("boldFont")" should return 603 or class name, i.e. "$term->x_resource ("boldFont")" should return
451 the same value as used by this instance of rxvt-unicode. Returns 604 the same value as used by this instance of rxvt-unicode. Returns
… …
472 ($row, $col) = $term->selection_beg ([$row, $col]) 625 ($row, $col) = $term->selection_beg ([$row, $col])
473 ($row, $col) = $term->selection_end ([$row, $col]) 626 ($row, $col) = $term->selection_end ([$row, $col])
474 Return the current values of the selection mark, begin or end 627 Return the current values of the selection mark, begin or end
475 positions, and optionally set them to new values. 628 positions, and optionally set them to new values.
476 629
630 $term->selection_make ($eventtime[, $rectangular])
631 Tries to make a selection as set by "selection_beg" and
632 "selection_end". If $rectangular is true (default: false), a
633 rectangular selection will be made. This is the prefered function to
634 make a selection.
635
477 $success = $term->selection_grab ($eventtime) 636 $success = $term->selection_grab ($eventtime)
478 Try to request the primary selection from the server (for example, 637 Try to request the primary selection text from the server (for
479 as set by the next method). 638 example, as set by the next method). No visual feedback will be
639 given. This function is mostly useful from within "on_sel_grab"
640 hooks.
480 641
481 $oldtext = $term->selection ([$newtext]) 642 $oldtext = $term->selection ([$newtext])
482 Return the current selection text and optionally replace it by 643 Return the current selection text and optionally replace it by
483 $newtext. 644 $newtext.
484 645
… …
529 $string = $term->locale_decode ($octets) 690 $string = $term->locale_decode ($octets)
530 Convert the given locale-encoded octets into a perl string. 691 Convert the given locale-encoded octets into a perl string.
531 692
532 $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 693 $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 694 XORs the rendition values in the given span with the provided value
534 (default: "RS_RVid"). Useful in refresh hooks to provide effects 695 (default: "RS_RVid"), which *MUST NOT* contain font styles. Useful
535 similar to the selection. 696 in refresh hooks to provide effects similar to the selection.
536 697
537 $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, 698 $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
538 $rstyle2]]) 699 $rstyle2]])
539 Similar to "scr_xor_span", but xors a rectangle instead. Trailing 700 Similar to "scr_xor_span", but xors a rectangle instead. Trailing
540 whitespace will additionally be xored with the $rstyle2, which 701 whitespace will additionally be xored with the $rstyle2, which
541 defaults to "RS_RVid | RS_Uline", which removes reverse video again 702 defaults to "RS_RVid | RS_Uline", which removes reverse video again
542 and underlines it instead. 703 and underlines it instead. Both styles *MUST NOT* contain font
704 styles.
543 705
544 $term->scr_bell 706 $term->scr_bell
545 Ring the bell! 707 Ring the bell!
546 708
547 $term->scr_add_lines ($string) 709 $term->scr_add_lines ($string)
… …
575 $windowid = $term->parent 737 $windowid = $term->parent
576 Return the window id of the toplevel window. 738 Return the window id of the toplevel window.
577 739
578 $windowid = $term->vt 740 $windowid = $term->vt
579 Return the window id of the terminal window. 741 Return the window id of the terminal window.
742
743 $term->vt_emask_add ($x_event_mask)
744 Adds the specified events to the vt event mask. Useful e.g. when you
745 want to receive pointer events all the times:
746
747 $term->vt_emask_add (urxvt::PointerMotionMask);
580 748
581 $window_width = $term->width 749 $window_width = $term->width
582 $window_height = $term->height 750 $window_height = $term->height
583 $font_width = $term->fwidth 751 $font_width = $term->fwidth
584 $font_height = $term->fheight 752 $font_height = $term->fheight
… …
587 $terminal_columns = $term->ncol 755 $terminal_columns = $term->ncol
588 $has_focus = $term->focus 756 $has_focus = $term->focus
589 $is_mapped = $term->mapped 757 $is_mapped = $term->mapped
590 $max_scrollback = $term->saveLines 758 $max_scrollback = $term->saveLines
591 $nrow_plus_saveLines = $term->total_rows 759 $nrow_plus_saveLines = $term->total_rows
592 $lines_in_scrollback = $term->nsaved 760 $topmost_scrollback_row = $term->top_row
593 Return various integers describing terminal characteristics. 761 Return various integers describing terminal characteristics.
594 762
595 $x_display = $term->display_id 763 $x_display = $term->display_id
596 Return the DISPLAY used by rxvt-unicode. 764 Return the DISPLAY used by rxvt-unicode.
597 765
… …
608 Return the modifier masks corresponding to the "ISO Level 3 Shift" 776 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 777 (often AltGr), the meta key (often Alt) and the num lock key, if
610 applicable. 778 applicable.
611 779
612 $view_start = $term->view_start ([$newvalue]) 780 $view_start = $term->view_start ([$newvalue])
613 Returns the negative row number of the topmost line. Minimum value 781 Returns the row number of the topmost displayed line. Maximum value
614 is 0, which displays the normal terminal contents. Larger values 782 is 0, which displays the normal terminal contents. Lower values
615 scroll this many lines into the scrollback buffer. 783 scroll this many lines into the scrollback buffer.
616 784
617 $term->want_refresh 785 $term->want_refresh
618 Requests a screen refresh. At the next opportunity, rxvt-unicode 786 Requests a screen refresh. At the next opportunity, rxvt-unicode
619 will compare the on-screen display with its stored representation. 787 will compare the on-screen display with its stored representation.
… …
687 Return the row number of the first/last row of the line, 855 Return the row number of the first/last row of the line,
688 respectively. 856 respectively.
689 857
690 $offset = $line->offset_of ($row, $col) 858 $offset = $line->offset_of ($row, $col)
691 Returns the character offset of the given row|col pair within 859 Returns the character offset of the given row|col pair within
692 the logical line. 860 the logical line. Works for rows outside the line, too, and
861 returns corresponding offsets outside the string.
693 862
694 ($row, $col) = $line->coord_of ($offset) 863 ($row, $col) = $line->coord_of ($offset)
695 Translates a string offset into terminal coordinates again. 864 Translates a string offset into terminal coordinates again.
696 865
697 $text = $term->special_encode $string 866 $text = $term->special_encode $string
… …
779 $timer = $timer->start 948 $timer = $timer->start
780 Start the timer. 949 Start the timer.
781 950
782 $timer = $timer->start ($tstamp) 951 $timer = $timer->start ($tstamp)
783 Set the event trigger time to $tstamp and start the timer. 952 Set the event trigger time to $tstamp and start the timer.
953
954 $timer = $timer->after ($delay)
955 Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
784 956
785 $timer = $timer->stop 957 $timer = $timer->stop
786 Stop the timer. 958 Stop the timer.
787 959
788 The "urxvt::iow" Class 960 The "urxvt::iow" Class
… …
827 This variable controls the verbosity level of the perl extension. Higher 999 This variable controls the verbosity level of the perl extension. Higher
828 numbers indicate more verbose output. 1000 numbers indicate more verbose output.
829 1001
830 == 0 - fatal messages 1002 == 0 - fatal messages
831 >= 3 - script loading and management 1003 >= 3 - script loading and management
832 >=10 - all events received 1004 >=10 - all called hooks
1005 >=11 - hook reutrn values
833 1006
834AUTHOR 1007AUTHOR
835 Marc Lehmann <pcg@goof.com> 1008 Marc Lehmann <pcg@goof.com>
836 http://software.schmorp.de/pkg/rxvt-unicode 1009 http://software.schmorp.de/pkg/rxvt-unicode
837 1010

Diff Legend

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