| … | |
… | |
| 244 | Argument names also often indicate the type of a parameter. Here are some |
244 | Argument names also often indicate the type of a parameter. Here are some |
| 245 | hints on what they mean: |
245 | hints on what they mean: |
| 246 | .IP "$text" 4 |
246 | .IP "$text" 4 |
| 247 | .IX Item "$text" |
247 | .IX Item "$text" |
| 248 | Rxvt-unicodes special way of encoding text, where one \*(L"unicode\*(R" character |
248 | Rxvt-unicodes special way of encoding text, where one \*(L"unicode\*(R" character |
| 249 | always represents one screen cell. See row_t for a discussion of this format. |
249 | always represents one screen cell. See ROW_t for a discussion of this format. |
| 250 | .IP "$string" 4 |
250 | .IP "$string" 4 |
| 251 | .IX Item "$string" |
251 | .IX Item "$string" |
| 252 | A perl text string, with an emphasis on \fItext\fR. It can store all unicode |
252 | A perl text string, with an emphasis on \fItext\fR. It can store all unicode |
| 253 | characters and is to be distinguished with text encoded in a specific |
253 | characters and is to be distinguished with text encoded in a specific |
| 254 | encoding (often locale\-specific) and binary data. |
254 | encoding (often locale\-specific) and binary data. |
| … | |
… | |
| 475 | The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR. |
475 | The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR. |
| 476 | .IP "$urxvt::TERM" 4 |
476 | .IP "$urxvt::TERM" 4 |
| 477 | .IX Item "$urxvt::TERM" |
477 | .IX Item "$urxvt::TERM" |
| 478 | The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR |
478 | The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR |
| 479 | object, whenever a callback/hook is executing. |
479 | object, whenever a callback/hook is executing. |
| 480 | .IP "*" 4 |
|
|
| 481 | .ie n .Sh "Functions in the ""urxvt"" Package" |
480 | .ie n .Sh "Functions in the ""urxvt"" Package" |
| 482 | .el .Sh "Functions in the \f(CWurxvt\fP Package" |
481 | .el .Sh "Functions in the \f(CWurxvt\fP Package" |
| 483 | .IX Subsection "Functions in the urxvt Package" |
482 | .IX Subsection "Functions in the urxvt Package" |
| 484 | .PD 0 |
|
|
| 485 | .ie n .IP "urxvt::fatal $errormessage" 4 |
483 | .ie n .IP "urxvt::fatal $errormessage" 4 |
| 486 | .el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
484 | .el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
| 487 | .IX Item "urxvt::fatal $errormessage" |
485 | .IX Item "urxvt::fatal $errormessage" |
| 488 | .PD |
|
|
| 489 | Fatally aborts execution with the given error message. Avoid at all |
486 | Fatally aborts execution with the given error message. Avoid at all |
| 490 | costs! The only time this is acceptable is when the terminal process |
487 | costs! The only time this is acceptable is when the terminal process |
| 491 | starts up. |
488 | starts up. |
| 492 | .ie n .IP "urxvt::warn $string" 4 |
489 | .ie n .IP "urxvt::warn $string" 4 |
| 493 | .el .IP "urxvt::warn \f(CW$string\fR" 4 |
490 | .el .IP "urxvt::warn \f(CW$string\fR" 4 |
| … | |
… | |
| 579 | .IX Subsection "The urxvt::term Class" |
576 | .IX Subsection "The urxvt::term Class" |
| 580 | .ie n .IP "$term = new urxvt::term $envhashref\fR, \f(CW$rxvtname, [arg...]" 4 |
577 | .ie n .IP "$term = new urxvt::term $envhashref\fR, \f(CW$rxvtname, [arg...]" 4 |
| 581 | .el .IP "$term = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4 |
578 | .el .IP "$term = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4 |
| 582 | .IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" |
579 | .IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" |
| 583 | Creates a new terminal, very similar as if you had started it with system |
580 | Creates a new terminal, very similar as if you had started it with system |
| 584 | \&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR>\-like |
581 | \&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like |
| 585 | \&\f(CW\*(C`hash which defines the environment of the new terminal. |
582 | hash which defines the environment of the new terminal. |
| 586 | |
583 | .Sp |
| 587 | \&\*(C'\fR.Sp |
|
|
| 588 | >Croaks (and probably outputs an error message) if the new instance |
584 | Croaks (and probably outputs an error message) if the new instance |
| 589 | couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't |
585 | couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't |
| 590 | initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and |
586 | initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and |
| 591 | \&\f(CW\*(C`start\*(C'\fR hooks will be called during this call. |
587 | \&\f(CW\*(C`start\*(C'\fR hooks will be called during this call. |
| 592 | .IP "$term\->destroy" 4 |
588 | .IP "$term\->destroy" 4 |
| 593 | .IX Item "$term->destroy" |
589 | .IX Item "$term->destroy" |
| … | |
… | |
| 1020 | .ie n .Sh "The ""urxvt::timer"" Class" |
1016 | .ie n .Sh "The ""urxvt::timer"" Class" |
| 1021 | .el .Sh "The \f(CWurxvt::timer\fP Class" |
1017 | .el .Sh "The \f(CWurxvt::timer\fP Class" |
| 1022 | .IX Subsection "The urxvt::timer Class" |
1018 | .IX Subsection "The urxvt::timer Class" |
| 1023 | This class implements timer watchers/events. Time is represented as a |
1019 | This class implements timer watchers/events. Time is represented as a |
| 1024 | fractional number of seconds since the epoch. Example: |
1020 | fractional number of seconds since the epoch. Example: |
| 1025 | .Sp |
1021 | .PP |
| 1026 | .Vb 8 |
1022 | .Vb 8 |
| 1027 | \& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
1023 | \& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 1028 | \& $term->{timer} = urxvt::timer |
1024 | \& $term->{timer} = urxvt::timer |
| 1029 | \& ->new |
1025 | \& ->new |
| 1030 | \& ->interval (1) |
1026 | \& ->interval (1) |
| 1031 | \& ->cb (sub { |
1027 | \& ->cb (sub { |
| 1032 | \& $term->{overlay}->set (0, 0, |
1028 | \& $term->{overlay}->set (0, 0, |
| 1033 | \& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1029 | \& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
| 1034 | \& }); |
1030 | \& }); |
| 1035 | .Ve |
1031 | .Ve |
| 1036 | .RS 4 |
|
|
| 1037 | .IP "$timer = new urxvt::timer" 4 |
1032 | .IP "$timer = new urxvt::timer" 4 |
| 1038 | .IX Item "$timer = new urxvt::timer" |
1033 | .IX Item "$timer = new urxvt::timer" |
| 1039 | Create a new timer object in started state. It is scheduled to fire |
1034 | Create a new timer object in started state. It is scheduled to fire |
| 1040 | immediately. |
1035 | immediately. |
| 1041 | .ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 |
1036 | .ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 |
| … | |
… | |
| 1066 | Set the event trigger time to \f(CW$tstamp\fR and start the timer. |
1061 | Set the event trigger time to \f(CW$tstamp\fR and start the timer. |
| 1067 | .ie n .IP "$timer = $timer\->stop" 4 |
1062 | .ie n .IP "$timer = $timer\->stop" 4 |
| 1068 | .el .IP "$timer = \f(CW$timer\fR\->stop" 4 |
1063 | .el .IP "$timer = \f(CW$timer\fR\->stop" 4 |
| 1069 | .IX Item "$timer = $timer->stop" |
1064 | .IX Item "$timer = $timer->stop" |
| 1070 | Stop the timer. |
1065 | Stop the timer. |
| 1071 | .RE |
|
|
| 1072 | .RS 4 |
|
|
| 1073 | .ie n .Sh "The ""urxvt::iow"" Class" |
1066 | .ie n .Sh "The ""urxvt::iow"" Class" |
| 1074 | .el .Sh "The \f(CWurxvt::iow\fP Class" |
1067 | .el .Sh "The \f(CWurxvt::iow\fP Class" |
| 1075 | .IX Subsection "The urxvt::iow Class" |
1068 | .IX Subsection "The urxvt::iow Class" |
| 1076 | This class implements io watchers/events. Example: |
1069 | This class implements io watchers/events. Example: |
| 1077 | .Sp |
1070 | .PP |
| 1078 | .Vb 12 |
1071 | .Vb 12 |
| 1079 | \& $term->{socket} = ... |
1072 | \& $term->{socket} = ... |
| 1080 | \& $term->{iow} = urxvt::iow |
1073 | \& $term->{iow} = urxvt::iow |
| 1081 | \& ->new |
1074 | \& ->new |
| 1082 | \& ->fd (fileno $term->{socket}) |
1075 | \& ->fd (fileno $term->{socket}) |
| … | |
… | |
| 1113 | Start watching for requested events on the given handle. |
1106 | Start watching for requested events on the given handle. |
| 1114 | .ie n .IP "$iow = $iow\->stop" 4 |
1107 | .ie n .IP "$iow = $iow\->stop" 4 |
| 1115 | .el .IP "$iow = \f(CW$iow\fR\->stop" 4 |
1108 | .el .IP "$iow = \f(CW$iow\fR\->stop" 4 |
| 1116 | .IX Item "$iow = $iow->stop" |
1109 | .IX Item "$iow = $iow->stop" |
| 1117 | Stop watching for events on the given filehandle. |
1110 | Stop watching for events on the given filehandle. |
| 1118 | .RE |
|
|
| 1119 | .RS 4 |
|
|
| 1120 | .SH "ENVIRONMENT" |
1111 | .SH "ENVIRONMENT" |
| 1121 | .IX Header "ENVIRONMENT" |
1112 | .IX Header "ENVIRONMENT" |
| 1122 | .Sh "\s-1URXVT_PERL_VERBOSITY\s0" |
1113 | .Sh "\s-1URXVT_PERL_VERBOSITY\s0" |
| 1123 | .IX Subsection "URXVT_PERL_VERBOSITY" |
1114 | .IX Subsection "URXVT_PERL_VERBOSITY" |
| 1124 | This variable controls the verbosity level of the perl extension. Higher |
1115 | This variable controls the verbosity level of the perl extension. Higher |
| … | |
… | |
| 1128 | .PD 0 |
1119 | .PD 0 |
| 1129 | .IP ">= 3 \- script loading and management" 4 |
1120 | .IP ">= 3 \- script loading and management" 4 |
| 1130 | .IX Item ">= 3 - script loading and management" |
1121 | .IX Item ">= 3 - script loading and management" |
| 1131 | .IP ">=10 \- all events received" 4 |
1122 | .IP ">=10 \- all events received" 4 |
| 1132 | .IX Item ">=10 - all events received" |
1123 | .IX Item ">=10 - all events received" |
| 1133 | .RE |
|
|
| 1134 | .RS 4 |
|
|
| 1135 | .PD |
1124 | .PD |
| 1136 | .SH "AUTHOR" |
1125 | .SH "AUTHOR" |
| 1137 | .IX Header "AUTHOR" |
1126 | .IX Header "AUTHOR" |
| 1138 | .Vb 2 |
1127 | .Vb 2 |
| 1139 | \& Marc Lehmann <pcg@goof.com> |
1128 | \& Marc Lehmann <pcg@goof.com> |
