1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 |
1 | .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
2 | .\" |
2 | .\" |
3 | .\" Standard preamble: |
3 | .\" Standard preamble: |
4 | .\" ======================================================================== |
4 | .\" ======================================================================== |
5 | .de Sh \" Subsection heading |
5 | .de Sh \" Subsection heading |
6 | .br |
6 | .br |
… | |
… | |
127 | .\} |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
130 | .\" |
130 | .\" |
131 | .IX Title "rxvt 3" |
131 | .IX Title "rxvt 3" |
132 | .TH rxvt 3 "2006-01-26" "7.3a" "RXVT-UNICODE" |
132 | .TH rxvt 3 "2006-01-29" "7.4" "RXVT-UNICODE" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | @@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter |
134 | @@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
137 | .Vb 1 |
… | |
… | |
778 | .Sp |
778 | .Sp |
779 | Using this function has the advantage that its output ends up in the |
779 | Using this function has the advantage that its output ends up in the |
780 | correct place, e.g. on stderr of the connecting urxvtc client. |
780 | correct place, e.g. on stderr of the connecting urxvtc client. |
781 | .Sp |
781 | .Sp |
782 | Messages have a size limit of 1023 bytes currently. |
782 | Messages have a size limit of 1023 bytes currently. |
|
|
783 | .IP "@terms = urxvt::termlist" 4 |
|
|
784 | .IX Item "@terms = urxvt::termlist" |
|
|
785 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
786 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
787 | objects that have perl extensions attached will be returned (because there |
|
|
788 | is no urxvt::term objet associated with others). |
783 | .IP "$time = urxvt::NOW" 4 |
789 | .IP "$time = urxvt::NOW" 4 |
784 | .IX Item "$time = urxvt::NOW" |
790 | .IX Item "$time = urxvt::NOW" |
785 | Returns the \*(L"current time\*(R" (as per the event loop). |
791 | Returns the \*(L"current time\*(R" (as per the event loop). |
786 | .IP "urxvt::CurrentTime" 4 |
792 | .IP "urxvt::CurrentTime" 4 |
787 | .IX Item "urxvt::CurrentTime" |
793 | .IX Item "urxvt::CurrentTime" |
… | |
… | |
864 | hash which defines the environment of the new terminal. |
870 | hash which defines the environment of the new terminal. |
865 | .Sp |
871 | .Sp |
866 | Croaks (and probably outputs an error message) if the new instance |
872 | Croaks (and probably outputs an error message) if the new instance |
867 | couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't |
873 | couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't |
868 | initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and |
874 | initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and |
869 | \&\f(CW\*(C`start\*(C'\fR hooks will be called during this call. |
875 | \&\f(CW\*(C`start\*(C'\fR hooks will be called before this call returns, and are free to |
|
|
876 | refer to global data (which is race free). |
870 | .IP "$term\->destroy" 4 |
877 | .IP "$term\->destroy" 4 |
871 | .IX Item "$term->destroy" |
878 | .IX Item "$term->destroy" |
872 | Destroy the terminal object (close the window, free resources |
879 | Destroy the terminal object (close the window, free resources |
873 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
880 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
874 | watchers (timers, io watchers) are still active. |
881 | watchers (timers, io watchers) are still active. |
… | |
… | |
1300 | .ie n .IP "$string = $term\fR\->special_decode \f(CW$text" 4 |
1307 | .ie n .IP "$string = $term\fR\->special_decode \f(CW$text" 4 |
1301 | .el .IP "$string = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 |
1308 | .el .IP "$string = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 |
1302 | .IX Item "$string = $term->special_decode $text" |
1309 | .IX Item "$string = $term->special_decode $text" |
1303 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1310 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1304 | \&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. |
1311 | \&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. |
1305 | .ie n .IP "$success = $term\fR\->grab_button ($button, \f(CW$modifiermask)" 4 |
1312 | .ie n .IP "$success = $term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 |
1306 | .el .IP "$success = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR)" 4 |
1313 | .el .IP "$success = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 |
1307 | .IX Item "$success = $term->grab_button ($button, $modifiermask)" |
1314 | .IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])" |
|
|
1315 | .PD 0 |
|
|
1316 | .ie n .IP "$term\->ungrab_button ($button, $modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 |
|
|
1317 | .el .IP "$term\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 |
|
|
1318 | .IX Item "$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])" |
|
|
1319 | .PD |
1308 | Registers a synchronous button grab. See the XGrabButton manpage. |
1320 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1321 | manpage. |
1309 | .ie n .IP "$success = $term\fR\->grab ($eventtime[, \f(CW$sync])" 4 |
1322 | .ie n .IP "$success = $term\fR\->grab ($eventtime[, \f(CW$sync])" 4 |
1310 | .el .IP "$success = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4 |
1323 | .el .IP "$success = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4 |
1311 | .IX Item "$success = $term->grab ($eventtime[, $sync])" |
1324 | .IX Item "$success = $term->grab ($eventtime[, $sync])" |
1312 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1325 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1313 | synchronous (\f(CW$sync\fR is true). Also remembers the grab timestampe. |
1326 | synchronous (\f(CW$sync\fR is true). Also remembers the grab timestampe. |