… | |
… | |
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 |
|
|
127 | beginning of a line when they process multiple files. The following |
|
|
128 | pattern matches the filename (note, there is a single space at the very |
|
|
129 | end):</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 |
127 | interesting uses, such as parsing a line from beginning to end.</p> |
137 | interesting 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> |
… | |
… | |
150 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
160 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
151 | </dt> |
161 | </dt> |
152 | <dd> |
162 | <dd> |
153 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
163 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
154 | text into various other formats/action (such as uri unescaping, perl |
164 | text into various other formats/action (such as uri unescaping, perl |
155 | evalution, web-browser starting etc.), depending on content. |
165 | evaluation, web-browser starting etc.), depending on content. |
156 | </dd> |
166 | </dd> |
157 | <dd> |
167 | <dd> |
158 | <p>Other extensions can extend this popup menu by pushing a code reference |
168 | <p>Other extensions can extend this popup menu by pushing a code reference |
159 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
169 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
160 | popup is displayed.</p> |
170 | popup is displayed.</p> |
… | |
… | |
195 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
205 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
196 | additionally stores the first match in the current line into the primary |
206 | additionally stores the first match in the current line into the primary |
197 | selection.</p> |
207 | selection.</p> |
198 | </dd> |
208 | </dd> |
199 | <p></p> |
209 | <p></p> |
|
|
210 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
211 | </dt> |
|
|
212 | <dd> |
|
|
213 | A support package that tries to make editing with readline easier. At the |
|
|
214 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
215 | move the text cursor to this position. It does so by generating as many |
|
|
216 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
217 | for programs that correctly support wide characters). |
|
|
218 | </dd> |
|
|
219 | <dd> |
|
|
220 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
221 | </dd> |
|
|
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> |
|
|
229 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
230 | </dt> |
|
|
231 | </dl> |
|
|
232 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
233 | might interfere with selection creation in harmless ways.</p> |
200 | <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 /> |
201 | </dt> |
235 | </dt> |
202 | <dd> |
236 | <dd> |
203 | This selection allows you to do automatic transforms on a selection |
237 | This selection allows you to do automatic transforms on a selection |
204 | whenever a selection is made. |
238 | whenever a selection is made. |
… | |
… | |
255 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
289 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
256 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
290 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
257 | button per tab. |
291 | button per tab. |
258 | </dd> |
292 | </dd> |
259 | <dd> |
293 | <dd> |
260 | <p>Clicking a button will activate that tab. Pressing Shift-Left and |
294 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
261 | Shift-Right will switch to the tab left or right of the current one.</p> |
295 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
296 | while <strong>Shift-Down</strong> creates a new tab.</p> |
262 | </dd> |
297 | </dd> |
263 | <p></p> |
298 | <p></p> |
264 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
299 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
265 | </dt> |
300 | </dt> |
266 | <dd> |
301 | <dd> |
267 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
302 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
268 | make them clickable. When middle-clicked, the program specified in the |
303 | make them clickable. When middle-clicked, the program specified in the |
269 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
304 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
270 | the URL as first argument. |
305 | the URL as first argument. |
|
|
306 | </dd> |
|
|
307 | <p></p> |
|
|
308 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> |
|
|
309 | </dt> |
|
|
310 | <dd> |
|
|
311 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
312 | not work perfectly, and some input methods don't seem to work well with |
|
|
313 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
314 | kinput2. |
|
|
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> |
271 | </dd> |
323 | </dd> |
272 | <p></p> |
324 | <p></p> |
273 | <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 /> |
274 | </dt> |
326 | </dt> |
275 | <dd> |
327 | <dd> |
… | |
… | |
452 | </dd> |
504 | </dd> |
453 | <p></p> |
505 | <p></p> |
454 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
506 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
455 | </dt> |
507 | </dt> |
456 | <dd> |
508 | <dd> |
457 | Called whenever something tries to destroy terminal, before doing anything |
509 | Called whenever something tries to destroy terminal, when the terminal is |
458 | yet. If this hook returns true, then destruction is skipped, but this is |
510 | still fully functional (not for long, though). |
459 | rarely a good idea. |
|
|
460 | </dd> |
511 | </dd> |
461 | <p></p> |
512 | <p></p> |
462 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
513 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
463 | </dt> |
514 | </dt> |
464 | <dd> |
515 | <dd> |
… | |
… | |
634 | focus out processing. |
685 | focus out processing. |
635 | </dd> |
686 | </dd> |
636 | <p></p> |
687 | <p></p> |
637 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
688 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
638 | </dt> |
689 | </dt> |
|
|
690 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
691 | </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 /> |
692 | <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> |
693 | </dt> |
641 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
694 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
642 | </dt> |
695 | </dt> |
643 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
696 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
… | |
… | |
654 | Called whenever the corresponding X event is received for the terminal If |
707 | Called whenever the corresponding X event is received for the terminal If |
655 | the hook returns true, then the even will be ignored by rxvt-unicode. |
708 | the hook returns true, then the even will be ignored by rxvt-unicode. |
656 | </dd> |
709 | </dd> |
657 | <dd> |
710 | <dd> |
658 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
711 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
659 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
712 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
660 | and column under the mouse cursor.</p> |
713 | (real, not screen-based) row and column under the mouse cursor.</p> |
661 | </dd> |
714 | </dd> |
662 | <dd> |
715 | <dd> |
663 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
716 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
664 | output, if any, in locale-specific encoding.</p> |
717 | output, if any, in locale-specific encoding.</p> |
665 | </dd> |
718 | </dd> |
… | |
… | |
1141 | <p>Normally its not a good idea to use this function, as programs might be |
1194 | <p>Normally its not a good idea to use this function, as programs might be |
1142 | confused by changes in cursor position or scrolling. Its useful inside a |
1195 | confused by changes in cursor position or scrolling. Its useful inside a |
1143 | <code>on_add_lines</code> hook, though.</p> |
1196 | <code>on_add_lines</code> hook, though.</p> |
1144 | </dd> |
1197 | </dd> |
1145 | <p></p> |
1198 | <p></p> |
|
|
1199 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1200 | </dt> |
|
|
1201 | <dd> |
|
|
1202 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1203 | </dd> |
|
|
1204 | <p></p> |
1146 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1205 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1147 | </dt> |
1206 | </dt> |
1148 | <dd> |
1207 | <dd> |
1149 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1208 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1150 | locale-specific encoding of the terminal and can contain command sequences |
1209 | locale-specific encoding of the terminal and can contain command sequences |
… | |
… | |
1166 | be used to suppress input and output handling to the pty/tty. See the |
1225 | be used to suppress input and output handling to the pty/tty. See the |
1167 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1226 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1168 | the previous value. |
1227 | the previous value. |
1169 | </dd> |
1228 | </dd> |
1170 | <p></p> |
1229 | <p></p> |
|
|
1230 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong><br /> |
|
|
1231 | </dt> |
|
|
1232 | <dd> |
|
|
1233 | Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1234 | is used. |
|
|
1235 | </dd> |
|
|
1236 | <p></p> |
1171 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1237 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1172 | </dt> |
1238 | </dt> |
1173 | <dd> |
1239 | <dd> |
1174 | Return the window id of the toplevel window. |
1240 | Return the window id of the toplevel window. |
1175 | </dd> |
1241 | </dd> |
… | |
… | |
1245 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
1311 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
1246 | </dt> |
1312 | </dt> |
1247 | <dd> |
1313 | <dd> |
1248 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1314 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1249 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1315 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1316 | </dd> |
|
|
1317 | <p></p> |
|
|
1318 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1319 | </dt> |
|
|
1320 | <dd> |
|
|
1321 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1322 | </dd> |
|
|
1323 | <p></p> |
|
|
1324 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1325 | </dt> |
|
|
1326 | <dd> |
|
|
1327 | Returns wether the cursor is currently hidden or not. |
1250 | </dd> |
1328 | </dd> |
1251 | <p></p> |
1329 | <p></p> |
1252 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1330 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1253 | </dt> |
1331 | </dt> |
1254 | <dd> |
1332 | <dd> |
… | |
… | |
1283 | to replace only parts of a line. The font index in the rendition will |
1361 | to replace only parts of a line. The font index in the rendition will |
1284 | automatically be updated.</p> |
1362 | automatically be updated.</p> |
1285 | </dd> |
1363 | </dd> |
1286 | <dd> |
1364 | <dd> |
1287 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1365 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1288 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1366 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
1289 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1367 | characters. Characters with combining characters and other characters that |
1290 | that do not fit into the normal tetx encoding will be replaced with |
1368 | do not fit into the normal tetx encoding will be replaced with characters |
1291 | characters in the private use area.</p> |
1369 | in the private use area.</p> |
1292 | </dd> |
1370 | </dd> |
1293 | <dd> |
1371 | <dd> |
1294 | <p>You have to obey this encoding when changing text. The advantage is |
1372 | <p>You have to obey this encoding when changing text. The advantage is |
1295 | that <code>substr</code> and similar functions work on screen cells and not on |
1373 | that <code>substr</code> and similar functions work on screen cells and not on |
1296 | characters.</p> |
1374 | characters.</p> |
… | |
… | |
1430 | </dt> |
1508 | </dt> |
1431 | <dd> |
1509 | <dd> |
1432 | Calls XUngrab for the most recent grab. Is called automatically on |
1510 | Calls XUngrab for the most recent grab. Is called automatically on |
1433 | evaluation errors, as it is better to lose the grab in the error case as |
1511 | evaluation errors, as it is better to lose the grab in the error case as |
1434 | the session. |
1512 | the session. |
|
|
1513 | </dd> |
|
|
1514 | <p></p> |
|
|
1515 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1516 | </dt> |
|
|
1517 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1518 | </dt> |
|
|
1519 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1520 | </dt> |
|
|
1521 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1522 | </dt> |
|
|
1523 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1524 | </dt> |
|
|
1525 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1526 | </dt> |
|
|
1527 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1528 | </dt> |
|
|
1529 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1530 | </dt> |
|
|
1531 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1532 | </dt> |
|
|
1533 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1534 | </dt> |
|
|
1535 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1536 | </dt> |
|
|
1537 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1538 | </dt> |
|
|
1539 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1540 | </dt> |
|
|
1541 | <dd> |
|
|
1542 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1543 | the source of the display, otherwise those functions map more-or-less |
|
|
1544 | directory onto the X functions of the same name. |
1435 | </dd> |
1545 | </dd> |
1436 | <p></p></dl> |
1546 | <p></p></dl> |
1437 | <p> |
1547 | <p> |
1438 | </p> |
1548 | </p> |
1439 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1549 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |