… | |
… | |
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 | Or by adding them to the resource for extensions loaded by default: |
|
|
35 | |
|
|
36 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
|
|
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). Right |
40 | intelligent when the user extends selections (double-click and |
37 | now, it tries to select urls and complete shell-quoted arguments, |
41 | further clicks). Right now, it tries to select words, urls and |
38 | which is very convenient, too, if your ls supports |
42 | complete shell-quoted arguments, which is very convenient, too, if |
39 | "--quoting-style=shell". |
43 | your ls supports "--quoting-style=shell". |
40 | |
44 | |
|
|
45 | A double-click usually selects the word under the cursor, further |
|
|
46 | clicks will enlarge the selection. |
|
|
47 | |
|
|
48 | The selection works by trying to match a number of regexes and |
|
|
49 | displaying them in increasing order of length. You can add your own |
|
|
50 | regexes by specifying resources of the form: |
|
|
51 | |
|
|
52 | URxvt.selection.pattern-0: perl-regex |
|
|
53 | URxvt.selection.pattern-1: perl-regex |
|
|
54 | ... |
|
|
55 | |
|
|
56 | The index number (0, 1...) must not have any holes, and each regex |
|
|
57 | must contain at least one pair of capturing parentheses, which will |
|
|
58 | be used for the match. For example, the followign adds a regex that |
|
|
59 | matches everything between two vertical bars: |
|
|
60 | |
|
|
61 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
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 | |
|
|
70 | You can look at the source of the selection extension to see more |
|
|
71 | interesting uses, such as parsing a line from beginning to end. |
|
|
72 | |
41 | It also offers the following bindable keyboard command: |
73 | This extension also offers following bindable keyboard commands: |
42 | |
74 | |
43 | rot13 |
75 | rot13 |
44 | Rot-13 the selection when activated. Used via keyboard trigger: |
76 | Rot-13 the selection when activated. Used via keyboard trigger: |
45 | |
77 | |
46 | URxvt.keysym.C-M-r: perl:selection:rot13 |
78 | URxvt.keysym.C-M-r: perl:selection:rot13 |
… | |
… | |
50 | options at runtime. |
82 | options at runtime. |
51 | |
83 | |
52 | selection-popup (enabled by default) |
84 | selection-popup (enabled by default) |
53 | 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 |
54 | selection text into various other formats/action (such as uri |
86 | selection text into various other formats/action (such as uri |
55 | unescaping, perl evalution, web-browser starting etc.), depending on |
87 | unescaping, perl evaluation, web-browser starting etc.), depending |
56 | 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 | }; |
57 | |
109 | |
58 | searchable-scrollback<hotkey> (enabled by default) |
110 | searchable-scrollback<hotkey> (enabled by default) |
59 | Adds regex search functionality to the scrollback buffer, triggered |
111 | Adds regex search functionality to the scrollback buffer, triggered |
60 | by a hotkey (default: "M-s"). When in search mode, normal terminal |
112 | by a hotkey (default: "M-s"). While in search mode, normal terminal |
61 | input/output is suspended. |
113 | input/output is suspended and a regex is displayed at the bottom of |
|
|
114 | the screen. |
62 | |
115 | |
63 | "/" starts an incremental regex search, "n" searches further, "p" or |
116 | Inputting characters appends them to the regex and continues |
64 | "N" jump to the previous match, "G" jumps to the bottom and clears |
117 | incremental search. "BackSpace" removes a character from the regex, |
65 | the history, "enter" leaves search mode at the current position and |
118 | "Up" and "Down" search upwards/downwards in the scrollback buffer, |
66 | "escape" returns to the original position. |
119 | "End" jumps to the bottom. "Escape" leaves search mode and returns |
|
|
120 | to the point where search was started, while "Enter" or "Return" |
|
|
121 | stay at the current position and additionally stores the first match |
|
|
122 | in the current line into the primary selection. |
67 | |
123 | |
68 | digital-clock |
124 | readline (enabled by default) |
69 | Displays a digital clock using the built-in overlay. |
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 | |
|
|
142 | selection-autotransform |
|
|
143 | This selection allows you to do automatic transforms on a selection |
|
|
144 | whenever a selection is made. |
|
|
145 | |
|
|
146 | It works by specifying perl snippets (most useful is a single "s///" |
|
|
147 | operator) that modify $_ as resources: |
|
|
148 | |
|
|
149 | URxvt.selection-autotransform.0: transform |
|
|
150 | URxvt.selection-autotransform.1: transform |
|
|
151 | ... |
|
|
152 | |
|
|
153 | For example, the following will transform selections of the form |
|
|
154 | "filename:number", often seen in compiler messages, into "vi |
|
|
155 | +$filename $word": |
|
|
156 | |
|
|
157 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
158 | |
|
|
159 | And this example matches the same,but replaces it with vi-commands |
|
|
160 | you can paste directly into your (vi :) editor: |
|
|
161 | |
|
|
162 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
163 | |
|
|
164 | Of course, this can be modified to suit your needs and your editor |
|
|
165 | :) |
|
|
166 | |
|
|
167 | To expand the example above to typical perl error messages ("XXX at |
|
|
168 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
169 | |
|
|
170 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
171 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
172 | |
|
|
173 | The first line tells the selection code to treat the unchanging part |
|
|
174 | of every error message as a selection pattern, and the second line |
|
|
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. |
70 | |
198 | |
71 | mark-urls |
199 | mark-urls |
72 | Uses per-line display filtering ("on_line_update") to underline |
200 | Uses per-line display filtering ("on_line_update") to underline urls |
73 | urls. |
201 | and make them clickable. When middle-clicked, the program specified |
|
|
202 | in the resource "urlLauncher" (default "x-www-browser") will be |
|
|
203 | started with the URL as first argument. |
|
|
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 |
74 | |
223 | |
75 | block-graphics-to-ascii |
224 | block-graphics-to-ascii |
76 | 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 |
77 | terminal, by replacing all line-drawing characters (U+2500 .. |
226 | terminal, by replacing all line-drawing characters (U+2500 .. |
78 | U+259F) by a similar-looking ascii character. |
227 | U+259F) by a similar-looking ascii character. |
|
|
228 | |
|
|
229 | digital-clock |
|
|
230 | Displays a digital clock using the built-in overlay. |
|
|
231 | |
|
|
232 | remote-clipboard |
|
|
233 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
234 | selection popup that allows one ti run external commands to store |
|
|
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' |
|
|
250 | |
|
|
251 | selection-pastebin |
|
|
252 | This is a little rarely useful extension that Uploads the selection |
|
|
253 | as textfile to a remote site (or does other things). (The |
|
|
254 | implementation is not currently secure for use in a multiuser |
|
|
255 | environment as it writes to /tmp directly.). |
|
|
256 | |
|
|
257 | It listens to the "selection-pastebin:remote-pastebin" keyboard |
|
|
258 | command, i.e. |
|
|
259 | |
|
|
260 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
261 | |
|
|
262 | Pressing this combination runs a command with "%" replaced by the |
|
|
263 | name of the textfile. This command can be set via a resource: |
|
|
264 | |
|
|
265 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
266 | |
|
|
267 | And the default is likely not useful to anybody but the few people |
|
|
268 | around here :) |
|
|
269 | |
|
|
270 | The name of the textfile is the hex encoded md5 sum of the |
|
|
271 | selection, so the same content should lead to the same filename. |
|
|
272 | |
|
|
273 | After a successful upload the selection will be replaced by the text |
|
|
274 | given in the "selection-pastebin-url" resource (again, the % is the |
|
|
275 | placeholder for the filename): |
|
|
276 | |
|
|
277 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
79 | |
278 | |
80 | example-refresh-hooks |
279 | example-refresh-hooks |
81 | Displays a very simple digital clock in the upper right corner of |
280 | Displays a very simple digital clock in the upper right corner of |
82 | the window. Illustrates overwriting the refresh callbacks to create |
281 | the window. Illustrates overwriting the refresh callbacks to create |
83 | your own overlays or changes. |
282 | your own overlays or changes. |
… | |
… | |
98 | Argument names also often indicate the type of a parameter. Here are |
297 | Argument names also often indicate the type of a parameter. Here are |
99 | some hints on what they mean: |
298 | some hints on what they mean: |
100 | |
299 | |
101 | $text |
300 | $text |
102 | Rxvt-unicodes special way of encoding text, where one "unicode" |
301 | Rxvt-unicodes special way of encoding text, where one "unicode" |
103 | character always represents one screen cell. See row_t for a |
302 | character always represents one screen cell. See ROW_t for a |
104 | discussion of this format. |
303 | discussion of this format. |
105 | |
304 | |
106 | $string |
305 | $string |
107 | A perl text string, with an emphasis on *text*. It can store all |
306 | 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 |
307 | unicode characters and is to be distinguished with text encoded in a |
… | |
… | |
142 | be called whenever the relevant event happens. |
341 | be called whenever the relevant event happens. |
143 | |
342 | |
144 | 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 |
145 | the in the "Extension Objects" section. |
344 | the in the "Extension Objects" section. |
146 | |
345 | |
147 | 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 |
148 | 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 |
149 | 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. |
150 | code. |
|
|
151 | |
349 | |
152 | *When in doubt, return a false value (preferably "()").* |
350 | *When in doubt, return a false value (preferably "()").* |
153 | |
351 | |
154 | on_init $term |
352 | on_init $term |
155 | Called after a new terminal object has been initialized, but before |
353 | Called after a new terminal object has been initialized, but before |
156 | 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 |
157 | to call or deliver senseless data, as terminal size and other |
355 | to call or deliver senseless data, as terminal size and other |
158 | characteristics have not yet been determined. You can safely query |
356 | characteristics have not yet been determined. You can safely query |
159 | 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). |
160 | |
368 | |
161 | on_reset $term |
369 | on_reset $term |
162 | 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 |
163 | 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 |
164 | size-related variables. |
372 | size-related variables. |
165 | |
373 | |
166 | on_start $term |
374 | on_child_start $term, $pid |
167 | Called at the very end of initialisation of a new terminal, just |
375 | Called just after the child process has been "fork"ed. |
168 | 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". |
169 | |
380 | |
170 | on_sel_make $term, $eventtime |
381 | on_sel_make $term, $eventtime |
171 | 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 |
172 | 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 |
173 | type of the selection will be honored. |
384 | type of the selection will be honored. |
… | |
… | |
186 | |
397 | |
187 | on_sel_extend $term |
398 | on_sel_extend $term |
188 | Called whenever the user tries to extend the selection (e.g. with a |
399 | Called whenever the user tries to extend the selection (e.g. with a |
189 | double click) and is either supposed to return false (normal |
400 | double click) and is either supposed to return false (normal |
190 | operation), or should extend the selection itelf and return true to |
401 | operation), or should extend the selection itelf and return true to |
191 | suppress the built-in processing. |
402 | suppress the built-in processing. This can happen multiple times, as |
|
|
403 | long as the callback returns true, it will be called on every |
|
|
404 | further click by the user and is supposed to enlarge the selection |
|
|
405 | more and more, if possible. |
192 | |
406 | |
193 | See the selection example extension. |
407 | See the selection example extension. |
194 | |
408 | |
195 | on_view_change $term, $offset |
409 | on_view_change $term, $offset |
196 | Called whenever the view offset changes, i..e the user or program |
410 | Called whenever the view offset changes, i..e the user or program |
… | |
… | |
250 | display code is run after this hook, and takes precedence. |
464 | display code is run after this hook, and takes precedence. |
251 | |
465 | |
252 | on_refresh_end $term |
466 | on_refresh_end $term |
253 | Called just after the screen gets redrawn. See "on_refresh_begin". |
467 | Called just after the screen gets redrawn. See "on_refresh_begin". |
254 | |
468 | |
255 | on_keyboard_command $term, $string |
469 | on_user_command $term, $string |
256 | Called whenever the user presses a key combination that has a |
470 | Called whenever the a user-configured event is being activated (e.g. |
257 | "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 |
258 | 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. |
|
|
476 | |
|
|
477 | on_x_event $term, $event |
|
|
478 | Called on every X event received on the vt window (and possibly |
|
|
479 | other windows). Should only be used as a last resort. Most event |
|
|
480 | structure members are not passed. |
259 | |
481 | |
260 | on_focus_in $term |
482 | on_focus_in $term |
261 | Called whenever the window gets the keyboard focus, before |
483 | Called whenever the window gets the keyboard focus, before |
262 | rxvt-unicode does focus in processing. |
484 | rxvt-unicode does focus in processing. |
263 | |
485 | |
264 | on_focus_out $term |
486 | on_focus_out $term |
265 | Called wheneever the window loses keyboard focus, before |
487 | Called wheneever the window loses keyboard focus, before |
266 | rxvt-unicode does focus out processing. |
488 | rxvt-unicode does focus out processing. |
267 | |
489 | |
|
|
490 | on_configure_notify $term, $event |
|
|
491 | on_property_notify $term, $event |
268 | on_key_press $term, $event, $keysym, $octets |
492 | on_key_press $term, $event, $keysym, $octets |
269 | on_key_release $term, $event, $keysym |
493 | on_key_release $term, $event, $keysym |
270 | on_button_press $term, $event |
494 | on_button_press $term, $event |
271 | on_button_release $term, $event |
495 | on_button_release $term, $event |
272 | on_motion_notify $term, $event |
496 | on_motion_notify $term, $event |
… | |
… | |
276 | 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 |
277 | rxvt-unicode. |
501 | rxvt-unicode. |
278 | |
502 | |
279 | 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 |
280 | XEvent manpage), with the additional members "row" and "col", which |
504 | XEvent manpage), with the additional members "row" and "col", which |
281 | are the row and column under the mouse cursor. |
505 | are the (real, not screen-based) row and column under the mouse |
|
|
506 | cursor. |
282 | |
507 | |
283 | "on_key_press" additionally receives the string rxvt-unicode would |
508 | "on_key_press" additionally receives the string rxvt-unicode would |
284 | output, if any, in locale-specific encoding. |
509 | output, if any, in locale-specific encoding. |
285 | |
510 | |
286 | 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). |
287 | |
518 | |
288 | Variables in the "urxvt" Package |
519 | Variables in the "urxvt" Package |
289 | $urxvt::LIBDIR |
520 | $urxvt::LIBDIR |
290 | The rxvt-unicode library directory, where, among other things, the |
521 | The rxvt-unicode library directory, where, among other things, the |
291 | perl modules and scripts are stored. |
522 | perl modules and scripts are stored. |
… | |
… | |
299 | |
530 | |
300 | $urxvt::TERM |
531 | $urxvt::TERM |
301 | The current terminal. This variable stores the current "urxvt::term" |
532 | The current terminal. This variable stores the current "urxvt::term" |
302 | object, whenever a callback/hook is executing. |
533 | object, whenever a callback/hook is executing. |
303 | |
534 | |
304 | * |
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. |
305 | |
550 | |
306 | Functions in the "urxvt" Package |
551 | Functions in the "urxvt" Package |
307 | $term = new urxvt [arg...] |
|
|
308 | Creates a new terminal, very similar as if you had started it with |
|
|
309 | "system $binfile, arg...". Croaks (and probably outputs an error |
|
|
310 | message) if the new instance couldn't be created. Returns "undef" if |
|
|
311 | the new instance didn't initialise perl, and the terminal object |
|
|
312 | otherwise. The "init" and "start" hooks will be called during the |
|
|
313 | call. |
|
|
314 | |
|
|
315 | urxvt::fatal $errormessage |
552 | urxvt::fatal $errormessage |
316 | Fatally aborts execution with the given error message. Avoid at all |
553 | Fatally aborts execution with the given error message. Avoid at all |
317 | 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 |
318 | starts up. |
555 | starts up. |
319 | |
556 | |
… | |
… | |
323 | function that calls this function. |
560 | function that calls this function. |
324 | |
561 | |
325 | 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 |
326 | correct place, e.g. on stderr of the connecting urxvtc client. |
563 | correct place, e.g. on stderr of the connecting urxvtc client. |
327 | |
564 | |
328 | $is_safe = urxvt::safe |
565 | Messages have a size limit of 1023 bytes currently. |
329 | Returns true when it is safe to do potentially unsafe things, such |
566 | |
330 | as evaluating perl code specified by the user. This is true when |
567 | @terms = urxvt::termlist |
331 | urxvt was started setuid or setgid. |
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). |
332 | |
573 | |
333 | $time = urxvt::NOW |
574 | $time = urxvt::NOW |
334 | Returns the "current time" (as per the event loop). |
575 | Returns the "current time" (as per the event loop). |
335 | |
576 | |
336 | urxvt::CurrentTime |
577 | urxvt::CurrentTime |
337 | urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
578 | urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, |
338 | Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
579 | Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, |
339 | Button5Mask, AnyModifier |
580 | Button5Mask, AnyModifier |
|
|
581 | urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, |
|
|
582 | ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, |
|
|
583 | PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
584 | Button3MotionMask, Button4MotionMask, Button5MotionMask, |
|
|
585 | ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, |
|
|
586 | StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, |
|
|
587 | SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, |
|
|
588 | ColormapChangeMask, OwnerGrabButtonMask |
|
|
589 | urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
590 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
591 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
592 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
593 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
594 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
595 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
340 | Various constants for use in X calls and event processing. |
596 | Various constants for use in X calls and event processing. |
341 | |
597 | |
342 | RENDITION |
598 | RENDITION |
343 | Rendition bitsets contain information about colour, font, font styles |
599 | Rendition bitsets contain information about colour, font, font styles |
344 | and similar information for each screen cell. |
600 | and similar information for each screen cell. |
… | |
… | |
365 | $background = urxvt::GET_BASEBG $rend |
621 | $background = urxvt::GET_BASEBG $rend |
366 | Return the foreground/background colour index, respectively. |
622 | Return the foreground/background colour index, respectively. |
367 | |
623 | |
368 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
624 | $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
369 | $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 |
370 | Replace the foreground/background colour in the rendition mask with |
627 | Replace the foreground/background colour in the rendition mask with |
371 | the specified one. |
628 | the specified one. |
372 | |
629 | |
373 | $value = urxvt::GET_CUSTOM $rend |
630 | $value = urxvt::GET_CUSTOM $rend |
374 | 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 |
… | |
… | |
385 | condition variables, but non-blocking condvar use is ok. What this means |
642 | condition variables, but non-blocking condvar use is ok. What this means |
386 | is that you cannot use blocking APIs, but the non-blocking variant |
643 | is that you cannot use blocking APIs, but the non-blocking variant |
387 | should work. |
644 | should work. |
388 | |
645 | |
389 | The "urxvt::term" Class |
646 | The "urxvt::term" Class |
|
|
647 | $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
648 | Creates a new terminal, very similar as if you had started it with |
|
|
649 | system "$rxvtname, arg...". $envhashref must be a reference to a |
|
|
650 | %ENV-like hash which defines the environment of the new terminal. |
|
|
651 | |
|
|
652 | Croaks (and probably outputs an error message) if the new instance |
|
|
653 | couldn't be created. Returns "undef" if the new instance didn't |
|
|
654 | initialise perl, and the terminal object otherwise. The "init" and |
|
|
655 | "start" hooks will be called before this call returns, and are free |
|
|
656 | to refer to global data (which is race free). |
|
|
657 | |
390 | $term->destroy |
658 | $term->destroy |
391 | Destroy the terminal object (close the window, free resources etc.). |
659 | Destroy the terminal object (close the window, free resources etc.). |
392 | 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 |
393 | (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. |
394 | |
671 | |
395 | $isset = $term->option ($optval[, $set]) |
672 | $isset = $term->option ($optval[, $set]) |
396 | Returns true if the option specified by $optval is enabled, and |
673 | Returns true if the option specified by $optval is enabled, and |
397 | 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 |
398 | 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 |
… | |
… | |
401 | 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 |
402 | the source file /src/optinc.h to see the actual list: |
679 | the source file /src/optinc.h to see the actual list: |
403 | |
680 | |
404 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
681 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
405 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
682 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
406 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
683 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
407 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
684 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
408 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
685 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
409 | tripleclickwords utmpInhibit visualBell |
686 | transparent tripleclickwords utmpInhibit visualBell |
410 | |
687 | |
411 | $value = $term->resource ($name[, $newval]) |
688 | $value = $term->resource ($name[, $newval]) |
412 | Returns the current resource value associated with a given name and |
689 | Returns the current resource value associated with a given name and |
413 | 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 |
414 | "init" hook. Unset resources are returned and accepted as "undef". |
691 | "init" hook. Unset resources are returned and accepted as "undef". |
… | |
… | |
431 | |
708 | |
432 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
709 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
433 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
710 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
434 | display_name embed ext_bwidth fade font geometry hold iconName |
711 | display_name embed ext_bwidth fade font geometry hold iconName |
435 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
712 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
436 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
713 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
437 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
714 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
438 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
715 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
439 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
716 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
440 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
717 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
441 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
718 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
|
|
719 | secondaryScreen secondaryScroll selectstyle shade term_name title |
442 | shade term_name title transparent transparent_all tripleclickwords |
720 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
443 | utmpInhibit visualBell |
721 | visualBell |
|
|
722 | |
|
|
723 | $value = $term->x_resource ($pattern) |
|
|
724 | Returns the X-Resource for the given pattern, excluding the program |
|
|
725 | or class name, i.e. "$term->x_resource ("boldFont")" should return |
|
|
726 | the same value as used by this instance of rxvt-unicode. Returns |
|
|
727 | "undef" if no resource with that pattern exists. |
|
|
728 | |
|
|
729 | This method should only be called during the "on_start" hook, as |
|
|
730 | there is only one resource database per display, and later |
|
|
731 | invocations might return the wrong resources. |
444 | |
732 | |
445 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
733 | $success = $term->parse_keysym ($keysym_spec, $command_string) |
446 | Adds a keymap translation exactly as specified via a resource. See |
734 | Adds a keymap translation exactly as specified via a resource. See |
447 | the "keysym" resource in the rxvt(1) manpage. |
735 | the "keysym" resource in the rxvt(1) manpage. |
448 | |
736 | |
… | |
… | |
459 | ($row, $col) = $term->selection_beg ([$row, $col]) |
747 | ($row, $col) = $term->selection_beg ([$row, $col]) |
460 | ($row, $col) = $term->selection_end ([$row, $col]) |
748 | ($row, $col) = $term->selection_end ([$row, $col]) |
461 | Return the current values of the selection mark, begin or end |
749 | Return the current values of the selection mark, begin or end |
462 | positions, and optionally set them to new values. |
750 | positions, and optionally set them to new values. |
463 | |
751 | |
|
|
752 | $term->selection_make ($eventtime[, $rectangular]) |
|
|
753 | Tries to make a selection as set by "selection_beg" and |
|
|
754 | "selection_end". If $rectangular is true (default: false), a |
|
|
755 | rectangular selection will be made. This is the prefered function to |
|
|
756 | make a selection. |
|
|
757 | |
464 | $success = $term->selection_grab ($eventtime) |
758 | $success = $term->selection_grab ($eventtime) |
465 | Try to request the primary selection from the server (for example, |
759 | Try to request the primary selection text from the server (for |
466 | as set by the next method). |
760 | example, as set by the next method). No visual feedback will be |
|
|
761 | given. This function is mostly useful from within "on_sel_grab" |
|
|
762 | hooks. |
467 | |
763 | |
468 | $oldtext = $term->selection ([$newtext]) |
764 | $oldtext = $term->selection ([$newtext]) |
469 | Return the current selection text and optionally replace it by |
765 | Return the current selection text and optionally replace it by |
470 | $newtext. |
766 | $newtext. |
471 | |
767 | |
… | |
… | |
516 | $string = $term->locale_decode ($octets) |
812 | $string = $term->locale_decode ($octets) |
517 | Convert the given locale-encoded octets into a perl string. |
813 | Convert the given locale-encoded octets into a perl string. |
518 | |
814 | |
519 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
815 | $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
520 | XORs the rendition values in the given span with the provided value |
816 | XORs the rendition values in the given span with the provided value |
521 | (default: "RS_RVid"). Useful in refresh hooks to provide effects |
817 | (default: "RS_RVid"), which *MUST NOT* contain font styles. Useful |
522 | similar to the selection. |
818 | in refresh hooks to provide effects similar to the selection. |
523 | |
819 | |
524 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
820 | $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, |
525 | $rstyle2]]) |
821 | $rstyle2]]) |
526 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
822 | Similar to "scr_xor_span", but xors a rectangle instead. Trailing |
527 | whitespace will additionally be xored with the $rstyle2, which |
823 | whitespace will additionally be xored with the $rstyle2, which |
528 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
824 | defaults to "RS_RVid | RS_Uline", which removes reverse video again |
529 | and underlines it instead. |
825 | and underlines it instead. Both styles *MUST NOT* contain font |
|
|
826 | styles. |
530 | |
827 | |
531 | $term->scr_bell |
828 | $term->scr_bell |
532 | Ring the bell! |
829 | Ring the bell! |
533 | |
830 | |
534 | $term->scr_add_lines ($string) |
831 | $term->scr_add_lines ($string) |
… | |
… | |
540 | |
837 | |
541 | 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 |
542 | be confused by changes in cursor position or scrolling. Its useful |
839 | be confused by changes in cursor position or scrolling. Its useful |
543 | inside a "on_add_lines" hook, though. |
840 | inside a "on_add_lines" hook, though. |
544 | |
841 | |
|
|
842 | $term->scr_change_screen ($screen) |
|
|
843 | Switch to given screen - 0 primary, 1 secondary. |
|
|
844 | |
545 | $term->cmd_parse ($octets) |
845 | $term->cmd_parse ($octets) |
546 | 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 |
547 | locale-specific encoding of the terminal and can contain command |
847 | locale-specific encoding of the terminal and can contain command |
548 | sequences (escape codes) that will be interpreted. |
848 | sequences (escape codes) that will be interpreted. |
549 | |
849 | |
… | |
… | |
557 | 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. |
558 | 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. |
559 | See the description of "urxvt::timer->events". Make sure to always |
859 | See the description of "urxvt::timer->events". Make sure to always |
560 | restore the previous value. |
860 | restore the previous value. |
561 | |
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 | |
562 | $windowid = $term->parent |
866 | $windowid = $term->parent |
563 | Return the window id of the toplevel window. |
867 | Return the window id of the toplevel window. |
564 | |
868 | |
565 | $windowid = $term->vt |
869 | $windowid = $term->vt |
566 | Return the window id of the terminal window. |
870 | Return the window id of the terminal window. |
|
|
871 | |
|
|
872 | $term->vt_emask_add ($x_event_mask) |
|
|
873 | Adds the specified events to the vt event mask. Useful e.g. when you |
|
|
874 | want to receive pointer events all the times: |
|
|
875 | |
|
|
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. |
567 | |
883 | |
568 | $window_width = $term->width |
884 | $window_width = $term->width |
569 | $window_height = $term->height |
885 | $window_height = $term->height |
570 | $font_width = $term->fwidth |
886 | $font_width = $term->fwidth |
571 | $font_height = $term->fheight |
887 | $font_height = $term->fheight |
… | |
… | |
574 | $terminal_columns = $term->ncol |
890 | $terminal_columns = $term->ncol |
575 | $has_focus = $term->focus |
891 | $has_focus = $term->focus |
576 | $is_mapped = $term->mapped |
892 | $is_mapped = $term->mapped |
577 | $max_scrollback = $term->saveLines |
893 | $max_scrollback = $term->saveLines |
578 | $nrow_plus_saveLines = $term->total_rows |
894 | $nrow_plus_saveLines = $term->total_rows |
579 | $lines_in_scrollback = $term->nsaved |
895 | $topmost_scrollback_row = $term->top_row |
580 | Return various integers describing terminal characteristics. |
896 | Return various integers describing terminal characteristics. |
|
|
897 | |
|
|
898 | $x_display = $term->display_id |
|
|
899 | Return the DISPLAY used by rxvt-unicode. |
581 | |
900 | |
582 | $lc_ctype = $term->locale |
901 | $lc_ctype = $term->locale |
583 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
902 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
584 | |
903 | |
585 | $x_display = $term->display_id |
904 | $env = $term->env |
586 | Return the DISPLAY used by rxvt-unicode. |
905 | Returns a copy of the environment in effect for the terminal as a |
|
|
906 | hashref similar to "\%ENV". |
587 | |
907 | |
588 | $modifiermask = $term->ModLevel3Mask |
908 | $modifiermask = $term->ModLevel3Mask |
589 | $modifiermask = $term->ModMetaMask |
909 | $modifiermask = $term->ModMetaMask |
590 | $modifiermask = $term->ModNumLockMask |
910 | $modifiermask = $term->ModNumLockMask |
591 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
911 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
592 | (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 |
593 | applicable. |
913 | applicable. |
594 | |
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 | |
595 | $view_start = $term->view_start ([$newvalue]) |
921 | $view_start = $term->view_start ([$newvalue]) |
596 | Returns the negative row number of the topmost line. Minimum value |
922 | Returns the row number of the topmost displayed line. Maximum value |
597 | is 0, which displays the normal terminal contents. Larger values |
923 | is 0, which displays the normal terminal contents. Lower values |
598 | scroll this many lines into the scrollback buffer. |
924 | scroll this many lines into the scrollback buffer. |
599 | |
925 | |
600 | $term->want_refresh |
926 | $term->want_refresh |
601 | Requests a screen refresh. At the next opportunity, rxvt-unicode |
927 | Requests a screen refresh. At the next opportunity, rxvt-unicode |
602 | will compare the on-screen display with its stored representation. |
928 | will compare the on-screen display with its stored representation. |
… | |
… | |
615 | 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 |
616 | 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 |
617 | automatically be updated. |
943 | automatically be updated. |
618 | |
944 | |
619 | $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 |
620 | more than one cell when displayed are padded with urxvt::NOCHAR |
946 | more than one cell when displayed are padded with $urxvt::NOCHAR |
621 | characters ("chr 65535"). Characters with combining characters and |
947 | (chr 65535) characters. Characters with combining characters and |
622 | 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 |
623 | be replaced with characters in the private use area. |
949 | be replaced with characters in the private use area. |
624 | |
950 | |
625 | 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 |
626 | 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 |
… | |
… | |
670 | Return the row number of the first/last row of the line, |
996 | Return the row number of the first/last row of the line, |
671 | respectively. |
997 | respectively. |
672 | |
998 | |
673 | $offset = $line->offset_of ($row, $col) |
999 | $offset = $line->offset_of ($row, $col) |
674 | Returns the character offset of the given row|col pair within |
1000 | Returns the character offset of the given row|col pair within |
675 | the logical line. |
1001 | the logical line. Works for rows outside the line, too, and |
|
|
1002 | returns corresponding offsets outside the string. |
676 | |
1003 | |
677 | ($row, $col) = $line->coord_of ($offset) |
1004 | ($row, $col) = $line->coord_of ($offset) |
678 | Translates a string offset into terminal coordinates again. |
1005 | Translates a string offset into terminal coordinates again. |
679 | |
1006 | |
680 | $text = $term->special_encode $string |
1007 | $text = $term->special_encode $string |
… | |
… | |
684 | |
1011 | |
685 | $string = $term->special_decode $text |
1012 | $string = $term->special_decode $text |
686 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1013 | Converts rxvt-unicodes text reprsentation into a perl string. See |
687 | "$term->ROW_t" for details. |
1014 | "$term->ROW_t" for details. |
688 | |
1015 | |
689 | $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]) |
690 | Registers a synchronous button grab. See the XGrabButton manpage. |
1019 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1020 | manpage. |
691 | |
1021 | |
692 | $success = $term->grab ($eventtime[, $sync]) |
1022 | $success = $term->grab ($eventtime[, $sync]) |
693 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1023 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
694 | synchronous ($sync is true). Also remembers the grab timestampe. |
1024 | synchronous ($sync is true). Also remembers the grab timestampe. |
695 | |
1025 | |
… | |
… | |
706 | $term->ungrab |
1036 | $term->ungrab |
707 | Calls XUngrab for the most recent grab. Is called automatically on |
1037 | Calls XUngrab for the most recent grab. Is called automatically on |
708 | 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 |
709 | case as the session. |
1039 | case as the session. |
710 | |
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. |
|
|
1059 | |
711 | The "urxvt::popup" Class |
1060 | The "urxvt::popup" Class |
712 | $popup->add_title ($title) |
1061 | $popup->add_title ($title) |
713 | Adds a non-clickable title to the popup. |
1062 | Adds a non-clickable title to the popup. |
714 | |
1063 | |
715 | $popup->add_separator ([$sepchr]) |
1064 | $popup->add_separator ([$sepchr]) |
… | |
… | |
727 | |
1076 | |
728 | $popup->show |
1077 | $popup->show |
729 | Displays the popup (which is initially hidden). |
1078 | Displays the popup (which is initially hidden). |
730 | |
1079 | |
731 | The "urxvt::timer" Class |
1080 | The "urxvt::timer" Class |
732 | This class implements timer watchers/events. Time is represented as |
1081 | This class implements timer watchers/events. Time is represented as a |
733 | a fractional number of seconds since the epoch. Example: |
1082 | fractional number of seconds since the epoch. Example: |
734 | |
1083 | |
735 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
1084 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
736 | $term->{timer} = urxvt::timer |
1085 | $term->{timer} = urxvt::timer |
737 | ->new |
1086 | ->new |
738 | ->interval (1) |
1087 | ->interval (1) |
739 | ->cb (sub { |
1088 | ->cb (sub { |
740 | $term->{overlay}->set (0, 0, |
1089 | $term->{overlay}->set (0, 0, |
741 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1090 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
742 | }); |
1091 | }); |
743 | |
1092 | |
744 | $timer = new urxvt::timer |
1093 | $timer = new urxvt::timer |
745 | Create a new timer object in started state. It is scheduled to |
1094 | Create a new timer object in started state. It is scheduled to fire |
746 | fire immediately. |
1095 | immediately. |
747 | |
1096 | |
748 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
1097 | $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
749 | Set the callback to be called when the timer triggers. |
1098 | Set the callback to be called when the timer triggers. |
750 | |
1099 | |
751 | $tstamp = $timer->at |
1100 | $tstamp = $timer->at |
752 | Return the time this watcher will fire next. |
1101 | Return the time this watcher will fire next. |
753 | |
1102 | |
754 | $timer = $timer->set ($tstamp) |
1103 | $timer = $timer->set ($tstamp) |
755 | Set the time the event is generated to $tstamp. |
1104 | Set the time the event is generated to $tstamp. |
756 | |
1105 | |
757 | $timer = $timer->interval ($interval) |
1106 | $timer = $timer->interval ($interval) |
758 | Normally (and when $interval is 0), the timer will automatically |
1107 | Normally (and when $interval is 0), the timer will automatically |
759 | stop after it has fired once. If $interval is non-zero, then the |
1108 | stop after it has fired once. If $interval is non-zero, then the |
760 | timer is automatically rescheduled at the given intervals. |
1109 | timer is automatically rescheduled at the given intervals. |
761 | |
1110 | |
762 | $timer = $timer->start |
1111 | $timer = $timer->start |
763 | Start the timer. |
1112 | Start the timer. |
764 | |
1113 | |
765 | $timer = $timer->start ($tstamp) |
1114 | $timer = $timer->start ($tstamp) |
766 | Set the event trigger time to $tstamp and start the timer. |
1115 | Set the event trigger time to $tstamp and start the timer. |
767 | |
1116 | |
|
|
1117 | $timer = $timer->after ($delay) |
|
|
1118 | Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>. |
|
|
1119 | |
768 | $timer = $timer->stop |
1120 | $timer = $timer->stop |
769 | Stop the timer. |
1121 | Stop the timer. |
770 | |
1122 | |
771 | The "urxvt::iow" Class |
1123 | The "urxvt::iow" Class |
772 | This class implements io watchers/events. Example: |
1124 | This class implements io watchers/events. Example: |
773 | |
1125 | |
774 | $term->{socket} = ... |
1126 | $term->{socket} = ... |
775 | $term->{iow} = urxvt::iow |
1127 | $term->{iow} = urxvt::iow |
|
|
1128 | ->new |
|
|
1129 | ->fd (fileno $term->{socket}) |
|
|
1130 | ->events (urxvt::EVENT_READ) |
|
|
1131 | ->start |
|
|
1132 | ->cb (sub { |
|
|
1133 | my ($iow, $revents) = @_; |
|
|
1134 | # $revents must be 1 here, no need to check |
|
|
1135 | sysread $term->{socket}, my $buf, 8192 |
|
|
1136 | or end-of-file; |
|
|
1137 | }); |
|
|
1138 | |
|
|
1139 | $iow = new urxvt::iow |
|
|
1140 | Create a new io watcher object in stopped state. |
|
|
1141 | |
|
|
1142 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
|
|
1143 | Set the callback to be called when io events are triggered. |
|
|
1144 | $reventmask is a bitset as described in the "events" method. |
|
|
1145 | |
|
|
1146 | $iow = $iow->fd ($fd) |
|
|
1147 | Set the filedescriptor (not handle) to watch. |
|
|
1148 | |
|
|
1149 | $iow = $iow->events ($eventmask) |
|
|
1150 | Set the event mask to watch. The only allowed values are |
|
|
1151 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be ORed |
|
|
1152 | together, or "urxvt::EVENT_NONE". |
|
|
1153 | |
|
|
1154 | $iow = $iow->start |
|
|
1155 | Start watching for requested events on the given handle. |
|
|
1156 | |
|
|
1157 | $iow = $iow->stop |
|
|
1158 | Stop watching for events on the given filehandle. |
|
|
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 |
776 | ->new |
1184 | ->new |
777 | ->fd (fileno $term->{socket}) |
|
|
778 | ->events (urxvt::EVENT_READ) |
|
|
779 | ->start |
1185 | ->start ($pid) |
780 | ->cb (sub { |
1186 | ->cb (sub { |
781 | my ($iow, $revents) = @_; |
1187 | my ($pw, $exit_status) = @_; |
782 | # $revents must be 1 here, no need to check |
|
|
783 | sysread $term->{socket}, my $buf, 8192 |
|
|
784 | or end-of-file; |
|
|
785 | }); |
1188 | ... |
|
|
1189 | }); |
786 | |
1190 | |
787 | $iow = new urxvt::iow |
1191 | $pw = new urxvt::pw |
788 | Create a new io watcher object in stopped state. |
1192 | Create a new process watcher in stopped state. |
789 | |
1193 | |
790 | $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... }) |
1194 | $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
791 | Set the callback to be called when io events are triggered. |
1195 | Set the callback to be called when the timer triggers. |
792 | $reventmask is a bitset as described in the "events" method. |
|
|
793 | |
1196 | |
794 | $iow = $iow->fd ($fd) |
1197 | $pw = $timer->start ($pid) |
795 | Set the filedescriptor (not handle) to watch. |
1198 | Tells the wqtcher to start watching for process $pid. |
796 | |
1199 | |
797 | $iow = $iow->events ($eventmask) |
|
|
798 | Set the event mask to watch. The only allowed values are |
|
|
799 | "urxvt::EVENT_READ" and "urxvt::EVENT_WRITE", which might be |
|
|
800 | ORed together, or "urxvt::EVENT_NONE". |
|
|
801 | |
|
|
802 | $iow = $iow->start |
|
|
803 | Start watching for requested events on the given handle. |
|
|
804 | |
|
|
805 | $iow = $iow->stop |
1200 | $pw = $pw->stop |
806 | Stop watching for events on the given filehandle. |
1201 | Stop the watcher. |
807 | |
1202 | |
808 | ENVIRONMENT |
1203 | ENVIRONMENT |
809 | URXVT_PERL_VERBOSITY |
1204 | URXVT_PERL_VERBOSITY |
810 | This variable controls the verbosity level of the perl extension. |
1205 | This variable controls the verbosity level of the perl extension. Higher |
811 | Higher numbers indicate more verbose output. |
1206 | numbers indicate more verbose output. |
812 | |
1207 | |
813 | == 0 - fatal messages |
1208 | == 0 - fatal messages |
814 | >= 3 - script loading and management |
1209 | >= 3 - script loading and management |
815 | >=10 - all events received |
1210 | >=10 - all called hooks |
|
|
1211 | >=11 - hook reutrn values |
816 | |
1212 | |
817 | AUTHOR |
1213 | AUTHOR |
818 | Marc Lehmann <pcg@goof.com> |
1214 | Marc Lehmann <pcg@goof.com> |
819 | http://software.schmorp.de/pkg/rxvt-unicode |
1215 | http://software.schmorp.de/pkg/rxvt-unicode |
820 | |
1216 | |