… | |
… | |
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 | |
16 | DESCRIPTION |
16 | DESCRIPTION |
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 |
… | |
… | |
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 | Miscellaneous selection modifications. |
35 | Intelligent selection. This extension tries to be more intelligent |
|
|
36 | when the user extends selections (double-click). Right now, it tries |
|
|
37 | to select urls and complete shell-quoted arguments, which is very |
|
|
38 | convenient, too, if your ls supports "--quoting-style=shell". |
|
|
39 | |
|
|
40 | It also offers the following bindable event: |
36 | |
41 | |
37 | rot13 |
42 | rot13 |
38 | Rot-13 the selection when activated. Used via keyboard trigger: |
43 | Rot-13 the selection when activated. Used via keyboard trigger: |
39 | |
44 | |
40 | URxvt.keysym.C-M-r: perl:selection:rot13 |
45 | URxvt.keysym.C-M-r: perl:selection:rot13 |
41 | |
46 | |
|
|
47 | option-popup (enabled by default) |
|
|
48 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
|
|
49 | options at runtime. |
|
|
50 | |
|
|
51 | selection-popup (enabled by default) |
|
|
52 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
|
|
53 | selection text into various other formats/action. |
|
|
54 | |
|
|
55 | searchable-scrollback<hotkey> (enabled by default) |
|
|
56 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
57 | by a hotkey (default: "M-s"). When in search mode, normal terminal |
|
|
58 | input/output is suspended. |
|
|
59 | |
|
|
60 | "/" starts an incremental regex search, "n" searches further, "p" or |
|
|
61 | "N" jump to the previous match, "G" jumps to the bottom and clears |
|
|
62 | the history, "enter" leaves search mode at the current position and |
|
|
63 | "escape" returns to the original position. |
|
|
64 | |
42 | digital-clock |
65 | digital-clock |
43 | Displays a digital clock using the built-in overlay. |
66 | Displays a digital clock using the built-in overlay. |
|
|
67 | |
|
|
68 | mark-urls |
|
|
69 | Uses per-line display filtering ("on_line_update") to underline |
|
|
70 | urls. |
|
|
71 | |
|
|
72 | block-graphics-to-ascii |
|
|
73 | A not very useful example of filtering all text output to the |
|
|
74 | terminal, by replacing all line-drawing characters (U+2500 .. |
|
|
75 | U+259F) by a similar-looking ascii character. |
44 | |
76 | |
45 | example-refresh-hooks |
77 | example-refresh-hooks |
46 | Displays a very simple digital clock in the upper right corner of |
78 | Displays a very simple digital clock in the upper right corner of |
47 | the window. Illustrates overwriting the refresh callbacks to create |
79 | the window. Illustrates overwriting the refresh callbacks to create |
48 | your own overlays or changes. |
80 | your own overlays or changes. |
49 | |
81 | |
50 | General API Considerations |
82 | General API Considerations |
51 | All objects (such as terminals, time watchers etc.) are typical |
83 | All objects (such as terminals, time watchers etc.) are typical |
52 | reference-to-hash objects. The hash can be used to store anything you |
84 | reference-to-hash objects. The hash can be used to store anything you |
53 | like. All members starting with an underscore (such as "_ptr" or |
85 | like. All members starting with an underscore (such as "_ptr" or |
54 | "_hook") are reserved for internal uses and must not be accessed or |
86 | "_hook") are reserved for internal uses and MUST NOT be accessed or |
55 | modified). |
87 | modified). |
56 | |
88 | |
57 | When objects are destroyed on the C++ side, the perl object hashes are |
89 | When objects are destroyed on the C++ side, the perl object hashes are |
58 | emptied, so its best to store related objects such as time watchers and |
90 | emptied, so its best to store related objects such as time watchers and |
59 | the like inside the terminal object so they get destroyed as soon as the |
91 | the like inside the terminal object so they get destroyed as soon as the |
60 | terminal is destroyed. |
92 | terminal is destroyed. |
61 | |
93 | |
|
|
94 | Argument names also often indicate the type of a parameter. Here are |
|
|
95 | some hints on what they mean: |
|
|
96 | |
|
|
97 | $text |
|
|
98 | Rxvt-unicodes special way of encoding text, where one "unicode" |
|
|
99 | character always represents one screen cell. See row_t for a |
|
|
100 | discussion of this format. |
|
|
101 | |
|
|
102 | $string |
|
|
103 | A perl text string, with an emphasis on *text*. It can store all |
|
|
104 | unicode characters and is to be distinguished with text encoded in a |
|
|
105 | specific encoding (often locale-specific) and binary data. |
|
|
106 | |
|
|
107 | $octets |
|
|
108 | Either binary data or - more common - a text string encoded in a |
|
|
109 | locale-specific way. |
|
|
110 | |
|
|
111 | Extension Objects |
|
|
112 | Very perl extension is a perl class. A separate perl object is created |
|
|
113 | for each terminal and each extension and passed as the first parameter |
|
|
114 | to hooks. So extensions can use their $self object without having to |
|
|
115 | think about other extensions, with the exception of methods and members |
|
|
116 | that begin with an underscore character "_": these are reserved for |
|
|
117 | internal use. |
|
|
118 | |
|
|
119 | Although it isn't a "urxvt::term" object, you can call all methods of |
|
|
120 | the "urxvt::term" class on this object. |
|
|
121 | |
|
|
122 | It has the following methods and data members: |
|
|
123 | |
|
|
124 | $urxvt_term = $self->{term} |
|
|
125 | Returns the "urxvt::term" object associated with this instance of |
|
|
126 | the extension. This member *must not* be changed in any way. |
|
|
127 | |
|
|
128 | $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
129 | Dynamically enable the given hooks (named without the "on_" prefix) |
|
|
130 | for this extension, replacing any previous hook. This is useful when |
|
|
131 | you want to overwrite time-critical hooks only temporarily. |
|
|
132 | |
|
|
133 | $self->disable ($hook_name[, $hook_name..]) |
|
|
134 | Dynamically disable the given hooks. |
|
|
135 | |
62 | Hooks |
136 | Hooks |
63 | The following subroutines can be declared in loaded scripts, and will be |
137 | The following subroutines can be declared in extension files, and will |
64 | called whenever the relevant event happens. |
138 | be called whenever the relevant event happens. |
65 | |
139 | |
|
|
140 | The first argument passed to them is an extension oject as described in |
|
|
141 | the in the "Extension Objects" section. |
|
|
142 | |
66 | All of them must return a boolean value. If it is true, then the event |
143 | All of these hooks must return a boolean value. If it is true, then the |
67 | counts as being *consumed*, and the invocation of other hooks is |
144 | event counts as being *consumed*, and the invocation of other hooks is |
68 | skipped, and the relevant action might not be carried out by the C++ |
145 | skipped, and the relevant action might not be carried out by the C++ |
69 | code. |
146 | code. |
70 | |
147 | |
71 | When in doubt, return a false value (preferably "()"). |
148 | *When in doubt, return a false value (preferably "()").* |
72 | |
149 | |
73 | on_init $term |
150 | on_init $term |
74 | Called after a new terminal object has been initialized, but before |
151 | Called after a new terminal object has been initialized, but before |
75 | windows are created or the command gets run. |
152 | windows are created or the command gets run. Most methods are unsafe |
|
|
153 | to call or deliver senseless data, as terminal size and other |
|
|
154 | characteristics have not yet been determined. You can safely query |
|
|
155 | and change resources, though. |
76 | |
156 | |
77 | on_reset $term |
157 | on_reset $term |
78 | Called after the screen is "reset" for any reason, such as resizing |
158 | Called after the screen is "reset" for any reason, such as resizing |
79 | or control sequences. Here is where you can react on changes to |
159 | or control sequences. Here is where you can react on changes to |
80 | size-related variables. |
160 | size-related variables. |
… | |
… | |
98 | queried and changed by calling "$term->selection". |
178 | queried and changed by calling "$term->selection". |
99 | |
179 | |
100 | Returning a true value aborts selection grabbing. It will still be |
180 | Returning a true value aborts selection grabbing. It will still be |
101 | hilighted. |
181 | hilighted. |
102 | |
182 | |
103 | on_focus_in $term |
183 | on_sel_extend $term |
104 | Called whenever the window gets the keyboard focus, before urxvt |
184 | Called whenever the user tries to extend the selection (e.g. with a |
105 | does focus in processing. |
185 | double click) and is either supposed to return false (normal |
|
|
186 | operation), or should extend the selection itelf and return true to |
|
|
187 | suppress the built-in processing. |
106 | |
188 | |
107 | on_focus_out $term |
189 | See the selection example extension. |
108 | Called wheneever the window loses keyboard focus, before urxvt does |
|
|
109 | focus out processing. |
|
|
110 | |
190 | |
111 | on_view_change $term, $offset |
191 | on_view_change $term, $offset |
112 | Called whenever the view offset changes, i..e the user or program |
192 | Called whenever the view offset changes, i..e the user or program |
113 | scrolls. Offset 0 means display the normal terminal, positive values |
193 | scrolls. Offset 0 means display the normal terminal, positive values |
114 | show this many lines of scrollback. |
194 | show this many lines of scrollback. |
… | |
… | |
120 | |
200 | |
121 | It is called before lines are scrolled out (so rows 0 .. min ($lines |
201 | It is called before lines are scrolled out (so rows 0 .. min ($lines |
122 | - 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
202 | - 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
123 | the total number of lines that will be in the scrollback buffer. |
203 | the total number of lines that will be in the scrollback buffer. |
124 | |
204 | |
125 | on_tty_activity $term *NYI* |
205 | on_osc_seq $term, $string |
126 | Called whenever the program(s) running in the urxvt window send |
206 | Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
127 | output. |
207 | operating system command) is processed. Cursor position and other |
|
|
208 | state information is up-to-date when this happens. For |
|
|
209 | interoperability, the string should start with the extension name |
|
|
210 | and a colon, to distinguish it from commands for other extensions, |
|
|
211 | and this might be enforced in the future. |
|
|
212 | |
|
|
213 | Be careful not ever to trust (in a security sense) the data you |
|
|
214 | receive, as its source can not easily be controleld (e-mail content, |
|
|
215 | messages from other users on the same system etc.). |
|
|
216 | |
|
|
217 | on_add_lines $term, $string |
|
|
218 | Called whenever text is about to be output, with the text as |
|
|
219 | argument. You can filter/change and output the text yourself by |
|
|
220 | returning a true value and calling "$term->scr_add_lines" yourself. |
|
|
221 | Please note that this might be very slow, however, as your hook is |
|
|
222 | called for all text being output. |
|
|
223 | |
|
|
224 | on_tt_write $term, $octets |
|
|
225 | Called whenever some data is written to the tty/pty and can be used |
|
|
226 | to suppress or filter tty input. |
|
|
227 | |
|
|
228 | on_line_update $term, $row |
|
|
229 | Called whenever a line was updated or changed. Can be used to filter |
|
|
230 | screen output (e.g. underline urls or other useless stuff). Only |
|
|
231 | lines that are being shown will be filtered, and, due to performance |
|
|
232 | reasons, not always immediately. |
|
|
233 | |
|
|
234 | The row number is always the topmost row of the line if the line |
|
|
235 | spans multiple rows. |
|
|
236 | |
|
|
237 | Please note that, if you change the line, then the hook might get |
|
|
238 | called later with the already-modified line (e.g. if unrelated parts |
|
|
239 | change), so you cannot just toggle rendition bits, but only set |
|
|
240 | them. |
128 | |
241 | |
129 | on_refresh_begin $term |
242 | on_refresh_begin $term |
130 | Called just before the screen gets redrawn. Can be used for overlay |
243 | Called just before the screen gets redrawn. Can be used for overlay |
131 | or similar effects by modify terminal contents in refresh_begin, and |
244 | or similar effects by modify terminal contents in refresh_begin, and |
132 | restoring them in refresh_end. The built-in overlay and selection |
245 | restoring them in refresh_end. The built-in overlay and selection |
… | |
… | |
138 | on_keyboard_command $term, $string |
251 | on_keyboard_command $term, $string |
139 | Called whenever the user presses a key combination that has a |
252 | Called whenever the user presses a key combination that has a |
140 | "perl:string" action bound to it (see description of the keysym |
253 | "perl:string" action bound to it (see description of the keysym |
141 | resource in the rxvt(1) manpage). |
254 | resource in the rxvt(1) manpage). |
142 | |
255 | |
|
|
256 | on_focus_in $term |
|
|
257 | Called whenever the window gets the keyboard focus, before |
|
|
258 | rxvt-unicode does focus in processing. |
|
|
259 | |
|
|
260 | on_focus_out $term |
|
|
261 | Called wheneever the window loses keyboard focus, before |
|
|
262 | rxvt-unicode does focus out processing. |
|
|
263 | |
|
|
264 | on_key_press $term, $event, $keysym, $octets |
|
|
265 | on_key_release $term, $event, $keysym |
|
|
266 | on_button_press $term, $event |
|
|
267 | on_button_release $term, $event |
|
|
268 | on_motion_notify $term, $event |
|
|
269 | on_map_notify $term, $event |
|
|
270 | on_unmap_notify $term, $event |
|
|
271 | Called whenever the corresponding X event is received for the |
|
|
272 | terminal If the hook returns true, then the even will be ignored by |
|
|
273 | rxvt-unicode. |
|
|
274 | |
|
|
275 | The event is a hash with most values as named by Xlib (see the |
|
|
276 | XEvent manpage), with the additional members "row" and "col", which |
|
|
277 | are the row and column under the mouse cursor. |
|
|
278 | |
|
|
279 | "on_key_press" additionally receives the string rxvt-unicode would |
|
|
280 | output, if any, in locale-specific encoding. |
|
|
281 | |
|
|
282 | subwindow. |
|
|
283 | |
|
|
284 | Variables in the "urxvt" Package |
|
|
285 | $urxvt::TERM |
|
|
286 | The current terminal. This variable stores the current "urxvt::term" |
|
|
287 | object, whenever a callback/hook is executing. |
|
|
288 | |
143 | Functions in the "urxvt" Package |
289 | Functions in the "urxvt" Package |
|
|
290 | $term = new urxvt [arg...] |
|
|
291 | Creates a new terminal, very similar as if you had started it with |
|
|
292 | "system $binfile, arg...". Croaks (and probably outputs an error |
|
|
293 | message) if the new instance couldn't be created. Returns "undef" if |
|
|
294 | the new instance didn't initialise perl, and the terminal object |
|
|
295 | otherwise. The "init" and "start" hooks will be called during the |
|
|
296 | call. |
|
|
297 | |
144 | urxvt::fatal $errormessage |
298 | urxvt::fatal $errormessage |
145 | Fatally aborts execution with the given error message. Avoid at all |
299 | Fatally aborts execution with the given error message. Avoid at all |
146 | costs! The only time this is acceptable is when the terminal process |
300 | costs! The only time this is acceptable is when the terminal process |
147 | starts up. |
301 | starts up. |
148 | |
302 | |
… | |
… | |
152 | function that calls this function. |
306 | function that calls this function. |
153 | |
307 | |
154 | Using this function has the advantage that its output ends up in the |
308 | Using this function has the advantage that its output ends up in the |
155 | correct place, e.g. on stderr of the connecting urxvtc client. |
309 | correct place, e.g. on stderr of the connecting urxvtc client. |
156 | |
310 | |
|
|
311 | $is_safe = urxvt::safe |
|
|
312 | Returns true when it is safe to do potentially unsafe things, such |
|
|
313 | as evaluating perl code specified by the user. This is true when |
|
|
314 | urxvt was started setuid or setgid. |
|
|
315 | |
157 | $time = urxvt::NOW |
316 | $time = urxvt::NOW |
158 | Returns the "current time" (as per the event loop). |
317 | Returns the "current time" (as per the event loop). |
|
|
318 | |
|
|
319 | urxvt::CurrentTime |
|
|
320 | urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
|
|
321 | Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
|
|
322 | Button5Mask, AnyModifier |
|
|
323 | Various constants for use in X calls and event processing. |
159 | |
324 | |
160 | RENDITION |
325 | RENDITION |
161 | Rendition bitsets contain information about colour, font, font styles |
326 | Rendition bitsets contain information about colour, font, font styles |
162 | and similar information for each screen cell. |
327 | and similar information for each screen cell. |
163 | |
328 | |
… | |
… | |
194 | initially zero. |
359 | initially zero. |
195 | |
360 | |
196 | $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
361 | $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
197 | Change the custom value. |
362 | Change the custom value. |
198 | |
363 | |
|
|
364 | The "urxvt::anyevent" Class |
|
|
365 | The sole purpose of this class is to deliver an interface to the |
|
|
366 | "AnyEvent" module - any module using it will work inside urxvt without |
|
|
367 | further work. The only exception is that you cannot wait on condition |
|
|
368 | variables, but non-blocking condvar use is ok. What this means is that |
|
|
369 | you cannot use blocking APIs, but the non-blocking variant should work. |
|
|
370 | |
199 | The "urxvt::term" Class |
371 | The "urxvt::term" Class |
|
|
372 | $term->destroy |
|
|
373 | Destroy the terminal object (close the window, free resources etc.). |
|
|
374 | |
|
|
375 | $isset = $term->option ($optval[, $set]) |
|
|
376 | Returns true if the option specified by $optval is enabled, and |
|
|
377 | optionally change it. All option values are stored by name in the |
|
|
378 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
|
|
379 | the hash. |
|
|
380 | |
|
|
381 | Here is a a likely non-exhaustive list of option names, please see |
|
|
382 | the source file /src/optinc.h to see the actual list: |
|
|
383 | |
|
|
384 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
385 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
386 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
387 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
388 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
389 | tripleclickwords utmpInhibit visualBell |
|
|
390 | |
200 | $value = $term->resource ($name[, $newval]) |
391 | $value = $term->resource ($name[, $newval]) |
201 | Returns the current resource value associated with a given name and |
392 | Returns the current resource value associated with a given name and |
202 | optionally sets a new value. Setting values is most useful in the |
393 | optionally sets a new value. Setting values is most useful in the |
203 | "init" hook. Unset resources are returned and accepted as "undef". |
394 | "init" hook. Unset resources are returned and accepted as "undef". |
204 | |
395 | |
… | |
… | |
213 | Please note that resource strings will currently only be freed when |
404 | Please note that resource strings will currently only be freed when |
214 | the terminal is destroyed, so changing options frequently will eat |
405 | the terminal is destroyed, so changing options frequently will eat |
215 | memory. |
406 | memory. |
216 | |
407 | |
217 | Here is a a likely non-exhaustive list of resource names, not all of |
408 | Here is a a likely non-exhaustive list of resource names, not all of |
218 | which are supported in every build, please see the source to see the |
409 | which are supported in every build, please see the source file |
219 | actual list: |
410 | /src/rsinc.h to see the actual list: |
220 | |
411 | |
221 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
412 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
222 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
413 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
223 | display_name embed ext_bwidth fade font geometry hold iconName |
414 | display_name embed ext_bwidth fade font geometry hold iconName |
224 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
415 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
225 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
416 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
226 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
417 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
227 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
418 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
228 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
419 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
229 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
420 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
230 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
421 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
231 | shade term_name title transparent transparent_all tripleclickwords |
422 | shade term_name title transparent transparent_all tripleclickwords |
232 | utmpInhibit visualBell |
423 | utmpInhibit visualBell |
233 | |
424 | |
|
|
425 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
426 | Adds a keymap translation exactly as specified via a resource. See |
|
|
427 | the "keysym" resource in the rxvt(1) manpage. |
|
|
428 | |
|
|
429 | $rend = $term->rstyle ([$new_rstyle]) |
|
|
430 | Return and optionally change the current rendition. Text that is |
|
|
431 | output by the terminal application will use this style. |
|
|
432 | |
|
|
433 | ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
434 | Return the current coordinates of the text cursor position and |
|
|
435 | optionally set it (which is usually bad as applications don't expect |
|
|
436 | that). |
|
|
437 | |
234 | ($row, $col) = $term->selection_mark ([$row, $col]) |
438 | ($row, $col) = $term->selection_mark ([$row, $col]) |
235 | ($row, $col) = $term->selection_beg ([$row, $col]) |
439 | ($row, $col) = $term->selection_beg ([$row, $col]) |
236 | ($row, $col) = $term->selection_end ([$row, $col]) |
440 | ($row, $col) = $term->selection_end ([$row, $col]) |
237 | Return the current values of the selection mark, begin or end |
441 | Return the current values of the selection mark, begin or end |
238 | positions, and optionally set them to new values. |
442 | positions, and optionally set them to new values. |
… | |
… | |
243 | |
447 | |
244 | $oldtext = $term->selection ([$newtext]) |
448 | $oldtext = $term->selection ([$newtext]) |
245 | Return the current selection text and optionally replace it by |
449 | Return the current selection text and optionally replace it by |
246 | $newtext. |
450 | $newtext. |
247 | |
451 | |
248 | #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line |
452 | $term->overlay_simple ($x, $y, $text) |
249 | overlay box. See the next method for details. # #=cut |
453 | Create a simple multi-line overlay box. See the next method for |
250 | |
454 | details. |
251 | sub urxvt::term::scr_overlay { die; my ($self, $x, $y, $text) = @_; |
|
|
252 | |
|
|
253 | my @lines = split /\n/, $text; |
|
|
254 | |
|
|
255 | my $w = 0; |
|
|
256 | for (map $self->strwidth ($_), @lines) { |
|
|
257 | $w = $_ if $w < $_; |
|
|
258 | } |
|
|
259 | |
|
|
260 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
261 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
262 | } |
|
|
263 | |
455 | |
264 | $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
456 | $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
265 | Create a new (empty) overlay at the given position with the given |
457 | Create a new (empty) overlay at the given position with the given |
266 | width/height. $rstyle defines the initial rendition style (default: |
458 | width/height. $rstyle defines the initial rendition style (default: |
267 | "OVERLAY_RSTYLE"). |
459 | "OVERLAY_RSTYLE"). |
… | |
… | |
273 | right/bottom side, respectively. |
465 | right/bottom side, respectively. |
274 | |
466 | |
275 | This method returns an urxvt::overlay object. The overlay will be |
467 | This method returns an urxvt::overlay object. The overlay will be |
276 | visible as long as the perl object is referenced. |
468 | visible as long as the perl object is referenced. |
277 | |
469 | |
278 | Currently, the only method on the "urxvt::overlay" object is "set": |
470 | The methods currently supported on "urxvt::overlay" objects are: |
279 | |
471 | |
280 | $overlay->set ($x, $y, $text, $rend) |
472 | $overlay->set ($x, $y, $text, $rend) |
281 | Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts text in |
473 | Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts |
282 | rxvt-unicode's special encoding and an array of rendition values at |
474 | text in rxvt-unicode's special encoding and an array of |
283 | a specific position inside the overlay. |
475 | rendition values at a specific position inside the overlay. |
284 | |
476 | |
|
|
477 | $overlay->hide |
|
|
478 | If visible, hide the overlay, but do not destroy it. |
|
|
479 | |
|
|
480 | $overlay->show |
|
|
481 | If hidden, display the overlay again. |
|
|
482 | |
|
|
483 | $popup = $term->popup ($event) |
|
|
484 | Creates a new "urxvt::popup" object that implements a popup menu. |
|
|
485 | The $event *must* be the event causing the menu to pop up (a button |
|
|
486 | event, currently). |
|
|
487 | |
285 | $cellwidth = $term->strwidth $string |
488 | $cellwidth = $term->strwidth ($string) |
286 | Returns the number of screen-cells this string would need. Correctly |
489 | Returns the number of screen-cells this string would need. Correctly |
287 | accounts for wide and combining characters. |
490 | accounts for wide and combining characters. |
288 | |
491 | |
289 | $octets = $term->locale_encode $string |
492 | $octets = $term->locale_encode ($string) |
290 | Convert the given text string into the corresponding locale |
493 | Convert the given text string into the corresponding locale |
291 | encoding. |
494 | encoding. |
292 | |
495 | |
293 | $string = $term->locale_decode $octets |
496 | $string = $term->locale_decode ($octets) |
294 | Convert the given locale-encoded octets into a perl string. |
497 | Convert the given locale-encoded octets into a perl string. |
|
|
498 | |
|
|
499 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
500 | XORs the rendition values in the given span with the provided value |
|
|
501 | (default: "RS_RVid"). Useful in refresh hooks to provide effects |
|
|
502 | similar to the selection. |
|
|
503 | |
|
|
504 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
|
|
505 | $rstyle2]]) |
|
|
506 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
|
|
507 | whitespace will additionally be xored with the $rstyle2, which |
|
|
508 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
|
|
509 | and underlines it instead. |
|
|
510 | |
|
|
511 | $term->scr_bell |
|
|
512 | Ring the bell! |
|
|
513 | |
|
|
514 | $term->scr_add_lines ($string) |
|
|
515 | Write the given text string to the screen, as if output by the |
|
|
516 | application running inside the terminal. It may not contain command |
|
|
517 | sequences (escape codes), but is free to use line feeds, carriage |
|
|
518 | returns and tabs. The string is a normal text string, not in |
|
|
519 | locale-dependent encoding. |
|
|
520 | |
|
|
521 | Normally its not a good idea to use this function, as programs might |
|
|
522 | be confused by changes in cursor position or scrolling. Its useful |
|
|
523 | inside a "on_add_lines" hook, though. |
|
|
524 | |
|
|
525 | $term->cmd_parse ($octets) |
|
|
526 | Similar to "scr_add_lines", but the argument must be in the |
|
|
527 | locale-specific encoding of the terminal and can contain command |
|
|
528 | sequences (escape codes) that will be interpreted. |
295 | |
529 | |
296 | $term->tt_write ($octets) |
530 | $term->tt_write ($octets) |
297 | Write the octets given in $data to the tty (i.e. as program input). |
531 | Write the octets given in $data to the tty (i.e. as program input). |
298 | To pass characters instead of octets, you should convert your |
532 | To pass characters instead of octets, you should convert your |
299 | strings first to the locale-specific encoding using |
533 | strings first to the locale-specific encoding using |
300 | "$term->locale_encode". |
534 | "$term->locale_encode". |
301 | |
535 | |
|
|
536 | $old_events = $term->pty_ev_events ([$new_events]) |
|
|
537 | Replaces the event mask of the pty watcher by the given event mask. |
|
|
538 | Can be used to suppress input and output handling to the pty/tty. |
|
|
539 | See the description of "urxvt::timer->events". Make sure to always |
|
|
540 | restore the previous value. |
|
|
541 | |
|
|
542 | $windowid = $term->parent |
|
|
543 | Return the window id of the toplevel window. |
|
|
544 | |
|
|
545 | $windowid = $term->vt |
|
|
546 | Return the window id of the terminal window. |
|
|
547 | |
|
|
548 | $window_width = $term->width |
|
|
549 | $window_height = $term->height |
|
|
550 | $font_width = $term->fwidth |
|
|
551 | $font_height = $term->fheight |
|
|
552 | $font_ascent = $term->fbase |
302 | $nrow = $term->nrow |
553 | $terminal_rows = $term->nrow |
303 | $ncol = $term->ncol |
554 | $terminal_columns = $term->ncol |
304 | Return the number of rows/columns of the terminal window (i.e. as |
555 | $has_focus = $term->focus |
305 | specified by "-geometry", excluding any scrollback). |
|
|
306 | |
|
|
307 | $nsaved = $term->nsaved |
556 | $is_mapped = $term->mapped |
308 | Returns the number of lines in the scrollback buffer. |
557 | $max_scrollback = $term->saveLines |
|
|
558 | $nrow_plus_saveLines = $term->total_rows |
|
|
559 | $lines_in_scrollback = $term->nsaved |
|
|
560 | Return various integers describing terminal characteristics. |
|
|
561 | |
|
|
562 | $lc_ctype = $term->locale |
|
|
563 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
564 | |
|
|
565 | $x_display = $term->display_id |
|
|
566 | Return the DISPLAY used by rxvt-unicode. |
|
|
567 | |
|
|
568 | $modifiermask = $term->ModLevel3Mask |
|
|
569 | $modifiermask = $term->ModMetaMask |
|
|
570 | $modifiermask = $term->ModNumLockMask |
|
|
571 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
|
|
572 | (often AltGr), the meta key (often Alt) and the num lock key, if |
|
|
573 | applicable. |
309 | |
574 | |
310 | $view_start = $term->view_start ([$newvalue]) |
575 | $view_start = $term->view_start ([$newvalue]) |
311 | Returns the negative row number of the topmost line. Minimum value |
576 | Returns the negative row number of the topmost line. Minimum value |
312 | is 0, which displays the normal terminal contents. Larger values |
577 | is 0, which displays the normal terminal contents. Larger values |
313 | scroll this many lines into the scrollback buffer. |
578 | scroll this many lines into the scrollback buffer. |
… | |
… | |
321 | |
586 | |
322 | $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
587 | $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
323 | Returns the text of the entire row with number $row_number. Row 0 is |
588 | Returns the text of the entire row with number $row_number. Row 0 is |
324 | the topmost terminal line, row "$term->$ncol-1" is the bottommost |
589 | the topmost terminal line, row "$term->$ncol-1" is the bottommost |
325 | terminal line. The scrollback buffer starts at line -1 and extends |
590 | terminal line. The scrollback buffer starts at line -1 and extends |
326 | to line "-$term->nsaved". |
591 | to line "-$term->nsaved". Nothing will be returned if a nonexistent |
|
|
592 | line is requested. |
327 | |
593 | |
328 | If $new_text is specified, it will replace characters in the current |
594 | If $new_text is specified, it will replace characters in the current |
329 | line, starting at column $start_col (default 0), which is useful to |
595 | line, starting at column $start_col (default 0), which is useful to |
330 | replace only parts of a line. The font index in the rendition will |
596 | replace only parts of a line. The font index in the rendition will |
331 | automatically be updated. |
597 | automatically be updated. |
… | |
… | |
352 | |
618 | |
353 | See the section on RENDITION, above. |
619 | See the section on RENDITION, above. |
354 | |
620 | |
355 | $length = $term->ROW_l ($row_number[, $new_length]) |
621 | $length = $term->ROW_l ($row_number[, $new_length]) |
356 | Returns the number of screen cells that are in use ("the line |
622 | Returns the number of screen cells that are in use ("the line |
357 | length"). If it is -1, then the line is part of a multiple-row |
623 | length"). Unlike the urxvt core, this returns "$term->ncol" if the |
358 | logical "line", which means all characters are in use and it is |
624 | line is joined with the following one. |
359 | continued on the next row. |
625 | |
|
|
626 | $bool = $term->is_longer ($row_number) |
|
|
627 | Returns true if the row is part of a multiple-row logical "line" |
|
|
628 | (i.e. joined with the following row), which means all characters are |
|
|
629 | in use and it is continued on the next row (and possibly a |
|
|
630 | continuation of the previous row(s)). |
|
|
631 | |
|
|
632 | $line = $term->line ($row_number) |
|
|
633 | Create and return a new "urxvt::line" object that stores information |
|
|
634 | about the logical line that row $row_number is part of. It supports |
|
|
635 | the following methods: |
|
|
636 | |
|
|
637 | $text = $line->t ([$new_text]) |
|
|
638 | Returns or replaces the full text of the line, similar to |
|
|
639 | "ROW_t" |
|
|
640 | |
|
|
641 | $rend = $line->r ([$new_rend]) |
|
|
642 | Returns or replaces the full rendition array of the line, |
|
|
643 | similar to "ROW_r" |
|
|
644 | |
|
|
645 | $length = $line->l |
|
|
646 | Returns the length of the line in cells, similar to "ROW_l". |
|
|
647 | |
|
|
648 | $rownum = $line->beg |
|
|
649 | $rownum = $line->end |
|
|
650 | Return the row number of the first/last row of the line, |
|
|
651 | respectively. |
|
|
652 | |
|
|
653 | $offset = $line->offset_of ($row, $col) |
|
|
654 | Returns the character offset of the given row|col pair within |
|
|
655 | the logical line. |
|
|
656 | |
|
|
657 | ($row, $col) = $line->coord_of ($offset) |
|
|
658 | Translates a string offset into terminal coordinates again. |
360 | |
659 | |
361 | $text = $term->special_encode $string |
660 | $text = $term->special_encode $string |
362 | Converts a perl string into the special encoding used by |
661 | Converts a perl string into the special encoding used by |
363 | rxvt-unicode, where one character corresponds to one screen cell. |
662 | rxvt-unicode, where one character corresponds to one screen cell. |
364 | See "$term->ROW_t" for details. |
663 | See "$term->ROW_t" for details. |
365 | |
664 | |
366 | $string = $term->special_decode $text |
665 | $string = $term->special_decode $text |
367 | Converts rxvt-unicodes text reprsentation into a perl string. See |
666 | Converts rxvt-unicodes text reprsentation into a perl string. See |
368 | "$term->ROW_t" for details. |
667 | "$term->ROW_t" for details. |
369 | |
668 | |
|
|
669 | $success = $term->grab_button ($button, $modifiermask) |
|
|
670 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
671 | |
|
|
672 | $success = $term->grab ($eventtime[, $sync]) |
|
|
673 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
674 | synchronous ($sync is true). Also remembers the grab timestampe. |
|
|
675 | |
|
|
676 | $term->allow_events_async |
|
|
677 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
678 | |
|
|
679 | $term->allow_events_sync |
|
|
680 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
681 | |
|
|
682 | $term->allow_events_replay |
|
|
683 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for |
|
|
684 | the most recent grab. |
|
|
685 | |
|
|
686 | $term->ungrab |
|
|
687 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
688 | evaluation errors, as it is better to lose the grab in the error |
|
|
689 | case as the session. |
|
|
690 | |
|
|
691 | The "urxvt::popup" Class |
370 | The "urxvt::timer" Class |
692 | The "urxvt::timer" Class |
371 | This class implements timer watchers/events. Time is represented as a |
693 | This class implements timer watchers/events. Time is represented as |
372 | fractional number of seconds since the epoch. Example: |
694 | a fractional number of seconds since the epoch. Example: |
373 | |
695 | |
374 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
696 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
375 | $term->{timer} = urxvt::timer |
697 | $term->{timer} = urxvt::timer |
376 | ->new |
698 | ->new |
377 | ->interval (1) |
699 | ->interval (1) |
378 | ->cb (sub { |
700 | ->cb (sub { |
379 | $term->{overlay}->set (0, 0, |
701 | $term->{overlay}->set (0, 0, |
380 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
702 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
381 | }); |
703 | }); |
382 | |
704 | |
383 | $timer = new urxvt::timer |
705 | $timer = new urxvt::timer |
384 | Create a new timer object in started state. It is scheduled to fire |
706 | Create a new timer object in started state. It is scheduled to |
385 | immediately. |
707 | fire immediately. |
386 | |
708 | |
387 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
709 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
388 | Set the callback to be called when the timer triggers. |
710 | Set the callback to be called when the timer triggers. |
389 | |
711 | |
390 | $tstamp = $timer->at |
712 | $tstamp = $timer->at |
391 | Return the time this watcher will fire next. |
713 | Return the time this watcher will fire next. |
392 | |
714 | |
393 | $timer = $timer->set ($tstamp) |
715 | $timer = $timer->set ($tstamp) |
394 | Set the time the event is generated to $tstamp. |
716 | Set the time the event is generated to $tstamp. |
395 | |
717 | |
396 | $timer = $timer->interval ($interval) |
718 | $timer = $timer->interval ($interval) |
397 | Normally (and when $interval is 0), the timer will automatically |
719 | Normally (and when $interval is 0), the timer will automatically |
398 | stop after it has fired once. If $interval is non-zero, then the |
720 | stop after it has fired once. If $interval is non-zero, then the |
399 | timer is automatically rescheduled at the given intervals. |
721 | timer is automatically rescheduled at the given intervals. |
400 | |
722 | |
401 | $timer = $timer->start |
723 | $timer = $timer->start |
402 | Start the timer. |
724 | Start the timer. |
403 | |
725 | |
404 | $timer = $timer->start ($tstamp) |
726 | $timer = $timer->start ($tstamp) |
405 | Set the event trigger time to $tstamp and start the timer. |
727 | Set the event trigger time to $tstamp and start the timer. |
406 | |
728 | |
407 | $timer = $timer->stop |
729 | $timer = $timer->stop |
408 | Stop the timer. |
730 | Stop the timer. |
409 | |
731 | |
410 | The "urxvt::iow" Class |
732 | The "urxvt::iow" Class |
411 | This class implements io watchers/events. Example: |
733 | This class implements io watchers/events. Example: |
412 | |
734 | |
413 | $term->{socket} = ... |
735 | $term->{socket} = ... |
414 | $term->{iow} = urxvt::iow |
736 | $term->{iow} = urxvt::iow |
415 | ->new |
737 | ->new |
416 | ->fd (fileno $term->{socket}) |
738 | ->fd (fileno $term->{socket}) |
417 | ->events (1) # wait for read data |
739 | ->events (urxvt::EVENT_READ) |
418 | ->start |
740 | ->start |
419 | ->cb (sub { |
741 | ->cb (sub { |
420 | my ($iow, $revents) = @_; |
742 | my ($iow, $revents) = @_; |
421 | # $revents must be 1 here, no need to check |
743 | # $revents must be 1 here, no need to check |
422 | sysread $term->{socket}, my $buf, 8192 |
744 | sysread $term->{socket}, my $buf, 8192 |
423 | or end-of-file; |
745 | or end-of-file; |
424 | }); |
746 | }); |
425 | |
747 | |
426 | $iow = new urxvt::iow |
748 | $iow = new urxvt::iow |
427 | Create a new io watcher object in stopped state. |
749 | Create a new io watcher object in stopped state. |
428 | |
750 | |
429 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
751 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
430 | Set the callback to be called when io events are triggered. |
752 | Set the callback to be called when io events are triggered. |
431 | $reventmask is a bitset as described in the "events" method. |
753 | $reventmask is a bitset as described in the "events" method. |
432 | |
754 | |
433 | $iow = $iow->fd ($fd) |
755 | $iow = $iow->fd ($fd) |
434 | Set the filedescriptor (not handle) to watch. |
756 | Set the filedescriptor (not handle) to watch. |
435 | |
757 | |
436 | $iow = $iow->events ($eventmask) |
758 | $iow = $iow->events ($eventmask) |
437 | Set the event mask to watch. Bit #0 (value 1) enables watching for |
759 | Set the event mask to watch. The only allowed values are |
438 | read data, Bit #1 (value 2) enables watching for write data. |
760 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be |
|
|
761 | ORed together, or "urxvt::EVENT_NONE". |
439 | |
762 | |
440 | $iow = $iow->start |
763 | $iow = $iow->start |
441 | Start watching for requested events on the given handle. |
764 | Start watching for requested events on the given handle. |
442 | |
765 | |
443 | $iow = $iow->stop |
766 | $iow = $iow->stop |
444 | Stop watching for events on the given filehandle. |
767 | Stop watching for events on the given filehandle. |
445 | |
768 | |
446 | ENVIRONMENT |
769 | ENVIRONMENT |
447 | URXVT_PERL_VERBOSITY |
770 | URXVT_PERL_VERBOSITY |
448 | This variable controls the verbosity level of the perl extension. Higher |
771 | This variable controls the verbosity level of the perl extension. |
449 | numbers indicate more verbose output. |
772 | Higher numbers indicate more verbose output. |
450 | |
773 | |
451 | 0 - only fatal messages |
774 | == 0 - fatal messages |
452 | 3 - script loading and management |
775 | >= 3 - script loading and management |
453 | 10 - all events received |
776 | >=10 - all events received |
454 | |
777 | |
455 | AUTHOR |
778 | AUTHOR |
456 | Marc Lehmann <pcg@goof.com> |
779 | Marc Lehmann <pcg@goof.com> |
457 | http://software.schmorp.de/pkg/rxvt-unicode |
780 | http://software.schmorp.de/pkg/rxvt-unicode |
458 | |
781 | |