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.12 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.20 by root, Wed Jan 11 01:00:04 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
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 26PREPACKAGED 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 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). Right
37 to select urls and complete shell-quoted arguments, which is very 37 now, it tries to select urls and complete shell-quoted arguments,
38 convenient, too, if your ls supports "--quoting-style=shell". 38 which is very convenient, too, if your ls supports
39 "--quoting-style=shell".
39 40
40 It also offers the following bindable event: 41 It also offers the following bindable keyboard command:
41 42
42 rot13 43 rot13
43 Rot-13 the selection when activated. Used via keyboard trigger: 44 Rot-13 the selection when activated. Used via keyboard trigger:
44 45
45 URxvt.keysym.C-M-r: perl:selection:rot13 46 URxvt.keysym.C-M-r: perl:selection:rot13
47
48 option-popup (enabled by default)
49 Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
50 options at runtime.
51
52 selection-popup (enabled by default)
53 Binds a popup menu to Ctrl-Button3 that lets you convert the
54 selection text into various other formats/action (such as uri
55 unescaping, perl evalution, web-browser starting etc.), depending on
56 content.
57
58 searchable-scrollback<hotkey> (enabled by default)
59 Adds regex search functionality to the scrollback buffer, triggered
60 by a hotkey (default: "M-s"). When in search mode, normal terminal
61 input/output is suspended.
62
63 "/" starts an incremental regex search, "n" searches further, "p" or
64 "N" jump to the previous match, "G" jumps to the bottom and clears
65 the history, "enter" leaves search mode at the current position and
66 "escape" returns to the original position.
46 67
47 digital-clock 68 digital-clock
48 Displays a digital clock using the built-in overlay. 69 Displays a digital clock using the built-in overlay.
49 70
50 mark-urls 71 mark-urls
59 example-refresh-hooks 80 example-refresh-hooks
60 Displays a very simple digital clock in the upper right corner of 81 Displays a very simple digital clock in the upper right corner of
61 the window. Illustrates overwriting the refresh callbacks to create 82 the window. Illustrates overwriting the refresh callbacks to create
62 your own overlays or changes. 83 your own overlays or changes.
63 84
85API DOCUMENTATION
64 General API Considerations 86 General API Considerations
65 All objects (such as terminals, time watchers etc.) are typical 87 All objects (such as terminals, time watchers etc.) are typical
66 reference-to-hash objects. The hash can be used to store anything you 88 reference-to-hash objects. The hash can be used to store anything you
67 like. All members starting with an underscore (such as "_ptr" or 89 like. All members starting with an underscore (such as "_ptr" or
68 "_hook") are reserved for internal uses and MUST NOT be accessed or 90 "_hook") are reserved for internal uses and MUST NOT be accessed or
88 110
89 $octets 111 $octets
90 Either binary data or - more common - a text string encoded in a 112 Either binary data or - more common - a text string encoded in a
91 locale-specific way. 113 locale-specific way.
92 114
115 Extension Objects
116 Very perl extension is a perl class. A separate perl object is created
117 for each terminal and each extension and passed as the first parameter
118 to hooks. So extensions can use their $self object without having to
119 think about other extensions, with the exception of methods and members
120 that begin with an underscore character "_": these are reserved for
121 internal use.
122
123 Although it isn't a "urxvt::term" object, you can call all methods of
124 the "urxvt::term" class on this object.
125
126 It has the following methods and data members:
127
128 $urxvt_term = $self->{term}
129 Returns the "urxvt::term" object associated with this instance of
130 the extension. This member *must not* be changed in any way.
131
132 $self->enable ($hook_name => $cb, [$hook_name => $cb..])
133 Dynamically enable the given hooks (named without the "on_" prefix)
134 for this extension, replacing any previous hook. This is useful when
135 you want to overwrite time-critical hooks only temporarily.
136
137 $self->disable ($hook_name[, $hook_name..])
138 Dynamically disable the given hooks.
139
93 Hooks 140 Hooks
94 The following subroutines can be declared in extension files, and will 141 The following subroutines can be declared in extension files, and will
95 be called whenever the relevant event happens. 142 be called whenever the relevant event happens.
96 143
97 The first argument passed to them is an object private to each terminal 144 The first argument passed to them is an extension oject as described in
98 and extension package. You can call all "urxvt::term" methods on it, but 145 the in the "Extension Objects" section.
99 its not a real "urxvt::term" object. Instead, the real "urxvt::term"
100 object that is shared between all packages is stored in the "term"
101 member.
102 146
103 All of them must return a boolean value. If it is true, then the event 147 All of these hooks must return a boolean value. If it is true, then the
104 counts as being *consumed*, and the invocation of other hooks is 148 event counts as being *consumed*, and the invocation of other hooks is
105 skipped, and the relevant action might not be carried out by the C++ 149 skipped, and the relevant action might not be carried out by the C++
106 code. 150 code.
107 151
108 When in doubt, return a false value (preferably "()"). 152 *When in doubt, return a false value (preferably "()").*
109 153
110 on_init $term 154 on_init $term
111 Called after a new terminal object has been initialized, but before 155 Called after a new terminal object has been initialized, but before
112 windows are created or the command gets run. Most methods are unsafe 156 windows are created or the command gets run. Most methods are unsafe
113 to call or deliver senseless data, as terminal size and other 157 to call or deliver senseless data, as terminal size and other
146 operation), or should extend the selection itelf and return true to 190 operation), or should extend the selection itelf and return true to
147 suppress the built-in processing. 191 suppress the built-in processing.
148 192
149 See the selection example extension. 193 See the selection example extension.
150 194
151 on_focus_in $term
152 Called whenever the window gets the keyboard focus, before urxvt
153 does focus in processing.
154
155 on_focus_out $term
156 Called wheneever the window loses keyboard focus, before urxvt does
157 focus out processing.
158
159 on_view_change $term, $offset 195 on_view_change $term, $offset
160 Called whenever the view offset changes, i..e the user or program 196 Called whenever the view offset changes, i..e the user or program
161 scrolls. Offset 0 means display the normal terminal, positive values 197 scrolls. Offset 0 means display the normal terminal, positive values
162 show this many lines of scrollback. 198 show this many lines of scrollback.
163 199
167 may be larger than the scroll back buffer or the terminal. 203 may be larger than the scroll back buffer or the terminal.
168 204
169 It is called before lines are scrolled out (so rows 0 .. min ($lines 205 It is called before lines are scrolled out (so rows 0 .. min ($lines
170 - 1, $nrow - 1) represent the lines to be scrolled out). $saved is 206 - 1, $nrow - 1) represent the lines to be scrolled out). $saved is
171 the total number of lines that will be in the scrollback buffer. 207 the total number of lines that will be in the scrollback buffer.
172
173 on_tty_activity $term *NYI*
174 Called whenever the program(s) running in the urxvt window send
175 output.
176 208
177 on_osc_seq $term, $string 209 on_osc_seq $term, $string
178 Called whenever the ESC ] 777 ; string ST command sequence (OSC = 210 Called whenever the ESC ] 777 ; string ST command sequence (OSC =
179 operating system command) is processed. Cursor position and other 211 operating system command) is processed. Cursor position and other
180 state information is up-to-date when this happens. For 212 state information is up-to-date when this happens. For
191 argument. You can filter/change and output the text yourself by 223 argument. You can filter/change and output the text yourself by
192 returning a true value and calling "$term->scr_add_lines" yourself. 224 returning a true value and calling "$term->scr_add_lines" yourself.
193 Please note that this might be very slow, however, as your hook is 225 Please note that this might be very slow, however, as your hook is
194 called for all text being output. 226 called for all text being output.
195 227
228 on_tt_write $term, $octets
229 Called whenever some data is written to the tty/pty and can be used
230 to suppress or filter tty input.
231
196 on_line_update $term, $row 232 on_line_update $term, $row
197 Called whenever a line was updated or changed. Can be used to filter 233 Called whenever a line was updated or changed. Can be used to filter
198 screen output (e.g. underline urls or other useless stuff). Only 234 screen output (e.g. underline urls or other useless stuff). Only
199 lines that are being shown will be filtered, and, due to performance 235 lines that are being shown will be filtered, and, due to performance
200 reasons, not always immediately. 236 reasons, not always immediately.
219 on_keyboard_command $term, $string 255 on_keyboard_command $term, $string
220 Called whenever the user presses a key combination that has a 256 Called whenever the user presses a key combination that has a
221 "perl:string" action bound to it (see description of the keysym 257 "perl:string" action bound to it (see description of the keysym
222 resource in the rxvt(1) manpage). 258 resource in the rxvt(1) manpage).
223 259
260 on_focus_in $term
261 Called whenever the window gets the keyboard focus, before
262 rxvt-unicode does focus in processing.
263
264 on_focus_out $term
265 Called wheneever the window loses keyboard focus, before
266 rxvt-unicode does focus out processing.
267
224 on_key_press $term, $event, $octets 268 on_key_press $term, $event, $keysym, $octets
225 on_key_release $term, $event 269 on_key_release $term, $event, $keysym
226 on_button_press $term, $event 270 on_button_press $term, $event
227 on_button_release $term, $event 271 on_button_release $term, $event
228 on_motion_notify $term, $event 272 on_motion_notify $term, $event
273 on_map_notify $term, $event
274 on_unmap_notify $term, $event
229 Called whenever the corresponding X event is received for the 275 Called whenever the corresponding X event is received for the
230 terminal If the hook returns true, then the even will be ignored by 276 terminal If the hook returns true, then the even will be ignored by
231 rxvt-unicode. 277 rxvt-unicode.
232 278
233 The event is a hash with most values as named by Xlib (see the 279 The event is a hash with most values as named by Xlib (see the
238 output, if any, in locale-specific encoding. 284 output, if any, in locale-specific encoding.
239 285
240 subwindow. 286 subwindow.
241 287
242 Variables in the "urxvt" Package 288 Variables in the "urxvt" Package
289 $urxvt::LIBDIR
290 The rxvt-unicode library directory, where, among other things, the
291 perl modules and scripts are stored.
292
293 $urxvt::RESCLASS, $urxvt::RESCLASS
294 The resource class and name rxvt-unicode uses to look up X
295 resources.
296
297 $urxvt::RXVTNAME
298 The basename of the installed binaries, usually "urxvt".
299
243 $urxvt::TERM 300 $urxvt::TERM
244 The current terminal. This variable stores the current "urxvt::term" 301 The current terminal. This variable stores the current "urxvt::term"
245 object, whenever a callback/hook is executing. 302 object, whenever a callback/hook is executing.
246 303
304 *
305
247 Functions in the "urxvt" Package 306 Functions in the "urxvt" Package
248 $term = new urxvt [arg...]
249 Creates a new terminal, very similar as if you had started it with
250 "system $binfile, arg...". Croaks (and probably outputs an error
251 message) if the new instance couldn't be created. Returns "undef" if
252 the new instance didn't initialise perl, and the terminal object
253 otherwise. The "init" and "start" hooks will be called during the
254 call.
255
256 urxvt::fatal $errormessage 307 urxvt::fatal $errormessage
257 Fatally aborts execution with the given error message. Avoid at all 308 Fatally aborts execution with the given error message. Avoid at all
258 costs! The only time this is acceptable is when the terminal process 309 costs! The only time this is acceptable is when the terminal process
259 starts up. 310 starts up.
260 311
264 function that calls this function. 315 function that calls this function.
265 316
266 Using this function has the advantage that its output ends up in the 317 Using this function has the advantage that its output ends up in the
267 correct place, e.g. on stderr of the connecting urxvtc client. 318 correct place, e.g. on stderr of the connecting urxvtc client.
268 319
320 Messages have a size limit of 1023 bytes currently.
321
322 $is_safe = urxvt::safe
323 Returns true when it is safe to do potentially unsafe things, such
324 as evaluating perl code specified by the user. This is true when
325 urxvt was started setuid or setgid.
326
269 $time = urxvt::NOW 327 $time = urxvt::NOW
270 Returns the "current time" (as per the event loop). 328 Returns the "current time" (as per the event loop).
329
330 urxvt::CurrentTime
331 urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
332 Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
333 Button5Mask, AnyModifier
334 Various constants for use in X calls and event processing.
271 335
272 RENDITION 336 RENDITION
273 Rendition bitsets contain information about colour, font, font styles 337 Rendition bitsets contain information about colour, font, font styles
274 and similar information for each screen cell. 338 and similar information for each screen cell.
275 339
293 357
294 $foreground = urxvt::GET_BASEFG $rend 358 $foreground = urxvt::GET_BASEFG $rend
295 $background = urxvt::GET_BASEBG $rend 359 $background = urxvt::GET_BASEBG $rend
296 Return the foreground/background colour index, respectively. 360 Return the foreground/background colour index, respectively.
297 361
298 $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 362 $rend = urxvt::SET_FGCOLOR $rend, $new_colour
299 $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 363 $rend = urxvt::SET_BGCOLOR $rend, $new_colour
300 Replace the foreground/background colour in the rendition mask with 364 Replace the foreground/background colour in the rendition mask with
301 the specified one. 365 the specified one.
302 366
303 $value = urxvt::GET_CUSTOM ($rend) 367 $value = urxvt::GET_CUSTOM $rend
304 Return the "custom" value: Every rendition has 5 bits for use by 368 Return the "custom" value: Every rendition has 5 bits for use by
305 extensions. They can be set and changed as you like and are 369 extensions. They can be set and changed as you like and are
306 initially zero. 370 initially zero.
307 371
308 $rend = urxvt::SET_CUSTOM ($rend, $new_value) 372 $rend = urxvt::SET_CUSTOM $rend, $new_value
309 Change the custom value. 373 Change the custom value.
310 374
375 The "urxvt::anyevent" Class
376 The sole purpose of this class is to deliver an interface to the
377 "AnyEvent" module - any module using it will work inside urxvt without
378 further programming. The only exception is that you cannot wait on
379 condition variables, but non-blocking condvar use is ok. What this means
380 is that you cannot use blocking APIs, but the non-blocking variant
381 should work.
382
311 The "urxvt::term" Class 383 The "urxvt::term" Class
384 $term = new urxvt::term $envhashref, $rxvtname, [arg...]
385 Creates a new terminal, very similar as if you had started it with
386 system "$rxvtname, arg...". $envhashref must be a reference to a
387 %ENV>-like "hash which defines the environment of the new terminal.
388 "
389
390 >Croaks (and probably outputs an error message) if the new instance
391 couldn't be created. Returns "undef" if the new instance didn't
392 initialise perl, and the terminal object otherwise. The "init" and
393 "start" hooks will be called during this call.
394
312 $term->destroy 395 $term->destroy
313 Destroy the terminal object (close the window, free resources etc.). 396 Destroy the terminal object (close the window, free resources etc.).
397 Please note that rxvt will not exit as long as any event watchers
398 (timers, io watchers) are still active.
399
400 $isset = $term->option ($optval[, $set])
401 Returns true if the option specified by $optval is enabled, and
402 optionally change it. All option values are stored by name in the
403 hash %urxvt::OPTION. Options not enabled in this binary are not in
404 the hash.
405
406 Here is a a likely non-exhaustive list of option names, please see
407 the source file /src/optinc.h to see the actual list:
408
409 borderLess console cursorBlink cursorUnderline hold iconic insecure
410 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
411 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
412 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
413 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
414 tripleclickwords utmpInhibit visualBell
314 415
315 $value = $term->resource ($name[, $newval]) 416 $value = $term->resource ($name[, $newval])
316 Returns the current resource value associated with a given name and 417 Returns the current resource value associated with a given name and
317 optionally sets a new value. Setting values is most useful in the 418 optionally sets a new value. Setting values is most useful in the
318 "init" hook. Unset resources are returned and accepted as "undef". 419 "init" hook. Unset resources are returned and accepted as "undef".
328 Please note that resource strings will currently only be freed when 429 Please note that resource strings will currently only be freed when
329 the terminal is destroyed, so changing options frequently will eat 430 the terminal is destroyed, so changing options frequently will eat
330 memory. 431 memory.
331 432
332 Here is a a likely non-exhaustive list of resource names, not all of 433 Here is a a likely non-exhaustive list of resource names, not all of
333 which are supported in every build, please see the source to see the 434 which are supported in every build, please see the source file
334 actual list: 435 /src/rsinc.h to see the actual list:
335 436
336 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 437 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
337 borderLess color cursorBlink cursorUnderline cutchars delete_key 438 borderLess color cursorBlink cursorUnderline cutchars delete_key
338 display_name embed ext_bwidth fade font geometry hold iconName 439 display_name embed ext_bwidth fade font geometry hold iconName
339 imFont imLocale inputMethod insecure int_bwidth intensityStyles 440 imFont imLocale inputMethod insecure int_bwidth intensityStyles
344 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 445 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
345 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 446 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
346 shade term_name title transparent transparent_all tripleclickwords 447 shade term_name title transparent transparent_all tripleclickwords
347 utmpInhibit visualBell 448 utmpInhibit visualBell
348 449
450 $success = $term->parse_keysym ($keysym_spec, $command_string)
451 Adds a keymap translation exactly as specified via a resource. See
452 the "keysym" resource in the rxvt(1) manpage.
453
349 $rend = $term->rstyle ([$new_rstyle]) 454 $rend = $term->rstyle ([$new_rstyle])
350 Return and optionally change the current rendition. Text that is 455 Return and optionally change the current rendition. Text that is
351 output by the terminal application will use this style. 456 output by the terminal application will use this style.
352 457
353 ($row, $col) = $term->screen_cur ([$row, $col]) 458 ($row, $col) = $term->screen_cur ([$row, $col])
367 472
368 $oldtext = $term->selection ([$newtext]) 473 $oldtext = $term->selection ([$newtext])
369 Return the current selection text and optionally replace it by 474 Return the current selection text and optionally replace it by
370 $newtext. 475 $newtext.
371 476
372 #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line 477 $term->overlay_simple ($x, $y, $text)
373 overlay box. See the next method for details. # #=cut # #sub 478 Create a simple multi-line overlay box. See the next method for
374 urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my 479 details.
375 @lines = split /\n/, $text; # # my $w = 0; # for (map
376 $self->strwidth ($_), @lines) { # $w = $_ if $w < $_; # } # #
377 $self->scr_overlay_new ($x, $y, $w, scalar @lines); #
378 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; #}
379 480
380 $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 481 $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
381 Create a new (empty) overlay at the given position with the given 482 Create a new (empty) overlay at the given position with the given
382 width/height. $rstyle defines the initial rendition style (default: 483 width/height. $rstyle defines the initial rendition style (default:
383 "OVERLAY_RSTYLE"). 484 "OVERLAY_RSTYLE").
402 If visible, hide the overlay, but do not destroy it. 503 If visible, hide the overlay, but do not destroy it.
403 504
404 $overlay->show 505 $overlay->show
405 If hidden, display the overlay again. 506 If hidden, display the overlay again.
406 507
508 $popup = $term->popup ($event)
509 Creates a new "urxvt::popup" object that implements a popup menu.
510 The $event *must* be the event causing the menu to pop up (a button
511 event, currently).
512
407 $cellwidth = $term->strwidth ($string) 513 $cellwidth = $term->strwidth ($string)
408 Returns the number of screen-cells this string would need. Correctly 514 Returns the number of screen-cells this string would need. Correctly
409 accounts for wide and combining characters. 515 accounts for wide and combining characters.
410 516
411 $octets = $term->locale_encode ($string) 517 $octets = $term->locale_encode ($string)
412 Convert the given text string into the corresponding locale 518 Convert the given text string into the corresponding locale
413 encoding. 519 encoding.
414 520
415 $string = $term->locale_decode ($octets) 521 $string = $term->locale_decode ($octets)
416 Convert the given locale-encoded octets into a perl string. 522 Convert the given locale-encoded octets into a perl string.
523
524 $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
525 XORs the rendition values in the given span with the provided value
526 (default: "RS_RVid"). Useful in refresh hooks to provide effects
527 similar to the selection.
528
529 $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
530 $rstyle2]])
531 Similar to "scr_xor_span", but xors a rectangle instead. Trailing
532 whitespace will additionally be xored with the $rstyle2, which
533 defaults to "RS_RVid | RS_Uline", which removes reverse video again
534 and underlines it instead.
535
536 $term->scr_bell
537 Ring the bell!
417 538
418 $term->scr_add_lines ($string) 539 $term->scr_add_lines ($string)
419 Write the given text string to the screen, as if output by the 540 Write the given text string to the screen, as if output by the
420 application running inside the terminal. It may not contain command 541 application running inside the terminal. It may not contain command
421 sequences (escape codes), but is free to use line feeds, carriage 542 sequences (escape codes), but is free to use line feeds, carriage
434 $term->tt_write ($octets) 555 $term->tt_write ($octets)
435 Write the octets given in $data to the tty (i.e. as program input). 556 Write the octets given in $data to the tty (i.e. as program input).
436 To pass characters instead of octets, you should convert your 557 To pass characters instead of octets, you should convert your
437 strings first to the locale-specific encoding using 558 strings first to the locale-specific encoding using
438 "$term->locale_encode". 559 "$term->locale_encode".
560
561 $old_events = $term->pty_ev_events ([$new_events])
562 Replaces the event mask of the pty watcher by the given event mask.
563 Can be used to suppress input and output handling to the pty/tty.
564 See the description of "urxvt::timer->events". Make sure to always
565 restore the previous value.
439 566
440 $windowid = $term->parent 567 $windowid = $term->parent
441 Return the window id of the toplevel window. 568 Return the window id of the toplevel window.
442 569
443 $windowid = $term->vt 570 $windowid = $term->vt
455 $max_scrollback = $term->saveLines 582 $max_scrollback = $term->saveLines
456 $nrow_plus_saveLines = $term->total_rows 583 $nrow_plus_saveLines = $term->total_rows
457 $lines_in_scrollback = $term->nsaved 584 $lines_in_scrollback = $term->nsaved
458 Return various integers describing terminal characteristics. 585 Return various integers describing terminal characteristics.
459 586
587 $x_display = $term->display_id
588 Return the DISPLAY used by rxvt-unicode.
589
590 $lc_ctype = $term->locale
591 Returns the LC_CTYPE category string used by this rxvt-unicode.
592
593 $env = $term->env
594 Returns a copy of the environment in effect for the terminal as a
595 hashref similar to "\%ENV".
596
597 $modifiermask = $term->ModLevel3Mask
598 $modifiermask = $term->ModMetaMask
599 $modifiermask = $term->ModNumLockMask
600 Return the modifier masks corresponding to the "ISO Level 3 Shift"
601 (often AltGr), the meta key (often Alt) and the num lock key, if
602 applicable.
603
460 $view_start = $term->view_start ([$newvalue]) 604 $view_start = $term->view_start ([$newvalue])
461 Returns the negative row number of the topmost line. Minimum value 605 Returns the negative row number of the topmost line. Minimum value
462 is 0, which displays the normal terminal contents. Larger values 606 is 0, which displays the normal terminal contents. Larger values
463 scroll this many lines into the scrollback buffer. 607 scroll this many lines into the scrollback buffer.
464 608
540 the logical line. 684 the logical line.
541 685
542 ($row, $col) = $line->coord_of ($offset) 686 ($row, $col) = $line->coord_of ($offset)
543 Translates a string offset into terminal coordinates again. 687 Translates a string offset into terminal coordinates again.
544 688
545 ($row, $col) = $line->coord_of ($offset) =item $text =
546 $term->special_encode $string 689 $text = $term->special_encode $string
547 Converts a perl string into the special encoding used by 690 Converts a perl string into the special encoding used by
548 rxvt-unicode, where one character corresponds to one screen cell. 691 rxvt-unicode, where one character corresponds to one screen cell.
549 See "$term->ROW_t" for details. 692 See "$term->ROW_t" for details.
550 693
551 $string = $term->special_decode $text 694 $string = $term->special_decode $text
552 Converts rxvt-unicodes text reprsentation into a perl string. See 695 Converts rxvt-unicodes text reprsentation into a perl string. See
553 "$term->ROW_t" for details. 696 "$term->ROW_t" for details.
554 697
698 $success = $term->grab_button ($button, $modifiermask)
699 Registers a synchronous button grab. See the XGrabButton manpage.
700
701 $success = $term->grab ($eventtime[, $sync])
702 Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
703 synchronous ($sync is true). Also remembers the grab timestampe.
704
705 $term->allow_events_async
706 Calls XAllowEvents with AsyncBoth for the most recent grab.
707
708 $term->allow_events_sync
709 Calls XAllowEvents with SyncBoth for the most recent grab.
710
711 $term->allow_events_replay
712 Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
713 the most recent grab.
714
715 $term->ungrab
716 Calls XUngrab for the most recent grab. Is called automatically on
717 evaluation errors, as it is better to lose the grab in the error
718 case as the session.
719
720 The "urxvt::popup" Class
721 $popup->add_title ($title)
722 Adds a non-clickable title to the popup.
723
724 $popup->add_separator ([$sepchr])
725 Creates a separator, optionally using the character given as
726 $sepchr.
727
728 $popup->add_button ($text, $cb)
729 Adds a clickable button to the popup. $cb is called whenever it is
730 selected.
731
732 $popup->add_toggle ($text, $cb, $initial_value)
733 Adds a toggle/checkbox item to the popup. Teh callback gets called
734 whenever it gets toggled, with a boolean indicating its value as its
735 first argument.
736
737 $popup->show
738 Displays the popup (which is initially hidden).
739
555 The "urxvt::timer" Class 740 The "urxvt::timer" Class
556 This class implements timer watchers/events. Time is represented as a 741 This class implements timer watchers/events. Time is represented as
557 fractional number of seconds since the epoch. Example: 742 a fractional number of seconds since the epoch. Example:
558 743
559 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); 744 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
560 $term->{timer} = urxvt::timer 745 $term->{timer} = urxvt::timer
561 ->new 746 ->new
562 ->interval (1) 747 ->interval (1)
563 ->cb (sub { 748 ->cb (sub {
564 $term->{overlay}->set (0, 0, 749 $term->{overlay}->set (0, 0,
565 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 750 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
566 }); 751 });
567 752
568 $timer = new urxvt::timer 753 $timer = new urxvt::timer
569 Create a new timer object in started state. It is scheduled to fire 754 Create a new timer object in started state. It is scheduled to
570 immediately. 755 fire immediately.
571 756
572 $timer = $timer->cb (sub { my ($timer) = @_; ... }) 757 $timer = $timer->cb (sub { my ($timer) = @_; ... })
573 Set the callback to be called when the timer triggers. 758 Set the callback to be called when the timer triggers.
574 759
575 $tstamp = $timer->at 760 $tstamp = $timer->at
576 Return the time this watcher will fire next. 761 Return the time this watcher will fire next.
577 762
578 $timer = $timer->set ($tstamp) 763 $timer = $timer->set ($tstamp)
579 Set the time the event is generated to $tstamp. 764 Set the time the event is generated to $tstamp.
580 765
581 $timer = $timer->interval ($interval) 766 $timer = $timer->interval ($interval)
582 Normally (and when $interval is 0), the timer will automatically 767 Normally (and when $interval is 0), the timer will automatically
583 stop after it has fired once. If $interval is non-zero, then the 768 stop after it has fired once. If $interval is non-zero, then the
584 timer is automatically rescheduled at the given intervals. 769 timer is automatically rescheduled at the given intervals.
585 770
586 $timer = $timer->start 771 $timer = $timer->start
587 Start the timer. 772 Start the timer.
588 773
589 $timer = $timer->start ($tstamp) 774 $timer = $timer->start ($tstamp)
590 Set the event trigger time to $tstamp and start the timer. 775 Set the event trigger time to $tstamp and start the timer.
591 776
592 $timer = $timer->stop 777 $timer = $timer->stop
593 Stop the timer. 778 Stop the timer.
594 779
595 The "urxvt::iow" Class 780 The "urxvt::iow" Class
596 This class implements io watchers/events. Example: 781 This class implements io watchers/events. Example:
597 782
598 $term->{socket} = ... 783 $term->{socket} = ...
599 $term->{iow} = urxvt::iow 784 $term->{iow} = urxvt::iow
600 ->new 785 ->new
601 ->fd (fileno $term->{socket}) 786 ->fd (fileno $term->{socket})
602 ->events (1) # wait for read data 787 ->events (urxvt::EVENT_READ)
603 ->start 788 ->start
604 ->cb (sub { 789 ->cb (sub {
605 my ($iow, $revents) = @_; 790 my ($iow, $revents) = @_;
606 # $revents must be 1 here, no need to check 791 # $revents must be 1 here, no need to check
607 sysread $term->{socket}, my $buf, 8192 792 sysread $term->{socket}, my $buf, 8192
608 or end-of-file; 793 or end-of-file;
609 }); 794 });
610 795
611 $iow = new urxvt::iow 796 $iow = new urxvt::iow
612 Create a new io watcher object in stopped state. 797 Create a new io watcher object in stopped state.
613 798
614 $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) 799 $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
615 Set the callback to be called when io events are triggered. 800 Set the callback to be called when io events are triggered.
616 $reventmask is a bitset as described in the "events" method. 801 $reventmask is a bitset as described in the "events" method.
617 802
618 $iow = $iow->fd ($fd) 803 $iow = $iow->fd ($fd)
619 Set the filedescriptor (not handle) to watch. 804 Set the filedescriptor (not handle) to watch.
620 805
621 $iow = $iow->events ($eventmask) 806 $iow = $iow->events ($eventmask)
622 Set the event mask to watch. Bit #0 (value 1) enables watching for 807 Set the event mask to watch. The only allowed values are
623 read data, Bit #1 (value 2) enables watching for write data. 808 "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be
809 ORed together, or "urxvt::EVENT_NONE".
624 810
625 $iow = $iow->start 811 $iow = $iow->start
626 Start watching for requested events on the given handle. 812 Start watching for requested events on the given handle.
627 813
628 $iow = $iow->stop 814 $iow = $iow->stop
629 Stop watching for events on the given filehandle. 815 Stop watching for events on the given filehandle.
630 816
631ENVIRONMENT 817ENVIRONMENT
632 URXVT_PERL_VERBOSITY 818 URXVT_PERL_VERBOSITY
633 This variable controls the verbosity level of the perl extension. Higher 819 This variable controls the verbosity level of the perl extension.
634 numbers indicate more verbose output. 820 Higher numbers indicate more verbose output.
635 821
636 =0 - only fatal messages 822 == 0 - fatal messages
637 =3 - script loading and management 823 >= 3 - script loading and management
638 =10 - all events received 824 >=10 - all events received
639 825
640AUTHOR 826AUTHOR
641 Marc Lehmann <pcg@goof.com> 827 Marc Lehmann <pcg@goof.com>
642 http://software.schmorp.de/pkg/rxvt-unicode 828 http://software.schmorp.de/pkg/rxvt-unicode
643 829

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines