ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.txt (file contents):
Revision 1.2 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.3 by root, Mon Jan 2 21:41:51 2006 UTC

1NAME 1NAME
2 rxvtperl - rxvt-unicode's embedded perl interpreter 2 rxvtperl - rxvt-unicode's embedded perl interpreter
3 3
4SYNOPSIS 4SYNOPSIS
5 * Put your scripts into /opt/rxvt/lib/urxvt/perl-ext/, they will be 5 # create a file grab_test in $HOME:
6 loaded automatically.
7
8 * Scripts are evaluated in a 'use strict' and 'use utf8' environment,
9 and thus must be encoded as UTF-8.
10 6
11 sub on_sel_grab { 7 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection; 8 warn "you selected ", $_[0]->selection;
13 () 9 ()
14 } 10 }
15 11
16 1 12 # start a rxvt using it:
13
14 rxvt --perl-lib $HOME -pe grab_test
17 15
18DESCRIPTION 16DESCRIPTION
19 Everytime a terminal object gets created, scripts specified via the 17 Everytime a terminal object gets created, scripts specified via the
20 "perl" resource are associated with it. 18 "perl" resource are loaded and associated with it.
19
20 Scripts are compiled in a 'use strict' and 'use utf8' environment, and
21 thus must be encoded as UTF-8.
21 22
22 Each script will only ever be loaded once, even in rxvtd, where scripts 23 Each script will only ever be loaded once, even in rxvtd, where scripts
23 will be shared (But not enabled) for all terminals. 24 will be shared (But not enabled) for all terminals.
24 25
25 General API Considerations 26 General API Considerations
107 restoring them in refresh_end. The built-in overlay and selection 108 restoring them in refresh_end. The built-in overlay and selection
108 display code is run after this hook, and takes precedence. 109 display code is run after this hook, and takes precedence.
109 110
110 on_refresh_end $term 111 on_refresh_end $term
111 Called just after the screen gets redrawn. See "on_refresh_begin". 112 Called just after the screen gets redrawn. See "on_refresh_begin".
113
114 on_keyboard_command $term, $string
115 Called whenever the user presses a key combination that has a
116 "perl:string" action bound to it (see description of the keysym
117 resource in the rxvt(1) manpage).
112 118
113 Functions in the "urxvt" Package 119 Functions in the "urxvt" Package
114 urxvt::fatal $errormessage 120 urxvt::fatal $errormessage
115 Fatally aborts execution with the given error message. Avoid at all 121 Fatally aborts execution with the given error message. Avoid at all
116 costs! The only time this is acceptable is when the terminal process 122 costs! The only time this is acceptable is when the terminal process

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines