… | |
… | |
40 | |
40 | |
41 | @@RXVT_NAME@@ -pe <extensionname> |
41 | @@RXVT_NAME@@ -pe <extensionname> |
42 | |
42 | |
43 | Or by adding them to the resource for extensions loaded by default: |
43 | Or by adding them to the resource for extensions loaded by default: |
44 | |
44 | |
45 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
45 | URxvt.perl-ext-common: default,selection-autotransform |
46 | |
46 | |
47 | =over 4 |
47 | =over 4 |
48 | |
48 | |
49 | =item selection (enabled by default) |
49 | =item selection (enabled by default) |
50 | |
50 | |
… | |
… | |
101 | |
101 | |
102 | Other extensions can extend this popup menu by pushing a code reference |
102 | Other extensions can extend this popup menu by pushing a code reference |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
103 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
104 | popup is being displayed. |
104 | popup is being displayed. |
105 | |
105 | |
106 | It's sole argument is the popup menu, which can be modified. It should |
106 | Its sole argument is the popup menu, which can be modified. It should |
107 | either return nothing or a string, the initial boolean value and a code |
107 | either return nothing or a string, the initial boolean value and a code |
108 | reference. The string will be used as button text and the code reference |
108 | reference. The string will be used as button text and the code reference |
109 | will be called when the toggle changes, with the new boolean value as |
109 | will be called when the toggle changes, with the new boolean value as |
110 | first argument. |
110 | first argument. |
111 | |
111 | |
112 | The following will add an entry C<myoption> that changes |
112 | The following will add an entry C<myoption> that changes |
113 | C<$self->{myoption}>: |
113 | C<< $self->{myoption} >>: |
114 | |
114 | |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
115 | push @{ $self->{term}{option_popup_hook} }, sub { |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
116 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
117 | }; |
117 | }; |
118 | |
118 | |
… | |
… | |
124 | |
124 | |
125 | Other extensions can extend this popup menu by pushing a code reference |
125 | Other extensions can extend this popup menu by pushing a code reference |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
126 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
127 | popup is being displayed. |
127 | popup is being displayed. |
128 | |
128 | |
129 | It's sole argument is the popup menu, which can be modified. The selection |
129 | Its sole argument is the popup menu, which can be modified. The selection |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
130 | is in C<$_>, which can be used to decide whether to add something or not. |
131 | It should either return nothing or a string and a code reference. The |
131 | It should either return nothing or a string and a code reference. The |
132 | string will be used as button text and the code reference will be called |
132 | string will be used as button text and the code reference will be called |
133 | when the button gets activated and should transform C<$_>. |
133 | when the button gets activated and should transform C<$_>. |
134 | |
134 | |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
135 | The following will add an entry C<a to b> that transforms all C<a>s in |
136 | the selection to C<b>s, but only if the selection currently contains any |
136 | the selection to C<b>s, but only if the selection currently contains any |
137 | C<a>s: |
137 | C<a>s: |
138 | |
138 | |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
139 | push @{ $self->{term}{selection_popup_hook} }, sub { |
140 | /a/ ? ("a to be" => sub { s/a/b/g } |
140 | /a/ ? ("a to b" => sub { s/a/b/g } |
141 | : () |
141 | : () |
142 | }; |
142 | }; |
143 | |
143 | |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
144 | =item searchable-scrollback<hotkey> (enabled by default) |
145 | |
145 | |
… | |
… | |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
152 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
153 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
154 | bottom. C<Escape> leaves search mode and returns to the point where search |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
155 | was started, while C<Enter> or C<Return> stay at the current position and |
156 | additionally stores the first match in the current line into the primary |
156 | additionally stores the first match in the current line into the primary |
157 | selection. |
157 | selection if the C<Shift> modifier is active. |
158 | |
158 | |
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
159 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
160 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
161 | or simply use an uppercase character which removes the "(?i)" prefix. |
162 | |
162 | |
… | |
… | |
165 | =item readline (enabled by default) |
165 | =item readline (enabled by default) |
166 | |
166 | |
167 | A support package that tries to make editing with readline easier. At |
167 | A support package that tries to make editing with readline easier. At |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
168 | the moment, it reacts to clicking shift-left mouse button by trying to |
169 | move the text cursor to this position. It does so by generating as many |
169 | move the text cursor to this position. It does so by generating as many |
170 | cursor-left or cursor-right keypresses as required (the this only works |
170 | cursor-left or cursor-right keypresses as required (this only works |
171 | for programs that correctly support wide characters). |
171 | for programs that correctly support wide characters). |
172 | |
172 | |
173 | To avoid too many false positives, this is only done when: |
173 | To avoid too many false positives, this is only done when: |
174 | |
174 | |
175 | =over 4 |
175 | =over 4 |
… | |
… | |
259 | The default pattern to match URLs can be overridden with the |
259 | The default pattern to match URLs can be overridden with the |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
262 | The launcher can also be overridden on a per-pattern basis. |
262 | The launcher can also be overridden on a per-pattern basis. |
263 | |
263 | |
|
|
264 | It is possible to activate the most recently seen match from the keyboard. |
|
|
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
|
|
266 | |
264 | Example configuration: |
267 | Example configuration: |
265 | |
268 | |
266 | URxvt.perl-ext: default,matcher |
269 | URxvt.perl-ext: default,matcher |
267 | URxvt.urlLauncher: sensible-browser |
270 | URxvt.urlLauncher: sensible-browser |
268 | URxvt.keysym.C-Delete: perl:matcher |
271 | URxvt.keysym.C-Delete: perl:matcher |
… | |
… | |
273 | |
276 | |
274 | =item xim-onthespot |
277 | =item xim-onthespot |
275 | |
278 | |
276 | This (experimental) perl extension implements OnTheSpot editing. It does |
279 | This (experimental) perl extension implements OnTheSpot editing. It does |
277 | not work perfectly, and some input methods don't seem to work well with |
280 | not work perfectly, and some input methods don't seem to work well with |
278 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
281 | OnTheSpot editing in general, but it seems to work at least for SCIM and |
279 | kinput2. |
282 | kinput2. |
280 | |
283 | |
281 | You enable it by specifying this extension and a preedit style of |
284 | You enable it by specifying this extension and a preedit style of |
282 | C<OnTheSpot>, i.e.: |
285 | C<OnTheSpot>, i.e.: |
283 | |
286 | |
… | |
… | |
291 | will show or hide itself. Another press of the accelerator key will hide |
294 | will show or hide itself. Another press of the accelerator key will hide |
292 | or show it again. |
295 | or show it again. |
293 | |
296 | |
294 | Initially, the window will not be shown when using this extension. |
297 | Initially, the window will not be shown when using this extension. |
295 | |
298 | |
296 | This is useful if you need a single terminal thats not using any desktop |
299 | This is useful if you need a single terminal that is not using any desktop |
297 | space most of the time but is quickly available at the press of a key. |
300 | space most of the time but is quickly available at the press of a key. |
298 | |
301 | |
299 | The accelerator key is grabbed regardless of any modifiers, so this |
302 | The accelerator key is grabbed regardless of any modifiers, so this |
300 | extension will actually grab a physical key just for this function. |
303 | extension will actually grab a physical key just for this function. |
301 | |
304 | |
302 | If you want a quake-like animation, tell your window manager to do so |
305 | If you want a quake-like animation, tell your window manager to do so |
303 | (fvwm can do it). |
306 | (fvwm can do it). |
304 | |
307 | |
305 | =item automove-background |
308 | =item overlay-osc |
306 | |
309 | |
307 | This is basically a very small extension that dynamically changes the |
310 | This extension implements some OSC commands to display timed popups on the |
308 | background pixmap offset to the window position, in effect creating the |
311 | screen - useful for status displays from within scripts. You have to read |
309 | same effect as pseudo transparency with a custom pixmap. No scaling is |
312 | the sources for more info. |
310 | supported in this mode. Example: |
|
|
311 | |
|
|
312 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
313 | |
|
|
314 | L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions> |
|
|
315 | shows how this extension can be used to implement an automatically blurred |
|
|
316 | transparent background. |
|
|
317 | |
313 | |
318 | =item block-graphics-to-ascii |
314 | =item block-graphics-to-ascii |
319 | |
315 | |
320 | A not very useful example of filtering all text output to the terminal |
316 | A not very useful example of filtering all text output to the terminal |
321 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
317 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
326 | Displays a digital clock using the built-in overlay. |
322 | Displays a digital clock using the built-in overlay. |
327 | |
323 | |
328 | =item remote-clipboard |
324 | =item remote-clipboard |
329 | |
325 | |
330 | Somewhat of a misnomer, this extension adds two menu entries to the |
326 | Somewhat of a misnomer, this extension adds two menu entries to the |
331 | selection popup that allows one ti run external commands to store the |
327 | selection popup that allows one to run external commands to store the |
332 | selection somewhere and fetch it again. |
328 | selection somewhere and fetch it again. |
333 | |
329 | |
334 | We use it to implement a "distributed selection mechanism", which just |
330 | We use it to implement a "distributed selection mechanism", which just |
335 | means that one command uploads the file to a remote server, and another |
331 | means that one command uploads the file to a remote server, and another |
336 | reads it. |
332 | reads it. |
… | |
… | |
345 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
346 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
347 | |
343 | |
348 | =item selection-pastebin |
344 | =item selection-pastebin |
349 | |
345 | |
350 | This is a little rarely useful extension that Uploads the selection as |
346 | This is a little rarely useful extension that uploads the selection as |
351 | textfile to a remote site (or does other things). (The implementation is |
347 | textfile to a remote site (or does other things). (The implementation is |
352 | not currently secure for use in a multiuser environment as it writes to |
348 | not currently secure for use in a multiuser environment as it writes to |
353 | F</tmp> directly.). |
349 | F</tmp> directly.). |
354 | |
350 | |
355 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
… | |
… | |
374 | |
370 | |
375 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
376 | |
372 | |
377 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
378 | the double C</> characters as comment start. Use C<\057\057> instead, |
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
379 | which works regardless of wether xrdb is used to parse the resource file |
375 | which works regardless of whether xrdb is used to parse the resource file |
380 | or not. |
376 | or not. |
|
|
377 | |
|
|
378 | =item macosx-clipboard and macosx-clipboard-native |
|
|
379 | |
|
|
380 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
381 | used 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 | |
|
|
387 | The difference between them is that the native variant requires a |
|
|
388 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
|
|
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
390 | simpler etc. etc. |
381 | |
391 | |
382 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
383 | |
393 | |
384 | Displays a very simple digital clock in the upper right corner of the |
394 | Displays a very simple digital clock in the upper right corner of the |
385 | window. Illustrates overwriting the refresh callbacks to create your own |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
386 | overlays or changes. |
396 | overlays or changes. |
|
|
397 | |
|
|
398 | =item confirm-paste |
|
|
399 | |
|
|
400 | Displays a confirmation dialog when a paste containing at least a full |
|
|
401 | line is detected. |
387 | |
402 | |
388 | =back |
403 | =back |
389 | |
404 | |
390 | =head1 API DOCUMENTATION |
405 | =head1 API DOCUMENTATION |
391 | |
406 | |
… | |
… | |
407 | |
422 | |
408 | =over 4 |
423 | =over 4 |
409 | |
424 | |
410 | =item $text |
425 | =item $text |
411 | |
426 | |
412 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
427 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
413 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
428 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
414 | |
429 | |
415 | =item $string |
430 | =item $string |
416 | |
431 | |
417 | A perl text string, with an emphasis on I<text>. It can store all unicode |
432 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
551 | |
566 | |
552 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
567 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
553 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
568 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
554 | number of lines that will be in the scrollback buffer. |
569 | number of lines that will be in the scrollback buffer. |
555 | |
570 | |
556 | =item on_osc_seq $term, $op, $args |
571 | =item on_osc_seq $term, $op, $args, $resp |
557 | |
572 | |
558 | Called on every OSC sequence and can be used to suppress it or modify its |
573 | Called on every OSC sequence and can be used to suppress it or modify its |
559 | behaviour. The default should be to return an empty list. A true value |
574 | behaviour. The default should be to return an empty list. A true value |
560 | suppresses execution of the request completely. Make sure you don't get |
575 | suppresses execution of the request completely. Make sure you don't get |
561 | confused by recursive invocations when you output an osc sequence within |
576 | confused by recursive invocations when you output an OSC sequence within |
562 | this callback. |
577 | this callback. |
563 | |
578 | |
564 | C<on_osc_seq_perl> should be used for new behaviour. |
579 | C<on_osc_seq_perl> should be used for new behaviour. |
565 | |
580 | |
566 | =item on_osc_seq_perl $term, $string |
581 | =item on_osc_seq_perl $term, $args, $resp |
567 | |
582 | |
568 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
583 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
569 | operating system command) is processed. Cursor position and other state |
584 | operating system command) is processed. Cursor position and other state |
570 | information is up-to-date when this happens. For interoperability, the |
585 | information is up-to-date when this happens. For interoperability, the |
571 | string should start with the extension name and a colon, to distinguish |
586 | string should start with the extension name (sans -osc) and a semicolon, |
572 | it from commands for other extensions, and this might be enforced in the |
587 | to distinguish it from commands for other extensions, and this might be |
573 | future. |
588 | enforced in the future. |
|
|
589 | |
|
|
590 | For example, C<overlay-osc> uses this: |
|
|
591 | |
|
|
592 | sub on_osc_seq_perl { |
|
|
593 | my ($self, $osc, $resp) = @_; |
|
|
594 | |
|
|
595 | return unless $osc =~ s/^overlay;//; |
|
|
596 | |
|
|
597 | ... process remaining $osc string |
|
|
598 | } |
574 | |
599 | |
575 | Be careful not ever to trust (in a security sense) the data you receive, |
600 | Be careful not ever to trust (in a security sense) the data you receive, |
576 | as its source can not easily be controlled (e-mail content, messages from |
601 | as its source can not easily be controlled (e-mail content, messages from |
577 | other users on the same system etc.). |
602 | other users on the same system etc.). |
|
|
603 | |
|
|
604 | For responses, C<$resp> contains the end-of-args separator used by the |
|
|
605 | sender. |
578 | |
606 | |
579 | =item on_add_lines $term, $string |
607 | =item on_add_lines $term, $string |
580 | |
608 | |
581 | Called whenever text is about to be output, with the text as argument. You |
609 | Called whenever text is about to be output, with the text as argument. You |
582 | can filter/change and output the text yourself by returning a true value |
610 | can filter/change and output the text yourself by returning a true value |
… | |
… | |
587 | =item on_tt_write $term, $octets |
615 | =item on_tt_write $term, $octets |
588 | |
616 | |
589 | Called whenever some data is written to the tty/pty and can be used to |
617 | Called whenever some data is written to the tty/pty and can be used to |
590 | suppress or filter tty input. |
618 | suppress or filter tty input. |
591 | |
619 | |
|
|
620 | =item on_tt_paste $term, $octets |
|
|
621 | |
|
|
622 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
623 | can filter/change and paste the text yourself by returning a true value |
|
|
624 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
625 | locale-encoded. |
|
|
626 | |
592 | =item on_line_update $term, $row |
627 | =item on_line_update $term, $row |
593 | |
628 | |
594 | Called whenever a line was updated or changed. Can be used to filter |
629 | Called whenever a line was updated or changed. Can be used to filter |
595 | screen output (e.g. underline urls or other useless stuff). Only lines |
630 | screen output (e.g. underline urls or other useless stuff). Only lines |
596 | that are being shown will be filtered, and, due to performance reasons, |
631 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
603 | later with the already-modified line (e.g. if unrelated parts change), so |
638 | later with the already-modified line (e.g. if unrelated parts change), so |
604 | you cannot just toggle rendition bits, but only set them. |
639 | you cannot just toggle rendition bits, but only set them. |
605 | |
640 | |
606 | =item on_refresh_begin $term |
641 | =item on_refresh_begin $term |
607 | |
642 | |
608 | Called just before the screen gets redrawn. Can be used for overlay |
643 | Called just before the screen gets redrawn. Can be used for overlay or |
609 | or similar effects by modify terminal contents in refresh_begin, and |
644 | similar effects by modifying the terminal contents in refresh_begin, and |
610 | restoring them in refresh_end. The built-in overlay and selection display |
645 | restoring them in refresh_end. The built-in overlay and selection display |
611 | code is run after this hook, and takes precedence. |
646 | code is run after this hook, and takes precedence. |
612 | |
647 | |
613 | =item on_refresh_end $term |
648 | =item on_refresh_end $term |
614 | |
649 | |
… | |
… | |
621 | resource in the @@RXVT_NAME@@(1) manpage). |
656 | resource in the @@RXVT_NAME@@(1) manpage). |
622 | |
657 | |
623 | The event is simply the action string. This interface is assumed to change |
658 | The event is simply the action string. This interface is assumed to change |
624 | slightly in the future. |
659 | slightly in the future. |
625 | |
660 | |
626 | =item on_resize_all_windows $tern, $new_width, $new_height |
661 | =item on_resize_all_windows $term, $new_width, $new_height |
627 | |
662 | |
628 | Called just after the new window size has been calculated, but before |
663 | Called just after the new window size has been calculated, but before |
629 | windows are actually being resized or hints are being set. If this hook |
664 | windows are actually being resized or hints are being set. If this hook |
630 | returns TRUE, setting of the window hints is being skipped. |
665 | returns TRUE, setting of the window hints is being skipped. |
631 | |
666 | |
… | |
… | |
665 | |
700 | |
666 | =item on_map_notify $term, $event |
701 | =item on_map_notify $term, $event |
667 | |
702 | |
668 | =item on_unmap_notify $term, $event |
703 | =item on_unmap_notify $term, $event |
669 | |
704 | |
670 | Called whenever the corresponding X event is received for the terminal If |
705 | Called whenever the corresponding X event is received for the terminal. If |
671 | the hook returns true, then the even will be ignored by rxvt-unicode. |
706 | the hook returns true, then the event will be ignored by rxvt-unicode. |
672 | |
707 | |
673 | The event is a hash with most values as named by Xlib (see the XEvent |
708 | The event is a hash with most values as named by Xlib (see the XEvent |
674 | manpage), with the additional members C<row> and C<col>, which are the |
709 | manpage), with the additional members C<row> and C<col>, which are the |
675 | (real, not screen-based) row and column under the mouse cursor. |
710 | (real, not screen-based) row and column under the mouse cursor. |
676 | |
711 | |
… | |
… | |
685 | |
720 | |
686 | =item on_wm_delete_window $term, $event |
721 | =item on_wm_delete_window $term, $event |
687 | |
722 | |
688 | Called when various types of ClientMessage events are received (all with |
723 | Called when various types of ClientMessage events are received (all with |
689 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
724 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
725 | |
|
|
726 | =item on_bell $term |
|
|
727 | |
|
|
728 | Called on receipt of a bell character. |
690 | |
729 | |
691 | =back |
730 | =back |
692 | |
731 | |
693 | =cut |
732 | =cut |
694 | |
733 | |
… | |
… | |
832 | |
871 | |
833 | =item $rend = urxvt::OVERLAY_RSTYLE |
872 | =item $rend = urxvt::OVERLAY_RSTYLE |
834 | |
873 | |
835 | Return the rendition mask used for overlays by default. |
874 | Return the rendition mask used for overlays by default. |
836 | |
875 | |
837 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
876 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
877 | urxvt::RS_RVid, urxvt::RS_Uline |
838 | |
878 | |
839 | Return the bit that enabled bold, italic, blink, reverse-video and |
879 | Return the bit that enabled bold, italic, blink, reverse-video and |
840 | underline, respectively. To enable such a style, just logically OR it into |
880 | underline, respectively. To enable such a style, just logically OR it into |
841 | the bitset. |
881 | the bitset. |
842 | |
882 | |
… | |
… | |
925 | local $TERM = shift; |
965 | local $TERM = shift; |
926 | my $htype = shift; |
966 | my $htype = shift; |
927 | |
967 | |
928 | if ($htype == 0) { # INIT |
968 | if ($htype == 0) { # INIT |
929 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
969 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
930 | |
970 | |
931 | my %ext_arg; |
971 | my %ext_arg; |
932 | |
972 | |
933 | { |
973 | { |
934 | my @init = @TERM_INIT; |
974 | my @init = @TERM_INIT; |
935 | @TERM_INIT = (); |
975 | @TERM_INIT = (); |
… | |
… | |
1101 | is that you cannot use blocking APIs, but the non-blocking variant should |
1141 | is that you cannot use blocking APIs, but the non-blocking variant should |
1102 | work. |
1142 | work. |
1103 | |
1143 | |
1104 | =cut |
1144 | =cut |
1105 | |
1145 | |
1106 | our $VERSION = 1; |
1146 | our $VERSION = '5.23'; |
1107 | |
1147 | |
1108 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1148 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1109 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1149 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1110 | |
1150 | |
1111 | sub timer { |
1151 | sub timer { |
… | |
… | |
1113 | |
1153 | |
1114 | my $cb = $arg{cb}; |
1154 | my $cb = $arg{cb}; |
1115 | |
1155 | |
1116 | urxvt::timer |
1156 | urxvt::timer |
1117 | ->new |
1157 | ->new |
1118 | ->start (urxvt::NOW + $arg{after}) |
1158 | ->after ($arg{after}, $arg{interval}) |
1119 | ->cb (sub { |
1159 | ->cb ($arg{interval} ? $cb : sub { |
1120 | $_[0]->stop; # need to cancel manually |
1160 | $_[0]->stop; # need to cancel manually |
1121 | $cb->(); |
1161 | $cb->(); |
1122 | }) |
1162 | }) |
1123 | } |
1163 | } |
1124 | |
1164 | |
1125 | sub io { |
1165 | sub io { |
1126 | my ($class, %arg) = @_; |
1166 | my ($class, %arg) = @_; |
1127 | |
1167 | |
1128 | my $cb = $arg{cb}; |
1168 | my $cb = $arg{cb}; |
|
|
1169 | my $fd = fileno $arg{fh}; |
|
|
1170 | defined $fd or $fd = $arg{fh}; |
1129 | |
1171 | |
1130 | bless [$arg{fh}, urxvt::iow |
1172 | bless [$arg{fh}, urxvt::iow |
1131 | ->new |
1173 | ->new |
1132 | ->fd (fileno $arg{fh}) |
1174 | ->fd ($fd) |
1133 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1175 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1134 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1176 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1135 | ->start |
1177 | ->start |
1136 | ->cb (sub { |
1178 | ->cb ($cb) |
1137 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1138 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1139 | })], |
|
|
1140 | urxvt::anyevent:: |
1179 | ], urxvt::anyevent:: |
|
|
1180 | } |
|
|
1181 | |
|
|
1182 | sub idle { |
|
|
1183 | my ($class, %arg) = @_; |
|
|
1184 | |
|
|
1185 | my $cb = $arg{cb}; |
|
|
1186 | |
|
|
1187 | urxvt::iw |
|
|
1188 | ->new |
|
|
1189 | ->start |
|
|
1190 | ->cb ($cb) |
|
|
1191 | } |
|
|
1192 | |
|
|
1193 | sub child { |
|
|
1194 | my ($class, %arg) = @_; |
|
|
1195 | |
|
|
1196 | my $cb = $arg{cb}; |
|
|
1197 | |
|
|
1198 | urxvt::pw |
|
|
1199 | ->new |
|
|
1200 | ->start ($arg{pid}) |
|
|
1201 | ->cb (sub { |
|
|
1202 | $_[0]->stop; # need to cancel manually |
|
|
1203 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1204 | }) |
1141 | } |
1205 | } |
1142 | |
1206 | |
1143 | sub DESTROY { |
1207 | sub DESTROY { |
1144 | $_[0][1]->stop; |
1208 | $_[0][1]->stop; |
1145 | } |
|
|
1146 | |
|
|
1147 | sub condvar { |
|
|
1148 | bless \my $flag, urxvt::anyevent:: |
|
|
1149 | } |
|
|
1150 | |
|
|
1151 | sub broadcast { |
|
|
1152 | ${$_[0]}++; |
|
|
1153 | } |
|
|
1154 | |
|
|
1155 | sub wait { |
|
|
1156 | unless (${$_[0]}) { |
|
|
1157 | Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; |
|
|
1158 | } |
|
|
1159 | } |
1209 | } |
1160 | |
1210 | |
1161 | sub one_event { |
1211 | sub one_event { |
1162 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1212 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1163 | } |
1213 | } |
… | |
… | |
1286 | Here is a likely non-exhaustive list of resource names, not all of which |
1336 | Here is a likely non-exhaustive list of resource names, not all of which |
1287 | are supported in every build, please see the source file F</src/rsinc.h> |
1337 | are supported in every build, please see the source file F</src/rsinc.h> |
1288 | to see the actual list: |
1338 | to see the actual list: |
1289 | |
1339 | |
1290 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1340 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1291 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1341 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1292 | display_name embed ext_bwidth fade font geometry hold iconName |
1342 | display_name embed ext_bwidth fade font geometry hold iconName |
1293 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1343 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1294 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1344 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1295 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1345 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1296 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1346 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1297 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1347 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1298 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1348 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1299 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1349 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1300 | secondaryScreen secondaryScroll selectstyle shade term_name title |
1350 | secondaryScreen secondaryScroll shade term_name title |
1301 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1351 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1302 | visualBell |
1352 | visualBell |
1303 | |
1353 | |
1304 | =cut |
1354 | =cut |
1305 | |
1355 | |
1306 | sub resource($$;$) { |
1356 | sub resource($$;$) { |
1307 | my ($self, $name) = (shift, shift); |
1357 | my ($self, $name) = (shift, shift); |
1308 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1358 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
1309 | &urxvt::term::_resource |
1359 | goto &urxvt::term::_resource |
1310 | } |
1360 | } |
1311 | |
1361 | |
1312 | =item $value = $term->x_resource ($pattern) |
1362 | =item $value = $term->x_resource ($pattern) |
1313 | |
1363 | |
1314 | Returns the X-Resource for the given pattern, excluding the program or |
1364 | Returns the X-Resource for the given pattern, excluding the program or |
… | |
… | |
1339 | |
1389 | |
1340 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1390 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1341 | |
1391 | |
1342 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1392 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1343 | |
1393 | |
1344 | Return the current values of the selection mark, begin or end positions, |
1394 | Return the current values of the selection mark, begin or end positions. |
1345 | and optionally set them to new values. |
1395 | |
|
|
1396 | When arguments are given, then the selection coordinates are set to |
|
|
1397 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1398 | screen. |
|
|
1399 | |
|
|
1400 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1401 | |
|
|
1402 | Returns the current selection screen, and then optionally sets it. |
1346 | |
1403 | |
1347 | =item $term->selection_make ($eventtime[, $rectangular]) |
1404 | =item $term->selection_make ($eventtime[, $rectangular]) |
1348 | |
1405 | |
1349 | Tries to make a selection as set by C<selection_beg> and |
1406 | Tries to make a selection as set by C<selection_beg> and |
1350 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1407 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1351 | rectangular selection will be made. This is the prefered function to make |
1408 | rectangular selection will be made. This is the preferred function to make |
1352 | a selection. |
1409 | a selection. |
1353 | |
1410 | |
1354 | =item $success = $term->selection_grab ($eventtime) |
1411 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1355 | |
1412 | |
1356 | Try to request the primary selection text from the server (for example, as |
1413 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1414 | true) selection from the server. The corresponding text can be set |
1357 | set by the next method). No visual feedback will be given. This function |
1415 | with the next method. No visual feedback will be given. This function |
1358 | is mostly useful from within C<on_sel_grab> hooks. |
1416 | is mostly useful from within C<on_sel_grab> hooks. |
1359 | |
1417 | |
1360 | =item $oldtext = $term->selection ([$newtext]) |
1418 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1361 | |
1419 | |
1362 | Return the current selection text and optionally replace it by C<$newtext>. |
1420 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1421 | and optionally replace it by C<$newtext>. |
|
|
1422 | |
|
|
1423 | =item $term->selection_clear ([$clipboard]) |
|
|
1424 | |
|
|
1425 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1363 | |
1426 | |
1364 | =item $term->overlay_simple ($x, $y, $text) |
1427 | =item $term->overlay_simple ($x, $y, $text) |
1365 | |
1428 | |
1366 | Create a simple multi-line overlay box. See the next method for details. |
1429 | Create a simple multi-line overlay box. See the next method for details. |
1367 | |
1430 | |
… | |
… | |
1397 | |
1460 | |
1398 | The methods currently supported on C<urxvt::overlay> objects are: |
1461 | The methods currently supported on C<urxvt::overlay> objects are: |
1399 | |
1462 | |
1400 | =over 4 |
1463 | =over 4 |
1401 | |
1464 | |
1402 | =item $overlay->set ($x, $y, $text, $rend) |
1465 | =item $overlay->set ($x, $y, $text[, $rend]) |
1403 | |
1466 | |
1404 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1467 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1405 | text in rxvt-unicode's special encoding and an array of rendition values |
1468 | text in rxvt-unicode's special encoding and an array of rendition values |
1406 | at a specific position inside the overlay. |
1469 | at a specific position inside the overlay. |
|
|
1470 | |
|
|
1471 | If C<$rend> is missing, then the rendition will not be changed. |
1407 | |
1472 | |
1408 | =item $overlay->hide |
1473 | =item $overlay->hide |
1409 | |
1474 | |
1410 | If visible, hide the overlay, but do not destroy it. |
1475 | If visible, hide the overlay, but do not destroy it. |
1411 | |
1476 | |
… | |
… | |
1493 | locale-specific encoding of the terminal and can contain command sequences |
1558 | locale-specific encoding of the terminal and can contain command sequences |
1494 | (escape codes) that will be interpreted. |
1559 | (escape codes) that will be interpreted. |
1495 | |
1560 | |
1496 | =item $term->tt_write ($octets) |
1561 | =item $term->tt_write ($octets) |
1497 | |
1562 | |
1498 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1563 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1499 | pass characters instead of octets, you should convert your strings first |
1564 | pass characters instead of octets, you should convert your strings first |
1500 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1565 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1566 | |
|
|
1567 | =item $term->tt_paste ($octets) |
|
|
1568 | |
|
|
1569 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1570 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1571 | is set. |
1501 | |
1572 | |
1502 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1573 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1503 | |
1574 | |
1504 | Replaces the event mask of the pty watcher by the given event mask. Can |
1575 | Replaces the event mask of the pty watcher by the given event mask. Can |
1505 | be used to suppress input and output handling to the pty/tty. See the |
1576 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1621 | |
1692 | |
1622 | Used after changing terminal contents to display them. |
1693 | Used after changing terminal contents to display them. |
1623 | |
1694 | |
1624 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1695 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1625 | |
1696 | |
1626 | Returns the text of the entire row with number C<$row_number>. Row C<0> |
1697 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1627 | is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost |
1698 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1628 | terminal line. The scrollback buffer starts at line C<-1> and extends to |
|
|
1629 | line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line |
1699 | terminal line. Nothing will be returned if a nonexistent line |
1630 | is requested. |
1700 | is requested. |
1631 | |
1701 | |
1632 | If C<$new_text> is specified, it will replace characters in the current |
1702 | If C<$new_text> is specified, it will replace characters in the current |
1633 | line, starting at column C<$start_col> (default C<0>), which is useful |
1703 | line, starting at column C<$start_col> (default C<0>), which is useful |
1634 | to replace only parts of a line. The font index in the rendition will |
1704 | to replace only parts of a line. The font index in the rendition will |
1635 | automatically be updated. |
1705 | automatically be updated. |
1636 | |
1706 | |
1637 | C<$text> is in a special encoding: tabs and wide characters that use more |
1707 | C<$text> is in a special encoding: tabs and wide characters that use more |
1638 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1708 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1639 | characters. Characters with combining characters and other characters that |
1709 | characters. Characters with combining characters and other characters that |
1640 | do not fit into the normal tetx encoding will be replaced with characters |
1710 | do not fit into the normal text encoding will be replaced with characters |
1641 | in the private use area. |
1711 | in the private use area. |
1642 | |
1712 | |
1643 | You have to obey this encoding when changing text. The advantage is |
1713 | You have to obey this encoding when changing text. The advantage is |
1644 | that C<substr> and similar functions work on screen cells and not on |
1714 | that C<substr> and similar functions work on screen cells and not on |
1645 | characters. |
1715 | characters. |
… | |
… | |
1820 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1890 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1821 | recent grab. |
1891 | recent grab. |
1822 | |
1892 | |
1823 | =item $term->ungrab |
1893 | =item $term->ungrab |
1824 | |
1894 | |
1825 | Calls XUngrab for the most recent grab. Is called automatically on |
1895 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1826 | evaluation errors, as it is better to lose the grab in the error case as |
1896 | evaluation errors, as it is better to lose the grab in the error case as |
1827 | the session. |
1897 | the session. |
1828 | |
1898 | |
1829 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1899 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1830 | |
1900 | |
… | |
… | |
1832 | |
1902 | |
1833 | =item @atoms = $term->XListProperties ($window) |
1903 | =item @atoms = $term->XListProperties ($window) |
1834 | |
1904 | |
1835 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1905 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
1836 | |
1906 | |
1837 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
1907 | =item $term->XChangeProperty ($window, $property, $type, $format, $octets) |
1838 | |
1908 | |
1839 | =item $term->XDeleteProperty ($window, $property) |
1909 | =item $term->XDeleteProperty ($window, $property) |
1840 | |
1910 | |
1841 | =item $window = $term->DefaultRootWindow |
1911 | =item $window = $term->DefaultRootWindow |
1842 | |
1912 | |
… | |
… | |
1852 | |
1922 | |
1853 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1923 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1854 | |
1924 | |
1855 | Various X or X-related functions. The C<$term> object only serves as |
1925 | Various X or X-related functions. The C<$term> object only serves as |
1856 | the source of the display, otherwise those functions map more-or-less |
1926 | the source of the display, otherwise those functions map more-or-less |
1857 | directory onto the X functions of the same name. |
1927 | directly onto the X functions of the same name. |
1858 | |
1928 | |
1859 | =back |
1929 | =back |
1860 | |
1930 | |
1861 | =cut |
1931 | =cut |
1862 | |
1932 | |
… | |
… | |
1964 | my $env = $self->{term}->env; |
2034 | my $env = $self->{term}->env; |
1965 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
2035 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1966 | delete $env->{LC_ALL}; |
2036 | delete $env->{LC_ALL}; |
1967 | $env->{LC_CTYPE} = $self->{term}->locale; |
2037 | $env->{LC_CTYPE} = $self->{term}->locale; |
1968 | |
2038 | |
1969 | urxvt::term->new ($env, "popup", |
2039 | my $term = urxvt::term->new ( |
|
|
2040 | $env, "popup", |
1970 | "--perl-lib" => "", "--perl-ext-common" => "", |
2041 | "--perl-lib" => "", "--perl-ext-common" => "", |
1971 | "-pty-fd" => -1, "-sl" => 0, |
2042 | "-pty-fd" => -1, "-sl" => 0, |
1972 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
2043 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1973 | "--transient-for" => $self->{term}->parent, |
2044 | "--transient-for" => $self->{term}->parent, |
1974 | "-display" => $self->{term}->display_id, |
2045 | "-display" => $self->{term}->display_id, |
1975 | "-pe" => "urxvt-popup") |
2046 | "-pe" => "urxvt-popup", |
1976 | or die "unable to create popup window\n"; |
2047 | ) or die "unable to create popup window\n"; |
|
|
2048 | |
|
|
2049 | unless (delete $term->{urxvt_popup_init_done}) { |
|
|
2050 | $term->ungrab; |
|
|
2051 | $term->destroy; |
|
|
2052 | die "unable to initialise popup window\n"; |
|
|
2053 | } |
1977 | } |
2054 | } |
1978 | |
2055 | |
1979 | sub DESTROY { |
2056 | sub DESTROY { |
1980 | my ($self) = @_; |
2057 | my ($self) = @_; |
1981 | |
2058 | |
… | |
… | |
1999 | ->new |
2076 | ->new |
2000 | ->interval (1) |
2077 | ->interval (1) |
2001 | ->cb (sub { |
2078 | ->cb (sub { |
2002 | $term->{overlay}->set (0, 0, |
2079 | $term->{overlay}->set (0, 0, |
2003 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2080 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2004 | }); |
2081 | }); |
2005 | |
2082 | |
2006 | =over 4 |
2083 | =over 4 |
2007 | |
2084 | |
2008 | =item $timer = new urxvt::timer |
2085 | =item $timer = new urxvt::timer |
2009 | |
2086 | |
… | |
… | |
2012 | |
2089 | |
2013 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2090 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2014 | |
2091 | |
2015 | Set the callback to be called when the timer triggers. |
2092 | Set the callback to be called when the timer triggers. |
2016 | |
2093 | |
2017 | =item $tstamp = $timer->at |
|
|
2018 | |
|
|
2019 | Return the time this watcher will fire next. |
|
|
2020 | |
|
|
2021 | =item $timer = $timer->set ($tstamp) |
2094 | =item $timer = $timer->set ($tstamp[, $interval]) |
2022 | |
2095 | |
2023 | Set the time the event is generated to $tstamp. |
2096 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2097 | new $interval). |
2024 | |
2098 | |
2025 | =item $timer = $timer->interval ($interval) |
2099 | =item $timer = $timer->interval ($interval) |
2026 | |
2100 | |
2027 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2101 | By default (and when C<$interval> is C<0>), the timer will automatically |
2028 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2102 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2029 | is automatically rescheduled at the given intervals. |
2103 | is automatically rescheduled at the given intervals. |
2030 | |
2104 | |
2031 | =item $timer = $timer->start |
2105 | =item $timer = $timer->start |
2032 | |
2106 | |
2033 | Start the timer. |
2107 | Start the timer. |
2034 | |
2108 | |
2035 | =item $timer = $timer->start ($tstamp) |
2109 | =item $timer = $timer->start ($tstamp[, $interval]) |
2036 | |
2110 | |
2037 | Set the event trigger time to C<$tstamp> and start the timer. |
2111 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2112 | also replaces the interval. |
2038 | |
2113 | |
2039 | =item $timer = $timer->after ($delay) |
2114 | =item $timer = $timer->after ($delay[, $interval]) |
2040 | |
2115 | |
2041 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2116 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2042 | |
2117 | |
2043 | =item $timer = $timer->stop |
2118 | =item $timer = $timer->stop |
2044 | |
2119 | |
… | |
… | |
2052 | |
2127 | |
2053 | $term->{socket} = ... |
2128 | $term->{socket} = ... |
2054 | $term->{iow} = urxvt::iow |
2129 | $term->{iow} = urxvt::iow |
2055 | ->new |
2130 | ->new |
2056 | ->fd (fileno $term->{socket}) |
2131 | ->fd (fileno $term->{socket}) |
2057 | ->events (urxvt::EVENT_READ) |
2132 | ->events (urxvt::EV_READ) |
2058 | ->start |
2133 | ->start |
2059 | ->cb (sub { |
2134 | ->cb (sub { |
2060 | my ($iow, $revents) = @_; |
2135 | my ($iow, $revents) = @_; |
2061 | # $revents must be 1 here, no need to check |
2136 | # $revents must be 1 here, no need to check |
2062 | sysread $term->{socket}, my $buf, 8192 |
2137 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
2080 | Set the file descriptor (not handle) to watch. |
2155 | Set the file descriptor (not handle) to watch. |
2081 | |
2156 | |
2082 | =item $iow = $iow->events ($eventmask) |
2157 | =item $iow = $iow->events ($eventmask) |
2083 | |
2158 | |
2084 | Set the event mask to watch. The only allowed values are |
2159 | Set the event mask to watch. The only allowed values are |
2085 | C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed |
2160 | C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed |
2086 | together, or C<urxvt::EVENT_NONE>. |
2161 | together, or C<urxvt::EV_NONE>. |
2087 | |
2162 | |
2088 | =item $iow = $iow->start |
2163 | =item $iow = $iow->start |
2089 | |
2164 | |
2090 | Start watching for requested events on the given handle. |
2165 | Start watching for requested events on the given handle. |
2091 | |
2166 | |
… | |
… | |
2132 | ->new |
2207 | ->new |
2133 | ->start ($pid) |
2208 | ->start ($pid) |
2134 | ->cb (sub { |
2209 | ->cb (sub { |
2135 | my ($pw, $exit_status) = @_; |
2210 | my ($pw, $exit_status) = @_; |
2136 | ... |
2211 | ... |
2137 | }); |
2212 | }); |
2138 | |
2213 | |
2139 | =over 4 |
2214 | =over 4 |
2140 | |
2215 | |
2141 | =item $pw = new urxvt::pw |
2216 | =item $pw = new urxvt::pw |
2142 | |
2217 | |