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.40 by root, Sun Jan 29 21:45:47 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>
… …
208</dd> 218</dd>
209<dd> 219<dd>
210<p>To avoid too many false positives, this is only done when:</p> 220<p>To avoid too many false positives, this is only done when:</p>
211</dd> 221</dd>
212<dl> 222<dl>
223<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
224</dt>
225<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
226</dt>
227<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
228</dt>
213<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> 229<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> 230</dt>
219</dl> 231</dl>
220<p>The normal selection mechanism isn't disabled, so quick successive clicks 232<p>The normal selection mechanism isn't disabled, so quick successive clicks
221might interfere with selection creation in harmless ways.</p> 233might interfere with selection creation in harmless ways.</p>
222<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 234<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
… …
291make them clickable. When middle-clicked, the program specified in the 303make them clickable. When middle-clicked, the program specified in the
292resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 304resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
293the URL as first argument. 305the URL as first argument.
294</dd> 306</dd>
295<p></p> 307<p></p>
308<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
309</dt>
310<dd>
311This (experimental) perl extension implements OnTheSpot editing. It does
312not work perfectly, and some input methods don't seem to work well with
313OnTheSpot editing in general, but it seems to work at leats for SCIM and
314kinput2.
315</dd>
316<dd>
317<p>You enable it by specifying this extension and a preedit style of
318<code>OnTheSpot</code>, i.e.:</p>
319</dd>
320<dd>
321<pre>
322 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
323</dd>
324<p></p>
296<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> 325<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
297</dt> 326</dt>
298<dd> 327<dd>
299This is basically a one-line extension that dynamically changes the background pixmap offset 328This 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 329to the window position, in effect creating the same effect as pseudo transparency with
… …
317</dt> 346</dt>
318<dd> 347<dd>
319Displays a digital clock using the built-in overlay. 348Displays a digital clock using the built-in overlay.
320</dd> 349</dd>
321<p></p> 350<p></p>
322<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 351<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
323</dt> 352</dt>
353<dd>
354Somewhat of a misnomer, this extension adds two menu entries to the
355selection popup that allows one ti run external commands to store the
356selection somewhere and fetch it again.
324<dd> 357</dd>
325Displays a very simple digital clock in the upper right corner of the 358<dd>
326window. Illustrates overwriting the refresh callbacks to create your own 359<p>We use it to implement a ``distributed selection mechanism'', which just
327overlays or changes. 360means that one command uploads the file to a remote server, and another
361reads it.</p>
362</dd>
363<dd>
364<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
365<code>URxvt.remote-selection.fetch</code> resources. The first should read the
366selection to store from STDIN (always in UTF-8), the second should provide
367the selection data on STDOUT (also in UTF-8).</p>
368</dd>
369<dd>
370<p>The defaults (which are likely useless to you) use rsh and cat:</p>
371</dd>
372<dd>
373<pre>
374 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
375 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
328</dd> 376</dd>
329<p></p> 377<p></p>
330<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> 378<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
331</dt> 379</dt>
332<dd> 380<dd>
… …
365for the filename):</p> 413for the filename):</p>
366</dd> 414</dd>
367<dd> 415<dd>
368<pre> 416<pre>
369 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> 417 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
418</dd>
419<p></p>
420<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
421</dt>
422<dd>
423Displays a very simple digital clock in the upper right corner of the
424window. Illustrates overwriting the refresh callbacks to create your own
425overlays or changes.
370</dd> 426</dd>
371<p></p></dl> 427<p></p></dl>
372<p> 428<p>
373</p> 429</p>
374<hr /> 430<hr />
… …
475</dd> 531</dd>
476<p></p> 532<p></p>
477<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> 533<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
478</dt> 534</dt>
479<dd> 535<dd>
480Called whenever something tries to destroy terminal, before doing anything 536Called whenever something tries to destroy terminal, when the terminal is
481yet. If this hook returns true, then destruction is skipped, but this is 537still fully functional (not for long, though).
482rarely a good idea.
483</dd> 538</dd>
484<p></p> 539<p></p>
485<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 540<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
486</dt> 541</dt>
487<dd> 542<dd>
… …
625</dt> 680</dt>
626<dd> 681<dd>
627Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 682Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
628</dd> 683</dd>
629<p></p> 684<p></p>
630<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 685<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
631</dt> 686</dt>
632<dd> 687<dd>
633Called whenever the user presses a key combination that has a 688Called 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> 689a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
635resource in the <code>rxvt(1)</code> manpage). 690resource in the <code>rxvt(1)</code> manpage).
691</dd>
692<dd>
693<p>The event is simply the action string. This interface is assumed to change
694slightly in the future.</p>
636</dd> 695</dd>
637<p></p> 696<p></p>
638<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 697<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
639</dt> 698</dt>
640<dd> 699<dd>
… …
777<p>Using this function has the advantage that its output ends up in the 836<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> 837correct place, e.g. on stderr of the connecting urxvtc client.</p>
779</dd> 838</dd>
780<dd> 839<dd>
781<p>Messages have a size limit of 1023 bytes currently.</p> 840<p>Messages have a size limit of 1023 bytes currently.</p>
841</dd>
842<p></p>
843<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
844</dt>
845<dd>
846Returns all urxvt::term objects that exist in this process, regardless of
847wether they are started, being destroyed etc., so be careful. Only term
848objects that have perl extensions attached will be returned (because there
849is no urxvt::term objet associated with others).
782</dd> 850</dd>
783<p></p> 851<p></p>
784<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 852<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
785</dt> 853</dt>
786<dd> 854<dd>
… …
897</dd> 965</dd>
898<dd> 966<dd>
899<p>Croaks (and probably outputs an error message) if the new instance 967<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 968couldn'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 969initialise 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> 970<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
971refer to global data (which is race free).</p>
903</dd> 972</dd>
904<p></p> 973<p></p>
905<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 974<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
906</dt> 975</dt>
907<dd> 976<dd>
… …
1197be used to suppress input and output handling to the pty/tty. See the 1266be 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 1267description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1199the previous value. 1268the previous value.
1200</dd> 1269</dd>
1201<p></p> 1270<p></p>
1271<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1272</dt>
1273<dd>
1274Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1275is used.
1276</dd>
1277<p></p>
1202<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1278<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1203</dt> 1279</dt>
1204<dd> 1280<dd>
1205Return the window id of the toplevel window. 1281Return the window id of the toplevel window.
1206</dd> 1282</dd>
… …
1325line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1401line, 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 1402to replace only parts of a line. The font index in the rendition will
1327automatically be updated.</p> 1403automatically be updated.</p>
1328</dd> 1404</dd>
1329<dd> 1405<dd>
1330<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use 1406<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> 1407than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1332characters. Characters with combining characters and other characters that 1408characters. Characters with combining characters and other characters that
1333do not fit into the normal tetx encoding will be replaced with characters 1409do not fit into the normal tetx encoding will be replaced with characters
1334in the private use area.</p> 1410in the private use area.</p>
1335</dd> 1411</dd>
1336<dd> 1412<dd>
… …
1435<dd> 1511<dd>
1436Converts rxvt-unicodes text reprsentation into a perl string. See 1512Converts rxvt-unicodes text reprsentation into a perl string. See
1437<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1513<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1438</dd> 1514</dd>
1439<p></p> 1515<p></p>
1440<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1516<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1441</dt> 1517</dt>
1518<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1519</dt>
1442<dd> 1520<dd>
1443Registers a synchronous button grab. See the XGrabButton manpage. 1521Register/unregister a synchronous button grab. See the XGrabButton
1522manpage.
1444</dd> 1523</dd>
1445<p></p> 1524<p></p>
1446<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1525<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1447</dt> 1526</dt>
1448<dd> 1527<dd>

Diff Legend

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