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.21 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.28 by root, Fri Jan 13 01:09:37 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>
203</dd>
204<dd>
205<p>Of course, this can be modified to suit your needs and your editor :)</p>
206</dd>
207<dd>
208<p>To expand the example above to typical perl error messages (``XXX at
209FILENAME line YYY.''), you need a slightly more elaborate solution:</p>
210</dd>
211<dd>
212<pre>
213 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>
215</dd>
216<dd>
217<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
219the message into vi commands to load the file.</p>
141</dd> 220</dd>
142<p></p> 221<p></p>
143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 222<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
144</dt> 223</dt>
145<dd> 224<dd>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 225Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
226make them clickable. When middle-clicked, the program specified in the
227resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
228the URL as first argument.
147</dd> 229</dd>
148<p></p> 230<p></p>
149<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 231<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
150</dt> 232</dt>
151<dd> 233<dd>
152A not very useful example of filtering all text output to the terminal, 234A not very useful example of filtering all text output to the terminal,
153by replacing all line-drawing characters (U+2500 .. U+259F) by a 235by replacing all line-drawing characters (U+2500 .. U+259F) by a
154similar-looking ascii character. 236similar-looking ascii character.
237</dd>
238<p></p>
239<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br />
240</dt>
241<dd>
242Displays a digital clock using the built-in overlay.
155</dd> 243</dd>
156<p></p> 244<p></p>
157<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 245<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
158</dt> 246</dt>
159<dd> 247<dd>
… …
183<dl> 271<dl>
184<dt><strong><a name="item__24text">$text</a></strong><br /> 272<dt><strong><a name="item__24text">$text</a></strong><br />
185</dt> 273</dt>
186<dd> 274<dd>
187Rxvt-unicodes special way of encoding text, where one ``unicode'' character 275Rxvt-unicodes special way of encoding text, where one ``unicode'' character
188always represents one screen cell. See <em>row_t</em> for a discussion of this format. 276always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
189</dd> 277</dd>
190<p></p> 278<p></p>
191<dt><strong><a name="item__24string">$string</a></strong><br /> 279<dt><strong><a name="item__24string">$string</a></strong><br />
192</dt> 280</dt>
193<dd> 281<dd>
… …
301</dt> 389</dt>
302<dd> 390<dd>
303Called whenever the user tries to extend the selection (e.g. with a double 391Called whenever the user tries to extend the selection (e.g. with a double
304click) and is either supposed to return false (normal operation), or 392click) and is either supposed to return false (normal operation), or
305should extend the selection itelf and return true to suppress the built-in 393should extend the selection itelf and return true to suppress the built-in
306processing. 394processing. This can happen multiple times, as long as the callback
395returns true, it will be called on every further click by the user and is
396supposed to enlarge the selection more and more, if possible.
307</dd> 397</dd>
308<dd> 398<dd>
309<p>See the <em>selection</em> example extension.</p> 399<p>See the <em>selection</em> example extension.</p>
310</dd> 400</dd>
311<p></p> 401<p></p>
… …
476</dt> 566</dt>
477<dd> 567<dd>
478The current terminal. This variable stores the current <code>urxvt::term</code> 568The current terminal. This variable stores the current <code>urxvt::term</code>
479object, whenever a callback/hook is executing. 569object, whenever a callback/hook is executing.
480</dd> 570</dd>
481<p></p> 571<p></p></dl>
482<dt></dt>
483</dl>
484<p> 572<p>
485</p> 573</p>
486<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 574<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
487<dl> 575<dl>
488<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
489</dt>
490<dd>
491Creates a new terminal, very similar as if you had started it with
492<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
493if the new instance couldn't be created. Returns <code>undef</code> if the new
494instance didn't initialise perl, and the terminal object otherwise. The
495<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
496</dd>
497<p></p>
498<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 576<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
499</dt> 577</dt>
500<dd> 578<dd>
501Fatally aborts execution with the given error message. Avoid at all 579Fatally aborts execution with the given error message. Avoid at all
502costs! The only time this is acceptable is when the terminal process 580costs! The only time this is acceptable is when the terminal process
… …
511that calls this function. 589that calls this function.
512</dd> 590</dd>
513<dd> 591<dd>
514<p>Using this function has the advantage that its output ends up in the 592<p>Using this function has the advantage that its output ends up in the
515correct place, e.g. on stderr of the connecting urxvtc client.</p> 593correct place, e.g. on stderr of the connecting urxvtc client.</p>
594</dd>
595<dd>
596<p>Messages have a size limit of 1023 bytes currently.</p>
516</dd> 597</dd>
517<p></p> 598<p></p>
518<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> 599<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
519</dt> 600</dt>
520<dd> 601<dd>
… …
612work.</p> 693work.</p>
613<p> 694<p>
614</p> 695</p>
615<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 696<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
616<dl> 697<dl>
698<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
699</dt>
700<dd>
701Creates a new terminal, very similar as if you had started it with system
702<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
703hash which defines the environment of the new terminal.
704</dd>
705<dd>
706<p>Croaks (and probably outputs an error message) if the new instance
707couldn't be created. Returns <code>undef</code> if the new instance didn't
708initialise perl, and the terminal object otherwise. The <code>init</code> and
709<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
710</dd>
711<p></p>
617<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 712<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
618</dt> 713</dt>
619<dd> 714<dd>
620Destroy the terminal object (close the window, free resources 715Destroy the terminal object (close the window, free resources
621etc.). Please note that rxvt will not exit as long as any event 716etc.). Please note that rxvt will not exit as long as any event
… …
683 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 778 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
684 shade term_name title transparent transparent_all tripleclickwords 779 shade term_name title transparent transparent_all tripleclickwords
685 utmpInhibit visualBell</pre> 780 utmpInhibit visualBell</pre>
686</dd> 781</dd>
687<p></p> 782<p></p>
783<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
784</dt>
785<dd>
786Returns the X-Resource for the given pattern, excluding the program or
787class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
788same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
789resource with that pattern exists.
790</dd>
791<dd>
792<p>This method should only be called during the <code>on_start</code> hook, as there is
793only one resource database per display, and later invocations might return
794the wrong resources.</p>
795</dd>
796<p></p>
688<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 797<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
689</dt> 798</dt>
690<dd> 799<dd>
691Adds a keymap translation exactly as specified via a resource. See the 800Adds a keymap translation exactly as specified via a resource. See the
692<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 801<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
… …
715<dd> 824<dd>
716Return the current values of the selection mark, begin or end positions, 825Return the current values of the selection mark, begin or end positions,
717and optionally set them to new values. 826and optionally set them to new values.
718</dd> 827</dd>
719<p></p> 828<p></p>
829<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
830</dt>
831<dd>
832Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and
833<a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a
834rectangular selection will be made. This is the prefered function to make
835a selection.
836</dd>
837<p></p>
720<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 838<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
721</dt> 839</dt>
722<dd> 840<dd>
723Try to request the primary selection from the server (for example, as set 841Try to request the primary selection text from the server (for example, as
724by the next method). 842set by the next method). No visual feedback will be given. This function
843is mostly useful from within <code>on_sel_grab</code> hooks.
725</dd> 844</dd>
726<p></p> 845<p></p>
727<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 846<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
728</dt> 847</dt>
729<dd> 848<dd>
… …
808<p></p> 927<p></p>
809<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 /> 928<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 />
810</dt> 929</dt>
811<dd> 930<dd>
812XORs the rendition values in the given span with the provided value 931XORs the rendition values in the given span with the provided value
813(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar 932(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
814to the selection. 933refresh hooks to provide effects similar to the selection.
815</dd> 934</dd>
816<p></p> 935<p></p>
817<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 /> 936<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 />
818</dt> 937</dt>
819<dd> 938<dd>
820Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 939Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
821whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 940whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
822to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines 941to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
823it instead. 942it instead. Both styles <em>MUST NOT</em> contain font styles.
824</dd> 943</dd>
825<p></p> 944<p></p>
826<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br /> 945<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
827</dt> 946</dt>
828<dd> 947<dd>
… …
906</dt> 1025</dt>
907<dd> 1026<dd>
908Return various integers describing terminal characteristics. 1027Return various integers describing terminal characteristics.
909</dd> 1028</dd>
910<p></p> 1029<p></p>
1030<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1031</dt>
1032<dd>
1033Return the DISPLAY used by rxvt-unicode.
1034</dd>
1035<p></p>
911<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br /> 1036<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
912</dt> 1037</dt>
913<dd> 1038<dd>
914Returns the LC_CTYPE category string used by this rxvt-unicode. 1039Returns the LC_CTYPE category string used by this rxvt-unicode.
915</dd> 1040</dd>
916<p></p> 1041<p></p>
917<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br /> 1042<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
918</dt> 1043</dt>
919<dd> 1044<dd>
920Return the DISPLAY used by rxvt-unicode. 1045Returns a copy of the environment in effect for the terminal as a hashref
1046similar to <code>\%ENV</code>.
921</dd> 1047</dd>
922<p></p> 1048<p></p>
923<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1049<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
924</dt> 1050</dt>
925<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1051<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
1049<p></p> 1175<p></p>
1050<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1176<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1051</dt> 1177</dt>
1052<dd> 1178<dd>
1053Returns the character offset of the given row|col pair within the logical 1179Returns the character offset of the given row|col pair within the logical
1054line. 1180line. Works for rows outside the line, too, and returns corresponding
1181offsets outside the string.
1055</dd> 1182</dd>
1056<p></p> 1183<p></p>
1057<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1184<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1058</dt> 1185</dt>
1059<dd> 1186<dd>
… …
1287<dl> 1414<dl>
1288<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> 1415<dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br />
1289</dt> 1416</dt>
1290<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1417<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1291</dt> 1418</dt>
1292<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1419<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1420</dt>
1421<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1293</dt> 1422</dt>
1294</dl> 1423</dl>
1295<p> 1424<p>
1296</p> 1425</p>
1297<hr /> 1426<hr />

Diff Legend

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