| … | |
… | |
| 302 | object, whenever a callback/hook is executing. |
302 | object, whenever a callback/hook is executing. |
| 303 | |
303 | |
| 304 | * |
304 | * |
| 305 | |
305 | |
| 306 | Functions in the "urxvt" Package |
306 | Functions in the "urxvt" Package |
| 307 | $term = new urxvt [arg...] |
|
|
| 308 | Creates a new terminal, very similar as if you had started it with |
|
|
| 309 | "system $binfile, arg...". Croaks (and probably outputs an error |
|
|
| 310 | message) if the new instance couldn't be created. Returns "undef" if |
|
|
| 311 | the new instance didn't initialise perl, and the terminal object |
|
|
| 312 | otherwise. The "init" and "start" hooks will be called during the |
|
|
| 313 | call. |
|
|
| 314 | |
|
|
| 315 | urxvt::fatal $errormessage |
307 | urxvt::fatal $errormessage |
| 316 | Fatally aborts execution with the given error message. Avoid at all |
308 | Fatally aborts execution with the given error message. Avoid at all |
| 317 | costs! The only time this is acceptable is when the terminal process |
309 | costs! The only time this is acceptable is when the terminal process |
| 318 | starts up. |
310 | starts up. |
| 319 | |
311 | |
| … | |
… | |
| 322 | newline. The module also overwrites the "warn" builtin with a |
314 | newline. The module also overwrites the "warn" builtin with a |
| 323 | function that calls this function. |
315 | function that calls this function. |
| 324 | |
316 | |
| 325 | Using this function has the advantage that its output ends up in the |
317 | Using this function has the advantage that its output ends up in the |
| 326 | correct place, e.g. on stderr of the connecting urxvtc client. |
318 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
319 | |
|
|
320 | Messages have a size limit of 1023 bytes currently. |
| 327 | |
321 | |
| 328 | $is_safe = urxvt::safe |
322 | $is_safe = urxvt::safe |
| 329 | Returns true when it is safe to do potentially unsafe things, such |
323 | Returns true when it is safe to do potentially unsafe things, such |
| 330 | as evaluating perl code specified by the user. This is true when |
324 | as evaluating perl code specified by the user. This is true when |
| 331 | urxvt was started setuid or setgid. |
325 | urxvt was started setuid or setgid. |
| … | |
… | |
| 385 | condition variables, but non-blocking condvar use is ok. What this means |
379 | condition variables, but non-blocking condvar use is ok. What this means |
| 386 | is that you cannot use blocking APIs, but the non-blocking variant |
380 | is that you cannot use blocking APIs, but the non-blocking variant |
| 387 | should work. |
381 | should work. |
| 388 | |
382 | |
| 389 | The "urxvt::term" Class |
383 | The "urxvt::term" Class |
|
|
384 | $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
|
|
385 | Creates a new terminal, very similar as if you had started it with |
|
|
386 | system "$rxvtname, arg...". $envhashref must be a reference to a |
|
|
387 | %ENV>-like "hash which defines the environment of the new terminal. |
|
|
388 | " |
|
|
389 | |
|
|
390 | >Croaks (and probably outputs an error message) if the new instance |
|
|
391 | couldn't be created. Returns "undef" if the new instance didn't |
|
|
392 | initialise perl, and the terminal object otherwise. The "init" and |
|
|
393 | "start" hooks will be called during this call. |
|
|
394 | |
| 390 | $term->destroy |
395 | $term->destroy |
| 391 | Destroy the terminal object (close the window, free resources etc.). |
396 | Destroy the terminal object (close the window, free resources etc.). |
| 392 | Please note that rxvt will not exit as long as any event watchers |
397 | Please note that rxvt will not exit as long as any event watchers |
| 393 | (timers, io watchers) are still active. |
398 | (timers, io watchers) are still active. |
| 394 | |
399 | |
| … | |
… | |
| 577 | $max_scrollback = $term->saveLines |
582 | $max_scrollback = $term->saveLines |
| 578 | $nrow_plus_saveLines = $term->total_rows |
583 | $nrow_plus_saveLines = $term->total_rows |
| 579 | $lines_in_scrollback = $term->nsaved |
584 | $lines_in_scrollback = $term->nsaved |
| 580 | Return various integers describing terminal characteristics. |
585 | Return various integers describing terminal characteristics. |
| 581 | |
586 | |
|
|
587 | $x_display = $term->display_id |
|
|
588 | Return the DISPLAY used by rxvt-unicode. |
|
|
589 | |
| 582 | $lc_ctype = $term->locale |
590 | $lc_ctype = $term->locale |
| 583 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
591 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
| 584 | |
592 | |
| 585 | $x_display = $term->display_id |
593 | $env = $term->env |
| 586 | Return the DISPLAY used by rxvt-unicode. |
594 | Returns a copy of the environment in effect for the terminal as a |
|
|
595 | hashref similar to "\%ENV". |
| 587 | |
596 | |
| 588 | $modifiermask = $term->ModLevel3Mask |
597 | $modifiermask = $term->ModLevel3Mask |
| 589 | $modifiermask = $term->ModMetaMask |
598 | $modifiermask = $term->ModMetaMask |
| 590 | $modifiermask = $term->ModNumLockMask |
599 | $modifiermask = $term->ModNumLockMask |
| 591 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
600 | Return the modifier masks corresponding to the "ISO Level 3 Shift" |
