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.26 by root, Thu Jan 12 12:10:06 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 the following bindable keyboard command:</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>
… …
122<p></p> 152<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 /> 153<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
124</dt> 154</dt>
125<dd> 155<dd>
126Adds regex search functionality to the scrollback buffer, triggered 156Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal 157by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
128input/output is suspended. 158input/output is suspended and a regex is displayed at the bottom of the
129</dd> 159screen.
130<dd> 160</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> 161<dd>
136<p></p> 162<p>Inputting characters appends them to the regex and continues incremental
137<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 163search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
138</dt> 164search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
165bottom. <code>Escape</code> leaves search mode and returns to the point where search
166was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
167additionally stores the first match in the current line into the primary
168selection.</p>
139<dd> 169</dd>
140Displays a digital clock using the built-in overlay. 170<p></p>
171<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
172</dt>
173<dd>
174This selection allows you to do automatic transforms on a selection
175whenever a selection is made.
176</dd>
177<dd>
178<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
179operator) that modify <code>$_</code> as resources:</p>
180</dd>
181<dd>
182<pre>
183 URxvt.selection-autotransform.0: transform
184 URxvt.selection-autotransform.1: transform
185 ...</pre>
186</dd>
187<dd>
188<p>For example, the following will transform selections of the form
189<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
190$word</code>:</p>
191</dd>
192<dd>
193<pre>
194 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre>
195</dd>
196<dd>
197<p>And this example matches the same,but replaces it with vi-commands you can
198paste directly into your (vi :) editor:</p>
199</dd>
200<dd>
201<pre>
202 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre>
141</dd> 203</dd>
142<p></p> 204<p></p>
143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 205<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
144</dt> 206</dt>
145<dd> 207<dd>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 208Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
209make them clickable. When middle-clicked, the program specified in the
210resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
211the URL as first argument.
147</dd> 212</dd>
148<p></p> 213<p></p>
149<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 214<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
150</dt> 215</dt>
151<dd> 216<dd>
152A not very useful example of filtering all text output to the terminal, 217A not very useful example of filtering all text output to the terminal,
153by replacing all line-drawing characters (U+2500 .. U+259F) by a 218by replacing all line-drawing characters (U+2500 .. U+259F) by a
154similar-looking ascii character. 219similar-looking ascii character.
220</dd>
221<p></p>
222<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
223</dt>
224<dd>
225Displays a digital clock using the built-in overlay.
155</dd> 226</dd>
156<p></p> 227<p></p>
157<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 228<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
158</dt> 229</dt>
159<dd> 230<dd>
… …
301</dt> 372</dt>
302<dd> 373<dd>
303Called whenever the user tries to extend the selection (e.g. with a double 374Called whenever the user tries to extend the selection (e.g. with a double
304click) and is either supposed to return false (normal operation), or 375click) and is either supposed to return false (normal operation), or
305should extend the selection itelf and return true to suppress the built-in 376should extend the selection itelf and return true to suppress the built-in
306processing. 377processing. This can happen multiple times, as long as the callback
378returns true, it will be called on every further click by the user and is
379supposed to enlarge the selection more and more, if possible.
307</dd> 380</dd>
308<dd> 381<dd>
309<p>See the <em>selection</em> example extension.</p> 382<p>See the <em>selection</em> example extension.</p>
310</dd> 383</dd>
311<p></p> 384<p></p>
… …
688 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 761 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
689 shade term_name title transparent transparent_all tripleclickwords 762 shade term_name title transparent transparent_all tripleclickwords
690 utmpInhibit visualBell</pre> 763 utmpInhibit visualBell</pre>
691</dd> 764</dd>
692<p></p> 765<p></p>
766<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
767</dt>
768<dd>
769Returns the X-Resource for the given pattern, excluding the program or
770class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
771same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
772resource with that pattern exists.
773</dd>
774<dd>
775<p>This method should only be called during the <code>on_start</code> hook, as there is
776only one resource database per display, and later invocations might return
777the wrong resources.</p>
778</dd>
779<p></p>
693<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 780<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
694</dt> 781</dt>
695<dd> 782<dd>
696Adds a keymap translation exactly as specified via a resource. See the 783Adds a keymap translation exactly as specified via a resource. See the
697<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 784<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
… …
720<dd> 807<dd>
721Return the current values of the selection mark, begin or end positions, 808Return the current values of the selection mark, begin or end positions,
722and optionally set them to new values. 809and optionally set them to new values.
723</dd> 810</dd>
724<p></p> 811<p></p>
812<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
813</dt>
814<dd>
815Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
816<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
817rectangular selection will be made. This is the prefered function to make
818a selection.
819</dd>
820<p></p>
725<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 821<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
726</dt> 822</dt>
727<dd> 823<dd>
728Try to request the primary selection from the server (for example, as set 824Try to request the primary selection text from the server (for example, as
729by the next method). 825set by the next method). No visual feedback will be given. This function
826is mostly useful from within <code>on_sel_grab</code> hooks.
730</dd> 827</dd>
731<p></p> 828<p></p>
732<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 829<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
733</dt> 830</dt>
734<dd> 831<dd>
… …
813<p></p> 910<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 /> 911<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> 912</dt>
816<dd> 913<dd>
817XORs the rendition values in the given span with the provided value 914XORs 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 915(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
819to the selection. 916refresh hooks to provide effects similar to the selection.
820</dd> 917</dd>
821<p></p> 918<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 /> 919<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> 920</dt>
824<dd> 921<dd>
825Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 922Similar 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 923whitespace 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 924to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
828it instead. 925it instead. Both styles <em>MUST NOT</em> contain font styles.
829</dd> 926</dd>
830<p></p> 927<p></p>
831<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br /> 928<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
832</dt> 929</dt>
833<dd> 930<dd>
… …
1061<p></p> 1158<p></p>
1062<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1159<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1063</dt> 1160</dt>
1064<dd> 1161<dd>
1065Returns the character offset of the given row|col pair within the logical 1162Returns the character offset of the given row|col pair within the logical
1066line. 1163line. Works for rows outside the line, too, and returns corresponding
1164offsets outside the string.
1067</dd> 1165</dd>
1068<p></p> 1166<p></p>
1069<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1167<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1070</dt> 1168</dt>
1071<dd> 1169<dd>
… …
1299<dl> 1397<dl>
1300<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1398<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1301</dt> 1399</dt>
1302<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1400<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1303</dt> 1401</dt>
1304<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1402<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1403</dt>
1404<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1305</dt> 1405</dt>
1306</dl> 1406</dl>
1307<p> 1407<p>
1308</p> 1408</p>
1309<hr /> 1409<hr />

Diff Legend

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