… | |
… | |
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. |
… | |
… | |
196 | |
205 | |
197 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
198 | B<Shift-Right> will switch to the tab left or right of the current one, |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
199 | while B<Shift-Down> creates a new tab. |
208 | while B<Shift-Down> creates a new tab. |
200 | |
209 | |
|
|
210 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
211 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
212 | following four resources (shown with defaults): |
|
|
213 | |
|
|
214 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
215 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
216 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
217 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
218 | |
|
|
219 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
220 | indices. |
|
|
221 | |
201 | =item mark-urls |
222 | =item mark-urls |
202 | |
223 | |
203 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
224 | 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 |
225 | make them clickable. When middle-clicked, the program specified in the |
205 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
226 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
206 | the URL as first argument. |
227 | the URL as first argument. |
207 | |
228 | |
|
|
229 | =item xim-onthespot |
|
|
230 | |
|
|
231 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
232 | not work perfectly, and some input methods don't seem to work well with |
|
|
233 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
234 | kinput2. |
|
|
235 | |
|
|
236 | You enable it by specifying this extension and a preedit style of |
|
|
237 | C<OnTheSpot>, i.e.: |
|
|
238 | |
|
|
239 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
240 | |
208 | =item automove-background |
241 | =item automove-background |
209 | |
242 | |
210 | This is basically a one-line extension that dynamically changes the background pixmap offset |
243 | 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 |
244 | 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: |
245 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
… | |
… | |
221 | |
254 | |
222 | =item digital-clock |
255 | =item digital-clock |
223 | |
256 | |
224 | Displays a digital clock using the built-in overlay. |
257 | Displays a digital clock using the built-in overlay. |
225 | |
258 | |
226 | =item example-refresh-hooks |
259 | =item remote-clipboard |
227 | |
260 | |
228 | Displays a very simple digital clock in the upper right corner of the |
261 | Somewhat of a misnomer, this extension adds two menu entries to the |
229 | window. Illustrates overwriting the refresh callbacks to create your own |
262 | selection popup that allows one ti run external commands to store the |
230 | overlays or changes. |
263 | selection somewhere and fetch it again. |
|
|
264 | |
|
|
265 | We use it to implement a "distributed selection mechanism", which just |
|
|
266 | means that one command uploads the file to a remote server, and another |
|
|
267 | reads it. |
|
|
268 | |
|
|
269 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
270 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
271 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
272 | the selection data on STDOUT (also in UTF-8). |
|
|
273 | |
|
|
274 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
275 | |
|
|
276 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
277 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
231 | |
278 | |
232 | =item selection-pastebin |
279 | =item selection-pastebin |
233 | |
280 | |
234 | This is a little rarely useful extension that Uploads the selection as |
281 | 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 |
282 | 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 |
302 | 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 |
303 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
257 | for the filename): |
304 | for the filename): |
258 | |
305 | |
259 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
306 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
307 | |
|
|
308 | =item example-refresh-hooks |
|
|
309 | |
|
|
310 | Displays a very simple digital clock in the upper right corner of the |
|
|
311 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
312 | overlays or changes. |
260 | |
313 | |
261 | =back |
314 | =back |
262 | |
315 | |
263 | =head1 API DOCUMENTATION |
316 | =head1 API DOCUMENTATION |
264 | |
317 | |
… | |
… | |
361 | Called at the very end of initialisation of a new terminal, just before |
414 | 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. |
415 | trying to map (display) the toplevel and returning to the mainloop. |
363 | |
416 | |
364 | =item on_destroy $term |
417 | =item on_destroy $term |
365 | |
418 | |
366 | Called whenever something tries to destroy terminal, before doing anything |
419 | 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 |
420 | still fully functional (not for long, though). |
368 | rarely a good idea. |
|
|
369 | |
421 | |
370 | =item on_reset $term |
422 | =item on_reset $term |
371 | |
423 | |
372 | Called after the screen is "reset" for any reason, such as resizing or |
424 | 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 |
425 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
475 | |
527 | |
476 | =item on_refresh_end $term |
528 | =item on_refresh_end $term |
477 | |
529 | |
478 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
530 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
479 | |
531 | |
480 | =item on_keyboard_command $term, $string |
532 | =item on_user_command $term, $string |
481 | |
533 | |
482 | Called whenever the user presses a key combination that has a |
534 | 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> |
535 | a C<perl:string> action bound to a key, see description of the B<keysym> |
484 | resource in the @@RXVT_NAME@@(1) manpage). |
536 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
537 | |
|
|
538 | The event is simply the action string. This interface is assumed to change |
|
|
539 | slightly in the future. |
485 | |
540 | |
486 | =item on_x_event $term, $event |
541 | =item on_x_event $term, $event |
487 | |
542 | |
488 | Called on every X event received on the vt window (and possibly other |
543 | 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 |
544 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
624 | Using this function has the advantage that its output ends up in the |
679 | 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. |
680 | correct place, e.g. on stderr of the connecting urxvtc client. |
626 | |
681 | |
627 | Messages have a size limit of 1023 bytes currently. |
682 | Messages have a size limit of 1023 bytes currently. |
628 | |
683 | |
|
|
684 | =item @terms = urxvt::termlist |
|
|
685 | |
|
|
686 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
687 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
688 | objects that have perl extensions attached will be returned (because there |
|
|
689 | is no urxvt::term objet associated with others). |
|
|
690 | |
629 | =item $time = urxvt::NOW |
691 | =item $time = urxvt::NOW |
630 | |
692 | |
631 | Returns the "current time" (as per the event loop). |
693 | Returns the "current time" (as per the event loop). |
632 | |
694 | |
633 | =item urxvt::CurrentTime |
695 | =item urxvt::CurrentTime |
… | |
… | |
690 | Return the foreground/background colour index, respectively. |
752 | Return the foreground/background colour index, respectively. |
691 | |
753 | |
692 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
754 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
693 | |
755 | |
694 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
756 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
757 | |
|
|
758 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
695 | |
759 | |
696 | Replace the foreground/background colour in the rendition mask with the |
760 | Replace the foreground/background colour in the rendition mask with the |
697 | specified one. |
761 | specified one. |
698 | |
762 | |
699 | =item $value = urxvt::GET_CUSTOM $rend |
763 | =item $value = urxvt::GET_CUSTOM $rend |
… | |
… | |
837 | } |
901 | } |
838 | |
902 | |
839 | $retval |
903 | $retval |
840 | } |
904 | } |
841 | |
905 | |
|
|
906 | sub SET_COLOR($$$) { |
|
|
907 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
|
|
908 | } |
|
|
909 | |
842 | # urxvt::term::extension |
910 | # urxvt::term::extension |
843 | |
911 | |
844 | package urxvt::term::extension; |
912 | package urxvt::term::extension; |
845 | |
913 | |
846 | sub enable { |
914 | sub enable { |
… | |
… | |
1013 | hash which defines the environment of the new terminal. |
1081 | hash which defines the environment of the new terminal. |
1014 | |
1082 | |
1015 | Croaks (and probably outputs an error message) if the new instance |
1083 | Croaks (and probably outputs an error message) if the new instance |
1016 | couldn't be created. Returns C<undef> if the new instance didn't |
1084 | couldn't be created. Returns C<undef> if the new instance didn't |
1017 | initialise perl, and the terminal object otherwise. The C<init> and |
1085 | initialise perl, and the terminal object otherwise. The C<init> and |
1018 | C<start> hooks will be called during this call. |
1086 | C<start> hooks will be called before this call returns, and are free to |
|
|
1087 | refer to global data (which is race free). |
1019 | |
1088 | |
1020 | =cut |
1089 | =cut |
1021 | |
1090 | |
1022 | sub new { |
1091 | sub new { |
1023 | my ($class, $env, @args) = @_; |
1092 | my ($class, $env, @args) = @_; |
1024 | |
1093 | |
|
|
1094 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1095 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1096 | |
1025 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1097 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
1026 | } |
1098 | } |
1027 | |
1099 | |
1028 | =item $term->destroy |
1100 | =item $term->destroy |
1029 | |
1101 | |
1030 | Destroy the terminal object (close the window, free resources |
1102 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1310 | Replaces the event mask of the pty watcher by the given event mask. Can |
1382 | Replaces the event mask of the pty watcher by the given event mask. Can |
1311 | be used to suppress input and output handling to the pty/tty. See the |
1383 | be used to suppress input and output handling to the pty/tty. See the |
1312 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1384 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1313 | the previous value. |
1385 | the previous value. |
1314 | |
1386 | |
|
|
1387 | =item $fd = $term->pty_fd |
|
|
1388 | |
|
|
1389 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1390 | is used. |
|
|
1391 | |
1315 | =item $windowid = $term->parent |
1392 | =item $windowid = $term->parent |
1316 | |
1393 | |
1317 | Return the window id of the toplevel window. |
1394 | Return the window id of the toplevel window. |
1318 | |
1395 | |
1319 | =item $windowid = $term->vt |
1396 | =item $windowid = $term->vt |
… | |
… | |
1324 | |
1401 | |
1325 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1402 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1326 | to receive pointer events all the times: |
1403 | to receive pointer events all the times: |
1327 | |
1404 | |
1328 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1405 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1406 | |
|
|
1407 | =item $term->focus_in |
|
|
1408 | |
|
|
1409 | =item $term->focus_out |
|
|
1410 | |
|
|
1411 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1412 | |
|
|
1413 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1414 | |
|
|
1415 | Deliver various fake events to to terminal. |
1329 | |
1416 | |
1330 | =item $window_width = $term->width |
1417 | =item $window_width = $term->width |
1331 | |
1418 | |
1332 | =item $window_height = $term->height |
1419 | =item $window_height = $term->height |
1333 | |
1420 | |
… | |
… | |
1579 | =item $string = $term->special_decode $text |
1666 | =item $string = $term->special_decode $text |
1580 | |
1667 | |
1581 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1668 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1582 | C<< $term->ROW_t >> for details. |
1669 | C<< $term->ROW_t >> for details. |
1583 | |
1670 | |
1584 | =item $success = $term->grab_button ($button, $modifiermask) |
1671 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1585 | |
1672 | |
|
|
1673 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1674 | |
1586 | Registers a synchronous button grab. See the XGrabButton manpage. |
1675 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1676 | manpage. |
1587 | |
1677 | |
1588 | =item $success = $term->grab ($eventtime[, $sync]) |
1678 | =item $success = $term->grab ($eventtime[, $sync]) |
1589 | |
1679 | |
1590 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1680 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1591 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1681 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |