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.23 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.31 by root, Tue Jan 17 16:22:41 2006 UTC

… …
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
90when the user extends selections (double-click). Right now, it tries to 90when the user extends selections (double-click and further clicks). Right
91select urls and complete shell-quoted arguments, which is very convenient, 91now, it tries to select words, urls and complete shell-quoted
92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92arguments, which is very convenient, too, if your <em>ls</em> supports
93</dd> 93<code>--quoting-style=shell</code>.
94<dd> 94</dd>
95<dd>
96<p>A double-click usually selects the word under the cursor, further clicks
97will enlarge the selection.</p>
98</dd>
99<dd>
100<p>The selection works by trying to match a number of regexes and displaying
101them in increasing order of length. You can add your own regexes by
102specifying resources of the form:</p>
103</dd>
104<dd>
105<pre>
106 URxvt.selection.pattern-0: perl-regex
107 URxvt.selection.pattern-1: perl-regex
108 ...</pre>
109</dd>
110<dd>
111<p>The index number (0, 1...) must not have any holes, and each regex must
112contain at least one pair of capturing parentheses, which will be used for
113the match. For example, the followign adds a regex that matches everything
114between two vertical bars:</p>
115</dd>
116<dd>
117<pre>
118 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
119</dd>
120<dd>
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>
123</dd>
124<dd>
95<p>It also offers the following bindable keyboard command:</p> 125<p>This extension also offers following bindable keyboard commands:</p>
96</dd> 126</dd>
97<dl> 127<dl>
98<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
99</dt> 129</dt>
100<dd> 130<dd>
101Rot-13 the selection when activated. Used via keyboard trigger: 131Rot-13 the selection when activated. Used via keyboard trigger:
102</dd> 132</dd>
103<dd> 133<dd>
104<pre> 134<pre>
105 URxvt.keysym.C-M-r: perl:selection:rot13</pre> 135 URxvt.keysym.C-M-r: perl:selection:rot13</pre>
136</dd>
137<p></p>
138<dt><strong><a name="item_remote_2dpastebin">remote-pastebin</a></strong><br />
139</dt>
140<dd>
141Upload the selection as textfile to a remote site.
142</dd>
143<dd>
144<pre>
145 URxvt.keysym.C-M-e: perl:selection:remote-pastebin</pre>
146</dd>
147<dd>
148<p>To set the command to upload the file set this resource:</p>
149</dd>
150<dd>
151<pre>
152 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre>
153</dd>
154<dd>
155<p>The % is the placeholder for the textfile. The name of the textfile is the hex encoded
156md5 sum of the selection.
157After an successful upload the selection will be replaced by the following url
158(the % is the placeholder for the filename):</p>
159</dd>
160<dd>
161<pre>
162 URxvt.selection-pastebin-url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
106</dd> 163</dd>
107<p></p></dl> 164<p></p></dl>
108<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> 165<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
109</dt> 166</dt>
110<dd> 167<dd>
… …
122<p></p> 179<p></p>
123<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br /> 180<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
124</dt> 181</dt>
125<dd> 182<dd>
126Adds regex search functionality to the scrollback buffer, triggered 183Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal 184by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
128input/output is suspended. 185input/output is suspended and a regex is displayed at the bottom of the
129</dd> 186screen.
130<dd> 187</dd>
131<p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or
132<code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the
133history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
134returns to the original position.</p>
135</dd> 188<dd>
136<p></p> 189<p>Inputting characters appends them to the regex and continues incremental
137<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 190search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
138</dt> 191search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
192bottom. <code>Escape</code> leaves search mode and returns to the point where search
193was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
194additionally stores the first match in the current line into the primary
195selection.</p>
139<dd> 196</dd>
140Displays a digital clock using the built-in overlay. 197<p></p>
198<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
199</dt>
200<dd>
201This selection allows you to do automatic transforms on a selection
202whenever a selection is made.
203</dd>
204<dd>
205<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
206operator) that modify <code>$_</code> as resources:</p>
207</dd>
208<dd>
209<pre>
210 URxvt.selection-autotransform.0: transform
211 URxvt.selection-autotransform.1: transform
212 ...</pre>
213</dd>
214<dd>
215<p>For example, the following will transform selections of the form
216<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
217$word</code>:</p>
218</dd>
219<dd>
220<pre>
221 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
222</dd>
223<dd>
224<p>And this example matches the same,but replaces it with vi-commands you can
225paste directly into your (vi :) editor:</p>
226</dd>
227<dd>
228<pre>
229 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
230</dd>
231<dd>
232<p>Of course, this can be modified to suit your needs and your editor :)</p>
233</dd>
234<dd>
235<p>To expand the example above to typical perl error messages (``XXX at
236FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
237</dd>
238<dd>
239<pre>
240 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
241 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre>
242</dd>
243<dd>
244<p>The first line tells the selection code to treat the unchanging part of
245every error message as a selection pattern, and the second line transforms
246the message into vi commands to load the file.</p>
141</dd> 247</dd>
142<p></p> 248<p></p>
143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 249<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
144</dt> 250</dt>
145<dd> 251<dd>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 252Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
253make them clickable. When middle-clicked, the program specified in the
254resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
255the URL as first argument.
147</dd> 256</dd>
148<p></p> 257<p></p>
149<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 258<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
150</dt> 259</dt>
151<dd> 260<dd>
152A not very useful example of filtering all text output to the terminal, 261A not very useful example of filtering all text output to the terminal,
153by replacing all line-drawing characters (U+2500 .. U+259F) by a 262by replacing all line-drawing characters (U+2500 .. U+259F) by a
154similar-looking ascii character. 263similar-looking ascii character.
264</dd>
265<p></p>
266<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
267</dt>
268<dd>
269Displays a digital clock using the built-in overlay.
155</dd> 270</dd>
156<p></p> 271<p></p>
157<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 272<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
158</dt> 273</dt>
159<dd> 274<dd>
… …
301</dt> 416</dt>
302<dd> 417<dd>
303Called whenever the user tries to extend the selection (e.g. with a double 418Called whenever the user tries to extend the selection (e.g. with a double
304click) and is either supposed to return false (normal operation), or 419click) and is either supposed to return false (normal operation), or
305should extend the selection itelf and return true to suppress the built-in 420should extend the selection itelf and return true to suppress the built-in
306processing. 421processing. This can happen multiple times, as long as the callback
422returns true, it will be called on every further click by the user and is
423supposed to enlarge the selection more and more, if possible.
307</dd> 424</dd>
308<dd> 425<dd>
309<p>See the <em>selection</em> example extension.</p> 426<p>See the <em>selection</em> example extension.</p>
310</dd> 427</dd>
311<p></p> 428<p></p>
… …
402Called whenever the user presses a key combination that has a 519Called whenever the user presses a key combination that has a
403<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 520<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
404resource in the <code>rxvt(1)</code> manpage). 521resource in the <code>rxvt(1)</code> manpage).
405</dd> 522</dd>
406<p></p> 523<p></p>
524<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
525</dt>
526<dd>
527Called on every X event received on the vt window (and possibly other
528windows). Should only be used as a last resort. Most event structure
529members are not passed.
530</dd>
531<p></p>
407<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 532<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
408</dt> 533</dt>
409<dd> 534<dd>
410Called whenever the window gets the keyboard focus, before rxvt-unicode 535Called whenever the window gets the keyboard focus, before rxvt-unicode
411does focus in processing. 536does focus in processing.
… …
504</dd> 629</dd>
505<dd> 630<dd>
506<p>Messages have a size limit of 1023 bytes currently.</p> 631<p>Messages have a size limit of 1023 bytes currently.</p>
507</dd> 632</dd>
508<p></p> 633<p></p>
509<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
510</dt>
511<dd>
512Returns true when it is safe to do potentially unsafe things, such as
513evaluating perl code specified by the user. This is true when urxvt was
514started setuid or setgid.
515</dd>
516<p></p>
517<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 634<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
518</dt> 635</dt>
519<dd> 636<dd>
520Returns the ``current time'' (as per the event loop). 637Returns the ``current time'' (as per the event loop).
521</dd> 638</dd>
… …
523<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 640<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
524</dt> 641</dt>
525<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 642<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
526Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 643Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
527Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 644Button4Mask, Button5Mask, AnyModifier</a></strong><br />
645</dt>
646<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
647ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
648PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
649Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
650KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
651ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
652FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
653</dt>
654<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
655EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
656GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
657UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
658ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
659CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
660SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
528</dt> 661</dt>
529<dd> 662<dd>
530Various constants for use in X calls and event processing. 663Various constants for use in X calls and event processing.
531</dd> 664</dd>
532<p></p></dl> 665<p></p></dl>
… …
688 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 821 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
689 shade term_name title transparent transparent_all tripleclickwords 822 shade term_name title transparent transparent_all tripleclickwords
690 utmpInhibit visualBell</pre> 823 utmpInhibit visualBell</pre>
691</dd> 824</dd>
692<p></p> 825<p></p>
826<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
827</dt>
828<dd>
829Returns the X-Resource for the given pattern, excluding the program or
830class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
831same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
832resource with that pattern exists.
833</dd>
834<dd>
835<p>This method should only be called during the <code>on_start</code> hook, as there is
836only one resource database per display, and later invocations might return
837the wrong resources.</p>
838</dd>
839<p></p>
693<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 840<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
694</dt> 841</dt>
695<dd> 842<dd>
696Adds a keymap translation exactly as specified via a resource. See the 843Adds a keymap translation exactly as specified via a resource. See the
697<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 844<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
… …
720<dd> 867<dd>
721Return the current values of the selection mark, begin or end positions, 868Return the current values of the selection mark, begin or end positions,
722and optionally set them to new values. 869and optionally set them to new values.
723</dd> 870</dd>
724<p></p> 871<p></p>
872<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
873</dt>
874<dd>
875Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
876<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
877rectangular selection will be made. This is the prefered function to make
878a selection.
879</dd>
880<p></p>
725<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 881<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
726</dt> 882</dt>
727<dd> 883<dd>
728Try to request the primary selection from the server (for example, as set 884Try to request the primary selection text from the server (for example, as
729by the next method). 885set by the next method). No visual feedback will be given. This function
886is mostly useful from within <code>on_sel_grab</code> hooks.
730</dd> 887</dd>
731<p></p> 888<p></p>
732<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 889<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
733</dt> 890</dt>
734<dd> 891<dd>
… …
813<p></p> 970<p></p>
814<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> 971<dt><strong><a name="item_scr_xor_span">$term-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
815</dt> 972</dt>
816<dd> 973<dd>
817XORs the rendition values in the given span with the provided value 974XORs the rendition values in the given span with the provided value
818(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar 975(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
819to the selection. 976refresh hooks to provide effects similar to the selection.
820</dd> 977</dd>
821<p></p> 978<p></p>
822<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br /> 979<dt><strong><a name="item_scr_xor_rect">$term-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
823</dt> 980</dt>
824<dd> 981<dd>
825Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 982Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
826whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 983whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
827to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines 984to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
828it instead. 985it instead. Both styles <em>MUST NOT</em> contain font styles.
829</dd> 986</dd>
830<p></p> 987<p></p>
831<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br /> 988<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
832</dt> 989</dt>
833<dd> 990<dd>
… …
883</dt> 1040</dt>
884<dd> 1041<dd>
885Return the window id of the terminal window. 1042Return the window id of the terminal window.
886</dd> 1043</dd>
887<p></p> 1044<p></p>
1045<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1046</dt>
1047<dd>
1048Adds the specified events to the vt event mask. Useful e.g. when you want
1049to receive pointer events all the times:
1050</dd>
1051<dd>
1052<pre>
1053 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1054</dd>
1055<p></p>
888<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1056<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
889</dt> 1057</dt>
890<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1058<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
891</dt> 1059</dt>
892<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1060<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
905</dt> 1073</dt>
906<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1074<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
907</dt> 1075</dt>
908<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1076<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
909</dt> 1077</dt>
910<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1078<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
911</dt> 1079</dt>
912<dd> 1080<dd>
913Return various integers describing terminal characteristics. 1081Return various integers describing terminal characteristics.
914</dd> 1082</dd>
915<p></p> 1083<p></p>
… …
944</dd> 1112</dd>
945<p></p> 1113<p></p>
946<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1114<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
947</dt> 1115</dt>
948<dd> 1116<dd>
949Returns the negative row number of the topmost line. Minimum value is 1117Returns the row number of the topmost displayed line. Maximum value is
950<code>0</code>, which displays the normal terminal contents. Larger values scroll 1118<code>0</code>, which displays the normal terminal contents. Lower values scroll
951this many lines into the scrollback buffer. 1119this many lines into the scrollback buffer.
952</dd> 1120</dd>
953<p></p> 1121<p></p>
954<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1122<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
955</dt> 1123</dt>
… …
966</dt> 1134</dt>
967<dd> 1135<dd>
968Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1136Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
969is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1137is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
970terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1138terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
971line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1139line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
972is requested. 1140is requested.
973</dd> 1141</dd>
974<dd> 1142<dd>
975<p>If <code>$new_text</code> is specified, it will replace characters in the current 1143<p>If <code>$new_text</code> is specified, it will replace characters in the current
976line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1144line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
… …
1061<p></p> 1229<p></p>
1062<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1230<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1063</dt> 1231</dt>
1064<dd> 1232<dd>
1065Returns the character offset of the given row|col pair within the logical 1233Returns the character offset of the given row|col pair within the logical
1066line. 1234line. Works for rows outside the line, too, and returns corresponding
1235offsets outside the string.
1067</dd> 1236</dd>
1068<p></p> 1237<p></p>
1069<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1238<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1070</dt> 1239</dt>
1071<dd> 1240<dd>
… …
1299<dl> 1468<dl>
1300<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1469<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1301</dt> 1470</dt>
1302<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1471<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1303</dt> 1472</dt>
1304<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1473<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1474</dt>
1475<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1305</dt> 1476</dt>
1306</dl> 1477</dl>
1307<p> 1478<p>
1308</p> 1479</p>
1309<hr /> 1480<hr />

Diff Legend

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