… | |
… | |
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. |
|
|
89 | |
|
|
90 | Other extensions can extend this popup menu by pushing a code |
|
|
91 | reference onto "@{ $term-"{selection_popup_hook} }>, that is called |
|
|
92 | whenever the popup is displayed. |
|
|
93 | |
|
|
94 | It's sole argument is the popup menu, which can be modified. The |
|
|
95 | selection is in $_, which can be used to decide wether to add |
|
|
96 | something or not. It should either return nothing or a string and a |
|
|
97 | code reference. The string will be used as button text and the code |
|
|
98 | reference will be called when the button gets activated and should |
|
|
99 | transform $_. |
|
|
100 | |
|
|
101 | The following will add an entry "a to b" that transforms all "a"s in |
|
|
102 | the selection to "b"s, but only if the selection currently contains |
|
|
103 | any "a"s: |
|
|
104 | |
|
|
105 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
106 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
107 | : () |
|
|
108 | }; |
78 | |
109 | |
79 | searchable-scrollback<hotkey> (enabled by default) |
110 | searchable-scrollback<hotkey> (enabled by default) |
80 | Adds regex search functionality to the scrollback buffer, triggered |
111 | Adds regex search functionality to the scrollback buffer, triggered |
81 | by a hotkey (default: "M-s"). While in search mode, normal terminal |
112 | 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 |
113 | 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 |
119 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
89 | to the point where search was started, while "Enter" or "Return" |
120 | to the point where search was started, while "Enter" or "Return" |
90 | stay at the current position and additionally stores the first match |
121 | stay at the current position and additionally stores the first match |
91 | in the current line into the primary selection. |
122 | in the current line into the primary selection. |
92 | |
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 | |
93 | selection-autotransform |
142 | selection-autotransform |
94 | This selection allows you to do automatic transforms on a selection |
143 | This selection allows you to do automatic transforms on a selection |
95 | whenever a selection is made. |
144 | whenever a selection is made. |
96 | |
145 | |
97 | 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///" |
… | |
… | |
108 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
157 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
109 | |
158 | |
110 | And this example matches the same,but replaces it with vi-commands |
159 | And this example matches the same,but replaces it with vi-commands |
111 | you can paste directly into your (vi :) editor: |
160 | you can paste directly into your (vi :) editor: |
112 | |
161 | |
113 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
162 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
114 | |
163 | |
115 | Of course, this can be modified to suit your needs and your editor |
164 | Of course, this can be modified to suit your needs and your editor |
116 | :) |
165 | :) |
117 | |
166 | |
118 | To expand the example above to typical perl error messages ("XXX at |
167 | To expand the example above to typical perl error messages ("XXX at |
119 | FILENAME line YYY."), you need a slightly more elaborate solution: |
168 | FILENAME line YYY."), you need a slightly more elaborate solution: |
120 | |
169 | |
121 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
170 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
122 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
171 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
123 | |
172 | |
124 | 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 |
125 | 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 |
126 | 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. |
|
|
187 | |
|
|
188 | The tabbar itself can be configured similarly to a normal terminal, |
|
|
189 | but with a resource class of "URxvt.tabbed". In addition, it |
|
|
190 | supports the following four resources (shown with defaults): |
|
|
191 | |
|
|
192 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
193 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
194 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
195 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
196 | |
|
|
197 | See *COLOR AND GRAPHICS* in the rxvt(1) manpage for valid indices. |
127 | |
198 | |
128 | mark-urls |
199 | mark-urls |
129 | Uses per-line display filtering ("on_line_update") to underline urls |
200 | Uses per-line display filtering ("on_line_update") to underline urls |
130 | and make them clickable. When middle-clicked, the program specified |
201 | and make them clickable. When middle-clicked, the program specified |
131 | in the resource "urlLauncher" (default "x-www-browser") will be |
202 | in the resource "urlLauncher" (default "x-www-browser") will be |
132 | started with the URL as first argument. |
203 | started with the URL as first argument. |
133 | |
204 | |
|
|
205 | xim-onthespot |
|
|
206 | This (experimental) perl extension implements OnTheSpot editing. It |
|
|
207 | does not work perfectly, and some input methods don't seem to work |
|
|
208 | well with OnTheSpot editing in general, but it seems to work at |
|
|
209 | leats for SCIM and kinput2. |
|
|
210 | |
|
|
211 | You enable it by specifying this extension and a preedit style of |
|
|
212 | "OnTheSpot", i.e.: |
|
|
213 | |
|
|
214 | rxvt -pt OnTheSpot -pe xim-onthespot |
|
|
215 | |
|
|
216 | automove-background |
|
|
217 | This is basically a one-line extension that dynamically changes the |
|
|
218 | background pixmap offset to the window position, in effect creating |
|
|
219 | the same effect as pseudo transparency with a custom pixmap. No |
|
|
220 | scaling is supported in this mode. Exmaple: |
|
|
221 | |
|
|
222 | rxvt -pixmap background.xpm -pe automove-background |
|
|
223 | |
134 | block-graphics-to-ascii |
224 | block-graphics-to-ascii |
135 | A not very useful example of filtering all text output to the |
225 | A not very useful example of filtering all text output to the |
136 | terminal, by replacing all line-drawing characters (U+2500 .. |
226 | terminal, by replacing all line-drawing characters (U+2500 .. |
137 | U+259F) by a similar-looking ascii character. |
227 | U+259F) by a similar-looking ascii character. |
138 | |
228 | |
139 | digital-clock |
229 | digital-clock |
140 | Displays a digital clock using the built-in overlay. |
230 | Displays a digital clock using the built-in overlay. |
141 | |
231 | |
142 | example-refresh-hooks |
232 | remote-clipboard |
143 | Displays a very simple digital clock in the upper right corner of |
233 | Somewhat of a misnomer, this extension adds two menu entries to the |
144 | the window. Illustrates overwriting the refresh callbacks to create |
234 | selection popup that allows one ti run external commands to store |
145 | your own overlays or changes. |
235 | the selection somewhere and fetch it again. |
|
|
236 | |
|
|
237 | We use it to implement a "distributed selection mechanism", which |
|
|
238 | just means that one command uploads the file to a remote server, and |
|
|
239 | another reads it. |
|
|
240 | |
|
|
241 | The commands can be set using the "URxvt.remote-selection.store" and |
|
|
242 | "URxvt.remote-selection.fetch" resources. The first should read the |
|
|
243 | selection to store from STDIN (always in UTF-8), the second should |
|
|
244 | provide the selection data on STDOUT (also in UTF-8). |
|
|
245 | |
|
|
246 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
247 | |
|
|
248 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
249 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
146 | |
250 | |
147 | selection-pastebin |
251 | selection-pastebin |
148 | This is a little rarely useful extension that Uploads the selection |
252 | This is a little rarely useful extension that Uploads the selection |
149 | as textfile to a remote site (or does other things). (The |
253 | as textfile to a remote site (or does other things). (The |
150 | implementation is not currently secure for use in a multiuser |
254 | implementation is not currently secure for use in a multiuser |
… | |
… | |
169 | After a successful upload the selection will be replaced by the text |
273 | After a successful upload the selection will be replaced by the text |
170 | given in the "selection-pastebin-url" resource (again, the % is the |
274 | given in the "selection-pastebin-url" resource (again, the % is the |
171 | placeholder for the filename): |
275 | placeholder for the filename): |
172 | |
276 | |
173 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
277 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
|
|
278 | |
|
|
279 | example-refresh-hooks |
|
|
280 | Displays a very simple digital clock in the upper right corner of |
|
|
281 | the window. Illustrates overwriting the refresh callbacks to create |
|
|
282 | your own overlays or changes. |
174 | |
283 | |
175 | API DOCUMENTATION |
284 | API DOCUMENTATION |
176 | General API Considerations |
285 | General API Considerations |
177 | All objects (such as terminals, time watchers etc.) are typical |
286 | All objects (such as terminals, time watchers etc.) are typical |
178 | reference-to-hash objects. The hash can be used to store anything you |
287 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
232 | be called whenever the relevant event happens. |
341 | be called whenever the relevant event happens. |
233 | |
342 | |
234 | The first argument passed to them is an extension oject as described in |
343 | The first argument passed to them is an extension oject as described in |
235 | the in the "Extension Objects" section. |
344 | the in the "Extension Objects" section. |
236 | |
345 | |
237 | All of these hooks must return a boolean value. If it is true, then the |
346 | All of these hooks must return a boolean value. If any of the called |
238 | event counts as being *consumed*, and the invocation of other hooks is |
347 | hooks returns true, then the event counts as being *consumed*, and the |
239 | skipped, and the relevant action might not be carried out by the C++ |
348 | relevant action might not be carried out by the C++ code. |
240 | code. |
|
|
241 | |
349 | |
242 | *When in doubt, return a false value (preferably "()").* |
350 | *When in doubt, return a false value (preferably "()").* |
243 | |
351 | |
244 | on_init $term |
352 | on_init $term |
245 | Called after a new terminal object has been initialized, but before |
353 | Called after a new terminal object has been initialized, but before |
246 | windows are created or the command gets run. Most methods are unsafe |
354 | windows are created or the command gets run. Most methods are unsafe |
247 | to call or deliver senseless data, as terminal size and other |
355 | to call or deliver senseless data, as terminal size and other |
248 | characteristics have not yet been determined. You can safely query |
356 | characteristics have not yet been determined. You can safely query |
249 | and change resources, though. |
357 | and change resources and options, though. For many purposes the |
|
|
358 | "on_start" hook is a better place. |
|
|
359 | |
|
|
360 | on_start $term |
|
|
361 | Called at the very end of initialisation of a new terminal, just |
|
|
362 | before trying to map (display) the toplevel and returning to the |
|
|
363 | mainloop. |
|
|
364 | |
|
|
365 | on_destroy $term |
|
|
366 | Called whenever something tries to destroy terminal, when the |
|
|
367 | terminal is still fully functional (not for long, though). |
250 | |
368 | |
251 | on_reset $term |
369 | on_reset $term |
252 | Called after the screen is "reset" for any reason, such as resizing |
370 | Called after the screen is "reset" for any reason, such as resizing |
253 | or control sequences. Here is where you can react on changes to |
371 | or control sequences. Here is where you can react on changes to |
254 | size-related variables. |
372 | size-related variables. |
255 | |
373 | |
256 | on_start $term |
374 | on_child_start $term, $pid |
257 | Called at the very end of initialisation of a new terminal, just |
375 | Called just after the child process has been "fork"ed. |
258 | before returning to the mainloop. |
376 | |
|
|
377 | on_child_exit $term, $status |
|
|
378 | Called just after the child process has exited. $status is the |
|
|
379 | status from "waitpid". |
259 | |
380 | |
260 | on_sel_make $term, $eventtime |
381 | on_sel_make $term, $eventtime |
261 | Called whenever a selection has been made by the user, but before |
382 | Called whenever a selection has been made by the user, but before |
262 | the selection text is copied, so changes to the beginning, end or |
383 | the selection text is copied, so changes to the beginning, end or |
263 | type of the selection will be honored. |
384 | type of the selection will be honored. |
… | |
… | |
343 | display code is run after this hook, and takes precedence. |
464 | display code is run after this hook, and takes precedence. |
344 | |
465 | |
345 | on_refresh_end $term |
466 | on_refresh_end $term |
346 | Called just after the screen gets redrawn. See "on_refresh_begin". |
467 | Called just after the screen gets redrawn. See "on_refresh_begin". |
347 | |
468 | |
348 | on_keyboard_command $term, $string |
469 | on_user_command $term, $string |
349 | Called whenever the user presses a key combination that has a |
470 | Called whenever the a user-configured event is being activated (e.g. |
350 | "perl:string" action bound to it (see description of the keysym |
471 | via a "perl:string" action bound to a key, see description of the |
351 | resource in the rxvt(1) manpage). |
472 | keysym resource in the rxvt(1) manpage). |
|
|
473 | |
|
|
474 | The event is simply the action string. This interface is assumed to |
|
|
475 | change slightly in the future. |
352 | |
476 | |
353 | on_x_event $term, $event |
477 | on_x_event $term, $event |
354 | Called on every X event received on the vt window (and possibly |
478 | Called on every X event received on the vt window (and possibly |
355 | other windows). Should only be used as a last resort. Most event |
479 | other windows). Should only be used as a last resort. Most event |
356 | structure members are not passed. |
480 | structure members are not passed. |
… | |
… | |
361 | |
485 | |
362 | on_focus_out $term |
486 | on_focus_out $term |
363 | Called wheneever the window loses keyboard focus, before |
487 | Called wheneever the window loses keyboard focus, before |
364 | rxvt-unicode does focus out processing. |
488 | rxvt-unicode does focus out processing. |
365 | |
489 | |
|
|
490 | on_configure_notify $term, $event |
|
|
491 | on_property_notify $term, $event |
366 | on_key_press $term, $event, $keysym, $octets |
492 | on_key_press $term, $event, $keysym, $octets |
367 | on_key_release $term, $event, $keysym |
493 | on_key_release $term, $event, $keysym |
368 | on_button_press $term, $event |
494 | on_button_press $term, $event |
369 | on_button_release $term, $event |
495 | on_button_release $term, $event |
370 | on_motion_notify $term, $event |
496 | on_motion_notify $term, $event |
… | |
… | |
374 | terminal If the hook returns true, then the even will be ignored by |
500 | terminal If the hook returns true, then the even will be ignored by |
375 | rxvt-unicode. |
501 | rxvt-unicode. |
376 | |
502 | |
377 | The event is a hash with most values as named by Xlib (see the |
503 | The event is a hash with most values as named by Xlib (see the |
378 | XEvent manpage), with the additional members "row" and "col", which |
504 | XEvent manpage), with the additional members "row" and "col", which |
379 | are the row and column under the mouse cursor. |
505 | are the (real, not screen-based) row and column under the mouse |
|
|
506 | cursor. |
380 | |
507 | |
381 | "on_key_press" additionally receives the string rxvt-unicode would |
508 | "on_key_press" additionally receives the string rxvt-unicode would |
382 | output, if any, in locale-specific encoding. |
509 | output, if any, in locale-specific encoding. |
383 | |
510 | |
384 | subwindow. |
511 | subwindow. |
|
|
512 | |
|
|
513 | on_client_message $term, $event |
|
|
514 | on_wm_protocols $term, $event |
|
|
515 | on_wm_delete_window $term, $event |
|
|
516 | Called when various types of ClientMessage events are received (all |
|
|
517 | with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
385 | |
518 | |
386 | Variables in the "urxvt" Package |
519 | Variables in the "urxvt" Package |
387 | $urxvt::LIBDIR |
520 | $urxvt::LIBDIR |
388 | The rxvt-unicode library directory, where, among other things, the |
521 | The rxvt-unicode library directory, where, among other things, the |
389 | perl modules and scripts are stored. |
522 | perl modules and scripts are stored. |
… | |
… | |
396 | The basename of the installed binaries, usually "urxvt". |
529 | The basename of the installed binaries, usually "urxvt". |
397 | |
530 | |
398 | $urxvt::TERM |
531 | $urxvt::TERM |
399 | The current terminal. This variable stores the current "urxvt::term" |
532 | The current terminal. This variable stores the current "urxvt::term" |
400 | object, whenever a callback/hook is executing. |
533 | object, whenever a callback/hook is executing. |
|
|
534 | |
|
|
535 | @urxvt::TERM_INIT |
|
|
536 | All coderefs in this array will be called as methods of the next |
|
|
537 | newly created "urxvt::term" object (during the "on_init" phase). The |
|
|
538 | array gets cleared before the codereferences that were in it are |
|
|
539 | being executed, so coderefs can push themselves onto it again if |
|
|
540 | they so desire. |
|
|
541 | |
|
|
542 | This complements to the perl-eval commandline option, but gets |
|
|
543 | executed first. |
|
|
544 | |
|
|
545 | @urxvt::TERM_EXT |
|
|
546 | Works similar to @TERM_INIT, but contains perl package/class names, |
|
|
547 | which get registered as normal extensions after calling the hooks in |
|
|
548 | @TERM_INIT but before other extensions. Gets cleared just like |
|
|
549 | @TERM_INIT. |
401 | |
550 | |
402 | Functions in the "urxvt" Package |
551 | Functions in the "urxvt" Package |
403 | urxvt::fatal $errormessage |
552 | urxvt::fatal $errormessage |
404 | Fatally aborts execution with the given error message. Avoid at all |
553 | Fatally aborts execution with the given error message. Avoid at all |
405 | costs! The only time this is acceptable is when the terminal process |
554 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
412 | |
561 | |
413 | Using this function has the advantage that its output ends up in the |
562 | Using this function has the advantage that its output ends up in the |
414 | correct place, e.g. on stderr of the connecting urxvtc client. |
563 | correct place, e.g. on stderr of the connecting urxvtc client. |
415 | |
564 | |
416 | Messages have a size limit of 1023 bytes currently. |
565 | Messages have a size limit of 1023 bytes currently. |
|
|
566 | |
|
|
567 | @terms = urxvt::termlist |
|
|
568 | Returns all urxvt::term objects that exist in this process, |
|
|
569 | regardless of wether they are started, being destroyed etc., so be |
|
|
570 | careful. Only term objects that have perl extensions attached will |
|
|
571 | be returned (because there is no urxvt::term objet associated with |
|
|
572 | others). |
417 | |
573 | |
418 | $time = urxvt::NOW |
574 | $time = urxvt::NOW |
419 | Returns the "current time" (as per the event loop). |
575 | Returns the "current time" (as per the event loop). |
420 | |
576 | |
421 | urxvt::CurrentTime |
577 | urxvt::CurrentTime |
… | |
… | |
465 | $background = urxvt::GET_BASEBG $rend |
621 | $background = urxvt::GET_BASEBG $rend |
466 | Return the foreground/background colour index, respectively. |
622 | Return the foreground/background colour index, respectively. |
467 | |
623 | |
468 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
624 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
469 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
625 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
|
|
626 | $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
470 | Replace the foreground/background colour in the rendition mask with |
627 | Replace the foreground/background colour in the rendition mask with |
471 | the specified one. |
628 | the specified one. |
472 | |
629 | |
473 | $value = urxvt::GET_CUSTOM $rend |
630 | $value = urxvt::GET_CUSTOM $rend |
474 | Return the "custom" value: Every rendition has 5 bits for use by |
631 | Return the "custom" value: Every rendition has 5 bits for use by |
… | |
… | |
493 | %ENV-like hash which defines the environment of the new terminal. |
650 | %ENV-like hash which defines the environment of the new terminal. |
494 | |
651 | |
495 | Croaks (and probably outputs an error message) if the new instance |
652 | Croaks (and probably outputs an error message) if the new instance |
496 | couldn't be created. Returns "undef" if the new instance didn't |
653 | couldn't be created. Returns "undef" if the new instance didn't |
497 | initialise perl, and the terminal object otherwise. The "init" and |
654 | initialise perl, and the terminal object otherwise. The "init" and |
498 | "start" hooks will be called during this call. |
655 | "start" hooks will be called before this call returns, and are free |
|
|
656 | to refer to global data (which is race free). |
499 | |
657 | |
500 | $term->destroy |
658 | $term->destroy |
501 | Destroy the terminal object (close the window, free resources etc.). |
659 | Destroy the terminal object (close the window, free resources etc.). |
502 | Please note that rxvt will not exit as long as any event watchers |
660 | Please note that rxvt will not exit as long as any event watchers |
503 | (timers, io watchers) are still active. |
661 | (timers, io watchers) are still active. |
|
|
662 | |
|
|
663 | $term->exec_async ($cmd[, @args]) |
|
|
664 | Works like the combination of the "fork"/"exec" builtins, which |
|
|
665 | executes ("starts") programs in the background. This function takes |
|
|
666 | care of setting the user environment before exec'ing the command |
|
|
667 | (e.g. "PATH") and should be preferred over explicit calls to "exec" |
|
|
668 | or "system". |
|
|
669 | |
|
|
670 | Returns the pid of the subprocess or "undef" on error. |
504 | |
671 | |
505 | $isset = $term->option ($optval[, $set]) |
672 | $isset = $term->option ($optval[, $set]) |
506 | Returns true if the option specified by $optval is enabled, and |
673 | Returns true if the option specified by $optval is enabled, and |
507 | optionally change it. All option values are stored by name in the |
674 | optionally change it. All option values are stored by name in the |
508 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
675 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
… | |
… | |
511 | Here is a a likely non-exhaustive list of option names, please see |
678 | Here is a a likely non-exhaustive list of option names, please see |
512 | the source file /src/optinc.h to see the actual list: |
679 | the source file /src/optinc.h to see the actual list: |
513 | |
680 | |
514 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
681 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
515 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
682 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
516 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
683 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
517 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
684 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
518 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
685 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
519 | tripleclickwords utmpInhibit visualBell |
686 | transparent tripleclickwords utmpInhibit visualBell |
520 | |
687 | |
521 | $value = $term->resource ($name[, $newval]) |
688 | $value = $term->resource ($name[, $newval]) |
522 | Returns the current resource value associated with a given name and |
689 | Returns the current resource value associated with a given name and |
523 | optionally sets a new value. Setting values is most useful in the |
690 | optionally sets a new value. Setting values is most useful in the |
524 | "init" hook. Unset resources are returned and accepted as "undef". |
691 | "init" hook. Unset resources are returned and accepted as "undef". |
… | |
… | |
541 | |
708 | |
542 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
709 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
543 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
710 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
544 | display_name embed ext_bwidth fade font geometry hold iconName |
711 | display_name embed ext_bwidth fade font geometry hold iconName |
545 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
712 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
546 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
713 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
547 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
714 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
548 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
715 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
549 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
716 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
550 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
717 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
551 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
718 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
|
|
719 | secondaryScreen secondaryScroll selectstyle shade term_name title |
552 | shade term_name title transparent transparent_all tripleclickwords |
720 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
553 | utmpInhibit visualBell |
721 | visualBell |
554 | |
722 | |
555 | $value = $term->x_resource ($pattern) |
723 | $value = $term->x_resource ($pattern) |
556 | Returns the X-Resource for the given pattern, excluding the program |
724 | Returns the X-Resource for the given pattern, excluding the program |
557 | or class name, i.e. "$term->x_resource ("boldFont")" should return |
725 | or class name, i.e. "$term->x_resource ("boldFont")" should return |
558 | the same value as used by this instance of rxvt-unicode. Returns |
726 | the same value as used by this instance of rxvt-unicode. Returns |
… | |
… | |
669 | |
837 | |
670 | Normally its not a good idea to use this function, as programs might |
838 | Normally its not a good idea to use this function, as programs might |
671 | be confused by changes in cursor position or scrolling. Its useful |
839 | be confused by changes in cursor position or scrolling. Its useful |
672 | inside a "on_add_lines" hook, though. |
840 | inside a "on_add_lines" hook, though. |
673 | |
841 | |
|
|
842 | $term->scr_change_screen ($screen) |
|
|
843 | Switch to given screen - 0 primary, 1 secondary. |
|
|
844 | |
674 | $term->cmd_parse ($octets) |
845 | $term->cmd_parse ($octets) |
675 | Similar to "scr_add_lines", but the argument must be in the |
846 | Similar to "scr_add_lines", but the argument must be in the |
676 | locale-specific encoding of the terminal and can contain command |
847 | locale-specific encoding of the terminal and can contain command |
677 | sequences (escape codes) that will be interpreted. |
848 | sequences (escape codes) that will be interpreted. |
678 | |
849 | |
… | |
… | |
686 | Replaces the event mask of the pty watcher by the given event mask. |
857 | Replaces the event mask of the pty watcher by the given event mask. |
687 | Can be used to suppress input and output handling to the pty/tty. |
858 | Can be used to suppress input and output handling to the pty/tty. |
688 | See the description of "urxvt::timer->events". Make sure to always |
859 | See the description of "urxvt::timer->events". Make sure to always |
689 | restore the previous value. |
860 | restore the previous value. |
690 | |
861 | |
|
|
862 | $fd = $term->pty_fd |
|
|
863 | Returns the master file descriptor for the pty in use, or -1 if no |
|
|
864 | pty is used. |
|
|
865 | |
691 | $windowid = $term->parent |
866 | $windowid = $term->parent |
692 | Return the window id of the toplevel window. |
867 | Return the window id of the toplevel window. |
693 | |
868 | |
694 | $windowid = $term->vt |
869 | $windowid = $term->vt |
695 | Return the window id of the terminal window. |
870 | Return the window id of the terminal window. |
… | |
… | |
697 | $term->vt_emask_add ($x_event_mask) |
872 | $term->vt_emask_add ($x_event_mask) |
698 | Adds the specified events to the vt event mask. Useful e.g. when you |
873 | Adds the specified events to the vt event mask. Useful e.g. when you |
699 | want to receive pointer events all the times: |
874 | want to receive pointer events all the times: |
700 | |
875 | |
701 | $term->vt_emask_add (urxvt::PointerMotionMask); |
876 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
877 | |
|
|
878 | $term->focus_in |
|
|
879 | $term->focus_out |
|
|
880 | $term->key_press ($state, $keycode[, $time]) |
|
|
881 | $term->key_release ($state, $keycode[, $time]) |
|
|
882 | Deliver various fake events to to terminal. |
702 | |
883 | |
703 | $window_width = $term->width |
884 | $window_width = $term->width |
704 | $window_height = $term->height |
885 | $window_height = $term->height |
705 | $font_width = $term->fwidth |
886 | $font_width = $term->fwidth |
706 | $font_height = $term->fheight |
887 | $font_height = $term->fheight |
… | |
… | |
729 | $modifiermask = $term->ModNumLockMask |
910 | $modifiermask = $term->ModNumLockMask |
730 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
911 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
731 | (often AltGr), the meta key (often Alt) and the num lock key, if |
912 | (often AltGr), the meta key (often Alt) and the num lock key, if |
732 | applicable. |
913 | applicable. |
733 | |
914 | |
|
|
915 | $screen = $term->current_screen |
|
|
916 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
917 | |
|
|
918 | $cursor_is_hidden = $term->hidden_cursor |
|
|
919 | Returns wether the cursor is currently hidden or not. |
|
|
920 | |
734 | $view_start = $term->view_start ([$newvalue]) |
921 | $view_start = $term->view_start ([$newvalue]) |
735 | Returns the row number of the topmost displayed line. Maximum value |
922 | Returns the row number of the topmost displayed line. Maximum value |
736 | is 0, which displays the normal terminal contents. Lower values |
923 | is 0, which displays the normal terminal contents. Lower values |
737 | scroll this many lines into the scrollback buffer. |
924 | scroll this many lines into the scrollback buffer. |
738 | |
925 | |
… | |
… | |
754 | line, starting at column $start_col (default 0), which is useful to |
941 | line, starting at column $start_col (default 0), which is useful to |
755 | replace only parts of a line. The font index in the rendition will |
942 | replace only parts of a line. The font index in the rendition will |
756 | automatically be updated. |
943 | automatically be updated. |
757 | |
944 | |
758 | $text is in a special encoding: tabs and wide characters that use |
945 | $text is in a special encoding: tabs and wide characters that use |
759 | more than one cell when displayed are padded with urxvt::NOCHAR |
946 | more than one cell when displayed are padded with $urxvt::NOCHAR |
760 | characters ("chr 65535"). Characters with combining characters and |
947 | (chr 65535) characters. Characters with combining characters and |
761 | other characters that do not fit into the normal tetx encoding will |
948 | other characters that do not fit into the normal tetx encoding will |
762 | be replaced with characters in the private use area. |
949 | be replaced with characters in the private use area. |
763 | |
950 | |
764 | You have to obey this encoding when changing text. The advantage is |
951 | You have to obey this encoding when changing text. The advantage is |
765 | that "substr" and similar functions work on screen cells and not on |
952 | that "substr" and similar functions work on screen cells and not on |
… | |
… | |
824 | |
1011 | |
825 | $string = $term->special_decode $text |
1012 | $string = $term->special_decode $text |
826 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1013 | Converts rxvt-unicodes text reprsentation into a perl string. See |
827 | "$term->ROW_t" for details. |
1014 | "$term->ROW_t" for details. |
828 | |
1015 | |
829 | $success = $term->grab_button ($button, $modifiermask) |
1016 | $success = $term->grab_button ($button, $modifiermask[, $window = |
|
|
1017 | $term->vt]) |
|
|
1018 | $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
830 | Registers a synchronous button grab. See the XGrabButton manpage. |
1019 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1020 | manpage. |
831 | |
1021 | |
832 | $success = $term->grab ($eventtime[, $sync]) |
1022 | $success = $term->grab ($eventtime[, $sync]) |
833 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1023 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
834 | synchronous ($sync is true). Also remembers the grab timestampe. |
1024 | synchronous ($sync is true). Also remembers the grab timestampe. |
835 | |
1025 | |
… | |
… | |
845 | |
1035 | |
846 | $term->ungrab |
1036 | $term->ungrab |
847 | Calls XUngrab for the most recent grab. Is called automatically on |
1037 | Calls XUngrab for the most recent grab. Is called automatically on |
848 | evaluation errors, as it is better to lose the grab in the error |
1038 | evaluation errors, as it is better to lose the grab in the error |
849 | case as the session. |
1039 | case as the session. |
|
|
1040 | |
|
|
1041 | $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1042 | $atom_name = $term->XGetAtomName ($atom) |
|
|
1043 | @atoms = $term->XListProperties ($window) |
|
|
1044 | ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1045 | $term->XChangeWindowProperty ($window, $property, $type, $format, |
|
|
1046 | $octets) |
|
|
1047 | $term->XDeleteProperty ($window, $property) |
|
|
1048 | $window = $term->DefaultRootWindow |
|
|
1049 | $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1050 | $term->XMapWindow ($window) |
|
|
1051 | $term->XUnmapWindow ($window) |
|
|
1052 | $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1053 | ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, |
|
|
1054 | $y) |
|
|
1055 | $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1056 | Various X or X-related functions. The $term object only serves as |
|
|
1057 | the source of the display, otherwise those functions map |
|
|
1058 | more-or-less directory onto the X functions of the same name. |
850 | |
1059 | |
851 | The "urxvt::popup" Class |
1060 | The "urxvt::popup" Class |
852 | $popup->add_title ($title) |
1061 | $popup->add_title ($title) |
853 | Adds a non-clickable title to the popup. |
1062 | Adds a non-clickable title to the popup. |
854 | |
1063 | |
… | |
… | |
902 | $timer = $timer->start |
1111 | $timer = $timer->start |
903 | Start the timer. |
1112 | Start the timer. |
904 | |
1113 | |
905 | $timer = $timer->start ($tstamp) |
1114 | $timer = $timer->start ($tstamp) |
906 | Set the event trigger time to $tstamp and start the timer. |
1115 | Set the event trigger time to $tstamp and start the timer. |
|
|
1116 | |
|
|
1117 | $timer = $timer->after ($delay) |
|
|
1118 | Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>. |
907 | |
1119 | |
908 | $timer = $timer->stop |
1120 | $timer = $timer->stop |
909 | Stop the timer. |
1121 | Stop the timer. |
910 | |
1122 | |
911 | The "urxvt::iow" Class |
1123 | The "urxvt::iow" Class |
… | |
… | |
943 | Start watching for requested events on the given handle. |
1155 | Start watching for requested events on the given handle. |
944 | |
1156 | |
945 | $iow = $iow->stop |
1157 | $iow = $iow->stop |
946 | Stop watching for events on the given filehandle. |
1158 | Stop watching for events on the given filehandle. |
947 | |
1159 | |
|
|
1160 | The "urxvt::iw" Class |
|
|
1161 | This class implements idle watchers, that get called automatically when |
|
|
1162 | the process is idle. They should return as fast as possible, after doing |
|
|
1163 | some useful work. |
|
|
1164 | |
|
|
1165 | $iw = new urxvt::iw |
|
|
1166 | Create a new idle watcher object in stopped state. |
|
|
1167 | |
|
|
1168 | $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1169 | Set the callback to be called when the watcher triggers. |
|
|
1170 | |
|
|
1171 | $timer = $timer->start |
|
|
1172 | Start the watcher. |
|
|
1173 | |
|
|
1174 | $timer = $timer->stop |
|
|
1175 | Stop the watcher. |
|
|
1176 | |
|
|
1177 | The "urxvt::pw" Class |
|
|
1178 | This class implements process watchers. They create an event whenever a |
|
|
1179 | process exits, after which they stop automatically. |
|
|
1180 | |
|
|
1181 | my $pid = fork; |
|
|
1182 | ... |
|
|
1183 | $term->{pw} = urxvt::pw |
|
|
1184 | ->new |
|
|
1185 | ->start ($pid) |
|
|
1186 | ->cb (sub { |
|
|
1187 | my ($pw, $exit_status) = @_; |
|
|
1188 | ... |
|
|
1189 | }); |
|
|
1190 | |
|
|
1191 | $pw = new urxvt::pw |
|
|
1192 | Create a new process watcher in stopped state. |
|
|
1193 | |
|
|
1194 | $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1195 | Set the callback to be called when the timer triggers. |
|
|
1196 | |
|
|
1197 | $pw = $timer->start ($pid) |
|
|
1198 | Tells the wqtcher to start watching for process $pid. |
|
|
1199 | |
|
|
1200 | $pw = $pw->stop |
|
|
1201 | Stop the watcher. |
|
|
1202 | |
948 | ENVIRONMENT |
1203 | ENVIRONMENT |
949 | URXVT_PERL_VERBOSITY |
1204 | URXVT_PERL_VERBOSITY |
950 | This variable controls the verbosity level of the perl extension. Higher |
1205 | This variable controls the verbosity level of the perl extension. Higher |
951 | numbers indicate more verbose output. |
1206 | numbers indicate more verbose output. |
952 | |
1207 | |