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.32 by root, Wed Jan 18 09:40:53 2006 UTC vs.
Revision 1.33 by root, Thu Jan 19 19:26:31 2006 UTC

… …
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> 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>
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>
156Adds regex search functionality to the scrollback buffer, triggered 180Adds regex search functionality to the scrollback buffer, triggered
… …
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>
… …
224<dd> 248<dd>
225Uses per-line display filtering (<code>on_line_update</code>) to underline urls and 249Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
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.
253</dd>
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>
229</dd> 265</dd>
230<p></p> 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>
… …
402<dd> 438<dd>
403Called 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
404returning to the mainloop. 440returning to the mainloop.
405</dd> 441</dd>
406<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>
407<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 />
408</dt> 457</dt>
409<dd> 458<dd>
410Called 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
411selection 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
… …
556<dd> 605<dd>
557Called wheneever the window loses keyboard focus, before rxvt-unicode does 606Called wheneever the window loses keyboard focus, before rxvt-unicode does
558focus out processing. 607focus out processing.
559</dd> 608</dd>
560<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>
561<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 />
562</dt> 613</dt>
563<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 />
564</dt> 615</dt>
565<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 />
… …
773Destroy the terminal object (close the window, free resources 824Destroy the terminal object (close the window, free resources
774etc.). Please note that rxvt will not exit as long as any event 825etc.). Please note that rxvt will not exit as long as any event
775watchers (timers, io watchers) are still active. 826watchers (timers, io watchers) are still active.
776</dd> 827</dd>
777<p></p> 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>
839</dd>
840<p></p>
778<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 />
779</dt> 842</dt>
780<dd> 843<dd>
781Returns true if the option specified by <code>$optval</code> is enabled, and 844Returns true if the option specified by <code>$optval</code> is enabled, and
782optionally change it. All option values are stored by name in the hash 845optionally change it. All option values are stored by name in the hash
… …
788</dd> 851</dd>
789<dd> 852<dd>
790<pre> 853<pre>
791 borderLess console cursorBlink cursorUnderline hold iconic insecure 854 borderLess console cursorBlink cursorUnderline hold iconic insecure
792 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 855 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
793 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 856 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
794 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 857 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
795 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 858 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
796 tripleclickwords utmpInhibit visualBell</pre> 859 transparent tripleclickwords utmpInhibit visualBell</pre>
797</dd> 860</dd>
798<p></p> 861<p></p>
799<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 />
800</dt> 863</dt>
801<dd> 864<dd>
… …
826<pre> 889<pre>
827 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 890 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
828 borderLess color cursorBlink cursorUnderline cutchars delete_key 891 borderLess color cursorBlink cursorUnderline cutchars delete_key
829 display_name embed ext_bwidth fade font geometry hold iconName 892 display_name embed ext_bwidth fade font geometry hold iconName
830 imFont imLocale inputMethod insecure int_bwidth intensityStyles 893 imFont imLocale inputMethod insecure int_bwidth intensityStyles
831 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 894 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
832 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 895 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
833 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 896 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
834 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 897 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
835 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 898 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
836 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 899 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
837 shade term_name title transparent transparent_all tripleclickwords 900 secondaryScreen secondaryScroll selectstyle shade term_name title
901 transient_for transparent transparent_all tripleclickwords utmpInhibit
838 utmpInhibit visualBell</pre> 902 visualBell</pre>
839</dd> 903</dd>
840<p></p> 904<p></p>
841<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 />
842</dt> 906</dt>
843<dd> 907<dd>
… …
1404<p></p> 1468<p></p>
1405<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1469<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1406</dt> 1470</dt>
1407<dd> 1471<dd>
1408Set 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;.
1409</dd> 1479</dd>
1410<p></p> 1480<p></p>
1411<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 />
1412</dt> 1482</dt>
1413<dd> 1483<dd>

Diff Legend

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