… | |
… | |
58 | 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 |
59 | matches everything between two vertical bars: |
59 | matches everything between two vertical bars: |
60 | |
60 | |
61 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
61 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
62 | |
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 | |
63 | 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 |
64 | interesting uses, such as parsing a line from beginning to end. |
71 | interesting uses, such as parsing a line from beginning to end. |
65 | |
72 | |
66 | This extension also offers following bindable keyboard commands: |
73 | This extension also offers following bindable keyboard commands: |
67 | |
74 | |
… | |
… | |
75 | options at runtime. |
82 | options at runtime. |
76 | |
83 | |
77 | selection-popup (enabled by default) |
84 | selection-popup (enabled by default) |
78 | 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 |
79 | selection text into various other formats/action (such as uri |
86 | selection text into various other formats/action (such as uri |
80 | unescaping, perl evalution, web-browser starting etc.), depending on |
87 | unescaping, perl evaluation, web-browser starting etc.), depending |
81 | content. |
88 | on content. |
82 | |
89 | |
83 | Other extensions can extend this popup menu by pushing a code |
90 | Other extensions can extend this popup menu by pushing a code |
84 | reference onto "@{ $term-"{selection_popup_hook} }>, that is called |
91 | reference onto "@{ $term-"{selection_popup_hook} }>, that is called |
85 | whenever the popup is displayed. |
92 | whenever the popup is displayed. |
86 | |
93 | |
… | |
… | |
112 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
119 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
113 | to the point where search was started, while "Enter" or "Return" |
120 | to the point where search was started, while "Enter" or "Return" |
114 | stay at the current position and additionally stores the first match |
121 | stay at the current position and additionally stores the first match |
115 | in the current line into the primary selection. |
122 | in the current line into the primary selection. |
116 | |
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 | |
117 | selection-autotransform |
142 | selection-autotransform |
118 | This selection allows you to do automatic transforms on a selection |
143 | This selection allows you to do automatic transforms on a selection |
119 | whenever a selection is made. |
144 | whenever a selection is made. |
120 | |
145 | |
121 | 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///" |
… | |
… | |
155 | "tabbed terminal". The topmost line displays a "[NEW]" button, |
180 | "tabbed terminal". The topmost line displays a "[NEW]" button, |
156 | which, when clicked, will add a new tab, followed by one button per |
181 | which, when clicked, will add a new tab, followed by one button per |
157 | tab. |
182 | tab. |
158 | |
183 | |
159 | Clicking a button will activate that tab. Pressing Shift-Left and |
184 | Clicking a button will activate that tab. Pressing Shift-Left and |
160 | Shift-Right will switch to the tab left or right of the current one. |
185 | Shift-Right will switch to the tab left or right of the current one, |
|
|
186 | while Shift-Down creates a new tab. |
161 | |
187 | |
162 | mark-urls |
188 | mark-urls |
163 | Uses per-line display filtering ("on_line_update") to underline urls |
189 | Uses per-line display filtering ("on_line_update") to underline urls |
164 | and make them clickable. When middle-clicked, the program specified |
190 | and make them clickable. When middle-clicked, the program specified |
165 | in the resource "urlLauncher" (default "x-www-browser") will be |
191 | in the resource "urlLauncher" (default "x-www-browser") will be |
166 | started with the URL as first argument. |
192 | started with the URL as first argument. |
167 | |
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 |
|
|
204 | |
168 | automove-background |
205 | automove-background |
169 | This is basically a one-line extension that dynamically changes the |
206 | This is basically a one-line extension that dynamically changes the |
170 | background pixmap offset to the window position, in effect creating |
207 | background pixmap offset to the window position, in effect creating |
171 | the same effect as pseudo transparency with a custom pixmap. No |
208 | the same effect as pseudo transparency with a custom pixmap. No |
172 | scaling is supported in this mode. Exmaple: |
209 | scaling is supported in this mode. Exmaple: |
… | |
… | |
179 | U+259F) by a similar-looking ascii character. |
216 | U+259F) by a similar-looking ascii character. |
180 | |
217 | |
181 | digital-clock |
218 | digital-clock |
182 | Displays a digital clock using the built-in overlay. |
219 | Displays a digital clock using the built-in overlay. |
183 | |
220 | |
184 | example-refresh-hooks |
221 | remote-clipboard |
185 | Displays a very simple digital clock in the upper right corner of |
222 | Somewhat of a misnomer, this extension adds two menu entries to the |
186 | the window. Illustrates overwriting the refresh callbacks to create |
223 | selection popup that allows one ti run external commands to store |
187 | your own overlays or changes. |
224 | the selection somewhere and fetch it again. |
|
|
225 | |
|
|
226 | We use it to implement a "distributed selection mechanism", which |
|
|
227 | just means that one command uploads the file to a remote server, and |
|
|
228 | another reads it. |
|
|
229 | |
|
|
230 | The commands can be set using the "URxvt.remote-selection.store" and |
|
|
231 | "URxvt.remote-selection.fetch" resources. The first should read the |
|
|
232 | selection to store from STDIN (always in UTF-8), the second should |
|
|
233 | provide the selection data on STDOUT (also in UTF-8). |
|
|
234 | |
|
|
235 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
236 | |
|
|
237 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
238 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
188 | |
239 | |
189 | selection-pastebin |
240 | selection-pastebin |
190 | This is a little rarely useful extension that Uploads the selection |
241 | This is a little rarely useful extension that Uploads the selection |
191 | as textfile to a remote site (or does other things). (The |
242 | as textfile to a remote site (or does other things). (The |
192 | implementation is not currently secure for use in a multiuser |
243 | implementation is not currently secure for use in a multiuser |
… | |
… | |
211 | After a successful upload the selection will be replaced by the text |
262 | After a successful upload the selection will be replaced by the text |
212 | given in the "selection-pastebin-url" resource (again, the % is the |
263 | given in the "selection-pastebin-url" resource (again, the % is the |
213 | placeholder for the filename): |
264 | placeholder for the filename): |
214 | |
265 | |
215 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
266 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
267 | |
|
|
268 | example-refresh-hooks |
|
|
269 | Displays a very simple digital clock in the upper right corner of |
|
|
270 | the window. Illustrates overwriting the refresh callbacks to create |
|
|
271 | your own overlays or changes. |
216 | |
272 | |
217 | API DOCUMENTATION |
273 | API DOCUMENTATION |
218 | General API Considerations |
274 | General API Considerations |
219 | All objects (such as terminals, time watchers etc.) are typical |
275 | All objects (such as terminals, time watchers etc.) are typical |
220 | reference-to-hash objects. The hash can be used to store anything you |
276 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
294 | Called at the very end of initialisation of a new terminal, just |
350 | Called at the very end of initialisation of a new terminal, just |
295 | before trying to map (display) the toplevel and returning to the |
351 | before trying to map (display) the toplevel and returning to the |
296 | mainloop. |
352 | mainloop. |
297 | |
353 | |
298 | on_destroy $term |
354 | on_destroy $term |
299 | Called whenever something tries to destroy terminal, before doing |
355 | Called whenever something tries to destroy terminal, when the |
300 | anything yet. If this hook returns true, then destruction is |
356 | terminal is still fully functional (not for long, though). |
301 | skipped, but this is rarely a good idea. |
|
|
302 | |
357 | |
303 | on_reset $term |
358 | on_reset $term |
304 | Called after the screen is "reset" for any reason, such as resizing |
359 | Called after the screen is "reset" for any reason, such as resizing |
305 | or control sequences. Here is where you can react on changes to |
360 | or control sequences. Here is where you can react on changes to |
306 | size-related variables. |
361 | size-related variables. |
… | |
… | |
398 | display code is run after this hook, and takes precedence. |
453 | display code is run after this hook, and takes precedence. |
399 | |
454 | |
400 | on_refresh_end $term |
455 | on_refresh_end $term |
401 | Called just after the screen gets redrawn. See "on_refresh_begin". |
456 | Called just after the screen gets redrawn. See "on_refresh_begin". |
402 | |
457 | |
403 | on_keyboard_command $term, $string |
458 | on_user_command $term, $string |
404 | Called whenever the user presses a key combination that has a |
459 | Called whenever the a user-configured event is being activated (e.g. |
405 | "perl:string" action bound to it (see description of the keysym |
460 | via a "perl:string" action bound to a key, see description of the |
406 | resource in the rxvt(1) manpage). |
461 | keysym resource in the rxvt(1) manpage). |
|
|
462 | |
|
|
463 | The event is simply the action string. This interface is assumed to |
|
|
464 | change slightly in the future. |
407 | |
465 | |
408 | on_x_event $term, $event |
466 | on_x_event $term, $event |
409 | Called on every X event received on the vt window (and possibly |
467 | Called on every X event received on the vt window (and possibly |
410 | other windows). Should only be used as a last resort. Most event |
468 | other windows). Should only be used as a last resort. Most event |
411 | structure members are not passed. |
469 | structure members are not passed. |
… | |
… | |
417 | on_focus_out $term |
475 | on_focus_out $term |
418 | Called wheneever the window loses keyboard focus, before |
476 | Called wheneever the window loses keyboard focus, before |
419 | rxvt-unicode does focus out processing. |
477 | rxvt-unicode does focus out processing. |
420 | |
478 | |
421 | on_configure_notify $term, $event |
479 | on_configure_notify $term, $event |
|
|
480 | on_property_notify $term, $event |
422 | on_key_press $term, $event, $keysym, $octets |
481 | on_key_press $term, $event, $keysym, $octets |
423 | on_key_release $term, $event, $keysym |
482 | on_key_release $term, $event, $keysym |
424 | on_button_press $term, $event |
483 | on_button_press $term, $event |
425 | on_button_release $term, $event |
484 | on_button_release $term, $event |
426 | on_motion_notify $term, $event |
485 | on_motion_notify $term, $event |
… | |
… | |
430 | terminal If the hook returns true, then the even will be ignored by |
489 | terminal If the hook returns true, then the even will be ignored by |
431 | rxvt-unicode. |
490 | rxvt-unicode. |
432 | |
491 | |
433 | The event is a hash with most values as named by Xlib (see the |
492 | The event is a hash with most values as named by Xlib (see the |
434 | XEvent manpage), with the additional members "row" and "col", which |
493 | XEvent manpage), with the additional members "row" and "col", which |
435 | are the row and column under the mouse cursor. |
494 | are the (real, not screen-based) row and column under the mouse |
|
|
495 | cursor. |
436 | |
496 | |
437 | "on_key_press" additionally receives the string rxvt-unicode would |
497 | "on_key_press" additionally receives the string rxvt-unicode would |
438 | output, if any, in locale-specific encoding. |
498 | output, if any, in locale-specific encoding. |
439 | |
499 | |
440 | subwindow. |
500 | subwindow. |
… | |
… | |
490 | |
550 | |
491 | Using this function has the advantage that its output ends up in the |
551 | Using this function has the advantage that its output ends up in the |
492 | correct place, e.g. on stderr of the connecting urxvtc client. |
552 | correct place, e.g. on stderr of the connecting urxvtc client. |
493 | |
553 | |
494 | Messages have a size limit of 1023 bytes currently. |
554 | Messages have a size limit of 1023 bytes currently. |
|
|
555 | |
|
|
556 | @terms = urxvt::termlist |
|
|
557 | Returns all urxvt::term objects that exist in this process, |
|
|
558 | regardless of wether they are started, being destroyed etc., so be |
|
|
559 | careful. Only term objects that have perl extensions attached will |
|
|
560 | be returned (because there is no urxvt::term objet associated with |
|
|
561 | others). |
495 | |
562 | |
496 | $time = urxvt::NOW |
563 | $time = urxvt::NOW |
497 | Returns the "current time" (as per the event loop). |
564 | Returns the "current time" (as per the event loop). |
498 | |
565 | |
499 | urxvt::CurrentTime |
566 | urxvt::CurrentTime |
… | |
… | |
571 | %ENV-like hash which defines the environment of the new terminal. |
638 | %ENV-like hash which defines the environment of the new terminal. |
572 | |
639 | |
573 | Croaks (and probably outputs an error message) if the new instance |
640 | Croaks (and probably outputs an error message) if the new instance |
574 | couldn't be created. Returns "undef" if the new instance didn't |
641 | couldn't be created. Returns "undef" if the new instance didn't |
575 | initialise perl, and the terminal object otherwise. The "init" and |
642 | initialise perl, and the terminal object otherwise. The "init" and |
576 | "start" hooks will be called during this call. |
643 | "start" hooks will be called before this call returns, and are free |
|
|
644 | to refer to global data (which is race free). |
577 | |
645 | |
578 | $term->destroy |
646 | $term->destroy |
579 | Destroy the terminal object (close the window, free resources etc.). |
647 | Destroy the terminal object (close the window, free resources etc.). |
580 | Please note that rxvt will not exit as long as any event watchers |
648 | Please note that rxvt will not exit as long as any event watchers |
581 | (timers, io watchers) are still active. |
649 | (timers, io watchers) are still active. |
… | |
… | |
757 | |
825 | |
758 | Normally its not a good idea to use this function, as programs might |
826 | Normally its not a good idea to use this function, as programs might |
759 | be confused by changes in cursor position or scrolling. Its useful |
827 | be confused by changes in cursor position or scrolling. Its useful |
760 | inside a "on_add_lines" hook, though. |
828 | inside a "on_add_lines" hook, though. |
761 | |
829 | |
|
|
830 | $term->scr_change_screen ($screen) |
|
|
831 | Switch to given screen - 0 primary, 1 secondary. |
|
|
832 | |
762 | $term->cmd_parse ($octets) |
833 | $term->cmd_parse ($octets) |
763 | Similar to "scr_add_lines", but the argument must be in the |
834 | Similar to "scr_add_lines", but the argument must be in the |
764 | locale-specific encoding of the terminal and can contain command |
835 | locale-specific encoding of the terminal and can contain command |
765 | sequences (escape codes) that will be interpreted. |
836 | sequences (escape codes) that will be interpreted. |
766 | |
837 | |
… | |
… | |
773 | $old_events = $term->pty_ev_events ([$new_events]) |
844 | $old_events = $term->pty_ev_events ([$new_events]) |
774 | Replaces the event mask of the pty watcher by the given event mask. |
845 | Replaces the event mask of the pty watcher by the given event mask. |
775 | Can be used to suppress input and output handling to the pty/tty. |
846 | Can be used to suppress input and output handling to the pty/tty. |
776 | See the description of "urxvt::timer->events". Make sure to always |
847 | See the description of "urxvt::timer->events". Make sure to always |
777 | restore the previous value. |
848 | restore the previous value. |
|
|
849 | |
|
|
850 | $fd = $term->pty_fd |
|
|
851 | Returns the master file descriptor for the pty in use, or -1 if no |
|
|
852 | pty is used. |
778 | |
853 | |
779 | $windowid = $term->parent |
854 | $windowid = $term->parent |
780 | Return the window id of the toplevel window. |
855 | Return the window id of the toplevel window. |
781 | |
856 | |
782 | $windowid = $term->vt |
857 | $windowid = $term->vt |
… | |
… | |
817 | $modifiermask = $term->ModNumLockMask |
892 | $modifiermask = $term->ModNumLockMask |
818 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
893 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
819 | (often AltGr), the meta key (often Alt) and the num lock key, if |
894 | (often AltGr), the meta key (often Alt) and the num lock key, if |
820 | applicable. |
895 | applicable. |
821 | |
896 | |
|
|
897 | $screen = $term->current_screen |
|
|
898 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
899 | |
|
|
900 | $cursor_is_hidden = $term->hidden_cursor |
|
|
901 | Returns wether the cursor is currently hidden or not. |
|
|
902 | |
822 | $view_start = $term->view_start ([$newvalue]) |
903 | $view_start = $term->view_start ([$newvalue]) |
823 | Returns the row number of the topmost displayed line. Maximum value |
904 | Returns the row number of the topmost displayed line. Maximum value |
824 | is 0, which displays the normal terminal contents. Lower values |
905 | is 0, which displays the normal terminal contents. Lower values |
825 | scroll this many lines into the scrollback buffer. |
906 | scroll this many lines into the scrollback buffer. |
826 | |
907 | |
… | |
… | |
842 | line, starting at column $start_col (default 0), which is useful to |
923 | line, starting at column $start_col (default 0), which is useful to |
843 | replace only parts of a line. The font index in the rendition will |
924 | replace only parts of a line. The font index in the rendition will |
844 | automatically be updated. |
925 | automatically be updated. |
845 | |
926 | |
846 | $text is in a special encoding: tabs and wide characters that use |
927 | $text is in a special encoding: tabs and wide characters that use |
847 | more than one cell when displayed are padded with urxvt::NOCHAR |
928 | more than one cell when displayed are padded with $urxvt::NOCHAR |
848 | characters ("chr 65535"). Characters with combining characters and |
929 | (chr 65535) characters. Characters with combining characters and |
849 | other characters that do not fit into the normal tetx encoding will |
930 | other characters that do not fit into the normal tetx encoding will |
850 | be replaced with characters in the private use area. |
931 | be replaced with characters in the private use area. |
851 | |
932 | |
852 | You have to obey this encoding when changing text. The advantage is |
933 | You have to obey this encoding when changing text. The advantage is |
853 | that "substr" and similar functions work on screen cells and not on |
934 | that "substr" and similar functions work on screen cells and not on |
… | |
… | |
912 | |
993 | |
913 | $string = $term->special_decode $text |
994 | $string = $term->special_decode $text |
914 | Converts rxvt-unicodes text reprsentation into a perl string. See |
995 | Converts rxvt-unicodes text reprsentation into a perl string. See |
915 | "$term->ROW_t" for details. |
996 | "$term->ROW_t" for details. |
916 | |
997 | |
917 | $success = $term->grab_button ($button, $modifiermask) |
998 | $success = $term->grab_button ($button, $modifiermask[, $window = |
|
|
999 | $term->vt]) |
|
|
1000 | $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
918 | Registers a synchronous button grab. See the XGrabButton manpage. |
1001 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1002 | manpage. |
919 | |
1003 | |
920 | $success = $term->grab ($eventtime[, $sync]) |
1004 | $success = $term->grab ($eventtime[, $sync]) |
921 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1005 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
922 | synchronous ($sync is true). Also remembers the grab timestampe. |
1006 | synchronous ($sync is true). Also remembers the grab timestampe. |
923 | |
1007 | |
… | |
… | |
933 | |
1017 | |
934 | $term->ungrab |
1018 | $term->ungrab |
935 | Calls XUngrab for the most recent grab. Is called automatically on |
1019 | Calls XUngrab for the most recent grab. Is called automatically on |
936 | evaluation errors, as it is better to lose the grab in the error |
1020 | evaluation errors, as it is better to lose the grab in the error |
937 | case as the session. |
1021 | case as the session. |
|
|
1022 | |
|
|
1023 | $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1024 | $atom_name = $term->XGetAtomName ($atom) |
|
|
1025 | @atoms = $term->XListProperties ($window) |
|
|
1026 | ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1027 | $term->XChangeWindowProperty ($window, $property, $type, $format, |
|
|
1028 | $octets) |
|
|
1029 | $term->XDeleteProperty ($window, $property) |
|
|
1030 | $window = $term->DefaultRootWindow |
|
|
1031 | $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1032 | $term->XMapWindow ($window) |
|
|
1033 | $term->XUnmapWindow ($window) |
|
|
1034 | $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1035 | ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, |
|
|
1036 | $y) |
|
|
1037 | $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1038 | Various X or X-related functions. The $term object only serves as |
|
|
1039 | the source of the display, otherwise those functions map |
|
|
1040 | more-or-less directory onto the X functions of the same name. |
938 | |
1041 | |
939 | The "urxvt::popup" Class |
1042 | The "urxvt::popup" Class |
940 | $popup->add_title ($title) |
1043 | $popup->add_title ($title) |
941 | Adds a non-clickable title to the popup. |
1044 | Adds a non-clickable title to the popup. |
942 | |
1045 | |