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.36 by root, Sat Jan 21 19:50:53 2006 UTC vs.
Revision 1.42 by root, Mon Feb 6 06:14:55 2006 UTC

… …
121<dd> 121<dd>
122<pre> 122<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> 123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd> 124</dd>
125<dd> 125<dd>
126<p>Another example: Programs I use often output ``absolute path: '' at the
127beginning of a line when they process multiple files. The following
128pattern matches the filename (note, there is a single space at the very
129end):</p>
130</dd>
131<dd>
132<pre>
133 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
134</dd>
135<dd>
126<p>You can look at the source of the selection extension to see more 136<p>You can look at the source of the selection extension to see more
127interesting uses, such as parsing a line from beginning to end.</p> 137interesting uses, such as parsing a line from beginning to end.</p>
128</dd> 138</dd>
129<dd> 139<dd>
130<p>This extension also offers following bindable keyboard commands:</p> 140<p>This extension also offers following bindable keyboard commands:</p>
… …
143<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> 153<dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br />
144</dt> 154</dt>
145<dd> 155<dd>
146Binds 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
147runtime. 157runtime.
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>
148</dd> 180</dd>
149<p></p> 181<p></p>
150<dt><strong>selection-popup (enabled by default)</strong><br /> 182<dt><strong>selection-popup (enabled by default)</strong><br />
151</dt> 183</dt>
152<dd> 184<dd>
… …
154text into various other formats/action (such as uri unescaping, perl 186text into various other formats/action (such as uri unescaping, perl
155evaluation, web-browser starting etc.), depending on content. 187evaluation, web-browser starting etc.), depending on content.
156</dd> 188</dd>
157<dd> 189<dd>
158<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
159onto <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
160popup is displayed.</p> 192popup is being displayed.</p>
161</dd> 193</dd>
162<dd> 194<dd>
163<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
164is 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.
165It 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
… …
208</dd> 240</dd>
209<dd> 241<dd>
210<p>To avoid too many false positives, this is only done when:</p> 242<p>To avoid too many false positives, this is only done when:</p>
211</dd> 243</dd>
212<dl> 244<dl>
245<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
246</dt>
247<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
248</dt>
249<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
250</dt>
213<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> 251<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
214</dt>
215<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
216</dt>
217<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
218</dt> 252</dt>
219</dl> 253</dl>
220<p>The normal selection mechanism isn't disabled, so quick successive clicks 254<p>The normal selection mechanism isn't disabled, so quick successive clicks
221might interfere with selection creation in harmless ways.</p> 255might interfere with selection creation in harmless ways.</p>
222<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 256<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
… …
281<dd> 315<dd>
282<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
283<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,
284while <strong>Shift-Down</strong> creates a new tab.</p> 318while <strong>Shift-Down</strong> creates a new tab.</p>
285</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>
286<p></p> 336<p></p>
287<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 />
288</dt> 338</dt>
289<dd> 339<dd>
290Uses 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
291make them clickable. When middle-clicked, the program specified in the 341make them clickable. When middle-clicked, the program specified in the
292resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 342resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
293the URL as first argument. 343the URL as first argument.
294</dd> 344</dd>
295<p></p> 345<p></p>
346<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
347</dt>
348<dd>
349This (experimental) perl extension implements OnTheSpot editing. It does
350not work perfectly, and some input methods don't seem to work well with
351OnTheSpot editing in general, but it seems to work at leats for SCIM and
352kinput2.
353</dd>
354<dd>
355<p>You enable it by specifying this extension and a preedit style of
356<code>OnTheSpot</code>, i.e.:</p>
357</dd>
358<dd>
359<pre>
360 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
361</dd>
362<p></p>
296<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> 363<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
297</dt> 364</dt>
298<dd> 365<dd>
299This is basically a one-line extension that dynamically changes the background pixmap offset 366This is basically a one-line extension that dynamically changes the background pixmap offset
300to the window position, in effect creating the same effect as pseudo transparency with 367to the window position, in effect creating the same effect as pseudo transparency with
… …
317</dt> 384</dt>
318<dd> 385<dd>
319Displays a digital clock using the built-in overlay. 386Displays a digital clock using the built-in overlay.
320</dd> 387</dd>
321<p></p> 388<p></p>
322<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 />
323</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.
324<dd> 395</dd>
325Displays a very simple digital clock in the upper right corner of the 396<dd>
326window. Illustrates overwriting the refresh callbacks to create your own 397<p>We use it to implement a ``distributed selection mechanism'', which just
327overlays 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>
328</dd> 414</dd>
329<p></p> 415<p></p>
330<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 />
331</dt> 417</dt>
332<dd> 418<dd>
… …
365for the filename):</p> 451for the filename):</p>
366</dd> 452</dd>
367<dd> 453<dd>
368<pre> 454<pre>
369 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.
370</dd> 464</dd>
371<p></p></dl> 465<p></p></dl>
372<p> 466<p>
373</p> 467</p>
374<hr /> 468<hr />
… …
475</dd> 569</dd>
476<p></p> 570<p></p>
477<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> 571<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
478</dt> 572</dt>
479<dd> 573<dd>
480Called whenever something tries to destroy terminal, before doing anything 574Called whenever something tries to destroy terminal, when the terminal is
481yet. If this hook returns true, then destruction is skipped, but this is 575still fully functional (not for long, though).
482rarely a good idea.
483</dd> 576</dd>
484<p></p> 577<p></p>
485<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 578<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
486</dt> 579</dt>
487<dd> 580<dd>
… …
625</dt> 718</dt>
626<dd> 719<dd>
627Called 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>.
628</dd> 721</dd>
629<p></p> 722<p></p>
630<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 />
631</dt> 724</dt>
632<dd> 725<dd>
633Called whenever the user presses a key combination that has a 726Called whenever the a user-configured event is being activated (e.g. via
634<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>
635resource 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>
636</dd> 733</dd>
637<p></p> 734<p></p>
638<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 />
639</dt> 736</dt>
640<dd> 737<dd>
… …
777<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
778correct place, e.g. on stderr of the connecting urxvtc client.</p> 875correct place, e.g. on stderr of the connecting urxvtc client.</p>
779</dd> 876</dd>
780<dd> 877<dd>
781<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).
782</dd> 888</dd>
783<p></p> 889<p></p>
784<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 />
785</dt> 891</dt>
786<dd> 892<dd>
… …
854<p></p> 960<p></p>
855<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 />
856</dt> 962</dt>
857<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 />
858</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>
859<dd> 967<dd>
860Replace the foreground/background colour in the rendition mask with the 968Replace the foreground/background colour in the rendition mask with the
861specified one. 969specified one.
862</dd> 970</dd>
863<p></p> 971<p></p>
… …
897</dd> 1005</dd>
898<dd> 1006<dd>
899<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
900couldn'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
901initialise perl, and the terminal object otherwise. The <code>init</code> and 1009initialise perl, and the terminal object otherwise. The <code>init</code> and
902<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>
903</dd> 1012</dd>
904<p></p> 1013<p></p>
905<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 />
906</dt> 1015</dt>
907<dd> 1016<dd>
… …
1197be used to suppress input and output handling to the pty/tty. See the 1306be used to suppress input and output handling to the pty/tty. See the
1198description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore 1307description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1199the previous value. 1308the previous value.
1200</dd> 1309</dd>
1201<p></p> 1310<p></p>
1311<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1312</dt>
1313<dd>
1314Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1315is used.
1316</dd>
1317<p></p>
1202<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1318<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1203</dt> 1319</dt>
1204<dd> 1320<dd>
1205Return the window id of the toplevel window. 1321Return the window id of the toplevel window.
1206</dd> 1322</dd>
… …
1218to receive pointer events all the times: 1334to receive pointer events all the times:
1219</dd> 1335</dd>
1220<dd> 1336<dd>
1221<pre> 1337<pre>
1222 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre> 1338 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1339</dd>
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.
1223</dd> 1351</dd>
1224<p></p> 1352<p></p>
1225<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 />
1226</dt> 1354</dt>
1227<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 />
… …
1325line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1453line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1326to replace only parts of a line. The font index in the rendition will 1454to replace only parts of a line. The font index in the rendition will
1327automatically be updated.</p> 1455automatically be updated.</p>
1328</dd> 1456</dd>
1329<dd> 1457<dd>
1330<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use 1458<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1331more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> 1459than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1332characters. Characters with combining characters and other characters that 1460characters. Characters with combining characters and other characters that
1333do not fit into the normal tetx encoding will be replaced with characters 1461do not fit into the normal tetx encoding will be replaced with characters
1334in the private use area.</p> 1462in the private use area.</p>
1335</dd> 1463</dd>
1336<dd> 1464<dd>
… …
1435<dd> 1563<dd>
1436Converts rxvt-unicodes text reprsentation into a perl string. See 1564Converts rxvt-unicodes text reprsentation into a perl string. See
1437<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.
1438</dd> 1566</dd>
1439<p></p> 1567<p></p>
1440<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 />
1441</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>
1442<dd> 1572<dd>
1443Registers a synchronous button grab. See the XGrabButton manpage. 1573Register/unregister a synchronous button grab. See the XGrabButton
1574manpage.
1444</dd> 1575</dd>
1445<p></p> 1576<p></p>
1446<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 />
1447</dt> 1578</dt>
1448<dd> 1579<dd>
… …
1530<dd> 1661<dd>
1531Adds 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
1532selected. 1663selected.
1533</dd> 1664</dd>
1534<p></p> 1665<p></p>
1535<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 />
1536</dt> 1667</dt>
1537<dd> 1668<dd>
1538Adds a toggle/checkbox item to the popup. Teh callback gets called 1669Adds a toggle/checkbox item to the popup. The callback gets called
1539whenever 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
1540argument. 1671first argument.
1541</dd> 1672</dd>
1542<p></p> 1673<p></p>
1543<dt><strong>$popup-&gt;show</strong><br /> 1674<dt><strong>$popup-&gt;show</strong><br />
1544</dt> 1675</dt>
1545<dd> 1676<dd>

Diff Legend

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