… | |
… | |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
34 | find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
35 | |
35 | |
36 | You can activate them like this: |
36 | You can activate them like this: |
37 | |
37 | |
38 | @@RXVT_NAME@@ -pe <extensionname> |
38 | @@RXVT_NAME@@ -pe <extensionname> |
|
|
39 | |
|
|
40 | Or by adding them to the resource for extensions loaded by default: |
|
|
41 | |
|
|
42 | URxvt.perl-ext-common: default,automove-background,selection-autotransform |
39 | |
43 | |
40 | =over 4 |
44 | =over 4 |
41 | |
45 | |
42 | =item selection (enabled by default) |
46 | =item selection (enabled by default) |
43 | |
47 | |
… | |
… | |
63 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
64 | between two vertical bars: |
68 | between two vertical bars: |
65 | |
69 | |
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
67 | |
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
78 | |
68 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
69 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
70 | |
81 | |
71 | This extension also offers the following bindable keyboard command: |
82 | This extension also offers following bindable keyboard commands: |
72 | |
83 | |
73 | =over 4 |
84 | =over 4 |
74 | |
85 | |
75 | =item rot13 |
86 | =item rot13 |
76 | |
87 | |
… | |
… | |
83 | =item option-popup (enabled by default) |
94 | =item option-popup (enabled by default) |
84 | |
95 | |
85 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
96 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
86 | runtime. |
97 | runtime. |
87 | |
98 | |
|
|
99 | Other extensions can extend this popup menu by pushing a code reference |
|
|
100 | onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the |
|
|
101 | popup is being displayed. |
|
|
102 | |
|
|
103 | It's sole argument is the popup menu, which can be modified. It should |
|
|
104 | either return nothing or a string, the initial boolean value and a code |
|
|
105 | reference. The string will be used as button text and the code reference |
|
|
106 | will be called when the toggle changes, with the new boolean value as |
|
|
107 | first argument. |
|
|
108 | |
|
|
109 | The following will add an entry C<myoption> that changes |
|
|
110 | C<$self->{myoption}>: |
|
|
111 | |
|
|
112 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
113 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
114 | }; |
|
|
115 | |
88 | =item selection-popup (enabled by default) |
116 | =item selection-popup (enabled by default) |
89 | |
117 | |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
91 | text into various other formats/action (such as uri unescaping, perl |
119 | text into various other formats/action (such as uri unescaping, perl |
92 | evalution, web-browser starting etc.), depending on content. |
120 | evaluation, web-browser starting etc.), depending on content. |
|
|
121 | |
|
|
122 | Other extensions can extend this popup menu by pushing a code reference |
|
|
123 | onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the |
|
|
124 | popup is being displayed. |
|
|
125 | |
|
|
126 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
127 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
128 | It should either return nothing or a string and a code reference. The |
|
|
129 | string will be used as button text and the code reference will be called |
|
|
130 | when the button gets activated and should transform C<$_>. |
|
|
131 | |
|
|
132 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
133 | the selection to C<b>s, but only if the selection currently contains any |
|
|
134 | C<a>s: |
|
|
135 | |
|
|
136 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
137 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
138 | : () |
|
|
139 | }; |
93 | |
140 | |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
141 | =item searchable-scrollback<hotkey> (enabled by default) |
95 | |
142 | |
96 | Adds regex search functionality to the scrollback buffer, triggered |
143 | Adds regex search functionality to the scrollback buffer, triggered |
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
144 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
… | |
… | |
104 | bottom. C<Escape> leaves search mode and returns to the point where search |
151 | bottom. C<Escape> leaves search mode and returns to the point where search |
105 | was started, while C<Enter> or C<Return> stay at the current position and |
152 | was started, while C<Enter> or C<Return> stay at the current position and |
106 | additionally stores the first match in the current line into the primary |
153 | additionally stores the first match in the current line into the primary |
107 | selection. |
154 | selection. |
108 | |
155 | |
|
|
156 | The regex defaults to "(?i)", resulting in a case-insensitive search. To |
|
|
157 | get a case-sensitive search you can delete this prefix using C<BackSpace> |
|
|
158 | or simply use an uppercase character which removes the "(?i)" prefix. |
|
|
159 | |
|
|
160 | See L<perlre> for more info about perl regular expression syntax. |
|
|
161 | |
|
|
162 | =item readline (enabled by default) |
|
|
163 | |
|
|
164 | A support package that tries to make editing with readline easier. At |
|
|
165 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
166 | move the text cursor to this position. It does so by generating as many |
|
|
167 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
168 | for programs that correctly support wide characters). |
|
|
169 | |
|
|
170 | To avoid too many false positives, this is only done when: |
|
|
171 | |
|
|
172 | =over 4 |
|
|
173 | |
|
|
174 | =item - the tty is in ICANON state. |
|
|
175 | |
|
|
176 | =item - the text cursor is visible. |
|
|
177 | |
|
|
178 | =item - the primary screen is currently being displayed. |
|
|
179 | |
|
|
180 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
181 | |
|
|
182 | =back |
|
|
183 | |
|
|
184 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
185 | might interfere with selection creation in harmless ways. |
|
|
186 | |
109 | =item selection-autotransform |
187 | =item selection-autotransform |
110 | |
188 | |
111 | This selection allows you to do automatic transforms on a selection |
189 | This selection allows you to do automatic transforms on a selection |
112 | whenever a selection is made. |
190 | whenever a selection is made. |
113 | |
191 | |
… | |
… | |
120 | |
198 | |
121 | For example, the following will transform selections of the form |
199 | For example, the following will transform selections of the form |
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
200 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
123 | $word>: |
201 | $word>: |
124 | |
202 | |
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
203 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
126 | |
204 | |
127 | And this example matches the same,but replaces it with vi-commands you can |
205 | And this example matches the same,but replaces it with vi-commands you can |
128 | paste directly into your (vi :) editor: |
206 | paste directly into your (vi :) editor: |
129 | |
207 | |
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
208 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
209 | |
|
|
210 | Of course, this can be modified to suit your needs and your editor :) |
|
|
211 | |
|
|
212 | To expand the example above to typical perl error messages ("XXX at |
|
|
213 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
214 | |
|
|
215 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
216 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
217 | |
|
|
218 | The first line tells the selection code to treat the unchanging part of |
|
|
219 | every error message as a selection pattern, and the second line transforms |
|
|
220 | the message into vi commands to load the file. |
|
|
221 | |
|
|
222 | =item tabbed |
|
|
223 | |
|
|
224 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
225 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
226 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
227 | button per tab. |
|
|
228 | |
|
|
229 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
230 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
231 | while B<Shift-Down> creates a new tab. |
|
|
232 | |
|
|
233 | The tabbar itself can be configured similarly to a normal terminal, but |
|
|
234 | with a resource class of C<URxvt.tabbed>. In addition, it supports the |
|
|
235 | following four resources (shown with defaults): |
|
|
236 | |
|
|
237 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
238 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
239 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
240 | URxvt.tabbed.tab-bg: <colour-index, default 1> |
|
|
241 | |
|
|
242 | See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid |
|
|
243 | indices. |
131 | |
244 | |
132 | =item mark-urls |
245 | =item mark-urls |
133 | |
246 | |
134 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
247 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
135 | make them clickable. When middle-clicked, the program specified in the |
248 | make them clickable. When middle-clicked, the program specified in the |
136 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
249 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
137 | the URL as first argument. |
250 | the URL as first argument. |
138 | |
251 | |
|
|
252 | =item xim-onthespot |
|
|
253 | |
|
|
254 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
255 | not work perfectly, and some input methods don't seem to work well with |
|
|
256 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
257 | kinput2. |
|
|
258 | |
|
|
259 | You enable it by specifying this extension and a preedit style of |
|
|
260 | C<OnTheSpot>, i.e.: |
|
|
261 | |
|
|
262 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
|
|
263 | |
|
|
264 | =item automove-background |
|
|
265 | |
|
|
266 | This is basically a very small extension that dynamically changes the |
|
|
267 | background pixmap offset to the window position, in effect creating the |
|
|
268 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
269 | supported in this mode. Exmaple: |
|
|
270 | |
|
|
271 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
272 | |
139 | =item block-graphics-to-ascii |
273 | =item block-graphics-to-ascii |
140 | |
274 | |
141 | A not very useful example of filtering all text output to the terminal, |
275 | A not very useful example of filtering all text output to the terminal |
142 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
276 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
143 | similar-looking ascii character. |
277 | similar-looking ascii character. |
144 | |
278 | |
145 | =item digital-clock |
279 | =item digital-clock |
146 | |
280 | |
147 | Displays a digital clock using the built-in overlay. |
281 | Displays a digital clock using the built-in overlay. |
|
|
282 | |
|
|
283 | =item remote-clipboard |
|
|
284 | |
|
|
285 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
286 | selection popup that allows one ti run external commands to store the |
|
|
287 | selection somewhere and fetch it again. |
|
|
288 | |
|
|
289 | We use it to implement a "distributed selection mechanism", which just |
|
|
290 | means that one command uploads the file to a remote server, and another |
|
|
291 | reads it. |
|
|
292 | |
|
|
293 | The commands can be set using the C<URxvt.remote-selection.store> and |
|
|
294 | C<URxvt.remote-selection.fetch> resources. The first should read the |
|
|
295 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
296 | the selection data on STDOUT (also in UTF-8). |
|
|
297 | |
|
|
298 | The defaults (which are likely useless to you) use rsh and cat: |
|
|
299 | |
|
|
300 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
301 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
|
|
302 | |
|
|
303 | =item selection-pastebin |
|
|
304 | |
|
|
305 | This is a little rarely useful extension that Uploads the selection as |
|
|
306 | textfile to a remote site (or does other things). (The implementation is |
|
|
307 | not currently secure for use in a multiuser environment as it writes to |
|
|
308 | F</tmp> directly.). |
|
|
309 | |
|
|
310 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
311 | i.e. |
|
|
312 | |
|
|
313 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
314 | |
|
|
315 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
316 | the textfile. This command can be set via a resource: |
|
|
317 | |
|
|
318 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
319 | |
|
|
320 | And the default is likely not useful to anybody but the few people around |
|
|
321 | here :) |
|
|
322 | |
|
|
323 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
324 | the same content should lead to the same filename. |
|
|
325 | |
|
|
326 | After a successful upload the selection will be replaced by the text given |
|
|
327 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
328 | for the filename): |
|
|
329 | |
|
|
330 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
148 | |
331 | |
149 | =item example-refresh-hooks |
332 | =item example-refresh-hooks |
150 | |
333 | |
151 | Displays a very simple digital clock in the upper right corner of the |
334 | Displays a very simple digital clock in the upper right corner of the |
152 | window. Illustrates overwriting the refresh callbacks to create your own |
335 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
192 | |
375 | |
193 | =back |
376 | =back |
194 | |
377 | |
195 | =head2 Extension Objects |
378 | =head2 Extension Objects |
196 | |
379 | |
197 | Very perl extension is a perl class. A separate perl object is created |
380 | Every perl extension is a perl class. A separate perl object is created |
198 | for each terminal and each extension and passed as the first parameter to |
381 | for each terminal and each extension and passed as the first parameter to |
199 | hooks. So extensions can use their C<$self> object without having to think |
382 | hooks. So extensions can use their C<$self> object without having to think |
200 | about other extensions, with the exception of methods and members that |
383 | about other extensions, with the exception of methods and members that |
201 | begin with an underscore character C<_>: these are reserved for internal |
384 | begin with an underscore character C<_>: these are reserved for internal |
202 | use. |
385 | use. |
… | |
… | |
231 | called whenever the relevant event happens. |
414 | called whenever the relevant event happens. |
232 | |
415 | |
233 | The first argument passed to them is an extension oject as described in |
416 | The first argument passed to them is an extension oject as described in |
234 | the in the C<Extension Objects> section. |
417 | the in the C<Extension Objects> section. |
235 | |
418 | |
236 | B<All> of these hooks must return a boolean value. If it is true, then the |
419 | B<All> of these hooks must return a boolean value. If any of the called |
237 | event counts as being I<consumed>, and the invocation of other hooks is |
420 | hooks returns true, then the event counts as being I<consumed>, and the |
238 | skipped, and the relevant action might not be carried out by the C++ code. |
421 | relevant action might not be carried out by the C++ code. |
239 | |
422 | |
240 | I<< When in doubt, return a false value (preferably C<()>). >> |
423 | I<< When in doubt, return a false value (preferably C<()>). >> |
241 | |
424 | |
242 | =over 4 |
425 | =over 4 |
243 | |
426 | |
244 | =item on_init $term |
427 | =item on_init $term |
245 | |
428 | |
246 | Called after a new terminal object has been initialized, but before |
429 | Called after a new terminal object has been initialized, but before |
247 | windows are created or the command gets run. Most methods are unsafe to |
430 | windows are created or the command gets run. Most methods are unsafe to |
248 | call or deliver senseless data, as terminal size and other characteristics |
431 | call or deliver senseless data, as terminal size and other characteristics |
249 | have not yet been determined. You can safely query and change resources, |
432 | have not yet been determined. You can safely query and change resources |
250 | though. |
433 | and options, though. For many purposes the C<on_start> hook is a better |
|
|
434 | place. |
|
|
435 | |
|
|
436 | =item on_start $term |
|
|
437 | |
|
|
438 | Called at the very end of initialisation of a new terminal, just before |
|
|
439 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
440 | |
|
|
441 | =item on_destroy $term |
|
|
442 | |
|
|
443 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
444 | still fully functional (not for long, though). |
251 | |
445 | |
252 | =item on_reset $term |
446 | =item on_reset $term |
253 | |
447 | |
254 | Called after the screen is "reset" for any reason, such as resizing or |
448 | Called after the screen is "reset" for any reason, such as resizing or |
255 | control sequences. Here is where you can react on changes to size-related |
449 | control sequences. Here is where you can react on changes to size-related |
256 | variables. |
450 | variables. |
257 | |
451 | |
258 | =item on_start $term |
452 | =item on_child_start $term, $pid |
259 | |
453 | |
260 | Called at the very end of initialisation of a new terminal, just before |
454 | Called just after the child process has been C<fork>ed. |
261 | returning to the mainloop. |
455 | |
|
|
456 | =item on_child_exit $term, $status |
|
|
457 | |
|
|
458 | Called just after the child process has exited. C<$status> is the status |
|
|
459 | from C<waitpid>. |
262 | |
460 | |
263 | =item on_sel_make $term, $eventtime |
461 | =item on_sel_make $term, $eventtime |
264 | |
462 | |
265 | Called whenever a selection has been made by the user, but before the |
463 | Called whenever a selection has been made by the user, but before the |
266 | selection text is copied, so changes to the beginning, end or type of the |
464 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
302 | |
500 | |
303 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
501 | It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
304 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
502 | $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total |
305 | number of lines that will be in the scrollback buffer. |
503 | number of lines that will be in the scrollback buffer. |
306 | |
504 | |
|
|
505 | =item on_osc_seq $term, $op, $args |
|
|
506 | |
|
|
507 | Called on every OSC sequence and can be used to suppress it or modify its |
|
|
508 | behaviour. The default should be to return an empty list. A true value |
|
|
509 | suppresses execution of the request completely. Make sure you don't get |
|
|
510 | confused by recursive invocations when you output an osc sequence within |
|
|
511 | this callback. |
|
|
512 | |
|
|
513 | C<on_osc_seq_perl> should be used for new behaviour. |
|
|
514 | |
307 | =item on_osc_seq $term, $string |
515 | =item on_osc_seq_perl $term, $string |
308 | |
516 | |
309 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
517 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
310 | operating system command) is processed. Cursor position and other state |
518 | operating system command) is processed. Cursor position and other state |
311 | information is up-to-date when this happens. For interoperability, the |
519 | information is up-to-date when this happens. For interoperability, the |
312 | string should start with the extension name and a colon, to distinguish |
520 | string should start with the extension name and a colon, to distinguish |
… | |
… | |
353 | |
561 | |
354 | =item on_refresh_end $term |
562 | =item on_refresh_end $term |
355 | |
563 | |
356 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
564 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
357 | |
565 | |
358 | =item on_keyboard_command $term, $string |
566 | =item on_user_command $term, $string |
359 | |
567 | |
360 | Called whenever the user presses a key combination that has a |
568 | Called whenever the a user-configured event is being activated (e.g. via |
361 | C<perl:string> action bound to it (see description of the B<keysym> |
569 | a C<perl:string> action bound to a key, see description of the B<keysym> |
362 | resource in the @@RXVT_NAME@@(1) manpage). |
570 | resource in the @@RXVT_NAME@@(1) manpage). |
|
|
571 | |
|
|
572 | The event is simply the action string. This interface is assumed to change |
|
|
573 | slightly in the future. |
|
|
574 | |
|
|
575 | =item on_resize_all_windows $tern, $new_width, $new_height |
|
|
576 | |
|
|
577 | Called just after the new window size has been calculcated, but before |
|
|
578 | windows are actually being resized or hints are being set. If this hook |
|
|
579 | returns TRUE, setting of the window hints is being skipped. |
|
|
580 | |
|
|
581 | =item on_x_event $term, $event |
|
|
582 | |
|
|
583 | Called on every X event received on the vt window (and possibly other |
|
|
584 | windows). Should only be used as a last resort. Most event structure |
|
|
585 | members are not passed. |
363 | |
586 | |
364 | =item on_focus_in $term |
587 | =item on_focus_in $term |
365 | |
588 | |
366 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
589 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
367 | does focus in processing. |
590 | does focus in processing. |
… | |
… | |
369 | =item on_focus_out $term |
592 | =item on_focus_out $term |
370 | |
593 | |
371 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
594 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
372 | focus out processing. |
595 | focus out processing. |
373 | |
596 | |
|
|
597 | =item on_configure_notify $term, $event |
|
|
598 | |
|
|
599 | =item on_property_notify $term, $event |
|
|
600 | |
374 | =item on_key_press $term, $event, $keysym, $octets |
601 | =item on_key_press $term, $event, $keysym, $octets |
375 | |
602 | |
376 | =item on_key_release $term, $event, $keysym |
603 | =item on_key_release $term, $event, $keysym |
377 | |
604 | |
378 | =item on_button_press $term, $event |
605 | =item on_button_press $term, $event |
… | |
… | |
387 | |
614 | |
388 | Called whenever the corresponding X event is received for the terminal If |
615 | Called whenever the corresponding X event is received for the terminal If |
389 | the hook returns true, then the even will be ignored by rxvt-unicode. |
616 | the hook returns true, then the even will be ignored by rxvt-unicode. |
390 | |
617 | |
391 | The event is a hash with most values as named by Xlib (see the XEvent |
618 | The event is a hash with most values as named by Xlib (see the XEvent |
392 | manpage), with the additional members C<row> and C<col>, which are the row |
619 | manpage), with the additional members C<row> and C<col>, which are the |
393 | and column under the mouse cursor. |
620 | (real, not screen-based) row and column under the mouse cursor. |
394 | |
621 | |
395 | C<on_key_press> additionally receives the string rxvt-unicode would |
622 | C<on_key_press> additionally receives the string rxvt-unicode would |
396 | output, if any, in locale-specific encoding. |
623 | output, if any, in locale-specific encoding. |
397 | |
624 | |
398 | subwindow. |
625 | subwindow. |
|
|
626 | |
|
|
627 | =item on_client_message $term, $event |
|
|
628 | |
|
|
629 | =item on_wm_protocols $term, $event |
|
|
630 | |
|
|
631 | =item on_wm_delete_window $term, $event |
|
|
632 | |
|
|
633 | Called when various types of ClientMessage events are received (all with |
|
|
634 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
399 | |
635 | |
400 | =back |
636 | =back |
401 | |
637 | |
402 | =cut |
638 | =cut |
403 | |
639 | |
… | |
… | |
409 | use Scalar::Util (); |
645 | use Scalar::Util (); |
410 | use List::Util (); |
646 | use List::Util (); |
411 | |
647 | |
412 | our $VERSION = 1; |
648 | our $VERSION = 1; |
413 | our $TERM; |
649 | our $TERM; |
|
|
650 | our @TERM_INIT; |
|
|
651 | our @TERM_EXT; |
414 | our @HOOKNAME; |
652 | our @HOOKNAME; |
415 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
653 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
416 | our %OPTION; |
654 | our %OPTION; |
417 | |
655 | |
418 | our $LIBDIR; |
656 | our $LIBDIR; |
419 | our $RESNAME; |
657 | our $RESNAME; |
420 | our $RESCLASS; |
658 | our $RESCLASS; |
421 | our $RXVTNAME; |
659 | our $RXVTNAME; |
422 | |
660 | |
|
|
661 | our $NOCHAR = chr 0xffff; |
|
|
662 | |
423 | =head2 Variables in the C<urxvt> Package |
663 | =head2 Variables in the C<urxvt> Package |
424 | |
664 | |
425 | =over 4 |
665 | =over 4 |
426 | |
666 | |
427 | =item $urxvt::LIBDIR |
667 | =item $urxvt::LIBDIR |
… | |
… | |
439 | |
679 | |
440 | =item $urxvt::TERM |
680 | =item $urxvt::TERM |
441 | |
681 | |
442 | The current terminal. This variable stores the current C<urxvt::term> |
682 | The current terminal. This variable stores the current C<urxvt::term> |
443 | object, whenever a callback/hook is executing. |
683 | object, whenever a callback/hook is executing. |
|
|
684 | |
|
|
685 | =item @urxvt::TERM_INIT |
|
|
686 | |
|
|
687 | All coderefs in this array will be called as methods of the next newly |
|
|
688 | created C<urxvt::term> object (during the C<on_init> phase). The array |
|
|
689 | gets cleared before the codereferences that were in it are being executed, |
|
|
690 | so coderefs can push themselves onto it again if they so desire. |
|
|
691 | |
|
|
692 | This complements to the perl-eval commandline option, but gets executed |
|
|
693 | first. |
|
|
694 | |
|
|
695 | =item @urxvt::TERM_EXT |
|
|
696 | |
|
|
697 | Works similar to C<@TERM_INIT>, but contains perl package/class names, which |
|
|
698 | get registered as normal extensions after calling the hooks in C<@TERM_INIT> |
|
|
699 | but before other extensions. Gets cleared just like C<@TERM_INIT>. |
444 | |
700 | |
445 | =back |
701 | =back |
446 | |
702 | |
447 | =head2 Functions in the C<urxvt> Package |
703 | =head2 Functions in the C<urxvt> Package |
448 | |
704 | |
… | |
… | |
463 | Using this function has the advantage that its output ends up in the |
719 | Using this function has the advantage that its output ends up in the |
464 | correct place, e.g. on stderr of the connecting urxvtc client. |
720 | correct place, e.g. on stderr of the connecting urxvtc client. |
465 | |
721 | |
466 | Messages have a size limit of 1023 bytes currently. |
722 | Messages have a size limit of 1023 bytes currently. |
467 | |
723 | |
468 | =item $is_safe = urxvt::safe |
724 | =item @terms = urxvt::termlist |
469 | |
725 | |
470 | Returns true when it is safe to do potentially unsafe things, such as |
726 | Returns all urxvt::term objects that exist in this process, regardless of |
471 | evaluating perl code specified by the user. This is true when urxvt was |
727 | wether they are started, being destroyed etc., so be careful. Only term |
472 | started setuid or setgid. |
728 | objects that have perl extensions attached will be returned (because there |
|
|
729 | is no urxvt::term objet associated with others). |
473 | |
730 | |
474 | =item $time = urxvt::NOW |
731 | =item $time = urxvt::NOW |
475 | |
732 | |
476 | Returns the "current time" (as per the event loop). |
733 | Returns the "current time" (as per the event loop). |
477 | |
734 | |
478 | =item urxvt::CurrentTime |
735 | =item urxvt::CurrentTime |
479 | |
736 | |
480 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
737 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
481 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
738 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
482 | Button4Mask, Button5Mask, AnyModifier |
739 | Button4Mask, Button5Mask, AnyModifier |
|
|
740 | |
|
|
741 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
742 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
743 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
744 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
745 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
746 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
747 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
748 | |
|
|
749 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
750 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
751 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
752 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
753 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
754 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
755 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
483 | |
756 | |
484 | Various constants for use in X calls and event processing. |
757 | Various constants for use in X calls and event processing. |
485 | |
758 | |
486 | =back |
759 | =back |
487 | |
760 | |
… | |
… | |
520 | |
793 | |
521 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
794 | =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour |
522 | |
795 | |
523 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
796 | =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour |
524 | |
797 | |
|
|
798 | =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg |
|
|
799 | |
525 | Replace the foreground/background colour in the rendition mask with the |
800 | Replace the foreground/background colour in the rendition mask with the |
526 | specified one. |
801 | specified one. |
527 | |
802 | |
528 | =item $value = urxvt::GET_CUSTOM $rend |
803 | =item $value = urxvt::GET_CUSTOM $rend |
529 | |
804 | |
… | |
… | |
538 | =back |
813 | =back |
539 | |
814 | |
540 | =cut |
815 | =cut |
541 | |
816 | |
542 | BEGIN { |
817 | BEGIN { |
543 | urxvt->bootstrap; |
|
|
544 | |
|
|
545 | # overwrite perl's warn |
818 | # overwrite perl's warn |
546 | *CORE::GLOBAL::warn = sub { |
819 | *CORE::GLOBAL::warn = sub { |
547 | my $msg = join "", @_; |
820 | my $msg = join "", @_; |
548 | $msg .= "\n" |
821 | $msg .= "\n" |
549 | unless $msg =~ /\n$/; |
822 | unless $msg =~ /\n$/; |
550 | urxvt::warn ($msg); |
823 | urxvt::warn ($msg); |
551 | }; |
824 | }; |
552 | |
|
|
553 | # %ENV is the original startup environment |
|
|
554 | delete $ENV{IFS}; |
|
|
555 | delete $ENV{CDPATH}; |
|
|
556 | delete $ENV{BASH_ENV}; |
|
|
557 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
558 | } |
825 | } |
559 | |
826 | |
560 | my @hook_count; |
827 | no warnings 'utf8'; |
|
|
828 | |
561 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
829 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
562 | |
830 | |
563 | sub verbose { |
831 | sub verbose { |
564 | my ($level, $msg) = @_; |
832 | my ($level, $msg) = @_; |
565 | warn "$msg\n" if $level <= $verbosity; |
833 | warn "$msg\n" if $level <= $verbosity; |
566 | } |
834 | } |
567 | |
835 | |
568 | my $extension_pkg = "extension0000"; |
|
|
569 | my %extension_pkg; |
836 | my %extension_pkg; |
570 | |
837 | |
571 | # load a single script into its own package, once only |
838 | # load a single script into its own package, once only |
572 | sub extension_package($) { |
839 | sub extension_package($) { |
573 | my ($path) = @_; |
840 | my ($path) = @_; |
574 | |
841 | |
575 | $extension_pkg{$path} ||= do { |
842 | $extension_pkg{$path} ||= do { |
576 | my $pkg = "urxvt::" . ($extension_pkg++); |
843 | $path =~ /([^\/\\]+)$/; |
|
|
844 | my $pkg = $1; |
|
|
845 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
846 | $pkg = "urxvt::ext::$pkg"; |
577 | |
847 | |
578 | verbose 3, "loading extension '$path' into package '$pkg'"; |
848 | verbose 3, "loading extension '$path' into package '$pkg'"; |
579 | |
849 | |
580 | open my $fh, "<:raw", $path |
850 | open my $fh, "<:raw", $path |
581 | or die "$path: $!"; |
851 | or die "$path: $!"; |
582 | |
852 | |
583 | my $source = untaint |
853 | my $source = |
584 | "package $pkg; use strict; use utf8;\n" |
854 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
585 | . "use base urxvt::term::extension::;\n" |
|
|
586 | . "#line 1 \"$path\"\n{\n" |
855 | . "#line 1 \"$path\"\n{\n" |
587 | . (do { local $/; <$fh> }) |
856 | . (do { local $/; <$fh> }) |
588 | . "\n};\n1"; |
857 | . "\n};\n1"; |
589 | |
858 | |
590 | eval $source |
859 | eval $source |
… | |
… | |
604 | if ($htype == 0) { # INIT |
873 | if ($htype == 0) { # INIT |
605 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
874 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
606 | |
875 | |
607 | my %ext_arg; |
876 | my %ext_arg; |
608 | |
877 | |
|
|
878 | { |
|
|
879 | my @init = @TERM_INIT; |
|
|
880 | @TERM_INIT = (); |
|
|
881 | $_->($TERM) for @init; |
|
|
882 | my @pkg = @TERM_EXT; |
|
|
883 | @TERM_EXT = (); |
|
|
884 | $TERM->register_package ($_) for @pkg; |
|
|
885 | } |
|
|
886 | |
609 | for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
887 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
610 | if ($_ eq "default") { |
888 | if ($_ eq "default") { |
611 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
889 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
612 | } elsif (/^-(.*)$/) { |
890 | } elsif (/^-(.*)$/) { |
613 | delete $ext_arg{$1}; |
891 | delete $ext_arg{$1}; |
614 | } elsif (/^([^<]+)<(.*)>$/) { |
892 | } elsif (/^([^<]+)<(.*)>$/) { |
615 | push @{ $ext_arg{$1} }, $2; |
893 | push @{ $ext_arg{$1} }, $2; |
616 | } else { |
894 | } else { |
617 | $ext_arg{$_} ||= []; |
895 | $ext_arg{$_} ||= []; |
618 | } |
896 | } |
619 | } |
897 | } |
620 | |
898 | |
621 | while (my ($ext, $argv) = each %ext_arg) { |
899 | for my $ext (sort keys %ext_arg) { |
622 | my @files = grep -f $_, map "$_/$ext", @dirs; |
900 | my @files = grep -f $_, map "$_/$ext", @dirs; |
623 | |
901 | |
624 | if (@files) { |
902 | if (@files) { |
625 | $TERM->register_package (extension_package $files[0], $argv); |
903 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
626 | } else { |
904 | } else { |
627 | warn "perl extension '$ext' not found in perl library search path\n"; |
905 | warn "perl extension '$ext' not found in perl library search path\n"; |
628 | } |
906 | } |
629 | } |
907 | } |
630 | |
908 | |
… | |
… | |
636 | |
914 | |
637 | if (my $cb = $TERM->{_hook}[$htype]) { |
915 | if (my $cb = $TERM->{_hook}[$htype]) { |
638 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
916 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
639 | if $verbosity >= 10; |
917 | if $verbosity >= 10; |
640 | |
918 | |
641 | keys %$cb; |
919 | for my $pkg (keys %$cb) { |
642 | |
|
|
643 | while (my ($pkg, $cb) = each %$cb) { |
|
|
644 | $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } |
920 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; |
645 | and last; |
921 | $retval ||= $retval_; |
646 | |
922 | |
647 | if ($@) { |
923 | if ($@) { |
648 | $TERM->ungrab; # better to lose the grab than the session |
924 | $TERM->ungrab; # better to lose the grab than the session |
649 | warn $@; |
925 | warn $@; |
650 | } |
926 | } |
… | |
… | |
653 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
929 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
654 | if $verbosity >= 11; |
930 | if $verbosity >= 11; |
655 | } |
931 | } |
656 | |
932 | |
657 | if ($htype == 1) { # DESTROY |
933 | if ($htype == 1) { # DESTROY |
658 | if (my $hook = delete $TERM->{_hook}) { |
|
|
659 | for my $htype (0..$#$hook) { |
|
|
660 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
661 | or set_should_invoke $htype, 0; |
|
|
662 | } |
|
|
663 | } |
|
|
664 | |
|
|
665 | # clear package objects |
934 | # clear package objects |
666 | %$_ = () for values %{ $TERM->{_pkg} }; |
935 | %$_ = () for values %{ $TERM->{_pkg} }; |
667 | |
936 | |
668 | # clear package |
937 | # clear package |
669 | %$TERM = (); |
938 | %$TERM = (); |
670 | } |
939 | } |
671 | |
940 | |
672 | $retval |
941 | $retval |
673 | } |
942 | } |
674 | |
943 | |
675 | sub exec_async(@) { |
944 | sub SET_COLOR($$$) { |
676 | my $pid = fork; |
945 | SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) |
677 | |
|
|
678 | return |
|
|
679 | if !defined $pid or $pid; |
|
|
680 | |
|
|
681 | %ENV = %{ $TERM->env }; |
|
|
682 | |
|
|
683 | exec @_; |
|
|
684 | _exit 255; |
|
|
685 | } |
946 | } |
686 | |
947 | |
687 | # urxvt::term::extension |
948 | # urxvt::term::extension |
688 | |
949 | |
689 | package urxvt::term::extension; |
950 | package urxvt::term::extension; |
… | |
… | |
695 | while (my ($name, $cb) = each %hook) { |
956 | while (my ($name, $cb) = each %hook) { |
696 | my $htype = $HOOKTYPE{uc $name}; |
957 | my $htype = $HOOKTYPE{uc $name}; |
697 | defined $htype |
958 | defined $htype |
698 | or Carp::croak "unsupported hook type '$name'"; |
959 | or Carp::croak "unsupported hook type '$name'"; |
699 | |
960 | |
|
|
961 | $self->set_should_invoke ($htype, +1) |
700 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
962 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
701 | $hook_count[$htype]++ |
|
|
702 | or urxvt::set_should_invoke $htype, 1; |
|
|
703 | } |
|
|
704 | |
963 | |
705 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
964 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
706 | } |
965 | } |
707 | } |
966 | } |
708 | |
967 | |
… | |
… | |
713 | for my $name (@hook) { |
972 | for my $name (@hook) { |
714 | my $htype = $HOOKTYPE{uc $name}; |
973 | my $htype = $HOOKTYPE{uc $name}; |
715 | defined $htype |
974 | defined $htype |
716 | or Carp::croak "unsupported hook type '$name'"; |
975 | or Carp::croak "unsupported hook type '$name'"; |
717 | |
976 | |
|
|
977 | $self->set_should_invoke ($htype, -1) |
718 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
978 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
719 | --$hook_count[$htype] |
|
|
720 | or urxvt::set_should_invoke $htype, 0; |
|
|
721 | } |
|
|
722 | } |
979 | } |
723 | } |
980 | } |
724 | |
981 | |
725 | our $AUTOLOAD; |
982 | our $AUTOLOAD; |
726 | |
983 | |
… | |
… | |
832 | # find on_xxx subs in the package and register them |
1089 | # find on_xxx subs in the package and register them |
833 | # as hooks |
1090 | # as hooks |
834 | sub register_package { |
1091 | sub register_package { |
835 | my ($self, $pkg, $argv) = @_; |
1092 | my ($self, $pkg, $argv) = @_; |
836 | |
1093 | |
|
|
1094 | no strict 'refs'; |
|
|
1095 | |
|
|
1096 | urxvt::verbose 6, "register package $pkg to $self"; |
|
|
1097 | |
|
|
1098 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
1099 | |
837 | my $proxy = bless { |
1100 | my $proxy = bless { |
838 | _pkg => $pkg, |
1101 | _pkg => $pkg, |
839 | argv => $argv, |
1102 | argv => $argv, |
840 | }, $pkg; |
1103 | }, $pkg; |
841 | Scalar::Util::weaken ($proxy->{term} = $self); |
1104 | Scalar::Util::weaken ($proxy->{term} = $self); |
… | |
… | |
856 | hash which defines the environment of the new terminal. |
1119 | hash which defines the environment of the new terminal. |
857 | |
1120 | |
858 | Croaks (and probably outputs an error message) if the new instance |
1121 | Croaks (and probably outputs an error message) if the new instance |
859 | couldn't be created. Returns C<undef> if the new instance didn't |
1122 | couldn't be created. Returns C<undef> if the new instance didn't |
860 | initialise perl, and the terminal object otherwise. The C<init> and |
1123 | initialise perl, and the terminal object otherwise. The C<init> and |
861 | C<start> hooks will be called during this call. |
1124 | C<start> hooks will be called before this call returns, and are free to |
|
|
1125 | refer to global data (which is race free). |
862 | |
1126 | |
863 | =cut |
1127 | =cut |
864 | |
1128 | |
865 | sub new { |
1129 | sub new { |
866 | my ($class, $env, @args) = @_; |
1130 | my ($class, $env, @args) = @_; |
867 | |
1131 | |
|
|
1132 | $env or Carp::croak "environment hash missing in call to urxvt::term->new"; |
|
|
1133 | @args or Carp::croak "name argument missing in call to urxvt::term->new"; |
|
|
1134 | |
868 | _new ([ map "$_=$env->{$_}", keys %$env ], @args); |
1135 | _new ([ map "$_=$env->{$_}", keys %$env ], \@args); |
869 | } |
1136 | } |
870 | |
1137 | |
871 | =item $term->destroy |
1138 | =item $term->destroy |
872 | |
1139 | |
873 | Destroy the terminal object (close the window, free resources |
1140 | Destroy the terminal object (close the window, free resources |
874 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1141 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
875 | watchers (timers, io watchers) are still active. |
1142 | watchers (timers, io watchers) are still active. |
876 | |
1143 | |
|
|
1144 | =item $term->exec_async ($cmd[, @args]) |
|
|
1145 | |
|
|
1146 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
1147 | ("starts") programs in the background. This function takes care of setting |
|
|
1148 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
1149 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
1150 | |
|
|
1151 | Returns the pid of the subprocess or C<undef> on error. |
|
|
1152 | |
|
|
1153 | =cut |
|
|
1154 | |
|
|
1155 | sub exec_async { |
|
|
1156 | my $self = shift; |
|
|
1157 | |
|
|
1158 | my $pid = fork; |
|
|
1159 | |
|
|
1160 | return $pid |
|
|
1161 | if !defined $pid or $pid; |
|
|
1162 | |
|
|
1163 | %ENV = %{ $self->env }; |
|
|
1164 | |
|
|
1165 | exec @_; |
|
|
1166 | urxvt::_exit 255; |
|
|
1167 | } |
|
|
1168 | |
877 | =item $isset = $term->option ($optval[, $set]) |
1169 | =item $isset = $term->option ($optval[, $set]) |
878 | |
1170 | |
879 | Returns true if the option specified by C<$optval> is enabled, and |
1171 | Returns true if the option specified by C<$optval> is enabled, and |
880 | optionally change it. All option values are stored by name in the hash |
1172 | optionally change it. All option values are stored by name in the hash |
881 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1173 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
883 | Here is a a likely non-exhaustive list of option names, please see the |
1175 | Here is a a likely non-exhaustive list of option names, please see the |
884 | source file F</src/optinc.h> to see the actual list: |
1176 | source file F</src/optinc.h> to see the actual list: |
885 | |
1177 | |
886 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1178 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
887 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1179 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
888 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1180 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
889 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1181 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
890 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1182 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
891 | tripleclickwords utmpInhibit visualBell |
1183 | transparent tripleclickwords utmpInhibit visualBell |
892 | |
1184 | |
893 | =item $value = $term->resource ($name[, $newval]) |
1185 | =item $value = $term->resource ($name[, $newval]) |
894 | |
1186 | |
895 | Returns the current resource value associated with a given name and |
1187 | Returns the current resource value associated with a given name and |
896 | optionally sets a new value. Setting values is most useful in the C<init> |
1188 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
913 | |
1205 | |
914 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1206 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
915 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1207 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
916 | display_name embed ext_bwidth fade font geometry hold iconName |
1208 | display_name embed ext_bwidth fade font geometry hold iconName |
917 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1209 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
918 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1210 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
919 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1211 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
920 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1212 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
921 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1213 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
922 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1214 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
923 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1215 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
924 | shade term_name title transparent transparent_all tripleclickwords |
1216 | secondaryScreen secondaryScroll selectstyle shade term_name title |
925 | utmpInhibit visualBell |
1217 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1218 | visualBell |
926 | |
1219 | |
927 | =cut |
1220 | =cut |
928 | |
1221 | |
929 | sub resource($$;$) { |
1222 | sub resource($$;$) { |
930 | my ($self, $name) = (shift, shift); |
1223 | my ($self, $name) = (shift, shift); |
… | |
… | |
1104 | |
1397 | |
1105 | Normally its not a good idea to use this function, as programs might be |
1398 | Normally its not a good idea to use this function, as programs might be |
1106 | confused by changes in cursor position or scrolling. Its useful inside a |
1399 | confused by changes in cursor position or scrolling. Its useful inside a |
1107 | C<on_add_lines> hook, though. |
1400 | C<on_add_lines> hook, though. |
1108 | |
1401 | |
|
|
1402 | =item $term->scr_change_screen ($screen) |
|
|
1403 | |
|
|
1404 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1405 | |
1109 | =item $term->cmd_parse ($octets) |
1406 | =item $term->cmd_parse ($octets) |
1110 | |
1407 | |
1111 | Similar to C<scr_add_lines>, but the argument must be in the |
1408 | Similar to C<scr_add_lines>, but the argument must be in the |
1112 | locale-specific encoding of the terminal and can contain command sequences |
1409 | locale-specific encoding of the terminal and can contain command sequences |
1113 | (escape codes) that will be interpreted. |
1410 | (escape codes) that will be interpreted. |
… | |
… | |
1123 | Replaces the event mask of the pty watcher by the given event mask. Can |
1420 | Replaces the event mask of the pty watcher by the given event mask. Can |
1124 | be used to suppress input and output handling to the pty/tty. See the |
1421 | be used to suppress input and output handling to the pty/tty. See the |
1125 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1422 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1126 | the previous value. |
1423 | the previous value. |
1127 | |
1424 | |
|
|
1425 | =item $fd = $term->pty_fd |
|
|
1426 | |
|
|
1427 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1428 | is used. |
|
|
1429 | |
1128 | =item $windowid = $term->parent |
1430 | =item $windowid = $term->parent |
1129 | |
1431 | |
1130 | Return the window id of the toplevel window. |
1432 | Return the window id of the toplevel window. |
1131 | |
1433 | |
1132 | =item $windowid = $term->vt |
1434 | =item $windowid = $term->vt |
1133 | |
1435 | |
1134 | Return the window id of the terminal window. |
1436 | Return the window id of the terminal window. |
1135 | |
1437 | |
|
|
1438 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1439 | |
|
|
1440 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1441 | to receive pointer events all the times: |
|
|
1442 | |
|
|
1443 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1444 | |
|
|
1445 | =item $term->focus_in |
|
|
1446 | |
|
|
1447 | =item $term->focus_out |
|
|
1448 | |
|
|
1449 | =item $term->key_press ($state, $keycode[, $time]) |
|
|
1450 | |
|
|
1451 | =item $term->key_release ($state, $keycode[, $time]) |
|
|
1452 | |
|
|
1453 | Deliver various fake events to to terminal. |
|
|
1454 | |
1136 | =item $window_width = $term->width |
1455 | =item $window_width = $term->width |
1137 | |
1456 | |
1138 | =item $window_height = $term->height |
1457 | =item $window_height = $term->height |
1139 | |
1458 | |
1140 | =item $font_width = $term->fwidth |
1459 | =item $font_width = $term->fwidth |
… | |
… | |
1153 | |
1472 | |
1154 | =item $max_scrollback = $term->saveLines |
1473 | =item $max_scrollback = $term->saveLines |
1155 | |
1474 | |
1156 | =item $nrow_plus_saveLines = $term->total_rows |
1475 | =item $nrow_plus_saveLines = $term->total_rows |
1157 | |
1476 | |
1158 | =item $lines_in_scrollback = $term->nsaved |
1477 | =item $topmost_scrollback_row = $term->top_row |
1159 | |
1478 | |
1160 | Return various integers describing terminal characteristics. |
1479 | Return various integers describing terminal characteristics. |
1161 | |
1480 | |
1162 | =item $x_display = $term->display_id |
1481 | =item $x_display = $term->display_id |
1163 | |
1482 | |
… | |
… | |
1170 | =item $env = $term->env |
1489 | =item $env = $term->env |
1171 | |
1490 | |
1172 | Returns a copy of the environment in effect for the terminal as a hashref |
1491 | Returns a copy of the environment in effect for the terminal as a hashref |
1173 | similar to C<\%ENV>. |
1492 | similar to C<\%ENV>. |
1174 | |
1493 | |
|
|
1494 | =item @envv = $term->envv |
|
|
1495 | |
|
|
1496 | Returns the environment as array of strings of the form C<VAR=VALUE>. |
|
|
1497 | |
|
|
1498 | =item @argv = $term->argv |
|
|
1499 | |
|
|
1500 | Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1501 | includes the program name as first element. |
|
|
1502 | |
1175 | =cut |
1503 | =cut |
1176 | |
1504 | |
1177 | sub env { |
1505 | sub env { |
1178 | if (my $env = $_[0]->_env) { |
|
|
1179 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } |
1506 | +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv } |
1180 | } else { |
|
|
1181 | +{ %ENV } |
|
|
1182 | } |
|
|
1183 | } |
1507 | } |
1184 | |
1508 | |
1185 | =item $modifiermask = $term->ModLevel3Mask |
1509 | =item $modifiermask = $term->ModLevel3Mask |
1186 | |
1510 | |
1187 | =item $modifiermask = $term->ModMetaMask |
1511 | =item $modifiermask = $term->ModMetaMask |
… | |
… | |
1189 | =item $modifiermask = $term->ModNumLockMask |
1513 | =item $modifiermask = $term->ModNumLockMask |
1190 | |
1514 | |
1191 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1515 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1192 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1516 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1193 | |
1517 | |
|
|
1518 | =item $screen = $term->current_screen |
|
|
1519 | |
|
|
1520 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1521 | |
|
|
1522 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1523 | |
|
|
1524 | Returns wether the cursor is currently hidden or not. |
|
|
1525 | |
1194 | =item $view_start = $term->view_start ([$newvalue]) |
1526 | =item $view_start = $term->view_start ([$newvalue]) |
1195 | |
1527 | |
1196 | Returns the negative row number of the topmost line. Minimum value is |
1528 | Returns the row number of the topmost displayed line. Maximum value is |
1197 | C<0>, which displays the normal terminal contents. Larger values scroll |
1529 | C<0>, which displays the normal terminal contents. Lower values scroll |
1198 | this many lines into the scrollback buffer. |
1530 | this many lines into the scrollback buffer. |
1199 | |
1531 | |
1200 | =item $term->want_refresh |
1532 | =item $term->want_refresh |
1201 | |
1533 | |
1202 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1534 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1217 | line, starting at column C<$start_col> (default C<0>), which is useful |
1549 | line, starting at column C<$start_col> (default C<0>), which is useful |
1218 | to replace only parts of a line. The font index in the rendition will |
1550 | to replace only parts of a line. The font index in the rendition will |
1219 | automatically be updated. |
1551 | automatically be updated. |
1220 | |
1552 | |
1221 | C<$text> is in a special encoding: tabs and wide characters that use more |
1553 | C<$text> is in a special encoding: tabs and wide characters that use more |
1222 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1554 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1223 | (C<chr 65535>). Characters with combining characters and other characters |
1555 | characters. Characters with combining characters and other characters that |
1224 | that do not fit into the normal tetx encoding will be replaced with |
1556 | do not fit into the normal tetx encoding will be replaced with characters |
1225 | characters in the private use area. |
1557 | in the private use area. |
1226 | |
1558 | |
1227 | You have to obey this encoding when changing text. The advantage is |
1559 | You have to obey this encoding when changing text. The advantage is |
1228 | that C<substr> and similar functions work on screen cells and not on |
1560 | that C<substr> and similar functions work on screen cells and not on |
1229 | characters. |
1561 | characters. |
1230 | |
1562 | |
… | |
… | |
1377 | =item $string = $term->special_decode $text |
1709 | =item $string = $term->special_decode $text |
1378 | |
1710 | |
1379 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1711 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1380 | C<< $term->ROW_t >> for details. |
1712 | C<< $term->ROW_t >> for details. |
1381 | |
1713 | |
1382 | =item $success = $term->grab_button ($button, $modifiermask) |
1714 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1383 | |
1715 | |
|
|
1716 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
|
|
1717 | |
1384 | Registers a synchronous button grab. See the XGrabButton manpage. |
1718 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1719 | manpage. |
1385 | |
1720 | |
1386 | =item $success = $term->grab ($eventtime[, $sync]) |
1721 | =item $success = $term->grab ($eventtime[, $sync]) |
1387 | |
1722 | |
1388 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1723 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1389 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
1724 | synchronous (C<$sync> is true). Also remembers the grab timestampe. |
… | |
… | |
1404 | =item $term->ungrab |
1739 | =item $term->ungrab |
1405 | |
1740 | |
1406 | Calls XUngrab for the most recent grab. Is called automatically on |
1741 | Calls XUngrab for the most recent grab. Is called automatically on |
1407 | evaluation errors, as it is better to lose the grab in the error case as |
1742 | evaluation errors, as it is better to lose the grab in the error case as |
1408 | the session. |
1743 | the session. |
|
|
1744 | |
|
|
1745 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1746 | |
|
|
1747 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1748 | |
|
|
1749 | =item @atoms = $term->XListProperties ($window) |
|
|
1750 | |
|
|
1751 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1752 | |
|
|
1753 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1754 | |
|
|
1755 | =item $term->XDeleteProperty ($window, $property) |
|
|
1756 | |
|
|
1757 | =item $window = $term->DefaultRootWindow |
|
|
1758 | |
|
|
1759 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1760 | |
|
|
1761 | =item $term->XMapWindow ($window) |
|
|
1762 | |
|
|
1763 | =item $term->XUnmapWindow ($window) |
|
|
1764 | |
|
|
1765 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1766 | |
|
|
1767 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1768 | |
|
|
1769 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1770 | |
|
|
1771 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1772 | the source of the display, otherwise those functions map more-or-less |
|
|
1773 | directory onto the X functions of the same name. |
1409 | |
1774 | |
1410 | =back |
1775 | =back |
1411 | |
1776 | |
1412 | =cut |
1777 | =cut |
1413 | |
1778 | |
… | |
… | |
1477 | my ($self, $text, $cb) = @_; |
1842 | my ($self, $text, $cb) = @_; |
1478 | |
1843 | |
1479 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1844 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1480 | } |
1845 | } |
1481 | |
1846 | |
1482 | =item $popup->add_toggle ($text, $cb, $initial_value) |
1847 | =item $popup->add_toggle ($text, $initial_value, $cb) |
1483 | |
1848 | |
1484 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1849 | Adds a toggle/checkbox item to the popup. The callback gets called |
1485 | whenever it gets toggled, with a boolean indicating its value as its first |
1850 | whenever it gets toggled, with a boolean indicating its new value as its |
1486 | argument. |
1851 | first argument. |
1487 | |
1852 | |
1488 | =cut |
1853 | =cut |
1489 | |
1854 | |
1490 | sub add_toggle { |
1855 | sub add_toggle { |
1491 | my ($self, $text, $cb, $value) = @_; |
1856 | my ($self, $text, $value, $cb) = @_; |
1492 | |
1857 | |
1493 | my $item; $item = { |
1858 | my $item; $item = { |
1494 | type => "button", |
1859 | type => "button", |
1495 | text => " $text", |
1860 | text => " $text", |
1496 | value => $value, |
1861 | value => $value, |
… | |
… | |
1515 | my $env = $self->{term}->env; |
1880 | my $env = $self->{term}->env; |
1516 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1881 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1517 | delete $env->{LC_ALL}; |
1882 | delete $env->{LC_ALL}; |
1518 | $env->{LC_CTYPE} = $self->{term}->locale; |
1883 | $env->{LC_CTYPE} = $self->{term}->locale; |
1519 | |
1884 | |
1520 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1885 | urxvt::term->new ($env, "popup", |
1521 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1886 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1887 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1888 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1522 | "--transient-for" => $self->{term}->parent, |
1889 | "--transient-for" => $self->{term}->parent, |
1523 | "-display" => $self->{term}->display_id, |
1890 | "-display" => $self->{term}->display_id, |
1524 | "-pe" => "urxvt-popup") |
1891 | "-pe" => "urxvt-popup") |
1525 | or die "unable to create popup window\n"; |
1892 | or die "unable to create popup window\n"; |
1526 | } |
1893 | } |
… | |
… | |
1531 | delete $self->{term}{_destroy}{$self}; |
1898 | delete $self->{term}{_destroy}{$self}; |
1532 | $self->{term}->ungrab; |
1899 | $self->{term}->ungrab; |
1533 | } |
1900 | } |
1534 | |
1901 | |
1535 | =back |
1902 | =back |
|
|
1903 | |
|
|
1904 | =cut |
|
|
1905 | |
|
|
1906 | package urxvt::watcher; |
|
|
1907 | |
|
|
1908 | @urxvt::timer::ISA = __PACKAGE__; |
|
|
1909 | @urxvt::iow::ISA = __PACKAGE__; |
|
|
1910 | @urxvt::pw::ISA = __PACKAGE__; |
|
|
1911 | @urxvt::iw::ISA = __PACKAGE__; |
1536 | |
1912 | |
1537 | =head2 The C<urxvt::timer> Class |
1913 | =head2 The C<urxvt::timer> Class |
1538 | |
1914 | |
1539 | This class implements timer watchers/events. Time is represented as a |
1915 | This class implements timer watchers/events. Time is represented as a |
1540 | fractional number of seconds since the epoch. Example: |
1916 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1578 | Start the timer. |
1954 | Start the timer. |
1579 | |
1955 | |
1580 | =item $timer = $timer->start ($tstamp) |
1956 | =item $timer = $timer->start ($tstamp) |
1581 | |
1957 | |
1582 | Set the event trigger time to C<$tstamp> and start the timer. |
1958 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1959 | |
|
|
1960 | =item $timer = $timer->after ($delay) |
|
|
1961 | |
|
|
1962 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1583 | |
1963 | |
1584 | =item $timer = $timer->stop |
1964 | =item $timer = $timer->stop |
1585 | |
1965 | |
1586 | Stop the timer. |
1966 | Stop the timer. |
1587 | |
1967 | |
… | |
… | |
1634 | |
2014 | |
1635 | Stop watching for events on the given filehandle. |
2015 | Stop watching for events on the given filehandle. |
1636 | |
2016 | |
1637 | =back |
2017 | =back |
1638 | |
2018 | |
|
|
2019 | =head2 The C<urxvt::iw> Class |
|
|
2020 | |
|
|
2021 | This class implements idle watchers, that get called automatically when |
|
|
2022 | the process is idle. They should return as fast as possible, after doing |
|
|
2023 | some useful work. |
|
|
2024 | |
|
|
2025 | =over 4 |
|
|
2026 | |
|
|
2027 | =item $iw = new urxvt::iw |
|
|
2028 | |
|
|
2029 | Create a new idle watcher object in stopped state. |
|
|
2030 | |
|
|
2031 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
2032 | |
|
|
2033 | Set the callback to be called when the watcher triggers. |
|
|
2034 | |
|
|
2035 | =item $timer = $timer->start |
|
|
2036 | |
|
|
2037 | Start the watcher. |
|
|
2038 | |
|
|
2039 | =item $timer = $timer->stop |
|
|
2040 | |
|
|
2041 | Stop the watcher. |
|
|
2042 | |
|
|
2043 | =back |
|
|
2044 | |
|
|
2045 | =head2 The C<urxvt::pw> Class |
|
|
2046 | |
|
|
2047 | This class implements process watchers. They create an event whenever a |
|
|
2048 | process exits, after which they stop automatically. |
|
|
2049 | |
|
|
2050 | my $pid = fork; |
|
|
2051 | ... |
|
|
2052 | $term->{pw} = urxvt::pw |
|
|
2053 | ->new |
|
|
2054 | ->start ($pid) |
|
|
2055 | ->cb (sub { |
|
|
2056 | my ($pw, $exit_status) = @_; |
|
|
2057 | ... |
|
|
2058 | }); |
|
|
2059 | |
|
|
2060 | =over 4 |
|
|
2061 | |
|
|
2062 | =item $pw = new urxvt::pw |
|
|
2063 | |
|
|
2064 | Create a new process watcher in stopped state. |
|
|
2065 | |
|
|
2066 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
2067 | |
|
|
2068 | Set the callback to be called when the timer triggers. |
|
|
2069 | |
|
|
2070 | =item $pw = $timer->start ($pid) |
|
|
2071 | |
|
|
2072 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
2073 | |
|
|
2074 | =item $pw = $pw->stop |
|
|
2075 | |
|
|
2076 | Stop the watcher. |
|
|
2077 | |
|
|
2078 | =back |
|
|
2079 | |
1639 | =head1 ENVIRONMENT |
2080 | =head1 ENVIRONMENT |
1640 | |
2081 | |
1641 | =head2 URXVT_PERL_VERBOSITY |
2082 | =head2 URXVT_PERL_VERBOSITY |
1642 | |
2083 | |
1643 | This variable controls the verbosity level of the perl extension. Higher |
2084 | This variable controls the verbosity level of the perl extension. Higher |