1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
3 | <head> |
3 | <head> |
4 | <title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> |
4 | <title>urxvtperl - rxvt-unicode's embedded perl interpreter</title> |
5 | <link rev="made" href="mailto:perl-binary@plan9.de" /> |
5 | <link rev="made" href="mailto:perl-binary@plan9.de" /> |
6 | </head> |
6 | </head> |
7 | |
7 | |
8 | <body style="background-color: white"> |
8 | <body style="background-color: white"> |
9 | |
9 | |
… | |
… | |
45 | <hr /> |
45 | <hr /> |
46 | <p> |
46 | <p> |
47 | </p> |
47 | </p> |
48 | <hr /> |
48 | <hr /> |
49 | <h1><a name="name">NAME</a></h1> |
49 | <h1><a name="name">NAME</a></h1> |
50 | <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
50 | <p>urxvtperl - rxvt-unicode's embedded perl interpreter</p> |
51 | <p> |
51 | <p> |
52 | </p> |
52 | </p> |
53 | <hr /> |
53 | <hr /> |
54 | <h1><a name="synopsis">SYNOPSIS</a></h1> |
54 | <h1><a name="synopsis">SYNOPSIS</a></h1> |
55 | <pre> |
55 | <pre> |
… | |
… | |
58 | sub on_sel_grab { |
58 | sub on_sel_grab { |
59 | warn "you selected ", $_[0]->selection; |
59 | warn "you selected ", $_[0]->selection; |
60 | () |
60 | () |
61 | }</pre> |
61 | }</pre> |
62 | <pre> |
62 | <pre> |
63 | # start a rxvt using it:</pre> |
63 | # start a urxvt using it:</pre> |
64 | <pre> |
64 | <pre> |
65 | rxvt --perl-lib $HOME -pe grab_test</pre> |
65 | urxvt --perl-lib $HOME -pe grab_test</pre> |
66 | <p> |
66 | <p> |
67 | </p> |
67 | </p> |
68 | <hr /> |
68 | <hr /> |
69 | <h1><a name="description">DESCRIPTION</a></h1> |
69 | <h1><a name="description">DESCRIPTION</a></h1> |
70 | <p>Everytime a terminal object gets created, extension scripts specified via |
70 | <p>Everytime a terminal object gets created, extension scripts specified via |
71 | the <code>perl</code> resource are loaded and associated with it.</p> |
71 | the <code>perl</code> resource are loaded and associated with it.</p> |
72 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
72 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
73 | thus must be encoded as UTF-8.</p> |
73 | thus must be encoded as UTF-8.</p> |
74 | <p>Each script will only ever be loaded once, even in rxvtd, where |
74 | <p>Each script will only ever be loaded once, even in urxvtd, where |
75 | scripts will be shared (but not enabled) for all terminals.</p> |
75 | scripts will be shared (but not enabled) for all terminals.</p> |
76 | <p> |
76 | <p> |
77 | </p> |
77 | </p> |
78 | <hr /> |
78 | <hr /> |
79 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
79 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
80 | <p>This section describes the extensions delivered with this release. You can |
80 | <p>This section describes the extensions delivered with this release. You can |
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
81 | find them in <em>/usr/local/lib/urxvt/perl/</em>.</p> |
82 | <p>You can activate them like this:</p> |
82 | <p>You can activate them like this:</p> |
83 | <pre> |
83 | <pre> |
84 | rxvt -pe <extensionname></pre> |
84 | urxvt -pe <extensionname></pre> |
85 | <dl> |
85 | <dl> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
87 | </dt> |
87 | </dt> |
88 | <dd> |
88 | <dd> |
89 | (More) intelligent selection. This extension tries to be more intelligent |
89 | (More) intelligent selection. This extension tries to be more intelligent |
… | |
… | |
189 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
189 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
190 | $word</code>:</p> |
190 | $word</code>:</p> |
191 | </dd> |
191 | </dd> |
192 | <dd> |
192 | <dd> |
193 | <pre> |
193 | <pre> |
194 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
194 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
195 | </dd> |
195 | </dd> |
196 | <dd> |
196 | <dd> |
197 | <p>And this example matches the same,but replaces it with vi-commands you can |
197 | <p>And this example matches the same,but replaces it with vi-commands you can |
198 | paste directly into your (vi :) editor:</p> |
198 | paste directly into your (vi :) editor:</p> |
199 | </dd> |
199 | </dd> |
200 | <dd> |
200 | <dd> |
201 | <pre> |
201 | <pre> |
202 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
202 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
203 | </dd> |
203 | </dd> |
204 | <dd> |
204 | <dd> |
205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
206 | </dd> |
206 | </dd> |
207 | <dd> |
207 | <dd> |
… | |
… | |
489 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
489 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
490 | </dt> |
490 | </dt> |
491 | <dd> |
491 | <dd> |
492 | Called whenever the user presses a key combination that has a |
492 | Called whenever the user presses a key combination that has a |
493 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
493 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
494 | resource in the <code>rxvt(1)</code> manpage). |
494 | resource in the <code>urxvt(1)</code> manpage). |
|
|
495 | </dd> |
|
|
496 | <p></p> |
|
|
497 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
498 | </dt> |
|
|
499 | <dd> |
|
|
500 | Called on every X event received on the vt window (and possibly other |
|
|
501 | windows). Should only be used as a last resort. Most event structure |
|
|
502 | members are not passed. |
495 | </dd> |
503 | </dd> |
496 | <p></p> |
504 | <p></p> |
497 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
505 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
498 | </dt> |
506 | </dt> |
499 | <dd> |
507 | <dd> |
… | |
… | |
613 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
621 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
614 | </dt> |
622 | </dt> |
615 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
623 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
616 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
624 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
617 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
625 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
626 | </dt> |
|
|
627 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
628 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
629 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
630 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
631 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
632 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
633 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
634 | </dt> |
|
|
635 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
636 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
637 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
638 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
639 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
640 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
641 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
618 | </dt> |
642 | </dt> |
619 | <dd> |
643 | <dd> |
620 | Various constants for use in X calls and event processing. |
644 | Various constants for use in X calls and event processing. |
621 | </dd> |
645 | </dd> |
622 | <p></p></dl> |
646 | <p></p></dl> |
… | |
… | |
711 | <p></p> |
735 | <p></p> |
712 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
736 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
713 | </dt> |
737 | </dt> |
714 | <dd> |
738 | <dd> |
715 | Destroy the terminal object (close the window, free resources |
739 | Destroy the terminal object (close the window, free resources |
716 | etc.). Please note that rxvt will not exit as long as any event |
740 | etc.). Please note that urxvt will not exit as long as any event |
717 | watchers (timers, io watchers) are still active. |
741 | watchers (timers, io watchers) are still active. |
718 | </dd> |
742 | </dd> |
719 | <p></p> |
743 | <p></p> |
720 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
744 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
721 | </dt> |
745 | </dt> |
… | |
… | |
796 | <p></p> |
820 | <p></p> |
797 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
821 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
798 | </dt> |
822 | </dt> |
799 | <dd> |
823 | <dd> |
800 | Adds a keymap translation exactly as specified via a resource. See the |
824 | Adds a keymap translation exactly as specified via a resource. See the |
801 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
825 | <code>keysym</code> resource in the <code>urxvt(1)</code> manpage. |
802 | </dd> |
826 | </dd> |
803 | <p></p> |
827 | <p></p> |
804 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
828 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
805 | </dt> |
829 | </dt> |
806 | <dd> |
830 | <dd> |
… | |
… | |
995 | <p></p> |
1019 | <p></p> |
996 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
1020 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
997 | </dt> |
1021 | </dt> |
998 | <dd> |
1022 | <dd> |
999 | Return the window id of the terminal window. |
1023 | Return the window id of the terminal window. |
|
|
1024 | </dd> |
|
|
1025 | <p></p> |
|
|
1026 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1027 | </dt> |
|
|
1028 | <dd> |
|
|
1029 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1030 | to receive pointer events all the times: |
|
|
1031 | </dd> |
|
|
1032 | <dd> |
|
|
1033 | <pre> |
|
|
1034 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
1000 | </dd> |
1035 | </dd> |
1001 | <p></p> |
1036 | <p></p> |
1002 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1037 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1003 | </dt> |
1038 | </dt> |
1004 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1039 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |