ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.178 by root, Sat Dec 26 09:02:42 2009 UTC

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
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
62 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
63 ... 66 ...
64 67
65The index number (0, 1...) must not have any holes, and each regex must 68The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for 69contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
68between two vertical bars: 71between two vertical bars:
69 72
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
71 74
72Another example: Programs I use often output "absolute path: " at the 75Another example: Programs I use often output "absolute path: " at the
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
109The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
110C<$self->{myoption}>: 113C<< $self->{myoption} >>:
111 114
112 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 }; 117 };
115 118
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide wether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 157selection if the C<Shift> modifier is active.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
166move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
220the message into vi commands to load the file. 223the message into vi commands to load the file.
221 224
222=item tabbed 225=item tabbed
223 226
224This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
225is, it implements what is commonly refered to as "tabbed terminal". The topmost line 228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one 229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227button per tab. 230button per tab.
228 231
229Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
230B<Shift-Right> will switch to the tab left or right of the current one, 233B<Shift-Right> will switch to the tab left or right of the current one,
240 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
241 244
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid 245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices. 246indices.
244 247
245=item mark-urls 248=item matcher
246 249
247Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
248make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
249resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
250the URL as first argument. 253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
251 276
252=item xim-onthespot 277=item xim-onthespot
253 278
254This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
255not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
256OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
257kinput2. 282kinput2.
258 283
259You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
261 286
262 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263 288
264=item automove-background 289=item kuake<hotkey>
265 290
266This is basically a very small extension that dynamically changes the 291A very primitive quake-console-like extension. It was inspired by a
267background pixmap offset to the window position, in effect creating the 292description of how the programs C<kuake> and C<yakuake> work: Whenever the
268same effect as pseudo transparency with a custom pixmap. No scaling is 293user presses a global accelerator key (by default C<F10>), the terminal
269supported in this mode. Exmaple: 294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
270 296
271 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 297Initially, the window will not be shown when using this extension.
298
299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key.
301
302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function.
304
305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it).
307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
272 313
273=item block-graphics-to-ascii 314=item block-graphics-to-ascii
274 315
275A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
276by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
281Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
282 323
283=item remote-clipboard 324=item remote-clipboard
284 325
285Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
286selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
287selection somewhere and fetch it again. 328selection somewhere and fetch it again.
288 329
289We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
290means that one command uploads the file to a remote server, and another 331means that one command uploads the file to a remote server, and another
291reads it. 332reads it.
326After a successful upload the selection will be replaced by the text given 367After a successful upload the selection will be replaced by the text given
327in the C<selection-pastebin-url> resource (again, the % is the placeholder 368in the C<selection-pastebin-url> resource (again, the % is the placeholder
328for the filename): 369for the filename):
329 370
330 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file
376or not.
377
378=item macosx-pastebin and macosx-pastebin-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
331 391
332=item example-refresh-hooks 392=item example-refresh-hooks
333 393
334Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
335window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
376=back 436=back
377 437
378=head2 Extension Objects 438=head2 Extension Objects
379 439
380Every perl extension is a perl class. A separate perl object is created 440Every perl extension is a perl class. A separate perl object is created
381for each terminal and each extension and passed as the first parameter to 441for each terminal, and each terminal has its own set of extenion objects,
382hooks. So extensions can use their C<$self> object without having to think 442which are passed as the first parameter to hooks. So extensions can use
383about other extensions, with the exception of methods and members that 443their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members
384begin with an underscore character C<_>: these are reserved for internal 445that begin with an underscore character C<_>: these are reserved for
385use. 446internal use.
386 447
387Although it isn't a C<urxvt::term> object, you can call all methods of the 448Although it isn't a C<urxvt::term> object, you can call all methods of the
388C<urxvt::term> class on this object. 449C<urxvt::term> class on this object.
389 450
390It has the following methods and data members: 451It has the following methods and data members:
411=head2 Hooks 472=head2 Hooks
412 473
413The following subroutines can be declared in extension files, and will be 474The following subroutines can be declared in extension files, and will be
414called whenever the relevant event happens. 475called whenever the relevant event happens.
415 476
416The first argument passed to them is an extension oject as described in 477The first argument passed to them is an extension object as described in
417the in the C<Extension Objects> section. 478the in the C<Extension Objects> section.
418 479
419B<All> of these hooks must return a boolean value. If any of the called 480B<All> of these hooks must return a boolean value. If any of the called
420hooks returns true, then the event counts as being I<consumed>, and the 481hooks returns true, then the event counts as being I<consumed>, and the
421relevant action might not be carried out by the C++ code. 482relevant action might not be carried out by the C++ code.
434place. 495place.
435 496
436=item on_start $term 497=item on_start $term
437 498
438Called at the very end of initialisation of a new terminal, just before 499Called at the very end of initialisation of a new terminal, just before
439trying to map (display) the toplevel and returning to the mainloop. 500trying to map (display) the toplevel and returning to the main loop.
440 501
441=item on_destroy $term 502=item on_destroy $term
442 503
443Called whenever something tries to destroy terminal, when the terminal is 504Called whenever something tries to destroy terminal, when the terminal is
444still fully functional (not for long, though). 505still fully functional (not for long, though).
471 532
472Called whenever a selection has been copied, but before the selection is 533Called whenever a selection has been copied, but before the selection is
473requested from the server. The selection text can be queried and changed 534requested from the server. The selection text can be queried and changed
474by calling C<< $term->selection >>. 535by calling C<< $term->selection >>.
475 536
476Returning a true value aborts selection grabbing. It will still be hilighted. 537Returning a true value aborts selection grabbing. It will still be highlighted.
477 538
478=item on_sel_extend $term 539=item on_sel_extend $term
479 540
480Called whenever the user tries to extend the selection (e.g. with a double 541Called whenever the user tries to extend the selection (e.g. with a double
481click) and is either supposed to return false (normal operation), or 542click) and is either supposed to return false (normal operation), or
482should extend the selection itelf and return true to suppress the built-in 543should extend the selection itself and return true to suppress the built-in
483processing. This can happen multiple times, as long as the callback 544processing. This can happen multiple times, as long as the callback
484returns true, it will be called on every further click by the user and is 545returns true, it will be called on every further click by the user and is
485supposed to enlarge the selection more and more, if possible. 546supposed to enlarge the selection more and more, if possible.
486 547
487See the F<selection> example extension. 548See the F<selection> example extension.
488 549
489=item on_view_change $term, $offset 550=item on_view_change $term, $offset
490 551
491Called whenever the view offset changes, i..e the user or program 552Called whenever the view offset changes, i.e. the user or program
492scrolls. Offset C<0> means display the normal terminal, positive values 553scrolls. Offset C<0> means display the normal terminal, positive values
493show this many lines of scrollback. 554show this many lines of scrollback.
494 555
495=item on_scroll_back $term, $lines, $saved 556=item on_scroll_back $term, $lines, $saved
496 557
500 561
501It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 562It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
502$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 563$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
503number of lines that will be in the scrollback buffer. 564number of lines that will be in the scrollback buffer.
504 565
505=item on_osc_seq $term, $op, $args 566=item on_osc_seq $term, $op, $args, $resp
506 567
507Called on every OSC sequence and can be used to suppress it or modify its 568Called on every OSC sequence and can be used to suppress it or modify its
508behaviour. The default should be to return an empty list. A true value 569behaviour. The default should be to return an empty list. A true value
509suppresses execution of the request completely. Make sure you don't get 570suppresses execution of the request completely. Make sure you don't get
510confused by recursive invocations when you output an osc sequence within 571confused by recursive invocations when you output an OSC sequence within
511this callback. 572this callback.
512 573
513C<on_osc_seq_perl> should be used for new behaviour. 574C<on_osc_seq_perl> should be used for new behaviour.
514 575
515=item on_osc_seq_perl $term, $string 576=item on_osc_seq_perl $term, $args, $resp
516 577
517Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 578Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518operating system command) is processed. Cursor position and other state 579operating system command) is processed. Cursor position and other state
519information is up-to-date when this happens. For interoperability, the 580information is up-to-date when this happens. For interoperability, the
520string should start with the extension name and a colon, to distinguish 581string should start with the extension name (sans -osc) and a semicolon,
521it from commands for other extensions, and this might be enforced in the 582to distinguish it from commands for other extensions, and this might be
522future. 583enforced in the future.
584
585For example, C<overlay-osc> uses this:
586
587 sub on_osc_seq_perl {
588 my ($self, $osc, $resp) = @_;
589
590 return unless $osc =~ s/^overlay;//;
591
592 ... process remaining $osc string
593 }
523 594
524Be careful not ever to trust (in a security sense) the data you receive, 595Be careful not ever to trust (in a security sense) the data you receive,
525as its source can not easily be controleld (e-mail content, messages from 596as its source can not easily be controlled (e-mail content, messages from
526other users on the same system etc.). 597other users on the same system etc.).
598
599For responses, C<$resp> contains the end-of-args separator used by the
600sender.
527 601
528=item on_add_lines $term, $string 602=item on_add_lines $term, $string
529 603
530Called whenever text is about to be output, with the text as argument. You 604Called whenever text is about to be output, with the text as argument. You
531can filter/change and output the text yourself by returning a true value 605can filter/change and output the text yourself by returning a true value
552later with the already-modified line (e.g. if unrelated parts change), so 626later with the already-modified line (e.g. if unrelated parts change), so
553you cannot just toggle rendition bits, but only set them. 627you cannot just toggle rendition bits, but only set them.
554 628
555=item on_refresh_begin $term 629=item on_refresh_begin $term
556 630
557Called just before the screen gets redrawn. Can be used for overlay 631Called just before the screen gets redrawn. Can be used for overlay or
558or similar effects by modify terminal contents in refresh_begin, and 632similar effects by modifying the terminal contents in refresh_begin, and
559restoring them in refresh_end. The built-in overlay and selection display 633restoring them in refresh_end. The built-in overlay and selection display
560code is run after this hook, and takes precedence. 634code is run after this hook, and takes precedence.
561 635
562=item on_refresh_end $term 636=item on_refresh_end $term
563 637
564Called just after the screen gets redrawn. See C<on_refresh_begin>. 638Called just after the screen gets redrawn. See C<on_refresh_begin>.
565 639
566=item on_user_command $term, $string 640=item on_user_command $term, $string
567 641
568Called whenever the a user-configured event is being activated (e.g. via 642Called whenever a user-configured event is being activated (e.g. via
569a C<perl:string> action bound to a key, see description of the B<keysym> 643a C<perl:string> action bound to a key, see description of the B<keysym>
570resource in the @@RXVT_NAME@@(1) manpage). 644resource in the @@RXVT_NAME@@(1) manpage).
571 645
572The event is simply the action string. This interface is assumed to change 646The event is simply the action string. This interface is assumed to change
573slightly in the future. 647slightly in the future.
574 648
575=item on_resize_all_windows $tern, $new_width, $new_height 649=item on_resize_all_windows $tern, $new_width, $new_height
576 650
577Called just after the new window size has been calculcated, but before 651Called just after the new window size has been calculated, but before
578windows are actually being resized or hints are being set. If this hook 652windows are actually being resized or hints are being set. If this hook
579returns TRUE, setting of the window hints is being skipped. 653returns TRUE, setting of the window hints is being skipped.
580 654
581=item on_x_event $term, $event 655=item on_x_event $term, $event
582 656
583Called on every X event received on the vt window (and possibly other 657Called on every X event received on the vt window (and possibly other
584windows). Should only be used as a last resort. Most event structure 658windows). Should only be used as a last resort. Most event structure
585members are not passed. 659members are not passed.
586 660
661=item on_root_event $term, $event
662
663Like C<on_x_event>, but is called for events on the root window.
664
587=item on_focus_in $term 665=item on_focus_in $term
588 666
589Called whenever the window gets the keyboard focus, before rxvt-unicode 667Called whenever the window gets the keyboard focus, before rxvt-unicode
590does focus in processing. 668does focus in processing.
591 669
592=item on_focus_out $term 670=item on_focus_out $term
593 671
594Called wheneever the window loses keyboard focus, before rxvt-unicode does 672Called whenever the window loses keyboard focus, before rxvt-unicode does
595focus out processing. 673focus out processing.
596 674
597=item on_configure_notify $term, $event 675=item on_configure_notify $term, $event
598 676
599=item on_property_notify $term, $event 677=item on_property_notify $term, $event
682The current terminal. This variable stores the current C<urxvt::term> 760The current terminal. This variable stores the current C<urxvt::term>
683object, whenever a callback/hook is executing. 761object, whenever a callback/hook is executing.
684 762
685=item @urxvt::TERM_INIT 763=item @urxvt::TERM_INIT
686 764
687All coderefs in this array will be called as methods of the next newly 765All code references in this array will be called as methods of the next newly
688created C<urxvt::term> object (during the C<on_init> phase). The array 766created C<urxvt::term> object (during the C<on_init> phase). The array
689gets cleared before the codereferences that were in it are being executed, 767gets cleared before the code references that were in it are being executed,
690so coderefs can push themselves onto it again if they so desire. 768so references can push themselves onto it again if they so desire.
691 769
692This complements to the perl-eval commandline option, but gets executed 770This complements to the perl-eval command line option, but gets executed
693first. 771first.
694 772
695=item @urxvt::TERM_EXT 773=item @urxvt::TERM_EXT
696 774
697Works similar to C<@TERM_INIT>, but contains perl package/class names, which 775Works similar to C<@TERM_INIT>, but contains perl package/class names, which
722Messages have a size limit of 1023 bytes currently. 800Messages have a size limit of 1023 bytes currently.
723 801
724=item @terms = urxvt::termlist 802=item @terms = urxvt::termlist
725 803
726Returns all urxvt::term objects that exist in this process, regardless of 804Returns all urxvt::term objects that exist in this process, regardless of
727wether they are started, being destroyed etc., so be careful. Only term 805whether they are started, being destroyed etc., so be careful. Only term
728objects that have perl extensions attached will be returned (because there 806objects that have perl extensions attached will be returned (because there
729is no urxvt::term objet associated with others). 807is no urxvt::term objet associated with others).
730 808
731=item $time = urxvt::NOW 809=item $time = urxvt::NOW
732 810
870 local $TERM = shift; 948 local $TERM = shift;
871 my $htype = shift; 949 my $htype = shift;
872 950
873 if ($htype == 0) { # INIT 951 if ($htype == 0) { # INIT
874 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 952 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
875 953
876 my %ext_arg; 954 my %ext_arg;
877 955
878 { 956 {
879 my @init = @TERM_INIT; 957 my @init = @TERM_INIT;
880 @TERM_INIT = (); 958 @TERM_INIT = ();
943 1021
944sub SET_COLOR($$$) { 1022sub SET_COLOR($$$) {
945 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1023 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946} 1024}
947 1025
1026sub rend2mask {
1027 no strict 'refs';
1028 my ($str, $mask) = (@_, 0);
1029 my %color = ( fg => undef, bg => undef );
1030 my @failed;
1031 for my $spec ( split /\s+/, $str ) {
1032 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1033 $color{lc($1)} = $2;
1034 } else {
1035 my $neg = $spec =~ s/^[-^]//;
1036 unless ( exists &{"RS_$spec"} ) {
1037 push @failed, $spec;
1038 next;
1039 }
1040 my $cur = &{"RS_$spec"};
1041 if ( $neg ) {
1042 $mask &= ~$cur;
1043 } else {
1044 $mask |= $cur;
1045 }
1046 }
1047 }
1048 ($mask, @color{qw(fg bg)}, \@failed)
1049}
1050
948# urxvt::term::extension 1051# urxvt::term::extension
949 1052
950package urxvt::term::extension; 1053package urxvt::term::extension;
951 1054
952sub enable { 1055sub enable {
1021is that you cannot use blocking APIs, but the non-blocking variant should 1124is that you cannot use blocking APIs, but the non-blocking variant should
1022work. 1125work.
1023 1126
1024=cut 1127=cut
1025 1128
1026our $VERSION = 1; 1129our $VERSION = '5.23';
1027 1130
1028$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1131$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1132push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030 1133
1031sub timer { 1134sub timer {
1033 1136
1034 my $cb = $arg{cb}; 1137 my $cb = $arg{cb};
1035 1138
1036 urxvt::timer 1139 urxvt::timer
1037 ->new 1140 ->new
1038 ->start (urxvt::NOW + $arg{after}) 1141 ->after ($arg{after})
1039 ->cb (sub { 1142 ->interval ($arg{interval})
1143 ->start
1144 ->cb ($argv{interval} ? $cb : sub {
1040 $_[0]->stop; # need to cancel manually 1145 $_[0]->stop; # need to cancel manually
1041 $cb->(); 1146 $cb->();
1042 }) 1147 })
1043} 1148}
1044 1149
1045sub io { 1150sub io {
1046 my ($class, %arg) = @_; 1151 my ($class, %arg) = @_;
1047 1152
1048 my $cb = $arg{cb}; 1153 my $cb = $arg{cb};
1154 my $fd = fileno $arg{fh};
1155 defined $fd or $fd = $arg{fh};
1049 1156
1050 bless [$arg{fh}, urxvt::iow 1157 bless [$arg{fh}, urxvt::iow
1051 ->new 1158 ->new
1052 ->fd (fileno $arg{fh}) 1159 ->fd ($fd)
1053 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1160 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1054 | ($arg{poll} =~ /w/ ? 2 : 0)) 1161 | ($arg{poll} =~ /w/ ? 2 : 0))
1055 ->start 1162 ->start
1056 ->cb (sub { 1163 ->cb ($cb)
1057 $cb->(($_[1] & 1 ? 'r' : '')
1058 . ($_[1] & 2 ? 'w' : ''));
1059 })],
1060 urxvt::anyevent:: 1164 ], urxvt::anyevent::
1165}
1166
1167sub idle {
1168 my ($class, %arg) = @_;
1169
1170 my $cb = $arg{cb};
1171
1172 urxvt::iw
1173 ->new
1174 ->start
1175 ->cb ($cb)
1176}
1177
1178sub child {
1179 my ($class, %arg) = @_;
1180
1181 my $cb = $arg{cb};
1182
1183 urxvt::pw
1184 ->new
1185 ->start ($arg{pid})
1186 ->cb (sub {
1187 $_[0]->stop; # need to cancel manually
1188 $cb->($_[0]->rpid, $_[0]->rstatus);
1189 })
1061} 1190}
1062 1191
1063sub DESTROY { 1192sub DESTROY {
1064 $_[0][1]->stop; 1193 $_[0][1]->stop;
1065} 1194}
1066 1195
1067sub condvar { 1196sub one_event {
1068 bless \my $flag, urxvt::anyevent::condvar::
1069}
1070
1071sub urxvt::anyevent::condvar::broadcast {
1072 ${$_[0]}++;
1073}
1074
1075sub urxvt::anyevent::condvar::wait {
1076 unless (${$_[0]}) {
1077 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1197 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1078 }
1079} 1198}
1080 1199
1081package urxvt::term; 1200package urxvt::term;
1082 1201
1083=head2 The C<urxvt::term> Class 1202=head2 The C<urxvt::term> Class
1170 1289
1171Returns true if the option specified by C<$optval> is enabled, and 1290Returns true if the option specified by C<$optval> is enabled, and
1172optionally change it. All option values are stored by name in the hash 1291optionally change it. All option values are stored by name in the hash
1173C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1292C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1174 1293
1175Here is a a likely non-exhaustive list of option names, please see the 1294Here is a likely non-exhaustive list of option names, please see the
1176source file F</src/optinc.h> to see the actual list: 1295source file F</src/optinc.h> to see the actual list:
1177 1296
1178 borderLess console cursorBlink cursorUnderline hold iconic insecure 1297 borderLess console cursorBlink cursorUnderline hold iconic insecure
1179 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1298 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1180 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1299 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1197likely change). 1316likely change).
1198 1317
1199Please note that resource strings will currently only be freed when the 1318Please note that resource strings will currently only be freed when the
1200terminal is destroyed, so changing options frequently will eat memory. 1319terminal is destroyed, so changing options frequently will eat memory.
1201 1320
1202Here is a a likely non-exhaustive list of resource names, not all of which 1321Here is a likely non-exhaustive list of resource names, not all of which
1203are supported in every build, please see the source file F</src/rsinc.h> 1322are supported in every build, please see the source file F</src/rsinc.h>
1204to see the actual list: 1323to see the actual list:
1205 1324
1206 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1325 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1207 borderLess color cursorBlink cursorUnderline cutchars delete_key 1326 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1208 display_name embed ext_bwidth fade font geometry hold iconName 1327 display_name embed ext_bwidth fade font geometry hold iconName
1209 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1328 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1210 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1329 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1211 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1330 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1212 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1331 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1332 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1333 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1334 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216 secondaryScreen secondaryScroll selectstyle shade term_name title 1335 secondaryScreen secondaryScroll shade term_name title
1217 transient_for transparent transparent_all tripleclickwords utmpInhibit 1336 transient_for transparent transparent_all tripleclickwords utmpInhibit
1218 visualBell 1337 visualBell
1219 1338
1220=cut 1339=cut
1221 1340
1222sub resource($$;$) { 1341sub resource($$;$) {
1223 my ($self, $name) = (shift, shift); 1342 my ($self, $name) = (shift, shift);
1224 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1343 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1225 &urxvt::term::_resource 1344 goto &urxvt::term::_resource
1226} 1345}
1227 1346
1228=item $value = $term->x_resource ($pattern) 1347=item $value = $term->x_resource ($pattern)
1229 1348
1230Returns the X-Resource for the given pattern, excluding the program or 1349Returns the X-Resource for the given pattern, excluding the program or
1313 1432
1314The methods currently supported on C<urxvt::overlay> objects are: 1433The methods currently supported on C<urxvt::overlay> objects are:
1315 1434
1316=over 4 1435=over 4
1317 1436
1318=item $overlay->set ($x, $y, $text, $rend) 1437=item $overlay->set ($x, $y, $text[, $rend])
1319 1438
1320Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1439Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1321text in rxvt-unicode's special encoding and an array of rendition values 1440text in rxvt-unicode's special encoding and an array of rendition values
1322at a specific position inside the overlay. 1441at a specific position inside the overlay.
1442
1443If C<$rend> is missing, then the rendition will not be changed.
1323 1444
1324=item $overlay->hide 1445=item $overlay->hide
1325 1446
1326If visible, hide the overlay, but do not destroy it. 1447If visible, hide the overlay, but do not destroy it.
1327 1448
1519 1640
1520Returns the currently displayed screen (0 primary, 1 secondary). 1641Returns the currently displayed screen (0 primary, 1 secondary).
1521 1642
1522=item $cursor_is_hidden = $term->hidden_cursor 1643=item $cursor_is_hidden = $term->hidden_cursor
1523 1644
1524Returns wether the cursor is currently hidden or not. 1645Returns whether the cursor is currently hidden or not.
1525 1646
1526=item $view_start = $term->view_start ([$newvalue]) 1647=item $view_start = $term->view_start ([$newvalue])
1527 1648
1528Returns the row number of the topmost displayed line. Maximum value is 1649Returns the row number of the topmost displayed line. Maximum value is
1529C<0>, which displays the normal terminal contents. Lower values scroll 1650C<0>, which displays the normal terminal contents. Lower values scroll
1537 1658
1538Used after changing terminal contents to display them. 1659Used after changing terminal contents to display them.
1539 1660
1540=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1661=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541 1662
1542Returns the text of the entire row with number C<$row_number>. Row C<0> 1663Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1543is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1664is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1544terminal line. The scrollback buffer starts at line C<-1> and extends to
1545line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1665terminal line. Nothing will be returned if a nonexistent line
1546is requested. 1666is requested.
1547 1667
1548If C<$new_text> is specified, it will replace characters in the current 1668If C<$new_text> is specified, it will replace characters in the current
1549line, starting at column C<$start_col> (default C<0>), which is useful 1669line, starting at column C<$start_col> (default C<0>), which is useful
1550to replace only parts of a line. The font index in the rendition will 1670to replace only parts of a line. The font index in the rendition will
1551automatically be updated. 1671automatically be updated.
1552 1672
1553C<$text> is in a special encoding: tabs and wide characters that use more 1673C<$text> is in a special encoding: tabs and wide characters that use more
1554than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1674than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1555characters. Characters with combining characters and other characters that 1675characters. Characters with combining characters and other characters that
1556do not fit into the normal tetx encoding will be replaced with characters 1676do not fit into the normal text encoding will be replaced with characters
1557in the private use area. 1677in the private use area.
1558 1678
1559You have to obey this encoding when changing text. The advantage is 1679You have to obey this encoding when changing text. The advantage is
1560that C<substr> and similar functions work on screen cells and not on 1680that C<substr> and similar functions work on screen cells and not on
1561characters. 1681characters.
1706where one character corresponds to one screen cell. See 1826where one character corresponds to one screen cell. See
1707C<< $term->ROW_t >> for details. 1827C<< $term->ROW_t >> for details.
1708 1828
1709=item $string = $term->special_decode $text 1829=item $string = $term->special_decode $text
1710 1830
1711Converts rxvt-unicodes text reprsentation into a perl string. See 1831Converts rxvt-unicodes text representation into a perl string. See
1712C<< $term->ROW_t >> for details. 1832C<< $term->ROW_t >> for details.
1713 1833
1714=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1834=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715 1835
1716=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1836=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1719manpage. 1839manpage.
1720 1840
1721=item $success = $term->grab ($eventtime[, $sync]) 1841=item $success = $term->grab ($eventtime[, $sync])
1722 1842
1723Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1843Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724synchronous (C<$sync> is true). Also remembers the grab timestampe. 1844synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725 1845
1726=item $term->allow_events_async 1846=item $term->allow_events_async
1727 1847
1728Calls XAllowEvents with AsyncBoth for the most recent grab. 1848Calls XAllowEvents with AsyncBoth for the most recent grab.
1729 1849
1748 1868
1749=item @atoms = $term->XListProperties ($window) 1869=item @atoms = $term->XListProperties ($window)
1750 1870
1751=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1871=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752 1872
1753=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1873=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754 1874
1755=item $term->XDeleteProperty ($window, $property) 1875=item $term->XDeleteProperty ($window, $property)
1756 1876
1757=item $window = $term->DefaultRootWindow 1877=item $window = $term->DefaultRootWindow
1758 1878
1880 my $env = $self->{term}->env; 2000 my $env = $self->{term}->env;
1881 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2001 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1882 delete $env->{LC_ALL}; 2002 delete $env->{LC_ALL};
1883 $env->{LC_CTYPE} = $self->{term}->locale; 2003 $env->{LC_CTYPE} = $self->{term}->locale;
1884 2004
1885 urxvt::term->new ($env, "popup", 2005 my $term = urxvt::term->new (
2006 $env, "popup",
1886 "--perl-lib" => "", "--perl-ext-common" => "", 2007 "--perl-lib" => "", "--perl-ext-common" => "",
1887 "-pty-fd" => -1, "-sl" => 0, 2008 "-pty-fd" => -1, "-sl" => 0,
1888 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2009 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889 "--transient-for" => $self->{term}->parent, 2010 "--transient-for" => $self->{term}->parent,
1890 "-display" => $self->{term}->display_id, 2011 "-display" => $self->{term}->display_id,
1891 "-pe" => "urxvt-popup") 2012 "-pe" => "urxvt-popup",
1892 or die "unable to create popup window\n"; 2013 ) or die "unable to create popup window\n";
2014
2015 unless (delete $term->{urxvt_popup_init_done}) {
2016 $term->ungrab;
2017 $term->destroy;
2018 die "unable to initialise popup window\n";
2019 }
1893} 2020}
1894 2021
1895sub DESTROY { 2022sub DESTROY {
1896 my ($self) = @_; 2023 my ($self) = @_;
1897 2024
1902=back 2029=back
1903 2030
1904=cut 2031=cut
1905 2032
1906package urxvt::watcher; 2033package urxvt::watcher;
1907
1908@urxvt::timer::ISA = __PACKAGE__;
1909@urxvt::iow::ISA = __PACKAGE__;
1910@urxvt::pw::ISA = __PACKAGE__;
1911@urxvt::iw::ISA = __PACKAGE__;
1912 2034
1913=head2 The C<urxvt::timer> Class 2035=head2 The C<urxvt::timer> Class
1914 2036
1915This class implements timer watchers/events. Time is represented as a 2037This class implements timer watchers/events. Time is represented as a
1916fractional number of seconds since the epoch. Example: 2038fractional number of seconds since the epoch. Example:
1920 ->new 2042 ->new
1921 ->interval (1) 2043 ->interval (1)
1922 ->cb (sub { 2044 ->cb (sub {
1923 $term->{overlay}->set (0, 0, 2045 $term->{overlay}->set (0, 0,
1924 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2046 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925 }); 2047 });
1926 2048
1927=over 4 2049=over 4
1928 2050
1929=item $timer = new urxvt::timer 2051=item $timer = new urxvt::timer
1930 2052
1973 2095
1974 $term->{socket} = ... 2096 $term->{socket} = ...
1975 $term->{iow} = urxvt::iow 2097 $term->{iow} = urxvt::iow
1976 ->new 2098 ->new
1977 ->fd (fileno $term->{socket}) 2099 ->fd (fileno $term->{socket})
1978 ->events (urxvt::EVENT_READ) 2100 ->events (urxvt::EV_READ)
1979 ->start 2101 ->start
1980 ->cb (sub { 2102 ->cb (sub {
1981 my ($iow, $revents) = @_; 2103 my ($iow, $revents) = @_;
1982 # $revents must be 1 here, no need to check 2104 # $revents must be 1 here, no need to check
1983 sysread $term->{socket}, my $buf, 8192 2105 sysread $term->{socket}, my $buf, 8192
1996Set the callback to be called when io events are triggered. C<$reventmask> 2118Set the callback to be called when io events are triggered. C<$reventmask>
1997is a bitset as described in the C<events> method. 2119is a bitset as described in the C<events> method.
1998 2120
1999=item $iow = $iow->fd ($fd) 2121=item $iow = $iow->fd ($fd)
2000 2122
2001Set the filedescriptor (not handle) to watch. 2123Set the file descriptor (not handle) to watch.
2002 2124
2003=item $iow = $iow->events ($eventmask) 2125=item $iow = $iow->events ($eventmask)
2004 2126
2005Set the event mask to watch. The only allowed values are 2127Set the event mask to watch. The only allowed values are
2006C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2128C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2007together, or C<urxvt::EVENT_NONE>. 2129together, or C<urxvt::EV_NONE>.
2008 2130
2009=item $iow = $iow->start 2131=item $iow = $iow->start
2010 2132
2011Start watching for requested events on the given handle. 2133Start watching for requested events on the given handle.
2012 2134
2013=item $iow = $iow->stop 2135=item $iow = $iow->stop
2014 2136
2015Stop watching for events on the given filehandle. 2137Stop watching for events on the given file handle.
2016 2138
2017=back 2139=back
2018 2140
2019=head2 The C<urxvt::iw> Class 2141=head2 The C<urxvt::iw> Class
2020 2142
2053 ->new 2175 ->new
2054 ->start ($pid) 2176 ->start ($pid)
2055 ->cb (sub { 2177 ->cb (sub {
2056 my ($pw, $exit_status) = @_; 2178 my ($pw, $exit_status) = @_;
2057 ... 2179 ...
2058 }); 2180 });
2059 2181
2060=over 4 2182=over 4
2061 2183
2062=item $pw = new urxvt::pw 2184=item $pw = new urxvt::pw
2063 2185
2067 2189
2068Set the callback to be called when the timer triggers. 2190Set the callback to be called when the timer triggers.
2069 2191
2070=item $pw = $timer->start ($pid) 2192=item $pw = $timer->start ($pid)
2071 2193
2072Tells the wqtcher to start watching for process C<$pid>. 2194Tells the watcher to start watching for process C<$pid>.
2073 2195
2074=item $pw = $pw->stop 2196=item $pw = $pw->stop
2075 2197
2076Stop the watcher. 2198Stop the watcher.
2077 2199
2090 2212
2091=item >= 3 - script loading and management 2213=item >= 3 - script loading and management
2092 2214
2093=item >=10 - all called hooks 2215=item >=10 - all called hooks
2094 2216
2095=item >=11 - hook reutrn values 2217=item >=11 - hook return values
2096 2218
2097=back 2219=back
2098 2220
2099=head1 AUTHOR 2221=head1 AUTHOR
2100 2222
2102 http://software.schmorp.de/pkg/rxvt-unicode 2224 http://software.schmorp.de/pkg/rxvt-unicode
2103 2225
2104=cut 2226=cut
2105 2227
21061 22281
2229
2230# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines