… | |
… | |
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: |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
136 | additionally stores the first match in the current line into the primary |
130 | selection. |
137 | selection. |
131 | |
138 | |
|
|
139 | =item readline (enabled by default) |
|
|
140 | |
|
|
141 | A support package that tries to make editing with readline easier. At the |
|
|
142 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
143 | move the text cursor to this position. It does so by generating as many |
|
|
144 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
145 | for programs that correctly support wide characters). |
|
|
146 | |
|
|
147 | To avoid too many false positives, this is only done when: |
|
|
148 | |
|
|
149 | =over 4 |
|
|
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 | |
|
|
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
158 | |
|
|
159 | =back |
|
|
160 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
162 | might interfere with selection creation in harmless ways. |
|
|
163 | |
132 | =item selection-autotransform |
164 | =item selection-autotransform |
133 | |
165 | |
134 | This selection allows you to do automatic transforms on a selection |
166 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
167 | whenever a selection is made. |
136 | |
168 | |
… | |
… | |
180 | 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 |
181 | make them clickable. When middle-clicked, the program specified in the |
213 | make them clickable. When middle-clicked, the program specified in the |
182 | 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 |
183 | the URL as first argument. |
215 | the URL as first argument. |
184 | |
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 | |
185 | =item automove-background |
229 | =item automove-background |
186 | |
230 | |
187 | 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 |
188 | 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 |
189 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
233 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
198 | |
242 | |
199 | =item digital-clock |
243 | =item digital-clock |
200 | |
244 | |
201 | Displays a digital clock using the built-in overlay. |
245 | Displays a digital clock using the built-in overlay. |
202 | |
246 | |
203 | =item example-refresh-hooks |
247 | =item remote-clipboard |
204 | |
248 | |
205 | 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 |
206 | window. Illustrates overwriting the refresh callbacks to create your own |
250 | selection popup that allows one ti run external commands to store the |
207 | 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' |
208 | |
266 | |
209 | =item selection-pastebin |
267 | =item selection-pastebin |
210 | |
268 | |
211 | 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 |
212 | 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 |
… | |
… | |
232 | 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 |
233 | 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 |
234 | for the filename): |
292 | for the filename): |
235 | |
293 | |
236 | 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. |
237 | |
301 | |
238 | =back |
302 | =back |
239 | |
303 | |
240 | =head1 API DOCUMENTATION |
304 | =head1 API DOCUMENTATION |
241 | |
305 | |
… | |
… | |
338 | 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 |
339 | trying to map (display) the toplevel and returning to the mainloop. |
403 | trying to map (display) the toplevel and returning to the mainloop. |
340 | |
404 | |
341 | =item on_destroy $term |
405 | =item on_destroy $term |
342 | |
406 | |
343 | Called whenever something tries to destroy terminal, before doing anything |
407 | Called whenever something tries to destroy terminal, when the terminal is |
344 | yet. If this hook returns true, then destruction is skipped, but this is |
408 | still fully functional (not for long, though). |
345 | rarely a good idea. |
|
|
346 | |
409 | |
347 | =item on_reset $term |
410 | =item on_reset $term |
348 | |
411 | |
349 | 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 |
350 | 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 |
… | |
… | |
452 | |
515 | |
453 | =item on_refresh_end $term |
516 | =item on_refresh_end $term |
454 | |
517 | |
455 | 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>. |
456 | |
519 | |
457 | =item on_keyboard_command $term, $string |
520 | =item on_user_command $term, $string |
458 | |
521 | |
459 | 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 |
460 | 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> |
461 | 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. |
462 | |
528 | |
463 | =item on_x_event $term, $event |
529 | =item on_x_event $term, $event |
464 | |
530 | |
465 | 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 |
466 | 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 |
… | |
… | |
496 | |
562 | |
497 | Called whenever the corresponding X event is received for the terminal If |
563 | Called whenever the corresponding X event is received for the terminal If |
498 | the hook returns true, then the even will be ignored by rxvt-unicode. |
564 | the hook returns true, then the even will be ignored by rxvt-unicode. |
499 | |
565 | |
500 | The event is a hash with most values as named by Xlib (see the XEvent |
566 | The event is a hash with most values as named by Xlib (see the XEvent |
501 | manpage), with the additional members C<row> and C<col>, which are the row |
567 | manpage), with the additional members C<row> and C<col>, which are the |
502 | and column under the mouse cursor. |
568 | (real, not screen-based) row and column under the mouse cursor. |
503 | |
569 | |
504 | C<on_key_press> additionally receives the string rxvt-unicode would |
570 | C<on_key_press> additionally receives the string rxvt-unicode would |
505 | output, if any, in locale-specific encoding. |
571 | output, if any, in locale-specific encoding. |
506 | |
572 | |
507 | subwindow. |
573 | subwindow. |
… | |
… | |
537 | |
603 | |
538 | our $LIBDIR; |
604 | our $LIBDIR; |
539 | our $RESNAME; |
605 | our $RESNAME; |
540 | our $RESCLASS; |
606 | our $RESCLASS; |
541 | our $RXVTNAME; |
607 | our $RXVTNAME; |
|
|
608 | |
|
|
609 | our $NOCHAR = chr 0xffff; |
542 | |
610 | |
543 | =head2 Variables in the C<urxvt> Package |
611 | =head2 Variables in the C<urxvt> Package |
544 | |
612 | |
545 | =over 4 |
613 | =over 4 |
546 | |
614 | |
… | |
… | |
693 | unless $msg =~ /\n$/; |
761 | unless $msg =~ /\n$/; |
694 | urxvt::warn ($msg); |
762 | urxvt::warn ($msg); |
695 | }; |
763 | }; |
696 | } |
764 | } |
697 | |
765 | |
|
|
766 | no warnings 'utf8'; |
|
|
767 | |
698 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
768 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
699 | |
769 | |
700 | sub verbose { |
770 | sub verbose { |
701 | my ($level, $msg) = @_; |
771 | my ($level, $msg) = @_; |
702 | warn "$msg\n" if $level <= $verbosity; |
772 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
718 | |
788 | |
719 | open my $fh, "<:raw", $path |
789 | open my $fh, "<:raw", $path |
720 | or die "$path: $!"; |
790 | or die "$path: $!"; |
721 | |
791 | |
722 | my $source = |
792 | my $source = |
723 | "package $pkg; use strict; use utf8;\n" |
793 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
724 | . "#line 1 \"$path\"\n{\n" |
794 | . "#line 1 \"$path\"\n{\n" |
725 | . (do { local $/; <$fh> }) |
795 | . (do { local $/; <$fh> }) |
726 | . "\n};\n1"; |
796 | . "\n};\n1"; |
727 | |
797 | |
728 | eval $source |
798 | eval $source |
… | |
… | |
753 | $TERM->register_package ($_) for @pkg; |
823 | $TERM->register_package ($_) for @pkg; |
754 | } |
824 | } |
755 | |
825 | |
756 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
826 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
757 | if ($_ eq "default") { |
827 | if ($_ eq "default") { |
758 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
828 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
759 | } elsif (/^-(.*)$/) { |
829 | } elsif (/^-(.*)$/) { |
760 | delete $ext_arg{$1}; |
830 | delete $ext_arg{$1}; |
761 | } elsif (/^([^<]+)<(.*)>$/) { |
831 | } elsif (/^([^<]+)<(.*)>$/) { |
762 | push @{ $ext_arg{$1} }, $2; |
832 | push @{ $ext_arg{$1} }, $2; |
763 | } else { |
833 | } else { |
… | |
… | |
1260 | |
1330 | |
1261 | Normally its not a good idea to use this function, as programs might be |
1331 | Normally its not a good idea to use this function, as programs might be |
1262 | confused by changes in cursor position or scrolling. Its useful inside a |
1332 | confused by changes in cursor position or scrolling. Its useful inside a |
1263 | C<on_add_lines> hook, though. |
1333 | C<on_add_lines> hook, though. |
1264 | |
1334 | |
|
|
1335 | =item $term->scr_change_screen ($screen) |
|
|
1336 | |
|
|
1337 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1338 | |
1265 | =item $term->cmd_parse ($octets) |
1339 | =item $term->cmd_parse ($octets) |
1266 | |
1340 | |
1267 | Similar to C<scr_add_lines>, but the argument must be in the |
1341 | Similar to C<scr_add_lines>, but the argument must be in the |
1268 | locale-specific encoding of the terminal and can contain command sequences |
1342 | locale-specific encoding of the terminal and can contain command sequences |
1269 | (escape codes) that will be interpreted. |
1343 | (escape codes) that will be interpreted. |
… | |
… | |
1278 | |
1352 | |
1279 | Replaces the event mask of the pty watcher by the given event mask. Can |
1353 | Replaces the event mask of the pty watcher by the given event mask. Can |
1280 | be used to suppress input and output handling to the pty/tty. See the |
1354 | be used to suppress input and output handling to the pty/tty. See the |
1281 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1355 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1282 | the previous value. |
1356 | the previous value. |
|
|
1357 | |
|
|
1358 | =item $fd = $term->pty_fd |
|
|
1359 | |
|
|
1360 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1361 | is used. |
1283 | |
1362 | |
1284 | =item $windowid = $term->parent |
1363 | =item $windowid = $term->parent |
1285 | |
1364 | |
1286 | Return the window id of the toplevel window. |
1365 | Return the window id of the toplevel window. |
1287 | |
1366 | |
… | |
… | |
1352 | =item $modifiermask = $term->ModNumLockMask |
1431 | =item $modifiermask = $term->ModNumLockMask |
1353 | |
1432 | |
1354 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1433 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1355 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1434 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1356 | |
1435 | |
|
|
1436 | =item $screen = $term->current_screen |
|
|
1437 | |
|
|
1438 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1439 | |
|
|
1440 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1441 | |
|
|
1442 | Returns wether the cursor is currently hidden or not. |
|
|
1443 | |
1357 | =item $view_start = $term->view_start ([$newvalue]) |
1444 | =item $view_start = $term->view_start ([$newvalue]) |
1358 | |
1445 | |
1359 | Returns the row number of the topmost displayed line. Maximum value is |
1446 | Returns the row number of the topmost displayed line. Maximum value is |
1360 | C<0>, which displays the normal terminal contents. Lower values scroll |
1447 | C<0>, which displays the normal terminal contents. Lower values scroll |
1361 | this many lines into the scrollback buffer. |
1448 | this many lines into the scrollback buffer. |
… | |
… | |
1380 | line, starting at column C<$start_col> (default C<0>), which is useful |
1467 | line, starting at column C<$start_col> (default C<0>), which is useful |
1381 | to replace only parts of a line. The font index in the rendition will |
1468 | to replace only parts of a line. The font index in the rendition will |
1382 | automatically be updated. |
1469 | automatically be updated. |
1383 | |
1470 | |
1384 | C<$text> is in a special encoding: tabs and wide characters that use more |
1471 | C<$text> is in a special encoding: tabs and wide characters that use more |
1385 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1472 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1386 | (C<chr 65535>). Characters with combining characters and other characters |
1473 | characters. Characters with combining characters and other characters that |
1387 | that do not fit into the normal tetx encoding will be replaced with |
1474 | do not fit into the normal tetx encoding will be replaced with characters |
1388 | characters in the private use area. |
1475 | in the private use area. |
1389 | |
1476 | |
1390 | You have to obey this encoding when changing text. The advantage is |
1477 | You have to obey this encoding when changing text. The advantage is |
1391 | that C<substr> and similar functions work on screen cells and not on |
1478 | that C<substr> and similar functions work on screen cells and not on |
1392 | characters. |
1479 | characters. |
1393 | |
1480 | |
… | |
… | |
1567 | =item $term->ungrab |
1654 | =item $term->ungrab |
1568 | |
1655 | |
1569 | Calls XUngrab for the most recent grab. Is called automatically on |
1656 | Calls XUngrab for the most recent grab. Is called automatically on |
1570 | evaluation errors, as it is better to lose the grab in the error case as |
1657 | evaluation errors, as it is better to lose the grab in the error case as |
1571 | the session. |
1658 | the session. |
|
|
1659 | |
|
|
1660 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1661 | |
|
|
1662 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1663 | |
|
|
1664 | =item @atoms = $term->XListProperties ($window) |
|
|
1665 | |
|
|
1666 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1667 | |
|
|
1668 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1669 | |
|
|
1670 | =item $term->XDeleteProperty ($window, $property) |
|
|
1671 | |
|
|
1672 | =item $window = $term->DefaultRootWindow |
|
|
1673 | |
|
|
1674 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1675 | |
|
|
1676 | =item $term->XMapWindow ($window) |
|
|
1677 | |
|
|
1678 | =item $term->XUnmapWindow ($window) |
|
|
1679 | |
|
|
1680 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1681 | |
|
|
1682 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1683 | |
|
|
1684 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1685 | |
|
|
1686 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1687 | the source of the display, otherwise those functions map more-or-less |
|
|
1688 | directory onto the X functions of the same name. |
1572 | |
1689 | |
1573 | =back |
1690 | =back |
1574 | |
1691 | |
1575 | =cut |
1692 | =cut |
1576 | |
1693 | |