… | |
… | |
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-10" "6.3" "RXVT-UNICODE" |
132 | .TH rxvt 3 "2006-01-11" "6.3" "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 |
… | |
… | |
480 | .IP "*" 4 |
480 | .IP "*" 4 |
481 | .ie n .Sh "Functions in the ""urxvt"" Package" |
481 | .ie n .Sh "Functions in the ""urxvt"" Package" |
482 | .el .Sh "Functions in the \f(CWurxvt\fP Package" |
482 | .el .Sh "Functions in the \f(CWurxvt\fP Package" |
483 | .IX Subsection "Functions in the urxvt Package" |
483 | .IX Subsection "Functions in the urxvt Package" |
484 | .PD 0 |
484 | .PD 0 |
485 | .IP "$term = new urxvt [arg...]" 4 |
|
|
486 | .IX Item "$term = new urxvt [arg...]" |
|
|
487 | .PD |
|
|
488 | Creates a new terminal, very similar as if you had started it with |
|
|
489 | \&\f(CW\*(C`system $binfile, arg...\*(C'\fR. Croaks (and probably outputs an error message) |
|
|
490 | if the new instance couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new |
|
|
491 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
492 | \&\f(CW\*(C`init\*(C'\fR and \f(CW\*(C`start\*(C'\fR hooks will be called during the call. |
|
|
493 | .ie n .IP "urxvt::fatal $errormessage" 4 |
485 | .ie n .IP "urxvt::fatal $errormessage" 4 |
494 | .el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
486 | .el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
495 | .IX Item "urxvt::fatal $errormessage" |
487 | .IX Item "urxvt::fatal $errormessage" |
|
|
488 | .PD |
496 | Fatally aborts execution with the given error message. Avoid at all |
489 | Fatally aborts execution with the given error message. Avoid at all |
497 | costs! The only time this is acceptable is when the terminal process |
490 | costs! The only time this is acceptable is when the terminal process |
498 | starts up. |
491 | starts up. |
499 | .ie n .IP "urxvt::warn $string" 4 |
492 | .ie n .IP "urxvt::warn $string" 4 |
500 | .el .IP "urxvt::warn \f(CW$string\fR" 4 |
493 | .el .IP "urxvt::warn \f(CW$string\fR" 4 |
… | |
… | |
503 | newline. The module also overwrites the \f(CW\*(C`warn\*(C'\fR builtin with a function |
496 | newline. The module also overwrites the \f(CW\*(C`warn\*(C'\fR builtin with a function |
504 | that calls this function. |
497 | that calls this function. |
505 | .Sp |
498 | .Sp |
506 | Using this function has the advantage that its output ends up in the |
499 | Using this function has the advantage that its output ends up in the |
507 | correct place, e.g. on stderr of the connecting urxvtc client. |
500 | correct place, e.g. on stderr of the connecting urxvtc client. |
|
|
501 | .Sp |
|
|
502 | Messages have a size limit of 1023 bytes currently. |
508 | .IP "$is_safe = urxvt::safe" 4 |
503 | .IP "$is_safe = urxvt::safe" 4 |
509 | .IX Item "$is_safe = urxvt::safe" |
504 | .IX Item "$is_safe = urxvt::safe" |
510 | Returns true when it is safe to do potentially unsafe things, such as |
505 | Returns true when it is safe to do potentially unsafe things, such as |
511 | evaluating perl code specified by the user. This is true when urxvt was |
506 | evaluating perl code specified by the user. This is true when urxvt was |
512 | started setuid or setgid. |
507 | started setuid or setgid. |
… | |
… | |
580 | is that you cannot use blocking APIs, but the non-blocking variant should |
575 | is that you cannot use blocking APIs, but the non-blocking variant should |
581 | work. |
576 | work. |
582 | .ie n .Sh "The ""urxvt::term"" Class" |
577 | .ie n .Sh "The ""urxvt::term"" Class" |
583 | .el .Sh "The \f(CWurxvt::term\fP Class" |
578 | .el .Sh "The \f(CWurxvt::term\fP Class" |
584 | .IX Subsection "The urxvt::term Class" |
579 | .IX Subsection "The urxvt::term Class" |
|
|
580 | .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 |
|
|
582 | .IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" |
|
|
583 | 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 |
|
|
585 | \&\f(CW\*(C`hash which defines the environment of the new terminal. |
|
|
586 | |
|
|
587 | \&\*(C'\fR.Sp |
|
|
588 | >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 |
|
|
590 | 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. |
585 | .IP "$term\->destroy" 4 |
592 | .IP "$term\->destroy" 4 |
586 | .IX Item "$term->destroy" |
593 | .IX Item "$term->destroy" |
587 | Destroy the terminal object (close the window, free resources |
594 | Destroy the terminal object (close the window, free resources |
588 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
595 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
589 | watchers (timers, io watchers) are still active. |
596 | watchers (timers, io watchers) are still active. |
… | |
… | |
822 | .ie n .IP "$lines_in_scrollback = $term\->nsaved" 4 |
829 | .ie n .IP "$lines_in_scrollback = $term\->nsaved" 4 |
823 | .el .IP "$lines_in_scrollback = \f(CW$term\fR\->nsaved" 4 |
830 | .el .IP "$lines_in_scrollback = \f(CW$term\fR\->nsaved" 4 |
824 | .IX Item "$lines_in_scrollback = $term->nsaved" |
831 | .IX Item "$lines_in_scrollback = $term->nsaved" |
825 | .PD |
832 | .PD |
826 | Return various integers describing terminal characteristics. |
833 | Return various integers describing terminal characteristics. |
|
|
834 | .ie n .IP "$x_display = $term\->display_id" 4 |
|
|
835 | .el .IP "$x_display = \f(CW$term\fR\->display_id" 4 |
|
|
836 | .IX Item "$x_display = $term->display_id" |
|
|
837 | Return the \s-1DISPLAY\s0 used by rxvt\-unicode. |
827 | .ie n .IP "$lc_ctype = $term\->locale" 4 |
838 | .ie n .IP "$lc_ctype = $term\->locale" 4 |
828 | .el .IP "$lc_ctype = \f(CW$term\fR\->locale" 4 |
839 | .el .IP "$lc_ctype = \f(CW$term\fR\->locale" 4 |
829 | .IX Item "$lc_ctype = $term->locale" |
840 | .IX Item "$lc_ctype = $term->locale" |
830 | Returns the \s-1LC_CTYPE\s0 category string used by this rxvt\-unicode. |
841 | Returns the \s-1LC_CTYPE\s0 category string used by this rxvt\-unicode. |
831 | .ie n .IP "$x_display = $term\->display_id" 4 |
842 | .ie n .IP "$env = $term\->env" 4 |
832 | .el .IP "$x_display = \f(CW$term\fR\->display_id" 4 |
843 | .el .IP "$env = \f(CW$term\fR\->env" 4 |
833 | .IX Item "$x_display = $term->display_id" |
844 | .IX Item "$env = $term->env" |
834 | Return the \s-1DISPLAY\s0 used by rxvt\-unicode. |
845 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
846 | similar to \f(CW\*(C`\e%ENV\*(C'\fR. |
835 | .ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4 |
847 | .ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4 |
836 | .el .IP "$modifiermask = \f(CW$term\fR\->ModLevel3Mask" 4 |
848 | .el .IP "$modifiermask = \f(CW$term\fR\->ModLevel3Mask" 4 |
837 | .IX Item "$modifiermask = $term->ModLevel3Mask" |
849 | .IX Item "$modifiermask = $term->ModLevel3Mask" |
838 | .PD 0 |
850 | .PD 0 |
839 | .ie n .IP "$modifiermask = $term\->ModMetaMask" 4 |
851 | .ie n .IP "$modifiermask = $term\->ModMetaMask" 4 |