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.8 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.17 by root, Mon Jan 9 01:36:56 2006 UTC

… …
18 <ul> 18 <ul>
19 19
20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> 20 <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li>
21 <li><a href="#general_api_considerations">General API Considerations</a></li> 21 <li><a href="#general_api_considerations">General API Considerations</a></li>
22 <li><a href="#hooks">Hooks</a></li> 22 <li><a href="#hooks">Hooks</a></li>
23 <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li>
23 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> 24 <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li>
24 <li><a href="#rendition">RENDITION</a></li> 25 <li><a href="#rendition">RENDITION</a></li>
26 <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li>
25 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> 27 <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li>
28 <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li>
26 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> 29 <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li>
27 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> 30 <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li>
28 </ul> 31 </ul>
29 32
30 <li><a href="#environment">ENVIRONMENT</a></li> 33 <li><a href="#environment">ENVIRONMENT</a></li>
… …
60 rxvt --perl-lib $HOME -pe grab_test</pre> 63 rxvt --perl-lib $HOME -pe grab_test</pre>
61<p> 64<p>
62</p> 65</p>
63<hr /> 66<hr />
64<h1><a name="description">DESCRIPTION</a></h1> 67<h1><a name="description">DESCRIPTION</a></h1>
65<p>Everytime a terminal object gets created, scripts specified via the 68<p>Everytime a terminal object gets created, extension scripts specified via
66<code>perl</code> resource are loaded and associated with it.</p> 69the <code>perl</code> resource are loaded and associated with it.</p>
67<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and 70<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
68thus must be encoded as UTF-8.</p> 71thus must be encoded as UTF-8.</p>
69<p>Each script will only ever be loaded once, even in rxvtd, where 72<p>Each script will only ever be loaded once, even in rxvtd, where
70scripts will be shared (but not enabled) for all terminals.</p> 73scripts will be shared (but not enabled) for all terminals.</p>
71<p> 74<p>
… …
75find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> 78find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p>
76<p>You can activate them like this:</p> 79<p>You can activate them like this:</p>
77<pre> 80<pre>
78 rxvt -pe &lt;extensionname&gt;</pre> 81 rxvt -pe &lt;extensionname&gt;</pre>
79<dl> 82<dl>
80<dt><strong><a name="item_selection">selection</a></strong><br /> 83<dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br />
81</dt> 84</dt>
85<dd>
86Intelligent selection. This extension tries to be more intelligent when
87the user extends selections (double-click). Right now, it tries to select
88urls and complete shell-quoted arguments, which is very convenient, too,
89if your <em>ls</em> supports <code>--quoting-style=shell</code>.
82<dd> 90</dd>
83Miscellaneous selection modifications. 91<dd>
92<p>It also offers the following bindable event:</p>
84</dd> 93</dd>
85<dl> 94<dl>
86<dt><strong><a name="item_rot13">rot13</a></strong><br /> 95<dt><strong><a name="item_rot13">rot13</a></strong><br />
87</dt> 96</dt>
88<dd> 97<dd>
… …
91<dd> 100<dd>
92<pre> 101<pre>
93 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 102 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
94</dd> 103</dd>
95<p></p></dl> 104<p></p></dl>
105<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
106</dt>
107<dd>
108Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
109runtime.
110</dd>
111<p></p>
112<dt><strong>selection-popup (enabled by default)</strong><br />
113</dt>
114<dd>
115Binds a popup menu to Ctrl-Button3 that lets you convert the selection
116text into various other formats/action.
117</dd>
118<p></p>
96<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 119<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
97</dt> 120</dt>
98<dd> 121<dd>
99Displays a digital clock using the built-in overlay. 122Displays a digital clock using the built-in overlay.
123</dd>
124<p></p>
125<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
126</dt>
127<dd>
128Uses per-line display filtering (<code>on_line_update</code>) to underline urls.
129</dd>
130<p></p>
131<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
132</dt>
133<dd>
134A not very useful example of filtering all text output to the terminal,
135by replacing all line-drawing characters (U+2500 .. U+259F) by a
136similar-looking ascii character.
100</dd> 137</dd>
101<p></p> 138<p></p>
102<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 139<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
103</dt> 140</dt>
104<dd> 141<dd>
… …
111</p> 148</p>
112<h2><a name="general_api_considerations">General API Considerations</a></h2> 149<h2><a name="general_api_considerations">General API Considerations</a></h2>
113<p>All objects (such as terminals, time watchers etc.) are typical 150<p>All objects (such as terminals, time watchers etc.) are typical
114reference-to-hash objects. The hash can be used to store anything you 151reference-to-hash objects. The hash can be used to store anything you
115like. All members starting with an underscore (such as <code>_ptr</code> or 152like. All members starting with an underscore (such as <code>_ptr</code> or
116<code>_hook</code>) are reserved for internal uses and must not be accessed or 153<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
117modified).</p> 154modified).</p>
118<p>When objects are destroyed on the C++ side, the perl object hashes are 155<p>When objects are destroyed on the C++ side, the perl object hashes are
119emptied, so its best to store related objects such as time watchers and 156emptied, so its best to store related objects such as time watchers and
120the like inside the terminal object so they get destroyed as soon as the 157the like inside the terminal object so they get destroyed as soon as the
121terminal is destroyed.</p> 158terminal is destroyed.</p>
159<p>Argument names also often indicate the type of a parameter. Here are some
160hints on what they mean:</p>
161<dl>
162<dt><strong><a name="item__24text">$text</a></strong><br />
163</dt>
164<dd>
165Rxvt-unicodes special way of encoding text, where one ``unicode'' character
166always represents one screen cell. See <em>row_t</em> for a discussion of this format.
167</dd>
168<p></p>
169<dt><strong><a name="item__24string">$string</a></strong><br />
170</dt>
171<dd>
172A perl text string, with an emphasis on <em>text</em>. It can store all unicode
173characters and is to be distinguished with text encoded in a specific
174encoding (often locale-specific) and binary data.
175</dd>
176<p></p>
177<dt><strong><a name="item__24octets">$octets</a></strong><br />
178</dt>
179<dd>
180Either binary data or - more common - a text string encoded in a
181locale-specific way.
182</dd>
183<p></p></dl>
122<p> 184<p>
123</p> 185</p>
124<h2><a name="hooks">Hooks</a></h2> 186<h2><a name="hooks">Hooks</a></h2>
125<p>The following subroutines can be declared in loaded scripts, and will be called 187<p>The following subroutines can be declared in extension files, and will be
126whenever the relevant event happens.</p> 188called whenever the relevant event happens.</p>
189<p>The first argument passed to them is an object private to each terminal
190and extension package. You can call all <code>urxvt::term</code> methods on it, but
191its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code>
192object that is shared between all packages is stored in the <code>term</code>
193member. It is, however, blessed intot he package of the extension script,
194so for all practical purposes you can treat an extension script as a class.</p>
127<p>All of them must return a boolean value. If it is true, then the event 195<p>All of them must return a boolean value. If it is true, then the event
128counts as being <em>consumed</em>, and the invocation of other hooks is skipped, 196counts as being <em>consumed</em>, and the invocation of other hooks is skipped,
129and the relevant action might not be carried out by the C++ code.</p> 197and the relevant action might not be carried out by the C++ code.</p>
130<p>When in doubt, return a false value (preferably <code>()</code>).</p> 198<p>When in doubt, return a false value (preferably <code>()</code>).</p>
131<dl> 199<dl>
132<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> 200<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br />
133</dt> 201</dt>
134<dd> 202<dd>
135Called after a new terminal object has been initialized, but before 203Called after a new terminal object has been initialized, but before
136windows are created or the command gets run. 204windows are created or the command gets run. Most methods are unsafe to
205call or deliver senseless data, as terminal size and other characteristics
206have not yet been determined. You can safely query and change resources,
207though.
137</dd> 208</dd>
138<p></p> 209<p></p>
139<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 210<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
140</dt> 211</dt>
141<dd> 212<dd>
… …
172</dd> 243</dd>
173<dd> 244<dd>
174<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> 245<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p>
175</dd> 246</dd>
176<p></p> 247<p></p>
177<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 248<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br />
178</dt> 249</dt>
179<dd>
180Called whenever the window gets the keyboard focus, before urxvt does
181focus in processing.
182</dd> 250<dd>
183<p></p> 251Called whenever the user tries to extend the selection (e.g. with a double
184<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> 252click) and is either supposed to return false (normal operation), or
185</dt> 253should extend the selection itelf and return true to suppress the built-in
254processing.
186<dd> 255</dd>
187Called wheneever the window loses keyboard focus, before urxvt does focus 256<dd>
188out processing. 257<p>See the <em>selection</em> example extension.</p>
189</dd> 258</dd>
190<p></p> 259<p></p>
191<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> 260<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br />
192</dt> 261</dt>
193<dd> 262<dd>
… …
207<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 276<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
208$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total 277$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
209number of lines that will be in the scrollback buffer.</p> 278number of lines that will be in the scrollback buffer.</p>
210</dd> 279</dd>
211<p></p> 280<p></p>
212<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> 281<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br />
213</dt> 282</dt>
283<dd>
284Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
285operating system command) is processed. Cursor position and other state
286information is up-to-date when this happens. For interoperability, the
287string should start with the extension name and a colon, to distinguish
288it from commands for other extensions, and this might be enforced in the
289future.
214<dd> 290</dd>
215Called whenever the <code>program(s)</code> running in the urxvt window send output. 291<dd>
292<p>Be careful not ever to trust (in a security sense) the data you receive,
293as its source can not easily be controleld (e-mail content, messages from
294other users on the same system etc.).</p>
295</dd>
296<p></p>
297<dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br />
298</dt>
299<dd>
300Called whenever text is about to be output, with the text as argument. You
301can filter/change and output the text yourself by returning a true value
302and calling <a href="#item_scr_add_lines"><code>$term-&gt;scr_add_lines</code></a> yourself. Please note that this
303might be very slow, however, as your hook is called for <strong>all</strong> text being
304output.
305</dd>
306<p></p>
307<dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br />
308</dt>
309<dd>
310Called whenever a line was updated or changed. Can be used to filter
311screen output (e.g. underline urls or other useless stuff). Only lines
312that are being shown will be filtered, and, due to performance reasons,
313not always immediately.
314</dd>
315<dd>
316<p>The row number is always the topmost row of the line if the line spans
317multiple rows.</p>
318</dd>
319<dd>
320<p>Please note that, if you change the line, then the hook might get called
321later with the already-modified line (e.g. if unrelated parts change), so
322you cannot just toggle rendition bits, but only set them.</p>
216</dd> 323</dd>
217<p></p> 324<p></p>
218<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> 325<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br />
219</dt> 326</dt>
220<dd> 327<dd>
… …
235<dd> 342<dd>
236Called whenever the user presses a key combination that has a 343Called whenever the user presses a key combination that has a
237<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 344<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
238resource in the <code>rxvt(1)</code> manpage). 345resource in the <code>rxvt(1)</code> manpage).
239</dd> 346</dd>
347<p></p>
348<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
349</dt>
350<dd>
351Called whenever the window gets the keyboard focus, before rxvt-unicode
352does focus in processing.
353</dd>
354<p></p>
355<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br />
356</dt>
357<dd>
358Called wheneever the window loses keyboard focus, before rxvt-unicode does
359focus out processing.
360</dd>
361<p></p>
362<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br />
363</dt>
364<dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br />
365</dt>
366<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
367</dt>
368<dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br />
369</dt>
370<dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br />
371</dt>
372<dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br />
373</dt>
374<dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br />
375</dt>
376<dd>
377Called whenever the corresponding X event is received for the terminal If
378the hook returns true, then the even will be ignored by rxvt-unicode.
379</dd>
380<dd>
381<p>The event is a hash with most values as named by Xlib (see the XEvent
382manpage), with the additional members <code>row</code> and <code>col</code>, which are the row
383and column under the mouse cursor.</p>
384</dd>
385<dd>
386<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
387output, if any, in locale-specific encoding.</p>
388</dd>
389<dd>
390<p>subwindow.</p>
391</dd>
240<p></p></dl> 392<p></p></dl>
241<p> 393<p>
242</p> 394</p>
395<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2>
396<dl>
397<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br />
398</dt>
399<dd>
400The current terminal. This variable stores the current <code>urxvt::term</code>
401object, whenever a callback/hook is executing.
402</dd>
403<p></p></dl>
404<p>
405</p>
243<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 406<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
244<dl> 407<dl>
408<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
409</dt>
410<dd>
411Creates a new terminal, very similar as if you had started it with
412<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
413if the new instance couldn't be created. Returns <code>undef</code> if the new
414instance didn't initialise perl, and the terminal object otherwise. The
415<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
416</dd>
417<p></p>
245<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 418<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
246</dt> 419</dt>
247<dd> 420<dd>
248Fatally aborts execution with the given error message. Avoid at all 421Fatally aborts execution with the given error message. Avoid at all
249costs! The only time this is acceptable is when the terminal process 422costs! The only time this is acceptable is when the terminal process
… …
264<p></p> 437<p></p>
265<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 438<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
266</dt> 439</dt>
267<dd> 440<dd>
268Returns the ``current time'' (as per the event loop). 441Returns the ``current time'' (as per the event loop).
442</dd>
443<p></p>
444<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
445</dt>
446<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
447Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
448Button4Mask, Button5Mask, AnyModifier</a></strong><br />
449</dt>
450<dd>
451Various constants for use in X calls and event processing.
269</dd> 452</dd>
270<p></p></dl> 453<p></p></dl>
271<p> 454<p>
272</p> 455</p>
273<h2><a name="rendition">RENDITION</a></h2> 456<h2><a name="rendition">RENDITION</a></h2>
… …
330Change the custom value. 513Change the custom value.
331</dd> 514</dd>
332<p></p></dl> 515<p></p></dl>
333<p> 516<p>
334</p> 517</p>
518<h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2>
519<p>The sole purpose of this class is to deliver an interface to the
520<code>AnyEvent</code> module - any module using it will work inside urxvt without
521further work. The only exception is that you cannot wait on condition
522variables, but non-blocking condvar use is ok. What this means is that you
523cannot use blocking APIs, but the non-blocking variant should work.</p>
524<p>
525</p>
335<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 526<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
336<dl> 527<dl>
528<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
529</dt>
530<dd>
531Destroy the terminal object (close the window, free resources etc.).
532</dd>
533<p></p>
534<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
535</dt>
536<dd>
537Returns true if the option specified by <code>$optval</code> is enabled, and
538optionally change it. All option values are stored by name in the hash
539<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.
540</dd>
541<dd>
542<p>Here is a a likely non-exhaustive list of option names, please see the
543source file <em>/src/optinc.h</em> to see the actual list:</p>
544</dd>
545<dd>
546<pre>
547 borderLess console cursorBlink cursorUnderline hold iconic insecure
548 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
549 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
550 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
551 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
552 tripleclickwords utmpInhibit visualBell</pre>
553</dd>
554<p></p>
337<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 555<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
338</dt> 556</dt>
339<dd> 557<dd>
340Returns the current resource value associated with a given name and 558Returns the current resource value associated with a given name and
341optionally sets a new value. Setting values is most useful in the <code>init</code> 559optionally sets a new value. Setting values is most useful in the <code>init</code>
… …
355<p>Please note that resource strings will currently only be freed when the 573<p>Please note that resource strings will currently only be freed when the
356terminal is destroyed, so changing options frequently will eat memory.</p> 574terminal is destroyed, so changing options frequently will eat memory.</p>
357</dd> 575</dd>
358<dd> 576<dd>
359<p>Here is a a likely non-exhaustive list of resource names, not all of which 577<p>Here is a a likely non-exhaustive list of resource names, not all of which
360are supported in every build, please see the source to see the actual 578are supported in every build, please see the source file <em>/src/rsinc.h</em>
361list:</p> 579to see the actual list:</p>
362</dd> 580</dd>
363<dd> 581<dd>
364<pre> 582<pre>
365 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 583 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
366 borderLess color cursorBlink cursorUnderline cutchars delete_key 584 borderLess color cursorBlink cursorUnderline cutchars delete_key
367 display_name embed ext_bwidth fade font geometry hold iconName 585 display_name embed ext_bwidth fade font geometry hold iconName
368 imFont imLocale inputMethod insecure int_bwidth intensityStyles 586 imFont imLocale inputMethod insecure int_bwidth intensityStyles
369 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 587 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
370 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext 588 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
371 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 589 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
372 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 590 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
373 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 591 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
374 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 592 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
375 shade term_name title transparent transparent_all tripleclickwords 593 shade term_name title transparent transparent_all tripleclickwords
376 utmpInhibit visualBell</pre> 594 utmpInhibit visualBell</pre>
377</dd> 595</dd>
378<p></p> 596<p></p>
597<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
598</dt>
599<dd>
600Return and optionally change the current rendition. Text that is output by
601the terminal application will use this style.
602</dd>
603<p></p>
604<dt><strong><a name="item_screen_cur">($row, $col) = $term-&gt;screen_cur ([$row, $col])</a></strong><br />
605</dt>
606<dd>
607Return the current coordinates of the text cursor position and optionally
608set it (which is usually bad as applications don't expect that).
609</dd>
610<p></p>
379<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br /> 611<dt><strong><a name="item_selection_mark">($row, $col) = $term-&gt;selection_mark ([$row, $col])</a></strong><br />
380</dt> 612</dt>
381<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br /> 613<dt><strong><a name="item_selection_beg">($row, $col) = $term-&gt;selection_beg ([$row, $col])</a></strong><br />
382</dt> 614</dt>
383<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br /> 615<dt><strong><a name="item_selection_end">($row, $col) = $term-&gt;selection_end ([$row, $col])</a></strong><br />
… …
402<dd> 634<dd>
403<p>#=item $term-&gt;overlay ($x, $y, $text) 635<p>#=item $term-&gt;overlay ($x, $y, $text)
404# 636#
405#Create a simple multi-line overlay box. See the next method for details. 637#Create a simple multi-line overlay box. See the next method for details.
406# 638#
407#=cut</p> 639#=cut
408</dd> 640#
409<dd>
410<p>sub urxvt::term::scr_overlay { 641#sub urxvt::term::scr_overlay {
411die;
412 my ($self, $x, $y, $text) = @_;</p> 642# my ($self, $x, $y, $text) = @_;
413</dd> 643#
414<dd>
415<pre>
416 my @lines = split /\n/, $text;</pre> 644# my @lines = split /\n/, $text;
417</dd> 645#
418<dd>
419<pre>
420 my $w = 0; 646# my $w = 0;
421 for (map $self-&gt;strwidth ($_), @lines) { 647# for (map $self-&gt;strwidth ($_), @lines) {
422 $w = $_ if $w &lt; $_; 648# $w = $_ if $w &lt; $_;
423 }</pre> 649# }
424</dd> 650#
425<dd>
426<pre>
427 $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines); 651# $self-&gt;scr_overlay_new ($x, $y, $w, scalar @lines);
428 $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 652# $self-&gt;scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
429}</pre> 653#}</p>
430</dd> 654</dd>
431<p></p> 655<p></p>
432<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> 656<dt><strong><a name="item_overlay">$term-&gt;overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br />
433</dt> 657</dt>
434<dd> 658<dd>
… …
447<dd> 671<dd>
448<p>This method returns an urxvt::overlay object. The overlay will be visible 672<p>This method returns an urxvt::overlay object. The overlay will be visible
449as long as the perl object is referenced.</p> 673as long as the perl object is referenced.</p>
450</dd> 674</dd>
451<dd> 675<dd>
452<p>Currently, the only method on the <code>urxvt::overlay</code> object is <a href="#item_set"><code>set</code></a>:</p> 676<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
453</dd> 677</dd>
454<p></p> 678<dl>
455<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br /> 679<dt><strong><a name="item_set">$overlay-&gt;set ($x, $y, $text, $rend)</a></strong><br />
456</dt> 680</dt>
457<dd> 681<dd>
458Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts 682Similar to <a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> and <a href="#item_row_r"><code>$term-&gt;ROW_r</code></a> in that it puts
459text in rxvt-unicode's special encoding and an array of rendition values 683text in rxvt-unicode's special encoding and an array of rendition values
460at a specific position inside the overlay. 684at a specific position inside the overlay.
461</dd> 685</dd>
462<p></p> 686<p></p>
687<dt><strong><a name="item_hide">$overlay-&gt;hide</a></strong><br />
688</dt>
689<dd>
690If visible, hide the overlay, but do not destroy it.
691</dd>
692<p></p>
693<dt><strong><a name="item_show">$overlay-&gt;show</a></strong><br />
694</dt>
695<dd>
696If hidden, display the overlay again.
697</dd>
698<p></p></dl>
699<dt><strong>$popup = $term-&gt;popup ($event)</strong><br />
700</dt>
701<dd>
702Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
703<code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event,
704currently).
705</dd>
706<p></p>
463<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth $string</a></strong><br /> 707<dt><strong><a name="item_strwidth">$cellwidth = $term-&gt;strwidth ($string)</a></strong><br />
464</dt> 708</dt>
465<dd> 709<dd>
466Returns the number of screen-cells this string would need. Correctly 710Returns the number of screen-cells this string would need. Correctly
467accounts for wide and combining characters. 711accounts for wide and combining characters.
468</dd> 712</dd>
469<p></p> 713<p></p>
470<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode $string</a></strong><br /> 714<dt><strong><a name="item_locale_encode">$octets = $term-&gt;locale_encode ($string)</a></strong><br />
471</dt> 715</dt>
472<dd> 716<dd>
473Convert the given text string into the corresponding locale encoding. 717Convert the given text string into the corresponding locale encoding.
474</dd> 718</dd>
475<p></p> 719<p></p>
476<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode $octets</a></strong><br /> 720<dt><strong><a name="item_locale_decode">$string = $term-&gt;locale_decode ($octets)</a></strong><br />
477</dt> 721</dt>
478<dd> 722<dd>
479Convert the given locale-encoded octets into a perl string. 723Convert the given locale-encoded octets into a perl string.
724</dd>
725<p></p>
726<dt><strong><a name="item_scr_add_lines">$term-&gt;scr_add_lines ($string)</a></strong><br />
727</dt>
728<dd>
729Write the given text string to the screen, as if output by the application
730running inside the terminal. It may not contain command sequences (escape
731codes), but is free to use line feeds, carriage returns and tabs. The
732string is a normal text string, not in locale-dependent encoding.
733</dd>
734<dd>
735<p>Normally its not a good idea to use this function, as programs might be
736confused by changes in cursor position or scrolling. Its useful inside a
737<code>on_add_lines</code> hook, though.</p>
738</dd>
739<p></p>
740<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
741</dt>
742<dd>
743Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
744locale-specific encoding of the terminal and can contain command sequences
745(escape codes) that will be interpreted.
480</dd> 746</dd>
481<p></p> 747<p></p>
482<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br /> 748<dt><strong><a name="item_tt_write">$term-&gt;tt_write ($octets)</a></strong><br />
483</dt> 749</dt>
484<dd> 750<dd>
485Write the octets given in <code>$data</code> to the tty (i.e. as program input). To 751Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
486pass characters instead of octets, you should convert your strings first 752pass characters instead of octets, you should convert your strings first
487to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>. 753to the locale-specific encoding using <a href="#item_locale_encode"><code>$term-&gt;locale_encode</code></a>.
488</dd> 754</dd>
489<p></p> 755<p></p>
756<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
757</dt>
758<dd>
759Return the window id of the toplevel window.
760</dd>
761<p></p>
762<dt><strong><a name="item_vt">$windowid = $term-&gt;vt</a></strong><br />
763</dt>
764<dd>
765Return the window id of the terminal window.
766</dd>
767<p></p>
768<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
769</dt>
770<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
771</dt>
772<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
773</dt>
774<dt><strong><a name="item_fheight">$font_height = $term-&gt;fheight</a></strong><br />
775</dt>
776<dt><strong><a name="item_fbase">$font_ascent = $term-&gt;fbase</a></strong><br />
777</dt>
490<dt><strong><a name="item_nrow">$nrow = $term-&gt;nrow</a></strong><br /> 778<dt><strong><a name="item_nrow">$terminal_rows = $term-&gt;nrow</a></strong><br />
491</dt> 779</dt>
492<dt><strong><a name="item_ncol">$ncol = $term-&gt;ncol</a></strong><br /> 780<dt><strong><a name="item_ncol">$terminal_columns = $term-&gt;ncol</a></strong><br />
493</dt>
494<dd>
495Return the number of rows/columns of the terminal window (i.e. as
496specified by <code>-geometry</code>, excluding any scrollback).
497</dd> 781</dt>
498<p></p> 782<dt><strong><a name="item_focus">$has_focus = $term-&gt;focus</a></strong><br />
783</dt>
784<dt><strong><a name="item_mapped">$is_mapped = $term-&gt;mapped</a></strong><br />
785</dt>
786<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
787</dt>
788<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
789</dt>
499<dt><strong><a name="item_nsaved">$nsaved = $term-&gt;nsaved</a></strong><br /> 790<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br />
500</dt> 791</dt>
792<dd>
793Return various integers describing terminal characteristics.
501<dd> 794</dd>
502Returns the number of lines in the scrollback buffer. 795<p></p>
796<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
797</dt>
798<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
799</dt>
800<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
801</dt>
802<dd>
803Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
804AltGr), the meta key (often Alt) and the num lock key, if applicable.
503</dd> 805</dd>
504<p></p> 806<p></p>
505<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 807<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
506</dt> 808</dt>
507<dd> 809<dd>
… …
525</dt> 827</dt>
526<dd> 828<dd>
527Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 829Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
528is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 830is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
529terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 831terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
530line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. 832line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line
833is requested.
531</dd> 834</dd>
532<dd> 835<dd>
533<p>If <code>$new_text</code> is specified, it will replace characters in the current 836<p>If <code>$new_text</code> is specified, it will replace characters in the current
534line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 837line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
535to replace only parts of a line. The font index in the rendition will 838to replace only parts of a line. The font index in the rendition will
536automatically be updated.</p> 839automatically be updated.</p>
537</dd> 840</dd>
538<dd> 841<dd>
539<p><code>$text</code> is in a special encoding: tabs and wide characters that use more 842<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
540than one cell when displayed are padded with urxvt::NOCHAR characters 843than one cell when displayed are padded with urxvt::NOCHAR characters
541(<code>chr 65535</code>). Characters with combining characters and other characters 844(<code>chr 65535</code>). Characters with combining characters and other characters
542that do not fit into the normal tetx encoding will be replaced with 845that do not fit into the normal tetx encoding will be replaced with
543characters in the private use area.</p> 846characters in the private use area.</p>
544</dd> 847</dd>
… …
567</dd> 870</dd>
568<p></p> 871<p></p>
569<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br /> 872<dt><strong><a name="item_row_l">$length = $term-&gt;ROW_l ($row_number[, $new_length])</a></strong><br />
570</dt> 873</dt>
571<dd> 874<dd>
572Returns the number of screen cells that are in use (``the line length''). If 875Returns the number of screen cells that are in use (``the line
573it is <code>-1</code>, then the line is part of a multiple-row logical ``line'', which 876length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term-&gt;ncol</code></a> if the
574means all characters are in use and it is continued on the next row. 877line is joined with the following one.
878</dd>
879<p></p>
880<dt><strong><a name="item_is_longer">$bool = $term-&gt;is_longer ($row_number)</a></strong><br />
881</dt>
575</dd> 882<dd>
883Returns true if the row is part of a multiple-row logical ``line'' (i.e.
884joined with the following row), which means all characters are in use
885and it is continued on the next row (and possibly a continuation of the
886previous row(s)).
887</dd>
576<p></p> 888<p></p>
889<dt><strong><a name="item_line">$line = $term-&gt;line ($row_number)</a></strong><br />
890</dt>
891<dd>
892Create and return a new <code>urxvt::line</code> object that stores information
893about the logical line that row <code>$row_number</code> is part of. It supports the
894following methods:
895</dd>
896<dl>
897<dt><strong><a name="item_t">$text = $line-&gt;t ([$new_text])</a></strong><br />
898</dt>
899<dd>
900Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a>
901</dd>
902<p></p>
903<dt><strong><a name="item_r">$rend = $line-&gt;r ([$new_rend])</a></strong><br />
904</dt>
905<dd>
906Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a>
907</dd>
908<p></p>
909<dt><strong><a name="item_l">$length = $line-&gt;l</a></strong><br />
910</dt>
911<dd>
912Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.
913</dd>
914<p></p>
915<dt><strong><a name="item_beg">$rownum = $line-&gt;beg</a></strong><br />
916</dt>
917<dt><strong><a name="item_end">$rownum = $line-&gt;end</a></strong><br />
918</dt>
919<dd>
920Return the row number of the first/last row of the line, respectively.
921</dd>
922<p></p>
923<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
924</dt>
925<dd>
926Returns the character offset of the given row|col pair within the logical
927line.
928</dd>
929<p></p>
930<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
931</dt>
932<dd>
933Translates a string offset into terminal coordinates again.
934</dd>
935<p></p></dl>
577<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br /> 936<dt><strong><a name="item_special_encode">$text = $term-&gt;special_encode $string</a></strong><br />
578</dt> 937</dt>
579<dd> 938<dd>
580Converts a perl string into the special encoding used by rxvt-unicode, 939Converts a perl string into the special encoding used by rxvt-unicode,
581where one character corresponds to one screen cell. See 940where one character corresponds to one screen cell. See
… …
586</dt> 945</dt>
587<dd> 946<dd>
588Converts rxvt-unicodes text reprsentation into a perl string. See 947Converts rxvt-unicodes text reprsentation into a perl string. See
589<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 948<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
590</dd> 949</dd>
950<p></p>
951<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br />
952</dt>
953<dd>
954Registers a synchronous button grab. See XGrabButton.
955</dd>
956<p></p>
957<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
958</dt>
959<dd>
960Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
961synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.
962</dd>
963<p></p>
964<dt><strong><a name="item_allow_events_async">$term-&gt;allow_events_async</a></strong><br />
965</dt>
966<dd>
967Calls XAllowEvents with AsyncBoth for the most recent grab.
968</dd>
969<p></p>
970<dt><strong><a name="item_allow_events_sync">$term-&gt;allow_events_sync</a></strong><br />
971</dt>
972<dd>
973Calls XAllowEvents with SyncBoth for the most recent grab.
974</dd>
975<p></p>
976<dt><strong><a name="item_allow_events_replay">$term-&gt;allow_events_replay</a></strong><br />
977</dt>
978<dd>
979Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
980recent grab.
981</dd>
982<p></p>
983<dt><strong><a name="item_ungrab">$term-&gt;ungrab</a></strong><br />
984</dt>
985<dd>
986Calls XUngrab for the most recent grab. Is called automatically on
987evaluation errors, as it is better to lose the grab in the error case as
988the session.
989</dd>
591<p></p></dl> 990<p></p></dl>
991<p>
992</p>
993<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
592<p> 994<p>
593</p> 995</p>
594<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> 996<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2>
595<p>This class implements timer watchers/events. Time is represented as a 997<p>This class implements timer watchers/events. Time is represented as a
596fractional number of seconds since the epoch. Example:</p> 998fractional number of seconds since the epoch. Example:</p>
… …
718<p> 1120<p>
719</p> 1121</p>
720<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> 1122<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2>
721<p>This variable controls the verbosity level of the perl extension. Higher 1123<p>This variable controls the verbosity level of the perl extension. Higher
722numbers indicate more verbose output.</p> 1124numbers indicate more verbose output.</p>
723<ol> 1125<dl>
724<li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> 1126<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
725</li> 1127</dt>
726<li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> 1128<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
727</li> 1129</dt>
728<li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> 1130<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br />
1131</dt>
729</li> 1132</dl>
730</ol>
731<p> 1133<p>
732</p> 1134</p>
733<hr /> 1135<hr />
734<h1><a name="author">AUTHOR</a></h1> 1136<h1><a name="author">AUTHOR</a></h1>
735<pre> 1137<pre>

Diff Legend

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