… | |
… | |
66 | contain at least one pair of capturing parentheses, which will be used for |
66 | contain at least one pair of capturing parentheses, which will be used for |
67 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
71 | |
78 | |
72 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
73 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
74 | |
81 | |
75 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
… | |
… | |
139 | |
146 | |
140 | To avoid too many false positives, this is only done when: |
147 | To avoid too many false positives, this is only done when: |
141 | |
148 | |
142 | =over 4 |
149 | =over 4 |
143 | |
150 | |
|
|
151 | =item - the tty is in ICANON state. |
|
|
152 | |
|
|
153 | =item - the text cursor is visible. |
|
|
154 | |
|
|
155 | =item - the primary screen is currently being displayed. |
|
|
156 | |
144 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
145 | |
|
|
146 | =item - the primary screen is currently being displayed. |
|
|
147 | |
|
|
148 | =item - the text cursor is visible. |
|
|
149 | |
158 | |
150 | =back |
159 | =back |
151 | |
160 | |
152 | The normal selection mechanism isn't disabled, so quick successive clicks |
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
153 | might interfere with selection creation in harmless ways. |
162 | might interfere with selection creation in harmless ways. |
… | |
… | |
203 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
204 | make them clickable. When middle-clicked, the program specified in the |
213 | make them clickable. When middle-clicked, the program specified in the |
205 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
206 | the URL as first argument. |
215 | the URL as first argument. |
207 | |
216 | |
|
|
217 | =item xim-onthespot |
|
|
218 | |
|
|
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
220 | not work perfectly, and some input methods don't seem to work well with |
|
|
221 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
222 | kinput2. |
|
|
223 | |
|
|
224 | You enable it by specifying this extension and a preedit style of |
|
|
225 | C<OnTheSpot>, i.e.: |
|
|
226 | |
|
|
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
228 | |
208 | =item automove-background |
229 | =item automove-background |
209 | |
230 | |
210 | This is basically a one-line extension that dynamically changes the background pixmap offset |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
211 | to the window position, in effect creating the same effect as pseudo transparency with |
232 | to the window position, in effect creating the same effect as pseudo transparency with |
212 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
221 | |
242 | |
222 | =item digital-clock |
243 | =item digital-clock |
223 | |
244 | |
224 | Displays a digital clock using the built-in overlay. |
245 | Displays a digital clock using the built-in overlay. |
225 | |
246 | |
226 | =item example-refresh-hooks |
247 | =item remote-clipboard |
227 | |
248 | |
228 | Displays a very simple digital clock in the upper right corner of the |
249 | Somewhat of a misnomer, this extension adds two menu entries to the |
229 | window. Illustrates overwriting the refresh callbacks to create your own |
250 | selection popup that allows one ti run external commands to store the |
230 | overlays or changes. |
251 | selection somewhere and fetch it again. |
|
|
252 | |
|
|
253 | We use it to implement a "distributed selection mechanism", which just |
|
|
254 | means that one command uploads the file to a remote server, and another |
|
|
255 | reads it. |
|
|
256 | |
|
|
257 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
258 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
259 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
260 | the selection data on STDOUT (also in UTF-8). |
|
|
261 | |
|
|
262 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
263 | |
|
|
264 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
265 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
231 | |
266 | |
232 | =item selection-pastebin |
267 | =item selection-pastebin |
233 | |
268 | |
234 | This is a little rarely useful extension that Uploads the selection as |
269 | This is a little rarely useful extension that Uploads the selection as |
235 | textfile to a remote site (or does other things). (The implementation is |
270 | textfile to a remote site (or does other things). (The implementation is |
… | |
… | |
255 | After a successful upload the selection will be replaced by the text given |
290 | After a successful upload the selection will be replaced by the text given |
256 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
291 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
257 | for the filename): |
292 | for the filename): |
258 | |
293 | |
259 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
294 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
295 | |
|
|
296 | =item example-refresh-hooks |
|
|
297 | |
|
|
298 | Displays a very simple digital clock in the upper right corner of the |
|
|
299 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
300 | overlays or changes. |
260 | |
301 | |
261 | =back |
302 | =back |
262 | |
303 | |
263 | =head1 API DOCUMENTATION |
304 | =head1 API DOCUMENTATION |
264 | |
305 | |
… | |
… | |
361 | Called at the very end of initialisation of a new terminal, just before |
402 | Called at the very end of initialisation of a new terminal, just before |
362 | trying to map (display) the toplevel and returning to the mainloop. |
403 | trying to map (display) the toplevel and returning to the mainloop. |
363 | |
404 | |
364 | =item on_destroy $term |
405 | =item on_destroy $term |
365 | |
406 | |
366 | Called whenever something tries to destroy terminal, before doing anything |
407 | Called whenever something tries to destroy terminal, when the terminal is |
367 | yet. If this hook returns true, then destruction is skipped, but this is |
408 | still fully functional (not for long, though). |
368 | rarely a good idea. |
|
|
369 | |
409 | |
370 | =item on_reset $term |
410 | =item on_reset $term |
371 | |
411 | |
372 | Called after the screen is "reset" for any reason, such as resizing or |
412 | Called after the screen is "reset" for any reason, such as resizing or |
373 | control sequences. Here is where you can react on changes to size-related |
413 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
475 | |
515 | |
476 | =item on_refresh_end $term |
516 | =item on_refresh_end $term |
477 | |
517 | |
478 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
518 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
479 | |
519 | |
480 | =item on_keyboard_command $term, $string |
520 | =item on_user_command $term, $string |
481 | |
521 | |
482 | Called whenever the user presses a key combination that has a |
522 | Called whenever the a user-configured event is being activated (e.g. via |
483 | C<perl:string> action bound to it (see description of the B<keysym> |
523 | a C<perl:string> action bound to a key, see description of the B<keysym> |
484 | resource in the @@RXVT_NAME@@(1) manpage). |
524 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
525 | |
|
|
526 | The event is simply the action string. This interface is assumed to change |
|
|
527 | slightly in the future. |
485 | |
528 | |
486 | =item on_x_event $term, $event |
529 | =item on_x_event $term, $event |
487 | |
530 | |
488 | Called on every X event received on the vt window (and possibly other |
531 | Called on every X event received on the vt window (and possibly other |
489 | windows). Should only be used as a last resort. Most event structure |
532 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
561 | our $LIBDIR; |
604 | our $LIBDIR; |
562 | our $RESNAME; |
605 | our $RESNAME; |
563 | our $RESCLASS; |
606 | our $RESCLASS; |
564 | our $RXVTNAME; |
607 | our $RXVTNAME; |
565 | |
608 | |
566 | our $NOCHAR = chr 0xfffe; |
609 | our $NOCHAR = chr 0xffff; |
567 | |
610 | |
568 | =head2 Variables in the C<urxvt> Package |
611 | =head2 Variables in the C<urxvt> Package |
569 | |
612 | |
570 | =over 4 |
613 | =over 4 |
571 | |
614 | |
… | |
… | |
623 | |
666 | |
624 | Using this function has the advantage that its output ends up in the |
667 | Using this function has the advantage that its output ends up in the |
625 | correct place, e.g. on stderr of the connecting urxvtc client. |
668 | correct place, e.g. on stderr of the connecting urxvtc client. |
626 | |
669 | |
627 | Messages have a size limit of 1023 bytes currently. |
670 | Messages have a size limit of 1023 bytes currently. |
|
|
671 | |
|
|
672 | =item @terms = urxvt::termlist |
|
|
673 | |
|
|
674 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
675 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
676 | objects that have perl extensions attached will be returned (because there |
|
|
677 | is no urxvt::term objet associated with others). |
628 | |
678 | |
629 | =item $time = urxvt::NOW |
679 | =item $time = urxvt::NOW |
630 | |
680 | |
631 | Returns the "current time" (as per the event loop). |
681 | Returns the "current time" (as per the event loop). |
632 | |
682 | |
… | |
… | |
718 | unless $msg =~ /\n$/; |
768 | unless $msg =~ /\n$/; |
719 | urxvt::warn ($msg); |
769 | urxvt::warn ($msg); |
720 | }; |
770 | }; |
721 | } |
771 | } |
722 | |
772 | |
|
|
773 | no warnings 'utf8'; |
|
|
774 | |
723 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
775 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
724 | |
776 | |
725 | sub verbose { |
777 | sub verbose { |
726 | my ($level, $msg) = @_; |
778 | my ($level, $msg) = @_; |
727 | warn "$msg\n" if $level <= $verbosity; |
779 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
743 | |
795 | |
744 | open my $fh, "<:raw", $path |
796 | open my $fh, "<:raw", $path |
745 | or die "$path: $!"; |
797 | or die "$path: $!"; |
746 | |
798 | |
747 | my $source = |
799 | my $source = |
748 | "package $pkg; use strict; use utf8;\n" |
800 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
749 | . "#line 1 \"$path\"\n{\n" |
801 | . "#line 1 \"$path\"\n{\n" |
750 | . (do { local $/; <$fh> }) |
802 | . (do { local $/; <$fh> }) |
751 | . "\n};\n1"; |
803 | . "\n};\n1"; |
752 | |
804 | |
753 | eval $source |
805 | eval $source |
… | |
… | |
1011 | hash which defines the environment of the new terminal. |
1063 | hash which defines the environment of the new terminal. |
1012 | |
1064 | |
1013 | Croaks (and probably outputs an error message) if the new instance |
1065 | Croaks (and probably outputs an error message) if the new instance |
1014 | couldn't be created. Returns C<undef> if the new instance didn't |
1066 | couldn't be created. Returns C<undef> if the new instance didn't |
1015 | initialise perl, and the terminal object otherwise. The C<init> and |
1067 | initialise perl, and the terminal object otherwise. The C<init> and |
1016 | C<start> hooks will be called during this call. |
1068 | C<start> hooks will be called before this call returns, and are free to |
|
|
1069 | refer to global data (which is race free). |
1017 | |
1070 | |
1018 | =cut |
1071 | =cut |
1019 | |
1072 | |
1020 | sub new { |
1073 | sub new { |
1021 | my ($class, $env, @args) = @_; |
1074 | my ($class, $env, @args) = @_; |
1022 | |
1075 | |
|
|
1076 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1077 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1078 | |
1023 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1079 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1024 | } |
1080 | } |
1025 | |
1081 | |
1026 | =item $term->destroy |
1082 | =item $term->destroy |
1027 | |
1083 | |
1028 | Destroy the terminal object (close the window, free resources |
1084 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1308 | Replaces the event mask of the pty watcher by the given event mask. Can |
1364 | Replaces the event mask of the pty watcher by the given event mask. Can |
1309 | be used to suppress input and output handling to the pty/tty. See the |
1365 | be used to suppress input and output handling to the pty/tty. See the |
1310 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1366 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1311 | the previous value. |
1367 | the previous value. |
1312 | |
1368 | |
|
|
1369 | =item $fd = $term->pty_fd |
|
|
1370 | |
|
|
1371 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1372 | is used. |
|
|
1373 | |
1313 | =item $windowid = $term->parent |
1374 | =item $windowid = $term->parent |
1314 | |
1375 | |
1315 | Return the window id of the toplevel window. |
1376 | Return the window id of the toplevel window. |
1316 | |
1377 | |
1317 | =item $windowid = $term->vt |
1378 | =item $windowid = $term->vt |
… | |
… | |
1416 | If C<$new_text> is specified, it will replace characters in the current |
1477 | If C<$new_text> is specified, it will replace characters in the current |
1417 | line, starting at column C<$start_col> (default C<0>), which is useful |
1478 | line, starting at column C<$start_col> (default C<0>), which is useful |
1418 | to replace only parts of a line. The font index in the rendition will |
1479 | to replace only parts of a line. The font index in the rendition will |
1419 | automatically be updated. |
1480 | automatically be updated. |
1420 | |
1481 | |
1421 | C<$text> is in a special encoding: tabs and wide characters that use |
1482 | C<$text> is in a special encoding: tabs and wide characters that use more |
1422 | more than one cell when displayed are padded with C<$urxvt::NOCHAR> |
1483 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1423 | characters. Characters with combining characters and other characters that |
1484 | characters. Characters with combining characters and other characters that |
1424 | do not fit into the normal tetx encoding will be replaced with characters |
1485 | do not fit into the normal tetx encoding will be replaced with characters |
1425 | in the private use area. |
1486 | in the private use area. |
1426 | |
1487 | |
1427 | You have to obey this encoding when changing text. The advantage is |
1488 | You have to obey this encoding when changing text. The advantage is |
… | |
… | |
1577 | =item $string = $term->special_decode $text |
1638 | =item $string = $term->special_decode $text |
1578 | |
1639 | |
1579 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1640 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1580 | C<< $term->ROW_t >> for details. |
1641 | C<< $term->ROW_t >> for details. |
1581 | |
1642 | |
1582 | =item $success = $term->grab_button ($button, $modifiermask) |
1643 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1583 | |
1644 | |
|
|
1645 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1646 | |
1584 | Registers a synchronous button grab. See the XGrabButton manpage. |
1647 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1648 | manpage. |
1585 | |
1649 | |
1586 | =item $success = $term->grab ($eventtime[, $sync]) |
1650 | =item $success = $term->grab ($eventtime[, $sync]) |
1587 | |
1651 | |
1588 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1652 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1589 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1653 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |