… | |
… | |
21 | thus must be encoded as UTF-8. |
21 | thus must be encoded as UTF-8. |
22 | |
22 | |
23 | Each script will only ever be loaded once, even in rxvtd, where scripts |
23 | Each script will only ever be loaded once, even in rxvtd, where scripts |
24 | will be shared (but not enabled) for all terminals. |
24 | will be shared (but not enabled) for all terminals. |
25 | |
25 | |
26 | Prepackaged Extensions |
26 | PREPACKAGED EXTENSIONS |
27 | This section describes the extensiosn delivered with this version. You |
27 | This section describes the extensions delivered with this release. You |
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 | |
33 | |
34 | selection |
34 | selection (enabled by default) |
35 | Intelligent selection. This extension tries to be more intelligent |
35 | (More) intelligent selection. This extension tries to be more |
36 | when the user extends selections (double-click). Right now, it tries |
36 | intelligent when the user extends selections (double-click and |
37 | to select urls and complete shell-quoted arguments, which is very |
37 | further clicks). Right now, it tries to select words, urls and |
|
|
38 | complete shell-quoted arguments, which is very convenient, too, if |
38 | convenient, too, if your ls supports "--quoting-style=shell". |
39 | your ls supports "--quoting-style=shell". |
39 | |
40 | |
|
|
41 | A double-click usually selects the word under the cursor, further |
|
|
42 | clicks will enlarge the selection. |
|
|
43 | |
40 | It also offers the following bindable event: |
44 | It also offers the following bindable keyboard command: |
41 | |
45 | |
42 | rot13 |
46 | rot13 |
43 | Rot-13 the selection when activated. Used via keyboard trigger: |
47 | Rot-13 the selection when activated. Used via keyboard trigger: |
44 | |
48 | |
45 | URxvt.keysym.C-M-r: perl:selection:rot13 |
49 | URxvt.keysym.C-M-r: perl:selection:rot13 |
46 | |
50 | |
|
|
51 | option-popup (enabled by default) |
|
|
52 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
|
|
53 | options at runtime. |
|
|
54 | |
|
|
55 | selection-popup (enabled by default) |
|
|
56 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
|
|
57 | selection text into various other formats/action (such as uri |
|
|
58 | unescaping, perl evalution, web-browser starting etc.), depending on |
|
|
59 | content. |
|
|
60 | |
|
|
61 | searchable-scrollback<hotkey> (enabled by default) |
|
|
62 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
63 | by a hotkey (default: "M-s"). While in search mode, normal terminal |
|
|
64 | input/output is suspended and a regex is displayed at the bottom of |
|
|
65 | the screen. |
|
|
66 | |
|
|
67 | Inputting characters appends them to the regex and continues |
|
|
68 | incremental search. "BackSpace" removes a character from the regex, |
|
|
69 | "Up" and "Down" search upwards/downwards in the scrollback buffer, |
|
|
70 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
|
|
71 | to the point where search was started, while "Enter" or "Return" |
|
|
72 | stay at the current position and additionally stores the first match |
|
|
73 | in the current line into the primary selection. |
|
|
74 | |
47 | digital-clock |
75 | digital-clock |
48 | Displays a digital clock using the built-in overlay. |
76 | Displays a digital clock using the built-in overlay. |
49 | |
77 | |
50 | mark-urls |
78 | mark-urls |
51 | Uses per-line display filtering ("on_line_update") to underline |
79 | Uses per-line display filtering ("on_line_update") to underline urls |
52 | urls. |
80 | and make them clickable. When middle-clicked, the program specified |
|
|
81 | in the resource "urlLauncher" (default "x-www-browser") will be |
|
|
82 | started with the URL as first argument. |
53 | |
83 | |
54 | block-graphics-to-ascii |
84 | block-graphics-to-ascii |
55 | A not very useful example of filtering all text output to the |
85 | A not very useful example of filtering all text output to the |
56 | terminal, by replacing all line-drawing characters (U+2500 .. |
86 | terminal, by replacing all line-drawing characters (U+2500 .. |
57 | U+259F) by a similar-looking ascii character. |
87 | U+259F) by a similar-looking ascii character. |
… | |
… | |
59 | example-refresh-hooks |
89 | example-refresh-hooks |
60 | Displays a very simple digital clock in the upper right corner of |
90 | Displays a very simple digital clock in the upper right corner of |
61 | the window. Illustrates overwriting the refresh callbacks to create |
91 | the window. Illustrates overwriting the refresh callbacks to create |
62 | your own overlays or changes. |
92 | your own overlays or changes. |
63 | |
93 | |
|
|
94 | API DOCUMENTATION |
64 | General API Considerations |
95 | General API Considerations |
65 | All objects (such as terminals, time watchers etc.) are typical |
96 | All objects (such as terminals, time watchers etc.) are typical |
66 | reference-to-hash objects. The hash can be used to store anything you |
97 | reference-to-hash objects. The hash can be used to store anything you |
67 | like. All members starting with an underscore (such as "_ptr" or |
98 | like. All members starting with an underscore (such as "_ptr" or |
68 | "_hook") are reserved for internal uses and MUST NOT be accessed or |
99 | "_hook") are reserved for internal uses and MUST NOT be accessed or |
… | |
… | |
76 | Argument names also often indicate the type of a parameter. Here are |
107 | Argument names also often indicate the type of a parameter. Here are |
77 | some hints on what they mean: |
108 | some hints on what they mean: |
78 | |
109 | |
79 | $text |
110 | $text |
80 | Rxvt-unicodes special way of encoding text, where one "unicode" |
111 | Rxvt-unicodes special way of encoding text, where one "unicode" |
81 | character always represents one screen cell. See row_t for a |
112 | character always represents one screen cell. See ROW_t for a |
82 | discussion of this format. |
113 | discussion of this format. |
83 | |
114 | |
84 | $string |
115 | $string |
85 | A perl text string, with an emphasis on *text*. It can store all |
116 | A perl text string, with an emphasis on *text*. It can store all |
86 | unicode characters and is to be distinguished with text encoded in a |
117 | unicode characters and is to be distinguished with text encoded in a |
… | |
… | |
88 | |
119 | |
89 | $octets |
120 | $octets |
90 | Either binary data or - more common - a text string encoded in a |
121 | Either binary data or - more common - a text string encoded in a |
91 | locale-specific way. |
122 | locale-specific way. |
92 | |
123 | |
|
|
124 | Extension Objects |
|
|
125 | Very perl extension is a perl class. A separate perl object is created |
|
|
126 | for each terminal and each extension and passed as the first parameter |
|
|
127 | to hooks. So extensions can use their $self object without having to |
|
|
128 | think about other extensions, with the exception of methods and members |
|
|
129 | that begin with an underscore character "_": these are reserved for |
|
|
130 | internal use. |
|
|
131 | |
|
|
132 | Although it isn't a "urxvt::term" object, you can call all methods of |
|
|
133 | the "urxvt::term" class on this object. |
|
|
134 | |
|
|
135 | It has the following methods and data members: |
|
|
136 | |
|
|
137 | $urxvt_term = $self->{term} |
|
|
138 | Returns the "urxvt::term" object associated with this instance of |
|
|
139 | the extension. This member *must not* be changed in any way. |
|
|
140 | |
|
|
141 | $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
142 | Dynamically enable the given hooks (named without the "on_" prefix) |
|
|
143 | for this extension, replacing any previous hook. This is useful when |
|
|
144 | you want to overwrite time-critical hooks only temporarily. |
|
|
145 | |
|
|
146 | $self->disable ($hook_name[, $hook_name..]) |
|
|
147 | Dynamically disable the given hooks. |
|
|
148 | |
93 | Hooks |
149 | Hooks |
94 | The following subroutines can be declared in extension files, and will |
150 | The following subroutines can be declared in extension files, and will |
95 | be called whenever the relevant event happens. |
151 | be called whenever the relevant event happens. |
96 | |
152 | |
97 | The first argument passed to them is an object private to each terminal |
153 | The first argument passed to them is an extension oject as described in |
98 | and extension package. You can call all "urxvt::term" methods on it, but |
154 | the in the "Extension Objects" section. |
99 | its not a real "urxvt::term" object. Instead, the real "urxvt::term" |
|
|
100 | object that is shared between all packages is stored in the "term" |
|
|
101 | member. It is, however, blessed intot he package of the extension |
|
|
102 | script, so for all practical purposes you can treat an extension script |
|
|
103 | as a class. |
|
|
104 | |
155 | |
105 | All of them must return a boolean value. If it is true, then the event |
156 | All of these hooks must return a boolean value. If it is true, then the |
106 | counts as being *consumed*, and the invocation of other hooks is |
157 | event counts as being *consumed*, and the invocation of other hooks is |
107 | skipped, and the relevant action might not be carried out by the C++ |
158 | skipped, and the relevant action might not be carried out by the C++ |
108 | code. |
159 | code. |
109 | |
160 | |
110 | When in doubt, return a false value (preferably "()"). |
161 | *When in doubt, return a false value (preferably "()").* |
111 | |
162 | |
112 | on_init $term |
163 | on_init $term |
113 | Called after a new terminal object has been initialized, but before |
164 | Called after a new terminal object has been initialized, but before |
114 | windows are created or the command gets run. Most methods are unsafe |
165 | windows are created or the command gets run. Most methods are unsafe |
115 | to call or deliver senseless data, as terminal size and other |
166 | to call or deliver senseless data, as terminal size and other |
… | |
… | |
144 | |
195 | |
145 | on_sel_extend $term |
196 | on_sel_extend $term |
146 | Called whenever the user tries to extend the selection (e.g. with a |
197 | Called whenever the user tries to extend the selection (e.g. with a |
147 | double click) and is either supposed to return false (normal |
198 | double click) and is either supposed to return false (normal |
148 | operation), or should extend the selection itelf and return true to |
199 | operation), or should extend the selection itelf and return true to |
149 | suppress the built-in processing. |
200 | suppress the built-in processing. This can happen multiple times, as |
|
|
201 | long as the callback returns true, it will be called on every |
|
|
202 | further click by the user and is supposed to enlarge the selection |
|
|
203 | more and more, if possible. |
150 | |
204 | |
151 | See the selection example extension. |
205 | See the selection example extension. |
152 | |
206 | |
153 | on_view_change $term, $offset |
207 | on_view_change $term, $offset |
154 | Called whenever the view offset changes, i..e the user or program |
208 | Called whenever the view offset changes, i..e the user or program |
… | |
… | |
161 | may be larger than the scroll back buffer or the terminal. |
215 | may be larger than the scroll back buffer or the terminal. |
162 | |
216 | |
163 | It is called before lines are scrolled out (so rows 0 .. min ($lines |
217 | It is called before lines are scrolled out (so rows 0 .. min ($lines |
164 | - 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
218 | - 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
165 | the total number of lines that will be in the scrollback buffer. |
219 | the total number of lines that will be in the scrollback buffer. |
166 | |
|
|
167 | on_tty_activity $term *NYI* |
|
|
168 | Called whenever the program(s) running in the urxvt window send |
|
|
169 | output. |
|
|
170 | |
220 | |
171 | on_osc_seq $term, $string |
221 | on_osc_seq $term, $string |
172 | Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
222 | Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
173 | operating system command) is processed. Cursor position and other |
223 | operating system command) is processed. Cursor position and other |
174 | state information is up-to-date when this happens. For |
224 | state information is up-to-date when this happens. For |
… | |
… | |
185 | argument. You can filter/change and output the text yourself by |
235 | argument. You can filter/change and output the text yourself by |
186 | returning a true value and calling "$term->scr_add_lines" yourself. |
236 | returning a true value and calling "$term->scr_add_lines" yourself. |
187 | Please note that this might be very slow, however, as your hook is |
237 | Please note that this might be very slow, however, as your hook is |
188 | called for all text being output. |
238 | called for all text being output. |
189 | |
239 | |
|
|
240 | on_tt_write $term, $octets |
|
|
241 | Called whenever some data is written to the tty/pty and can be used |
|
|
242 | to suppress or filter tty input. |
|
|
243 | |
190 | on_line_update $term, $row |
244 | on_line_update $term, $row |
191 | Called whenever a line was updated or changed. Can be used to filter |
245 | Called whenever a line was updated or changed. Can be used to filter |
192 | screen output (e.g. underline urls or other useless stuff). Only |
246 | screen output (e.g. underline urls or other useless stuff). Only |
193 | lines that are being shown will be filtered, and, due to performance |
247 | lines that are being shown will be filtered, and, due to performance |
194 | reasons, not always immediately. |
248 | reasons, not always immediately. |
… | |
… | |
221 | |
275 | |
222 | on_focus_out $term |
276 | on_focus_out $term |
223 | Called wheneever the window loses keyboard focus, before |
277 | Called wheneever the window loses keyboard focus, before |
224 | rxvt-unicode does focus out processing. |
278 | rxvt-unicode does focus out processing. |
225 | |
279 | |
226 | on_key_press $term, $event, $octets |
280 | on_key_press $term, $event, $keysym, $octets |
227 | on_key_release $term, $event |
281 | on_key_release $term, $event, $keysym |
228 | on_button_press $term, $event |
282 | on_button_press $term, $event |
229 | on_button_release $term, $event |
283 | on_button_release $term, $event |
230 | on_motion_notify $term, $event |
284 | on_motion_notify $term, $event |
231 | on_map_notify $term, $event |
285 | on_map_notify $term, $event |
232 | on_unmap_notify $term, $event |
286 | on_unmap_notify $term, $event |
… | |
… | |
242 | output, if any, in locale-specific encoding. |
296 | output, if any, in locale-specific encoding. |
243 | |
297 | |
244 | subwindow. |
298 | subwindow. |
245 | |
299 | |
246 | Variables in the "urxvt" Package |
300 | Variables in the "urxvt" Package |
|
|
301 | $urxvt::LIBDIR |
|
|
302 | The rxvt-unicode library directory, where, among other things, the |
|
|
303 | perl modules and scripts are stored. |
|
|
304 | |
|
|
305 | $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
306 | The resource class and name rxvt-unicode uses to look up X |
|
|
307 | resources. |
|
|
308 | |
|
|
309 | $urxvt::RXVTNAME |
|
|
310 | The basename of the installed binaries, usually "urxvt". |
|
|
311 | |
247 | $urxvt::TERM |
312 | $urxvt::TERM |
248 | The current terminal. This variable stores the current "urxvt::term" |
313 | The current terminal. This variable stores the current "urxvt::term" |
249 | object, whenever a callback/hook is executing. |
314 | object, whenever a callback/hook is executing. |
250 | |
315 | |
251 | Functions in the "urxvt" Package |
316 | Functions in the "urxvt" Package |
252 | $term = new urxvt [arg...] |
|
|
253 | Creates a new terminal, very similar as if you had started it with |
|
|
254 | "system $binfile, arg...". Croaks (and probably outputs an error |
|
|
255 | message) if the new instance couldn't be created. Returns "undef" if |
|
|
256 | the new instance didn't initialise perl, and the terminal object |
|
|
257 | otherwise. The "init" and "start" hooks will be called during the |
|
|
258 | call. |
|
|
259 | |
|
|
260 | urxvt::fatal $errormessage |
317 | urxvt::fatal $errormessage |
261 | Fatally aborts execution with the given error message. Avoid at all |
318 | Fatally aborts execution with the given error message. Avoid at all |
262 | costs! The only time this is acceptable is when the terminal process |
319 | costs! The only time this is acceptable is when the terminal process |
263 | starts up. |
320 | starts up. |
264 | |
321 | |
… | |
… | |
268 | function that calls this function. |
325 | function that calls this function. |
269 | |
326 | |
270 | Using this function has the advantage that its output ends up in the |
327 | Using this function has the advantage that its output ends up in the |
271 | correct place, e.g. on stderr of the connecting urxvtc client. |
328 | correct place, e.g. on stderr of the connecting urxvtc client. |
272 | |
329 | |
|
|
330 | Messages have a size limit of 1023 bytes currently. |
|
|
331 | |
|
|
332 | $is_safe = urxvt::safe |
|
|
333 | Returns true when it is safe to do potentially unsafe things, such |
|
|
334 | as evaluating perl code specified by the user. This is true when |
|
|
335 | urxvt was started setuid or setgid. |
|
|
336 | |
273 | $time = urxvt::NOW |
337 | $time = urxvt::NOW |
274 | Returns the "current time" (as per the event loop). |
338 | Returns the "current time" (as per the event loop). |
275 | |
339 | |
276 | urxvt::CurrentTime |
340 | urxvt::CurrentTime |
277 | urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
341 | urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
278 | Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
342 | Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
279 | Button5Mask, AnyModifier |
343 | Button5Mask, AnyModifier |
280 | Various constants for use in X events. |
344 | Various constants for use in X calls and event processing. |
281 | |
345 | |
282 | RENDITION |
346 | RENDITION |
283 | Rendition bitsets contain information about colour, font, font styles |
347 | Rendition bitsets contain information about colour, font, font styles |
284 | and similar information for each screen cell. |
348 | and similar information for each screen cell. |
285 | |
349 | |
… | |
… | |
303 | |
367 | |
304 | $foreground = urxvt::GET_BASEFG $rend |
368 | $foreground = urxvt::GET_BASEFG $rend |
305 | $background = urxvt::GET_BASEBG $rend |
369 | $background = urxvt::GET_BASEBG $rend |
306 | Return the foreground/background colour index, respectively. |
370 | Return the foreground/background colour index, respectively. |
307 | |
371 | |
308 | $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
372 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
309 | $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
373 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
310 | Replace the foreground/background colour in the rendition mask with |
374 | Replace the foreground/background colour in the rendition mask with |
311 | the specified one. |
375 | the specified one. |
312 | |
376 | |
313 | $value = urxvt::GET_CUSTOM ($rend) |
377 | $value = urxvt::GET_CUSTOM $rend |
314 | Return the "custom" value: Every rendition has 5 bits for use by |
378 | Return the "custom" value: Every rendition has 5 bits for use by |
315 | extensions. They can be set and changed as you like and are |
379 | extensions. They can be set and changed as you like and are |
316 | initially zero. |
380 | initially zero. |
317 | |
381 | |
318 | $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
382 | $rend = urxvt::SET_CUSTOM $rend, $new_value |
319 | Change the custom value. |
383 | Change the custom value. |
320 | |
384 | |
|
|
385 | The "urxvt::anyevent" Class |
|
|
386 | The sole purpose of this class is to deliver an interface to the |
|
|
387 | "AnyEvent" module - any module using it will work inside urxvt without |
|
|
388 | further programming. The only exception is that you cannot wait on |
|
|
389 | condition variables, but non-blocking condvar use is ok. What this means |
|
|
390 | is that you cannot use blocking APIs, but the non-blocking variant |
|
|
391 | should work. |
|
|
392 | |
321 | The "urxvt::term" Class |
393 | The "urxvt::term" Class |
|
|
394 | $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
395 | Creates a new terminal, very similar as if you had started it with |
|
|
396 | system "$rxvtname, arg...". $envhashref must be a reference to a |
|
|
397 | %ENV-like hash which defines the environment of the new terminal. |
|
|
398 | |
|
|
399 | Croaks (and probably outputs an error message) if the new instance |
|
|
400 | couldn't be created. Returns "undef" if the new instance didn't |
|
|
401 | initialise perl, and the terminal object otherwise. The "init" and |
|
|
402 | "start" hooks will be called during this call. |
|
|
403 | |
322 | $term->destroy |
404 | $term->destroy |
323 | Destroy the terminal object (close the window, free resources etc.). |
405 | Destroy the terminal object (close the window, free resources etc.). |
|
|
406 | Please note that rxvt will not exit as long as any event watchers |
|
|
407 | (timers, io watchers) are still active. |
324 | |
408 | |
325 | $isset = $term->option ($optval[, $set]) |
409 | $isset = $term->option ($optval[, $set]) |
326 | Returns true if the option specified by $optval is enabled, and |
410 | Returns true if the option specified by $optval is enabled, and |
327 | optionally change it. All option values are stored by name in the |
411 | optionally change it. All option values are stored by name in the |
328 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
412 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
… | |
… | |
370 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
454 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
371 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
455 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
372 | shade term_name title transparent transparent_all tripleclickwords |
456 | shade term_name title transparent transparent_all tripleclickwords |
373 | utmpInhibit visualBell |
457 | utmpInhibit visualBell |
374 | |
458 | |
|
|
459 | $value = $term->x_resource ($pattern) |
|
|
460 | Returns the X-Resource for the given pattern, excluding the program |
|
|
461 | or class name, i.e. "$term->x_resource ("boldFont")" should return |
|
|
462 | the same value as used by this instance of rxvt-unicode. Returns |
|
|
463 | "undef" if no resource with that pattern exists. |
|
|
464 | |
|
|
465 | This method should only be called during the "on_start" hook, as |
|
|
466 | there is only one resource database per display, and later |
|
|
467 | invocations might return the wrong resources. |
|
|
468 | |
|
|
469 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
470 | Adds a keymap translation exactly as specified via a resource. See |
|
|
471 | the "keysym" resource in the rxvt(1) manpage. |
|
|
472 | |
375 | $rend = $term->rstyle ([$new_rstyle]) |
473 | $rend = $term->rstyle ([$new_rstyle]) |
376 | Return and optionally change the current rendition. Text that is |
474 | Return and optionally change the current rendition. Text that is |
377 | output by the terminal application will use this style. |
475 | output by the terminal application will use this style. |
378 | |
476 | |
379 | ($row, $col) = $term->screen_cur ([$row, $col]) |
477 | ($row, $col) = $term->screen_cur ([$row, $col]) |
… | |
… | |
385 | ($row, $col) = $term->selection_beg ([$row, $col]) |
483 | ($row, $col) = $term->selection_beg ([$row, $col]) |
386 | ($row, $col) = $term->selection_end ([$row, $col]) |
484 | ($row, $col) = $term->selection_end ([$row, $col]) |
387 | Return the current values of the selection mark, begin or end |
485 | Return the current values of the selection mark, begin or end |
388 | positions, and optionally set them to new values. |
486 | positions, and optionally set them to new values. |
389 | |
487 | |
|
|
488 | $term->selection_make ($eventtime[, $rectangular]) |
|
|
489 | Tries to make a selection as set by "selection_beg" and |
|
|
490 | "selection_end". If $rectangular is true (default: false), a |
|
|
491 | rectangular selection will be made. This is the prefered function to |
|
|
492 | make a selection. |
|
|
493 | |
390 | $success = $term->selection_grab ($eventtime) |
494 | $success = $term->selection_grab ($eventtime) |
391 | Try to request the primary selection from the server (for example, |
495 | Try to request the primary selection text from the server (for |
392 | as set by the next method). |
496 | example, as set by the next method). No visual feedback will be |
|
|
497 | given. This function is mostly useful from within "on_sel_grab" |
|
|
498 | hooks. |
393 | |
499 | |
394 | $oldtext = $term->selection ([$newtext]) |
500 | $oldtext = $term->selection ([$newtext]) |
395 | Return the current selection text and optionally replace it by |
501 | Return the current selection text and optionally replace it by |
396 | $newtext. |
502 | $newtext. |
397 | |
503 | |
398 | #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line |
504 | $term->overlay_simple ($x, $y, $text) |
399 | overlay box. See the next method for details. # #=cut # #sub |
505 | Create a simple multi-line overlay box. See the next method for |
400 | urxvt::term::scr_overlay { # my ($self, $x, $y, $text) = @_; # # my |
506 | details. |
401 | @lines = split /\n/, $text; # # my $w = 0; # for (map |
|
|
402 | $self->strwidth ($_), @lines) { # $w = $_ if $w < $_; # } # # |
|
|
403 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); # |
|
|
404 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; #} |
|
|
405 | |
507 | |
406 | $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
508 | $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
407 | Create a new (empty) overlay at the given position with the given |
509 | Create a new (empty) overlay at the given position with the given |
408 | width/height. $rstyle defines the initial rendition style (default: |
510 | width/height. $rstyle defines the initial rendition style (default: |
409 | "OVERLAY_RSTYLE"). |
511 | "OVERLAY_RSTYLE"). |
… | |
… | |
443 | Convert the given text string into the corresponding locale |
545 | Convert the given text string into the corresponding locale |
444 | encoding. |
546 | encoding. |
445 | |
547 | |
446 | $string = $term->locale_decode ($octets) |
548 | $string = $term->locale_decode ($octets) |
447 | Convert the given locale-encoded octets into a perl string. |
549 | Convert the given locale-encoded octets into a perl string. |
|
|
550 | |
|
|
551 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
552 | XORs the rendition values in the given span with the provided value |
|
|
553 | (default: "RS_RVid"), which *MUST NOT* contain font styles. Useful |
|
|
554 | in refresh hooks to provide effects similar to the selection. |
|
|
555 | |
|
|
556 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
|
|
557 | $rstyle2]]) |
|
|
558 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
|
|
559 | whitespace will additionally be xored with the $rstyle2, which |
|
|
560 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
|
|
561 | and underlines it instead. Both styles *MUST NOT* contain font |
|
|
562 | styles. |
|
|
563 | |
|
|
564 | $term->scr_bell |
|
|
565 | Ring the bell! |
448 | |
566 | |
449 | $term->scr_add_lines ($string) |
567 | $term->scr_add_lines ($string) |
450 | Write the given text string to the screen, as if output by the |
568 | Write the given text string to the screen, as if output by the |
451 | application running inside the terminal. It may not contain command |
569 | application running inside the terminal. It may not contain command |
452 | sequences (escape codes), but is free to use line feeds, carriage |
570 | sequences (escape codes), but is free to use line feeds, carriage |
… | |
… | |
465 | $term->tt_write ($octets) |
583 | $term->tt_write ($octets) |
466 | Write the octets given in $data to the tty (i.e. as program input). |
584 | Write the octets given in $data to the tty (i.e. as program input). |
467 | To pass characters instead of octets, you should convert your |
585 | To pass characters instead of octets, you should convert your |
468 | strings first to the locale-specific encoding using |
586 | strings first to the locale-specific encoding using |
469 | "$term->locale_encode". |
587 | "$term->locale_encode". |
|
|
588 | |
|
|
589 | $old_events = $term->pty_ev_events ([$new_events]) |
|
|
590 | Replaces the event mask of the pty watcher by the given event mask. |
|
|
591 | Can be used to suppress input and output handling to the pty/tty. |
|
|
592 | See the description of "urxvt::timer->events". Make sure to always |
|
|
593 | restore the previous value. |
470 | |
594 | |
471 | $windowid = $term->parent |
595 | $windowid = $term->parent |
472 | Return the window id of the toplevel window. |
596 | Return the window id of the toplevel window. |
473 | |
597 | |
474 | $windowid = $term->vt |
598 | $windowid = $term->vt |
… | |
… | |
486 | $max_scrollback = $term->saveLines |
610 | $max_scrollback = $term->saveLines |
487 | $nrow_plus_saveLines = $term->total_rows |
611 | $nrow_plus_saveLines = $term->total_rows |
488 | $lines_in_scrollback = $term->nsaved |
612 | $lines_in_scrollback = $term->nsaved |
489 | Return various integers describing terminal characteristics. |
613 | Return various integers describing terminal characteristics. |
490 | |
614 | |
|
|
615 | $x_display = $term->display_id |
|
|
616 | Return the DISPLAY used by rxvt-unicode. |
|
|
617 | |
|
|
618 | $lc_ctype = $term->locale |
|
|
619 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
620 | |
|
|
621 | $env = $term->env |
|
|
622 | Returns a copy of the environment in effect for the terminal as a |
|
|
623 | hashref similar to "\%ENV". |
|
|
624 | |
491 | $modifiermask = $term->ModLevel3Mask |
625 | $modifiermask = $term->ModLevel3Mask |
492 | $modifiermask = $term->ModMetaMask |
626 | $modifiermask = $term->ModMetaMask |
493 | $modifiermask = $term->ModNumLockMask |
627 | $modifiermask = $term->ModNumLockMask |
494 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
628 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
495 | (often AltGr), the meta key (often Alt) and the num lock key, if |
629 | (often AltGr), the meta key (often Alt) and the num lock key, if |
… | |
… | |
573 | Return the row number of the first/last row of the line, |
707 | Return the row number of the first/last row of the line, |
574 | respectively. |
708 | respectively. |
575 | |
709 | |
576 | $offset = $line->offset_of ($row, $col) |
710 | $offset = $line->offset_of ($row, $col) |
577 | Returns the character offset of the given row|col pair within |
711 | Returns the character offset of the given row|col pair within |
578 | the logical line. |
712 | the logical line. Works for rows outside the line, too, and |
|
|
713 | returns corresponding offsets outside the string. |
579 | |
714 | |
580 | ($row, $col) = $line->coord_of ($offset) |
715 | ($row, $col) = $line->coord_of ($offset) |
581 | Translates a string offset into terminal coordinates again. |
716 | Translates a string offset into terminal coordinates again. |
582 | |
717 | |
583 | ($row, $col) = $line->coord_of ($offset) =item $text = |
|
|
584 | $term->special_encode $string |
718 | $text = $term->special_encode $string |
585 | Converts a perl string into the special encoding used by |
719 | Converts a perl string into the special encoding used by |
586 | rxvt-unicode, where one character corresponds to one screen cell. |
720 | rxvt-unicode, where one character corresponds to one screen cell. |
587 | See "$term->ROW_t" for details. |
721 | See "$term->ROW_t" for details. |
588 | |
722 | |
589 | $string = $term->special_decode $text |
723 | $string = $term->special_decode $text |
590 | Converts rxvt-unicodes text reprsentation into a perl string. See |
724 | Converts rxvt-unicodes text reprsentation into a perl string. See |
591 | "$term->ROW_t" for details. |
725 | "$term->ROW_t" for details. |
592 | |
726 | |
|
|
727 | $success = $term->grab_button ($button, $modifiermask) |
|
|
728 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
729 | |
|
|
730 | $success = $term->grab ($eventtime[, $sync]) |
|
|
731 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
732 | synchronous ($sync is true). Also remembers the grab timestampe. |
|
|
733 | |
|
|
734 | $term->allow_events_async |
|
|
735 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
736 | |
|
|
737 | $term->allow_events_sync |
|
|
738 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
739 | |
|
|
740 | $term->allow_events_replay |
|
|
741 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for |
|
|
742 | the most recent grab. |
|
|
743 | |
|
|
744 | $term->ungrab |
|
|
745 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
746 | evaluation errors, as it is better to lose the grab in the error |
|
|
747 | case as the session. |
|
|
748 | |
593 | The "urxvt::popup" Class |
749 | The "urxvt::popup" Class |
|
|
750 | $popup->add_title ($title) |
|
|
751 | Adds a non-clickable title to the popup. |
|
|
752 | |
|
|
753 | $popup->add_separator ([$sepchr]) |
|
|
754 | Creates a separator, optionally using the character given as |
|
|
755 | $sepchr. |
|
|
756 | |
|
|
757 | $popup->add_button ($text, $cb) |
|
|
758 | Adds a clickable button to the popup. $cb is called whenever it is |
|
|
759 | selected. |
|
|
760 | |
|
|
761 | $popup->add_toggle ($text, $cb, $initial_value) |
|
|
762 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
763 | whenever it gets toggled, with a boolean indicating its value as its |
|
|
764 | first argument. |
|
|
765 | |
|
|
766 | $popup->show |
|
|
767 | Displays the popup (which is initially hidden). |
|
|
768 | |
594 | The "urxvt::timer" Class |
769 | The "urxvt::timer" Class |
595 | This class implements timer watchers/events. Time is represented as |
770 | This class implements timer watchers/events. Time is represented as a |
596 | a fractional number of seconds since the epoch. Example: |
771 | fractional number of seconds since the epoch. Example: |
597 | |
772 | |
598 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
773 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
599 | $term->{timer} = urxvt::timer |
774 | $term->{timer} = urxvt::timer |
600 | ->new |
775 | ->new |
601 | ->interval (1) |
776 | ->interval (1) |
602 | ->cb (sub { |
777 | ->cb (sub { |
603 | $term->{overlay}->set (0, 0, |
778 | $term->{overlay}->set (0, 0, |
604 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
779 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
605 | }); |
780 | }); |
606 | |
781 | |
607 | $timer = new urxvt::timer |
782 | $timer = new urxvt::timer |
608 | Create a new timer object in started state. It is scheduled to |
783 | Create a new timer object in started state. It is scheduled to fire |
609 | fire immediately. |
784 | immediately. |
610 | |
785 | |
611 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
786 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
612 | Set the callback to be called when the timer triggers. |
787 | Set the callback to be called when the timer triggers. |
613 | |
788 | |
614 | $tstamp = $timer->at |
789 | $tstamp = $timer->at |
615 | Return the time this watcher will fire next. |
790 | Return the time this watcher will fire next. |
616 | |
791 | |
617 | $timer = $timer->set ($tstamp) |
792 | $timer = $timer->set ($tstamp) |
618 | Set the time the event is generated to $tstamp. |
793 | Set the time the event is generated to $tstamp. |
619 | |
794 | |
620 | $timer = $timer->interval ($interval) |
795 | $timer = $timer->interval ($interval) |
621 | Normally (and when $interval is 0), the timer will automatically |
796 | Normally (and when $interval is 0), the timer will automatically |
622 | stop after it has fired once. If $interval is non-zero, then the |
797 | stop after it has fired once. If $interval is non-zero, then the |
623 | timer is automatically rescheduled at the given intervals. |
798 | timer is automatically rescheduled at the given intervals. |
624 | |
799 | |
625 | $timer = $timer->start |
800 | $timer = $timer->start |
626 | Start the timer. |
801 | Start the timer. |
627 | |
802 | |
628 | $timer = $timer->start ($tstamp) |
803 | $timer = $timer->start ($tstamp) |
629 | Set the event trigger time to $tstamp and start the timer. |
804 | Set the event trigger time to $tstamp and start the timer. |
630 | |
805 | |
631 | $timer = $timer->stop |
806 | $timer = $timer->stop |
632 | Stop the timer. |
807 | Stop the timer. |
633 | |
808 | |
634 | The "urxvt::iow" Class |
809 | The "urxvt::iow" Class |
635 | This class implements io watchers/events. Example: |
810 | This class implements io watchers/events. Example: |
636 | |
811 | |
637 | $term->{socket} = ... |
812 | $term->{socket} = ... |
638 | $term->{iow} = urxvt::iow |
813 | $term->{iow} = urxvt::iow |
639 | ->new |
814 | ->new |
640 | ->fd (fileno $term->{socket}) |
815 | ->fd (fileno $term->{socket}) |
641 | ->events (1) # wait for read data |
816 | ->events (urxvt::EVENT_READ) |
642 | ->start |
817 | ->start |
643 | ->cb (sub { |
818 | ->cb (sub { |
644 | my ($iow, $revents) = @_; |
819 | my ($iow, $revents) = @_; |
645 | # $revents must be 1 here, no need to check |
820 | # $revents must be 1 here, no need to check |
646 | sysread $term->{socket}, my $buf, 8192 |
821 | sysread $term->{socket}, my $buf, 8192 |
647 | or end-of-file; |
822 | or end-of-file; |
648 | }); |
823 | }); |
649 | |
824 | |
650 | $iow = new urxvt::iow |
825 | $iow = new urxvt::iow |
651 | Create a new io watcher object in stopped state. |
826 | Create a new io watcher object in stopped state. |
652 | |
827 | |
653 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
828 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
654 | Set the callback to be called when io events are triggered. |
829 | Set the callback to be called when io events are triggered. |
655 | $reventmask is a bitset as described in the "events" method. |
830 | $reventmask is a bitset as described in the "events" method. |
656 | |
831 | |
657 | $iow = $iow->fd ($fd) |
832 | $iow = $iow->fd ($fd) |
658 | Set the filedescriptor (not handle) to watch. |
833 | Set the filedescriptor (not handle) to watch. |
659 | |
834 | |
660 | $iow = $iow->events ($eventmask) |
835 | $iow = $iow->events ($eventmask) |
661 | Set the event mask to watch. Bit #0 (value 1) enables watching |
836 | Set the event mask to watch. The only allowed values are |
662 | for read data, Bit #1 (value 2) enables watching for write data. |
837 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed |
|
|
838 | together, or "urxvt::EVENT_NONE". |
663 | |
839 | |
664 | $iow = $iow->start |
840 | $iow = $iow->start |
665 | Start watching for requested events on the given handle. |
841 | Start watching for requested events on the given handle. |
666 | |
842 | |
667 | $iow = $iow->stop |
843 | $iow = $iow->stop |
668 | Stop watching for events on the given filehandle. |
844 | Stop watching for events on the given filehandle. |
669 | |
845 | |
670 | ENVIRONMENT |
846 | ENVIRONMENT |
671 | URXVT_PERL_VERBOSITY |
847 | URXVT_PERL_VERBOSITY |
672 | This variable controls the verbosity level of the perl extension. |
848 | This variable controls the verbosity level of the perl extension. Higher |
673 | Higher numbers indicate more verbose output. |
849 | numbers indicate more verbose output. |
674 | |
850 | |
675 | =0 - only fatal messages |
851 | == 0 - fatal messages |
676 | =3 - script loading and management |
852 | >= 3 - script loading and management |
677 | =10 - all events received |
853 | >=10 - all called hooks |
|
|
854 | >=11 - hook reutrn values |
678 | |
855 | |
679 | AUTHOR |
856 | AUTHOR |
680 | Marc Lehmann <pcg@goof.com> |
857 | Marc Lehmann <pcg@goof.com> |
681 | http://software.schmorp.de/pkg/rxvt-unicode |
858 | http://software.schmorp.de/pkg/rxvt-unicode |
682 | |
859 | |