… | |
… | |
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 |
… | |
… | |
122 | 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 |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
124 | popup is being displayed. |
124 | popup is being displayed. |
125 | |
125 | |
126 | 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 |
127 | 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. |
128 | 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 |
129 | 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 |
130 | when the button gets activated and should transform C<$_>. |
130 | when the button gets activated and should transform C<$_>. |
131 | |
131 | |
132 | 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 |
… | |
… | |
151 | 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 |
152 | 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 |
153 | 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 |
154 | selection. |
154 | selection. |
155 | |
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 | |
156 | =item readline (enabled by default) |
162 | =item readline (enabled by default) |
157 | |
163 | |
158 | A support package that tries to make editing with readline easier. At |
164 | A support package that tries to make editing with readline easier. At |
159 | the moment, it reacts to clicking shift-left mouse button by trying to |
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
160 | 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 |
… | |
… | |
214 | the message into vi commands to load the file. |
220 | the message into vi commands to load the file. |
215 | |
221 | |
216 | =item tabbed |
222 | =item tabbed |
217 | |
223 | |
218 | This transforms the terminal into a tabbar with additional terminals, that |
224 | This transforms the terminal into a tabbar with additional terminals, that |
219 | 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 |
220 | 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 |
221 | button per tab. |
227 | button per tab. |
222 | |
228 | |
223 | 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 |
224 | 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, |
… | |
… | |
234 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
235 | |
241 | |
236 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
237 | indices. |
243 | indices. |
238 | |
244 | |
239 | =item mark-urls |
245 | =item matcher |
240 | |
246 | |
241 | 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 text |
242 | make them clickable. When middle-clicked, the program specified in the |
248 | matching a certain pattern and make it clickable. When clicked with the |
243 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
249 | mouse button specified in the C<matcher.button> resource (default 2, or |
244 | the URL as first argument. |
250 | middle), the program specified in the C<matcher.launcher> resource |
|
|
251 | (default, the C<urlLauncher> resource, C<sensible-browser>) will be started |
|
|
252 | with the matched text as first argument. The default configuration is |
|
|
253 | suitable for matching URLs and launching a web browser, like the |
|
|
254 | former "mark-urls" extension. |
|
|
255 | |
|
|
256 | The default pattern to match URLs can be overridden with the |
|
|
257 | C<matcher.pattern.0> resource, and additional patterns can be specified |
|
|
258 | with numbered patterns, in a manner similar to the "selection" extension. |
|
|
259 | The launcher can also be overridden on a per-pattern basis. |
|
|
260 | |
|
|
261 | Example configuration: |
|
|
262 | |
|
|
263 | URxvt.perl-ext: default,matcher |
|
|
264 | URxvt.urlLauncher: sensible-browser |
|
|
265 | URxvt.matcher.button: 1 |
|
|
266 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
|
|
267 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
|
|
268 | URxvt.matcher.launcher.2: gvim +$2 $1 |
245 | |
269 | |
246 | =item xim-onthespot |
270 | =item xim-onthespot |
247 | |
271 | |
248 | This (experimental) perl extension implements OnTheSpot editing. It does |
272 | This (experimental) perl extension implements OnTheSpot editing. It does |
249 | not work perfectly, and some input methods don't seem to work well with |
273 | not work perfectly, and some input methods don't seem to work well with |
… | |
… | |
253 | You enable it by specifying this extension and a preedit style of |
277 | You enable it by specifying this extension and a preedit style of |
254 | C<OnTheSpot>, i.e.: |
278 | C<OnTheSpot>, i.e.: |
255 | |
279 | |
256 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
280 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
257 | |
281 | |
|
|
282 | =item kuake<hotkey> |
|
|
283 | |
|
|
284 | A very primitive quake-console-like extension. It was inspired by a |
|
|
285 | description of how the programs C<kuake> and C<yakuake> work: Whenever the |
|
|
286 | user presses a global accelerator key (by default C<F10>), the terminal |
|
|
287 | will show or hide itself. Another press of the accelerator key will hide |
|
|
288 | or show it again. |
|
|
289 | |
|
|
290 | Initially, the window will not be shown when using this extension. |
|
|
291 | |
|
|
292 | This is useful if you need a single terminal thats not using any desktop |
|
|
293 | space most of the time but is quickly available at the press of a key. |
|
|
294 | |
|
|
295 | The accelerator key is grabbed regardless of any modifiers, so this |
|
|
296 | extension will actually grab a physical key just for this function. |
|
|
297 | |
|
|
298 | If you want a quake-like animation, tell your window manager to do so |
|
|
299 | (fvwm can do it). |
|
|
300 | |
258 | =item automove-background |
301 | =item automove-background |
259 | |
302 | |
260 | This is basically a one-line extension that dynamically changes the background pixmap offset |
303 | This is basically a very small extension that dynamically changes the |
261 | to the window position, in effect creating the same effect as pseudo transparency with |
304 | background pixmap offset to the window position, in effect creating the |
262 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
305 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
306 | supported in this mode. Example: |
263 | |
307 | |
264 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
308 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
265 | |
309 | |
266 | =item block-graphics-to-ascii |
310 | =item block-graphics-to-ascii |
267 | |
311 | |
268 | A not very useful example of filtering all text output to the terminal, |
312 | A not very useful example of filtering all text output to the terminal |
269 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
313 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
270 | similar-looking ascii character. |
314 | similar-looking ascii character. |
271 | |
315 | |
272 | =item digital-clock |
316 | =item digital-clock |
273 | |
317 | |
… | |
… | |
319 | After a successful upload the selection will be replaced by the text given |
363 | After a successful upload the selection will be replaced by the text given |
320 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
364 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
321 | for the filename): |
365 | for the filename): |
322 | |
366 | |
323 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
367 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
368 | |
|
|
369 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
|
|
370 | the double C</> characters as comment start. Use C<\057\057> instead, |
|
|
371 | which works regardless of wether xrdb is used to parse the resource file |
|
|
372 | or not. |
324 | |
373 | |
325 | =item example-refresh-hooks |
374 | =item example-refresh-hooks |
326 | |
375 | |
327 | Displays a very simple digital clock in the upper right corner of the |
376 | Displays a very simple digital clock in the upper right corner of the |
328 | window. Illustrates overwriting the refresh callbacks to create your own |
377 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
369 | =back |
418 | =back |
370 | |
419 | |
371 | =head2 Extension Objects |
420 | =head2 Extension Objects |
372 | |
421 | |
373 | Every perl extension is a perl class. A separate perl object is created |
422 | Every perl extension is a perl class. A separate perl object is created |
374 | for each terminal and each extension and passed as the first parameter to |
423 | for each terminal, and each terminal has its own set of extenion objects, |
375 | hooks. So extensions can use their C<$self> object without having to think |
424 | which are passed as the first parameter to hooks. So extensions can use |
376 | about other extensions, with the exception of methods and members that |
425 | their C<$self> object without having to think about clashes with other |
|
|
426 | extensions or other terminals, with the exception of methods and members |
377 | begin with an underscore character C<_>: these are reserved for internal |
427 | that begin with an underscore character C<_>: these are reserved for |
378 | use. |
428 | internal use. |
379 | |
429 | |
380 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
430 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
381 | C<urxvt::term> class on this object. |
431 | C<urxvt::term> class on this object. |
382 | |
432 | |
383 | It has the following methods and data members: |
433 | It has the following methods and data members: |
… | |
… | |
404 | =head2 Hooks |
454 | =head2 Hooks |
405 | |
455 | |
406 | The following subroutines can be declared in extension files, and will be |
456 | The following subroutines can be declared in extension files, and will be |
407 | called whenever the relevant event happens. |
457 | called whenever the relevant event happens. |
408 | |
458 | |
409 | The first argument passed to them is an extension oject as described in |
459 | The first argument passed to them is an extension object as described in |
410 | the in the C<Extension Objects> section. |
460 | the in the C<Extension Objects> section. |
411 | |
461 | |
412 | B<All> of these hooks must return a boolean value. If any of the called |
462 | B<All> of these hooks must return a boolean value. If any of the called |
413 | hooks returns true, then the event counts as being I<consumed>, and the |
463 | hooks returns true, then the event counts as being I<consumed>, and the |
414 | relevant action might not be carried out by the C++ code. |
464 | relevant action might not be carried out by the C++ code. |
… | |
… | |
427 | place. |
477 | place. |
428 | |
478 | |
429 | =item on_start $term |
479 | =item on_start $term |
430 | |
480 | |
431 | Called at the very end of initialisation of a new terminal, just before |
481 | Called at the very end of initialisation of a new terminal, just before |
432 | trying to map (display) the toplevel and returning to the mainloop. |
482 | trying to map (display) the toplevel and returning to the main loop. |
433 | |
483 | |
434 | =item on_destroy $term |
484 | =item on_destroy $term |
435 | |
485 | |
436 | Called whenever something tries to destroy terminal, when the terminal is |
486 | Called whenever something tries to destroy terminal, when the terminal is |
437 | still fully functional (not for long, though). |
487 | still fully functional (not for long, though). |
… | |
… | |
464 | |
514 | |
465 | Called whenever a selection has been copied, but before the selection is |
515 | Called whenever a selection has been copied, but before the selection is |
466 | requested from the server. The selection text can be queried and changed |
516 | requested from the server. The selection text can be queried and changed |
467 | by calling C<< $term->selection >>. |
517 | by calling C<< $term->selection >>. |
468 | |
518 | |
469 | Returning a true value aborts selection grabbing. It will still be hilighted. |
519 | Returning a true value aborts selection grabbing. It will still be highlighted. |
470 | |
520 | |
471 | =item on_sel_extend $term |
521 | =item on_sel_extend $term |
472 | |
522 | |
473 | Called whenever the user tries to extend the selection (e.g. with a double |
523 | Called whenever the user tries to extend the selection (e.g. with a double |
474 | click) and is either supposed to return false (normal operation), or |
524 | click) and is either supposed to return false (normal operation), or |
475 | should extend the selection itelf and return true to suppress the built-in |
525 | should extend the selection itself and return true to suppress the built-in |
476 | processing. This can happen multiple times, as long as the callback |
526 | processing. This can happen multiple times, as long as the callback |
477 | returns true, it will be called on every further click by the user and is |
527 | returns true, it will be called on every further click by the user and is |
478 | supposed to enlarge the selection more and more, if possible. |
528 | supposed to enlarge the selection more and more, if possible. |
479 | |
529 | |
480 | See the F<selection> example extension. |
530 | See the F<selection> example extension. |
481 | |
531 | |
482 | =item on_view_change $term, $offset |
532 | =item on_view_change $term, $offset |
483 | |
533 | |
484 | Called whenever the view offset changes, i..e the user or program |
534 | Called whenever the view offset changes, i.e. the user or program |
485 | scrolls. Offset C<0> means display the normal terminal, positive values |
535 | scrolls. Offset C<0> means display the normal terminal, positive values |
486 | show this many lines of scrollback. |
536 | show this many lines of scrollback. |
487 | |
537 | |
488 | =item on_scroll_back $term, $lines, $saved |
538 | =item on_scroll_back $term, $lines, $saved |
489 | |
539 | |
… | |
… | |
513 | string should start with the extension name and a colon, to distinguish |
563 | string should start with the extension name and a colon, to distinguish |
514 | it from commands for other extensions, and this might be enforced in the |
564 | it from commands for other extensions, and this might be enforced in the |
515 | future. |
565 | future. |
516 | |
566 | |
517 | Be careful not ever to trust (in a security sense) the data you receive, |
567 | Be careful not ever to trust (in a security sense) the data you receive, |
518 | as its source can not easily be controleld (e-mail content, messages from |
568 | as its source can not easily be controlled (e-mail content, messages from |
519 | other users on the same system etc.). |
569 | other users on the same system etc.). |
520 | |
570 | |
521 | =item on_add_lines $term, $string |
571 | =item on_add_lines $term, $string |
522 | |
572 | |
523 | Called whenever text is about to be output, with the text as argument. You |
573 | Called whenever text is about to be output, with the text as argument. You |
… | |
… | |
556 | |
606 | |
557 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
607 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
558 | |
608 | |
559 | =item on_user_command $term, $string |
609 | =item on_user_command $term, $string |
560 | |
610 | |
561 | Called whenever the a user-configured event is being activated (e.g. via |
611 | Called whenever a user-configured event is being activated (e.g. via |
562 | a C<perl:string> action bound to a key, see description of the B<keysym> |
612 | a C<perl:string> action bound to a key, see description of the B<keysym> |
563 | resource in the @@RXVT_NAME@@(1) manpage). |
613 | resource in the @@RXVT_NAME@@(1) manpage). |
564 | |
614 | |
565 | The event is simply the action string. This interface is assumed to change |
615 | The event is simply the action string. This interface is assumed to change |
566 | slightly in the future. |
616 | slightly in the future. |
567 | |
617 | |
568 | =item on_resize_all_windows $tern, $new_width, $new_height |
618 | =item on_resize_all_windows $tern, $new_width, $new_height |
569 | |
619 | |
570 | Called just after the new window size has been calculcated, but before |
620 | Called just after the new window size has been calculated, but before |
571 | windows are actually being resized or hints are being set. If this hook |
621 | windows are actually being resized or hints are being set. If this hook |
572 | returns TRUE, setting of the window hints is being skipped. |
622 | returns TRUE, setting of the window hints is being skipped. |
573 | |
623 | |
574 | =item on_x_event $term, $event |
624 | =item on_x_event $term, $event |
575 | |
625 | |
576 | Called on every X event received on the vt window (and possibly other |
626 | Called on every X event received on the vt window (and possibly other |
577 | windows). Should only be used as a last resort. Most event structure |
627 | windows). Should only be used as a last resort. Most event structure |
578 | members are not passed. |
628 | members are not passed. |
579 | |
629 | |
|
|
630 | =item on_root_event $term, $event |
|
|
631 | |
|
|
632 | Like C<on_x_event>, but is called for events on the root window. |
|
|
633 | |
580 | =item on_focus_in $term |
634 | =item on_focus_in $term |
581 | |
635 | |
582 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
636 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
583 | does focus in processing. |
637 | does focus in processing. |
584 | |
638 | |
585 | =item on_focus_out $term |
639 | =item on_focus_out $term |
586 | |
640 | |
587 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
641 | Called whenever the window loses keyboard focus, before rxvt-unicode does |
588 | focus out processing. |
642 | focus out processing. |
589 | |
643 | |
590 | =item on_configure_notify $term, $event |
644 | =item on_configure_notify $term, $event |
591 | |
645 | |
592 | =item on_property_notify $term, $event |
646 | =item on_property_notify $term, $event |
… | |
… | |
675 | The current terminal. This variable stores the current C<urxvt::term> |
729 | The current terminal. This variable stores the current C<urxvt::term> |
676 | object, whenever a callback/hook is executing. |
730 | object, whenever a callback/hook is executing. |
677 | |
731 | |
678 | =item @urxvt::TERM_INIT |
732 | =item @urxvt::TERM_INIT |
679 | |
733 | |
680 | All coderefs in this array will be called as methods of the next newly |
734 | All code references in this array will be called as methods of the next newly |
681 | created C<urxvt::term> object (during the C<on_init> phase). The array |
735 | created C<urxvt::term> object (during the C<on_init> phase). The array |
682 | gets cleared before the codereferences that were in it are being executed, |
736 | gets cleared before the code references that were in it are being executed, |
683 | so coderefs can push themselves onto it again if they so desire. |
737 | so references can push themselves onto it again if they so desire. |
684 | |
738 | |
685 | This complements to the perl-eval commandline option, but gets executed |
739 | This complements to the perl-eval command line option, but gets executed |
686 | first. |
740 | first. |
687 | |
741 | |
688 | =item @urxvt::TERM_EXT |
742 | =item @urxvt::TERM_EXT |
689 | |
743 | |
690 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
744 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
… | |
… | |
715 | Messages have a size limit of 1023 bytes currently. |
769 | Messages have a size limit of 1023 bytes currently. |
716 | |
770 | |
717 | =item @terms = urxvt::termlist |
771 | =item @terms = urxvt::termlist |
718 | |
772 | |
719 | Returns all urxvt::term objects that exist in this process, regardless of |
773 | Returns all urxvt::term objects that exist in this process, regardless of |
720 | wether they are started, being destroyed etc., so be careful. Only term |
774 | whether they are started, being destroyed etc., so be careful. Only term |
721 | objects that have perl extensions attached will be returned (because there |
775 | objects that have perl extensions attached will be returned (because there |
722 | is no urxvt::term objet associated with others). |
776 | is no urxvt::term objet associated with others). |
723 | |
777 | |
724 | =item $time = urxvt::NOW |
778 | =item $time = urxvt::NOW |
725 | |
779 | |
… | |
… | |
1056 | sub DESTROY { |
1110 | sub DESTROY { |
1057 | $_[0][1]->stop; |
1111 | $_[0][1]->stop; |
1058 | } |
1112 | } |
1059 | |
1113 | |
1060 | sub condvar { |
1114 | sub condvar { |
1061 | bless \my $flag, urxvt::anyevent::condvar:: |
1115 | bless \my $flag, urxvt::anyevent:: |
1062 | } |
1116 | } |
1063 | |
1117 | |
1064 | sub urxvt::anyevent::condvar::broadcast { |
1118 | sub broadcast { |
1065 | ${$_[0]}++; |
1119 | ${$_[0]}++; |
1066 | } |
1120 | } |
1067 | |
1121 | |
1068 | sub urxvt::anyevent::condvar::wait { |
1122 | sub wait { |
1069 | unless (${$_[0]}) { |
1123 | unless (${$_[0]}) { |
1070 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1124 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
1071 | } |
1125 | } |
|
|
1126 | } |
|
|
1127 | |
|
|
1128 | sub one_event { |
|
|
1129 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1072 | } |
1130 | } |
1073 | |
1131 | |
1074 | package urxvt::term; |
1132 | package urxvt::term; |
1075 | |
1133 | |
1076 | =head2 The C<urxvt::term> Class |
1134 | =head2 The C<urxvt::term> Class |
… | |
… | |
1163 | |
1221 | |
1164 | Returns true if the option specified by C<$optval> is enabled, and |
1222 | Returns true if the option specified by C<$optval> is enabled, and |
1165 | optionally change it. All option values are stored by name in the hash |
1223 | optionally change it. All option values are stored by name in the hash |
1166 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1224 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1167 | |
1225 | |
1168 | Here is a a likely non-exhaustive list of option names, please see the |
1226 | Here is a likely non-exhaustive list of option names, please see the |
1169 | source file F</src/optinc.h> to see the actual list: |
1227 | source file F</src/optinc.h> to see the actual list: |
1170 | |
1228 | |
1171 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1229 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1172 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1230 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1173 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1231 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
… | |
… | |
1190 | likely change). |
1248 | likely change). |
1191 | |
1249 | |
1192 | Please note that resource strings will currently only be freed when the |
1250 | Please note that resource strings will currently only be freed when the |
1193 | terminal is destroyed, so changing options frequently will eat memory. |
1251 | terminal is destroyed, so changing options frequently will eat memory. |
1194 | |
1252 | |
1195 | Here is a a likely non-exhaustive list of resource names, not all of which |
1253 | Here is a likely non-exhaustive list of resource names, not all of which |
1196 | are supported in every build, please see the source file F</src/rsinc.h> |
1254 | are supported in every build, please see the source file F</src/rsinc.h> |
1197 | to see the actual list: |
1255 | to see the actual list: |
1198 | |
1256 | |
1199 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1257 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1200 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1258 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
1512 | |
1570 | |
1513 | Returns the currently displayed screen (0 primary, 1 secondary). |
1571 | Returns the currently displayed screen (0 primary, 1 secondary). |
1514 | |
1572 | |
1515 | =item $cursor_is_hidden = $term->hidden_cursor |
1573 | =item $cursor_is_hidden = $term->hidden_cursor |
1516 | |
1574 | |
1517 | Returns wether the cursor is currently hidden or not. |
1575 | Returns whether the cursor is currently hidden or not. |
1518 | |
1576 | |
1519 | =item $view_start = $term->view_start ([$newvalue]) |
1577 | =item $view_start = $term->view_start ([$newvalue]) |
1520 | |
1578 | |
1521 | Returns the row number of the topmost displayed line. Maximum value is |
1579 | Returns the row number of the topmost displayed line. Maximum value is |
1522 | C<0>, which displays the normal terminal contents. Lower values scroll |
1580 | C<0>, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1699 | where one character corresponds to one screen cell. See |
1757 | where one character corresponds to one screen cell. See |
1700 | C<< $term->ROW_t >> for details. |
1758 | C<< $term->ROW_t >> for details. |
1701 | |
1759 | |
1702 | =item $string = $term->special_decode $text |
1760 | =item $string = $term->special_decode $text |
1703 | |
1761 | |
1704 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1762 | Converts rxvt-unicodes text representation into a perl string. See |
1705 | C<< $term->ROW_t >> for details. |
1763 | C<< $term->ROW_t >> for details. |
1706 | |
1764 | |
1707 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1765 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1708 | |
1766 | |
1709 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
1767 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1712 | manpage. |
1770 | manpage. |
1713 | |
1771 | |
1714 | =item $success = $term->grab ($eventtime[, $sync]) |
1772 | =item $success = $term->grab ($eventtime[, $sync]) |
1715 | |
1773 | |
1716 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1774 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1717 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1775 | synchronous (C<$sync> is true). Also remembers the grab timestamp. |
1718 | |
1776 | |
1719 | =item $term->allow_events_async |
1777 | =item $term->allow_events_async |
1720 | |
1778 | |
1721 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1779 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1722 | |
1780 | |
… | |
… | |
1895 | =back |
1953 | =back |
1896 | |
1954 | |
1897 | =cut |
1955 | =cut |
1898 | |
1956 | |
1899 | package urxvt::watcher; |
1957 | package urxvt::watcher; |
1900 | |
|
|
1901 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1902 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1903 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1904 | @urxvt::iw::ISA = __PACKAGE__; |
|
|
1905 | |
1958 | |
1906 | =head2 The C<urxvt::timer> Class |
1959 | =head2 The C<urxvt::timer> Class |
1907 | |
1960 | |
1908 | This class implements timer watchers/events. Time is represented as a |
1961 | This class implements timer watchers/events. Time is represented as a |
1909 | fractional number of seconds since the epoch. Example: |
1962 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1989 | Set the callback to be called when io events are triggered. C<$reventmask> |
2042 | Set the callback to be called when io events are triggered. C<$reventmask> |
1990 | is a bitset as described in the C<events> method. |
2043 | is a bitset as described in the C<events> method. |
1991 | |
2044 | |
1992 | =item $iow = $iow->fd ($fd) |
2045 | =item $iow = $iow->fd ($fd) |
1993 | |
2046 | |
1994 | Set the filedescriptor (not handle) to watch. |
2047 | Set the file descriptor (not handle) to watch. |
1995 | |
2048 | |
1996 | =item $iow = $iow->events ($eventmask) |
2049 | =item $iow = $iow->events ($eventmask) |
1997 | |
2050 | |
1998 | Set the event mask to watch. The only allowed values are |
2051 | Set the event mask to watch. The only allowed values are |
1999 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2052 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
… | |
… | |
2003 | |
2056 | |
2004 | Start watching for requested events on the given handle. |
2057 | Start watching for requested events on the given handle. |
2005 | |
2058 | |
2006 | =item $iow = $iow->stop |
2059 | =item $iow = $iow->stop |
2007 | |
2060 | |
2008 | Stop watching for events on the given filehandle. |
2061 | Stop watching for events on the given file handle. |
2009 | |
2062 | |
2010 | =back |
2063 | =back |
2011 | |
2064 | |
2012 | =head2 The C<urxvt::iw> Class |
2065 | =head2 The C<urxvt::iw> Class |
2013 | |
2066 | |
… | |
… | |
2060 | |
2113 | |
2061 | Set the callback to be called when the timer triggers. |
2114 | Set the callback to be called when the timer triggers. |
2062 | |
2115 | |
2063 | =item $pw = $timer->start ($pid) |
2116 | =item $pw = $timer->start ($pid) |
2064 | |
2117 | |
2065 | Tells the wqtcher to start watching for process C<$pid>. |
2118 | Tells the watcher to start watching for process C<$pid>. |
2066 | |
2119 | |
2067 | =item $pw = $pw->stop |
2120 | =item $pw = $pw->stop |
2068 | |
2121 | |
2069 | Stop the watcher. |
2122 | Stop the watcher. |
2070 | |
2123 | |
… | |
… | |
2083 | |
2136 | |
2084 | =item >= 3 - script loading and management |
2137 | =item >= 3 - script loading and management |
2085 | |
2138 | |
2086 | =item >=10 - all called hooks |
2139 | =item >=10 - all called hooks |
2087 | |
2140 | |
2088 | =item >=11 - hook reutrn values |
2141 | =item >=11 - hook return values |
2089 | |
2142 | |
2090 | =back |
2143 | =back |
2091 | |
2144 | |
2092 | =head1 AUTHOR |
2145 | =head1 AUTHOR |
2093 | |
2146 | |