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.29 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.33 by root, Thu Jan 19 19:26:31 2006 UTC

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>urxvtperl - rxvt-unicode's embedded perl interpreter</title> 4<title>rxvtperl - 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>urxvtperl - rxvt-unicode's embedded perl interpreter</p> 50<p>rxvtperl - 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 &quot;you selected &quot;, $_[0]-&gt;selection; 59 warn &quot;you selected &quot;, $_[0]-&gt;selection;
60 () 60 ()
61 }</pre> 61 }</pre>
62<pre> 62<pre>
63 # start a urxvt using it:</pre> 63 # start a rxvt using it:</pre>
64<pre> 64<pre>
65 urxvt --perl-lib $HOME -pe grab_test</pre> 65 rxvt --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
71the <code>perl</code> resource are loaded and associated with it.</p> 71the <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
73thus must be encoded as UTF-8.</p> 73thus must be encoded as UTF-8.</p>
74<p>Each script will only ever be loaded once, even in urxvtd, where 74<p>Each script will only ever be loaded once, even in rxvtd, where
75scripts will be shared (but not enabled) for all terminals.</p> 75scripts 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
81find them in <em>/usr/local/lib/urxvt/perl/</em>.</p> 81find them in <em>/opt/rxvt/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 urxvt -pe &lt;extensionname&gt;</pre> 84 rxvt -pe &lt;extensionname&gt;</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
… …
120<dd> 120<dd>
121<p>You can look at the source of the selection extension to see more 121<p>You can look at the source of the selection extension to see more
122interesting uses, such as parsing a line from beginning to end.</p> 122interesting uses, such as parsing a line from beginning to end.</p>
123</dd> 123</dd>
124<dd> 124<dd>
125<p>This extension also offers the following bindable keyboard command:</p> 125<p>This extension also offers following bindable keyboard commands:</p>
126</dd> 126</dd>
127<dl> 127<dl>
128<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
129</dt> 129</dt>
130<dd> 130<dd>
… …
146</dt> 146</dt>
147<dd> 147<dd>
148Binds a popup menu to Ctrl-Button3 that lets you convert the selection 148Binds a popup menu to Ctrl-Button3 that lets you convert the selection
149text into various other formats/action (such as uri unescaping, perl 149text into various other formats/action (such as uri unescaping, perl
150evalution, web-browser starting etc.), depending on content. 150evalution, web-browser starting etc.), depending on content.
151</dd>
152<dd>
153<p>Other extensions can extend this popup menu by pushing a code reference
154onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
155popup is displayed.</p>
156</dd>
157<dd>
158<p>It's sole argument is the popup menu, which can be modified. The selection
159is in <code>$_</code>, which can be used to decide wether to add something or not.
160It should either return nothing or a string and a code reference. The
161string will be used as button text and the code reference will be called
162when the button gets activated and should transform <code>$_</code>.</p>
163</dd>
164<dd>
165<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
166the selection to <code>b</code>s, but only if the selection currently contains any
167<code>a</code>s:</p>
168</dd>
169<dd>
170<pre>
171 push @{ $self-&gt;{term}{selection_popup_hook} }, sub {
172 /a/ ? (&quot;a to be&quot; =&gt; sub { s/a/b/g }
173 : ()
174 };</pre>
151</dd> 175</dd>
152<p></p> 176<p></p>
153<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br /> 177<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
154</dt> 178</dt>
155<dd> 179<dd>
… …
197<p>And this example matches the same,but replaces it with vi-commands you can 221<p>And this example matches the same,but replaces it with vi-commands you can
198paste directly into your (vi :) editor:</p> 222paste directly into your (vi :) editor:</p>
199</dd> 223</dd>
200<dd> 224<dd>
201<pre> 225<pre>
202 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> 226 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
203</dd> 227</dd>
204<dd> 228<dd>
205<p>Of course, this can be modified to suit your needs and your editor :)</p> 229<p>Of course, this can be modified to suit your needs and your editor :)</p>
206</dd> 230</dd>
207<dd> 231<dd>
208<p>To expand the example above to typical perl error messages (``XXX at 232<p>To expand the example above to typical perl error messages (``XXX at
209FILENAME line YYY.''), you need a slightly more elaborate solution:</p> 233FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
210</dd> 234</dd>
211<dd> 235<dd>
212<pre> 236<pre>
213 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 237 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
214 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> 238 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre>
215</dd> 239</dd>
216<dd> 240<dd>
217<p>The first line tells the selection code to treat the unchanging part of 241<p>The first line tells the selection code to treat the unchanging part of
218every error message as a selection pattern, and the second line transforms 242every error message as a selection pattern, and the second line transforms
219the message into vi commands to load the file.</p> 243the message into vi commands to load the file.</p>
… …
226make them clickable. When middle-clicked, the program specified in the 250make them clickable. When middle-clicked, the program specified in the
227resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 251resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
228the URL as first argument. 252the URL as first argument.
229</dd> 253</dd>
230<p></p> 254<p></p>
255<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
256</dt>
257<dd>
258This is basically a one-line extension that dynamically changes the background pixmap offset
259to the window position, in effect creating the same effect as pseudo transparency with
260a custom pixmap. No scaling is supported in this mode. Exmaple:
261</dd>
262<dd>
263<pre>
264 rxvt -pixmap background.xpm -pe automove-background</pre>
265</dd>
266<p></p>
231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 267<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
232</dt> 268</dt>
233<dd> 269<dd>
234A not very useful example of filtering all text output to the terminal, 270A not very useful example of filtering all text output to the terminal,
235by replacing all line-drawing characters (U+2500 .. U+259F) by a 271by replacing all line-drawing characters (U+2500 .. U+259F) by a
… …
246</dt> 282</dt>
247<dd> 283<dd>
248Displays a very simple digital clock in the upper right corner of the 284Displays a very simple digital clock in the upper right corner of the
249window. Illustrates overwriting the refresh callbacks to create your own 285window. Illustrates overwriting the refresh callbacks to create your own
250overlays or changes. 286overlays or changes.
287</dd>
288<p></p>
289<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
290</dt>
291<dd>
292This is a little rarely useful extension that Uploads the selection as
293textfile to a remote site (or does other things). (The implementation is
294not currently secure for use in a multiuser environment as it writes to
295<em>/tmp</em> directly.).
296</dd>
297<dd>
298<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
299i.e.</p>
300</dd>
301<dd>
302<pre>
303 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre>
304</dd>
305<dd>
306<p>Pressing this combination runs a command with <code>%</code> replaced by the name of
307the textfile. This command can be set via a resource:</p>
308</dd>
309<dd>
310<pre>
311 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
312</dd>
313<dd>
314<p>And the default is likely not useful to anybody but the few people around
315here :)</p>
316</dd>
317<dd>
318<p>The name of the textfile is the hex encoded md5 sum of the selection, so
319the same content should lead to the same filename.</p>
320</dd>
321<dd>
322<p>After a successful upload the selection will be replaced by the text given
323in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
324for the filename):</p>
325</dd>
326<dd>
327<pre>
328 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
251</dd> 329</dd>
252<p></p></dl> 330<p></p></dl>
253<p> 331<p>
254</p> 332</p>
255<hr /> 333<hr />
… …
360<dd> 438<dd>
361Called at the very end of initialisation of a new terminal, just before 439Called at the very end of initialisation of a new terminal, just before
362returning to the mainloop. 440returning to the mainloop.
363</dd> 441</dd>
364<p></p> 442<p></p>
443<dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br />
444</dt>
445<dd>
446Called just after the child process has been <code>fork</code>ed.
447</dd>
448<p></p>
449<dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br />
450</dt>
451<dd>
452Called just after the child process has exited. <code>$status</code> is the status
453from <code>waitpid</code>.
454</dd>
455<p></p>
365<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> 456<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br />
366</dt> 457</dt>
367<dd> 458<dd>
368Called whenever a selection has been made by the user, but before the 459Called whenever a selection has been made by the user, but before the
369selection text is copied, so changes to the beginning, end or type of the 460selection text is copied, so changes to the beginning, end or type of the
… …
489<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 580<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br />
490</dt> 581</dt>
491<dd> 582<dd>
492Called whenever the user presses a key combination that has a 583Called 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> 584<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
494resource in the <code>urxvt(1)</code> manpage). 585resource in the <code>rxvt(1)</code> manpage).
495</dd> 586</dd>
496<p></p> 587<p></p>
497<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 588<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
498</dt> 589</dt>
499<dd> 590<dd>
… …
514<dd> 605<dd>
515Called wheneever the window loses keyboard focus, before rxvt-unicode does 606Called wheneever the window loses keyboard focus, before rxvt-unicode does
516focus out processing. 607focus out processing.
517</dd> 608</dd>
518<p></p> 609<p></p>
610<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
611</dt>
519<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 612<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
520</dt> 613</dt>
521<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 614<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
522</dt> 615</dt>
523<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 616<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
… …
600<p>Using this function has the advantage that its output ends up in the 693<p>Using this function has the advantage that its output ends up in the
601correct place, e.g. on stderr of the connecting urxvtc client.</p> 694correct place, e.g. on stderr of the connecting urxvtc client.</p>
602</dd> 695</dd>
603<dd> 696<dd>
604<p>Messages have a size limit of 1023 bytes currently.</p> 697<p>Messages have a size limit of 1023 bytes currently.</p>
605</dd>
606<p></p>
607<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
608</dt>
609<dd>
610Returns true when it is safe to do potentially unsafe things, such as
611evaluating perl code specified by the user. This is true when urxvt was
612started setuid or setgid.
613</dd> 698</dd>
614<p></p> 699<p></p>
615<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 700<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
616</dt> 701</dt>
617<dd> 702<dd>
… …
735<p></p> 820<p></p>
736<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 821<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
737</dt> 822</dt>
738<dd> 823<dd>
739Destroy the terminal object (close the window, free resources 824Destroy the terminal object (close the window, free resources
740etc.). Please note that urxvt will not exit as long as any event 825etc.). Please note that rxvt will not exit as long as any event
741watchers (timers, io watchers) are still active. 826watchers (timers, io watchers) are still active.
827</dd>
828<p></p>
829<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
830</dt>
831<dd>
832Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
833(``starts'') programs in the background. This function takes care of setting
834the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
835be preferred over explicit calls to <code>exec</code> or <code>system</code>.
836</dd>
837<dd>
838<p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
742</dd> 839</dd>
743<p></p> 840<p></p>
744<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 841<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
745</dt> 842</dt>
746<dd> 843<dd>
… …
754</dd> 851</dd>
755<dd> 852<dd>
756<pre> 853<pre>
757 borderLess console cursorBlink cursorUnderline hold iconic insecure 854 borderLess console cursorBlink cursorUnderline hold iconic insecure
758 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 855 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
759 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 856 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
760 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 857 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
761 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 858 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
762 tripleclickwords utmpInhibit visualBell</pre> 859 transparent tripleclickwords utmpInhibit visualBell</pre>
763</dd> 860</dd>
764<p></p> 861<p></p>
765<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 862<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
766</dt> 863</dt>
767<dd> 864<dd>
… …
792<pre> 889<pre>
793 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 890 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
794 borderLess color cursorBlink cursorUnderline cutchars delete_key 891 borderLess color cursorBlink cursorUnderline cutchars delete_key
795 display_name embed ext_bwidth fade font geometry hold iconName 892 display_name embed ext_bwidth fade font geometry hold iconName
796 imFont imLocale inputMethod insecure int_bwidth intensityStyles 893 imFont imLocale inputMethod insecure int_bwidth intensityStyles
797 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 894 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
798 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 895 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
799 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 896 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
800 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 897 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
801 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 898 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
802 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 899 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
803 shade term_name title transparent transparent_all tripleclickwords 900 secondaryScreen secondaryScroll selectstyle shade term_name title
901 transient_for transparent transparent_all tripleclickwords utmpInhibit
804 utmpInhibit visualBell</pre> 902 visualBell</pre>
805</dd> 903</dd>
806<p></p> 904<p></p>
807<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br /> 905<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
808</dt> 906</dt>
809<dd> 907<dd>
… …
820<p></p> 918<p></p>
821<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 919<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
822</dt> 920</dt>
823<dd> 921<dd>
824Adds a keymap translation exactly as specified via a resource. See the 922Adds a keymap translation exactly as specified via a resource. See the
825<code>keysym</code> resource in the <code>urxvt(1)</code> manpage. 923<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
826</dd> 924</dd>
827<p></p> 925<p></p>
828<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br /> 926<dt><strong><a name="item_rstyle">$rend = $term-&gt;rstyle ([$new_rstyle])</a></strong><br />
829</dt> 927</dt>
830<dd> 928<dd>
… …
1054</dt> 1152</dt>
1055<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1153<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
1056</dt> 1154</dt>
1057<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1155<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
1058</dt> 1156</dt>
1059<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1157<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
1060</dt> 1158</dt>
1061<dd> 1159<dd>
1062Return various integers describing terminal characteristics. 1160Return various integers describing terminal characteristics.
1063</dd> 1161</dd>
1064<p></p> 1162<p></p>
… …
1093</dd> 1191</dd>
1094<p></p> 1192<p></p>
1095<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1193<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1096</dt> 1194</dt>
1097<dd> 1195<dd>
1098Returns the negative row number of the topmost line. Minimum value is 1196Returns the row number of the topmost displayed line. Maximum value is
1099<code>0</code>, which displays the normal terminal contents. Larger values scroll 1197<code>0</code>, which displays the normal terminal contents. Lower values scroll
1100this many lines into the scrollback buffer. 1198this many lines into the scrollback buffer.
1101</dd> 1199</dd>
1102<p></p> 1200<p></p>
1103<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1201<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
1104</dt> 1202</dt>
… …
1115</dt> 1213</dt>
1116<dd> 1214<dd>
1117Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1215Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1118is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1216is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1119terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1217terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1120line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1218line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1121is requested. 1219is requested.
1122</dd> 1220</dd>
1123<dd> 1221<dd>
1124<p>If <code>$new_text</code> is specified, it will replace characters in the current 1222<p>If <code>$new_text</code> is specified, it will replace characters in the current
1125line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1223line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
… …
1370<p></p> 1468<p></p>
1371<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1469<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1372</dt> 1470</dt>
1373<dd> 1471<dd>
1374Set the event trigger time to <code>$tstamp</code> and start the timer. 1472Set the event trigger time to <code>$tstamp</code> and start the timer.
1473</dd>
1474<p></p>
1475<dt><strong><a name="item_after">$timer = $timer-&gt;after ($delay)</a></strong><br />
1476</dt>
1477<dd>
1478Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1375</dd> 1479</dd>
1376<p></p> 1480<p></p>
1377<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1481<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1378</dt> 1482</dt>
1379<dd> 1483<dd>

Diff Legend

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