… | |
… | |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Everytime a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
27 | |
27 | |
… | |
… | |
62 | URxvt.selection.pattern-1: perl-regex |
62 | URxvt.selection.pattern-1: perl-regex |
63 | ... |
63 | ... |
64 | |
64 | |
65 | The index number (0, 1...) must not have any holes, and each regex must |
65 | The index number (0, 1...) must not have any holes, and each regex must |
66 | contain at least one pair of capturing parentheses, which will be used for |
66 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the following adds a regex that matches everything |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
71 | |
71 | |
72 | Another example: Programs I use often output "absolute path: " at the |
72 | Another example: Programs I use often output "absolute path: " at the |
… | |
… | |
94 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
95 | |
95 | |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
97 | runtime. |
97 | runtime. |
98 | |
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's sole argument is the popup menu, which can be modified. It should |
|
|
104 | either return nothing or a string, the initial boolean value and a code |
|
|
105 | reference. The string will be used as button text and the code reference |
|
|
106 | will be called when the toggle changes, with the new boolean value as |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
|
|
115 | |
99 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
100 | |
117 | |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
102 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
103 | evaluation, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
104 | |
121 | |
105 | Other extensions can extend this popup menu by pushing a code reference |
122 | Other extensions can extend this popup menu by pushing a code reference |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
107 | popup is displayed. |
124 | popup is being displayed. |
108 | |
125 | |
109 | It's sole argument is the popup menu, which can be modified. The selection |
126 | It's sole argument is the popup menu, which can be modified. The selection |
110 | is in C<$_>, which can be used to decide wether to add something or not. |
127 | is in C<$_>, which can be used to decide whether to add something or not. |
111 | It should either return nothing or a string and a code reference. The |
128 | It should either return nothing or a string and a code reference. The |
112 | string will be used as button text and the code reference will be called |
129 | string will be used as button text and the code reference will be called |
113 | when the button gets activated and should transform C<$_>. |
130 | when the button gets activated and should transform C<$_>. |
114 | |
131 | |
115 | The following will add an entry C<a to b> that transforms all C<a>s in |
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
… | |
… | |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
136 | additionally stores the first match in the current line into the primary |
153 | additionally stores the first match in the current line into the primary |
137 | selection. |
154 | selection. |
138 | |
155 | |
|
|
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
159 | |
|
|
160 | See L<perlre> for more info about perl regular expression syntax. |
|
|
161 | |
139 | =item readline (enabled by default) |
162 | =item readline (enabled by default) |
140 | |
163 | |
141 | A support package that tries to make editing with readline easier. At the |
164 | A support package that tries to make editing with readline easier. At |
142 | moment, it reacts to clicking with the left mouse button by trying to |
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
143 | move the text cursor to this position. It does so by generating as many |
166 | move the text cursor to this position. It does so by generating as many |
144 | cursor-left or cursor-right keypresses as required (the this only works |
167 | cursor-left or cursor-right keypresses as required (the this only works |
145 | for programs that correctly support wide characters). |
168 | for programs that correctly support wide characters). |
146 | |
169 | |
147 | To avoid too many false positives, this is only done when: |
170 | To avoid too many false positives, this is only done when: |
… | |
… | |
197 | the message into vi commands to load the file. |
220 | the message into vi commands to load the file. |
198 | |
221 | |
199 | =item tabbed |
222 | =item tabbed |
200 | |
223 | |
201 | This transforms the terminal into a tabbar with additional terminals, that |
224 | This transforms the terminal into a tabbar with additional terminals, that |
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
225 | is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
226 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
204 | button per tab. |
227 | button per tab. |
205 | |
228 | |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
229 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
208 | while B<Shift-Down> creates a new tab. |
231 | while B<Shift-Down> creates a new tab. |
|
|
232 | |
|
|
233 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
234 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
235 | following four resources (shown with defaults): |
|
|
236 | |
|
|
237 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
238 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
239 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
241 | |
|
|
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
243 | indices. |
209 | |
244 | |
210 | =item mark-urls |
245 | =item mark-urls |
211 | |
246 | |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
247 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
213 | make them clickable. When middle-clicked, the program specified in the |
248 | make them clickable. When middle-clicked, the program specified in the |
… | |
… | |
224 | You enable it by specifying this extension and a preedit style of |
259 | You enable it by specifying this extension and a preedit style of |
225 | C<OnTheSpot>, i.e.: |
260 | C<OnTheSpot>, i.e.: |
226 | |
261 | |
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
228 | |
263 | |
|
|
264 | =item kuake<hotkey> |
|
|
265 | |
|
|
266 | A very primitive quake-console-like extension. It was inspired by a |
|
|
267 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
268 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
269 | will show or hide itself. Another press of the accelerator key will hide |
|
|
270 | or show it again. |
|
|
271 | |
|
|
272 | Initially, the window will not be shown when using this extension. |
|
|
273 | |
|
|
274 | This is useful if you need a single terminal thats not using any desktop |
|
|
275 | space most of the time but is quickly available at the press of a key. |
|
|
276 | |
|
|
277 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
278 | extension will actually grab a physical key just for this function. |
|
|
279 | |
|
|
280 | If you want a quake-like animation, tell your window manager to do so |
|
|
281 | (fvwm can do it). |
|
|
282 | |
229 | =item automove-background |
283 | =item automove-background |
230 | |
284 | |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
285 | This is basically a very small extension that dynamically changes the |
232 | to the window position, in effect creating the same effect as pseudo transparency with |
286 | background pixmap offset to the window position, in effect creating the |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
287 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
288 | supported in this mode. Example: |
234 | |
289 | |
235 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
236 | |
291 | |
237 | =item block-graphics-to-ascii |
292 | =item block-graphics-to-ascii |
238 | |
293 | |
239 | A not very useful example of filtering all text output to the terminal, |
294 | A not very useful example of filtering all text output to the terminal |
240 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
295 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
241 | similar-looking ascii character. |
296 | similar-looking ascii character. |
242 | |
297 | |
243 | =item digital-clock |
298 | =item digital-clock |
244 | |
299 | |
245 | Displays a digital clock using the built-in overlay. |
300 | Displays a digital clock using the built-in overlay. |
246 | |
301 | |
247 | =item remote-selection |
302 | =item remote-clipboard |
248 | |
303 | |
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
304 | Somewhat of a misnomer, this extension adds two menu entries to the |
250 | selection popup that allows one ti run external commands to store the |
305 | selection popup that allows one ti run external commands to store the |
251 | selection somewhere and fetch it again. |
306 | selection somewhere and fetch it again. |
252 | |
307 | |
… | |
… | |
290 | After a successful upload the selection will be replaced by the text given |
345 | After a successful upload the selection will be replaced by the text given |
291 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
346 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
292 | for the filename): |
347 | for the filename): |
293 | |
348 | |
294 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
349 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
350 | |
|
|
351 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
352 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
353 | which works regardless of wether xrdb is used to parse the resource file |
|
|
354 | or not. |
295 | |
355 | |
296 | =item example-refresh-hooks |
356 | =item example-refresh-hooks |
297 | |
357 | |
298 | Displays a very simple digital clock in the upper right corner of the |
358 | Displays a very simple digital clock in the upper right corner of the |
299 | window. Illustrates overwriting the refresh callbacks to create your own |
359 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
339 | |
399 | |
340 | =back |
400 | =back |
341 | |
401 | |
342 | =head2 Extension Objects |
402 | =head2 Extension Objects |
343 | |
403 | |
344 | Very perl extension is a perl class. A separate perl object is created |
404 | Every perl extension is a perl class. A separate perl object is created |
345 | for each terminal and each extension and passed as the first parameter to |
405 | for each terminal, and each terminal has its own set of extenion objects, |
346 | hooks. So extensions can use their C<$self> object without having to think |
406 | which are passed as the first parameter to hooks. So extensions can use |
347 | about other extensions, with the exception of methods and members that |
407 | their C<$self> object without having to think about clashes with other |
|
|
408 | extensions or other terminals, with the exception of methods and members |
348 | begin with an underscore character C<_>: these are reserved for internal |
409 | that begin with an underscore character C<_>: these are reserved for |
349 | use. |
410 | internal use. |
350 | |
411 | |
351 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
412 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
352 | C<urxvt::term> class on this object. |
413 | C<urxvt::term> class on this object. |
353 | |
414 | |
354 | It has the following methods and data members: |
415 | It has the following methods and data members: |
… | |
… | |
375 | =head2 Hooks |
436 | =head2 Hooks |
376 | |
437 | |
377 | The following subroutines can be declared in extension files, and will be |
438 | The following subroutines can be declared in extension files, and will be |
378 | called whenever the relevant event happens. |
439 | called whenever the relevant event happens. |
379 | |
440 | |
380 | The first argument passed to them is an extension oject as described in |
441 | The first argument passed to them is an extension object as described in |
381 | the in the C<Extension Objects> section. |
442 | the in the C<Extension Objects> section. |
382 | |
443 | |
383 | B<All> of these hooks must return a boolean value. If any of the called |
444 | B<All> of these hooks must return a boolean value. If any of the called |
384 | hooks returns true, then the event counts as being I<consumed>, and the |
445 | hooks returns true, then the event counts as being I<consumed>, and the |
385 | relevant action might not be carried out by the C++ code. |
446 | relevant action might not be carried out by the C++ code. |
… | |
… | |
398 | place. |
459 | place. |
399 | |
460 | |
400 | =item on_start $term |
461 | =item on_start $term |
401 | |
462 | |
402 | Called at the very end of initialisation of a new terminal, just before |
463 | Called at the very end of initialisation of a new terminal, just before |
403 | trying to map (display) the toplevel and returning to the mainloop. |
464 | trying to map (display) the toplevel and returning to the main loop. |
404 | |
465 | |
405 | =item on_destroy $term |
466 | =item on_destroy $term |
406 | |
467 | |
407 | Called whenever something tries to destroy terminal, when the terminal is |
468 | Called whenever something tries to destroy terminal, when the terminal is |
408 | still fully functional (not for long, though). |
469 | still fully functional (not for long, though). |
… | |
… | |
435 | |
496 | |
436 | Called whenever a selection has been copied, but before the selection is |
497 | Called whenever a selection has been copied, but before the selection is |
437 | requested from the server. The selection text can be queried and changed |
498 | requested from the server. The selection text can be queried and changed |
438 | by calling C<< $term->selection >>. |
499 | by calling C<< $term->selection >>. |
439 | |
500 | |
440 | Returning a true value aborts selection grabbing. It will still be hilighted. |
501 | Returning a true value aborts selection grabbing. It will still be highlighted. |
441 | |
502 | |
442 | =item on_sel_extend $term |
503 | =item on_sel_extend $term |
443 | |
504 | |
444 | Called whenever the user tries to extend the selection (e.g. with a double |
505 | Called whenever the user tries to extend the selection (e.g. with a double |
445 | click) and is either supposed to return false (normal operation), or |
506 | click) and is either supposed to return false (normal operation), or |
446 | should extend the selection itelf and return true to suppress the built-in |
507 | should extend the selection itself and return true to suppress the built-in |
447 | processing. This can happen multiple times, as long as the callback |
508 | processing. This can happen multiple times, as long as the callback |
448 | returns true, it will be called on every further click by the user and is |
509 | returns true, it will be called on every further click by the user and is |
449 | supposed to enlarge the selection more and more, if possible. |
510 | supposed to enlarge the selection more and more, if possible. |
450 | |
511 | |
451 | See the F<selection> example extension. |
512 | See the F<selection> example extension. |
452 | |
513 | |
453 | =item on_view_change $term, $offset |
514 | =item on_view_change $term, $offset |
454 | |
515 | |
455 | Called whenever the view offset changes, i..e the user or program |
516 | Called whenever the view offset changes, i.e. the user or program |
456 | scrolls. Offset C<0> means display the normal terminal, positive values |
517 | scrolls. Offset C<0> means display the normal terminal, positive values |
457 | show this many lines of scrollback. |
518 | show this many lines of scrollback. |
458 | |
519 | |
459 | =item on_scroll_back $term, $lines, $saved |
520 | =item on_scroll_back $term, $lines, $saved |
460 | |
521 | |
… | |
… | |
464 | |
525 | |
465 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
526 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
466 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
527 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
467 | number of lines that will be in the scrollback buffer. |
528 | number of lines that will be in the scrollback buffer. |
468 | |
529 | |
|
|
530 | =item on_osc_seq $term, $op, $args |
|
|
531 | |
|
|
532 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
533 | behaviour. The default should be to return an empty list. A true value |
|
|
534 | suppresses execution of the request completely. Make sure you don't get |
|
|
535 | confused by recursive invocations when you output an osc sequence within |
|
|
536 | this callback. |
|
|
537 | |
|
|
538 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
539 | |
469 | =item on_osc_seq $term, $string |
540 | =item on_osc_seq_perl $term, $string |
470 | |
541 | |
471 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
542 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
472 | operating system command) is processed. Cursor position and other state |
543 | operating system command) is processed. Cursor position and other state |
473 | information is up-to-date when this happens. For interoperability, the |
544 | information is up-to-date when this happens. For interoperability, the |
474 | string should start with the extension name and a colon, to distinguish |
545 | string should start with the extension name and a colon, to distinguish |
475 | it from commands for other extensions, and this might be enforced in the |
546 | it from commands for other extensions, and this might be enforced in the |
476 | future. |
547 | future. |
477 | |
548 | |
478 | Be careful not ever to trust (in a security sense) the data you receive, |
549 | Be careful not ever to trust (in a security sense) the data you receive, |
479 | as its source can not easily be controleld (e-mail content, messages from |
550 | as its source can not easily be controlled (e-mail content, messages from |
480 | other users on the same system etc.). |
551 | other users on the same system etc.). |
481 | |
552 | |
482 | =item on_add_lines $term, $string |
553 | =item on_add_lines $term, $string |
483 | |
554 | |
484 | Called whenever text is about to be output, with the text as argument. You |
555 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
515 | |
586 | |
516 | =item on_refresh_end $term |
587 | =item on_refresh_end $term |
517 | |
588 | |
518 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
589 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
519 | |
590 | |
520 | =item on_keyboard_command $term, $string |
591 | =item on_user_command $term, $string |
521 | |
592 | |
522 | Called whenever the user presses a key combination that has a |
593 | Called whenever a user-configured event is being activated (e.g. via |
523 | C<perl:string> action bound to it (see description of the B<keysym> |
594 | a C<perl:string> action bound to a key, see description of the B<keysym> |
524 | resource in the @@RXVT_NAME@@(1) manpage). |
595 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
596 | |
|
|
597 | The event is simply the action string. This interface is assumed to change |
|
|
598 | slightly in the future. |
|
|
599 | |
|
|
600 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
601 | |
|
|
602 | Called just after the new window size has been calculated, but before |
|
|
603 | windows are actually being resized or hints are being set. If this hook |
|
|
604 | returns TRUE, setting of the window hints is being skipped. |
525 | |
605 | |
526 | =item on_x_event $term, $event |
606 | =item on_x_event $term, $event |
527 | |
607 | |
528 | Called on every X event received on the vt window (and possibly other |
608 | Called on every X event received on the vt window (and possibly other |
529 | windows). Should only be used as a last resort. Most event structure |
609 | windows). Should only be used as a last resort. Most event structure |
530 | members are not passed. |
610 | members are not passed. |
531 | |
611 | |
|
|
612 | =item on_root_event $term, $event |
|
|
613 | |
|
|
614 | Like C<on_x_event>, but is called for events on the root window. |
|
|
615 | |
532 | =item on_focus_in $term |
616 | =item on_focus_in $term |
533 | |
617 | |
534 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
618 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
535 | does focus in processing. |
619 | does focus in processing. |
536 | |
620 | |
537 | =item on_focus_out $term |
621 | =item on_focus_out $term |
538 | |
622 | |
539 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
623 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
540 | focus out processing. |
624 | focus out processing. |
541 | |
625 | |
542 | =item on_configure_notify $term, $event |
626 | =item on_configure_notify $term, $event |
543 | |
627 | |
544 | =item on_property_notify $term, $event |
628 | =item on_property_notify $term, $event |
… | |
… | |
627 | The current terminal. This variable stores the current C<urxvt::term> |
711 | The current terminal. This variable stores the current C<urxvt::term> |
628 | object, whenever a callback/hook is executing. |
712 | object, whenever a callback/hook is executing. |
629 | |
713 | |
630 | =item @urxvt::TERM_INIT |
714 | =item @urxvt::TERM_INIT |
631 | |
715 | |
632 | All coderefs in this array will be called as methods of the next newly |
716 | All code references in this array will be called as methods of the next newly |
633 | created C<urxvt::term> object (during the C<on_init> phase). The array |
717 | created C<urxvt::term> object (during the C<on_init> phase). The array |
634 | gets cleared before the codereferences that were in it are being executed, |
718 | gets cleared before the code references that were in it are being executed, |
635 | so coderefs can push themselves onto it again if they so desire. |
719 | so references can push themselves onto it again if they so desire. |
636 | |
720 | |
637 | This complements to the perl-eval commandline option, but gets executed |
721 | This complements to the perl-eval command line option, but gets executed |
638 | first. |
722 | first. |
639 | |
723 | |
640 | =item @urxvt::TERM_EXT |
724 | =item @urxvt::TERM_EXT |
641 | |
725 | |
642 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
726 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
663 | |
747 | |
664 | Using this function has the advantage that its output ends up in the |
748 | Using this function has the advantage that its output ends up in the |
665 | correct place, e.g. on stderr of the connecting urxvtc client. |
749 | correct place, e.g. on stderr of the connecting urxvtc client. |
666 | |
750 | |
667 | Messages have a size limit of 1023 bytes currently. |
751 | Messages have a size limit of 1023 bytes currently. |
|
|
752 | |
|
|
753 | =item @terms = urxvt::termlist |
|
|
754 | |
|
|
755 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
756 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
757 | objects that have perl extensions attached will be returned (because there |
|
|
758 | is no urxvt::term objet associated with others). |
668 | |
759 | |
669 | =item $time = urxvt::NOW |
760 | =item $time = urxvt::NOW |
670 | |
761 | |
671 | Returns the "current time" (as per the event loop). |
762 | Returns the "current time" (as per the event loop). |
672 | |
763 | |
… | |
… | |
730 | Return the foreground/background colour index, respectively. |
821 | Return the foreground/background colour index, respectively. |
731 | |
822 | |
732 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
823 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
733 | |
824 | |
734 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
825 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
826 | |
|
|
827 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
735 | |
828 | |
736 | Replace the foreground/background colour in the rendition mask with the |
829 | Replace the foreground/background colour in the rendition mask with the |
737 | specified one. |
830 | specified one. |
738 | |
831 | |
739 | =item $value = urxvt::GET_CUSTOM $rend |
832 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
830 | } else { |
923 | } else { |
831 | $ext_arg{$_} ||= []; |
924 | $ext_arg{$_} ||= []; |
832 | } |
925 | } |
833 | } |
926 | } |
834 | |
927 | |
835 | while (my ($ext, $argv) = each %ext_arg) { |
928 | for my $ext (sort keys %ext_arg) { |
836 | my @files = grep -f $_, map "$_/$ext", @dirs; |
929 | my @files = grep -f $_, map "$_/$ext", @dirs; |
837 | |
930 | |
838 | if (@files) { |
931 | if (@files) { |
839 | $TERM->register_package (extension_package $files[0], $argv); |
932 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
840 | } else { |
933 | } else { |
841 | warn "perl extension '$ext' not found in perl library search path\n"; |
934 | warn "perl extension '$ext' not found in perl library search path\n"; |
842 | } |
935 | } |
843 | } |
936 | } |
844 | |
937 | |
… | |
… | |
850 | |
943 | |
851 | if (my $cb = $TERM->{_hook}[$htype]) { |
944 | if (my $cb = $TERM->{_hook}[$htype]) { |
852 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
945 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
853 | if $verbosity >= 10; |
946 | if $verbosity >= 10; |
854 | |
947 | |
855 | keys %$cb; |
948 | for my $pkg (keys %$cb) { |
856 | |
|
|
857 | while (my ($pkg, $cb) = each %$cb) { |
|
|
858 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
949 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
859 | $retval ||= $retval_; |
950 | $retval ||= $retval_; |
860 | |
951 | |
861 | if ($@) { |
952 | if ($@) { |
862 | $TERM->ungrab; # better to lose the grab than the session |
953 | $TERM->ungrab; # better to lose the grab than the session |
863 | warn $@; |
954 | warn $@; |
… | |
… | |
875 | # clear package |
966 | # clear package |
876 | %$TERM = (); |
967 | %$TERM = (); |
877 | } |
968 | } |
878 | |
969 | |
879 | $retval |
970 | $retval |
|
|
971 | } |
|
|
972 | |
|
|
973 | sub SET_COLOR($$$) { |
|
|
974 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
880 | } |
975 | } |
881 | |
976 | |
882 | # urxvt::term::extension |
977 | # urxvt::term::extension |
883 | |
978 | |
884 | package urxvt::term::extension; |
979 | package urxvt::term::extension; |
… | |
… | |
1053 | hash which defines the environment of the new terminal. |
1148 | hash which defines the environment of the new terminal. |
1054 | |
1149 | |
1055 | Croaks (and probably outputs an error message) if the new instance |
1150 | Croaks (and probably outputs an error message) if the new instance |
1056 | couldn't be created. Returns C<undef> if the new instance didn't |
1151 | couldn't be created. Returns C<undef> if the new instance didn't |
1057 | initialise perl, and the terminal object otherwise. The C<init> and |
1152 | initialise perl, and the terminal object otherwise. The C<init> and |
1058 | C<start> hooks will be called during this call. |
1153 | C<start> hooks will be called before this call returns, and are free to |
|
|
1154 | refer to global data (which is race free). |
1059 | |
1155 | |
1060 | =cut |
1156 | =cut |
1061 | |
1157 | |
1062 | sub new { |
1158 | sub new { |
1063 | my ($class, $env, @args) = @_; |
1159 | my ($class, $env, @args) = @_; |
1064 | |
1160 | |
|
|
1161 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1162 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1163 | |
1065 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1164 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1066 | } |
1165 | } |
1067 | |
1166 | |
1068 | =item $term->destroy |
1167 | =item $term->destroy |
1069 | |
1168 | |
1070 | Destroy the terminal object (close the window, free resources |
1169 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1100 | |
1199 | |
1101 | Returns true if the option specified by C<$optval> is enabled, and |
1200 | Returns true if the option specified by C<$optval> is enabled, and |
1102 | optionally change it. All option values are stored by name in the hash |
1201 | optionally change it. All option values are stored by name in the hash |
1103 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1202 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1104 | |
1203 | |
1105 | Here is a a likely non-exhaustive list of option names, please see the |
1204 | Here is a likely non-exhaustive list of option names, please see the |
1106 | source file F</src/optinc.h> to see the actual list: |
1205 | source file F</src/optinc.h> to see the actual list: |
1107 | |
1206 | |
1108 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1207 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1109 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1208 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1110 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1209 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1127 | likely change). |
1226 | likely change). |
1128 | |
1227 | |
1129 | Please note that resource strings will currently only be freed when the |
1228 | Please note that resource strings will currently only be freed when the |
1130 | terminal is destroyed, so changing options frequently will eat memory. |
1229 | terminal is destroyed, so changing options frequently will eat memory. |
1131 | |
1230 | |
1132 | Here is a a likely non-exhaustive list of resource names, not all of which |
1231 | Here is a likely non-exhaustive list of resource names, not all of which |
1133 | are supported in every build, please see the source file F</src/rsinc.h> |
1232 | are supported in every build, please see the source file F</src/rsinc.h> |
1134 | to see the actual list: |
1233 | to see the actual list: |
1135 | |
1234 | |
1136 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1235 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1137 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1236 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1370 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1469 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1371 | to receive pointer events all the times: |
1470 | to receive pointer events all the times: |
1372 | |
1471 | |
1373 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1472 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1374 | |
1473 | |
|
|
1474 | =item $term->focus_in |
|
|
1475 | |
|
|
1476 | =item $term->focus_out |
|
|
1477 | |
|
|
1478 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1479 | |
|
|
1480 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1481 | |
|
|
1482 | Deliver various fake events to to terminal. |
|
|
1483 | |
1375 | =item $window_width = $term->width |
1484 | =item $window_width = $term->width |
1376 | |
1485 | |
1377 | =item $window_height = $term->height |
1486 | =item $window_height = $term->height |
1378 | |
1487 | |
1379 | =item $font_width = $term->fwidth |
1488 | =item $font_width = $term->fwidth |
… | |
… | |
1409 | =item $env = $term->env |
1518 | =item $env = $term->env |
1410 | |
1519 | |
1411 | Returns a copy of the environment in effect for the terminal as a hashref |
1520 | Returns a copy of the environment in effect for the terminal as a hashref |
1412 | similar to C<\%ENV>. |
1521 | similar to C<\%ENV>. |
1413 | |
1522 | |
|
|
1523 | =item @envv = $term->envv |
|
|
1524 | |
|
|
1525 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1526 | |
|
|
1527 | =item @argv = $term->argv |
|
|
1528 | |
|
|
1529 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1530 | includes the program name as first element. |
|
|
1531 | |
1414 | =cut |
1532 | =cut |
1415 | |
1533 | |
1416 | sub env { |
1534 | sub env { |
1417 | if (my $env = $_[0]->_env) { |
|
|
1418 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1535 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1419 | } else { |
|
|
1420 | +{ %ENV } |
|
|
1421 | } |
|
|
1422 | } |
1536 | } |
1423 | |
1537 | |
1424 | =item $modifiermask = $term->ModLevel3Mask |
1538 | =item $modifiermask = $term->ModLevel3Mask |
1425 | |
1539 | |
1426 | =item $modifiermask = $term->ModMetaMask |
1540 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1434 | |
1548 | |
1435 | Returns the currently displayed screen (0 primary, 1 secondary). |
1549 | Returns the currently displayed screen (0 primary, 1 secondary). |
1436 | |
1550 | |
1437 | =item $cursor_is_hidden = $term->hidden_cursor |
1551 | =item $cursor_is_hidden = $term->hidden_cursor |
1438 | |
1552 | |
1439 | Returns wether the cursor is currently hidden or not. |
1553 | Returns whether the cursor is currently hidden or not. |
1440 | |
1554 | |
1441 | =item $view_start = $term->view_start ([$newvalue]) |
1555 | =item $view_start = $term->view_start ([$newvalue]) |
1442 | |
1556 | |
1443 | Returns the row number of the topmost displayed line. Maximum value is |
1557 | Returns the row number of the topmost displayed line. Maximum value is |
1444 | C<0>, which displays the normal terminal contents. Lower values scroll |
1558 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1621 | where one character corresponds to one screen cell. See |
1735 | where one character corresponds to one screen cell. See |
1622 | C<< $term->ROW_t >> for details. |
1736 | C<< $term->ROW_t >> for details. |
1623 | |
1737 | |
1624 | =item $string = $term->special_decode $text |
1738 | =item $string = $term->special_decode $text |
1625 | |
1739 | |
1626 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1740 | Converts rxvt-unicodes text representation into a perl string. See |
1627 | C<< $term->ROW_t >> for details. |
1741 | C<< $term->ROW_t >> for details. |
1628 | |
1742 | |
1629 | =item $success = $term->grab_button ($button, $modifiermask) |
1743 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1630 | |
1744 | |
|
|
1745 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1746 | |
1631 | Registers a synchronous button grab. See the XGrabButton manpage. |
1747 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1748 | manpage. |
1632 | |
1749 | |
1633 | =item $success = $term->grab ($eventtime[, $sync]) |
1750 | =item $success = $term->grab ($eventtime[, $sync]) |
1634 | |
1751 | |
1635 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1752 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1636 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1753 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1637 | |
1754 | |
1638 | =item $term->allow_events_async |
1755 | =item $term->allow_events_async |
1639 | |
1756 | |
1640 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1757 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1641 | |
1758 | |
… | |
… | |
1754 | my ($self, $text, $cb) = @_; |
1871 | my ($self, $text, $cb) = @_; |
1755 | |
1872 | |
1756 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1873 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1757 | } |
1874 | } |
1758 | |
1875 | |
1759 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1876 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1760 | |
1877 | |
1761 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1878 | Adds a toggle/checkbox item to the popup. The callback gets called |
1762 | whenever it gets toggled, with a boolean indicating its value as its first |
1879 | whenever it gets toggled, with a boolean indicating its new value as its |
1763 | argument. |
1880 | first argument. |
1764 | |
1881 | |
1765 | =cut |
1882 | =cut |
1766 | |
1883 | |
1767 | sub add_toggle { |
1884 | sub add_toggle { |
1768 | my ($self, $text, $cb, $value) = @_; |
1885 | my ($self, $text, $value, $cb) = @_; |
1769 | |
1886 | |
1770 | my $item; $item = { |
1887 | my $item; $item = { |
1771 | type => "button", |
1888 | type => "button", |
1772 | text => " $text", |
1889 | text => " $text", |
1773 | value => $value, |
1890 | value => $value, |
… | |
… | |
1908 | Set the callback to be called when io events are triggered. C<$reventmask> |
2025 | Set the callback to be called when io events are triggered. C<$reventmask> |
1909 | is a bitset as described in the C<events> method. |
2026 | is a bitset as described in the C<events> method. |
1910 | |
2027 | |
1911 | =item $iow = $iow->fd ($fd) |
2028 | =item $iow = $iow->fd ($fd) |
1912 | |
2029 | |
1913 | Set the filedescriptor (not handle) to watch. |
2030 | Set the file descriptor (not handle) to watch. |
1914 | |
2031 | |
1915 | =item $iow = $iow->events ($eventmask) |
2032 | =item $iow = $iow->events ($eventmask) |
1916 | |
2033 | |
1917 | Set the event mask to watch. The only allowed values are |
2034 | Set the event mask to watch. The only allowed values are |
1918 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2035 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1922 | |
2039 | |
1923 | Start watching for requested events on the given handle. |
2040 | Start watching for requested events on the given handle. |
1924 | |
2041 | |
1925 | =item $iow = $iow->stop |
2042 | =item $iow = $iow->stop |
1926 | |
2043 | |
1927 | Stop watching for events on the given filehandle. |
2044 | Stop watching for events on the given file handle. |
1928 | |
2045 | |
1929 | =back |
2046 | =back |
1930 | |
2047 | |
1931 | =head2 The C<urxvt::iw> Class |
2048 | =head2 The C<urxvt::iw> Class |
1932 | |
2049 | |
… | |
… | |
1979 | |
2096 | |
1980 | Set the callback to be called when the timer triggers. |
2097 | Set the callback to be called when the timer triggers. |
1981 | |
2098 | |
1982 | =item $pw = $timer->start ($pid) |
2099 | =item $pw = $timer->start ($pid) |
1983 | |
2100 | |
1984 | Tells the wqtcher to start watching for process C<$pid>. |
2101 | Tells the watcher to start watching for process C<$pid>. |
1985 | |
2102 | |
1986 | =item $pw = $pw->stop |
2103 | =item $pw = $pw->stop |
1987 | |
2104 | |
1988 | Stop the watcher. |
2105 | Stop the watcher. |
1989 | |
2106 | |
… | |
… | |
2002 | |
2119 | |
2003 | =item >= 3 - script loading and management |
2120 | =item >= 3 - script loading and management |
2004 | |
2121 | |
2005 | =item >=10 - all called hooks |
2122 | =item >=10 - all called hooks |
2006 | |
2123 | |
2007 | =item >=11 - hook reutrn values |
2124 | =item >=11 - hook return values |
2008 | |
2125 | |
2009 | =back |
2126 | =back |
2010 | |
2127 | |
2011 | =head1 AUTHOR |
2128 | =head1 AUTHOR |
2012 | |
2129 | |