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.38 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.42 by root, Mon Feb 6 06:14:55 2006 UTC

… …
154</dt> 154</dt>
155<dd> 155<dd>
156Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 156Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
157runtime. 157runtime.
158</dd> 158</dd>
159<dd>
160<p>Other extensions can extend this popup menu by pushing a code reference
161onto <code>@{ $term-</code>{option_popup_hook} }&gt;, which gets called whenever the
162popup is being displayed.</p>
163</dd>
164<dd>
165<p>It's sole argument is the popup menu, which can be modified. It should
166either return nothing or a string, the initial boolean value and a code
167reference. The string will be used as button text and the code reference
168will be called when the toggle changes, with the new boolean value as
169first argument.</p>
170</dd>
171<dd>
172<p>The following will add an entry <code>myoption</code> that changes
173<code>$self-</code>{myoption}&gt;:</p>
174</dd>
175<dd>
176<pre>
177 push @{ $self-&gt;{term}{option_popup_hook} }, sub {
178 (&quot;my option&quot; =&gt; $myoption, sub { $self-&gt;{myoption} = $_[0] })
179 };</pre>
180</dd>
159<p></p> 181<p></p>
160<dt><strong>selection-popup (enabled by default)</strong><br /> 182<dt><strong>selection-popup (enabled by default)</strong><br />
161</dt> 183</dt>
162<dd> 184<dd>
163Binds a popup menu to Ctrl-Button3 that lets you convert the selection 185Binds a popup menu to Ctrl-Button3 that lets you convert the selection
164text into various other formats/action (such as uri unescaping, perl 186text into various other formats/action (such as uri unescaping, perl
165evaluation, web-browser starting etc.), depending on content. 187evaluation, web-browser starting etc.), depending on content.
166</dd> 188</dd>
167<dd> 189<dd>
168<p>Other extensions can extend this popup menu by pushing a code reference 190<p>Other extensions can extend this popup menu by pushing a code reference
169onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the 191onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the
170popup is displayed.</p> 192popup is being displayed.</p>
171</dd> 193</dd>
172<dd> 194<dd>
173<p>It's sole argument is the popup menu, which can be modified. The selection 195<p>It's sole argument is the popup menu, which can be modified. The selection
174is in <code>$_</code>, which can be used to decide wether to add something or not. 196is in <code>$_</code>, which can be used to decide wether to add something or not.
175It should either return nothing or a string and a code reference. The 197It should either return nothing or a string and a code reference. The
… …
293<dd> 315<dd>
294<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and 316<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
295<strong>Shift-Right</strong> will switch to the tab left or right of the current one, 317<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
296while <strong>Shift-Down</strong> creates a new tab.</p> 318while <strong>Shift-Down</strong> creates a new tab.</p>
297</dd> 319</dd>
320<dd>
321<p>The tabbar itself can be configured similarly to a normal terminal, but
322with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
323following four resources (shown with defaults):</p>
324</dd>
325<dd>
326<pre>
327 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
328 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
329 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
330 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre>
331</dd>
332<dd>
333<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
334indices.</p>
335</dd>
298<p></p> 336<p></p>
299<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 337<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
300</dt> 338</dt>
301<dd> 339<dd>
302Uses per-line display filtering (<code>on_line_update</code>) to underline urls and 340Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
… …
346</dt> 384</dt>
347<dd> 385<dd>
348Displays a digital clock using the built-in overlay. 386Displays a digital clock using the built-in overlay.
349</dd> 387</dd>
350<p></p> 388<p></p>
351<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 389<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
352</dt> 390</dt>
391<dd>
392Somewhat of a misnomer, this extension adds two menu entries to the
393selection popup that allows one ti run external commands to store the
394selection somewhere and fetch it again.
353<dd> 395</dd>
354Displays a very simple digital clock in the upper right corner of the 396<dd>
355window. Illustrates overwriting the refresh callbacks to create your own 397<p>We use it to implement a ``distributed selection mechanism'', which just
356overlays or changes. 398means that one command uploads the file to a remote server, and another
399reads it.</p>
400</dd>
401<dd>
402<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
403<code>URxvt.remote-selection.fetch</code> resources. The first should read the
404selection to store from STDIN (always in UTF-8), the second should provide
405the selection data on STDOUT (also in UTF-8).</p>
406</dd>
407<dd>
408<p>The defaults (which are likely useless to you) use rsh and cat:</p>
409</dd>
410<dd>
411<pre>
412 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
413 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
357</dd> 414</dd>
358<p></p> 415<p></p>
359<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> 416<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
360</dt> 417</dt>
361<dd> 418<dd>
… …
394for the filename):</p> 451for the filename):</p>
395</dd> 452</dd>
396<dd> 453<dd>
397<pre> 454<pre>
398 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> 455 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
456</dd>
457<p></p>
458<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
459</dt>
460<dd>
461Displays a very simple digital clock in the upper right corner of the
462window. Illustrates overwriting the refresh callbacks to create your own
463overlays or changes.
399</dd> 464</dd>
400<p></p></dl> 465<p></p></dl>
401<p> 466<p>
402</p> 467</p>
403<hr /> 468<hr />
… …
653</dt> 718</dt>
654<dd> 719<dd>
655Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 720Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
656</dd> 721</dd>
657<p></p> 722<p></p>
658<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 723<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
659</dt> 724</dt>
660<dd> 725<dd>
661Called whenever the user presses a key combination that has a 726Called whenever the a user-configured event is being activated (e.g. via
662<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 727a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
663resource in the <code>rxvt(1)</code> manpage). 728resource in the <code>rxvt(1)</code> manpage).
729</dd>
730<dd>
731<p>The event is simply the action string. This interface is assumed to change
732slightly in the future.</p>
664</dd> 733</dd>
665<p></p> 734<p></p>
666<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 735<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
667</dt> 736</dt>
668<dd> 737<dd>
… …
805<p>Using this function has the advantage that its output ends up in the 874<p>Using this function has the advantage that its output ends up in the
806correct place, e.g. on stderr of the connecting urxvtc client.</p> 875correct place, e.g. on stderr of the connecting urxvtc client.</p>
807</dd> 876</dd>
808<dd> 877<dd>
809<p>Messages have a size limit of 1023 bytes currently.</p> 878<p>Messages have a size limit of 1023 bytes currently.</p>
879</dd>
880<p></p>
881<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
882</dt>
883<dd>
884Returns all urxvt::term objects that exist in this process, regardless of
885wether they are started, being destroyed etc., so be careful. Only term
886objects that have perl extensions attached will be returned (because there
887is no urxvt::term objet associated with others).
810</dd> 888</dd>
811<p></p> 889<p></p>
812<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 890<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
813</dt> 891</dt>
814<dd> 892<dd>
… …
882<p></p> 960<p></p>
883<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> 961<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
884</dt> 962</dt>
885<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> 963<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
886</dt> 964</dt>
965<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br />
966</dt>
887<dd> 967<dd>
888Replace the foreground/background colour in the rendition mask with the 968Replace the foreground/background colour in the rendition mask with the
889specified one. 969specified one.
890</dd> 970</dd>
891<p></p> 971<p></p>
… …
925</dd> 1005</dd>
926<dd> 1006<dd>
927<p>Croaks (and probably outputs an error message) if the new instance 1007<p>Croaks (and probably outputs an error message) if the new instance
928couldn't be created. Returns <code>undef</code> if the new instance didn't 1008couldn't be created. Returns <code>undef</code> if the new instance didn't
929initialise perl, and the terminal object otherwise. The <code>init</code> and 1009initialise perl, and the terminal object otherwise. The <code>init</code> and
930<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> 1010<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
1011refer to global data (which is race free).</p>
931</dd> 1012</dd>
932<p></p> 1013<p></p>
933<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 1014<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
934</dt> 1015</dt>
935<dd> 1016<dd>
… …
1255<dd> 1336<dd>
1256<pre> 1337<pre>
1257 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre> 1338 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1258</dd> 1339</dd>
1259<p></p> 1340<p></p>
1341<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br />
1342</dt>
1343<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br />
1344</dt>
1345<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br />
1346</dt>
1347<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br />
1348</dt>
1349<dd>
1350Deliver various fake events to to terminal.
1351</dd>
1352<p></p>
1260<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1353<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1261</dt> 1354</dt>
1262<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1355<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1263</dt> 1356</dt>
1264<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1357<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
1470<dd> 1563<dd>
1471Converts rxvt-unicodes text reprsentation into a perl string. See 1564Converts rxvt-unicodes text reprsentation into a perl string. See
1472<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1565<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1473</dd> 1566</dd>
1474<p></p> 1567<p></p>
1475<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1568<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1476</dt> 1569</dt>
1570<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1571</dt>
1477<dd> 1572<dd>
1478Registers a synchronous button grab. See the XGrabButton manpage. 1573Register/unregister a synchronous button grab. See the XGrabButton
1574manpage.
1479</dd> 1575</dd>
1480<p></p> 1576<p></p>
1481<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1577<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1482</dt> 1578</dt>
1483<dd> 1579<dd>
… …
1565<dd> 1661<dd>
1566Adds a clickable button to the popup. <code>$cb</code> is called whenever it is 1662Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1567selected. 1663selected.
1568</dd> 1664</dd>
1569<p></p> 1665<p></p>
1570<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br /> 1666<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $initial_value, $cb)</a></strong><br />
1571</dt> 1667</dt>
1572<dd> 1668<dd>
1573Adds a toggle/checkbox item to the popup. Teh callback gets called 1669Adds a toggle/checkbox item to the popup. The callback gets called
1574whenever it gets toggled, with a boolean indicating its value as its first 1670whenever it gets toggled, with a boolean indicating its new value as its
1575argument. 1671first argument.
1576</dd> 1672</dd>
1577<p></p> 1673<p></p>
1578<dt><strong>$popup-&gt;show</strong><br /> 1674<dt><strong>$popup-&gt;show</strong><br />
1579</dt> 1675</dt>
1580<dd> 1676<dd>

Diff Legend

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