… | |
… | |
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 the following bindable keyboard command: |
73 | This extension also offers following bindable keyboard commands: |
63 | |
74 | |
64 | rot13 |
75 | rot13 |
65 | Rot-13 the selection when activated. Used via keyboard trigger: |
76 | Rot-13 the selection when activated. Used via keyboard trigger: |
66 | |
77 | |
67 | URxvt.keysym.C-M-r: perl:selection:rot13 |
78 | URxvt.keysym.C-M-r: perl:selection:rot13 |
68 | |
79 | |
69 | option-popup (enabled by default) |
80 | option-popup (enabled by default) |
70 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
81 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
71 | options at runtime. |
82 | options at runtime. |
72 | |
83 | |
|
|
84 | Other extensions can extend this popup menu by pushing a code |
|
|
85 | reference onto "@{ $term-"{option_popup_hook} }>, which gets called |
|
|
86 | whenever the popup is being displayed. |
|
|
87 | |
|
|
88 | It's sole argument is the popup menu, which can be modified. It |
|
|
89 | should either return nothing or a string, the initial boolean value |
|
|
90 | and a code reference. The string will be used as button text and the |
|
|
91 | code reference will be called when the toggle changes, with the new |
|
|
92 | boolean value as first argument. |
|
|
93 | |
|
|
94 | The following will add an entry "myoption" that changes |
|
|
95 | "$self-"{myoption}>: |
|
|
96 | |
|
|
97 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
98 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
99 | }; |
|
|
100 | |
73 | selection-popup (enabled by default) |
101 | selection-popup (enabled by default) |
74 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
102 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
75 | selection text into various other formats/action (such as uri |
103 | selection text into various other formats/action (such as uri |
76 | unescaping, perl evalution, web-browser starting etc.), depending on |
104 | unescaping, perl evaluation, web-browser starting etc.), depending |
77 | content. |
105 | on content. |
|
|
106 | |
|
|
107 | Other extensions can extend this popup menu by pushing a code |
|
|
108 | reference onto "@{ $term-"{selection_popup_hook} }>, which gets |
|
|
109 | called whenever the popup is being displayed. |
|
|
110 | |
|
|
111 | It's sole argument is the popup menu, which can be modified. The |
|
|
112 | selection is in $_, which can be used to decide wether to add |
|
|
113 | something or not. It should either return nothing or a string and a |
|
|
114 | code reference. The string will be used as button text and the code |
|
|
115 | reference will be called when the button gets activated and should |
|
|
116 | transform $_. |
|
|
117 | |
|
|
118 | The following will add an entry "a to b" that transforms all "a"s in |
|
|
119 | the selection to "b"s, but only if the selection currently contains |
|
|
120 | any "a"s: |
|
|
121 | |
|
|
122 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
123 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
124 | : () |
|
|
125 | }; |
78 | |
126 | |
79 | searchable-scrollback<hotkey> (enabled by default) |
127 | searchable-scrollback<hotkey> (enabled by default) |
80 | Adds regex search functionality to the scrollback buffer, triggered |
128 | Adds regex search functionality to the scrollback buffer, triggered |
81 | by a hotkey (default: "M-s"). While in search mode, normal terminal |
129 | by a hotkey (default: "M-s"). While in search mode, normal terminal |
82 | input/output is suspended and a regex is displayed at the bottom of |
130 | input/output is suspended and a regex is displayed at the bottom of |
… | |
… | |
88 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
136 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
89 | to the point where search was started, while "Enter" or "Return" |
137 | to the point where search was started, while "Enter" or "Return" |
90 | stay at the current position and additionally stores the first match |
138 | stay at the current position and additionally stores the first match |
91 | in the current line into the primary selection. |
139 | in the current line into the primary selection. |
92 | |
140 | |
|
|
141 | readline (enabled by default) |
|
|
142 | A support package that tries to make editing with readline easier. |
|
|
143 | At the moment, it reacts to clicking shift-left mouse button by |
|
|
144 | trying to move the text cursor to this position. It does so by |
|
|
145 | generating as many cursor-left or cursor-right keypresses as |
|
|
146 | required (the this only works for programs that correctly support |
|
|
147 | wide characters). |
|
|
148 | |
|
|
149 | To avoid too many false positives, this is only done when: |
|
|
150 | |
|
|
151 | - the tty is in ICANON state. |
|
|
152 | - the text cursor is visible. |
|
|
153 | - the primary screen is currently being displayed. |
|
|
154 | - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
155 | |
|
|
156 | The normal selection mechanism isn't disabled, so quick successive |
|
|
157 | clicks might interfere with selection creation in harmless ways. |
|
|
158 | |
93 | selection-autotransform |
159 | selection-autotransform |
94 | This selection allows you to do automatic transforms on a selection |
160 | This selection allows you to do automatic transforms on a selection |
95 | whenever a selection is made. |
161 | whenever a selection is made. |
96 | |
162 | |
97 | It works by specifying perl snippets (most useful is a single "s///" |
163 | It works by specifying perl snippets (most useful is a single "s///" |
… | |
… | |
108 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
174 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
109 | |
175 | |
110 | And this example matches the same,but replaces it with vi-commands |
176 | And this example matches the same,but replaces it with vi-commands |
111 | you can paste directly into your (vi :) editor: |
177 | you can paste directly into your (vi :) editor: |
112 | |
178 | |
113 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
179 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
114 | |
180 | |
115 | Of course, this can be modified to suit your needs and your editor |
181 | Of course, this can be modified to suit your needs and your editor |
116 | :) |
182 | :) |
117 | |
183 | |
118 | To expand the example above to typical perl error messages ("XXX at |
184 | To expand the example above to typical perl error messages ("XXX at |
119 | FILENAME line YYY."), you need a slightly more elaborate solution: |
185 | FILENAME line YYY."), you need a slightly more elaborate solution: |
120 | |
186 | |
121 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
187 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
122 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
188 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
123 | |
189 | |
124 | The first line tells the selection code to treat the unchanging part |
190 | The first line tells the selection code to treat the unchanging part |
125 | of every error message as a selection pattern, and the second line |
191 | of every error message as a selection pattern, and the second line |
126 | transforms the message into vi commands to load the file. |
192 | transforms the message into vi commands to load the file. |
|
|
193 | |
|
|
194 | tabbed |
|
|
195 | This transforms the terminal into a tabbar with additional |
|
|
196 | terminals, that is, it implements what is commonly refered to as |
|
|
197 | "tabbed terminal". The topmost line displays a "[NEW]" button, |
|
|
198 | which, when clicked, will add a new tab, followed by one button per |
|
|
199 | tab. |
|
|
200 | |
|
|
201 | Clicking a button will activate that tab. Pressing Shift-Left and |
|
|
202 | Shift-Right will switch to the tab left or right of the current one, |
|
|
203 | while Shift-Down creates a new tab. |
|
|
204 | |
|
|
205 | The tabbar itself can be configured similarly to a normal terminal, |
|
|
206 | but with a resource class of "URxvt.tabbed". In addition, it |
|
|
207 | supports the following four resources (shown with defaults): |
|
|
208 | |
|
|
209 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
210 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
211 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
212 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
213 | |
|
|
214 | See *COLOR AND GRAPHICS* in the rxvt(1) manpage for valid indices. |
127 | |
215 | |
128 | mark-urls |
216 | mark-urls |
129 | Uses per-line display filtering ("on_line_update") to underline urls |
217 | Uses per-line display filtering ("on_line_update") to underline urls |
130 | and make them clickable. When middle-clicked, the program specified |
218 | and make them clickable. When middle-clicked, the program specified |
131 | in the resource "urlLauncher" (default "x-www-browser") will be |
219 | in the resource "urlLauncher" (default "x-www-browser") will be |
132 | started with the URL as first argument. |
220 | started with the URL as first argument. |
133 | |
221 | |
|
|
222 | xim-onthespot |
|
|
223 | This (experimental) perl extension implements OnTheSpot editing. It |
|
|
224 | does not work perfectly, and some input methods don't seem to work |
|
|
225 | well with OnTheSpot editing in general, but it seems to work at |
|
|
226 | leats for SCIM and kinput2. |
|
|
227 | |
|
|
228 | You enable it by specifying this extension and a preedit style of |
|
|
229 | "OnTheSpot", i.e.: |
|
|
230 | |
|
|
231 | rxvt -pt OnTheSpot -pe xim-onthespot |
|
|
232 | |
|
|
233 | automove-background |
|
|
234 | This is basically a one-line extension that dynamically changes the |
|
|
235 | background pixmap offset to the window position, in effect creating |
|
|
236 | the same effect as pseudo transparency with a custom pixmap. No |
|
|
237 | scaling is supported in this mode. Exmaple: |
|
|
238 | |
|
|
239 | rxvt -pixmap background.xpm -pe automove-background |
|
|
240 | |
134 | block-graphics-to-ascii |
241 | block-graphics-to-ascii |
135 | A not very useful example of filtering all text output to the |
242 | A not very useful example of filtering all text output to the |
136 | terminal, by replacing all line-drawing characters (U+2500 .. |
243 | terminal, by replacing all line-drawing characters (U+2500 .. |
137 | U+259F) by a similar-looking ascii character. |
244 | U+259F) by a similar-looking ascii character. |
138 | |
245 | |
139 | digital-clock |
246 | digital-clock |
140 | Displays a digital clock using the built-in overlay. |
247 | Displays a digital clock using the built-in overlay. |
|
|
248 | |
|
|
249 | remote-clipboard |
|
|
250 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
251 | selection popup that allows one ti run external commands to store |
|
|
252 | the selection somewhere and fetch it again. |
|
|
253 | |
|
|
254 | We use it to implement a "distributed selection mechanism", which |
|
|
255 | just means that one command uploads the file to a remote server, and |
|
|
256 | another reads it. |
|
|
257 | |
|
|
258 | The commands can be set using the "URxvt.remote-selection.store" and |
|
|
259 | "URxvt.remote-selection.fetch" resources. The first should read the |
|
|
260 | selection to store from STDIN (always in UTF-8), the second should |
|
|
261 | provide the selection data on STDOUT (also in UTF-8). |
|
|
262 | |
|
|
263 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
264 | |
|
|
265 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
266 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
267 | |
|
|
268 | selection-pastebin |
|
|
269 | This is a little rarely useful extension that Uploads the selection |
|
|
270 | as textfile to a remote site (or does other things). (The |
|
|
271 | implementation is not currently secure for use in a multiuser |
|
|
272 | environment as it writes to /tmp directly.). |
|
|
273 | |
|
|
274 | It listens to the "selection-pastebin:remote-pastebin" keyboard |
|
|
275 | command, i.e. |
|
|
276 | |
|
|
277 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
278 | |
|
|
279 | Pressing this combination runs a command with "%" replaced by the |
|
|
280 | name of the textfile. This command can be set via a resource: |
|
|
281 | |
|
|
282 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
283 | |
|
|
284 | And the default is likely not useful to anybody but the few people |
|
|
285 | around here :) |
|
|
286 | |
|
|
287 | The name of the textfile is the hex encoded md5 sum of the |
|
|
288 | selection, so the same content should lead to the same filename. |
|
|
289 | |
|
|
290 | After a successful upload the selection will be replaced by the text |
|
|
291 | given in the "selection-pastebin-url" resource (again, the % is the |
|
|
292 | placeholder for the filename): |
|
|
293 | |
|
|
294 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
141 | |
295 | |
142 | example-refresh-hooks |
296 | example-refresh-hooks |
143 | Displays a very simple digital clock in the upper right corner of |
297 | Displays a very simple digital clock in the upper right corner of |
144 | the window. Illustrates overwriting the refresh callbacks to create |
298 | the window. Illustrates overwriting the refresh callbacks to create |
145 | your own overlays or changes. |
299 | your own overlays or changes. |
… | |
… | |
204 | be called whenever the relevant event happens. |
358 | be called whenever the relevant event happens. |
205 | |
359 | |
206 | The first argument passed to them is an extension oject as described in |
360 | The first argument passed to them is an extension oject as described in |
207 | the in the "Extension Objects" section. |
361 | the in the "Extension Objects" section. |
208 | |
362 | |
209 | All of these hooks must return a boolean value. If it is true, then the |
363 | All of these hooks must return a boolean value. If any of the called |
210 | event counts as being *consumed*, and the invocation of other hooks is |
364 | hooks returns true, then the event counts as being *consumed*, and the |
211 | skipped, and the relevant action might not be carried out by the C++ |
365 | relevant action might not be carried out by the C++ code. |
212 | code. |
|
|
213 | |
366 | |
214 | *When in doubt, return a false value (preferably "()").* |
367 | *When in doubt, return a false value (preferably "()").* |
215 | |
368 | |
216 | on_init $term |
369 | on_init $term |
217 | Called after a new terminal object has been initialized, but before |
370 | Called after a new terminal object has been initialized, but before |
218 | windows are created or the command gets run. Most methods are unsafe |
371 | windows are created or the command gets run. Most methods are unsafe |
219 | to call or deliver senseless data, as terminal size and other |
372 | to call or deliver senseless data, as terminal size and other |
220 | characteristics have not yet been determined. You can safely query |
373 | characteristics have not yet been determined. You can safely query |
221 | and change resources, though. |
374 | and change resources and options, though. For many purposes the |
|
|
375 | "on_start" hook is a better place. |
|
|
376 | |
|
|
377 | on_start $term |
|
|
378 | Called at the very end of initialisation of a new terminal, just |
|
|
379 | before trying to map (display) the toplevel and returning to the |
|
|
380 | mainloop. |
|
|
381 | |
|
|
382 | on_destroy $term |
|
|
383 | Called whenever something tries to destroy terminal, when the |
|
|
384 | terminal is still fully functional (not for long, though). |
222 | |
385 | |
223 | on_reset $term |
386 | on_reset $term |
224 | Called after the screen is "reset" for any reason, such as resizing |
387 | Called after the screen is "reset" for any reason, such as resizing |
225 | or control sequences. Here is where you can react on changes to |
388 | or control sequences. Here is where you can react on changes to |
226 | size-related variables. |
389 | size-related variables. |
227 | |
390 | |
228 | on_start $term |
391 | on_child_start $term, $pid |
229 | Called at the very end of initialisation of a new terminal, just |
392 | Called just after the child process has been "fork"ed. |
230 | before returning to the mainloop. |
393 | |
|
|
394 | on_child_exit $term, $status |
|
|
395 | Called just after the child process has exited. $status is the |
|
|
396 | status from "waitpid". |
231 | |
397 | |
232 | on_sel_make $term, $eventtime |
398 | on_sel_make $term, $eventtime |
233 | Called whenever a selection has been made by the user, but before |
399 | Called whenever a selection has been made by the user, but before |
234 | the selection text is copied, so changes to the beginning, end or |
400 | the selection text is copied, so changes to the beginning, end or |
235 | type of the selection will be honored. |
401 | type of the selection will be honored. |
… | |
… | |
315 | display code is run after this hook, and takes precedence. |
481 | display code is run after this hook, and takes precedence. |
316 | |
482 | |
317 | on_refresh_end $term |
483 | on_refresh_end $term |
318 | Called just after the screen gets redrawn. See "on_refresh_begin". |
484 | Called just after the screen gets redrawn. See "on_refresh_begin". |
319 | |
485 | |
320 | on_keyboard_command $term, $string |
486 | on_user_command $term, $string |
321 | Called whenever the user presses a key combination that has a |
487 | Called whenever the a user-configured event is being activated (e.g. |
322 | "perl:string" action bound to it (see description of the keysym |
488 | via a "perl:string" action bound to a key, see description of the |
323 | resource in the rxvt(1) manpage). |
489 | keysym resource in the rxvt(1) manpage). |
|
|
490 | |
|
|
491 | The event is simply the action string. This interface is assumed to |
|
|
492 | change slightly in the future. |
|
|
493 | |
|
|
494 | on_resize_all_windows $tern, $new_width, $new_height |
|
|
495 | Called just after the new window size has been calculcated, but |
|
|
496 | before windows are actually being resized or hints are being set. If |
|
|
497 | this hook returns TRUE, setting of the window hints is being |
|
|
498 | skipped. |
324 | |
499 | |
325 | on_x_event $term, $event |
500 | on_x_event $term, $event |
326 | Called on every X event received on the vt window (and possibly |
501 | Called on every X event received on the vt window (and possibly |
327 | other windows). Should only be used as a last resort. Most event |
502 | other windows). Should only be used as a last resort. Most event |
328 | structure members are not passed. |
503 | structure members are not passed. |
… | |
… | |
333 | |
508 | |
334 | on_focus_out $term |
509 | on_focus_out $term |
335 | Called wheneever the window loses keyboard focus, before |
510 | Called wheneever the window loses keyboard focus, before |
336 | rxvt-unicode does focus out processing. |
511 | rxvt-unicode does focus out processing. |
337 | |
512 | |
|
|
513 | on_configure_notify $term, $event |
|
|
514 | on_property_notify $term, $event |
338 | on_key_press $term, $event, $keysym, $octets |
515 | on_key_press $term, $event, $keysym, $octets |
339 | on_key_release $term, $event, $keysym |
516 | on_key_release $term, $event, $keysym |
340 | on_button_press $term, $event |
517 | on_button_press $term, $event |
341 | on_button_release $term, $event |
518 | on_button_release $term, $event |
342 | on_motion_notify $term, $event |
519 | on_motion_notify $term, $event |
… | |
… | |
346 | terminal If the hook returns true, then the even will be ignored by |
523 | terminal If the hook returns true, then the even will be ignored by |
347 | rxvt-unicode. |
524 | rxvt-unicode. |
348 | |
525 | |
349 | The event is a hash with most values as named by Xlib (see the |
526 | The event is a hash with most values as named by Xlib (see the |
350 | XEvent manpage), with the additional members "row" and "col", which |
527 | XEvent manpage), with the additional members "row" and "col", which |
351 | are the row and column under the mouse cursor. |
528 | are the (real, not screen-based) row and column under the mouse |
|
|
529 | cursor. |
352 | |
530 | |
353 | "on_key_press" additionally receives the string rxvt-unicode would |
531 | "on_key_press" additionally receives the string rxvt-unicode would |
354 | output, if any, in locale-specific encoding. |
532 | output, if any, in locale-specific encoding. |
355 | |
533 | |
356 | subwindow. |
534 | subwindow. |
|
|
535 | |
|
|
536 | on_client_message $term, $event |
|
|
537 | on_wm_protocols $term, $event |
|
|
538 | on_wm_delete_window $term, $event |
|
|
539 | Called when various types of ClientMessage events are received (all |
|
|
540 | with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
357 | |
541 | |
358 | Variables in the "urxvt" Package |
542 | Variables in the "urxvt" Package |
359 | $urxvt::LIBDIR |
543 | $urxvt::LIBDIR |
360 | The rxvt-unicode library directory, where, among other things, the |
544 | The rxvt-unicode library directory, where, among other things, the |
361 | perl modules and scripts are stored. |
545 | perl modules and scripts are stored. |
… | |
… | |
368 | The basename of the installed binaries, usually "urxvt". |
552 | The basename of the installed binaries, usually "urxvt". |
369 | |
553 | |
370 | $urxvt::TERM |
554 | $urxvt::TERM |
371 | The current terminal. This variable stores the current "urxvt::term" |
555 | The current terminal. This variable stores the current "urxvt::term" |
372 | object, whenever a callback/hook is executing. |
556 | object, whenever a callback/hook is executing. |
|
|
557 | |
|
|
558 | @urxvt::TERM_INIT |
|
|
559 | All coderefs in this array will be called as methods of the next |
|
|
560 | newly created "urxvt::term" object (during the "on_init" phase). The |
|
|
561 | array gets cleared before the codereferences that were in it are |
|
|
562 | being executed, so coderefs can push themselves onto it again if |
|
|
563 | they so desire. |
|
|
564 | |
|
|
565 | This complements to the perl-eval commandline option, but gets |
|
|
566 | executed first. |
|
|
567 | |
|
|
568 | @urxvt::TERM_EXT |
|
|
569 | Works similar to @TERM_INIT, but contains perl package/class names, |
|
|
570 | which get registered as normal extensions after calling the hooks in |
|
|
571 | @TERM_INIT but before other extensions. Gets cleared just like |
|
|
572 | @TERM_INIT. |
373 | |
573 | |
374 | Functions in the "urxvt" Package |
574 | Functions in the "urxvt" Package |
375 | urxvt::fatal $errormessage |
575 | urxvt::fatal $errormessage |
376 | Fatally aborts execution with the given error message. Avoid at all |
576 | Fatally aborts execution with the given error message. Avoid at all |
377 | costs! The only time this is acceptable is when the terminal process |
577 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
385 | Using this function has the advantage that its output ends up in the |
585 | Using this function has the advantage that its output ends up in the |
386 | correct place, e.g. on stderr of the connecting urxvtc client. |
586 | correct place, e.g. on stderr of the connecting urxvtc client. |
387 | |
587 | |
388 | Messages have a size limit of 1023 bytes currently. |
588 | Messages have a size limit of 1023 bytes currently. |
389 | |
589 | |
390 | $is_safe = urxvt::safe |
590 | @terms = urxvt::termlist |
391 | Returns true when it is safe to do potentially unsafe things, such |
591 | Returns all urxvt::term objects that exist in this process, |
392 | as evaluating perl code specified by the user. This is true when |
592 | regardless of wether they are started, being destroyed etc., so be |
393 | urxvt was started setuid or setgid. |
593 | careful. Only term objects that have perl extensions attached will |
|
|
594 | be returned (because there is no urxvt::term objet associated with |
|
|
595 | others). |
394 | |
596 | |
395 | $time = urxvt::NOW |
597 | $time = urxvt::NOW |
396 | Returns the "current time" (as per the event loop). |
598 | Returns the "current time" (as per the event loop). |
397 | |
599 | |
398 | urxvt::CurrentTime |
600 | urxvt::CurrentTime |
… | |
… | |
442 | $background = urxvt::GET_BASEBG $rend |
644 | $background = urxvt::GET_BASEBG $rend |
443 | Return the foreground/background colour index, respectively. |
645 | Return the foreground/background colour index, respectively. |
444 | |
646 | |
445 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
647 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
446 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
648 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
649 | $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
447 | Replace the foreground/background colour in the rendition mask with |
650 | Replace the foreground/background colour in the rendition mask with |
448 | the specified one. |
651 | the specified one. |
449 | |
652 | |
450 | $value = urxvt::GET_CUSTOM $rend |
653 | $value = urxvt::GET_CUSTOM $rend |
451 | Return the "custom" value: Every rendition has 5 bits for use by |
654 | Return the "custom" value: Every rendition has 5 bits for use by |
… | |
… | |
470 | %ENV-like hash which defines the environment of the new terminal. |
673 | %ENV-like hash which defines the environment of the new terminal. |
471 | |
674 | |
472 | Croaks (and probably outputs an error message) if the new instance |
675 | Croaks (and probably outputs an error message) if the new instance |
473 | couldn't be created. Returns "undef" if the new instance didn't |
676 | couldn't be created. Returns "undef" if the new instance didn't |
474 | initialise perl, and the terminal object otherwise. The "init" and |
677 | initialise perl, and the terminal object otherwise. The "init" and |
475 | "start" hooks will be called during this call. |
678 | "start" hooks will be called before this call returns, and are free |
|
|
679 | to refer to global data (which is race free). |
476 | |
680 | |
477 | $term->destroy |
681 | $term->destroy |
478 | Destroy the terminal object (close the window, free resources etc.). |
682 | Destroy the terminal object (close the window, free resources etc.). |
479 | Please note that rxvt will not exit as long as any event watchers |
683 | Please note that rxvt will not exit as long as any event watchers |
480 | (timers, io watchers) are still active. |
684 | (timers, io watchers) are still active. |
|
|
685 | |
|
|
686 | $term->exec_async ($cmd[, @args]) |
|
|
687 | Works like the combination of the "fork"/"exec" builtins, which |
|
|
688 | executes ("starts") programs in the background. This function takes |
|
|
689 | care of setting the user environment before exec'ing the command |
|
|
690 | (e.g. "PATH") and should be preferred over explicit calls to "exec" |
|
|
691 | or "system". |
|
|
692 | |
|
|
693 | Returns the pid of the subprocess or "undef" on error. |
481 | |
694 | |
482 | $isset = $term->option ($optval[, $set]) |
695 | $isset = $term->option ($optval[, $set]) |
483 | Returns true if the option specified by $optval is enabled, and |
696 | Returns true if the option specified by $optval is enabled, and |
484 | optionally change it. All option values are stored by name in the |
697 | optionally change it. All option values are stored by name in the |
485 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
698 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
… | |
… | |
488 | Here is a a likely non-exhaustive list of option names, please see |
701 | Here is a a likely non-exhaustive list of option names, please see |
489 | the source file /src/optinc.h to see the actual list: |
702 | the source file /src/optinc.h to see the actual list: |
490 | |
703 | |
491 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
704 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
492 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
705 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
493 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
706 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
494 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
707 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
495 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
708 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
496 | tripleclickwords utmpInhibit visualBell |
709 | transparent tripleclickwords utmpInhibit visualBell |
497 | |
710 | |
498 | $value = $term->resource ($name[, $newval]) |
711 | $value = $term->resource ($name[, $newval]) |
499 | Returns the current resource value associated with a given name and |
712 | Returns the current resource value associated with a given name and |
500 | optionally sets a new value. Setting values is most useful in the |
713 | optionally sets a new value. Setting values is most useful in the |
501 | "init" hook. Unset resources are returned and accepted as "undef". |
714 | "init" hook. Unset resources are returned and accepted as "undef". |
… | |
… | |
518 | |
731 | |
519 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
732 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
520 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
733 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
521 | display_name embed ext_bwidth fade font geometry hold iconName |
734 | display_name embed ext_bwidth fade font geometry hold iconName |
522 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
735 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
523 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
736 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
524 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
737 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
525 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
738 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
526 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
739 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
527 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
740 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
528 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
741 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
|
|
742 | secondaryScreen secondaryScroll selectstyle shade term_name title |
529 | shade term_name title transparent transparent_all tripleclickwords |
743 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
530 | utmpInhibit visualBell |
744 | visualBell |
531 | |
745 | |
532 | $value = $term->x_resource ($pattern) |
746 | $value = $term->x_resource ($pattern) |
533 | Returns the X-Resource for the given pattern, excluding the program |
747 | Returns the X-Resource for the given pattern, excluding the program |
534 | or class name, i.e. "$term->x_resource ("boldFont")" should return |
748 | or class name, i.e. "$term->x_resource ("boldFont")" should return |
535 | the same value as used by this instance of rxvt-unicode. Returns |
749 | the same value as used by this instance of rxvt-unicode. Returns |
… | |
… | |
646 | |
860 | |
647 | Normally its not a good idea to use this function, as programs might |
861 | Normally its not a good idea to use this function, as programs might |
648 | be confused by changes in cursor position or scrolling. Its useful |
862 | be confused by changes in cursor position or scrolling. Its useful |
649 | inside a "on_add_lines" hook, though. |
863 | inside a "on_add_lines" hook, though. |
650 | |
864 | |
|
|
865 | $term->scr_change_screen ($screen) |
|
|
866 | Switch to given screen - 0 primary, 1 secondary. |
|
|
867 | |
651 | $term->cmd_parse ($octets) |
868 | $term->cmd_parse ($octets) |
652 | Similar to "scr_add_lines", but the argument must be in the |
869 | Similar to "scr_add_lines", but the argument must be in the |
653 | locale-specific encoding of the terminal and can contain command |
870 | locale-specific encoding of the terminal and can contain command |
654 | sequences (escape codes) that will be interpreted. |
871 | sequences (escape codes) that will be interpreted. |
655 | |
872 | |
… | |
… | |
663 | Replaces the event mask of the pty watcher by the given event mask. |
880 | Replaces the event mask of the pty watcher by the given event mask. |
664 | Can be used to suppress input and output handling to the pty/tty. |
881 | Can be used to suppress input and output handling to the pty/tty. |
665 | See the description of "urxvt::timer->events". Make sure to always |
882 | See the description of "urxvt::timer->events". Make sure to always |
666 | restore the previous value. |
883 | restore the previous value. |
667 | |
884 | |
|
|
885 | $fd = $term->pty_fd |
|
|
886 | Returns the master file descriptor for the pty in use, or -1 if no |
|
|
887 | pty is used. |
|
|
888 | |
668 | $windowid = $term->parent |
889 | $windowid = $term->parent |
669 | Return the window id of the toplevel window. |
890 | Return the window id of the toplevel window. |
670 | |
891 | |
671 | $windowid = $term->vt |
892 | $windowid = $term->vt |
672 | Return the window id of the terminal window. |
893 | Return the window id of the terminal window. |
… | |
… | |
674 | $term->vt_emask_add ($x_event_mask) |
895 | $term->vt_emask_add ($x_event_mask) |
675 | Adds the specified events to the vt event mask. Useful e.g. when you |
896 | Adds the specified events to the vt event mask. Useful e.g. when you |
676 | want to receive pointer events all the times: |
897 | want to receive pointer events all the times: |
677 | |
898 | |
678 | $term->vt_emask_add (urxvt::PointerMotionMask); |
899 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
900 | |
|
|
901 | $term->focus_in |
|
|
902 | $term->focus_out |
|
|
903 | $term->key_press ($state, $keycode[, $time]) |
|
|
904 | $term->key_release ($state, $keycode[, $time]) |
|
|
905 | Deliver various fake events to to terminal. |
679 | |
906 | |
680 | $window_width = $term->width |
907 | $window_width = $term->width |
681 | $window_height = $term->height |
908 | $window_height = $term->height |
682 | $font_width = $term->fwidth |
909 | $font_width = $term->fwidth |
683 | $font_height = $term->fheight |
910 | $font_height = $term->fheight |
… | |
… | |
699 | |
926 | |
700 | $env = $term->env |
927 | $env = $term->env |
701 | Returns a copy of the environment in effect for the terminal as a |
928 | Returns a copy of the environment in effect for the terminal as a |
702 | hashref similar to "\%ENV". |
929 | hashref similar to "\%ENV". |
703 | |
930 | |
|
|
931 | @envv = $term->envv |
|
|
932 | Returns the environment as array of strings of the form "VAR=VALUE". |
|
|
933 | |
|
|
934 | @argv = $term->argv |
|
|
935 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
936 | includes the program name as first element. |
|
|
937 | |
704 | $modifiermask = $term->ModLevel3Mask |
938 | $modifiermask = $term->ModLevel3Mask |
705 | $modifiermask = $term->ModMetaMask |
939 | $modifiermask = $term->ModMetaMask |
706 | $modifiermask = $term->ModNumLockMask |
940 | $modifiermask = $term->ModNumLockMask |
707 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
941 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
708 | (often AltGr), the meta key (often Alt) and the num lock key, if |
942 | (often AltGr), the meta key (often Alt) and the num lock key, if |
709 | applicable. |
943 | applicable. |
710 | |
944 | |
|
|
945 | $screen = $term->current_screen |
|
|
946 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
947 | |
|
|
948 | $cursor_is_hidden = $term->hidden_cursor |
|
|
949 | Returns wether the cursor is currently hidden or not. |
|
|
950 | |
711 | $view_start = $term->view_start ([$newvalue]) |
951 | $view_start = $term->view_start ([$newvalue]) |
712 | Returns the row number of the topmost displayed line. Maximum value |
952 | Returns the row number of the topmost displayed line. Maximum value |
713 | is 0, which displays the normal terminal contents. Lower values |
953 | is 0, which displays the normal terminal contents. Lower values |
714 | scroll this many lines into the scrollback buffer. |
954 | scroll this many lines into the scrollback buffer. |
715 | |
955 | |
… | |
… | |
731 | line, starting at column $start_col (default 0), which is useful to |
971 | line, starting at column $start_col (default 0), which is useful to |
732 | replace only parts of a line. The font index in the rendition will |
972 | replace only parts of a line. The font index in the rendition will |
733 | automatically be updated. |
973 | automatically be updated. |
734 | |
974 | |
735 | $text is in a special encoding: tabs and wide characters that use |
975 | $text is in a special encoding: tabs and wide characters that use |
736 | more than one cell when displayed are padded with urxvt::NOCHAR |
976 | more than one cell when displayed are padded with $urxvt::NOCHAR |
737 | characters ("chr 65535"). Characters with combining characters and |
977 | (chr 65535) characters. Characters with combining characters and |
738 | other characters that do not fit into the normal tetx encoding will |
978 | other characters that do not fit into the normal tetx encoding will |
739 | be replaced with characters in the private use area. |
979 | be replaced with characters in the private use area. |
740 | |
980 | |
741 | You have to obey this encoding when changing text. The advantage is |
981 | You have to obey this encoding when changing text. The advantage is |
742 | that "substr" and similar functions work on screen cells and not on |
982 | that "substr" and similar functions work on screen cells and not on |
… | |
… | |
801 | |
1041 | |
802 | $string = $term->special_decode $text |
1042 | $string = $term->special_decode $text |
803 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1043 | Converts rxvt-unicodes text reprsentation into a perl string. See |
804 | "$term->ROW_t" for details. |
1044 | "$term->ROW_t" for details. |
805 | |
1045 | |
806 | $success = $term->grab_button ($button, $modifiermask) |
1046 | $success = $term->grab_button ($button, $modifiermask[, $window = |
|
|
1047 | $term->vt]) |
|
|
1048 | $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
807 | Registers a synchronous button grab. See the XGrabButton manpage. |
1049 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1050 | manpage. |
808 | |
1051 | |
809 | $success = $term->grab ($eventtime[, $sync]) |
1052 | $success = $term->grab ($eventtime[, $sync]) |
810 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1053 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
811 | synchronous ($sync is true). Also remembers the grab timestampe. |
1054 | synchronous ($sync is true). Also remembers the grab timestampe. |
812 | |
1055 | |
… | |
… | |
823 | $term->ungrab |
1066 | $term->ungrab |
824 | Calls XUngrab for the most recent grab. Is called automatically on |
1067 | Calls XUngrab for the most recent grab. Is called automatically on |
825 | evaluation errors, as it is better to lose the grab in the error |
1068 | evaluation errors, as it is better to lose the grab in the error |
826 | case as the session. |
1069 | case as the session. |
827 | |
1070 | |
|
|
1071 | $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1072 | $atom_name = $term->XGetAtomName ($atom) |
|
|
1073 | @atoms = $term->XListProperties ($window) |
|
|
1074 | ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1075 | $term->XChangeWindowProperty ($window, $property, $type, $format, |
|
|
1076 | $octets) |
|
|
1077 | $term->XDeleteProperty ($window, $property) |
|
|
1078 | $window = $term->DefaultRootWindow |
|
|
1079 | $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1080 | $term->XMapWindow ($window) |
|
|
1081 | $term->XUnmapWindow ($window) |
|
|
1082 | $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1083 | ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, |
|
|
1084 | $y) |
|
|
1085 | $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1086 | Various X or X-related functions. The $term object only serves as |
|
|
1087 | the source of the display, otherwise those functions map |
|
|
1088 | more-or-less directory onto the X functions of the same name. |
|
|
1089 | |
828 | The "urxvt::popup" Class |
1090 | The "urxvt::popup" Class |
829 | $popup->add_title ($title) |
1091 | $popup->add_title ($title) |
830 | Adds a non-clickable title to the popup. |
1092 | Adds a non-clickable title to the popup. |
831 | |
1093 | |
832 | $popup->add_separator ([$sepchr]) |
1094 | $popup->add_separator ([$sepchr]) |
… | |
… | |
835 | |
1097 | |
836 | $popup->add_button ($text, $cb) |
1098 | $popup->add_button ($text, $cb) |
837 | Adds a clickable button to the popup. $cb is called whenever it is |
1099 | Adds a clickable button to the popup. $cb is called whenever it is |
838 | selected. |
1100 | selected. |
839 | |
1101 | |
840 | $popup->add_toggle ($text, $cb, $initial_value) |
1102 | $popup->add_toggle ($text, $initial_value, $cb) |
841 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1103 | Adds a toggle/checkbox item to the popup. The callback gets called |
842 | whenever it gets toggled, with a boolean indicating its value as its |
1104 | whenever it gets toggled, with a boolean indicating its new value as |
843 | first argument. |
1105 | its first argument. |
844 | |
1106 | |
845 | $popup->show |
1107 | $popup->show |
846 | Displays the popup (which is initially hidden). |
1108 | Displays the popup (which is initially hidden). |
847 | |
1109 | |
848 | The "urxvt::timer" Class |
1110 | The "urxvt::timer" Class |
… | |
… | |
879 | $timer = $timer->start |
1141 | $timer = $timer->start |
880 | Start the timer. |
1142 | Start the timer. |
881 | |
1143 | |
882 | $timer = $timer->start ($tstamp) |
1144 | $timer = $timer->start ($tstamp) |
883 | Set the event trigger time to $tstamp and start the timer. |
1145 | Set the event trigger time to $tstamp and start the timer. |
|
|
1146 | |
|
|
1147 | $timer = $timer->after ($delay) |
|
|
1148 | Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>. |
884 | |
1149 | |
885 | $timer = $timer->stop |
1150 | $timer = $timer->stop |
886 | Stop the timer. |
1151 | Stop the timer. |
887 | |
1152 | |
888 | The "urxvt::iow" Class |
1153 | The "urxvt::iow" Class |
… | |
… | |
920 | Start watching for requested events on the given handle. |
1185 | Start watching for requested events on the given handle. |
921 | |
1186 | |
922 | $iow = $iow->stop |
1187 | $iow = $iow->stop |
923 | Stop watching for events on the given filehandle. |
1188 | Stop watching for events on the given filehandle. |
924 | |
1189 | |
|
|
1190 | The "urxvt::iw" Class |
|
|
1191 | This class implements idle watchers, that get called automatically when |
|
|
1192 | the process is idle. They should return as fast as possible, after doing |
|
|
1193 | some useful work. |
|
|
1194 | |
|
|
1195 | $iw = new urxvt::iw |
|
|
1196 | Create a new idle watcher object in stopped state. |
|
|
1197 | |
|
|
1198 | $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1199 | Set the callback to be called when the watcher triggers. |
|
|
1200 | |
|
|
1201 | $timer = $timer->start |
|
|
1202 | Start the watcher. |
|
|
1203 | |
|
|
1204 | $timer = $timer->stop |
|
|
1205 | Stop the watcher. |
|
|
1206 | |
|
|
1207 | The "urxvt::pw" Class |
|
|
1208 | This class implements process watchers. They create an event whenever a |
|
|
1209 | process exits, after which they stop automatically. |
|
|
1210 | |
|
|
1211 | my $pid = fork; |
|
|
1212 | ... |
|
|
1213 | $term->{pw} = urxvt::pw |
|
|
1214 | ->new |
|
|
1215 | ->start ($pid) |
|
|
1216 | ->cb (sub { |
|
|
1217 | my ($pw, $exit_status) = @_; |
|
|
1218 | ... |
|
|
1219 | }); |
|
|
1220 | |
|
|
1221 | $pw = new urxvt::pw |
|
|
1222 | Create a new process watcher in stopped state. |
|
|
1223 | |
|
|
1224 | $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1225 | Set the callback to be called when the timer triggers. |
|
|
1226 | |
|
|
1227 | $pw = $timer->start ($pid) |
|
|
1228 | Tells the wqtcher to start watching for process $pid. |
|
|
1229 | |
|
|
1230 | $pw = $pw->stop |
|
|
1231 | Stop the watcher. |
|
|
1232 | |
925 | ENVIRONMENT |
1233 | ENVIRONMENT |
926 | URXVT_PERL_VERBOSITY |
1234 | URXVT_PERL_VERBOSITY |
927 | This variable controls the verbosity level of the perl extension. Higher |
1235 | This variable controls the verbosity level of the perl extension. Higher |
928 | numbers indicate more verbose output. |
1236 | numbers indicate more verbose output. |
929 | |
1237 | |