1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
229 | runtime. |
229 | runtime. |
230 | .IP "selection-popup (enabled by default)" 4 |
230 | .IP "selection-popup (enabled by default)" 4 |
231 | .IX Item "selection-popup (enabled by default)" |
231 | .IX Item "selection-popup (enabled by default)" |
232 | Binds a popup menu to Ctrl\-Button3 that lets you convert the selection |
232 | Binds a popup menu to Ctrl\-Button3 that lets you convert the selection |
233 | text into various other formats/action (such as uri unescaping, perl |
233 | text into various other formats/action (such as uri unescaping, perl |
234 | evalution, web-browser starting etc.), depending on content. |
234 | evaluation, web-browser starting etc.), depending on content. |
235 | .Sp |
235 | .Sp |
236 | Other extensions can extend this popup menu by pushing a code reference |
236 | Other extensions can extend this popup menu by pushing a code reference |
237 | onto \f(CW\*(C`@{ $term\-\*(C'\fR{selection_popup_hook} }>, that is called whenever the |
237 | onto \f(CW\*(C`@{ $term\-\*(C'\fR{selection_popup_hook} }>, that is called whenever the |
238 | popup is displayed. |
238 | popup is displayed. |
239 | .Sp |
239 | .Sp |
… | |
… | |
307 | .Ve |
307 | .Ve |
308 | .Sp |
308 | .Sp |
309 | The first line tells the selection code to treat the unchanging part of |
309 | The first line tells the selection code to treat the unchanging part of |
310 | every error message as a selection pattern, and the second line transforms |
310 | every error message as a selection pattern, and the second line transforms |
311 | the message into vi commands to load the file. |
311 | the message into vi commands to load the file. |
|
|
312 | .IP "readline" 4 |
|
|
313 | .IX Item "readline" |
|
|
314 | A support package that tries to make editing with readline easier. At the |
|
|
315 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
316 | move the text cursor to this position. It does so by generating as many |
|
|
317 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
318 | for programs that correctly support wide characters). |
|
|
319 | .Sp |
|
|
320 | It only works when clicking into the same line (possibly extended over |
|
|
321 | multiple rows) as the text cursor and on the primary screen, to reduce the |
|
|
322 | risk of misinterpreting. The normal selection isn't disabled, so quick |
|
|
323 | successive clicks might interfere with selection creation in harmless |
|
|
324 | ways. |
312 | .IP "tabbed" 4 |
325 | .IP "tabbed" 4 |
313 | .IX Item "tabbed" |
326 | .IX Item "tabbed" |
314 | This transforms the terminal into a tabbar with additional terminals, that |
327 | This transforms the terminal into a tabbar with additional terminals, that |
315 | is, it implements what is commonly refered to as \*(L"tabbed terminal\*(R". The topmost line |
328 | is, it implements what is commonly refered to as \*(L"tabbed terminal\*(R". The topmost line |
316 | displays a \*(L"[\s-1NEW\s0]\*(R" button, which, when clicked, will add a new tab, followed by one |
329 | displays a \*(L"[\s-1NEW\s0]\*(R" button, which, when clicked, will add a new tab, followed by one |
317 | button per tab. |
330 | button per tab. |
318 | .Sp |
331 | .Sp |
319 | Clicking a button will activate that tab. Pressing Shift-Left and |
332 | Clicking a button will activate that tab. Pressing \fBShift-Left\fR and |
320 | Shift-Right will switch to the tab left or right of the current one. |
333 | \&\fBShift-Right\fR will switch to the tab left or right of the current one, |
|
|
334 | while \fBShift-Down\fR creates a new tab. |
321 | .IP "mark-urls" 4 |
335 | .IP "mark-urls" 4 |
322 | .IX Item "mark-urls" |
336 | .IX Item "mark-urls" |
323 | Uses per-line display filtering (\f(CW\*(C`on_line_update\*(C'\fR) to underline urls and |
337 | Uses per-line display filtering (\f(CW\*(C`on_line_update\*(C'\fR) to underline urls and |
324 | make them clickable. When middle\-clicked, the program specified in the |
338 | make them clickable. When middle\-clicked, the program specified in the |
325 | resource \f(CW\*(C`urlLauncher\*(C'\fR (default \f(CW\*(C`x\-www\-browser\*(C'\fR) will be started with |
339 | resource \f(CW\*(C`urlLauncher\*(C'\fR (default \f(CW\*(C`x\-www\-browser\*(C'\fR) will be started with |
… | |
… | |
605 | focus out processing. |
619 | focus out processing. |
606 | .ie n .IP "on_configure_notify $term\fR, \f(CW$event" 4 |
620 | .ie n .IP "on_configure_notify $term\fR, \f(CW$event" 4 |
607 | .el .IP "on_configure_notify \f(CW$term\fR, \f(CW$event\fR" 4 |
621 | .el .IP "on_configure_notify \f(CW$term\fR, \f(CW$event\fR" 4 |
608 | .IX Item "on_configure_notify $term, $event" |
622 | .IX Item "on_configure_notify $term, $event" |
609 | .PD 0 |
623 | .PD 0 |
|
|
624 | .ie n .IP "on_property_notify $term\fR, \f(CW$event" 4 |
|
|
625 | .el .IP "on_property_notify \f(CW$term\fR, \f(CW$event\fR" 4 |
|
|
626 | .IX Item "on_property_notify $term, $event" |
610 | .ie n .IP "on_key_press $term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets" 4 |
627 | .ie n .IP "on_key_press $term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets" 4 |
611 | .el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4 |
628 | .el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4 |
612 | .IX Item "on_key_press $term, $event, $keysym, $octets" |
629 | .IX Item "on_key_press $term, $event, $keysym, $octets" |
613 | .ie n .IP "on_key_release $term\fR, \f(CW$event\fR, \f(CW$keysym" 4 |
630 | .ie n .IP "on_key_release $term\fR, \f(CW$event\fR, \f(CW$keysym" 4 |
614 | .el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4 |
631 | .el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4 |
… | |
… | |
631 | .PD |
648 | .PD |
632 | Called whenever the corresponding X event is received for the terminal If |
649 | Called whenever the corresponding X event is received for the terminal If |
633 | the hook returns true, then the even will be ignored by rxvt\-unicode. |
650 | the hook returns true, then the even will be ignored by rxvt\-unicode. |
634 | .Sp |
651 | .Sp |
635 | The event is a hash with most values as named by Xlib (see the XEvent |
652 | The event is a hash with most values as named by Xlib (see the XEvent |
636 | manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*(C'\fR, which are the row |
653 | manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*(C'\fR, which are the |
637 | and column under the mouse cursor. |
654 | (real, not screen\-based) row and column under the mouse cursor. |
638 | .Sp |
655 | .Sp |
639 | \&\f(CW\*(C`on_key_press\*(C'\fR additionally receives the string rxvt-unicode would |
656 | \&\f(CW\*(C`on_key_press\*(C'\fR additionally receives the string rxvt-unicode would |
640 | output, if any, in locale-specific encoding. |
657 | output, if any, in locale-specific encoding. |
641 | .Sp |
658 | .Sp |
642 | subwindow. |
659 | subwindow. |
… | |
… | |
997 | string is a normal text string, not in locale-dependent encoding. |
1014 | string is a normal text string, not in locale-dependent encoding. |
998 | .Sp |
1015 | .Sp |
999 | Normally its not a good idea to use this function, as programs might be |
1016 | Normally its not a good idea to use this function, as programs might be |
1000 | confused by changes in cursor position or scrolling. Its useful inside a |
1017 | confused by changes in cursor position or scrolling. Its useful inside a |
1001 | \&\f(CW\*(C`on_add_lines\*(C'\fR hook, though. |
1018 | \&\f(CW\*(C`on_add_lines\*(C'\fR hook, though. |
|
|
1019 | .IP "$term\->scr_change_screen ($screen)" 4 |
|
|
1020 | .IX Item "$term->scr_change_screen ($screen)" |
|
|
1021 | Switch to given screen \- 0 primary, 1 secondary. |
1002 | .IP "$term\->cmd_parse ($octets)" 4 |
1022 | .IP "$term\->cmd_parse ($octets)" 4 |
1003 | .IX Item "$term->cmd_parse ($octets)" |
1023 | .IX Item "$term->cmd_parse ($octets)" |
1004 | Similar to \f(CW\*(C`scr_add_lines\*(C'\fR, but the argument must be in the |
1024 | Similar to \f(CW\*(C`scr_add_lines\*(C'\fR, but the argument must be in the |
1005 | locale-specific encoding of the terminal and can contain command sequences |
1025 | locale-specific encoding of the terminal and can contain command sequences |
1006 | (escape codes) that will be interpreted. |
1026 | (escape codes) that will be interpreted. |
… | |
… | |
1095 | .el .IP "$modifiermask = \f(CW$term\fR\->ModNumLockMask" 4 |
1115 | .el .IP "$modifiermask = \f(CW$term\fR\->ModNumLockMask" 4 |
1096 | .IX Item "$modifiermask = $term->ModNumLockMask" |
1116 | .IX Item "$modifiermask = $term->ModNumLockMask" |
1097 | .PD |
1117 | .PD |
1098 | Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often |
1118 | Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often |
1099 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1119 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1120 | .ie n .IP "$screen = $term\->current_screen" 4 |
|
|
1121 | .el .IP "$screen = \f(CW$term\fR\->current_screen" 4 |
|
|
1122 | .IX Item "$screen = $term->current_screen" |
|
|
1123 | Returns the currently displayed screen (0 primary, 1 secondary). |
1100 | .ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4 |
1124 | .ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4 |
1101 | .el .IP "$view_start = \f(CW$term\fR\->view_start ([$newvalue])" 4 |
1125 | .el .IP "$view_start = \f(CW$term\fR\->view_start ([$newvalue])" 4 |
1102 | .IX Item "$view_start = $term->view_start ([$newvalue])" |
1126 | .IX Item "$view_start = $term->view_start ([$newvalue])" |
1103 | Returns the row number of the topmost displayed line. Maximum value is |
1127 | Returns the row number of the topmost displayed line. Maximum value is |
1104 | \&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll |
1128 | \&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll |
… | |
… | |
1122 | If \f(CW$new_text\fR is specified, it will replace characters in the current |
1146 | If \f(CW$new_text\fR is specified, it will replace characters in the current |
1123 | line, starting at column \f(CW$start_col\fR (default \f(CW0\fR), which is useful |
1147 | line, starting at column \f(CW$start_col\fR (default \f(CW0\fR), which is useful |
1124 | to replace only parts of a line. The font index in the rendition will |
1148 | to replace only parts of a line. The font index in the rendition will |
1125 | automatically be updated. |
1149 | automatically be updated. |
1126 | .Sp |
1150 | .Sp |
1127 | \&\f(CW$text\fR is in a special encoding: tabs and wide characters that use more |
1151 | \&\f(CW$text\fR is in a special encoding: tabs and wide characters that use |
1128 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1152 | more than one cell when displayed are padded with \f(CW$urxvt::NOCHAR\fR |
1129 | (\f(CW\*(C`chr 65535\*(C'\fR). Characters with combining characters and other characters |
1153 | characters. Characters with combining characters and other characters that |
1130 | that do not fit into the normal tetx encoding will be replaced with |
1154 | do not fit into the normal tetx encoding will be replaced with characters |
1131 | characters in the private use area. |
1155 | in the private use area. |
1132 | .Sp |
1156 | .Sp |
1133 | You have to obey this encoding when changing text. The advantage is |
1157 | You have to obey this encoding when changing text. The advantage is |
1134 | that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on |
1158 | that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on |
1135 | characters. |
1159 | characters. |
1136 | .Sp |
1160 | .Sp |
… | |
… | |
1233 | .IP "$term\->ungrab" 4 |
1257 | .IP "$term\->ungrab" 4 |
1234 | .IX Item "$term->ungrab" |
1258 | .IX Item "$term->ungrab" |
1235 | Calls XUngrab for the most recent grab. Is called automatically on |
1259 | Calls XUngrab for the most recent grab. Is called automatically on |
1236 | evaluation errors, as it is better to lose the grab in the error case as |
1260 | evaluation errors, as it is better to lose the grab in the error case as |
1237 | the session. |
1261 | the session. |
|
|
1262 | .ie n .IP "$atom = $term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists])" 4 |
|
|
1263 | .el .IP "$atom = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4 |
|
|
1264 | .IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])" |
|
|
1265 | .PD 0 |
|
|
1266 | .ie n .IP "$atom_name = $term\->XGetAtomName ($atom)" 4 |
|
|
1267 | .el .IP "$atom_name = \f(CW$term\fR\->XGetAtomName ($atom)" 4 |
|
|
1268 | .IX Item "$atom_name = $term->XGetAtomName ($atom)" |
|
|
1269 | .ie n .IP "@atoms = $term\->XListProperties ($window)" 4 |
|
|
1270 | .el .IP "@atoms = \f(CW$term\fR\->XListProperties ($window)" 4 |
|
|
1271 | .IX Item "@atoms = $term->XListProperties ($window)" |
|
|
1272 | .ie n .IP "($type,$format,$octets) = $term\fR\->XGetWindowProperty ($window, \f(CW$property)" 4 |
|
|
1273 | .el .IP "($type,$format,$octets) = \f(CW$term\fR\->XGetWindowProperty ($window, \f(CW$property\fR)" 4 |
|
|
1274 | .IX Item "($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)" |
|
|
1275 | .ie n .IP "$term\->XChangeWindowProperty ($window, $property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets)" 4 |
|
|
1276 | .el .IP "$term\->XChangeWindowProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets\fR)" 4 |
|
|
1277 | .IX Item "$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)" |
|
|
1278 | .ie n .IP "$term\->XDeleteProperty ($window, $property)" 4 |
|
|
1279 | .el .IP "$term\->XDeleteProperty ($window, \f(CW$property\fR)" 4 |
|
|
1280 | .IX Item "$term->XDeleteProperty ($window, $property)" |
|
|
1281 | .ie n .IP "$window = $term\->DefaultRootWindow" 4 |
|
|
1282 | .el .IP "$window = \f(CW$term\fR\->DefaultRootWindow" 4 |
|
|
1283 | .IX Item "$window = $term->DefaultRootWindow" |
|
|
1284 | .ie n .IP "$term\->XReparentWindow ($window, $parent\fR, [$x, \f(CW$y])" 4 |
|
|
1285 | .el .IP "$term\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y\fR])" 4 |
|
|
1286 | .IX Item "$term->XReparentWindow ($window, $parent, [$x, $y])" |
|
|
1287 | .IP "$term\->XMapWindow ($window)" 4 |
|
|
1288 | .IX Item "$term->XMapWindow ($window)" |
|
|
1289 | .IP "$term\->XUnmapWindow ($window)" 4 |
|
|
1290 | .IX Item "$term->XUnmapWindow ($window)" |
|
|
1291 | .ie n .IP "$term\->XMoveResizeWindow ($window, $x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height)" 4 |
|
|
1292 | .el .IP "$term\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR)" 4 |
|
|
1293 | .IX Item "$term->XMoveResizeWindow ($window, $x, $y, $width, $height)" |
|
|
1294 | .ie n .IP "($x, $y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y)" 4 |
|
|
1295 | .el .IP "($x, \f(CW$y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y\fR)" 4 |
|
|
1296 | .IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)" |
|
|
1297 | .ie n .IP "$term\->XChangeInput ($window, $add_events\fR[, \f(CW$del_events])" 4 |
|
|
1298 | .el .IP "$term\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4 |
|
|
1299 | .IX Item "$term->XChangeInput ($window, $add_events[, $del_events])" |
|
|
1300 | .PD |
|
|
1301 | Various X or X\-related functions. The \f(CW$term\fR object only serves as |
|
|
1302 | the source of the display, otherwise those functions map more-or-less |
|
|
1303 | directory onto the X functions of the same name. |
1238 | .ie n .Sh "The ""urxvt::popup"" Class" |
1304 | .ie n .Sh "The ""urxvt::popup"" Class" |
1239 | .el .Sh "The \f(CWurxvt::popup\fP Class" |
1305 | .el .Sh "The \f(CWurxvt::popup\fP Class" |
1240 | .IX Subsection "The urxvt::popup Class" |
1306 | .IX Subsection "The urxvt::popup Class" |
1241 | .IP "$popup\->add_title ($title)" 4 |
1307 | .IP "$popup\->add_title ($title)" 4 |
1242 | .IX Item "$popup->add_title ($title)" |
1308 | .IX Item "$popup->add_title ($title)" |