… | |
… | |
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 the following bindable keyboard command: |
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 |
… | |
… | |
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 | |
58 | searchable-scrollback<hotkey> (enabled by default) |
79 | searchable-scrollback<hotkey> (enabled by default) |
59 | Adds regex search functionality to the scrollback buffer, triggered |
80 | Adds regex search functionality to the scrollback buffer, triggered |
60 | by a hotkey (default: "M-s"). When in search mode, normal terminal |
81 | by a hotkey (default: "M-s"). While in search mode, normal terminal |
61 | input/output is suspended. |
82 | input/output is suspended and a regex is displayed at the bottom of |
|
|
83 | the screen. |
62 | |
84 | |
63 | "/" starts an incremental regex search, "n" searches further, "p" or |
85 | Inputting characters appends them to the regex and continues |
64 | "N" jump to the previous match, "G" jumps to the bottom and clears |
86 | incremental search. "BackSpace" removes a character from the regex, |
65 | the history, "enter" leaves search mode at the current position and |
87 | "Up" and "Down" search upwards/downwards in the scrollback buffer, |
66 | "escape" returns to the original position. |
88 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
|
|
89 | to the point where search was started, while "Enter" or "Return" |
|
|
90 | stay at the current position and additionally stores the first match |
|
|
91 | in the current line into the primary selection. |
67 | |
92 | |
68 | digital-clock |
93 | selection-autotransform |
69 | Displays a digital clock using the built-in overlay. |
94 | This selection allows you to do automatic transforms on a selection |
|
|
95 | whenever a selection is made. |
|
|
96 | |
|
|
97 | It works by specifying perl snippets (most useful is a single "s///" |
|
|
98 | operator) that modify $_ as resources: |
|
|
99 | |
|
|
100 | URxvt.selection-autotransform.0: transform |
|
|
101 | URxvt.selection-autotransform.1: transform |
|
|
102 | ... |
|
|
103 | |
|
|
104 | For example, the following will transform selections of the form |
|
|
105 | "filename:number", often seen in compiler messages, into "vi |
|
|
106 | +$filename $word": |
|
|
107 | |
|
|
108 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
109 | |
|
|
110 | And this example matches the same,but replaces it with vi-commands |
|
|
111 | you can paste directly into your (vi :) editor: |
|
|
112 | |
|
|
113 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
114 | |
|
|
115 | Of course, this can be modified to suit your needs and your editor |
|
|
116 | :) |
|
|
117 | |
|
|
118 | To expand the example above to typical perl error messages ("XXX at |
|
|
119 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
120 | |
|
|
121 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
122 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
123 | |
|
|
124 | The first line tells the selection code to treat the unchanging part |
|
|
125 | of every error message as a selection pattern, and the second line |
|
|
126 | transforms the message into vi commands to load the file. |
70 | |
127 | |
71 | mark-urls |
128 | mark-urls |
72 | Uses per-line display filtering ("on_line_update") to underline |
129 | Uses per-line display filtering ("on_line_update") to underline urls |
73 | urls. |
130 | and make them clickable. When middle-clicked, the program specified |
|
|
131 | in the resource "urlLauncher" (default "x-www-browser") will be |
|
|
132 | started with the URL as first argument. |
74 | |
133 | |
75 | block-graphics-to-ascii |
134 | block-graphics-to-ascii |
76 | A not very useful example of filtering all text output to the |
135 | A not very useful example of filtering all text output to the |
77 | terminal, by replacing all line-drawing characters (U+2500 .. |
136 | terminal, by replacing all line-drawing characters (U+2500 .. |
78 | U+259F) by a similar-looking ascii character. |
137 | U+259F) by a similar-looking ascii character. |
|
|
138 | |
|
|
139 | digital-clock |
|
|
140 | Displays a digital clock using the built-in overlay. |
79 | |
141 | |
80 | example-refresh-hooks |
142 | example-refresh-hooks |
81 | Displays a very simple digital clock in the upper right corner of |
143 | Displays a very simple digital clock in the upper right corner of |
82 | the window. Illustrates overwriting the refresh callbacks to create |
144 | the window. Illustrates overwriting the refresh callbacks to create |
83 | your own overlays or changes. |
145 | your own overlays or changes. |
… | |
… | |
98 | Argument names also often indicate the type of a parameter. Here are |
160 | Argument names also often indicate the type of a parameter. Here are |
99 | some hints on what they mean: |
161 | some hints on what they mean: |
100 | |
162 | |
101 | $text |
163 | $text |
102 | Rxvt-unicodes special way of encoding text, where one "unicode" |
164 | Rxvt-unicodes special way of encoding text, where one "unicode" |
103 | character always represents one screen cell. See row_t for a |
165 | character always represents one screen cell. See ROW_t for a |
104 | discussion of this format. |
166 | discussion of this format. |
105 | |
167 | |
106 | $string |
168 | $string |
107 | A perl text string, with an emphasis on *text*. It can store all |
169 | A perl text string, with an emphasis on *text*. It can store all |
108 | unicode characters and is to be distinguished with text encoded in a |
170 | unicode characters and is to be distinguished with text encoded in a |
… | |
… | |
186 | |
248 | |
187 | on_sel_extend $term |
249 | on_sel_extend $term |
188 | Called whenever the user tries to extend the selection (e.g. with a |
250 | Called whenever the user tries to extend the selection (e.g. with a |
189 | double click) and is either supposed to return false (normal |
251 | double click) and is either supposed to return false (normal |
190 | operation), or should extend the selection itelf and return true to |
252 | operation), or should extend the selection itelf and return true to |
191 | suppress the built-in processing. |
253 | suppress the built-in processing. This can happen multiple times, as |
|
|
254 | long as the callback returns true, it will be called on every |
|
|
255 | further click by the user and is supposed to enlarge the selection |
|
|
256 | more and more, if possible. |
192 | |
257 | |
193 | See the selection example extension. |
258 | See the selection example extension. |
194 | |
259 | |
195 | on_view_change $term, $offset |
260 | on_view_change $term, $offset |
196 | Called whenever the view offset changes, i..e the user or program |
261 | Called whenever the view offset changes, i..e the user or program |
… | |
… | |
254 | |
319 | |
255 | on_keyboard_command $term, $string |
320 | on_keyboard_command $term, $string |
256 | Called whenever the user presses a key combination that has a |
321 | Called whenever the user presses a key combination that has a |
257 | "perl:string" action bound to it (see description of the keysym |
322 | "perl:string" action bound to it (see description of the keysym |
258 | resource in the rxvt(1) manpage). |
323 | resource in the rxvt(1) manpage). |
|
|
324 | |
|
|
325 | on_x_event $term, $event |
|
|
326 | Called on every X event received on the vt window (and possibly |
|
|
327 | other windows). Should only be used as a last resort. Most event |
|
|
328 | structure members are not passed. |
259 | |
329 | |
260 | on_focus_in $term |
330 | on_focus_in $term |
261 | Called whenever the window gets the keyboard focus, before |
331 | Called whenever the window gets the keyboard focus, before |
262 | rxvt-unicode does focus in processing. |
332 | rxvt-unicode does focus in processing. |
263 | |
333 | |
… | |
… | |
284 | output, if any, in locale-specific encoding. |
354 | output, if any, in locale-specific encoding. |
285 | |
355 | |
286 | subwindow. |
356 | subwindow. |
287 | |
357 | |
288 | Variables in the "urxvt" Package |
358 | Variables in the "urxvt" Package |
|
|
359 | $urxvt::LIBDIR |
|
|
360 | The rxvt-unicode library directory, where, among other things, the |
|
|
361 | perl modules and scripts are stored. |
|
|
362 | |
|
|
363 | $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
364 | The resource class and name rxvt-unicode uses to look up X |
|
|
365 | resources. |
|
|
366 | |
|
|
367 | $urxvt::RXVTNAME |
|
|
368 | The basename of the installed binaries, usually "urxvt". |
|
|
369 | |
289 | $urxvt::TERM |
370 | $urxvt::TERM |
290 | The current terminal. This variable stores the current "urxvt::term" |
371 | The current terminal. This variable stores the current "urxvt::term" |
291 | object, whenever a callback/hook is executing. |
372 | object, whenever a callback/hook is executing. |
292 | |
373 | |
293 | Functions in the "urxvt" Package |
374 | Functions in the "urxvt" Package |
294 | $term = new urxvt [arg...] |
|
|
295 | Creates a new terminal, very similar as if you had started it with |
|
|
296 | "system $binfile, arg...". Croaks (and probably outputs an error |
|
|
297 | message) if the new instance couldn't be created. Returns "undef" if |
|
|
298 | the new instance didn't initialise perl, and the terminal object |
|
|
299 | otherwise. The "init" and "start" hooks will be called during the |
|
|
300 | call. |
|
|
301 | |
|
|
302 | urxvt::fatal $errormessage |
375 | urxvt::fatal $errormessage |
303 | Fatally aborts execution with the given error message. Avoid at all |
376 | Fatally aborts execution with the given error message. Avoid at all |
304 | costs! The only time this is acceptable is when the terminal process |
377 | costs! The only time this is acceptable is when the terminal process |
305 | starts up. |
378 | starts up. |
306 | |
379 | |
… | |
… | |
310 | function that calls this function. |
383 | function that calls this function. |
311 | |
384 | |
312 | Using this function has the advantage that its output ends up in the |
385 | Using this function has the advantage that its output ends up in the |
313 | correct place, e.g. on stderr of the connecting urxvtc client. |
386 | correct place, e.g. on stderr of the connecting urxvtc client. |
314 | |
387 | |
|
|
388 | Messages have a size limit of 1023 bytes currently. |
|
|
389 | |
315 | $is_safe = urxvt::safe |
390 | $is_safe = urxvt::safe |
316 | Returns true when it is safe to do potentially unsafe things, such |
391 | Returns true when it is safe to do potentially unsafe things, such |
317 | as evaluating perl code specified by the user. This is true when |
392 | as evaluating perl code specified by the user. This is true when |
318 | urxvt was started setuid or setgid. |
393 | urxvt was started setuid or setgid. |
319 | |
394 | |
… | |
… | |
322 | |
397 | |
323 | urxvt::CurrentTime |
398 | urxvt::CurrentTime |
324 | urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
399 | urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
325 | Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
400 | Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
326 | Button5Mask, AnyModifier |
401 | Button5Mask, AnyModifier |
|
|
402 | urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, |
|
|
403 | ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, |
|
|
404 | PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
405 | Button3MotionMask, Button4MotionMask, Button5MotionMask, |
|
|
406 | ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, |
|
|
407 | StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, |
|
|
408 | SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, |
|
|
409 | ColormapChangeMask, OwnerGrabButtonMask |
|
|
410 | urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
411 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
412 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
413 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
414 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
415 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
416 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
327 | Various constants for use in X calls and event processing. |
417 | Various constants for use in X calls and event processing. |
328 | |
418 | |
329 | RENDITION |
419 | RENDITION |
330 | Rendition bitsets contain information about colour, font, font styles |
420 | Rendition bitsets contain information about colour, font, font styles |
331 | and similar information for each screen cell. |
421 | and similar information for each screen cell. |
… | |
… | |
350 | |
440 | |
351 | $foreground = urxvt::GET_BASEFG $rend |
441 | $foreground = urxvt::GET_BASEFG $rend |
352 | $background = urxvt::GET_BASEBG $rend |
442 | $background = urxvt::GET_BASEBG $rend |
353 | Return the foreground/background colour index, respectively. |
443 | Return the foreground/background colour index, respectively. |
354 | |
444 | |
355 | $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
445 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
356 | $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
446 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
357 | Replace the foreground/background colour in the rendition mask with |
447 | Replace the foreground/background colour in the rendition mask with |
358 | the specified one. |
448 | the specified one. |
359 | |
449 | |
360 | $value = urxvt::GET_CUSTOM ($rend) |
450 | $value = urxvt::GET_CUSTOM $rend |
361 | Return the "custom" value: Every rendition has 5 bits for use by |
451 | Return the "custom" value: Every rendition has 5 bits for use by |
362 | extensions. They can be set and changed as you like and are |
452 | extensions. They can be set and changed as you like and are |
363 | initially zero. |
453 | initially zero. |
364 | |
454 | |
365 | $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
455 | $rend = urxvt::SET_CUSTOM $rend, $new_value |
366 | Change the custom value. |
456 | Change the custom value. |
367 | |
457 | |
368 | The "urxvt::anyevent" Class |
458 | The "urxvt::anyevent" Class |
369 | The sole purpose of this class is to deliver an interface to the |
459 | The sole purpose of this class is to deliver an interface to the |
370 | "AnyEvent" module - any module using it will work inside urxvt without |
460 | "AnyEvent" module - any module using it will work inside urxvt without |
371 | further work. The only exception is that you cannot wait on condition |
461 | further programming. The only exception is that you cannot wait on |
372 | variables, but non-blocking condvar use is ok. What this means is that |
462 | condition variables, but non-blocking condvar use is ok. What this means |
373 | you cannot use blocking APIs, but the non-blocking variant should work. |
463 | is that you cannot use blocking APIs, but the non-blocking variant |
|
|
464 | should work. |
374 | |
465 | |
375 | The "urxvt::term" Class |
466 | The "urxvt::term" Class |
|
|
467 | $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
468 | Creates a new terminal, very similar as if you had started it with |
|
|
469 | system "$rxvtname, arg...". $envhashref must be a reference to a |
|
|
470 | %ENV-like hash which defines the environment of the new terminal. |
|
|
471 | |
|
|
472 | Croaks (and probably outputs an error message) if the new instance |
|
|
473 | couldn't be created. Returns "undef" if the new instance didn't |
|
|
474 | initialise perl, and the terminal object otherwise. The "init" and |
|
|
475 | "start" hooks will be called during this call. |
|
|
476 | |
376 | $term->destroy |
477 | $term->destroy |
377 | Destroy the terminal object (close the window, free resources etc.). |
478 | Destroy the terminal object (close the window, free resources etc.). |
|
|
479 | Please note that rxvt will not exit as long as any event watchers |
|
|
480 | (timers, io watchers) are still active. |
378 | |
481 | |
379 | $isset = $term->option ($optval[, $set]) |
482 | $isset = $term->option ($optval[, $set]) |
380 | Returns true if the option specified by $optval is enabled, and |
483 | Returns true if the option specified by $optval is enabled, and |
381 | optionally change it. All option values are stored by name in the |
484 | optionally change it. All option values are stored by name in the |
382 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
485 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
… | |
… | |
424 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
527 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
425 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
528 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
426 | shade term_name title transparent transparent_all tripleclickwords |
529 | shade term_name title transparent transparent_all tripleclickwords |
427 | utmpInhibit visualBell |
530 | utmpInhibit visualBell |
428 | |
531 | |
|
|
532 | $value = $term->x_resource ($pattern) |
|
|
533 | Returns the X-Resource for the given pattern, excluding the program |
|
|
534 | or class name, i.e. "$term->x_resource ("boldFont")" should return |
|
|
535 | the same value as used by this instance of rxvt-unicode. Returns |
|
|
536 | "undef" if no resource with that pattern exists. |
|
|
537 | |
|
|
538 | This method should only be called during the "on_start" hook, as |
|
|
539 | there is only one resource database per display, and later |
|
|
540 | invocations might return the wrong resources. |
|
|
541 | |
429 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
542 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
430 | Adds a keymap translation exactly as specified via a resource. See |
543 | Adds a keymap translation exactly as specified via a resource. See |
431 | the "keysym" resource in the rxvt(1) manpage. |
544 | the "keysym" resource in the rxvt(1) manpage. |
432 | |
545 | |
433 | $rend = $term->rstyle ([$new_rstyle]) |
546 | $rend = $term->rstyle ([$new_rstyle]) |
… | |
… | |
443 | ($row, $col) = $term->selection_beg ([$row, $col]) |
556 | ($row, $col) = $term->selection_beg ([$row, $col]) |
444 | ($row, $col) = $term->selection_end ([$row, $col]) |
557 | ($row, $col) = $term->selection_end ([$row, $col]) |
445 | Return the current values of the selection mark, begin or end |
558 | Return the current values of the selection mark, begin or end |
446 | positions, and optionally set them to new values. |
559 | positions, and optionally set them to new values. |
447 | |
560 | |
|
|
561 | $term->selection_make ($eventtime[, $rectangular]) |
|
|
562 | Tries to make a selection as set by "selection_beg" and |
|
|
563 | "selection_end". If $rectangular is true (default: false), a |
|
|
564 | rectangular selection will be made. This is the prefered function to |
|
|
565 | make a selection. |
|
|
566 | |
448 | $success = $term->selection_grab ($eventtime) |
567 | $success = $term->selection_grab ($eventtime) |
449 | Try to request the primary selection from the server (for example, |
568 | Try to request the primary selection text from the server (for |
450 | as set by the next method). |
569 | example, as set by the next method). No visual feedback will be |
|
|
570 | given. This function is mostly useful from within "on_sel_grab" |
|
|
571 | hooks. |
451 | |
572 | |
452 | $oldtext = $term->selection ([$newtext]) |
573 | $oldtext = $term->selection ([$newtext]) |
453 | Return the current selection text and optionally replace it by |
574 | Return the current selection text and optionally replace it by |
454 | $newtext. |
575 | $newtext. |
455 | |
576 | |
… | |
… | |
500 | $string = $term->locale_decode ($octets) |
621 | $string = $term->locale_decode ($octets) |
501 | Convert the given locale-encoded octets into a perl string. |
622 | Convert the given locale-encoded octets into a perl string. |
502 | |
623 | |
503 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
624 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
504 | XORs the rendition values in the given span with the provided value |
625 | XORs the rendition values in the given span with the provided value |
505 | (default: "RS_RVid"). Useful in refresh hooks to provide effects |
626 | (default: "RS_RVid"), which *MUST NOT* contain font styles. Useful |
506 | similar to the selection. |
627 | in refresh hooks to provide effects similar to the selection. |
507 | |
628 | |
508 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
629 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
509 | $rstyle2]]) |
630 | $rstyle2]]) |
510 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
631 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
511 | whitespace will additionally be xored with the $rstyle2, which |
632 | whitespace will additionally be xored with the $rstyle2, which |
512 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
633 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
513 | and underlines it instead. |
634 | and underlines it instead. Both styles *MUST NOT* contain font |
|
|
635 | styles. |
514 | |
636 | |
515 | $term->scr_bell |
637 | $term->scr_bell |
516 | Ring the bell! |
638 | Ring the bell! |
517 | |
639 | |
518 | $term->scr_add_lines ($string) |
640 | $term->scr_add_lines ($string) |
… | |
… | |
546 | $windowid = $term->parent |
668 | $windowid = $term->parent |
547 | Return the window id of the toplevel window. |
669 | Return the window id of the toplevel window. |
548 | |
670 | |
549 | $windowid = $term->vt |
671 | $windowid = $term->vt |
550 | Return the window id of the terminal window. |
672 | Return the window id of the terminal window. |
|
|
673 | |
|
|
674 | $term->vt_emask_add ($x_event_mask) |
|
|
675 | Adds the specified events to the vt event mask. Useful e.g. when you |
|
|
676 | want to receive pointer events all the times: |
|
|
677 | |
|
|
678 | $term->vt_emask_add (urxvt::PointerMotionMask); |
551 | |
679 | |
552 | $window_width = $term->width |
680 | $window_width = $term->width |
553 | $window_height = $term->height |
681 | $window_height = $term->height |
554 | $font_width = $term->fwidth |
682 | $font_width = $term->fwidth |
555 | $font_height = $term->fheight |
683 | $font_height = $term->fheight |
… | |
… | |
558 | $terminal_columns = $term->ncol |
686 | $terminal_columns = $term->ncol |
559 | $has_focus = $term->focus |
687 | $has_focus = $term->focus |
560 | $is_mapped = $term->mapped |
688 | $is_mapped = $term->mapped |
561 | $max_scrollback = $term->saveLines |
689 | $max_scrollback = $term->saveLines |
562 | $nrow_plus_saveLines = $term->total_rows |
690 | $nrow_plus_saveLines = $term->total_rows |
563 | $lines_in_scrollback = $term->nsaved |
691 | $topmost_scrollback_row = $term->top_row |
564 | Return various integers describing terminal characteristics. |
692 | Return various integers describing terminal characteristics. |
|
|
693 | |
|
|
694 | $x_display = $term->display_id |
|
|
695 | Return the DISPLAY used by rxvt-unicode. |
565 | |
696 | |
566 | $lc_ctype = $term->locale |
697 | $lc_ctype = $term->locale |
567 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
698 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
568 | |
699 | |
569 | $x_display = $term->display_id |
700 | $env = $term->env |
570 | Return the DISPLAY used by rxvt-unicode. |
701 | Returns a copy of the environment in effect for the terminal as a |
|
|
702 | hashref similar to "\%ENV". |
571 | |
703 | |
572 | $modifiermask = $term->ModLevel3Mask |
704 | $modifiermask = $term->ModLevel3Mask |
573 | $modifiermask = $term->ModMetaMask |
705 | $modifiermask = $term->ModMetaMask |
574 | $modifiermask = $term->ModNumLockMask |
706 | $modifiermask = $term->ModNumLockMask |
575 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
707 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
576 | (often AltGr), the meta key (often Alt) and the num lock key, if |
708 | (often AltGr), the meta key (often Alt) and the num lock key, if |
577 | applicable. |
709 | applicable. |
578 | |
710 | |
579 | $view_start = $term->view_start ([$newvalue]) |
711 | $view_start = $term->view_start ([$newvalue]) |
580 | Returns the negative row number of the topmost line. Minimum value |
712 | Returns the row number of the topmost displayed line. Maximum value |
581 | is 0, which displays the normal terminal contents. Larger values |
713 | is 0, which displays the normal terminal contents. Lower values |
582 | scroll this many lines into the scrollback buffer. |
714 | scroll this many lines into the scrollback buffer. |
583 | |
715 | |
584 | $term->want_refresh |
716 | $term->want_refresh |
585 | Requests a screen refresh. At the next opportunity, rxvt-unicode |
717 | Requests a screen refresh. At the next opportunity, rxvt-unicode |
586 | will compare the on-screen display with its stored representation. |
718 | will compare the on-screen display with its stored representation. |
… | |
… | |
654 | Return the row number of the first/last row of the line, |
786 | Return the row number of the first/last row of the line, |
655 | respectively. |
787 | respectively. |
656 | |
788 | |
657 | $offset = $line->offset_of ($row, $col) |
789 | $offset = $line->offset_of ($row, $col) |
658 | Returns the character offset of the given row|col pair within |
790 | Returns the character offset of the given row|col pair within |
659 | the logical line. |
791 | the logical line. Works for rows outside the line, too, and |
|
|
792 | returns corresponding offsets outside the string. |
660 | |
793 | |
661 | ($row, $col) = $line->coord_of ($offset) |
794 | ($row, $col) = $line->coord_of ($offset) |
662 | Translates a string offset into terminal coordinates again. |
795 | Translates a string offset into terminal coordinates again. |
663 | |
796 | |
664 | $text = $term->special_encode $string |
797 | $text = $term->special_encode $string |
… | |
… | |
691 | Calls XUngrab for the most recent grab. Is called automatically on |
824 | Calls XUngrab for the most recent grab. Is called automatically on |
692 | evaluation errors, as it is better to lose the grab in the error |
825 | evaluation errors, as it is better to lose the grab in the error |
693 | case as the session. |
826 | case as the session. |
694 | |
827 | |
695 | The "urxvt::popup" Class |
828 | The "urxvt::popup" Class |
|
|
829 | $popup->add_title ($title) |
|
|
830 | Adds a non-clickable title to the popup. |
|
|
831 | |
|
|
832 | $popup->add_separator ([$sepchr]) |
|
|
833 | Creates a separator, optionally using the character given as |
|
|
834 | $sepchr. |
|
|
835 | |
|
|
836 | $popup->add_button ($text, $cb) |
|
|
837 | Adds a clickable button to the popup. $cb is called whenever it is |
|
|
838 | selected. |
|
|
839 | |
|
|
840 | $popup->add_toggle ($text, $cb, $initial_value) |
|
|
841 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
842 | whenever it gets toggled, with a boolean indicating its value as its |
|
|
843 | first argument. |
|
|
844 | |
|
|
845 | $popup->show |
|
|
846 | Displays the popup (which is initially hidden). |
|
|
847 | |
696 | The "urxvt::timer" Class |
848 | The "urxvt::timer" Class |
697 | This class implements timer watchers/events. Time is represented as |
849 | This class implements timer watchers/events. Time is represented as a |
698 | a fractional number of seconds since the epoch. Example: |
850 | fractional number of seconds since the epoch. Example: |
699 | |
851 | |
700 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
852 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
701 | $term->{timer} = urxvt::timer |
853 | $term->{timer} = urxvt::timer |
702 | ->new |
854 | ->new |
703 | ->interval (1) |
855 | ->interval (1) |
704 | ->cb (sub { |
856 | ->cb (sub { |
705 | $term->{overlay}->set (0, 0, |
857 | $term->{overlay}->set (0, 0, |
706 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
858 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
707 | }); |
859 | }); |
708 | |
860 | |
709 | $timer = new urxvt::timer |
861 | $timer = new urxvt::timer |
710 | Create a new timer object in started state. It is scheduled to |
862 | Create a new timer object in started state. It is scheduled to fire |
711 | fire immediately. |
863 | immediately. |
712 | |
864 | |
713 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
865 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
714 | Set the callback to be called when the timer triggers. |
866 | Set the callback to be called when the timer triggers. |
715 | |
867 | |
716 | $tstamp = $timer->at |
868 | $tstamp = $timer->at |
717 | Return the time this watcher will fire next. |
869 | Return the time this watcher will fire next. |
718 | |
870 | |
719 | $timer = $timer->set ($tstamp) |
871 | $timer = $timer->set ($tstamp) |
720 | Set the time the event is generated to $tstamp. |
872 | Set the time the event is generated to $tstamp. |
721 | |
873 | |
722 | $timer = $timer->interval ($interval) |
874 | $timer = $timer->interval ($interval) |
723 | Normally (and when $interval is 0), the timer will automatically |
875 | Normally (and when $interval is 0), the timer will automatically |
724 | stop after it has fired once. If $interval is non-zero, then the |
876 | stop after it has fired once. If $interval is non-zero, then the |
725 | timer is automatically rescheduled at the given intervals. |
877 | timer is automatically rescheduled at the given intervals. |
726 | |
878 | |
727 | $timer = $timer->start |
879 | $timer = $timer->start |
728 | Start the timer. |
880 | Start the timer. |
729 | |
881 | |
730 | $timer = $timer->start ($tstamp) |
882 | $timer = $timer->start ($tstamp) |
731 | Set the event trigger time to $tstamp and start the timer. |
883 | Set the event trigger time to $tstamp and start the timer. |
732 | |
884 | |
733 | $timer = $timer->stop |
885 | $timer = $timer->stop |
734 | Stop the timer. |
886 | Stop the timer. |
735 | |
887 | |
736 | The "urxvt::iow" Class |
888 | The "urxvt::iow" Class |
737 | This class implements io watchers/events. Example: |
889 | This class implements io watchers/events. Example: |
738 | |
890 | |
739 | $term->{socket} = ... |
891 | $term->{socket} = ... |
740 | $term->{iow} = urxvt::iow |
892 | $term->{iow} = urxvt::iow |
741 | ->new |
893 | ->new |
742 | ->fd (fileno $term->{socket}) |
894 | ->fd (fileno $term->{socket}) |
743 | ->events (urxvt::EVENT_READ) |
895 | ->events (urxvt::EVENT_READ) |
744 | ->start |
896 | ->start |
745 | ->cb (sub { |
897 | ->cb (sub { |
746 | my ($iow, $revents) = @_; |
898 | my ($iow, $revents) = @_; |
747 | # $revents must be 1 here, no need to check |
899 | # $revents must be 1 here, no need to check |
748 | sysread $term->{socket}, my $buf, 8192 |
900 | sysread $term->{socket}, my $buf, 8192 |
749 | or end-of-file; |
901 | or end-of-file; |
750 | }); |
902 | }); |
751 | |
903 | |
752 | $iow = new urxvt::iow |
904 | $iow = new urxvt::iow |
753 | Create a new io watcher object in stopped state. |
905 | Create a new io watcher object in stopped state. |
754 | |
906 | |
755 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
907 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
756 | Set the callback to be called when io events are triggered. |
908 | Set the callback to be called when io events are triggered. |
757 | $reventmask is a bitset as described in the "events" method. |
909 | $reventmask is a bitset as described in the "events" method. |
758 | |
910 | |
759 | $iow = $iow->fd ($fd) |
911 | $iow = $iow->fd ($fd) |
760 | Set the filedescriptor (not handle) to watch. |
912 | Set the filedescriptor (not handle) to watch. |
761 | |
913 | |
762 | $iow = $iow->events ($eventmask) |
914 | $iow = $iow->events ($eventmask) |
763 | Set the event mask to watch. The only allowed values are |
915 | Set the event mask to watch. The only allowed values are |
764 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be |
916 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed |
765 | ORed together, or "urxvt::EVENT_NONE". |
917 | together, or "urxvt::EVENT_NONE". |
766 | |
918 | |
767 | $iow = $iow->start |
919 | $iow = $iow->start |
768 | Start watching for requested events on the given handle. |
920 | Start watching for requested events on the given handle. |
769 | |
921 | |
770 | $iow = $iow->stop |
922 | $iow = $iow->stop |
771 | Stop watching for events on the given filehandle. |
923 | Stop watching for events on the given filehandle. |
772 | |
924 | |
773 | ENVIRONMENT |
925 | ENVIRONMENT |
774 | URXVT_PERL_VERBOSITY |
926 | URXVT_PERL_VERBOSITY |
775 | This variable controls the verbosity level of the perl extension. |
927 | This variable controls the verbosity level of the perl extension. Higher |
776 | Higher numbers indicate more verbose output. |
928 | numbers indicate more verbose output. |
777 | |
929 | |
778 | == 0 - fatal messages |
930 | == 0 - fatal messages |
779 | >= 3 - script loading and management |
931 | >= 3 - script loading and management |
780 | >=10 - all events received |
932 | >=10 - all called hooks |
|
|
933 | >=11 - hook reutrn values |
781 | |
934 | |
782 | AUTHOR |
935 | AUTHOR |
783 | Marc Lehmann <pcg@goof.com> |
936 | Marc Lehmann <pcg@goof.com> |
784 | http://software.schmorp.de/pkg/rxvt-unicode |
937 | http://software.schmorp.de/pkg/rxvt-unicode |
785 | |
938 | |