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

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.3 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.5 by root, Mon Jan 2 21:41:51 2006 UTC

… …
42<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> 42<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
43<p> 43<p>
44</p> 44</p>
45<hr /> 45<hr />
46<h1><a name="synopsis">SYNOPSIS</a></h1> 46<h1><a name="synopsis">SYNOPSIS</a></h1>
47<p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> 47<pre>
48<p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and 48 # create a file grab_test in $HOME:</pre>
49thus must be encoded as UTF-8.</p>
50<pre> 49<pre>
51 sub on_sel_grab { 50 sub on_sel_grab {
52 warn &quot;you selected &quot;, $_[0]-&gt;selection; 51 warn &quot;you selected &quot;, $_[0]-&gt;selection;
53 () 52 ()
54 }</pre> 53 }</pre>
55<pre> 54<pre>
56 1</pre> 55 # start a rxvt using it:</pre>
56<pre>
57 rxvt --perl-lib $HOME -pe grab_test</pre>
57<p> 58<p>
58</p> 59</p>
59<hr /> 60<hr />
60<h1><a name="description">DESCRIPTION</a></h1> 61<h1><a name="description">DESCRIPTION</a></h1>
61<p>On startup, rxvt will scan <em>/opt/rxvt/lib/urxvt/perl-ext/</em> 62<p>Everytime a terminal object gets created, scripts specified via the
62for files and will load them. Everytime a terminal object gets created, 63<code>perl</code> resource are loaded and associated with it.</p>
63the directory specified by the <code>perl-lib</code> resource will be additionally 64<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
64scanned.</p> 65thus must be encoded as UTF-8.</p>
65<p>Each script will only ever be loaded once, even in rxvtd, where 66<p>Each script will only ever be loaded once, even in rxvtd, where
66scripts will be shared for all terminals.</p> 67scripts will be shared (But not enabled) for all terminals.</p>
67<p>Hooks in scripts specified by <code>perl-lib</code> will only be called for the
68terminals created with that specific option value.</p>
69<p> 68<p>
70</p> 69</p>
71<h2><a name="general_api_considerations">General API Considerations</a></h2> 70<h2><a name="general_api_considerations">General API Considerations</a></h2>
72<p>All objects (such as terminals, time watchers etc.) are typical 71<p>All objects (such as terminals, time watchers etc.) are typical
73reference-to-hash objects. The hash can be used to store anything you 72reference-to-hash objects. The hash can be used to store anything you
… …
186<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> 185<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br />
187</dt> 186</dt>
188<dd> 187<dd>
189Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 188Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
190</dd> 189</dd>
190<p></p>
191<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
192</dt>
193<dd>
194Called whenever the user presses a key combination that has a
195<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
196resource in the <code>rxvt(1)</code> manpage).
197</dd>
191<p></p></dl> 198<p></p></dl>
192<p> 199<p>
193</p> 200</p>
194<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 201<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
195<dl> 202<dl>
… …
253<pre> 260<pre>
254 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 261 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
255 borderLess color cursorBlink cursorUnderline cutchars delete_key 262 borderLess color cursorBlink cursorUnderline cutchars delete_key
256 display_name embed ext_bwidth fade font geometry hold iconName 263 display_name embed ext_bwidth fade font geometry hold iconName
257 imFont imLocale inputMethod insecure int_bwidth intensityStyles 264 imFont imLocale inputMethod insecure int_bwidth intensityStyles
258 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 265 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
259 modifier mouseWheelScrollPage name pastableTabs path perl perl_eval 266 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
260 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 267 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
261 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 268 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
262 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 269 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
263 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 270 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
264 shade term_name title transparent transparent_all tripleclickwords 271 shade term_name title transparent transparent_all tripleclickwords

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines