… | |
… | |
12 | # start a rxvt using it: |
12 | # start a rxvt using it: |
13 | |
13 | |
14 | rxvt --perl-lib $HOME -pe grab_test |
14 | rxvt --perl-lib $HOME -pe grab_test |
15 | |
15 | |
16 | DESCRIPTION |
16 | DESCRIPTION |
17 | Everytime a terminal object gets created, scripts specified via the |
17 | Everytime a terminal object gets created, extension scripts specified |
18 | "perl" resource are loaded and associated with it. |
18 | via the "perl" resource are loaded and associated with it. |
19 | |
19 | |
20 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
20 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
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). Right |
37 | to select urls and complete shell-quoted arguments, which is very |
37 | now, it tries to select urls and complete shell-quoted arguments, |
38 | convenient, too, if your ls supports "--quoting-style=shell". |
38 | which is very convenient, too, if your ls supports |
|
|
39 | "--quoting-style=shell". |
39 | |
40 | |
40 | It also offers the following bindable event: |
41 | It also offers the following bindable keyboard command: |
41 | |
42 | |
42 | rot13 |
43 | rot13 |
43 | Rot-13 the selection when activated. Used via keyboard trigger: |
44 | Rot-13 the selection when activated. Used via keyboard trigger: |
44 | |
45 | |
45 | URxvt.keysym.C-M-r: perl:selection:rot13 |
46 | URxvt.keysym.C-M-r: perl:selection:rot13 |
46 | |
47 | |
|
|
48 | option-popup (enabled by default) |
|
|
49 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) |
|
|
50 | options at runtime. |
|
|
51 | |
|
|
52 | selection-popup (enabled by default) |
|
|
53 | Binds a popup menu to Ctrl-Button3 that lets you convert the |
|
|
54 | selection text into various other formats/action (such as uri |
|
|
55 | unescaping, perl evalution, web-browser starting etc.), depending on |
|
|
56 | content. |
|
|
57 | |
|
|
58 | searchable-scrollback<hotkey> (enabled by default) |
|
|
59 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
60 | by a hotkey (default: "M-s"). When in search mode, normal terminal |
|
|
61 | input/output is suspended. |
|
|
62 | |
|
|
63 | "/" starts an incremental regex search, "n" searches further, "p" or |
|
|
64 | "N" jump to the previous match, "G" jumps to the bottom and clears |
|
|
65 | the history, "enter" leaves search mode at the current position and |
|
|
66 | "escape" returns to the original position. |
|
|
67 | |
47 | digital-clock |
68 | digital-clock |
48 | Displays a digital clock using the built-in overlay. |
69 | Displays a digital clock using the built-in overlay. |
|
|
70 | |
|
|
71 | mark-urls |
|
|
72 | Uses per-line display filtering ("on_line_update") to underline |
|
|
73 | urls. |
|
|
74 | |
|
|
75 | block-graphics-to-ascii |
|
|
76 | A not very useful example of filtering all text output to the |
|
|
77 | terminal, by replacing all line-drawing characters (U+2500 .. |
|
|
78 | U+259F) by a similar-looking ascii character. |
49 | |
79 | |
50 | example-refresh-hooks |
80 | example-refresh-hooks |
51 | Displays a very simple digital clock in the upper right corner of |
81 | Displays a very simple digital clock in the upper right corner of |
52 | the window. Illustrates overwriting the refresh callbacks to create |
82 | the window. Illustrates overwriting the refresh callbacks to create |
53 | your own overlays or changes. |
83 | your own overlays or changes. |
54 | |
84 | |
|
|
85 | API DOCUMENTATION |
55 | General API Considerations |
86 | General API Considerations |
56 | All objects (such as terminals, time watchers etc.) are typical |
87 | All objects (such as terminals, time watchers etc.) are typical |
57 | reference-to-hash objects. The hash can be used to store anything you |
88 | reference-to-hash objects. The hash can be used to store anything you |
58 | like. All members starting with an underscore (such as "_ptr" or |
89 | like. All members starting with an underscore (such as "_ptr" or |
59 | "_hook") are reserved for internal uses and MUST NOT be accessed or |
90 | "_hook") are reserved for internal uses and MUST NOT be accessed or |
… | |
… | |
62 | When objects are destroyed on the C++ side, the perl object hashes are |
93 | When objects are destroyed on the C++ side, the perl object hashes are |
63 | emptied, so its best to store related objects such as time watchers and |
94 | emptied, so its best to store related objects such as time watchers and |
64 | the like inside the terminal object so they get destroyed as soon as the |
95 | the like inside the terminal object so they get destroyed as soon as the |
65 | terminal is destroyed. |
96 | terminal is destroyed. |
66 | |
97 | |
|
|
98 | Argument names also often indicate the type of a parameter. Here are |
|
|
99 | some hints on what they mean: |
|
|
100 | |
|
|
101 | $text |
|
|
102 | Rxvt-unicodes special way of encoding text, where one "unicode" |
|
|
103 | character always represents one screen cell. See row_t for a |
|
|
104 | discussion of this format. |
|
|
105 | |
|
|
106 | $string |
|
|
107 | A perl text string, with an emphasis on *text*. It can store all |
|
|
108 | unicode characters and is to be distinguished with text encoded in a |
|
|
109 | specific encoding (often locale-specific) and binary data. |
|
|
110 | |
|
|
111 | $octets |
|
|
112 | Either binary data or - more common - a text string encoded in a |
|
|
113 | locale-specific way. |
|
|
114 | |
|
|
115 | Extension Objects |
|
|
116 | Very perl extension is a perl class. A separate perl object is created |
|
|
117 | for each terminal and each extension and passed as the first parameter |
|
|
118 | to hooks. So extensions can use their $self object without having to |
|
|
119 | think about other extensions, with the exception of methods and members |
|
|
120 | that begin with an underscore character "_": these are reserved for |
|
|
121 | internal use. |
|
|
122 | |
|
|
123 | Although it isn't a "urxvt::term" object, you can call all methods of |
|
|
124 | the "urxvt::term" class on this object. |
|
|
125 | |
|
|
126 | It has the following methods and data members: |
|
|
127 | |
|
|
128 | $urxvt_term = $self->{term} |
|
|
129 | Returns the "urxvt::term" object associated with this instance of |
|
|
130 | the extension. This member *must not* be changed in any way. |
|
|
131 | |
|
|
132 | $self->enable ($hook_name => $cb, [$hook_name => $cb..]) |
|
|
133 | Dynamically enable the given hooks (named without the "on_" prefix) |
|
|
134 | for this extension, replacing any previous hook. This is useful when |
|
|
135 | you want to overwrite time-critical hooks only temporarily. |
|
|
136 | |
|
|
137 | $self->disable ($hook_name[, $hook_name..]) |
|
|
138 | Dynamically disable the given hooks. |
|
|
139 | |
67 | Hooks |
140 | Hooks |
68 | The following subroutines can be declared in loaded scripts, and will be |
141 | The following subroutines can be declared in extension files, and will |
69 | called whenever the relevant event happens. |
142 | be called whenever the relevant event happens. |
70 | |
143 | |
71 | The first argument passed to them is an object private to each terminal |
144 | The first argument passed to them is an extension oject as described in |
72 | and extension package. You can call all "urxvt::term" methods on it, but |
145 | the in the "Extension Objects" section. |
73 | its not a real "urxvt::term" object. Instead, the real "urxvt::term" |
|
|
74 | object that is shared between all packages is stored in the "term" |
|
|
75 | member. |
|
|
76 | |
146 | |
77 | All of them must return a boolean value. If it is true, then the event |
147 | All of these hooks must return a boolean value. If it is true, then the |
78 | counts as being *consumed*, and the invocation of other hooks is |
148 | event counts as being *consumed*, and the invocation of other hooks is |
79 | skipped, and the relevant action might not be carried out by the C++ |
149 | skipped, and the relevant action might not be carried out by the C++ |
80 | code. |
150 | code. |
81 | |
151 | |
82 | When in doubt, return a false value (preferably "()"). |
152 | *When in doubt, return a false value (preferably "()").* |
83 | |
153 | |
84 | on_init $term |
154 | on_init $term |
85 | Called after a new terminal object has been initialized, but before |
155 | Called after a new terminal object has been initialized, but before |
86 | windows are created or the command gets run. |
156 | windows are created or the command gets run. Most methods are unsafe |
|
|
157 | to call or deliver senseless data, as terminal size and other |
|
|
158 | characteristics have not yet been determined. You can safely query |
|
|
159 | and change resources, though. |
87 | |
160 | |
88 | on_reset $term |
161 | on_reset $term |
89 | Called after the screen is "reset" for any reason, such as resizing |
162 | Called after the screen is "reset" for any reason, such as resizing |
90 | or control sequences. Here is where you can react on changes to |
163 | or control sequences. Here is where you can react on changes to |
91 | size-related variables. |
164 | size-related variables. |
… | |
… | |
117 | operation), or should extend the selection itelf and return true to |
190 | operation), or should extend the selection itelf and return true to |
118 | suppress the built-in processing. |
191 | suppress the built-in processing. |
119 | |
192 | |
120 | See the selection example extension. |
193 | See the selection example extension. |
121 | |
194 | |
122 | on_focus_in $term |
|
|
123 | Called whenever the window gets the keyboard focus, before urxvt |
|
|
124 | does focus in processing. |
|
|
125 | |
|
|
126 | on_focus_out $term |
|
|
127 | Called wheneever the window loses keyboard focus, before urxvt does |
|
|
128 | focus out processing. |
|
|
129 | |
|
|
130 | on_view_change $term, $offset |
195 | on_view_change $term, $offset |
131 | Called whenever the view offset changes, i..e the user or program |
196 | Called whenever the view offset changes, i..e the user or program |
132 | scrolls. Offset 0 means display the normal terminal, positive values |
197 | scrolls. Offset 0 means display the normal terminal, positive values |
133 | show this many lines of scrollback. |
198 | show this many lines of scrollback. |
134 | |
199 | |
… | |
… | |
138 | may be larger than the scroll back buffer or the terminal. |
203 | may be larger than the scroll back buffer or the terminal. |
139 | |
204 | |
140 | It is called before lines are scrolled out (so rows 0 .. min ($lines |
205 | It is called before lines are scrolled out (so rows 0 .. min ($lines |
141 | - 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
206 | - 1, $nrow - 1) represent the lines to be scrolled out). $saved is |
142 | the total number of lines that will be in the scrollback buffer. |
207 | the total number of lines that will be in the scrollback buffer. |
143 | |
|
|
144 | on_tty_activity $term *NYI* |
|
|
145 | Called whenever the program(s) running in the urxvt window send |
|
|
146 | output. |
|
|
147 | |
208 | |
148 | on_osc_seq $term, $string |
209 | on_osc_seq $term, $string |
149 | Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
210 | Called whenever the ESC ] 777 ; string ST command sequence (OSC = |
150 | operating system command) is processed. Cursor position and other |
211 | operating system command) is processed. Cursor position and other |
151 | state information is up-to-date when this happens. For |
212 | state information is up-to-date when this happens. For |
… | |
… | |
155 | |
216 | |
156 | Be careful not ever to trust (in a security sense) the data you |
217 | Be careful not ever to trust (in a security sense) the data you |
157 | receive, as its source can not easily be controleld (e-mail content, |
218 | receive, as its source can not easily be controleld (e-mail content, |
158 | messages from other users on the same system etc.). |
219 | messages from other users on the same system etc.). |
159 | |
220 | |
|
|
221 | on_add_lines $term, $string |
|
|
222 | Called whenever text is about to be output, with the text as |
|
|
223 | argument. You can filter/change and output the text yourself by |
|
|
224 | returning a true value and calling "$term->scr_add_lines" yourself. |
|
|
225 | Please note that this might be very slow, however, as your hook is |
|
|
226 | called for all text being output. |
|
|
227 | |
|
|
228 | on_tt_write $term, $octets |
|
|
229 | Called whenever some data is written to the tty/pty and can be used |
|
|
230 | to suppress or filter tty input. |
|
|
231 | |
|
|
232 | on_line_update $term, $row |
|
|
233 | Called whenever a line was updated or changed. Can be used to filter |
|
|
234 | screen output (e.g. underline urls or other useless stuff). Only |
|
|
235 | lines that are being shown will be filtered, and, due to performance |
|
|
236 | reasons, not always immediately. |
|
|
237 | |
|
|
238 | The row number is always the topmost row of the line if the line |
|
|
239 | spans multiple rows. |
|
|
240 | |
|
|
241 | Please note that, if you change the line, then the hook might get |
|
|
242 | called later with the already-modified line (e.g. if unrelated parts |
|
|
243 | change), so you cannot just toggle rendition bits, but only set |
|
|
244 | them. |
|
|
245 | |
160 | on_refresh_begin $term |
246 | on_refresh_begin $term |
161 | Called just before the screen gets redrawn. Can be used for overlay |
247 | Called just before the screen gets redrawn. Can be used for overlay |
162 | or similar effects by modify terminal contents in refresh_begin, and |
248 | or similar effects by modify terminal contents in refresh_begin, and |
163 | restoring them in refresh_end. The built-in overlay and selection |
249 | restoring them in refresh_end. The built-in overlay and selection |
164 | display code is run after this hook, and takes precedence. |
250 | display code is run after this hook, and takes precedence. |
… | |
… | |
169 | on_keyboard_command $term, $string |
255 | on_keyboard_command $term, $string |
170 | Called whenever the user presses a key combination that has a |
256 | Called whenever the user presses a key combination that has a |
171 | "perl:string" action bound to it (see description of the keysym |
257 | "perl:string" action bound to it (see description of the keysym |
172 | resource in the rxvt(1) manpage). |
258 | resource in the rxvt(1) manpage). |
173 | |
259 | |
|
|
260 | on_focus_in $term |
|
|
261 | Called whenever the window gets the keyboard focus, before |
|
|
262 | rxvt-unicode does focus in processing. |
|
|
263 | |
|
|
264 | on_focus_out $term |
|
|
265 | Called wheneever the window loses keyboard focus, before |
|
|
266 | rxvt-unicode does focus out processing. |
|
|
267 | |
|
|
268 | on_key_press $term, $event, $keysym, $octets |
|
|
269 | on_key_release $term, $event, $keysym |
|
|
270 | on_button_press $term, $event |
|
|
271 | on_button_release $term, $event |
|
|
272 | on_motion_notify $term, $event |
|
|
273 | on_map_notify $term, $event |
|
|
274 | on_unmap_notify $term, $event |
|
|
275 | Called whenever the corresponding X event is received for the |
|
|
276 | terminal If the hook returns true, then the even will be ignored by |
|
|
277 | rxvt-unicode. |
|
|
278 | |
|
|
279 | The event is a hash with most values as named by Xlib (see the |
|
|
280 | XEvent manpage), with the additional members "row" and "col", which |
|
|
281 | are the row and column under the mouse cursor. |
|
|
282 | |
|
|
283 | "on_key_press" additionally receives the string rxvt-unicode would |
|
|
284 | output, if any, in locale-specific encoding. |
|
|
285 | |
|
|
286 | subwindow. |
|
|
287 | |
174 | Variables in the "urxvt" Package |
288 | Variables in the "urxvt" Package |
|
|
289 | $urxvt::LIBDIR |
|
|
290 | The rxvt-unicode library directory, where, among other things, the |
|
|
291 | perl modules and scripts are stored. |
|
|
292 | |
|
|
293 | $urxvt::RESCLASS, $urxvt::RESCLASS |
|
|
294 | The resource class and name rxvt-unicode uses to look up X |
|
|
295 | resources. |
|
|
296 | |
|
|
297 | $urxvt::RXVTNAME |
|
|
298 | The basename of the installed binaries, usually "urxvt". |
|
|
299 | |
175 | $urxvt::TERM |
300 | $urxvt::TERM |
176 | The current terminal. Whenever a callback/Hook is bein executed, |
|
|
177 | this variable stores the current "urxvt::term" object. |
301 | The current terminal. This variable stores the current "urxvt::term" |
|
|
302 | object, whenever a callback/hook is executing. |
|
|
303 | |
|
|
304 | * |
178 | |
305 | |
179 | Functions in the "urxvt" Package |
306 | Functions in the "urxvt" Package |
180 | urxvt::fatal $errormessage |
307 | urxvt::fatal $errormessage |
181 | Fatally aborts execution with the given error message. Avoid at all |
308 | Fatally aborts execution with the given error message. Avoid at all |
182 | costs! The only time this is acceptable is when the terminal process |
309 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
188 | function that calls this function. |
315 | function that calls this function. |
189 | |
316 | |
190 | Using this function has the advantage that its output ends up in the |
317 | Using this function has the advantage that its output ends up in the |
191 | correct place, e.g. on stderr of the connecting urxvtc client. |
318 | correct place, e.g. on stderr of the connecting urxvtc client. |
192 | |
319 | |
|
|
320 | Messages have a size limit of 1023 bytes currently. |
|
|
321 | |
|
|
322 | $is_safe = urxvt::safe |
|
|
323 | Returns true when it is safe to do potentially unsafe things, such |
|
|
324 | as evaluating perl code specified by the user. This is true when |
|
|
325 | urxvt was started setuid or setgid. |
|
|
326 | |
193 | $time = urxvt::NOW |
327 | $time = urxvt::NOW |
194 | Returns the "current time" (as per the event loop). |
328 | Returns the "current time" (as per the event loop). |
|
|
329 | |
|
|
330 | urxvt::CurrentTime |
|
|
331 | urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
|
|
332 | Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
|
|
333 | Button5Mask, AnyModifier |
|
|
334 | Various constants for use in X calls and event processing. |
195 | |
335 | |
196 | RENDITION |
336 | RENDITION |
197 | Rendition bitsets contain information about colour, font, font styles |
337 | Rendition bitsets contain information about colour, font, font styles |
198 | and similar information for each screen cell. |
338 | and similar information for each screen cell. |
199 | |
339 | |
… | |
… | |
217 | |
357 | |
218 | $foreground = urxvt::GET_BASEFG $rend |
358 | $foreground = urxvt::GET_BASEFG $rend |
219 | $background = urxvt::GET_BASEBG $rend |
359 | $background = urxvt::GET_BASEBG $rend |
220 | Return the foreground/background colour index, respectively. |
360 | Return the foreground/background colour index, respectively. |
221 | |
361 | |
222 | $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) |
362 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
223 | $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) |
363 | $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
224 | Replace the foreground/background colour in the rendition mask with |
364 | Replace the foreground/background colour in the rendition mask with |
225 | the specified one. |
365 | the specified one. |
226 | |
366 | |
227 | $value = urxvt::GET_CUSTOM ($rend) |
367 | $value = urxvt::GET_CUSTOM $rend |
228 | Return the "custom" value: Every rendition has 5 bits for use by |
368 | Return the "custom" value: Every rendition has 5 bits for use by |
229 | extensions. They can be set and changed as you like and are |
369 | extensions. They can be set and changed as you like and are |
230 | initially zero. |
370 | initially zero. |
231 | |
371 | |
232 | $rend = urxvt::SET_CUSTOM ($rend, $new_value) |
372 | $rend = urxvt::SET_CUSTOM $rend, $new_value |
233 | Change the custom value. |
373 | Change the custom value. |
234 | |
374 | |
|
|
375 | The "urxvt::anyevent" Class |
|
|
376 | The sole purpose of this class is to deliver an interface to the |
|
|
377 | "AnyEvent" module - any module using it will work inside urxvt without |
|
|
378 | further programming. The only exception is that you cannot wait on |
|
|
379 | condition variables, but non-blocking condvar use is ok. What this means |
|
|
380 | is that you cannot use blocking APIs, but the non-blocking variant |
|
|
381 | should work. |
|
|
382 | |
235 | The "urxvt::term" Class |
383 | The "urxvt::term" Class |
|
|
384 | $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
385 | Creates a new terminal, very similar as if you had started it with |
|
|
386 | system "$rxvtname, arg...". $envhashref must be a reference to a |
|
|
387 | %ENV>-like "hash which defines the environment of the new terminal. |
|
|
388 | " |
|
|
389 | |
|
|
390 | >Croaks (and probably outputs an error message) if the new instance |
|
|
391 | couldn't be created. Returns "undef" if the new instance didn't |
|
|
392 | initialise perl, and the terminal object otherwise. The "init" and |
|
|
393 | "start" hooks will be called during this call. |
|
|
394 | |
|
|
395 | $term->destroy |
|
|
396 | Destroy the terminal object (close the window, free resources etc.). |
|
|
397 | Please note that rxvt will not exit as long as any event watchers |
|
|
398 | (timers, io watchers) are still active. |
|
|
399 | |
|
|
400 | $isset = $term->option ($optval[, $set]) |
|
|
401 | Returns true if the option specified by $optval is enabled, and |
|
|
402 | optionally change it. All option values are stored by name in the |
|
|
403 | hash %urxvt::OPTION. Options not enabled in this binary are not in |
|
|
404 | the hash. |
|
|
405 | |
|
|
406 | Here is a a likely non-exhaustive list of option names, please see |
|
|
407 | the source file /src/optinc.h to see the actual list: |
|
|
408 | |
|
|
409 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
410 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
411 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
412 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
413 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
414 | tripleclickwords utmpInhibit visualBell |
|
|
415 | |
236 | $value = $term->resource ($name[, $newval]) |
416 | $value = $term->resource ($name[, $newval]) |
237 | Returns the current resource value associated with a given name and |
417 | Returns the current resource value associated with a given name and |
238 | optionally sets a new value. Setting values is most useful in the |
418 | optionally sets a new value. Setting values is most useful in the |
239 | "init" hook. Unset resources are returned and accepted as "undef". |
419 | "init" hook. Unset resources are returned and accepted as "undef". |
240 | |
420 | |
… | |
… | |
249 | Please note that resource strings will currently only be freed when |
429 | Please note that resource strings will currently only be freed when |
250 | the terminal is destroyed, so changing options frequently will eat |
430 | the terminal is destroyed, so changing options frequently will eat |
251 | memory. |
431 | memory. |
252 | |
432 | |
253 | Here is a a likely non-exhaustive list of resource names, not all of |
433 | Here is a a likely non-exhaustive list of resource names, not all of |
254 | which are supported in every build, please see the source to see the |
434 | which are supported in every build, please see the source file |
255 | actual list: |
435 | /src/rsinc.h to see the actual list: |
256 | |
436 | |
257 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
437 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
258 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
438 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
259 | display_name embed ext_bwidth fade font geometry hold iconName |
439 | display_name embed ext_bwidth fade font geometry hold iconName |
260 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
440 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
261 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
441 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
262 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
442 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
263 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
443 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
264 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
444 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
265 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
445 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
266 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
446 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
267 | shade term_name title transparent transparent_all tripleclickwords |
447 | shade term_name title transparent transparent_all tripleclickwords |
268 | utmpInhibit visualBell |
448 | utmpInhibit visualBell |
269 | |
449 | |
|
|
450 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
|
|
451 | Adds a keymap translation exactly as specified via a resource. See |
|
|
452 | the "keysym" resource in the rxvt(1) manpage. |
|
|
453 | |
|
|
454 | $rend = $term->rstyle ([$new_rstyle]) |
|
|
455 | Return and optionally change the current rendition. Text that is |
|
|
456 | output by the terminal application will use this style. |
|
|
457 | |
|
|
458 | ($row, $col) = $term->screen_cur ([$row, $col]) |
|
|
459 | Return the current coordinates of the text cursor position and |
|
|
460 | optionally set it (which is usually bad as applications don't expect |
|
|
461 | that). |
|
|
462 | |
270 | ($row, $col) = $term->selection_mark ([$row, $col]) |
463 | ($row, $col) = $term->selection_mark ([$row, $col]) |
271 | ($row, $col) = $term->selection_beg ([$row, $col]) |
464 | ($row, $col) = $term->selection_beg ([$row, $col]) |
272 | ($row, $col) = $term->selection_end ([$row, $col]) |
465 | ($row, $col) = $term->selection_end ([$row, $col]) |
273 | Return the current values of the selection mark, begin or end |
466 | Return the current values of the selection mark, begin or end |
274 | positions, and optionally set them to new values. |
467 | positions, and optionally set them to new values. |
… | |
… | |
279 | |
472 | |
280 | $oldtext = $term->selection ([$newtext]) |
473 | $oldtext = $term->selection ([$newtext]) |
281 | Return the current selection text and optionally replace it by |
474 | Return the current selection text and optionally replace it by |
282 | $newtext. |
475 | $newtext. |
283 | |
476 | |
284 | #=item $term->overlay ($x, $y, $text) # #Create a simple multi-line |
477 | $term->overlay_simple ($x, $y, $text) |
285 | overlay box. See the next method for details. # #=cut |
478 | Create a simple multi-line overlay box. See the next method for |
286 | |
479 | details. |
287 | sub urxvt::term::scr_overlay { die; my ($self, $x, $y, $text) = @_; |
|
|
288 | |
|
|
289 | my @lines = split /\n/, $text; |
|
|
290 | |
|
|
291 | my $w = 0; |
|
|
292 | for (map $self->strwidth ($_), @lines) { |
|
|
293 | $w = $_ if $w < $_; |
|
|
294 | } |
|
|
295 | |
|
|
296 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
297 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
298 | } |
|
|
299 | |
480 | |
300 | $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
481 | $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) |
301 | Create a new (empty) overlay at the given position with the given |
482 | Create a new (empty) overlay at the given position with the given |
302 | width/height. $rstyle defines the initial rendition style (default: |
483 | width/height. $rstyle defines the initial rendition style (default: |
303 | "OVERLAY_RSTYLE"). |
484 | "OVERLAY_RSTYLE"). |
… | |
… | |
322 | If visible, hide the overlay, but do not destroy it. |
503 | If visible, hide the overlay, but do not destroy it. |
323 | |
504 | |
324 | $overlay->show |
505 | $overlay->show |
325 | If hidden, display the overlay again. |
506 | If hidden, display the overlay again. |
326 | |
507 | |
|
|
508 | $popup = $term->popup ($event) |
|
|
509 | Creates a new "urxvt::popup" object that implements a popup menu. |
|
|
510 | The $event *must* be the event causing the menu to pop up (a button |
|
|
511 | event, currently). |
|
|
512 | |
327 | $cellwidth = $term->strwidth $string |
513 | $cellwidth = $term->strwidth ($string) |
328 | Returns the number of screen-cells this string would need. Correctly |
514 | Returns the number of screen-cells this string would need. Correctly |
329 | accounts for wide and combining characters. |
515 | accounts for wide and combining characters. |
330 | |
516 | |
331 | $octets = $term->locale_encode $string |
517 | $octets = $term->locale_encode ($string) |
332 | Convert the given text string into the corresponding locale |
518 | Convert the given text string into the corresponding locale |
333 | encoding. |
519 | encoding. |
334 | |
520 | |
335 | $string = $term->locale_decode $octets |
521 | $string = $term->locale_decode ($octets) |
336 | Convert the given locale-encoded octets into a perl string. |
522 | Convert the given locale-encoded octets into a perl string. |
|
|
523 | |
|
|
524 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
|
|
525 | XORs the rendition values in the given span with the provided value |
|
|
526 | (default: "RS_RVid"). Useful in refresh hooks to provide effects |
|
|
527 | similar to the selection. |
|
|
528 | |
|
|
529 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
|
|
530 | $rstyle2]]) |
|
|
531 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
|
|
532 | whitespace will additionally be xored with the $rstyle2, which |
|
|
533 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
|
|
534 | and underlines it instead. |
|
|
535 | |
|
|
536 | $term->scr_bell |
|
|
537 | Ring the bell! |
|
|
538 | |
|
|
539 | $term->scr_add_lines ($string) |
|
|
540 | Write the given text string to the screen, as if output by the |
|
|
541 | application running inside the terminal. It may not contain command |
|
|
542 | sequences (escape codes), but is free to use line feeds, carriage |
|
|
543 | returns and tabs. The string is a normal text string, not in |
|
|
544 | locale-dependent encoding. |
|
|
545 | |
|
|
546 | Normally its not a good idea to use this function, as programs might |
|
|
547 | be confused by changes in cursor position or scrolling. Its useful |
|
|
548 | inside a "on_add_lines" hook, though. |
|
|
549 | |
|
|
550 | $term->cmd_parse ($octets) |
|
|
551 | Similar to "scr_add_lines", but the argument must be in the |
|
|
552 | locale-specific encoding of the terminal and can contain command |
|
|
553 | sequences (escape codes) that will be interpreted. |
337 | |
554 | |
338 | $term->tt_write ($octets) |
555 | $term->tt_write ($octets) |
339 | Write the octets given in $data to the tty (i.e. as program input). |
556 | Write the octets given in $data to the tty (i.e. as program input). |
340 | To pass characters instead of octets, you should convert your |
557 | To pass characters instead of octets, you should convert your |
341 | strings first to the locale-specific encoding using |
558 | strings first to the locale-specific encoding using |
342 | "$term->locale_encode". |
559 | "$term->locale_encode". |
343 | |
560 | |
|
|
561 | $old_events = $term->pty_ev_events ([$new_events]) |
|
|
562 | Replaces the event mask of the pty watcher by the given event mask. |
|
|
563 | Can be used to suppress input and output handling to the pty/tty. |
|
|
564 | See the description of "urxvt::timer->events". Make sure to always |
|
|
565 | restore the previous value. |
|
|
566 | |
|
|
567 | $windowid = $term->parent |
|
|
568 | Return the window id of the toplevel window. |
|
|
569 | |
|
|
570 | $windowid = $term->vt |
|
|
571 | Return the window id of the terminal window. |
|
|
572 | |
|
|
573 | $window_width = $term->width |
|
|
574 | $window_height = $term->height |
|
|
575 | $font_width = $term->fwidth |
|
|
576 | $font_height = $term->fheight |
|
|
577 | $font_ascent = $term->fbase |
344 | $nrow = $term->nrow |
578 | $terminal_rows = $term->nrow |
345 | $ncol = $term->ncol |
579 | $terminal_columns = $term->ncol |
346 | Return the number of rows/columns of the terminal window (i.e. as |
580 | $has_focus = $term->focus |
347 | specified by "-geometry", excluding any scrollback). |
581 | $is_mapped = $term->mapped |
|
|
582 | $max_scrollback = $term->saveLines |
|
|
583 | $nrow_plus_saveLines = $term->total_rows |
|
|
584 | $lines_in_scrollback = $term->nsaved |
|
|
585 | Return various integers describing terminal characteristics. |
348 | |
586 | |
|
|
587 | $x_display = $term->display_id |
|
|
588 | Return the DISPLAY used by rxvt-unicode. |
|
|
589 | |
|
|
590 | $lc_ctype = $term->locale |
|
|
591 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
592 | |
349 | $nsaved = $term->nsaved |
593 | $env = $term->env |
350 | Returns the number of lines in the scrollback buffer. |
594 | Returns a copy of the environment in effect for the terminal as a |
|
|
595 | hashref similar to "\%ENV". |
|
|
596 | |
|
|
597 | $modifiermask = $term->ModLevel3Mask |
|
|
598 | $modifiermask = $term->ModMetaMask |
|
|
599 | $modifiermask = $term->ModNumLockMask |
|
|
600 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
|
|
601 | (often AltGr), the meta key (often Alt) and the num lock key, if |
|
|
602 | applicable. |
351 | |
603 | |
352 | $view_start = $term->view_start ([$newvalue]) |
604 | $view_start = $term->view_start ([$newvalue]) |
353 | Returns the negative row number of the topmost line. Minimum value |
605 | Returns the negative row number of the topmost line. Minimum value |
354 | is 0, which displays the normal terminal contents. Larger values |
606 | is 0, which displays the normal terminal contents. Larger values |
355 | scroll this many lines into the scrollback buffer. |
607 | scroll this many lines into the scrollback buffer. |
… | |
… | |
409 | $line = $term->line ($row_number) |
661 | $line = $term->line ($row_number) |
410 | Create and return a new "urxvt::line" object that stores information |
662 | Create and return a new "urxvt::line" object that stores information |
411 | about the logical line that row $row_number is part of. It supports |
663 | about the logical line that row $row_number is part of. It supports |
412 | the following methods: |
664 | the following methods: |
413 | |
665 | |
414 | $text = $line->t |
666 | $text = $line->t ([$new_text]) |
415 | Returns the full text of the line, similar to "ROW_t" |
667 | Returns or replaces the full text of the line, similar to |
|
|
668 | "ROW_t" |
416 | |
669 | |
417 | $rend = $line->r |
670 | $rend = $line->r ([$new_rend]) |
418 | Returns the full rendition array of the line, similar to "ROW_r" |
671 | Returns or replaces the full rendition array of the line, |
|
|
672 | similar to "ROW_r" |
419 | |
673 | |
420 | $length = $line->l |
674 | $length = $line->l |
421 | Returns the length of the line in cells, similar to "ROW_l". |
675 | Returns the length of the line in cells, similar to "ROW_l". |
422 | |
676 | |
423 | $rownum = $line->beg |
677 | $rownum = $line->beg |
… | |
… | |
430 | the logical line. |
684 | the logical line. |
431 | |
685 | |
432 | ($row, $col) = $line->coord_of ($offset) |
686 | ($row, $col) = $line->coord_of ($offset) |
433 | Translates a string offset into terminal coordinates again. |
687 | Translates a string offset into terminal coordinates again. |
434 | |
688 | |
435 | ($row, $col) = $line->coord_of ($offset) =item $text = |
|
|
436 | $term->special_encode $string |
689 | $text = $term->special_encode $string |
437 | Converts a perl string into the special encoding used by |
690 | Converts a perl string into the special encoding used by |
438 | rxvt-unicode, where one character corresponds to one screen cell. |
691 | rxvt-unicode, where one character corresponds to one screen cell. |
439 | See "$term->ROW_t" for details. |
692 | See "$term->ROW_t" for details. |
440 | |
693 | |
441 | $string = $term->special_decode $text |
694 | $string = $term->special_decode $text |
442 | Converts rxvt-unicodes text reprsentation into a perl string. See |
695 | Converts rxvt-unicodes text reprsentation into a perl string. See |
443 | "$term->ROW_t" for details. |
696 | "$term->ROW_t" for details. |
444 | |
697 | |
|
|
698 | $success = $term->grab_button ($button, $modifiermask) |
|
|
699 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
700 | |
|
|
701 | $success = $term->grab ($eventtime[, $sync]) |
|
|
702 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
703 | synchronous ($sync is true). Also remembers the grab timestampe. |
|
|
704 | |
|
|
705 | $term->allow_events_async |
|
|
706 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
707 | |
|
|
708 | $term->allow_events_sync |
|
|
709 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
710 | |
|
|
711 | $term->allow_events_replay |
|
|
712 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for |
|
|
713 | the most recent grab. |
|
|
714 | |
|
|
715 | $term->ungrab |
|
|
716 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
717 | evaluation errors, as it is better to lose the grab in the error |
|
|
718 | case as the session. |
|
|
719 | |
|
|
720 | The "urxvt::popup" Class |
|
|
721 | $popup->add_title ($title) |
|
|
722 | Adds a non-clickable title to the popup. |
|
|
723 | |
|
|
724 | $popup->add_separator ([$sepchr]) |
|
|
725 | Creates a separator, optionally using the character given as |
|
|
726 | $sepchr. |
|
|
727 | |
|
|
728 | $popup->add_button ($text, $cb) |
|
|
729 | Adds a clickable button to the popup. $cb is called whenever it is |
|
|
730 | selected. |
|
|
731 | |
|
|
732 | $popup->add_toggle ($text, $cb, $initial_value) |
|
|
733 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
734 | whenever it gets toggled, with a boolean indicating its value as its |
|
|
735 | first argument. |
|
|
736 | |
|
|
737 | $popup->show |
|
|
738 | Displays the popup (which is initially hidden). |
|
|
739 | |
445 | The "urxvt::timer" Class |
740 | The "urxvt::timer" Class |
446 | This class implements timer watchers/events. Time is represented as a |
741 | This class implements timer watchers/events. Time is represented as |
447 | fractional number of seconds since the epoch. Example: |
742 | a fractional number of seconds since the epoch. Example: |
448 | |
743 | |
449 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
744 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
450 | $term->{timer} = urxvt::timer |
745 | $term->{timer} = urxvt::timer |
451 | ->new |
746 | ->new |
452 | ->interval (1) |
747 | ->interval (1) |
453 | ->cb (sub { |
748 | ->cb (sub { |
454 | $term->{overlay}->set (0, 0, |
749 | $term->{overlay}->set (0, 0, |
455 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
750 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
456 | }); |
751 | }); |
457 | |
752 | |
458 | $timer = new urxvt::timer |
753 | $timer = new urxvt::timer |
459 | Create a new timer object in started state. It is scheduled to fire |
754 | Create a new timer object in started state. It is scheduled to |
460 | immediately. |
755 | fire immediately. |
461 | |
756 | |
462 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
757 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
463 | Set the callback to be called when the timer triggers. |
758 | Set the callback to be called when the timer triggers. |
464 | |
759 | |
465 | $tstamp = $timer->at |
760 | $tstamp = $timer->at |
466 | Return the time this watcher will fire next. |
761 | Return the time this watcher will fire next. |
467 | |
762 | |
468 | $timer = $timer->set ($tstamp) |
763 | $timer = $timer->set ($tstamp) |
469 | Set the time the event is generated to $tstamp. |
764 | Set the time the event is generated to $tstamp. |
470 | |
765 | |
471 | $timer = $timer->interval ($interval) |
766 | $timer = $timer->interval ($interval) |
472 | Normally (and when $interval is 0), the timer will automatically |
767 | Normally (and when $interval is 0), the timer will automatically |
473 | stop after it has fired once. If $interval is non-zero, then the |
768 | stop after it has fired once. If $interval is non-zero, then the |
474 | timer is automatically rescheduled at the given intervals. |
769 | timer is automatically rescheduled at the given intervals. |
475 | |
770 | |
476 | $timer = $timer->start |
771 | $timer = $timer->start |
477 | Start the timer. |
772 | Start the timer. |
478 | |
773 | |
479 | $timer = $timer->start ($tstamp) |
774 | $timer = $timer->start ($tstamp) |
480 | Set the event trigger time to $tstamp and start the timer. |
775 | Set the event trigger time to $tstamp and start the timer. |
481 | |
776 | |
482 | $timer = $timer->stop |
777 | $timer = $timer->stop |
483 | Stop the timer. |
778 | Stop the timer. |
484 | |
779 | |
485 | The "urxvt::iow" Class |
780 | The "urxvt::iow" Class |
486 | This class implements io watchers/events. Example: |
781 | This class implements io watchers/events. Example: |
487 | |
782 | |
488 | $term->{socket} = ... |
783 | $term->{socket} = ... |
489 | $term->{iow} = urxvt::iow |
784 | $term->{iow} = urxvt::iow |
490 | ->new |
785 | ->new |
491 | ->fd (fileno $term->{socket}) |
786 | ->fd (fileno $term->{socket}) |
492 | ->events (1) # wait for read data |
787 | ->events (urxvt::EVENT_READ) |
493 | ->start |
788 | ->start |
494 | ->cb (sub { |
789 | ->cb (sub { |
495 | my ($iow, $revents) = @_; |
790 | my ($iow, $revents) = @_; |
496 | # $revents must be 1 here, no need to check |
791 | # $revents must be 1 here, no need to check |
497 | sysread $term->{socket}, my $buf, 8192 |
792 | sysread $term->{socket}, my $buf, 8192 |
498 | or end-of-file; |
793 | or end-of-file; |
499 | }); |
794 | }); |
500 | |
795 | |
501 | $iow = new urxvt::iow |
796 | $iow = new urxvt::iow |
502 | Create a new io watcher object in stopped state. |
797 | Create a new io watcher object in stopped state. |
503 | |
798 | |
504 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
799 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
505 | Set the callback to be called when io events are triggered. |
800 | Set the callback to be called when io events are triggered. |
506 | $reventmask is a bitset as described in the "events" method. |
801 | $reventmask is a bitset as described in the "events" method. |
507 | |
802 | |
508 | $iow = $iow->fd ($fd) |
803 | $iow = $iow->fd ($fd) |
509 | Set the filedescriptor (not handle) to watch. |
804 | Set the filedescriptor (not handle) to watch. |
510 | |
805 | |
511 | $iow = $iow->events ($eventmask) |
806 | $iow = $iow->events ($eventmask) |
512 | Set the event mask to watch. Bit #0 (value 1) enables watching for |
807 | Set the event mask to watch. The only allowed values are |
513 | read data, Bit #1 (value 2) enables watching for write data. |
808 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be |
|
|
809 | ORed together, or "urxvt::EVENT_NONE". |
514 | |
810 | |
515 | $iow = $iow->start |
811 | $iow = $iow->start |
516 | Start watching for requested events on the given handle. |
812 | Start watching for requested events on the given handle. |
517 | |
813 | |
518 | $iow = $iow->stop |
814 | $iow = $iow->stop |
519 | Stop watching for events on the given filehandle. |
815 | Stop watching for events on the given filehandle. |
520 | |
816 | |
521 | ENVIRONMENT |
817 | ENVIRONMENT |
522 | URXVT_PERL_VERBOSITY |
818 | URXVT_PERL_VERBOSITY |
523 | This variable controls the verbosity level of the perl extension. Higher |
819 | This variable controls the verbosity level of the perl extension. |
524 | numbers indicate more verbose output. |
820 | Higher numbers indicate more verbose output. |
525 | |
821 | |
526 | =0 - only fatal messages |
822 | == 0 - fatal messages |
527 | =3 - script loading and management |
823 | >= 3 - script loading and management |
528 | =10 - all events received |
824 | >=10 - all events received |
529 | |
825 | |
530 | AUTHOR |
826 | AUTHOR |
531 | Marc Lehmann <pcg@goof.com> |
827 | Marc Lehmann <pcg@goof.com> |
532 | http://software.schmorp.de/pkg/rxvt-unicode |
828 | http://software.schmorp.de/pkg/rxvt-unicode |
533 | |
829 | |