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.25 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.30 by root, Mon Jan 16 06:37:51 2006 UTC

… …
95<dd> 95<dd>
96<p>A double-click usually selects the word under the cursor, further clicks 96<p>A double-click usually selects the word under the cursor, further clicks
97will enlarge the selection.</p> 97will enlarge the selection.</p>
98</dd> 98</dd>
99<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>
100<p>It also offers the following bindable keyboard command:</p> 125<p>This extension also offers the following bindable keyboard command:</p>
101</dd> 126</dd>
102<dl> 127<dl>
103<dt><strong><a name="item_rot13">rot13</a></strong><br /> 128<dt><strong><a name="item_rot13">rot13</a></strong><br />
104</dt> 129</dt>
105<dd> 130<dd>
… …
141was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 166was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
142additionally stores the first match in the current line into the primary 167additionally stores the first match in the current line into the primary
143selection.</p> 168selection.</p>
144</dd> 169</dd>
145<p></p> 170<p></p>
146<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> 171<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
147</dt> 172</dt>
173<dd>
174This selection allows you to do automatic transforms on a selection
175whenever a selection is made.
148<dd> 176</dd>
149Displays a digital clock using the built-in overlay. 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/^([^:[:space:]]+):(\\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/^([^:[:space:]]+(\\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>
150</dd> 220</dd>
151<p></p> 221<p></p>
152<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 />
153</dt> 223</dt>
154<dd> 224<dd>
… …
162</dt> 232</dt>
163<dd> 233<dd>
164A 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,
165by replacing all line-drawing characters (U+2500 .. U+259F) by a 235by replacing all line-drawing characters (U+2500 .. U+259F) by a
166similar-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.
167</dd> 243</dd>
168<p></p> 244<p></p>
169<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 />
170</dt> 246</dt>
171<dd> 247<dd>
… …
416Called whenever the user presses a key combination that has a 492Called whenever the user presses a key combination that has a
417<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 493<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong>
418resource in the <code>rxvt(1)</code> manpage). 494resource in the <code>rxvt(1)</code> manpage).
419</dd> 495</dd>
420<p></p> 496<p></p>
497<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
498</dt>
499<dd>
500Called on every X event received on the vt window (and possibly other
501windows). Should only be used as a last resort. Most event structure
502members are not passed.
503</dd>
504<p></p>
421<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> 505<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br />
422</dt> 506</dt>
423<dd> 507<dd>
424Called whenever the window gets the keyboard focus, before rxvt-unicode 508Called whenever the window gets the keyboard focus, before rxvt-unicode
425does focus in processing. 509does focus in processing.
… …
537<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> 621<dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br />
538</dt> 622</dt>
539<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 623<dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
540Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 624Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
541Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 625Button4Mask, Button5Mask, AnyModifier</a></strong><br />
626</dt>
627<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
628ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
629PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
630Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
631KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
632ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
633FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br />
634</dt>
635<dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
636EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
637GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
638UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
639ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
640CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
641SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
542</dt> 642</dt>
543<dd> 643<dd>
544Various constants for use in X calls and event processing. 644Various constants for use in X calls and event processing.
545</dd> 645</dd>
546<p></p></dl> 646<p></p></dl>
… …
921</dt> 1021</dt>
922<dd> 1022<dd>
923Return the window id of the terminal window. 1023Return the window id of the terminal window.
924</dd> 1024</dd>
925<p></p> 1025<p></p>
1026<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1027</dt>
1028<dd>
1029Adds the specified events to the vt event mask. Useful e.g. when you want
1030to receive pointer events all the times:
1031</dd>
1032<dd>
1033<pre>
1034 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1035</dd>
1036<p></p>
926<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1037<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
927</dt> 1038</dt>
928<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1039<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
929</dt> 1040</dt>
930<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1041<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
943</dt> 1054</dt>
944<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1055<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
945</dt> 1056</dt>
946<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1057<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
947</dt> 1058</dt>
948<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1059<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
949</dt> 1060</dt>
950<dd> 1061<dd>
951Return various integers describing terminal characteristics. 1062Return various integers describing terminal characteristics.
952</dd> 1063</dd>
953<p></p> 1064<p></p>
… …
982</dd> 1093</dd>
983<p></p> 1094<p></p>
984<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1095<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
985</dt> 1096</dt>
986<dd> 1097<dd>
987Returns the negative row number of the topmost line. Minimum value is 1098Returns the row number of the topmost displayed line. Maximum value is
988<code>0</code>, which displays the normal terminal contents. Larger values scroll 1099<code>0</code>, which displays the normal terminal contents. Lower values scroll
989this many lines into the scrollback buffer. 1100this many lines into the scrollback buffer.
990</dd> 1101</dd>
991<p></p> 1102<p></p>
992<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1103<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
993</dt> 1104</dt>
… …
1004</dt> 1115</dt>
1005<dd> 1116<dd>
1006Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1117Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
1007is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1118is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
1008terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1119terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
1009line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1120line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
1010is requested. 1121is requested.
1011</dd> 1122</dd>
1012<dd> 1123<dd>
1013<p>If <code>$new_text</code> is specified, it will replace characters in the current 1124<p>If <code>$new_text</code> is specified, it will replace characters in the current
1014line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1125line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful

Diff Legend

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