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.34 by root, Fri Jan 20 16:02:20 2006 UTC vs.
Revision 1.35 by root, Fri Jan 20 22:49:34 2006 UTC

… …
150<dt><strong>selection-popup (enabled by default)</strong><br /> 150<dt><strong>selection-popup (enabled by default)</strong><br />
151</dt> 151</dt>
152<dd> 152<dd>
153Binds a popup menu to Ctrl-Button3 that lets you convert the selection 153Binds a popup menu to Ctrl-Button3 that lets you convert the selection
154text into various other formats/action (such as uri unescaping, perl 154text into various other formats/action (such as uri unescaping, perl
155evalution, web-browser starting etc.), depending on content. 155evaluation, web-browser starting etc.), depending on content.
156</dd> 156</dd>
157<dd> 157<dd>
158<p>Other extensions can extend this popup menu by pushing a code reference 158<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 159onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
160popup is displayed.</p> 160popup is displayed.</p>
… …
246<p>The first line tells the selection code to treat the unchanging part of 246<p>The first line tells the selection code to treat the unchanging part of
247every error message as a selection pattern, and the second line transforms 247every error message as a selection pattern, and the second line transforms
248the message into vi commands to load the file.</p> 248the message into vi commands to load the file.</p>
249</dd> 249</dd>
250<p></p> 250<p></p>
251<dt><strong><a name="item_readline">readline</a></strong><br />
252</dt>
253<dd>
254A support package that tries to make editing with readline easier. At the
255moment, it reacts to clicking with the left mouse button by trying to
256move the text cursor to this position. It does so by generating as many
257cursor-left or cursor-right keypresses as required (the this only works
258for programs that correctly support wide characters).
259</dd>
260<dd>
261<p>It only works when clicking into the same line (possibly extended over
262multiple rows) as the text cursor and on the primary screen, to reduce the
263risk of misinterpreting. The normal selection isn't disabled, so quick
264successive clicks might interfere with selection creation in harmless
265ways.</p>
266</dd>
267<p></p>
251<dt><strong><a name="item_tabbed">tabbed</a></strong><br /> 268<dt><strong><a name="item_tabbed">tabbed</a></strong><br />
252</dt> 269</dt>
253<dd> 270<dd>
254This transforms the terminal into a tabbar with additional terminals, that 271This transforms the terminal into a tabbar with additional terminals, that
255is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line 272is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
256displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one 273displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
257button per tab. 274button per tab.
258</dd> 275</dd>
259<dd> 276<dd>
260<p>Clicking a button will activate that tab. Pressing Shift-Left and 277<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
261Shift-Right will switch to the tab left or right of the current one.</p> 278<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
279while <strong>Shift-Down</strong> creates a new tab.</p>
262</dd> 280</dd>
263<p></p> 281<p></p>
264<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 282<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
265</dt> 283</dt>
266<dd> 284<dd>
… …
634focus out processing. 652focus out processing.
635</dd> 653</dd>
636<p></p> 654<p></p>
637<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> 655<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
638</dt> 656</dt>
657<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
658</dt>
639<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 659<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
640</dt> 660</dt>
641<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 661<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
642</dt> 662</dt>
643<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 663<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
… …
654Called whenever the corresponding X event is received for the terminal If 674Called whenever the corresponding X event is received for the terminal If
655the hook returns true, then the even will be ignored by rxvt-unicode. 675the hook returns true, then the even will be ignored by rxvt-unicode.
656</dd> 676</dd>
657<dd> 677<dd>
658<p>The event is a hash with most values as named by Xlib (see the XEvent 678<p>The event is a hash with most values as named by Xlib (see the XEvent
659manpage), with the additional members <code>row</code> and <code>col</code>, which are the row 679manpage), with the additional members <code>row</code> and <code>col</code>, which are the
660and column under the mouse cursor.</p> 680(real, not screen-based) row and column under the mouse cursor.</p>
661</dd> 681</dd>
662<dd> 682<dd>
663<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 683<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
664output, if any, in locale-specific encoding.</p> 684output, if any, in locale-specific encoding.</p>
665</dd> 685</dd>
… …
1141<p>Normally its not a good idea to use this function, as programs might be 1161<p>Normally its not a good idea to use this function, as programs might be
1142confused by changes in cursor position or scrolling. Its useful inside a 1162confused by changes in cursor position or scrolling. Its useful inside a
1143<code>on_add_lines</code> hook, though.</p> 1163<code>on_add_lines</code> hook, though.</p>
1144</dd> 1164</dd>
1145<p></p> 1165<p></p>
1166<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1167</dt>
1168<dd>
1169Switch to given screen - 0 primary, 1 secondary.
1170</dd>
1171<p></p>
1146<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1172<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1147</dt> 1173</dt>
1148<dd> 1174<dd>
1149Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1175Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1150locale-specific encoding of the terminal and can contain command sequences 1176locale-specific encoding of the terminal and can contain command sequences
… …
1245<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br /> 1271<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1246</dt> 1272</dt>
1247<dd> 1273<dd>
1248Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1274Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1249AltGr), the meta key (often Alt) and the num lock key, if applicable. 1275AltGr), the meta key (often Alt) and the num lock key, if applicable.
1276</dd>
1277<p></p>
1278<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1279</dt>
1280<dd>
1281Returns the currently displayed screen (0 primary, 1 secondary).
1250</dd> 1282</dd>
1251<p></p> 1283<p></p>
1252<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1284<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1253</dt> 1285</dt>
1254<dd> 1286<dd>
… …
1282line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1314line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
1283to replace only parts of a line. The font index in the rendition will 1315to replace only parts of a line. The font index in the rendition will
1284automatically be updated.</p> 1316automatically be updated.</p>
1285</dd> 1317</dd>
1286<dd> 1318<dd>
1287<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1319<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use
1288than one cell when displayed are padded with urxvt::NOCHAR characters 1320more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code>
1289(<code>chr 65535</code>). Characters with combining characters and other characters 1321characters. Characters with combining characters and other characters that
1290that do not fit into the normal tetx encoding will be replaced with 1322do not fit into the normal tetx encoding will be replaced with characters
1291characters in the private use area.</p> 1323in the private use area.</p>
1292</dd> 1324</dd>
1293<dd> 1325<dd>
1294<p>You have to obey this encoding when changing text. The advantage is 1326<p>You have to obey this encoding when changing text. The advantage is
1295that <code>substr</code> and similar functions work on screen cells and not on 1327that <code>substr</code> and similar functions work on screen cells and not on
1296characters.</p> 1328characters.</p>
… …
1430</dt> 1462</dt>
1431<dd> 1463<dd>
1432Calls XUngrab for the most recent grab. Is called automatically on 1464Calls XUngrab for the most recent grab. Is called automatically on
1433evaluation errors, as it is better to lose the grab in the error case as 1465evaluation errors, as it is better to lose the grab in the error case as
1434the session. 1466the session.
1467</dd>
1468<p></p>
1469<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1470</dt>
1471<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1472</dt>
1473<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1474</dt>
1475<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1476</dt>
1477<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1478</dt>
1479<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1480</dt>
1481<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1482</dt>
1483<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1484</dt>
1485<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1486</dt>
1487<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1488</dt>
1489<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1490</dt>
1491<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1492</dt>
1493<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1494</dt>
1495<dd>
1496Various X or X-related functions. The <code>$term</code> object only serves as
1497the source of the display, otherwise those functions map more-or-less
1498directory onto the X functions of the same name.
1435</dd> 1499</dd>
1436<p></p></dl> 1500<p></p></dl>
1437<p> 1501<p>
1438</p> 1502</p>
1439<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1503<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>

Diff Legend

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