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.36 by root, Sat Jan 21 19:50:53 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>
… …
195was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 195was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
196additionally stores the first match in the current line into the primary 196additionally stores the first match in the current line into the primary
197selection.</p> 197selection.</p>
198</dd> 198</dd>
199<p></p> 199<p></p>
200<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
201</dt>
202<dd>
203A support package that tries to make editing with readline easier. At the
204moment, it reacts to clicking with the left mouse button by trying to
205move the text cursor to this position. It does so by generating as many
206cursor-left or cursor-right keypresses as required (the this only works
207for programs that correctly support wide characters).
208</dd>
209<dd>
210<p>To avoid too many false positives, this is only done when:</p>
211</dd>
212<dl>
213<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>
219</dl>
220<p>The normal selection mechanism isn't disabled, so quick successive clicks
221might interfere with selection creation in harmless ways.</p>
200<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 222<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
201</dt> 223</dt>
202<dd> 224<dd>
203This selection allows you to do automatic transforms on a selection 225This selection allows you to do automatic transforms on a selection
204whenever a selection is made. 226whenever a selection is made.
… …
255is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line 277is, 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 278displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
257button per tab. 279button per tab.
258</dd> 280</dd>
259<dd> 281<dd>
260<p>Clicking a button will activate that tab. Pressing Shift-Left and 282<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> 283<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>
262</dd> 285</dd>
263<p></p> 286<p></p>
264<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 287<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
265</dt> 288</dt>
266<dd> 289<dd>
… …
634focus out processing. 657focus out processing.
635</dd> 658</dd>
636<p></p> 659<p></p>
637<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> 660<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
638</dt> 661</dt>
662<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
663</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 /> 664<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> 665</dt>
641<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 666<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
642</dt> 667</dt>
643<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 668<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 679Called whenever the corresponding X event is received for the terminal If
655the hook returns true, then the even will be ignored by rxvt-unicode. 680the hook returns true, then the even will be ignored by rxvt-unicode.
656</dd> 681</dd>
657<dd> 682<dd>
658<p>The event is a hash with most values as named by Xlib (see the XEvent 683<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 684manpage), with the additional members <code>row</code> and <code>col</code>, which are the
660and column under the mouse cursor.</p> 685(real, not screen-based) row and column under the mouse cursor.</p>
661</dd> 686</dd>
662<dd> 687<dd>
663<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 688<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
664output, if any, in locale-specific encoding.</p> 689output, if any, in locale-specific encoding.</p>
665</dd> 690</dd>
… …
1141<p>Normally its not a good idea to use this function, as programs might be 1166<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 1167confused by changes in cursor position or scrolling. Its useful inside a
1143<code>on_add_lines</code> hook, though.</p> 1168<code>on_add_lines</code> hook, though.</p>
1144</dd> 1169</dd>
1145<p></p> 1170<p></p>
1171<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1172</dt>
1173<dd>
1174Switch to given screen - 0 primary, 1 secondary.
1175</dd>
1176<p></p>
1146<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1177<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1147</dt> 1178</dt>
1148<dd> 1179<dd>
1149Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1180Similar 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 1181locale-specific encoding of the terminal and can contain command sequences
… …
1245<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br /> 1276<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1246</dt> 1277</dt>
1247<dd> 1278<dd>
1248Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1279Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1249AltGr), the meta key (often Alt) and the num lock key, if applicable. 1280AltGr), the meta key (often Alt) and the num lock key, if applicable.
1281</dd>
1282<p></p>
1283<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1284</dt>
1285<dd>
1286Returns the currently displayed screen (0 primary, 1 secondary).
1287</dd>
1288<p></p>
1289<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1290</dt>
1291<dd>
1292Returns wether the cursor is currently hidden or not.
1250</dd> 1293</dd>
1251<p></p> 1294<p></p>
1252<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1295<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1253</dt> 1296</dt>
1254<dd> 1297<dd>
… …
1282line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1325line, 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 1326to replace only parts of a line. The font index in the rendition will
1284automatically be updated.</p> 1327automatically be updated.</p>
1285</dd> 1328</dd>
1286<dd> 1329<dd>
1287<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1330<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 1331more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code>
1289(<code>chr 65535</code>). Characters with combining characters and other characters 1332characters. Characters with combining characters and other characters that
1290that do not fit into the normal tetx encoding will be replaced with 1333do not fit into the normal tetx encoding will be replaced with characters
1291characters in the private use area.</p> 1334in the private use area.</p>
1292</dd> 1335</dd>
1293<dd> 1336<dd>
1294<p>You have to obey this encoding when changing text. The advantage is 1337<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 1338that <code>substr</code> and similar functions work on screen cells and not on
1296characters.</p> 1339characters.</p>
… …
1430</dt> 1473</dt>
1431<dd> 1474<dd>
1432Calls XUngrab for the most recent grab. Is called automatically on 1475Calls 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 1476evaluation errors, as it is better to lose the grab in the error case as
1434the session. 1477the session.
1478</dd>
1479<p></p>
1480<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1481</dt>
1482<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1483</dt>
1484<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1485</dt>
1486<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1487</dt>
1488<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1489</dt>
1490<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1491</dt>
1492<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1493</dt>
1494<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1495</dt>
1496<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1497</dt>
1498<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1499</dt>
1500<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1501</dt>
1502<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1503</dt>
1504<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1505</dt>
1506<dd>
1507Various X or X-related functions. The <code>$term</code> object only serves as
1508the source of the display, otherwise those functions map more-or-less
1509directory onto the X functions of the same name.
1435</dd> 1510</dd>
1436<p></p></dl> 1511<p></p></dl>
1437<p> 1512<p>
1438</p> 1513</p>
1439<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1514<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