… | |
… | |
28 | can find them in /opt/rxvt/lib/urxvt/perl/. |
28 | can find them in /opt/rxvt/lib/urxvt/perl/. |
29 | |
29 | |
30 | You can activate them like this: |
30 | You can activate them like this: |
31 | |
31 | |
32 | rxvt -pe <extensionname> |
32 | rxvt -pe <extensionname> |
|
|
33 | |
|
|
34 | Or by adding them to the resource for extensions loaded by default: |
|
|
35 | |
|
|
36 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
33 | |
37 | |
34 | selection (enabled by default) |
38 | selection (enabled by default) |
35 | (More) intelligent selection. This extension tries to be more |
39 | (More) intelligent selection. This extension tries to be more |
36 | intelligent when the user extends selections (double-click and |
40 | intelligent when the user extends selections (double-click and |
37 | further clicks). Right now, it tries to select words, urls and |
41 | further clicks). Right now, it tries to select words, urls and |
… | |
… | |
54 | be used for the match. For example, the followign adds a regex that |
58 | be used for the match. For example, the followign adds a regex that |
55 | matches everything between two vertical bars: |
59 | matches everything between two vertical bars: |
56 | |
60 | |
57 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
61 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
58 | |
62 | |
|
|
63 | Another example: Programs I use often output "absolute path: " at |
|
|
64 | the beginning of a line when they process multiple files. The |
|
|
65 | following pattern matches the filename (note, there is a single |
|
|
66 | space at the very end): |
|
|
67 | |
|
|
68 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
69 | |
59 | You can look at the source of the selection extension to see more |
70 | You can look at the source of the selection extension to see more |
60 | interesting uses, such as parsing a line from beginning to end. |
71 | interesting uses, such as parsing a line from beginning to end. |
61 | |
72 | |
62 | This extension also offers following bindable keyboard commands: |
73 | This extension also offers following bindable keyboard commands: |
63 | |
74 | |
… | |
… | |
71 | options at runtime. |
82 | options at runtime. |
72 | |
83 | |
73 | selection-popup (enabled by default) |
84 | selection-popup (enabled by default) |
74 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
85 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
75 | selection text into various other formats/action (such as uri |
86 | selection text into various other formats/action (such as uri |
76 | unescaping, perl evalution, web-browser starting etc.), depending on |
87 | unescaping, perl evaluation, web-browser starting etc.), depending |
77 | content. |
88 | on content. |
78 | |
89 | |
79 | Other extensions can extend this popup menu by pushing a code |
90 | Other extensions can extend this popup menu by pushing a code |
80 | reference onto "@{ $term-"{selection_popup_hook} }>, that is called |
91 | reference onto "@{ $term-"{selection_popup_hook} }>, that is called |
81 | whenever the popup is displayed. |
92 | whenever the popup is displayed. |
82 | |
93 | |
… | |
… | |
108 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
119 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
109 | to the point where search was started, while "Enter" or "Return" |
120 | to the point where search was started, while "Enter" or "Return" |
110 | stay at the current position and additionally stores the first match |
121 | stay at the current position and additionally stores the first match |
111 | in the current line into the primary selection. |
122 | in the current line into the primary selection. |
112 | |
123 | |
|
|
124 | readline (enabled by default) |
|
|
125 | A support package that tries to make editing with readline easier. |
|
|
126 | At the moment, it reacts to clicking with the left mouse button by |
|
|
127 | trying to move the text cursor to this position. It does so by |
|
|
128 | generating as many cursor-left or cursor-right keypresses as |
|
|
129 | required (the this only works for programs that correctly support |
|
|
130 | wide characters). |
|
|
131 | |
|
|
132 | To avoid too many false positives, this is only done when: |
|
|
133 | |
|
|
134 | - the tty is in ICANON state. |
|
|
135 | - the text cursor is visible. |
|
|
136 | - the primary screen is currently being displayed. |
|
|
137 | - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
138 | |
|
|
139 | The normal selection mechanism isn't disabled, so quick successive |
|
|
140 | clicks might interfere with selection creation in harmless ways. |
|
|
141 | |
113 | selection-autotransform |
142 | selection-autotransform |
114 | This selection allows you to do automatic transforms on a selection |
143 | This selection allows you to do automatic transforms on a selection |
115 | whenever a selection is made. |
144 | whenever a selection is made. |
116 | |
145 | |
117 | It works by specifying perl snippets (most useful is a single "s///" |
146 | It works by specifying perl snippets (most useful is a single "s///" |
… | |
… | |
142 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
171 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
143 | |
172 | |
144 | The first line tells the selection code to treat the unchanging part |
173 | The first line tells the selection code to treat the unchanging part |
145 | of every error message as a selection pattern, and the second line |
174 | of every error message as a selection pattern, and the second line |
146 | transforms the message into vi commands to load the file. |
175 | transforms the message into vi commands to load the file. |
|
|
176 | |
|
|
177 | tabbed |
|
|
178 | This transforms the terminal into a tabbar with additional |
|
|
179 | terminals, that is, it implements what is commonly refered to as |
|
|
180 | "tabbed terminal". The topmost line displays a "[NEW]" button, |
|
|
181 | which, when clicked, will add a new tab, followed by one button per |
|
|
182 | tab. |
|
|
183 | |
|
|
184 | Clicking a button will activate that tab. Pressing Shift-Left and |
|
|
185 | Shift-Right will switch to the tab left or right of the current one, |
|
|
186 | while Shift-Down creates a new tab. |
147 | |
187 | |
148 | mark-urls |
188 | mark-urls |
149 | Uses per-line display filtering ("on_line_update") to underline urls |
189 | Uses per-line display filtering ("on_line_update") to underline urls |
150 | and make them clickable. When middle-clicked, the program specified |
190 | and make them clickable. When middle-clicked, the program specified |
151 | in the resource "urlLauncher" (default "x-www-browser") will be |
191 | in the resource "urlLauncher" (default "x-www-browser") will be |
152 | started with the URL as first argument. |
192 | started with the URL as first argument. |
|
|
193 | |
|
|
194 | xim-onthespot |
|
|
195 | This (experimental) perl extension implements OnTheSpot editing. It |
|
|
196 | does not work perfectly, and some input methods don't seem to work |
|
|
197 | well with OnTheSpot editing in general, but it seems to work at |
|
|
198 | leats for SCIM and kinput2. |
|
|
199 | |
|
|
200 | You enable it by specifying this extension and a preedit style of |
|
|
201 | "OnTheSpot", i.e.: |
|
|
202 | |
|
|
203 | rxvt -pt OnTheSpot -pe xim-onthespot |
153 | |
204 | |
154 | automove-background |
205 | automove-background |
155 | This is basically a one-line extension that dynamically changes the |
206 | This is basically a one-line extension that dynamically changes the |
156 | background pixmap offset to the window position, in effect creating |
207 | background pixmap offset to the window position, in effect creating |
157 | the same effect as pseudo transparency with a custom pixmap. No |
208 | the same effect as pseudo transparency with a custom pixmap. No |
… | |
… | |
260 | be called whenever the relevant event happens. |
311 | be called whenever the relevant event happens. |
261 | |
312 | |
262 | The first argument passed to them is an extension oject as described in |
313 | The first argument passed to them is an extension oject as described in |
263 | the in the "Extension Objects" section. |
314 | the in the "Extension Objects" section. |
264 | |
315 | |
265 | All of these hooks must return a boolean value. If it is true, then the |
316 | All of these hooks must return a boolean value. If any of the called |
266 | event counts as being *consumed*, and the invocation of other hooks is |
317 | hooks returns true, then the event counts as being *consumed*, and the |
267 | skipped, and the relevant action might not be carried out by the C++ |
318 | relevant action might not be carried out by the C++ code. |
268 | code. |
|
|
269 | |
319 | |
270 | *When in doubt, return a false value (preferably "()").* |
320 | *When in doubt, return a false value (preferably "()").* |
271 | |
321 | |
272 | on_init $term |
322 | on_init $term |
273 | Called after a new terminal object has been initialized, but before |
323 | Called after a new terminal object has been initialized, but before |
274 | windows are created or the command gets run. Most methods are unsafe |
324 | windows are created or the command gets run. Most methods are unsafe |
275 | to call or deliver senseless data, as terminal size and other |
325 | to call or deliver senseless data, as terminal size and other |
276 | characteristics have not yet been determined. You can safely query |
326 | characteristics have not yet been determined. You can safely query |
277 | and change resources, though. |
327 | and change resources and options, though. For many purposes the |
|
|
328 | "on_start" hook is a better place. |
|
|
329 | |
|
|
330 | on_start $term |
|
|
331 | Called at the very end of initialisation of a new terminal, just |
|
|
332 | before trying to map (display) the toplevel and returning to the |
|
|
333 | mainloop. |
|
|
334 | |
|
|
335 | on_destroy $term |
|
|
336 | Called whenever something tries to destroy terminal, when the |
|
|
337 | terminal is still fully functional (not for long, though). |
278 | |
338 | |
279 | on_reset $term |
339 | on_reset $term |
280 | Called after the screen is "reset" for any reason, such as resizing |
340 | Called after the screen is "reset" for any reason, such as resizing |
281 | or control sequences. Here is where you can react on changes to |
341 | or control sequences. Here is where you can react on changes to |
282 | size-related variables. |
342 | size-related variables. |
283 | |
|
|
284 | on_start $term |
|
|
285 | Called at the very end of initialisation of a new terminal, just |
|
|
286 | before returning to the mainloop. |
|
|
287 | |
343 | |
288 | on_child_start $term, $pid |
344 | on_child_start $term, $pid |
289 | Called just after the child process has been "fork"ed. |
345 | Called just after the child process has been "fork"ed. |
290 | |
346 | |
291 | on_child_exit $term, $status |
347 | on_child_exit $term, $status |
… | |
… | |
397 | on_focus_out $term |
453 | on_focus_out $term |
398 | Called wheneever the window loses keyboard focus, before |
454 | Called wheneever the window loses keyboard focus, before |
399 | rxvt-unicode does focus out processing. |
455 | rxvt-unicode does focus out processing. |
400 | |
456 | |
401 | on_configure_notify $term, $event |
457 | on_configure_notify $term, $event |
|
|
458 | on_property_notify $term, $event |
402 | on_key_press $term, $event, $keysym, $octets |
459 | on_key_press $term, $event, $keysym, $octets |
403 | on_key_release $term, $event, $keysym |
460 | on_key_release $term, $event, $keysym |
404 | on_button_press $term, $event |
461 | on_button_press $term, $event |
405 | on_button_release $term, $event |
462 | on_button_release $term, $event |
406 | on_motion_notify $term, $event |
463 | on_motion_notify $term, $event |
… | |
… | |
410 | terminal If the hook returns true, then the even will be ignored by |
467 | terminal If the hook returns true, then the even will be ignored by |
411 | rxvt-unicode. |
468 | rxvt-unicode. |
412 | |
469 | |
413 | The event is a hash with most values as named by Xlib (see the |
470 | The event is a hash with most values as named by Xlib (see the |
414 | XEvent manpage), with the additional members "row" and "col", which |
471 | XEvent manpage), with the additional members "row" and "col", which |
415 | are the row and column under the mouse cursor. |
472 | are the (real, not screen-based) row and column under the mouse |
|
|
473 | cursor. |
416 | |
474 | |
417 | "on_key_press" additionally receives the string rxvt-unicode would |
475 | "on_key_press" additionally receives the string rxvt-unicode would |
418 | output, if any, in locale-specific encoding. |
476 | output, if any, in locale-specific encoding. |
419 | |
477 | |
420 | subwindow. |
478 | subwindow. |
|
|
479 | |
|
|
480 | on_client_message $term, $event |
|
|
481 | on_wm_protocols $term, $event |
|
|
482 | on_wm_delete_window $term, $event |
|
|
483 | Called when various types of ClientMessage events are received (all |
|
|
484 | with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
421 | |
485 | |
422 | Variables in the "urxvt" Package |
486 | Variables in the "urxvt" Package |
423 | $urxvt::LIBDIR |
487 | $urxvt::LIBDIR |
424 | The rxvt-unicode library directory, where, among other things, the |
488 | The rxvt-unicode library directory, where, among other things, the |
425 | perl modules and scripts are stored. |
489 | perl modules and scripts are stored. |
… | |
… | |
432 | The basename of the installed binaries, usually "urxvt". |
496 | The basename of the installed binaries, usually "urxvt". |
433 | |
497 | |
434 | $urxvt::TERM |
498 | $urxvt::TERM |
435 | The current terminal. This variable stores the current "urxvt::term" |
499 | The current terminal. This variable stores the current "urxvt::term" |
436 | object, whenever a callback/hook is executing. |
500 | object, whenever a callback/hook is executing. |
|
|
501 | |
|
|
502 | @urxvt::TERM_INIT |
|
|
503 | All coderefs in this array will be called as methods of the next |
|
|
504 | newly created "urxvt::term" object (during the "on_init" phase). The |
|
|
505 | array gets cleared before the codereferences that were in it are |
|
|
506 | being executed, so coderefs can push themselves onto it again if |
|
|
507 | they so desire. |
|
|
508 | |
|
|
509 | This complements to the perl-eval commandline option, but gets |
|
|
510 | executed first. |
|
|
511 | |
|
|
512 | @urxvt::TERM_EXT |
|
|
513 | Works similar to @TERM_INIT, but contains perl package/class names, |
|
|
514 | which get registered as normal extensions after calling the hooks in |
|
|
515 | @TERM_INIT but before other extensions. Gets cleared just like |
|
|
516 | @TERM_INIT. |
437 | |
517 | |
438 | Functions in the "urxvt" Package |
518 | Functions in the "urxvt" Package |
439 | urxvt::fatal $errormessage |
519 | urxvt::fatal $errormessage |
440 | Fatally aborts execution with the given error message. Avoid at all |
520 | Fatally aborts execution with the given error message. Avoid at all |
441 | costs! The only time this is acceptable is when the terminal process |
521 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
715 | |
795 | |
716 | Normally its not a good idea to use this function, as programs might |
796 | Normally its not a good idea to use this function, as programs might |
717 | be confused by changes in cursor position or scrolling. Its useful |
797 | be confused by changes in cursor position or scrolling. Its useful |
718 | inside a "on_add_lines" hook, though. |
798 | inside a "on_add_lines" hook, though. |
719 | |
799 | |
|
|
800 | $term->scr_change_screen ($screen) |
|
|
801 | Switch to given screen - 0 primary, 1 secondary. |
|
|
802 | |
720 | $term->cmd_parse ($octets) |
803 | $term->cmd_parse ($octets) |
721 | Similar to "scr_add_lines", but the argument must be in the |
804 | Similar to "scr_add_lines", but the argument must be in the |
722 | locale-specific encoding of the terminal and can contain command |
805 | locale-specific encoding of the terminal and can contain command |
723 | sequences (escape codes) that will be interpreted. |
806 | sequences (escape codes) that will be interpreted. |
724 | |
807 | |
… | |
… | |
731 | $old_events = $term->pty_ev_events ([$new_events]) |
814 | $old_events = $term->pty_ev_events ([$new_events]) |
732 | Replaces the event mask of the pty watcher by the given event mask. |
815 | Replaces the event mask of the pty watcher by the given event mask. |
733 | Can be used to suppress input and output handling to the pty/tty. |
816 | Can be used to suppress input and output handling to the pty/tty. |
734 | See the description of "urxvt::timer->events". Make sure to always |
817 | See the description of "urxvt::timer->events". Make sure to always |
735 | restore the previous value. |
818 | restore the previous value. |
|
|
819 | |
|
|
820 | $fd = $term->pty_fd |
|
|
821 | Returns the master file descriptor for the pty in use, or -1 if no |
|
|
822 | pty is used. |
736 | |
823 | |
737 | $windowid = $term->parent |
824 | $windowid = $term->parent |
738 | Return the window id of the toplevel window. |
825 | Return the window id of the toplevel window. |
739 | |
826 | |
740 | $windowid = $term->vt |
827 | $windowid = $term->vt |
… | |
… | |
775 | $modifiermask = $term->ModNumLockMask |
862 | $modifiermask = $term->ModNumLockMask |
776 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
863 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
777 | (often AltGr), the meta key (often Alt) and the num lock key, if |
864 | (often AltGr), the meta key (often Alt) and the num lock key, if |
778 | applicable. |
865 | applicable. |
779 | |
866 | |
|
|
867 | $screen = $term->current_screen |
|
|
868 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
869 | |
|
|
870 | $cursor_is_hidden = $term->hidden_cursor |
|
|
871 | Returns wether the cursor is currently hidden or not. |
|
|
872 | |
780 | $view_start = $term->view_start ([$newvalue]) |
873 | $view_start = $term->view_start ([$newvalue]) |
781 | Returns the row number of the topmost displayed line. Maximum value |
874 | Returns the row number of the topmost displayed line. Maximum value |
782 | is 0, which displays the normal terminal contents. Lower values |
875 | is 0, which displays the normal terminal contents. Lower values |
783 | scroll this many lines into the scrollback buffer. |
876 | scroll this many lines into the scrollback buffer. |
784 | |
877 | |
… | |
… | |
800 | line, starting at column $start_col (default 0), which is useful to |
893 | line, starting at column $start_col (default 0), which is useful to |
801 | replace only parts of a line. The font index in the rendition will |
894 | replace only parts of a line. The font index in the rendition will |
802 | automatically be updated. |
895 | automatically be updated. |
803 | |
896 | |
804 | $text is in a special encoding: tabs and wide characters that use |
897 | $text is in a special encoding: tabs and wide characters that use |
805 | more than one cell when displayed are padded with urxvt::NOCHAR |
898 | more than one cell when displayed are padded with $urxvt::NOCHAR |
806 | characters ("chr 65535"). Characters with combining characters and |
899 | (chr 65535) characters. Characters with combining characters and |
807 | other characters that do not fit into the normal tetx encoding will |
900 | other characters that do not fit into the normal tetx encoding will |
808 | be replaced with characters in the private use area. |
901 | be replaced with characters in the private use area. |
809 | |
902 | |
810 | You have to obey this encoding when changing text. The advantage is |
903 | You have to obey this encoding when changing text. The advantage is |
811 | that "substr" and similar functions work on screen cells and not on |
904 | that "substr" and similar functions work on screen cells and not on |
… | |
… | |
891 | |
984 | |
892 | $term->ungrab |
985 | $term->ungrab |
893 | Calls XUngrab for the most recent grab. Is called automatically on |
986 | Calls XUngrab for the most recent grab. Is called automatically on |
894 | evaluation errors, as it is better to lose the grab in the error |
987 | evaluation errors, as it is better to lose the grab in the error |
895 | case as the session. |
988 | case as the session. |
|
|
989 | |
|
|
990 | $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
991 | $atom_name = $term->XGetAtomName ($atom) |
|
|
992 | @atoms = $term->XListProperties ($window) |
|
|
993 | ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
994 | $term->XChangeWindowProperty ($window, $property, $type, $format, |
|
|
995 | $octets) |
|
|
996 | $term->XDeleteProperty ($window, $property) |
|
|
997 | $window = $term->DefaultRootWindow |
|
|
998 | $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
999 | $term->XMapWindow ($window) |
|
|
1000 | $term->XUnmapWindow ($window) |
|
|
1001 | $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1002 | ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, |
|
|
1003 | $y) |
|
|
1004 | $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1005 | Various X or X-related functions. The $term object only serves as |
|
|
1006 | the source of the display, otherwise those functions map |
|
|
1007 | more-or-less directory onto the X functions of the same name. |
896 | |
1008 | |
897 | The "urxvt::popup" Class |
1009 | The "urxvt::popup" Class |
898 | $popup->add_title ($title) |
1010 | $popup->add_title ($title) |
899 | Adds a non-clickable title to the popup. |
1011 | Adds a non-clickable title to the popup. |
900 | |
1012 | |
… | |
… | |
992 | Start watching for requested events on the given handle. |
1104 | Start watching for requested events on the given handle. |
993 | |
1105 | |
994 | $iow = $iow->stop |
1106 | $iow = $iow->stop |
995 | Stop watching for events on the given filehandle. |
1107 | Stop watching for events on the given filehandle. |
996 | |
1108 | |
|
|
1109 | The "urxvt::iw" Class |
|
|
1110 | This class implements idle watchers, that get called automatically when |
|
|
1111 | the process is idle. They should return as fast as possible, after doing |
|
|
1112 | some useful work. |
|
|
1113 | |
|
|
1114 | $iw = new urxvt::iw |
|
|
1115 | Create a new idle watcher object in stopped state. |
|
|
1116 | |
|
|
1117 | $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1118 | Set the callback to be called when the watcher triggers. |
|
|
1119 | |
|
|
1120 | $timer = $timer->start |
|
|
1121 | Start the watcher. |
|
|
1122 | |
|
|
1123 | $timer = $timer->stop |
|
|
1124 | Stop the watcher. |
|
|
1125 | |
|
|
1126 | The "urxvt::pw" Class |
|
|
1127 | This class implements process watchers. They create an event whenever a |
|
|
1128 | process exits, after which they stop automatically. |
|
|
1129 | |
|
|
1130 | my $pid = fork; |
|
|
1131 | ... |
|
|
1132 | $term->{pw} = urxvt::pw |
|
|
1133 | ->new |
|
|
1134 | ->start ($pid) |
|
|
1135 | ->cb (sub { |
|
|
1136 | my ($pw, $exit_status) = @_; |
|
|
1137 | ... |
|
|
1138 | }); |
|
|
1139 | |
|
|
1140 | $pw = new urxvt::pw |
|
|
1141 | Create a new process watcher in stopped state. |
|
|
1142 | |
|
|
1143 | $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1144 | Set the callback to be called when the timer triggers. |
|
|
1145 | |
|
|
1146 | $pw = $timer->start ($pid) |
|
|
1147 | Tells the wqtcher to start watching for process $pid. |
|
|
1148 | |
|
|
1149 | $pw = $pw->stop |
|
|
1150 | Stop the watcher. |
|
|
1151 | |
997 | ENVIRONMENT |
1152 | ENVIRONMENT |
998 | URXVT_PERL_VERBOSITY |
1153 | URXVT_PERL_VERBOSITY |
999 | This variable controls the verbosity level of the perl extension. Higher |
1154 | This variable controls the verbosity level of the perl extension. Higher |
1000 | numbers indicate more verbose output. |
1155 | numbers indicate more verbose output. |
1001 | |
1156 | |