| … | |
… | |
| 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> |
| … | |
… | |
| 145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
160 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
| 146 | </dt> |
161 | </dt> |
| 147 | <dd> |
162 | <dd> |
| 148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
163 | 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 |
164 | text into various other formats/action (such as uri unescaping, perl |
| 150 | evalution, web-browser starting etc.), depending on content. |
165 | evaluation, web-browser starting etc.), depending on content. |
|
|
166 | </dd> |
|
|
167 | <dd> |
|
|
168 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
169 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
|
|
170 | popup is displayed.</p> |
|
|
171 | </dd> |
|
|
172 | <dd> |
|
|
173 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
174 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
175 | It should either return nothing or a string and a code reference. The |
|
|
176 | string will be used as button text and the code reference will be called |
|
|
177 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
178 | </dd> |
|
|
179 | <dd> |
|
|
180 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
181 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
182 | <code>a</code>s:</p> |
|
|
183 | </dd> |
|
|
184 | <dd> |
|
|
185 | <pre> |
|
|
186 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
187 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
188 | : () |
|
|
189 | };</pre> |
| 151 | </dd> |
190 | </dd> |
| 152 | <p></p> |
191 | <p></p> |
| 153 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
192 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
| 154 | </dt> |
193 | </dt> |
| 155 | <dd> |
194 | <dd> |
| … | |
… | |
| 166 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
205 | 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 |
206 | additionally stores the first match in the current line into the primary |
| 168 | selection.</p> |
207 | selection.</p> |
| 169 | </dd> |
208 | </dd> |
| 170 | <p></p> |
209 | <p></p> |
|
|
210 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
211 | </dt> |
|
|
212 | <dd> |
|
|
213 | A support package that tries to make editing with readline easier. At the |
|
|
214 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
215 | move the text cursor to this position. It does so by generating as many |
|
|
216 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
217 | for programs that correctly support wide characters). |
|
|
218 | </dd> |
|
|
219 | <dd> |
|
|
220 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
221 | </dd> |
|
|
222 | <dl> |
|
|
223 | <dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br /> |
|
|
224 | </dt> |
|
|
225 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
226 | </dt> |
|
|
227 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
228 | </dt> |
|
|
229 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
230 | </dt> |
|
|
231 | </dl> |
|
|
232 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
233 | might interfere with selection creation in harmless ways.</p> |
| 171 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
234 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
| 172 | </dt> |
235 | </dt> |
| 173 | <dd> |
236 | <dd> |
| 174 | This selection allows you to do automatic transforms on a selection |
237 | This selection allows you to do automatic transforms on a selection |
| 175 | whenever a selection is made. |
238 | whenever a selection is made. |
| … | |
… | |
| 197 | <p>And this example matches the same,but replaces it with vi-commands you can |
260 | <p>And this example matches the same,but replaces it with vi-commands you can |
| 198 | paste directly into your (vi :) editor:</p> |
261 | paste directly into your (vi :) editor:</p> |
| 199 | </dd> |
262 | </dd> |
| 200 | <dd> |
263 | <dd> |
| 201 | <pre> |
264 | <pre> |
| 202 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
265 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
| 203 | </dd> |
266 | </dd> |
| 204 | <dd> |
267 | <dd> |
| 205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
268 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
| 206 | </dd> |
269 | </dd> |
| 207 | <dd> |
270 | <dd> |
| 208 | <p>To expand the example above to typical perl error messages (``XXX at |
271 | <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> |
272 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
| 210 | </dd> |
273 | </dd> |
| 211 | <dd> |
274 | <dd> |
| 212 | <pre> |
275 | <pre> |
| 213 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
276 | 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> |
277 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
| 215 | </dd> |
278 | </dd> |
| 216 | <dd> |
279 | <dd> |
| 217 | <p>The first line tells the selection code to treat the unchanging part of |
280 | <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 |
281 | every error message as a selection pattern, and the second line transforms |
| 219 | the message into vi commands to load the file.</p> |
282 | the message into vi commands to load the file.</p> |
|
|
283 | </dd> |
|
|
284 | <p></p> |
|
|
285 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
286 | </dt> |
|
|
287 | <dd> |
|
|
288 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
289 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
290 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
291 | button per tab. |
|
|
292 | </dd> |
|
|
293 | <dd> |
|
|
294 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
295 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
296 | while <strong>Shift-Down</strong> creates a new tab.</p> |
|
|
297 | </dd> |
|
|
298 | <dd> |
|
|
299 | <p>The tabbar itself can be configured similarly to a normal terminal, but |
|
|
300 | with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the |
|
|
301 | following four resources (shown with defaults):</p> |
|
|
302 | </dd> |
|
|
303 | <dd> |
|
|
304 | <pre> |
|
|
305 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
306 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
307 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
308 | URxvt.tabbed.tab-bg: <colour-index, default 1></pre> |
|
|
309 | </dd> |
|
|
310 | <dd> |
|
|
311 | <p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid |
|
|
312 | indices.</p> |
| 220 | </dd> |
313 | </dd> |
| 221 | <p></p> |
314 | <p></p> |
| 222 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
315 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
| 223 | </dt> |
316 | </dt> |
| 224 | <dd> |
317 | <dd> |
| … | |
… | |
| 226 | make them clickable. When middle-clicked, the program specified in the |
319 | 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 |
320 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
| 228 | the URL as first argument. |
321 | the URL as first argument. |
| 229 | </dd> |
322 | </dd> |
| 230 | <p></p> |
323 | <p></p> |
|
|
324 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> |
|
|
325 | </dt> |
|
|
326 | <dd> |
|
|
327 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
328 | not work perfectly, and some input methods don't seem to work well with |
|
|
329 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
330 | kinput2. |
|
|
331 | </dd> |
|
|
332 | <dd> |
|
|
333 | <p>You enable it by specifying this extension and a preedit style of |
|
|
334 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
335 | </dd> |
|
|
336 | <dd> |
|
|
337 | <pre> |
|
|
338 | rxvt -pt OnTheSpot -pe xim-onthespot</pre> |
|
|
339 | </dd> |
|
|
340 | <p></p> |
|
|
341 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
342 | </dt> |
|
|
343 | <dd> |
|
|
344 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
345 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
346 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
347 | </dd> |
|
|
348 | <dd> |
|
|
349 | <pre> |
|
|
350 | rxvt -pixmap background.xpm -pe automove-background</pre> |
|
|
351 | </dd> |
|
|
352 | <p></p> |
| 231 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
353 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
| 232 | </dt> |
354 | </dt> |
| 233 | <dd> |
355 | <dd> |
| 234 | A not very useful example of filtering all text output to the terminal, |
356 | 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 |
357 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| … | |
… | |
| 240 | </dt> |
362 | </dt> |
| 241 | <dd> |
363 | <dd> |
| 242 | Displays a digital clock using the built-in overlay. |
364 | Displays a digital clock using the built-in overlay. |
| 243 | </dd> |
365 | </dd> |
| 244 | <p></p> |
366 | <p></p> |
| 245 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
367 | <dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br /> |
| 246 | </dt> |
368 | </dt> |
|
|
369 | <dd> |
|
|
370 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
371 | selection popup that allows one ti run external commands to store the |
|
|
372 | selection somewhere and fetch it again. |
| 247 | <dd> |
373 | </dd> |
| 248 | Displays a very simple digital clock in the upper right corner of the |
374 | <dd> |
| 249 | window. Illustrates overwriting the refresh callbacks to create your own |
375 | <p>We use it to implement a ``distributed selection mechanism'', which just |
| 250 | overlays or changes. |
376 | means that one command uploads the file to a remote server, and another |
|
|
377 | reads it.</p> |
|
|
378 | </dd> |
|
|
379 | <dd> |
|
|
380 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
381 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
382 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
383 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
384 | </dd> |
|
|
385 | <dd> |
|
|
386 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
387 | </dd> |
|
|
388 | <dd> |
|
|
389 | <pre> |
|
|
390 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
391 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> |
| 251 | </dd> |
392 | </dd> |
| 252 | <p></p> |
393 | <p></p> |
| 253 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
394 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
| 254 | </dt> |
395 | </dt> |
| 255 | <dd> |
396 | <dd> |
| … | |
… | |
| 288 | for the filename):</p> |
429 | for the filename):</p> |
| 289 | </dd> |
430 | </dd> |
| 290 | <dd> |
431 | <dd> |
| 291 | <pre> |
432 | <pre> |
| 292 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
433 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
|
|
434 | </dd> |
|
|
435 | <p></p> |
|
|
436 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
|
|
437 | </dt> |
|
|
438 | <dd> |
|
|
439 | Displays a very simple digital clock in the upper right corner of the |
|
|
440 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
441 | overlays or changes. |
| 293 | </dd> |
442 | </dd> |
| 294 | <p></p></dl> |
443 | <p></p></dl> |
| 295 | <p> |
444 | <p> |
| 296 | </p> |
445 | </p> |
| 297 | <hr /> |
446 | <hr /> |
| … | |
… | |
| 372 | <h2><a name="hooks">Hooks</a></h2> |
521 | <h2><a name="hooks">Hooks</a></h2> |
| 373 | <p>The following subroutines can be declared in extension files, and will be |
522 | <p>The following subroutines can be declared in extension files, and will be |
| 374 | called whenever the relevant event happens.</p> |
523 | called whenever the relevant event happens.</p> |
| 375 | <p>The first argument passed to them is an extension oject as described in |
524 | <p>The first argument passed to them is an extension oject as described in |
| 376 | the in the <code>Extension Objects</code> section.</p> |
525 | 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 |
526 | <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 |
527 | 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> |
528 | 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> |
529 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 381 | <dl> |
530 | <dl> |
| 382 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
531 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 383 | </dt> |
532 | </dt> |
| 384 | <dd> |
533 | <dd> |
| 385 | Called after a new terminal object has been initialized, but before |
534 | 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 |
535 | 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 |
536 | call or deliver senseless data, as terminal size and other characteristics |
| 388 | have not yet been determined. You can safely query and change resources, |
537 | have not yet been determined. You can safely query and change resources |
| 389 | though. |
538 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
539 | place. |
|
|
540 | </dd> |
|
|
541 | <p></p> |
|
|
542 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
543 | </dt> |
|
|
544 | <dd> |
|
|
545 | Called at the very end of initialisation of a new terminal, just before |
|
|
546 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
547 | </dd> |
|
|
548 | <p></p> |
|
|
549 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
550 | </dt> |
|
|
551 | <dd> |
|
|
552 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
553 | still fully functional (not for long, though). |
| 390 | </dd> |
554 | </dd> |
| 391 | <p></p> |
555 | <p></p> |
| 392 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
556 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 393 | </dt> |
557 | </dt> |
| 394 | <dd> |
558 | <dd> |
| 395 | Called after the screen is ``reset'' for any reason, such as resizing or |
559 | 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 |
560 | control sequences. Here is where you can react on changes to size-related |
| 397 | variables. |
561 | variables. |
| 398 | </dd> |
562 | </dd> |
| 399 | <p></p> |
563 | <p></p> |
| 400 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
564 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
| 401 | </dt> |
565 | </dt> |
|
|
566 | <dd> |
|
|
567 | Called just after the child process has been <code>fork</code>ed. |
| 402 | <dd> |
568 | </dd> |
| 403 | Called at the very end of initialisation of a new terminal, just before |
569 | <p></p> |
| 404 | returning to the mainloop. |
570 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
571 | </dt> |
|
|
572 | <dd> |
|
|
573 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
574 | from <code>waitpid</code>. |
| 405 | </dd> |
575 | </dd> |
| 406 | <p></p> |
576 | <p></p> |
| 407 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
577 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 408 | </dt> |
578 | </dt> |
| 409 | <dd> |
579 | <dd> |
| … | |
… | |
| 526 | </dt> |
696 | </dt> |
| 527 | <dd> |
697 | <dd> |
| 528 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
698 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
| 529 | </dd> |
699 | </dd> |
| 530 | <p></p> |
700 | <p></p> |
| 531 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
701 | <dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br /> |
| 532 | </dt> |
702 | </dt> |
| 533 | <dd> |
703 | <dd> |
| 534 | Called whenever the user presses a key combination that has a |
704 | 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> |
705 | 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). |
706 | resource in the <code>rxvt(1)</code> manpage). |
|
|
707 | </dd> |
|
|
708 | <dd> |
|
|
709 | <p>The event is simply the action string. This interface is assumed to change |
|
|
710 | slightly in the future.</p> |
| 537 | </dd> |
711 | </dd> |
| 538 | <p></p> |
712 | <p></p> |
| 539 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
713 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
| 540 | </dt> |
714 | </dt> |
| 541 | <dd> |
715 | <dd> |
| … | |
… | |
| 556 | <dd> |
730 | <dd> |
| 557 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
731 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 558 | focus out processing. |
732 | focus out processing. |
| 559 | </dd> |
733 | </dd> |
| 560 | <p></p> |
734 | <p></p> |
|
|
735 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
736 | </dt> |
|
|
737 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
738 | </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 /> |
739 | <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> |
740 | </dt> |
| 563 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
741 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
| 564 | </dt> |
742 | </dt> |
| 565 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
743 | <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 |
754 | 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. |
755 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 578 | </dd> |
756 | </dd> |
| 579 | <dd> |
757 | <dd> |
| 580 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
758 | <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 |
759 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 582 | and column under the mouse cursor.</p> |
760 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 583 | </dd> |
761 | </dd> |
| 584 | <dd> |
762 | <dd> |
| 585 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
763 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 586 | output, if any, in locale-specific encoding.</p> |
764 | output, if any, in locale-specific encoding.</p> |
| 587 | </dd> |
765 | </dd> |
| 588 | <dd> |
766 | <dd> |
| 589 | <p>subwindow.</p> |
767 | <p>subwindow.</p> |
|
|
768 | </dd> |
|
|
769 | <p></p> |
|
|
770 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
771 | </dt> |
|
|
772 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
773 | </dt> |
|
|
774 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
775 | </dt> |
|
|
776 | <dd> |
|
|
777 | Called when various types of ClientMessage events are received (all with |
|
|
778 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
| 590 | </dd> |
779 | </dd> |
| 591 | <p></p></dl> |
780 | <p></p></dl> |
| 592 | <p> |
781 | <p> |
| 593 | </p> |
782 | </p> |
| 594 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
783 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| … | |
… | |
| 616 | </dt> |
805 | </dt> |
| 617 | <dd> |
806 | <dd> |
| 618 | The current terminal. This variable stores the current <code>urxvt::term</code> |
807 | The current terminal. This variable stores the current <code>urxvt::term</code> |
| 619 | object, whenever a callback/hook is executing. |
808 | object, whenever a callback/hook is executing. |
| 620 | </dd> |
809 | </dd> |
|
|
810 | <p></p> |
|
|
811 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
812 | </dt> |
|
|
813 | <dd> |
|
|
814 | All coderefs in this array will be called as methods of the next newly |
|
|
815 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
816 | gets cleared before the codereferences that were in it are being executed, |
|
|
817 | so coderefs can push themselves onto it again if they so desire. |
|
|
818 | </dd> |
|
|
819 | <dd> |
|
|
820 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
821 | first.</p> |
|
|
822 | </dd> |
|
|
823 | <p></p> |
|
|
824 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
825 | </dt> |
|
|
826 | <dd> |
|
|
827 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
828 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
829 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
830 | </dd> |
| 621 | <p></p></dl> |
831 | <p></p></dl> |
| 622 | <p> |
832 | <p> |
| 623 | </p> |
833 | </p> |
| 624 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
834 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| 625 | <dl> |
835 | <dl> |
| … | |
… | |
| 642 | <p>Using this function has the advantage that its output ends up in the |
852 | <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> |
853 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
| 644 | </dd> |
854 | </dd> |
| 645 | <dd> |
855 | <dd> |
| 646 | <p>Messages have a size limit of 1023 bytes currently.</p> |
856 | <p>Messages have a size limit of 1023 bytes currently.</p> |
|
|
857 | </dd> |
|
|
858 | <p></p> |
|
|
859 | <dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br /> |
|
|
860 | </dt> |
|
|
861 | <dd> |
|
|
862 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
863 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
864 | objects that have perl extensions attached will be returned (because there |
|
|
865 | is no urxvt::term objet associated with others). |
| 647 | </dd> |
866 | </dd> |
| 648 | <p></p> |
867 | <p></p> |
| 649 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
868 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
| 650 | </dt> |
869 | </dt> |
| 651 | <dd> |
870 | <dd> |
| … | |
… | |
| 719 | <p></p> |
938 | <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 /> |
939 | <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> |
940 | </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 /> |
941 | <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> |
942 | </dt> |
|
|
943 | <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 /> |
|
|
944 | </dt> |
| 724 | <dd> |
945 | <dd> |
| 725 | Replace the foreground/background colour in the rendition mask with the |
946 | Replace the foreground/background colour in the rendition mask with the |
| 726 | specified one. |
947 | specified one. |
| 727 | </dd> |
948 | </dd> |
| 728 | <p></p> |
949 | <p></p> |
| … | |
… | |
| 762 | </dd> |
983 | </dd> |
| 763 | <dd> |
984 | <dd> |
| 764 | <p>Croaks (and probably outputs an error message) if the new instance |
985 | <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 |
986 | 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 |
987 | 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> |
988 | <a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to |
|
|
989 | refer to global data (which is race free).</p> |
| 768 | </dd> |
990 | </dd> |
| 769 | <p></p> |
991 | <p></p> |
| 770 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
992 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
| 771 | </dt> |
993 | </dt> |
| 772 | <dd> |
994 | <dd> |
| 773 | Destroy the terminal object (close the window, free resources |
995 | Destroy the terminal object (close the window, free resources |
| 774 | etc.). Please note that rxvt will not exit as long as any event |
996 | etc.). Please note that rxvt will not exit as long as any event |
| 775 | watchers (timers, io watchers) are still active. |
997 | watchers (timers, io watchers) are still active. |
| 776 | </dd> |
998 | </dd> |
| 777 | <p></p> |
999 | <p></p> |
|
|
1000 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
1001 | </dt> |
|
|
1002 | <dd> |
|
|
1003 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
1004 | (``starts'') programs in the background. This function takes care of setting |
|
|
1005 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
1006 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
1007 | </dd> |
|
|
1008 | <dd> |
|
|
1009 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
1010 | </dd> |
|
|
1011 | <p></p> |
| 778 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
1012 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
| 779 | </dt> |
1013 | </dt> |
| 780 | <dd> |
1014 | <dd> |
| 781 | Returns true if the option specified by <code>$optval</code> is enabled, and |
1015 | 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 |
1016 | optionally change it. All option values are stored by name in the hash |
| … | |
… | |
| 788 | </dd> |
1022 | </dd> |
| 789 | <dd> |
1023 | <dd> |
| 790 | <pre> |
1024 | <pre> |
| 791 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1025 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 792 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1026 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 793 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1027 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 794 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1028 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 795 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1029 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 796 | tripleclickwords utmpInhibit visualBell</pre> |
1030 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 797 | </dd> |
1031 | </dd> |
| 798 | <p></p> |
1032 | <p></p> |
| 799 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
1033 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 800 | </dt> |
1034 | </dt> |
| 801 | <dd> |
1035 | <dd> |
| … | |
… | |
| 826 | <pre> |
1060 | <pre> |
| 827 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1061 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 828 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1062 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 829 | display_name embed ext_bwidth fade font geometry hold iconName |
1063 | display_name embed ext_bwidth fade font geometry hold iconName |
| 830 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1064 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 831 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1065 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 832 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1066 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 833 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1067 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 834 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1068 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 835 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1069 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 836 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1070 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 837 | shade term_name title transparent transparent_all tripleclickwords |
1071 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1072 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 838 | utmpInhibit visualBell</pre> |
1073 | visualBell</pre> |
| 839 | </dd> |
1074 | </dd> |
| 840 | <p></p> |
1075 | <p></p> |
| 841 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
1076 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
| 842 | </dt> |
1077 | </dt> |
| 843 | <dd> |
1078 | <dd> |
| … | |
… | |
| 1018 | <p>Normally its not a good idea to use this function, as programs might be |
1253 | <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 |
1254 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1020 | <code>on_add_lines</code> hook, though.</p> |
1255 | <code>on_add_lines</code> hook, though.</p> |
| 1021 | </dd> |
1256 | </dd> |
| 1022 | <p></p> |
1257 | <p></p> |
|
|
1258 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1259 | </dt> |
|
|
1260 | <dd> |
|
|
1261 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1262 | </dd> |
|
|
1263 | <p></p> |
| 1023 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1264 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
| 1024 | </dt> |
1265 | </dt> |
| 1025 | <dd> |
1266 | <dd> |
| 1026 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1267 | 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 |
1268 | 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 |
1284 | 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 |
1285 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
| 1045 | the previous value. |
1286 | the previous value. |
| 1046 | </dd> |
1287 | </dd> |
| 1047 | <p></p> |
1288 | <p></p> |
|
|
1289 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong><br /> |
|
|
1290 | </dt> |
|
|
1291 | <dd> |
|
|
1292 | Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1293 | is used. |
|
|
1294 | </dd> |
|
|
1295 | <p></p> |
| 1048 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1296 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
| 1049 | </dt> |
1297 | </dt> |
| 1050 | <dd> |
1298 | <dd> |
| 1051 | Return the window id of the toplevel window. |
1299 | Return the window id of the toplevel window. |
| 1052 | </dd> |
1300 | </dd> |
| … | |
… | |
| 1066 | <dd> |
1314 | <dd> |
| 1067 | <pre> |
1315 | <pre> |
| 1068 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
1316 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
| 1069 | </dd> |
1317 | </dd> |
| 1070 | <p></p> |
1318 | <p></p> |
|
|
1319 | <dt><strong><a name="item_focus_in">$term->focus_in</a></strong><br /> |
|
|
1320 | </dt> |
|
|
1321 | <dt><strong><a name="item_focus_out">$term->focus_out</a></strong><br /> |
|
|
1322 | </dt> |
|
|
1323 | <dt><strong><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a></strong><br /> |
|
|
1324 | </dt> |
|
|
1325 | <dt><strong><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a></strong><br /> |
|
|
1326 | </dt> |
|
|
1327 | <dd> |
|
|
1328 | Deliver various fake events to to terminal. |
|
|
1329 | </dd> |
|
|
1330 | <p></p> |
| 1071 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1331 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
| 1072 | </dt> |
1332 | </dt> |
| 1073 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1333 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
| 1074 | </dt> |
1334 | </dt> |
| 1075 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1335 | <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 /> |
1382 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
| 1123 | </dt> |
1383 | </dt> |
| 1124 | <dd> |
1384 | <dd> |
| 1125 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1385 | 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. |
1386 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1387 | </dd> |
|
|
1388 | <p></p> |
|
|
1389 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1390 | </dt> |
|
|
1391 | <dd> |
|
|
1392 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1393 | </dd> |
|
|
1394 | <p></p> |
|
|
1395 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1396 | </dt> |
|
|
1397 | <dd> |
|
|
1398 | Returns wether the cursor is currently hidden or not. |
| 1127 | </dd> |
1399 | </dd> |
| 1128 | <p></p> |
1400 | <p></p> |
| 1129 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1401 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 1130 | </dt> |
1402 | </dt> |
| 1131 | <dd> |
1403 | <dd> |
| … | |
… | |
| 1160 | to replace only parts of a line. The font index in the rendition will |
1432 | to replace only parts of a line. The font index in the rendition will |
| 1161 | automatically be updated.</p> |
1433 | automatically be updated.</p> |
| 1162 | </dd> |
1434 | </dd> |
| 1163 | <dd> |
1435 | <dd> |
| 1164 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1436 | <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 |
1437 | 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 |
1438 | characters. Characters with combining characters and other characters that |
| 1167 | that do not fit into the normal tetx encoding will be replaced with |
1439 | do not fit into the normal tetx encoding will be replaced with characters |
| 1168 | characters in the private use area.</p> |
1440 | in the private use area.</p> |
| 1169 | </dd> |
1441 | </dd> |
| 1170 | <dd> |
1442 | <dd> |
| 1171 | <p>You have to obey this encoding when changing text. The advantage is |
1443 | <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 |
1444 | that <code>substr</code> and similar functions work on screen cells and not on |
| 1173 | characters.</p> |
1445 | characters.</p> |
| … | |
… | |
| 1269 | <dd> |
1541 | <dd> |
| 1270 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1542 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 1271 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1543 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| 1272 | </dd> |
1544 | </dd> |
| 1273 | <p></p> |
1545 | <p></p> |
| 1274 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
1546 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
| 1275 | </dt> |
1547 | </dt> |
|
|
1548 | <dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
|
|
1549 | </dt> |
| 1276 | <dd> |
1550 | <dd> |
| 1277 | Registers a synchronous button grab. See the XGrabButton manpage. |
1551 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1552 | manpage. |
| 1278 | </dd> |
1553 | </dd> |
| 1279 | <p></p> |
1554 | <p></p> |
| 1280 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
1555 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
| 1281 | </dt> |
1556 | </dt> |
| 1282 | <dd> |
1557 | <dd> |
| … | |
… | |
| 1307 | </dt> |
1582 | </dt> |
| 1308 | <dd> |
1583 | <dd> |
| 1309 | Calls XUngrab for the most recent grab. Is called automatically on |
1584 | 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 |
1585 | evaluation errors, as it is better to lose the grab in the error case as |
| 1311 | the session. |
1586 | the session. |
|
|
1587 | </dd> |
|
|
1588 | <p></p> |
|
|
1589 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1590 | </dt> |
|
|
1591 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1592 | </dt> |
|
|
1593 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1594 | </dt> |
|
|
1595 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1596 | </dt> |
|
|
1597 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1598 | </dt> |
|
|
1599 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1600 | </dt> |
|
|
1601 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1602 | </dt> |
|
|
1603 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1604 | </dt> |
|
|
1605 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1606 | </dt> |
|
|
1607 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1608 | </dt> |
|
|
1609 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1610 | </dt> |
|
|
1611 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1612 | </dt> |
|
|
1613 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1614 | </dt> |
|
|
1615 | <dd> |
|
|
1616 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1617 | the source of the display, otherwise those functions map more-or-less |
|
|
1618 | directory onto the X functions of the same name. |
| 1312 | </dd> |
1619 | </dd> |
| 1313 | <p></p></dl> |
1620 | <p></p></dl> |
| 1314 | <p> |
1621 | <p> |
| 1315 | </p> |
1622 | </p> |
| 1316 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1623 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
| … | |
… | |
| 1404 | <p></p> |
1711 | <p></p> |
| 1405 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1712 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
| 1406 | </dt> |
1713 | </dt> |
| 1407 | <dd> |
1714 | <dd> |
| 1408 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1715 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1716 | </dd> |
|
|
1717 | <p></p> |
|
|
1718 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1719 | </dt> |
|
|
1720 | <dd> |
|
|
1721 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 1409 | </dd> |
1722 | </dd> |
| 1410 | <p></p> |
1723 | <p></p> |
| 1411 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1724 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 1412 | </dt> |
1725 | </dt> |
| 1413 | <dd> |
1726 | <dd> |
| … | |
… | |
| 1471 | Stop watching for events on the given filehandle. |
1784 | Stop watching for events on the given filehandle. |
| 1472 | </dd> |
1785 | </dd> |
| 1473 | <p></p></dl> |
1786 | <p></p></dl> |
| 1474 | <p> |
1787 | <p> |
| 1475 | </p> |
1788 | </p> |
|
|
1789 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1790 | <p>This class implements idle watchers, that get called automatically when |
|
|
1791 | the process is idle. They should return as fast as possible, after doing |
|
|
1792 | some useful work.</p> |
|
|
1793 | <dl> |
|
|
1794 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1795 | </dt> |
|
|
1796 | <dd> |
|
|
1797 | Create a new idle watcher object in stopped state. |
|
|
1798 | </dd> |
|
|
1799 | <p></p> |
|
|
1800 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1801 | </dt> |
|
|
1802 | <dd> |
|
|
1803 | Set the callback to be called when the watcher triggers. |
|
|
1804 | </dd> |
|
|
1805 | <p></p> |
|
|
1806 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1807 | </dt> |
|
|
1808 | <dd> |
|
|
1809 | Start the watcher. |
|
|
1810 | </dd> |
|
|
1811 | <p></p> |
|
|
1812 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1813 | </dt> |
|
|
1814 | <dd> |
|
|
1815 | Stop the watcher. |
|
|
1816 | </dd> |
|
|
1817 | <p></p></dl> |
|
|
1818 | <p> |
|
|
1819 | </p> |
|
|
1820 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1821 | <p>This class implements process watchers. They create an event whenever a |
|
|
1822 | process exits, after which they stop automatically.</p> |
|
|
1823 | <pre> |
|
|
1824 | my $pid = fork; |
|
|
1825 | ... |
|
|
1826 | $term->{pw} = urxvt::pw |
|
|
1827 | ->new |
|
|
1828 | ->start ($pid) |
|
|
1829 | ->cb (sub { |
|
|
1830 | my ($pw, $exit_status) = @_; |
|
|
1831 | ... |
|
|
1832 | });</pre> |
|
|
1833 | <dl> |
|
|
1834 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1835 | </dt> |
|
|
1836 | <dd> |
|
|
1837 | Create a new process watcher in stopped state. |
|
|
1838 | </dd> |
|
|
1839 | <p></p> |
|
|
1840 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1841 | </dt> |
|
|
1842 | <dd> |
|
|
1843 | Set the callback to be called when the timer triggers. |
|
|
1844 | </dd> |
|
|
1845 | <p></p> |
|
|
1846 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1847 | </dt> |
|
|
1848 | <dd> |
|
|
1849 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1850 | </dd> |
|
|
1851 | <p></p> |
|
|
1852 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1853 | </dt> |
|
|
1854 | <dd> |
|
|
1855 | Stop the watcher. |
|
|
1856 | </dd> |
|
|
1857 | <p></p></dl> |
|
|
1858 | <p> |
|
|
1859 | </p> |
| 1476 | <hr /> |
1860 | <hr /> |
| 1477 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1861 | <h1><a name="environment">ENVIRONMENT</a></h1> |
| 1478 | <p> |
1862 | <p> |
| 1479 | </p> |
1863 | </p> |
| 1480 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1864 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
