… | |
… | |
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 |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
215 | the URL as first argument. |
250 | the URL as first argument. |
216 | |
251 | |
|
|
252 | =item xim-onthespot |
|
|
253 | |
|
|
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
255 | not work perfectly, and some input methods don't seem to work well with |
|
|
256 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
257 | kinput2. |
|
|
258 | |
|
|
259 | You enable it by specifying this extension and a preedit style of |
|
|
260 | C<OnTheSpot>, i.e.: |
|
|
261 | |
|
|
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
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 | |
217 | =item automove-background |
283 | =item automove-background |
218 | |
284 | |
219 | 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 |
220 | 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 |
221 | 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: |
222 | |
289 | |
223 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
290 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
224 | |
291 | |
225 | =item block-graphics-to-ascii |
292 | =item block-graphics-to-ascii |
226 | |
293 | |
227 | 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 |
228 | 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 |
229 | similar-looking ascii character. |
296 | similar-looking ascii character. |
230 | |
297 | |
231 | =item digital-clock |
298 | =item digital-clock |
232 | |
299 | |
233 | Displays a digital clock using the built-in overlay. |
300 | Displays a digital clock using the built-in overlay. |
234 | |
301 | |
235 | =item example-refresh-hooks |
302 | =item remote-clipboard |
236 | |
303 | |
237 | Displays a very simple digital clock in the upper right corner of the |
304 | Somewhat of a misnomer, this extension adds two menu entries to the |
238 | window. Illustrates overwriting the refresh callbacks to create your own |
305 | selection popup that allows one ti run external commands to store the |
239 | overlays or changes. |
306 | selection somewhere and fetch it again. |
|
|
307 | |
|
|
308 | We use it to implement a "distributed selection mechanism", which just |
|
|
309 | means that one command uploads the file to a remote server, and another |
|
|
310 | reads it. |
|
|
311 | |
|
|
312 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
313 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
314 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
315 | the selection data on STDOUT (also in UTF-8). |
|
|
316 | |
|
|
317 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
318 | |
|
|
319 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
320 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
240 | |
321 | |
241 | =item selection-pastebin |
322 | =item selection-pastebin |
242 | |
323 | |
243 | This is a little rarely useful extension that Uploads the selection as |
324 | This is a little rarely useful extension that Uploads the selection as |
244 | textfile to a remote site (or does other things). (The implementation is |
325 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
264 | 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 |
265 | 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 |
266 | for the filename): |
347 | for the filename): |
267 | |
348 | |
268 | 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 | =item example-refresh-hooks |
|
|
352 | |
|
|
353 | Displays a very simple digital clock in the upper right corner of the |
|
|
354 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
355 | overlays or changes. |
269 | |
356 | |
270 | =back |
357 | =back |
271 | |
358 | |
272 | =head1 API DOCUMENTATION |
359 | =head1 API DOCUMENTATION |
273 | |
360 | |
… | |
… | |
307 | |
394 | |
308 | =back |
395 | =back |
309 | |
396 | |
310 | =head2 Extension Objects |
397 | =head2 Extension Objects |
311 | |
398 | |
312 | Very perl extension is a perl class. A separate perl object is created |
399 | Every perl extension is a perl class. A separate perl object is created |
313 | for each terminal and each extension and passed as the first parameter to |
400 | for each terminal, and each terminal has its own set of extenion objects, |
314 | hooks. So extensions can use their C<$self> object without having to think |
401 | which are passed as the first parameter to hooks. So extensions can use |
315 | about other extensions, with the exception of methods and members that |
402 | their C<$self> object without having to think about clashes with other |
|
|
403 | extensions or other terminals, with the exception of methods and members |
316 | begin with an underscore character C<_>: these are reserved for internal |
404 | that begin with an underscore character C<_>: these are reserved for |
317 | use. |
405 | internal use. |
318 | |
406 | |
319 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
407 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
320 | C<urxvt::term> class on this object. |
408 | C<urxvt::term> class on this object. |
321 | |
409 | |
322 | It has the following methods and data members: |
410 | It has the following methods and data members: |
… | |
… | |
343 | =head2 Hooks |
431 | =head2 Hooks |
344 | |
432 | |
345 | The following subroutines can be declared in extension files, and will be |
433 | The following subroutines can be declared in extension files, and will be |
346 | called whenever the relevant event happens. |
434 | called whenever the relevant event happens. |
347 | |
435 | |
348 | The first argument passed to them is an extension oject as described in |
436 | The first argument passed to them is an extension object as described in |
349 | the in the C<Extension Objects> section. |
437 | the in the C<Extension Objects> section. |
350 | |
438 | |
351 | B<All> of these hooks must return a boolean value. If any of the called |
439 | B<All> of these hooks must return a boolean value. If any of the called |
352 | hooks returns true, then the event counts as being I<consumed>, and the |
440 | hooks returns true, then the event counts as being I<consumed>, and the |
353 | relevant action might not be carried out by the C++ code. |
441 | relevant action might not be carried out by the C++ code. |
… | |
… | |
366 | place. |
454 | place. |
367 | |
455 | |
368 | =item on_start $term |
456 | =item on_start $term |
369 | |
457 | |
370 | Called at the very end of initialisation of a new terminal, just before |
458 | Called at the very end of initialisation of a new terminal, just before |
371 | trying to map (display) the toplevel and returning to the mainloop. |
459 | trying to map (display) the toplevel and returning to the main loop. |
372 | |
460 | |
373 | =item on_destroy $term |
461 | =item on_destroy $term |
374 | |
462 | |
375 | Called whenever something tries to destroy terminal, before doing anything |
463 | Called whenever something tries to destroy terminal, when the terminal is |
376 | yet. If this hook returns true, then destruction is skipped, but this is |
464 | still fully functional (not for long, though). |
377 | rarely a good idea. |
|
|
378 | |
465 | |
379 | =item on_reset $term |
466 | =item on_reset $term |
380 | |
467 | |
381 | Called after the screen is "reset" for any reason, such as resizing or |
468 | Called after the screen is "reset" for any reason, such as resizing or |
382 | control sequences. Here is where you can react on changes to size-related |
469 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
404 | |
491 | |
405 | Called whenever a selection has been copied, but before the selection is |
492 | Called whenever a selection has been copied, but before the selection is |
406 | requested from the server. The selection text can be queried and changed |
493 | requested from the server. The selection text can be queried and changed |
407 | by calling C<< $term->selection >>. |
494 | by calling C<< $term->selection >>. |
408 | |
495 | |
409 | Returning a true value aborts selection grabbing. It will still be hilighted. |
496 | Returning a true value aborts selection grabbing. It will still be highlighted. |
410 | |
497 | |
411 | =item on_sel_extend $term |
498 | =item on_sel_extend $term |
412 | |
499 | |
413 | Called whenever the user tries to extend the selection (e.g. with a double |
500 | Called whenever the user tries to extend the selection (e.g. with a double |
414 | click) and is either supposed to return false (normal operation), or |
501 | click) and is either supposed to return false (normal operation), or |
415 | should extend the selection itelf and return true to suppress the built-in |
502 | should extend the selection itself and return true to suppress the built-in |
416 | processing. This can happen multiple times, as long as the callback |
503 | processing. This can happen multiple times, as long as the callback |
417 | returns true, it will be called on every further click by the user and is |
504 | returns true, it will be called on every further click by the user and is |
418 | supposed to enlarge the selection more and more, if possible. |
505 | supposed to enlarge the selection more and more, if possible. |
419 | |
506 | |
420 | See the F<selection> example extension. |
507 | See the F<selection> example extension. |
421 | |
508 | |
422 | =item on_view_change $term, $offset |
509 | =item on_view_change $term, $offset |
423 | |
510 | |
424 | Called whenever the view offset changes, i..e the user or program |
511 | Called whenever the view offset changes, i.e. the user or program |
425 | scrolls. Offset C<0> means display the normal terminal, positive values |
512 | scrolls. Offset C<0> means display the normal terminal, positive values |
426 | show this many lines of scrollback. |
513 | show this many lines of scrollback. |
427 | |
514 | |
428 | =item on_scroll_back $term, $lines, $saved |
515 | =item on_scroll_back $term, $lines, $saved |
429 | |
516 | |
… | |
… | |
433 | |
520 | |
434 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
521 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
435 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
522 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
436 | number of lines that will be in the scrollback buffer. |
523 | number of lines that will be in the scrollback buffer. |
437 | |
524 | |
|
|
525 | =item on_osc_seq $term, $op, $args |
|
|
526 | |
|
|
527 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
528 | behaviour. The default should be to return an empty list. A true value |
|
|
529 | suppresses execution of the request completely. Make sure you don't get |
|
|
530 | confused by recursive invocations when you output an osc sequence within |
|
|
531 | this callback. |
|
|
532 | |
|
|
533 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
534 | |
438 | =item on_osc_seq $term, $string |
535 | =item on_osc_seq_perl $term, $string |
439 | |
536 | |
440 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
537 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
441 | operating system command) is processed. Cursor position and other state |
538 | operating system command) is processed. Cursor position and other state |
442 | information is up-to-date when this happens. For interoperability, the |
539 | information is up-to-date when this happens. For interoperability, the |
443 | string should start with the extension name and a colon, to distinguish |
540 | string should start with the extension name and a colon, to distinguish |
444 | it from commands for other extensions, and this might be enforced in the |
541 | it from commands for other extensions, and this might be enforced in the |
445 | future. |
542 | future. |
446 | |
543 | |
447 | Be careful not ever to trust (in a security sense) the data you receive, |
544 | Be careful not ever to trust (in a security sense) the data you receive, |
448 | as its source can not easily be controleld (e-mail content, messages from |
545 | as its source can not easily be controlled (e-mail content, messages from |
449 | other users on the same system etc.). |
546 | other users on the same system etc.). |
450 | |
547 | |
451 | =item on_add_lines $term, $string |
548 | =item on_add_lines $term, $string |
452 | |
549 | |
453 | Called whenever text is about to be output, with the text as argument. You |
550 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
484 | |
581 | |
485 | =item on_refresh_end $term |
582 | =item on_refresh_end $term |
486 | |
583 | |
487 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
584 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
488 | |
585 | |
489 | =item on_keyboard_command $term, $string |
586 | =item on_user_command $term, $string |
490 | |
587 | |
491 | Called whenever the user presses a key combination that has a |
588 | Called whenever a user-configured event is being activated (e.g. via |
492 | C<perl:string> action bound to it (see description of the B<keysym> |
589 | a C<perl:string> action bound to a key, see description of the B<keysym> |
493 | resource in the @@RXVT_NAME@@(1) manpage). |
590 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
591 | |
|
|
592 | The event is simply the action string. This interface is assumed to change |
|
|
593 | slightly in the future. |
|
|
594 | |
|
|
595 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
596 | |
|
|
597 | Called just after the new window size has been calculated, but before |
|
|
598 | windows are actually being resized or hints are being set. If this hook |
|
|
599 | returns TRUE, setting of the window hints is being skipped. |
494 | |
600 | |
495 | =item on_x_event $term, $event |
601 | =item on_x_event $term, $event |
496 | |
602 | |
497 | Called on every X event received on the vt window (and possibly other |
603 | Called on every X event received on the vt window (and possibly other |
498 | windows). Should only be used as a last resort. Most event structure |
604 | windows). Should only be used as a last resort. Most event structure |
499 | members are not passed. |
605 | members are not passed. |
500 | |
606 | |
|
|
607 | =item on_root_event $term, $event |
|
|
608 | |
|
|
609 | Like C<on_x_event>, but is called for events on the root window. |
|
|
610 | |
501 | =item on_focus_in $term |
611 | =item on_focus_in $term |
502 | |
612 | |
503 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
613 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
504 | does focus in processing. |
614 | does focus in processing. |
505 | |
615 | |
506 | =item on_focus_out $term |
616 | =item on_focus_out $term |
507 | |
617 | |
508 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
618 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
509 | focus out processing. |
619 | focus out processing. |
510 | |
620 | |
511 | =item on_configure_notify $term, $event |
621 | =item on_configure_notify $term, $event |
512 | |
622 | |
513 | =item on_property_notify $term, $event |
623 | =item on_property_notify $term, $event |
… | |
… | |
596 | The current terminal. This variable stores the current C<urxvt::term> |
706 | The current terminal. This variable stores the current C<urxvt::term> |
597 | object, whenever a callback/hook is executing. |
707 | object, whenever a callback/hook is executing. |
598 | |
708 | |
599 | =item @urxvt::TERM_INIT |
709 | =item @urxvt::TERM_INIT |
600 | |
710 | |
601 | All coderefs in this array will be called as methods of the next newly |
711 | All code references in this array will be called as methods of the next newly |
602 | created C<urxvt::term> object (during the C<on_init> phase). The array |
712 | created C<urxvt::term> object (during the C<on_init> phase). The array |
603 | gets cleared before the codereferences that were in it are being executed, |
713 | gets cleared before the code references that were in it are being executed, |
604 | so coderefs can push themselves onto it again if they so desire. |
714 | so references can push themselves onto it again if they so desire. |
605 | |
715 | |
606 | This complements to the perl-eval commandline option, but gets executed |
716 | This complements to the perl-eval command line option, but gets executed |
607 | first. |
717 | first. |
608 | |
718 | |
609 | =item @urxvt::TERM_EXT |
719 | =item @urxvt::TERM_EXT |
610 | |
720 | |
611 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
721 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
632 | |
742 | |
633 | Using this function has the advantage that its output ends up in the |
743 | Using this function has the advantage that its output ends up in the |
634 | correct place, e.g. on stderr of the connecting urxvtc client. |
744 | correct place, e.g. on stderr of the connecting urxvtc client. |
635 | |
745 | |
636 | Messages have a size limit of 1023 bytes currently. |
746 | Messages have a size limit of 1023 bytes currently. |
|
|
747 | |
|
|
748 | =item @terms = urxvt::termlist |
|
|
749 | |
|
|
750 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
751 | whether they are started, being destroyed etc., so be careful. Only term |
|
|
752 | objects that have perl extensions attached will be returned (because there |
|
|
753 | is no urxvt::term objet associated with others). |
637 | |
754 | |
638 | =item $time = urxvt::NOW |
755 | =item $time = urxvt::NOW |
639 | |
756 | |
640 | Returns the "current time" (as per the event loop). |
757 | Returns the "current time" (as per the event loop). |
641 | |
758 | |
… | |
… | |
699 | Return the foreground/background colour index, respectively. |
816 | Return the foreground/background colour index, respectively. |
700 | |
817 | |
701 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
818 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
702 | |
819 | |
703 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
820 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
821 | |
|
|
822 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
704 | |
823 | |
705 | Replace the foreground/background colour in the rendition mask with the |
824 | Replace the foreground/background colour in the rendition mask with the |
706 | specified one. |
825 | specified one. |
707 | |
826 | |
708 | =item $value = urxvt::GET_CUSTOM $rend |
827 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
799 | } else { |
918 | } else { |
800 | $ext_arg{$_} ||= []; |
919 | $ext_arg{$_} ||= []; |
801 | } |
920 | } |
802 | } |
921 | } |
803 | |
922 | |
804 | while (my ($ext, $argv) = each %ext_arg) { |
923 | for my $ext (sort keys %ext_arg) { |
805 | my @files = grep -f $_, map "$_/$ext", @dirs; |
924 | my @files = grep -f $_, map "$_/$ext", @dirs; |
806 | |
925 | |
807 | if (@files) { |
926 | if (@files) { |
808 | $TERM->register_package (extension_package $files[0], $argv); |
927 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
809 | } else { |
928 | } else { |
810 | warn "perl extension '$ext' not found in perl library search path\n"; |
929 | warn "perl extension '$ext' not found in perl library search path\n"; |
811 | } |
930 | } |
812 | } |
931 | } |
813 | |
932 | |
… | |
… | |
819 | |
938 | |
820 | if (my $cb = $TERM->{_hook}[$htype]) { |
939 | if (my $cb = $TERM->{_hook}[$htype]) { |
821 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
940 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
822 | if $verbosity >= 10; |
941 | if $verbosity >= 10; |
823 | |
942 | |
824 | keys %$cb; |
943 | for my $pkg (keys %$cb) { |
825 | |
|
|
826 | while (my ($pkg, $cb) = each %$cb) { |
|
|
827 | my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; |
944 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
828 | $retval ||= $retval_; |
945 | $retval ||= $retval_; |
829 | |
946 | |
830 | if ($@) { |
947 | if ($@) { |
831 | $TERM->ungrab; # better to lose the grab than the session |
948 | $TERM->ungrab; # better to lose the grab than the session |
832 | warn $@; |
949 | warn $@; |
… | |
… | |
844 | # clear package |
961 | # clear package |
845 | %$TERM = (); |
962 | %$TERM = (); |
846 | } |
963 | } |
847 | |
964 | |
848 | $retval |
965 | $retval |
|
|
966 | } |
|
|
967 | |
|
|
968 | sub SET_COLOR($$$) { |
|
|
969 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
849 | } |
970 | } |
850 | |
971 | |
851 | # urxvt::term::extension |
972 | # urxvt::term::extension |
852 | |
973 | |
853 | package urxvt::term::extension; |
974 | package urxvt::term::extension; |
… | |
… | |
1022 | hash which defines the environment of the new terminal. |
1143 | hash which defines the environment of the new terminal. |
1023 | |
1144 | |
1024 | Croaks (and probably outputs an error message) if the new instance |
1145 | Croaks (and probably outputs an error message) if the new instance |
1025 | couldn't be created. Returns C<undef> if the new instance didn't |
1146 | couldn't be created. Returns C<undef> if the new instance didn't |
1026 | initialise perl, and the terminal object otherwise. The C<init> and |
1147 | initialise perl, and the terminal object otherwise. The C<init> and |
1027 | C<start> hooks will be called during this call. |
1148 | C<start> hooks will be called before this call returns, and are free to |
|
|
1149 | refer to global data (which is race free). |
1028 | |
1150 | |
1029 | =cut |
1151 | =cut |
1030 | |
1152 | |
1031 | sub new { |
1153 | sub new { |
1032 | my ($class, $env, @args) = @_; |
1154 | my ($class, $env, @args) = @_; |
1033 | |
1155 | |
|
|
1156 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1157 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1158 | |
1034 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1159 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1035 | } |
1160 | } |
1036 | |
1161 | |
1037 | =item $term->destroy |
1162 | =item $term->destroy |
1038 | |
1163 | |
1039 | Destroy the terminal object (close the window, free resources |
1164 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1069 | |
1194 | |
1070 | Returns true if the option specified by C<$optval> is enabled, and |
1195 | Returns true if the option specified by C<$optval> is enabled, and |
1071 | optionally change it. All option values are stored by name in the hash |
1196 | optionally change it. All option values are stored by name in the hash |
1072 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1197 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1073 | |
1198 | |
1074 | Here is a a likely non-exhaustive list of option names, please see the |
1199 | Here is a likely non-exhaustive list of option names, please see the |
1075 | source file F</src/optinc.h> to see the actual list: |
1200 | source file F</src/optinc.h> to see the actual list: |
1076 | |
1201 | |
1077 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1202 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1078 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1203 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1079 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1204 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1096 | likely change). |
1221 | likely change). |
1097 | |
1222 | |
1098 | Please note that resource strings will currently only be freed when the |
1223 | Please note that resource strings will currently only be freed when the |
1099 | terminal is destroyed, so changing options frequently will eat memory. |
1224 | terminal is destroyed, so changing options frequently will eat memory. |
1100 | |
1225 | |
1101 | Here is a a likely non-exhaustive list of resource names, not all of which |
1226 | Here is a likely non-exhaustive list of resource names, not all of which |
1102 | are supported in every build, please see the source file F</src/rsinc.h> |
1227 | are supported in every build, please see the source file F</src/rsinc.h> |
1103 | to see the actual list: |
1228 | to see the actual list: |
1104 | |
1229 | |
1105 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1230 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1106 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1231 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1339 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1464 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1340 | to receive pointer events all the times: |
1465 | to receive pointer events all the times: |
1341 | |
1466 | |
1342 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1467 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1343 | |
1468 | |
|
|
1469 | =item $term->focus_in |
|
|
1470 | |
|
|
1471 | =item $term->focus_out |
|
|
1472 | |
|
|
1473 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1474 | |
|
|
1475 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1476 | |
|
|
1477 | Deliver various fake events to to terminal. |
|
|
1478 | |
1344 | =item $window_width = $term->width |
1479 | =item $window_width = $term->width |
1345 | |
1480 | |
1346 | =item $window_height = $term->height |
1481 | =item $window_height = $term->height |
1347 | |
1482 | |
1348 | =item $font_width = $term->fwidth |
1483 | =item $font_width = $term->fwidth |
… | |
… | |
1378 | =item $env = $term->env |
1513 | =item $env = $term->env |
1379 | |
1514 | |
1380 | Returns a copy of the environment in effect for the terminal as a hashref |
1515 | Returns a copy of the environment in effect for the terminal as a hashref |
1381 | similar to C<\%ENV>. |
1516 | similar to C<\%ENV>. |
1382 | |
1517 | |
|
|
1518 | =item @envv = $term->envv |
|
|
1519 | |
|
|
1520 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1521 | |
|
|
1522 | =item @argv = $term->argv |
|
|
1523 | |
|
|
1524 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1525 | includes the program name as first element. |
|
|
1526 | |
1383 | =cut |
1527 | =cut |
1384 | |
1528 | |
1385 | sub env { |
1529 | sub env { |
1386 | if (my $env = $_[0]->_env) { |
|
|
1387 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1530 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1388 | } else { |
|
|
1389 | +{ %ENV } |
|
|
1390 | } |
|
|
1391 | } |
1531 | } |
1392 | |
1532 | |
1393 | =item $modifiermask = $term->ModLevel3Mask |
1533 | =item $modifiermask = $term->ModLevel3Mask |
1394 | |
1534 | |
1395 | =item $modifiermask = $term->ModMetaMask |
1535 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1403 | |
1543 | |
1404 | Returns the currently displayed screen (0 primary, 1 secondary). |
1544 | Returns the currently displayed screen (0 primary, 1 secondary). |
1405 | |
1545 | |
1406 | =item $cursor_is_hidden = $term->hidden_cursor |
1546 | =item $cursor_is_hidden = $term->hidden_cursor |
1407 | |
1547 | |
1408 | Returns wether the cursor is currently hidden or not. |
1548 | Returns whether the cursor is currently hidden or not. |
1409 | |
1549 | |
1410 | =item $view_start = $term->view_start ([$newvalue]) |
1550 | =item $view_start = $term->view_start ([$newvalue]) |
1411 | |
1551 | |
1412 | Returns the row number of the topmost displayed line. Maximum value is |
1552 | Returns the row number of the topmost displayed line. Maximum value is |
1413 | C<0>, which displays the normal terminal contents. Lower values scroll |
1553 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1590 | where one character corresponds to one screen cell. See |
1730 | where one character corresponds to one screen cell. See |
1591 | C<< $term->ROW_t >> for details. |
1731 | C<< $term->ROW_t >> for details. |
1592 | |
1732 | |
1593 | =item $string = $term->special_decode $text |
1733 | =item $string = $term->special_decode $text |
1594 | |
1734 | |
1595 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1735 | Converts rxvt-unicodes text representation into a perl string. See |
1596 | C<< $term->ROW_t >> for details. |
1736 | C<< $term->ROW_t >> for details. |
1597 | |
1737 | |
1598 | =item $success = $term->grab_button ($button, $modifiermask) |
1738 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1599 | |
1739 | |
|
|
1740 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1741 | |
1600 | Registers a synchronous button grab. See the XGrabButton manpage. |
1742 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1743 | manpage. |
1601 | |
1744 | |
1602 | =item $success = $term->grab ($eventtime[, $sync]) |
1745 | =item $success = $term->grab ($eventtime[, $sync]) |
1603 | |
1746 | |
1604 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1747 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1605 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1748 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1606 | |
1749 | |
1607 | =item $term->allow_events_async |
1750 | =item $term->allow_events_async |
1608 | |
1751 | |
1609 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1752 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1610 | |
1753 | |
… | |
… | |
1723 | my ($self, $text, $cb) = @_; |
1866 | my ($self, $text, $cb) = @_; |
1724 | |
1867 | |
1725 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1868 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1726 | } |
1869 | } |
1727 | |
1870 | |
1728 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1871 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1729 | |
1872 | |
1730 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1873 | Adds a toggle/checkbox item to the popup. The callback gets called |
1731 | whenever it gets toggled, with a boolean indicating its value as its first |
1874 | whenever it gets toggled, with a boolean indicating its new value as its |
1732 | argument. |
1875 | first argument. |
1733 | |
1876 | |
1734 | =cut |
1877 | =cut |
1735 | |
1878 | |
1736 | sub add_toggle { |
1879 | sub add_toggle { |
1737 | my ($self, $text, $cb, $value) = @_; |
1880 | my ($self, $text, $value, $cb) = @_; |
1738 | |
1881 | |
1739 | my $item; $item = { |
1882 | my $item; $item = { |
1740 | type => "button", |
1883 | type => "button", |
1741 | text => " $text", |
1884 | text => " $text", |
1742 | value => $value, |
1885 | value => $value, |
… | |
… | |
1877 | Set the callback to be called when io events are triggered. C<$reventmask> |
2020 | Set the callback to be called when io events are triggered. C<$reventmask> |
1878 | is a bitset as described in the C<events> method. |
2021 | is a bitset as described in the C<events> method. |
1879 | |
2022 | |
1880 | =item $iow = $iow->fd ($fd) |
2023 | =item $iow = $iow->fd ($fd) |
1881 | |
2024 | |
1882 | Set the filedescriptor (not handle) to watch. |
2025 | Set the file descriptor (not handle) to watch. |
1883 | |
2026 | |
1884 | =item $iow = $iow->events ($eventmask) |
2027 | =item $iow = $iow->events ($eventmask) |
1885 | |
2028 | |
1886 | Set the event mask to watch. The only allowed values are |
2029 | Set the event mask to watch. The only allowed values are |
1887 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2030 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
1891 | |
2034 | |
1892 | Start watching for requested events on the given handle. |
2035 | Start watching for requested events on the given handle. |
1893 | |
2036 | |
1894 | =item $iow = $iow->stop |
2037 | =item $iow = $iow->stop |
1895 | |
2038 | |
1896 | Stop watching for events on the given filehandle. |
2039 | Stop watching for events on the given file handle. |
1897 | |
2040 | |
1898 | =back |
2041 | =back |
1899 | |
2042 | |
1900 | =head2 The C<urxvt::iw> Class |
2043 | =head2 The C<urxvt::iw> Class |
1901 | |
2044 | |
… | |
… | |
1948 | |
2091 | |
1949 | Set the callback to be called when the timer triggers. |
2092 | Set the callback to be called when the timer triggers. |
1950 | |
2093 | |
1951 | =item $pw = $timer->start ($pid) |
2094 | =item $pw = $timer->start ($pid) |
1952 | |
2095 | |
1953 | Tells the wqtcher to start watching for process C<$pid>. |
2096 | Tells the watcher to start watching for process C<$pid>. |
1954 | |
2097 | |
1955 | =item $pw = $pw->stop |
2098 | =item $pw = $pw->stop |
1956 | |
2099 | |
1957 | Stop the watcher. |
2100 | Stop the watcher. |
1958 | |
2101 | |
… | |
… | |
1971 | |
2114 | |
1972 | =item >= 3 - script loading and management |
2115 | =item >= 3 - script loading and management |
1973 | |
2116 | |
1974 | =item >=10 - all called hooks |
2117 | =item >=10 - all called hooks |
1975 | |
2118 | |
1976 | =item >=11 - hook reutrn values |
2119 | =item >=11 - hook return values |
1977 | |
2120 | |
1978 | =back |
2121 | =back |
1979 | |
2122 | |
1980 | =head1 AUTHOR |
2123 | =head1 AUTHOR |
1981 | |
2124 | |