ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.man.in (file contents):
Revision 1.79 by sf-exg, Fri Nov 18 14:14:41 2011 UTC vs.
Revision 1.80 by root, Mon Dec 5 15:08:31 2011 UTC

… …
122.\} 122.\}
123.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
124.\" ======================================================================== 124.\" ========================================================================
125.\" 125.\"
126.IX Title "@@RXVT_NAME@@ 3" 126.IX Title "@@RXVT_NAME@@ 3"
127.TH @@RXVT_NAME@@ 3 "2011-11-18" "@@RXVT_VERSION@@" "RXVT-UNICODE" 127.TH @@RXVT_NAME@@ 3 "2011-12-05" "@@RXVT_VERSION@@" "RXVT-UNICODE"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
130.if n .ad l 130.if n .ad l
131.nh 131.nh
132.SH "NAME" 132.SH "NAME"
… …
547overlays or changes. 547overlays or changes.
548.IP "confirm-paste" 4 548.IP "confirm-paste" 4
549.IX Item "confirm-paste" 549.IX Item "confirm-paste"
550Displays a confirmation dialog when a paste containing at least a full 550Displays a confirmation dialog when a paste containing at least a full
551line is detected. 551line is detected.
552.IP "bell-command" 4
553.IX Item "bell-command"
554Runs the command specified by the \f(CW\*(C`URxvt.bell\-command\*(C'\fR resource when
555a bell event occurs. For example, the following pops up a notification
556bubble with the text \*(L"Beep, Beep\*(R" using notify-send:
557.Sp
558.Vb 1
559\& URxvt.bell\-command: notify\-send "Beep, Beep"
560.Ve
552.SH "API DOCUMENTATION" 561.SH "API DOCUMENTATION"
553.IX Header "API DOCUMENTATION" 562.IX Header "API DOCUMENTATION"
554.SS "General \s-1API\s0 Considerations" 563.SS "General \s-1API\s0 Considerations"
555.IX Subsection "General API Considerations" 564.IX Subsection "General API Considerations"
556All objects (such as terminals, time watchers etc.) are typical 565All objects (such as terminals, time watchers etc.) are typical
… …
580.ie n .IP "$octets" 4 589.ie n .IP "$octets" 4
581.el .IP "\f(CW$octets\fR" 4 590.el .IP "\f(CW$octets\fR" 4
582.IX Item "$octets" 591.IX Item "$octets"
583Either binary data or \- more common \- a text string encoded in a 592Either binary data or \- more common \- a text string encoded in a
584locale-specific way. 593locale-specific way.
594.ie n .IP "$keysym" 4
595.el .IP "\f(CW$keysym\fR" 4
596.IX Item "$keysym"
597an integer that is a valid X11 keysym code. You can convert a string
598into a keysym and viceversa by using \f(CW\*(C`XStringToKeysym\*(C'\fR and
599\&\f(CW\*(C`XKeysymToString\*(C'\fR.
585.SS "Extension Objects" 600.SS "Extension Objects"
586.IX Subsection "Extension Objects" 601.IX Subsection "Extension Objects"
587Every perl extension is a perl class. A separate perl object is created 602Every perl extension is a perl class. A separate perl object is created
588for each terminal, and each terminal has its own set of extension objects, 603for each terminal, and each terminal has its own set of extension objects,
589which are passed as the first parameter to hooks. So extensions can use 604which are passed as the first parameter to hooks. So extensions can use
… …
792a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR 807a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR
793resource in the @@RXVT_NAME@@(1) manpage). 808resource in the @@RXVT_NAME@@(1) manpage).
794.Sp 809.Sp
795The event is simply the action string. This interface is assumed to change 810The event is simply the action string. This interface is assumed to change
796slightly in the future. 811slightly in the future.
812.ie n .IP "on_register_command $term, $keysym, $modifiermask, $string" 4
813.el .IP "on_register_command \f(CW$term\fR, \f(CW$keysym\fR, \f(CW$modifiermask\fR, \f(CW$string\fR" 4
814.IX Item "on_register_command $term, $keysym, $modifiermask, $string"
815Called after parsing a keysym resource but before registering the
816associated binding. If this hook returns \s-1TRUE\s0 the binding is not
817registered. It can be used to modify a binding by calling
818\&\f(CW\*(C`register_command\*(C'\fR.
797.ie n .IP "on_resize_all_windows $term, $new_width, $new_height" 4 819.ie n .IP "on_resize_all_windows $term, $new_width, $new_height" 4
798.el .IP "on_resize_all_windows \f(CW$term\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4 820.el .IP "on_resize_all_windows \f(CW$term\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4
799.IX Item "on_resize_all_windows $term, $new_width, $new_height" 821.IX Item "on_resize_all_windows $term, $new_width, $new_height"
800Called just after the new window size has been calculated, but before 822Called just after the new window size has been calculated, but before
801windows are actually being resized or hints are being set. If this hook 823windows are actually being resized or hints are being set. If this hook
… …
1118resource with that pattern exists. 1140resource with that pattern exists.
1119.Sp 1141.Sp
1120This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is 1142This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is
1121only one resource database per display, and later invocations might return 1143only one resource database per display, and later invocations might return
1122the wrong resources. 1144the wrong resources.
1123.ie n .IP "$success = $term\->parse_keysym ($keysym_spec, $command_string)" 4 1145.ie n .IP "$success = $term\->parse_keysym ($key, $octets)" 4
1124.el .IP "\f(CW$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4 1146.el .IP "\f(CW$success\fR = \f(CW$term\fR\->parse_keysym ($key, \f(CW$octets\fR)" 4
1125.IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)" 1147.IX Item "$success = $term->parse_keysym ($key, $octets)"
1126Adds a keymap translation exactly as specified via a resource. See the 1148Adds a key binding exactly as specified via a resource. See the
1127\&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage. 1149\&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage.
1150.ie n .IP "$term\->register_command ($keysym, $modifiermask, $string)" 4
1151.el .IP "\f(CW$term\fR\->register_command ($keysym, \f(CW$modifiermask\fR, \f(CW$string\fR)" 4
1152.IX Item "$term->register_command ($keysym, $modifiermask, $string)"
1153Adds a key binding. This is a lower level api compared to
1154\&\f(CW\*(C`parse_keysym\*(C'\fR, as it expects a parsed key description, and can be
1155used only inside either the \f(CW\*(C`on_init\*(C'\fR hook, to add a binding, or the
1156\&\f(CW\*(C`on_register_command\*(C'\fR hook, to modify a parsed binding.
1128.ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4 1157.ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4
1129.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4 1158.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4
1130.IX Item "$rend = $term->rstyle ([$new_rstyle])" 1159.IX Item "$rend = $term->rstyle ([$new_rstyle])"
1131Return and optionally change the current rendition. Text that is output by 1160Return and optionally change the current rendition. Text that is output by
1132the terminal application will use this style. 1161the terminal application will use this style.
… …
1315to receive pointer events all the times: 1344to receive pointer events all the times:
1316.Sp 1345.Sp
1317.Vb 1 1346.Vb 1
1318\& $term\->vt_emask_add (urxvt::PointerMotionMask); 1347\& $term\->vt_emask_add (urxvt::PointerMotionMask);
1319.Ve 1348.Ve
1349.ie n .IP "$term\->set_urgency ($set)" 4
1350.el .IP "\f(CW$term\fR\->set_urgency ($set)" 4
1351.IX Item "$term->set_urgency ($set)"
1352Enable/disable the urgency hint on the toplevel window.
1320.ie n .IP "$term\->focus_in" 4 1353.ie n .IP "$term\->focus_in" 4
1321.el .IP "\f(CW$term\fR\->focus_in" 4 1354.el .IP "\f(CW$term\fR\->focus_in" 4
1322.IX Item "$term->focus_in" 1355.IX Item "$term->focus_in"
1323.PD 0 1356.PD 0
1324.ie n .IP "$term\->focus_out" 4 1357.ie n .IP "$term\->focus_out" 4
… …
1600.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 1633.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
1601.IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)" 1634.IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)"
1602.ie n .IP "$term\->XChangeInput ($window, $add_events[, $del_events])" 4 1635.ie n .IP "$term\->XChangeInput ($window, $add_events[, $del_events])" 4
1603.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4 1636.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4
1604.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])" 1637.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])"
1638.ie n .IP "$keysym = $term\->XStringToKeysym ($string)" 4
1639.el .IP "\f(CW$keysym\fR = \f(CW$term\fR\->XStringToKeysym ($string)" 4
1640.IX Item "$keysym = $term->XStringToKeysym ($string)"
1641.ie n .IP "$string = $term\->XKeysymToString ($keysym)" 4
1642.el .IP "\f(CW$string\fR = \f(CW$term\fR\->XKeysymToString ($keysym)" 4
1643.IX Item "$string = $term->XKeysymToString ($keysym)"
1605.PD 1644.PD
1606Various X or X\-related functions. The \f(CW$term\fR object only serves as 1645Various X or X\-related functions. The \f(CW$term\fR object only serves as
1607the source of the display, otherwise those functions map more-or-less 1646the source of the display, otherwise those functions map more-or-less
1608directly onto the X functions of the same name. 1647directly onto the X functions of the same name.
1609.ie n .SS "The ""urxvt::popup"" Class" 1648.ie n .SS "The ""urxvt::popup"" Class"

Diff Legend

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