| … | |
… | |
| 28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
| 29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
| 30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
| 31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
| 32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
| 33 | </ul> |
35 | </ul> |
| 34 | |
36 | |
| 35 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
| 36 | <ul> |
38 | <ul> |
| 37 | |
39 | |
| … | |
… | |
| 80 | <p>This section describes the extensions delivered with this release. You can |
82 | <p>This section describes the extensions delivered with this release. You can |
| 81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
| 82 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
| 83 | <pre> |
85 | <pre> |
| 84 | rxvt -pe <extensionname></pre> |
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
| 85 | <dl> |
90 | <dl> |
| 86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
| 87 | </dt> |
92 | </dt> |
| 88 | <dd> |
93 | <dd> |
| 89 | (More) intelligent selection. This extension tries to be more intelligent |
94 | (More) intelligent selection. This extension tries to be more intelligent |
| … | |
… | |
| 116 | <dd> |
121 | <dd> |
| 117 | <pre> |
122 | <pre> |
| 118 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
| 119 | </dd> |
124 | </dd> |
| 120 | <dd> |
125 | <dd> |
|
|
126 | <p>Another example: Programs I use often output ``absolute path: '' at the |
|
|
127 | beginning of a line when they process multiple files. The following |
|
|
128 | pattern matches the filename (note, there is a single space at the very |
|
|
129 | end):</p> |
|
|
130 | </dd> |
|
|
131 | <dd> |
|
|
132 | <pre> |
|
|
133 | URxvt.selection.pattern-0: ^(/[^:]+):\</pre> |
|
|
134 | </dd> |
|
|
135 | <dd> |
| 121 | <p>You can look at the source of the selection extension to see more |
136 | <p>You can look at the source of the selection extension to see more |
| 122 | interesting uses, such as parsing a line from beginning to end.</p> |
137 | interesting uses, such as parsing a line from beginning to end.</p> |
| 123 | </dd> |
138 | </dd> |
| 124 | <dd> |
139 | <dd> |
| 125 | <p>This extension also offers following bindable keyboard commands:</p> |
140 | <p>This extension also offers following bindable keyboard commands:</p> |
| … | |
… | |
| 139 | </dt> |
154 | </dt> |
| 140 | <dd> |
155 | <dd> |
| 141 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
156 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
| 142 | runtime. |
157 | runtime. |
| 143 | </dd> |
158 | </dd> |
|
|
159 | <dd> |
|
|
160 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
161 | onto <code>@{ $term-</code>{option_popup_hook} }>, which gets called whenever the |
|
|
162 | popup is being displayed.</p> |
|
|
163 | </dd> |
|
|
164 | <dd> |
|
|
165 | <p>It's sole argument is the popup menu, which can be modified. It should |
|
|
166 | either return nothing or a string, the initial boolean value and a code |
|
|
167 | reference. The string will be used as button text and the code reference |
|
|
168 | will be called when the toggle changes, with the new boolean value as |
|
|
169 | first argument.</p> |
|
|
170 | </dd> |
|
|
171 | <dd> |
|
|
172 | <p>The following will add an entry <code>myoption</code> that changes |
|
|
173 | <code>$self-</code>{myoption}>:</p> |
|
|
174 | </dd> |
|
|
175 | <dd> |
|
|
176 | <pre> |
|
|
177 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
178 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
179 | };</pre> |
|
|
180 | </dd> |
| 144 | <p></p> |
181 | <p></p> |
| 145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
182 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
| 146 | </dt> |
183 | </dt> |
| 147 | <dd> |
184 | <dd> |
| 148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
185 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
| 149 | text into various other formats/action (such as uri unescaping, perl |
186 | text into various other formats/action (such as uri unescaping, perl |
| 150 | evalution, web-browser starting etc.), depending on content. |
187 | evaluation, web-browser starting etc.), depending on content. |
|
|
188 | </dd> |
|
|
189 | <dd> |
|
|
190 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
191 | onto <code>@{ $term-</code>{selection_popup_hook} }>, which gets called whenever the |
|
|
192 | popup is being displayed.</p> |
|
|
193 | </dd> |
|
|
194 | <dd> |
|
|
195 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
196 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
197 | It should either return nothing or a string and a code reference. The |
|
|
198 | string will be used as button text and the code reference will be called |
|
|
199 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
200 | </dd> |
|
|
201 | <dd> |
|
|
202 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
203 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
204 | <code>a</code>s:</p> |
|
|
205 | </dd> |
|
|
206 | <dd> |
|
|
207 | <pre> |
|
|
208 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
209 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
210 | : () |
|
|
211 | };</pre> |
| 151 | </dd> |
212 | </dd> |
| 152 | <p></p> |
213 | <p></p> |
| 153 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
214 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
| 154 | </dt> |
215 | </dt> |
| 155 | <dd> |
216 | <dd> |
| … | |
… | |
| 166 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
227 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
| 167 | additionally stores the first match in the current line into the primary |
228 | additionally stores the first match in the current line into the primary |
| 168 | selection.</p> |
229 | selection.</p> |
| 169 | </dd> |
230 | </dd> |
| 170 | <p></p> |
231 | <p></p> |
|
|
232 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
233 | </dt> |
|
|
234 | <dd> |
|
|
235 | A support package that tries to make editing with readline easier. At the |
|
|
236 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
237 | move the text cursor to this position. It does so by generating as many |
|
|
238 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
239 | for programs that correctly support wide characters). |
|
|
240 | </dd> |
|
|
241 | <dd> |
|
|
242 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
243 | </dd> |
|
|
244 | <dl> |
|
|
245 | <dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br /> |
|
|
246 | </dt> |
|
|
247 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
248 | </dt> |
|
|
249 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
250 | </dt> |
|
|
251 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
252 | </dt> |
|
|
253 | </dl> |
|
|
254 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
255 | might interfere with selection creation in harmless ways.</p> |
| 171 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
256 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
| 172 | </dt> |
257 | </dt> |
| 173 | <dd> |
258 | <dd> |
| 174 | This selection allows you to do automatic transforms on a selection |
259 | This selection allows you to do automatic transforms on a selection |
| 175 | whenever a selection is made. |
260 | whenever a selection is made. |
| … | |
… | |
| 197 | <p>And this example matches the same,but replaces it with vi-commands you can |
282 | <p>And this example matches the same,but replaces it with vi-commands you can |
| 198 | paste directly into your (vi :) editor:</p> |
283 | paste directly into your (vi :) editor:</p> |
| 199 | </dd> |
284 | </dd> |
| 200 | <dd> |
285 | <dd> |
| 201 | <pre> |
286 | <pre> |
| 202 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
287 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
| 203 | </dd> |
288 | </dd> |
| 204 | <dd> |
289 | <dd> |
| 205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
290 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
| 206 | </dd> |
291 | </dd> |
| 207 | <dd> |
292 | <dd> |
| 208 | <p>To expand the example above to typical perl error messages (``XXX at |
293 | <p>To expand the example above to typical perl error messages (``XXX at |
| 209 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
294 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
| 210 | </dd> |
295 | </dd> |
| 211 | <dd> |
296 | <dd> |
| 212 | <pre> |
297 | <pre> |
| 213 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
298 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
| 214 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
299 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
| 215 | </dd> |
300 | </dd> |
| 216 | <dd> |
301 | <dd> |
| 217 | <p>The first line tells the selection code to treat the unchanging part of |
302 | <p>The first line tells the selection code to treat the unchanging part of |
| 218 | every error message as a selection pattern, and the second line transforms |
303 | every error message as a selection pattern, and the second line transforms |
| 219 | the message into vi commands to load the file.</p> |
304 | the message into vi commands to load the file.</p> |
|
|
305 | </dd> |
|
|
306 | <p></p> |
|
|
307 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
308 | </dt> |
|
|
309 | <dd> |
|
|
310 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
311 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
312 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
313 | button per tab. |
|
|
314 | </dd> |
|
|
315 | <dd> |
|
|
316 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
317 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
318 | while <strong>Shift-Down</strong> creates a new tab.</p> |
|
|
319 | </dd> |
|
|
320 | <dd> |
|
|
321 | <p>The tabbar itself can be configured similarly to a normal terminal, but |
|
|
322 | with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the |
|
|
323 | following four resources (shown with defaults):</p> |
|
|
324 | </dd> |
|
|
325 | <dd> |
|
|
326 | <pre> |
|
|
327 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
328 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
329 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
330 | URxvt.tabbed.tab-bg: <colour-index, default 1></pre> |
|
|
331 | </dd> |
|
|
332 | <dd> |
|
|
333 | <p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid |
|
|
334 | indices.</p> |
| 220 | </dd> |
335 | </dd> |
| 221 | <p></p> |
336 | <p></p> |
| 222 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
337 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
| 223 | </dt> |
338 | </dt> |
| 224 | <dd> |
339 | <dd> |
| … | |
… | |
| 226 | make them clickable. When middle-clicked, the program specified in the |
341 | make them clickable. When middle-clicked, the program specified in the |
| 227 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
342 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
| 228 | the URL as first argument. |
343 | the URL as first argument. |
| 229 | </dd> |
344 | </dd> |
| 230 | <p></p> |
345 | <p></p> |
|
|
346 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> |
|
|
347 | </dt> |
|
|
348 | <dd> |
|
|
349 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
350 | not work perfectly, and some input methods don't seem to work well with |
|
|
351 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
352 | kinput2. |
|
|
353 | </dd> |
|
|
354 | <dd> |
|
|
355 | <p>You enable it by specifying this extension and a preedit style of |
|
|
356 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
357 | </dd> |
|
|
358 | <dd> |
|
|
359 | <pre> |
|
|
360 | rxvt -pt OnTheSpot -pe xim-onthespot</pre> |
|
|
361 | </dd> |
|
|
362 | <p></p> |
|
|
363 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
364 | </dt> |
|
|
365 | <dd> |
|
|
366 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
367 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
368 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
369 | </dd> |
|
|
370 | <dd> |
|
|
371 | <pre> |
|
|
372 | rxvt -pixmap background.xpm -pe automove-background</pre> |
|
|
373 | </dd> |
|
|
374 | <p></p> |
| 231 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
375 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
| 232 | </dt> |
376 | </dt> |
| 233 | <dd> |
377 | <dd> |
| 234 | A not very useful example of filtering all text output to the terminal, |
378 | A not very useful example of filtering all text output to the terminal, |
| 235 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
379 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| … | |
… | |
| 240 | </dt> |
384 | </dt> |
| 241 | <dd> |
385 | <dd> |
| 242 | Displays a digital clock using the built-in overlay. |
386 | Displays a digital clock using the built-in overlay. |
| 243 | </dd> |
387 | </dd> |
| 244 | <p></p> |
388 | <p></p> |
| 245 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
389 | <dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br /> |
| 246 | </dt> |
390 | </dt> |
|
|
391 | <dd> |
|
|
392 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
393 | selection popup that allows one ti run external commands to store the |
|
|
394 | selection somewhere and fetch it again. |
| 247 | <dd> |
395 | </dd> |
| 248 | Displays a very simple digital clock in the upper right corner of the |
396 | <dd> |
| 249 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | <p>We use it to implement a ``distributed selection mechanism'', which just |
| 250 | overlays or changes. |
398 | means that one command uploads the file to a remote server, and another |
|
|
399 | reads it.</p> |
|
|
400 | </dd> |
|
|
401 | <dd> |
|
|
402 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
403 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
404 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
405 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
406 | </dd> |
|
|
407 | <dd> |
|
|
408 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
409 | </dd> |
|
|
410 | <dd> |
|
|
411 | <pre> |
|
|
412 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
413 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> |
| 251 | </dd> |
414 | </dd> |
| 252 | <p></p> |
415 | <p></p> |
| 253 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
416 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
| 254 | </dt> |
417 | </dt> |
| 255 | <dd> |
418 | <dd> |
| … | |
… | |
| 288 | for the filename):</p> |
451 | for the filename):</p> |
| 289 | </dd> |
452 | </dd> |
| 290 | <dd> |
453 | <dd> |
| 291 | <pre> |
454 | <pre> |
| 292 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
455 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
|
|
456 | </dd> |
|
|
457 | <p></p> |
|
|
458 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
|
|
459 | </dt> |
|
|
460 | <dd> |
|
|
461 | Displays a very simple digital clock in the upper right corner of the |
|
|
462 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
463 | overlays or changes. |
| 293 | </dd> |
464 | </dd> |
| 294 | <p></p></dl> |
465 | <p></p></dl> |
| 295 | <p> |
466 | <p> |
| 296 | </p> |
467 | </p> |
| 297 | <hr /> |
468 | <hr /> |
| … | |
… | |
| 372 | <h2><a name="hooks">Hooks</a></h2> |
543 | <h2><a name="hooks">Hooks</a></h2> |
| 373 | <p>The following subroutines can be declared in extension files, and will be |
544 | <p>The following subroutines can be declared in extension files, and will be |
| 374 | called whenever the relevant event happens.</p> |
545 | called whenever the relevant event happens.</p> |
| 375 | <p>The first argument passed to them is an extension oject as described in |
546 | <p>The first argument passed to them is an extension oject as described in |
| 376 | the in the <code>Extension Objects</code> section.</p> |
547 | the in the <code>Extension Objects</code> section.</p> |
| 377 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
548 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
| 378 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
549 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
| 379 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
550 | relevant action might not be carried out by the C++ code.</p> |
| 380 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
551 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 381 | <dl> |
552 | <dl> |
| 382 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
553 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 383 | </dt> |
554 | </dt> |
| 384 | <dd> |
555 | <dd> |
| 385 | Called after a new terminal object has been initialized, but before |
556 | Called after a new terminal object has been initialized, but before |
| 386 | windows are created or the command gets run. Most methods are unsafe to |
557 | windows are created or the command gets run. Most methods are unsafe to |
| 387 | call or deliver senseless data, as terminal size and other characteristics |
558 | call or deliver senseless data, as terminal size and other characteristics |
| 388 | have not yet been determined. You can safely query and change resources, |
559 | have not yet been determined. You can safely query and change resources |
| 389 | though. |
560 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
561 | place. |
|
|
562 | </dd> |
|
|
563 | <p></p> |
|
|
564 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
565 | </dt> |
|
|
566 | <dd> |
|
|
567 | Called at the very end of initialisation of a new terminal, just before |
|
|
568 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
569 | </dd> |
|
|
570 | <p></p> |
|
|
571 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
572 | </dt> |
|
|
573 | <dd> |
|
|
574 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
575 | still fully functional (not for long, though). |
| 390 | </dd> |
576 | </dd> |
| 391 | <p></p> |
577 | <p></p> |
| 392 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
578 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 393 | </dt> |
579 | </dt> |
| 394 | <dd> |
580 | <dd> |
| 395 | Called after the screen is ``reset'' for any reason, such as resizing or |
581 | Called after the screen is ``reset'' for any reason, such as resizing or |
| 396 | control sequences. Here is where you can react on changes to size-related |
582 | control sequences. Here is where you can react on changes to size-related |
| 397 | variables. |
583 | variables. |
| 398 | </dd> |
584 | </dd> |
| 399 | <p></p> |
585 | <p></p> |
| 400 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
586 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
| 401 | </dt> |
587 | </dt> |
|
|
588 | <dd> |
|
|
589 | Called just after the child process has been <code>fork</code>ed. |
| 402 | <dd> |
590 | </dd> |
| 403 | Called at the very end of initialisation of a new terminal, just before |
591 | <p></p> |
| 404 | returning to the mainloop. |
592 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
593 | </dt> |
|
|
594 | <dd> |
|
|
595 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
596 | from <code>waitpid</code>. |
| 405 | </dd> |
597 | </dd> |
| 406 | <p></p> |
598 | <p></p> |
| 407 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
599 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 408 | </dt> |
600 | </dt> |
| 409 | <dd> |
601 | <dd> |
| … | |
… | |
| 526 | </dt> |
718 | </dt> |
| 527 | <dd> |
719 | <dd> |
| 528 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
720 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
| 529 | </dd> |
721 | </dd> |
| 530 | <p></p> |
722 | <p></p> |
| 531 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
723 | <dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br /> |
| 532 | </dt> |
724 | </dt> |
| 533 | <dd> |
725 | <dd> |
| 534 | Called whenever the user presses a key combination that has a |
726 | Called whenever the a user-configured event is being activated (e.g. via |
| 535 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
727 | a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
| 536 | resource in the <code>rxvt(1)</code> manpage). |
728 | resource in the <code>rxvt(1)</code> manpage). |
|
|
729 | </dd> |
|
|
730 | <dd> |
|
|
731 | <p>The event is simply the action string. This interface is assumed to change |
|
|
732 | slightly in the future.</p> |
| 537 | </dd> |
733 | </dd> |
| 538 | <p></p> |
734 | <p></p> |
| 539 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
735 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
| 540 | </dt> |
736 | </dt> |
| 541 | <dd> |
737 | <dd> |
| … | |
… | |
| 556 | <dd> |
752 | <dd> |
| 557 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
753 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 558 | focus out processing. |
754 | focus out processing. |
| 559 | </dd> |
755 | </dd> |
| 560 | <p></p> |
756 | <p></p> |
|
|
757 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
758 | </dt> |
|
|
759 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
760 | </dt> |
| 561 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
761 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
| 562 | </dt> |
762 | </dt> |
| 563 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
763 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
| 564 | </dt> |
764 | </dt> |
| 565 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
765 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
| … | |
… | |
| 576 | Called whenever the corresponding X event is received for the terminal If |
776 | Called whenever the corresponding X event is received for the terminal If |
| 577 | the hook returns true, then the even will be ignored by rxvt-unicode. |
777 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 578 | </dd> |
778 | </dd> |
| 579 | <dd> |
779 | <dd> |
| 580 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
780 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
| 581 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
781 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 582 | and column under the mouse cursor.</p> |
782 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 583 | </dd> |
783 | </dd> |
| 584 | <dd> |
784 | <dd> |
| 585 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
785 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 586 | output, if any, in locale-specific encoding.</p> |
786 | output, if any, in locale-specific encoding.</p> |
| 587 | </dd> |
787 | </dd> |
| 588 | <dd> |
788 | <dd> |
| 589 | <p>subwindow.</p> |
789 | <p>subwindow.</p> |
|
|
790 | </dd> |
|
|
791 | <p></p> |
|
|
792 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
793 | </dt> |
|
|
794 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
795 | </dt> |
|
|
796 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
797 | </dt> |
|
|
798 | <dd> |
|
|
799 | Called when various types of ClientMessage events are received (all with |
|
|
800 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
| 590 | </dd> |
801 | </dd> |
| 591 | <p></p></dl> |
802 | <p></p></dl> |
| 592 | <p> |
803 | <p> |
| 593 | </p> |
804 | </p> |
| 594 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
805 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| … | |
… | |
| 616 | </dt> |
827 | </dt> |
| 617 | <dd> |
828 | <dd> |
| 618 | The current terminal. This variable stores the current <code>urxvt::term</code> |
829 | The current terminal. This variable stores the current <code>urxvt::term</code> |
| 619 | object, whenever a callback/hook is executing. |
830 | object, whenever a callback/hook is executing. |
| 620 | </dd> |
831 | </dd> |
|
|
832 | <p></p> |
|
|
833 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
834 | </dt> |
|
|
835 | <dd> |
|
|
836 | All coderefs in this array will be called as methods of the next newly |
|
|
837 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
838 | gets cleared before the codereferences that were in it are being executed, |
|
|
839 | so coderefs can push themselves onto it again if they so desire. |
|
|
840 | </dd> |
|
|
841 | <dd> |
|
|
842 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
843 | first.</p> |
|
|
844 | </dd> |
|
|
845 | <p></p> |
|
|
846 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
847 | </dt> |
|
|
848 | <dd> |
|
|
849 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
850 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
851 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
852 | </dd> |
| 621 | <p></p></dl> |
853 | <p></p></dl> |
| 622 | <p> |
854 | <p> |
| 623 | </p> |
855 | </p> |
| 624 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
856 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| 625 | <dl> |
857 | <dl> |
| … | |
… | |
| 642 | <p>Using this function has the advantage that its output ends up in the |
874 | <p>Using this function has the advantage that its output ends up in the |
| 643 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
875 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
| 644 | </dd> |
876 | </dd> |
| 645 | <dd> |
877 | <dd> |
| 646 | <p>Messages have a size limit of 1023 bytes currently.</p> |
878 | <p>Messages have a size limit of 1023 bytes currently.</p> |
|
|
879 | </dd> |
|
|
880 | <p></p> |
|
|
881 | <dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br /> |
|
|
882 | </dt> |
|
|
883 | <dd> |
|
|
884 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
885 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
886 | objects that have perl extensions attached will be returned (because there |
|
|
887 | is no urxvt::term objet associated with others). |
| 647 | </dd> |
888 | </dd> |
| 648 | <p></p> |
889 | <p></p> |
| 649 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
890 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
| 650 | </dt> |
891 | </dt> |
| 651 | <dd> |
892 | <dd> |
| … | |
… | |
| 719 | <p></p> |
960 | <p></p> |
| 720 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
961 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
| 721 | </dt> |
962 | </dt> |
| 722 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
963 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
| 723 | </dt> |
964 | </dt> |
|
|
965 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br /> |
|
|
966 | </dt> |
| 724 | <dd> |
967 | <dd> |
| 725 | Replace the foreground/background colour in the rendition mask with the |
968 | Replace the foreground/background colour in the rendition mask with the |
| 726 | specified one. |
969 | specified one. |
| 727 | </dd> |
970 | </dd> |
| 728 | <p></p> |
971 | <p></p> |
| … | |
… | |
| 762 | </dd> |
1005 | </dd> |
| 763 | <dd> |
1006 | <dd> |
| 764 | <p>Croaks (and probably outputs an error message) if the new instance |
1007 | <p>Croaks (and probably outputs an error message) if the new instance |
| 765 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
1008 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
| 766 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
1009 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
| 767 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
1010 | <a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to |
|
|
1011 | refer to global data (which is race free).</p> |
| 768 | </dd> |
1012 | </dd> |
| 769 | <p></p> |
1013 | <p></p> |
| 770 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
1014 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
| 771 | </dt> |
1015 | </dt> |
| 772 | <dd> |
1016 | <dd> |
| 773 | Destroy the terminal object (close the window, free resources |
1017 | Destroy the terminal object (close the window, free resources |
| 774 | etc.). Please note that rxvt will not exit as long as any event |
1018 | etc.). Please note that rxvt will not exit as long as any event |
| 775 | watchers (timers, io watchers) are still active. |
1019 | watchers (timers, io watchers) are still active. |
| 776 | </dd> |
1020 | </dd> |
| 777 | <p></p> |
1021 | <p></p> |
|
|
1022 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
1023 | </dt> |
|
|
1024 | <dd> |
|
|
1025 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
1026 | (``starts'') programs in the background. This function takes care of setting |
|
|
1027 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
1028 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
1029 | </dd> |
|
|
1030 | <dd> |
|
|
1031 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
1032 | </dd> |
|
|
1033 | <p></p> |
| 778 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
1034 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
| 779 | </dt> |
1035 | </dt> |
| 780 | <dd> |
1036 | <dd> |
| 781 | Returns true if the option specified by <code>$optval</code> is enabled, and |
1037 | Returns true if the option specified by <code>$optval</code> is enabled, and |
| 782 | optionally change it. All option values are stored by name in the hash |
1038 | optionally change it. All option values are stored by name in the hash |
| … | |
… | |
| 788 | </dd> |
1044 | </dd> |
| 789 | <dd> |
1045 | <dd> |
| 790 | <pre> |
1046 | <pre> |
| 791 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1047 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 792 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1048 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 793 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1049 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 794 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1050 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 795 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1051 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 796 | tripleclickwords utmpInhibit visualBell</pre> |
1052 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 797 | </dd> |
1053 | </dd> |
| 798 | <p></p> |
1054 | <p></p> |
| 799 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
1055 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 800 | </dt> |
1056 | </dt> |
| 801 | <dd> |
1057 | <dd> |
| … | |
… | |
| 826 | <pre> |
1082 | <pre> |
| 827 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1083 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 828 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1084 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 829 | display_name embed ext_bwidth fade font geometry hold iconName |
1085 | display_name embed ext_bwidth fade font geometry hold iconName |
| 830 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1086 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 831 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1087 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 832 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1088 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 833 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1089 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 834 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1090 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 835 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1091 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 836 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1092 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 837 | shade term_name title transparent transparent_all tripleclickwords |
1093 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1094 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 838 | utmpInhibit visualBell</pre> |
1095 | visualBell</pre> |
| 839 | </dd> |
1096 | </dd> |
| 840 | <p></p> |
1097 | <p></p> |
| 841 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
1098 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
| 842 | </dt> |
1099 | </dt> |
| 843 | <dd> |
1100 | <dd> |
| … | |
… | |
| 1018 | <p>Normally its not a good idea to use this function, as programs might be |
1275 | <p>Normally its not a good idea to use this function, as programs might be |
| 1019 | confused by changes in cursor position or scrolling. Its useful inside a |
1276 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1020 | <code>on_add_lines</code> hook, though.</p> |
1277 | <code>on_add_lines</code> hook, though.</p> |
| 1021 | </dd> |
1278 | </dd> |
| 1022 | <p></p> |
1279 | <p></p> |
|
|
1280 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1281 | </dt> |
|
|
1282 | <dd> |
|
|
1283 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1284 | </dd> |
|
|
1285 | <p></p> |
| 1023 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1286 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
| 1024 | </dt> |
1287 | </dt> |
| 1025 | <dd> |
1288 | <dd> |
| 1026 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1289 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
| 1027 | locale-specific encoding of the terminal and can contain command sequences |
1290 | locale-specific encoding of the terminal and can contain command sequences |
| … | |
… | |
| 1043 | be used to suppress input and output handling to the pty/tty. See the |
1306 | be used to suppress input and output handling to the pty/tty. See the |
| 1044 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1307 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
| 1045 | the previous value. |
1308 | the previous value. |
| 1046 | </dd> |
1309 | </dd> |
| 1047 | <p></p> |
1310 | <p></p> |
|
|
1311 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong><br /> |
|
|
1312 | </dt> |
|
|
1313 | <dd> |
|
|
1314 | Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1315 | is used. |
|
|
1316 | </dd> |
|
|
1317 | <p></p> |
| 1048 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1318 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
| 1049 | </dt> |
1319 | </dt> |
| 1050 | <dd> |
1320 | <dd> |
| 1051 | Return the window id of the toplevel window. |
1321 | Return the window id of the toplevel window. |
| 1052 | </dd> |
1322 | </dd> |
| … | |
… | |
| 1066 | <dd> |
1336 | <dd> |
| 1067 | <pre> |
1337 | <pre> |
| 1068 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
1338 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
| 1069 | </dd> |
1339 | </dd> |
| 1070 | <p></p> |
1340 | <p></p> |
|
|
1341 | <dt><strong><a name="item_focus_in">$term->focus_in</a></strong><br /> |
|
|
1342 | </dt> |
|
|
1343 | <dt><strong><a name="item_focus_out">$term->focus_out</a></strong><br /> |
|
|
1344 | </dt> |
|
|
1345 | <dt><strong><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a></strong><br /> |
|
|
1346 | </dt> |
|
|
1347 | <dt><strong><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a></strong><br /> |
|
|
1348 | </dt> |
|
|
1349 | <dd> |
|
|
1350 | Deliver various fake events to to terminal. |
|
|
1351 | </dd> |
|
|
1352 | <p></p> |
| 1071 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1353 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
| 1072 | </dt> |
1354 | </dt> |
| 1073 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1355 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
| 1074 | </dt> |
1356 | </dt> |
| 1075 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1357 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
| … | |
… | |
| 1122 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
1404 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
| 1123 | </dt> |
1405 | </dt> |
| 1124 | <dd> |
1406 | <dd> |
| 1125 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1407 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
| 1126 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1408 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1409 | </dd> |
|
|
1410 | <p></p> |
|
|
1411 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1412 | </dt> |
|
|
1413 | <dd> |
|
|
1414 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1415 | </dd> |
|
|
1416 | <p></p> |
|
|
1417 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1418 | </dt> |
|
|
1419 | <dd> |
|
|
1420 | Returns wether the cursor is currently hidden or not. |
| 1127 | </dd> |
1421 | </dd> |
| 1128 | <p></p> |
1422 | <p></p> |
| 1129 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1423 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 1130 | </dt> |
1424 | </dt> |
| 1131 | <dd> |
1425 | <dd> |
| … | |
… | |
| 1160 | to replace only parts of a line. The font index in the rendition will |
1454 | to replace only parts of a line. The font index in the rendition will |
| 1161 | automatically be updated.</p> |
1455 | automatically be updated.</p> |
| 1162 | </dd> |
1456 | </dd> |
| 1163 | <dd> |
1457 | <dd> |
| 1164 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1458 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
| 1165 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1459 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
| 1166 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1460 | characters. Characters with combining characters and other characters that |
| 1167 | that do not fit into the normal tetx encoding will be replaced with |
1461 | do not fit into the normal tetx encoding will be replaced with characters |
| 1168 | characters in the private use area.</p> |
1462 | in the private use area.</p> |
| 1169 | </dd> |
1463 | </dd> |
| 1170 | <dd> |
1464 | <dd> |
| 1171 | <p>You have to obey this encoding when changing text. The advantage is |
1465 | <p>You have to obey this encoding when changing text. The advantage is |
| 1172 | that <code>substr</code> and similar functions work on screen cells and not on |
1466 | that <code>substr</code> and similar functions work on screen cells and not on |
| 1173 | characters.</p> |
1467 | characters.</p> |
| … | |
… | |
| 1269 | <dd> |
1563 | <dd> |
| 1270 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1564 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 1271 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1565 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| 1272 | </dd> |
1566 | </dd> |
| 1273 | <p></p> |
1567 | <p></p> |
| 1274 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
1568 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
| 1275 | </dt> |
1569 | </dt> |
|
|
1570 | <dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
|
|
1571 | </dt> |
| 1276 | <dd> |
1572 | <dd> |
| 1277 | Registers a synchronous button grab. See the XGrabButton manpage. |
1573 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1574 | manpage. |
| 1278 | </dd> |
1575 | </dd> |
| 1279 | <p></p> |
1576 | <p></p> |
| 1280 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
1577 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
| 1281 | </dt> |
1578 | </dt> |
| 1282 | <dd> |
1579 | <dd> |
| … | |
… | |
| 1308 | <dd> |
1605 | <dd> |
| 1309 | Calls XUngrab for the most recent grab. Is called automatically on |
1606 | Calls XUngrab for the most recent grab. Is called automatically on |
| 1310 | evaluation errors, as it is better to lose the grab in the error case as |
1607 | evaluation errors, as it is better to lose the grab in the error case as |
| 1311 | the session. |
1608 | the session. |
| 1312 | </dd> |
1609 | </dd> |
|
|
1610 | <p></p> |
|
|
1611 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1612 | </dt> |
|
|
1613 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1614 | </dt> |
|
|
1615 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1616 | </dt> |
|
|
1617 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1618 | </dt> |
|
|
1619 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1620 | </dt> |
|
|
1621 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1622 | </dt> |
|
|
1623 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1624 | </dt> |
|
|
1625 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1626 | </dt> |
|
|
1627 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1628 | </dt> |
|
|
1629 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1630 | </dt> |
|
|
1631 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1632 | </dt> |
|
|
1633 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1634 | </dt> |
|
|
1635 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1636 | </dt> |
|
|
1637 | <dd> |
|
|
1638 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1639 | the source of the display, otherwise those functions map more-or-less |
|
|
1640 | directory onto the X functions of the same name. |
|
|
1641 | </dd> |
| 1313 | <p></p></dl> |
1642 | <p></p></dl> |
| 1314 | <p> |
1643 | <p> |
| 1315 | </p> |
1644 | </p> |
| 1316 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1645 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
| 1317 | <dl> |
1646 | <dl> |
| … | |
… | |
| 1332 | <dd> |
1661 | <dd> |
| 1333 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
1662 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
| 1334 | selected. |
1663 | selected. |
| 1335 | </dd> |
1664 | </dd> |
| 1336 | <p></p> |
1665 | <p></p> |
| 1337 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
1666 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $initial_value, $cb)</a></strong><br /> |
| 1338 | </dt> |
1667 | </dt> |
| 1339 | <dd> |
1668 | <dd> |
| 1340 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1669 | Adds a toggle/checkbox item to the popup. The callback gets called |
| 1341 | whenever it gets toggled, with a boolean indicating its value as its first |
1670 | whenever it gets toggled, with a boolean indicating its new value as its |
| 1342 | argument. |
1671 | first argument. |
| 1343 | </dd> |
1672 | </dd> |
| 1344 | <p></p> |
1673 | <p></p> |
| 1345 | <dt><strong>$popup->show</strong><br /> |
1674 | <dt><strong>$popup->show</strong><br /> |
| 1346 | </dt> |
1675 | </dt> |
| 1347 | <dd> |
1676 | <dd> |
| … | |
… | |
| 1404 | <p></p> |
1733 | <p></p> |
| 1405 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1734 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
| 1406 | </dt> |
1735 | </dt> |
| 1407 | <dd> |
1736 | <dd> |
| 1408 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1737 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1738 | </dd> |
|
|
1739 | <p></p> |
|
|
1740 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1741 | </dt> |
|
|
1742 | <dd> |
|
|
1743 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 1409 | </dd> |
1744 | </dd> |
| 1410 | <p></p> |
1745 | <p></p> |
| 1411 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1746 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 1412 | </dt> |
1747 | </dt> |
| 1413 | <dd> |
1748 | <dd> |
| … | |
… | |
| 1471 | Stop watching for events on the given filehandle. |
1806 | Stop watching for events on the given filehandle. |
| 1472 | </dd> |
1807 | </dd> |
| 1473 | <p></p></dl> |
1808 | <p></p></dl> |
| 1474 | <p> |
1809 | <p> |
| 1475 | </p> |
1810 | </p> |
|
|
1811 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1812 | <p>This class implements idle watchers, that get called automatically when |
|
|
1813 | the process is idle. They should return as fast as possible, after doing |
|
|
1814 | some useful work.</p> |
|
|
1815 | <dl> |
|
|
1816 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1817 | </dt> |
|
|
1818 | <dd> |
|
|
1819 | Create a new idle watcher object in stopped state. |
|
|
1820 | </dd> |
|
|
1821 | <p></p> |
|
|
1822 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1823 | </dt> |
|
|
1824 | <dd> |
|
|
1825 | Set the callback to be called when the watcher triggers. |
|
|
1826 | </dd> |
|
|
1827 | <p></p> |
|
|
1828 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1829 | </dt> |
|
|
1830 | <dd> |
|
|
1831 | Start the watcher. |
|
|
1832 | </dd> |
|
|
1833 | <p></p> |
|
|
1834 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1835 | </dt> |
|
|
1836 | <dd> |
|
|
1837 | Stop the watcher. |
|
|
1838 | </dd> |
|
|
1839 | <p></p></dl> |
|
|
1840 | <p> |
|
|
1841 | </p> |
|
|
1842 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1843 | <p>This class implements process watchers. They create an event whenever a |
|
|
1844 | process exits, after which they stop automatically.</p> |
|
|
1845 | <pre> |
|
|
1846 | my $pid = fork; |
|
|
1847 | ... |
|
|
1848 | $term->{pw} = urxvt::pw |
|
|
1849 | ->new |
|
|
1850 | ->start ($pid) |
|
|
1851 | ->cb (sub { |
|
|
1852 | my ($pw, $exit_status) = @_; |
|
|
1853 | ... |
|
|
1854 | });</pre> |
|
|
1855 | <dl> |
|
|
1856 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1857 | </dt> |
|
|
1858 | <dd> |
|
|
1859 | Create a new process watcher in stopped state. |
|
|
1860 | </dd> |
|
|
1861 | <p></p> |
|
|
1862 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1863 | </dt> |
|
|
1864 | <dd> |
|
|
1865 | Set the callback to be called when the timer triggers. |
|
|
1866 | </dd> |
|
|
1867 | <p></p> |
|
|
1868 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1869 | </dt> |
|
|
1870 | <dd> |
|
|
1871 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1872 | </dd> |
|
|
1873 | <p></p> |
|
|
1874 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1875 | </dt> |
|
|
1876 | <dd> |
|
|
1877 | Stop the watcher. |
|
|
1878 | </dd> |
|
|
1879 | <p></p></dl> |
|
|
1880 | <p> |
|
|
1881 | </p> |
| 1476 | <hr /> |
1882 | <hr /> |
| 1477 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1883 | <h1><a name="environment">ENVIRONMENT</a></h1> |
| 1478 | <p> |
1884 | <p> |
| 1479 | </p> |
1885 | </p> |
| 1480 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1886 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
