… | |
… | |
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-09" "6.3" "RXVT-UNICODE" |
132 | .TH rxvt 3 "2006-01-10" "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 |
… | |
… | |
197 | runtime. |
197 | runtime. |
198 | .IP "selection-popup (enabled by default)" 4 |
198 | .IP "selection-popup (enabled by default)" 4 |
199 | .IX Item "selection-popup (enabled by default)" |
199 | .IX Item "selection-popup (enabled by default)" |
200 | Binds a popup menu to Ctrl\-Button3 that lets you convert the selection |
200 | Binds a popup menu to Ctrl\-Button3 that lets you convert the selection |
201 | text into various other formats/action. |
201 | text into various other formats/action. |
|
|
202 | .IP "searchable\-scrollback<hotkey> (enabled by default)" 4 |
|
|
203 | .IX Item "searchable-scrollback<hotkey> (enabled by default)" |
|
|
204 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
205 | by a hotkey (default: \f(CW\*(C`M\-s\*(C'\fR). When in search mode, normal terminal |
|
|
206 | input/output is suspended. |
|
|
207 | .Sp |
|
|
208 | \&\f(CW\*(C`/\*(C'\fR starts an incremental regex search, \f(CW\*(C`n\*(C'\fR searches further, \f(CW\*(C`p\*(C'\fR or |
|
|
209 | \&\f(CW\*(C`N\*(C'\fR jump to the previous match, \f(CW\*(C`G\*(C'\fR jumps to the bottom and clears the |
|
|
210 | history, \f(CW\*(C`enter\*(C'\fR leaves search mode at the current position and \f(CW\*(C`escape\*(C'\fR |
|
|
211 | returns to the original position. |
202 | .IP "digital-clock" 4 |
212 | .IP "digital-clock" 4 |
203 | .IX Item "digital-clock" |
213 | .IX Item "digital-clock" |
204 | Displays a digital clock using the built-in overlay. |
214 | Displays a digital clock using the built-in overlay. |
205 | .IP "mark-urls" 4 |
215 | .IP "mark-urls" 4 |
206 | .IX Item "mark-urls" |
216 | .IX Item "mark-urls" |
… | |
… | |
241 | encoding (often locale\-specific) and binary data. |
251 | encoding (often locale\-specific) and binary data. |
242 | .IP "$octets" 4 |
252 | .IP "$octets" 4 |
243 | .IX Item "$octets" |
253 | .IX Item "$octets" |
244 | Either binary data or \- more common \- a text string encoded in a |
254 | Either binary data or \- more common \- a text string encoded in a |
245 | locale-specific way. |
255 | locale-specific way. |
|
|
256 | .Sh "Extension Objects" |
|
|
257 | .IX Subsection "Extension Objects" |
|
|
258 | Very perl extension is a perl class. A separate perl object is created |
|
|
259 | for each terminal and each extension and passed as the first parameter to |
|
|
260 | hooks. So extensions can use their \f(CW$self\fR object without having to think |
|
|
261 | about other extensions, with the exception of methods and members that |
|
|
262 | begin with an underscore character \f(CW\*(C`_\*(C'\fR: these are reserved for internal |
|
|
263 | use. |
|
|
264 | .PP |
|
|
265 | Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all methods of the |
|
|
266 | \&\f(CW\*(C`urxvt::term\*(C'\fR class on this object. |
|
|
267 | .PP |
|
|
268 | It has the following methods and data members: |
|
|
269 | .ie n .IP "$urxvt_term = $self\->{term}" 4 |
|
|
270 | .el .IP "$urxvt_term = \f(CW$self\fR\->{term}" 4 |
|
|
271 | .IX Item "$urxvt_term = $self->{term}" |
|
|
272 | Returns the \f(CW\*(C`urxvt::term\*(C'\fR object associated with this instance of the |
|
|
273 | extension. This member \fImust not\fR be changed in any way. |
|
|
274 | .ie n .IP "$self\->enable ($hook_name => $cb\fR, [$hook_name => \f(CW$cb..])" 4 |
|
|
275 | .el .IP "$self\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb\fR..])" 4 |
|
|
276 | .IX Item "$self->enable ($hook_name => $cb, [$hook_name => $cb..])" |
|
|
277 | Dynamically enable the given hooks (named without the \f(CW\*(C`on_\*(C'\fR prefix) for |
|
|
278 | this extension, replacing any previous hook. This is useful when you want |
|
|
279 | to overwrite time-critical hooks only temporarily. |
|
|
280 | .ie n .IP "$self\->disable ($hook_name[, $hook_name..])" 4 |
|
|
281 | .el .IP "$self\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4 |
|
|
282 | .IX Item "$self->disable ($hook_name[, $hook_name..])" |
|
|
283 | Dynamically disable the given hooks. |
246 | .Sh "Hooks" |
284 | .Sh "Hooks" |
247 | .IX Subsection "Hooks" |
285 | .IX Subsection "Hooks" |
248 | The following subroutines can be declared in extension files, and will be |
286 | The following subroutines can be declared in extension files, and will be |
249 | called whenever the relevant event happens. |
287 | called whenever the relevant event happens. |
250 | .PP |
288 | .PP |
251 | The first argument passed to them is an object private to each terminal |
289 | The first argument passed to them is an extension oject as described in |
252 | and extension package. You can call all \f(CW\*(C`urxvt::term\*(C'\fR methods on it, but |
290 | the in the \f(CW\*(C`Extension Objects\*(C'\fR section. |
253 | its not a real \f(CW\*(C`urxvt::term\*(C'\fR object. Instead, the real \f(CW\*(C`urxvt::term\*(C'\fR |
|
|
254 | object that is shared between all packages is stored in the \f(CW\*(C`term\*(C'\fR |
|
|
255 | member. It is, however, blessed intot he package of the extension script, |
|
|
256 | so for all practical purposes you can treat an extension script as a class. |
|
|
257 | .PP |
291 | .PP |
258 | All of them must return a boolean value. If it is true, then the event |
292 | \&\fBAll\fR of these hooks must return a boolean value. If it is true, then the |
259 | counts as being \fIconsumed\fR, and the invocation of other hooks is skipped, |
293 | event counts as being \fIconsumed\fR, and the invocation of other hooks is |
260 | and the relevant action might not be carried out by the \*(C+ code. |
294 | skipped, and the relevant action might not be carried out by the \*(C+ code. |
261 | .PP |
295 | .PP |
262 | When in doubt, return a false value (preferably \f(CW\*(C`()\*(C'\fR). |
296 | \&\fIWhen in doubt, return a false value (preferably \f(CI\*(C`()\*(C'\fI).\fR |
263 | .ie n .IP "on_init $term" 4 |
297 | .ie n .IP "on_init $term" 4 |
264 | .el .IP "on_init \f(CW$term\fR" 4 |
298 | .el .IP "on_init \f(CW$term\fR" 4 |
265 | .IX Item "on_init $term" |
299 | .IX Item "on_init $term" |
266 | Called after a new terminal object has been initialized, but before |
300 | Called after a new terminal object has been initialized, but before |
267 | windows are created or the command gets run. Most methods are unsafe to |
301 | windows are created or the command gets run. Most methods are unsafe to |
… | |
… | |
340 | Called whenever text is about to be output, with the text as argument. You |
374 | Called whenever text is about to be output, with the text as argument. You |
341 | can filter/change and output the text yourself by returning a true value |
375 | can filter/change and output the text yourself by returning a true value |
342 | and calling \f(CW\*(C`$term\->scr_add_lines\*(C'\fR yourself. Please note that this |
376 | and calling \f(CW\*(C`$term\->scr_add_lines\*(C'\fR yourself. Please note that this |
343 | might be very slow, however, as your hook is called for \fBall\fR text being |
377 | might be very slow, however, as your hook is called for \fBall\fR text being |
344 | output. |
378 | output. |
|
|
379 | .ie n .IP "on_tt_write $term\fR, \f(CW$octets" 4 |
|
|
380 | .el .IP "on_tt_write \f(CW$term\fR, \f(CW$octets\fR" 4 |
|
|
381 | .IX Item "on_tt_write $term, $octets" |
|
|
382 | Called whenever some data is written to the tty/pty and can be used to |
|
|
383 | suppress or filter tty input. |
345 | .ie n .IP "on_line_update $term\fR, \f(CW$row" 4 |
384 | .ie n .IP "on_line_update $term\fR, \f(CW$row" 4 |
346 | .el .IP "on_line_update \f(CW$term\fR, \f(CW$row\fR" 4 |
385 | .el .IP "on_line_update \f(CW$term\fR, \f(CW$row\fR" 4 |
347 | .IX Item "on_line_update $term, $row" |
386 | .IX Item "on_line_update $term, $row" |
348 | Called whenever a line was updated or changed. Can be used to filter |
387 | Called whenever a line was updated or changed. Can be used to filter |
349 | screen output (e.g. underline urls or other useless stuff). Only lines |
388 | screen output (e.g. underline urls or other useless stuff). Only lines |
… | |
… | |
381 | .ie n .IP "on_focus_out $term" 4 |
420 | .ie n .IP "on_focus_out $term" 4 |
382 | .el .IP "on_focus_out \f(CW$term\fR" 4 |
421 | .el .IP "on_focus_out \f(CW$term\fR" 4 |
383 | .IX Item "on_focus_out $term" |
422 | .IX Item "on_focus_out $term" |
384 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
423 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
385 | focus out processing. |
424 | focus out processing. |
386 | .ie n .IP "on_key_press $term\fR, \f(CW$event\fR, \f(CW$octets" 4 |
425 | .ie n .IP "on_key_press $term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets" 4 |
387 | .el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$octets\fR" 4 |
426 | .el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4 |
388 | .IX Item "on_key_press $term, $event, $octets" |
427 | .IX Item "on_key_press $term, $event, $keysym, $octets" |
389 | .PD 0 |
428 | .PD 0 |
390 | .ie n .IP "on_key_release $term\fR, \f(CW$event" 4 |
429 | .ie n .IP "on_key_release $term\fR, \f(CW$event\fR, \f(CW$keysym" 4 |
391 | .el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR" 4 |
430 | .el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4 |
392 | .IX Item "on_key_release $term, $event" |
431 | .IX Item "on_key_release $term, $event, $keysym" |
393 | .ie n .IP "on_button_press $term\fR, \f(CW$event" 4 |
432 | .ie n .IP "on_button_press $term\fR, \f(CW$event" 4 |
394 | .el .IP "on_button_press \f(CW$term\fR, \f(CW$event\fR" 4 |
433 | .el .IP "on_button_press \f(CW$term\fR, \f(CW$event\fR" 4 |
395 | .IX Item "on_button_press $term, $event" |
434 | .IX Item "on_button_press $term, $event" |
396 | .ie n .IP "on_button_release $term\fR, \f(CW$event" 4 |
435 | .ie n .IP "on_button_release $term\fR, \f(CW$event" 4 |
397 | .el .IP "on_button_release \f(CW$term\fR, \f(CW$event\fR" 4 |
436 | .el .IP "on_button_release \f(CW$term\fR, \f(CW$event\fR" 4 |
… | |
… | |
579 | \& scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
618 | \& scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
580 | \& scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
619 | \& scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
581 | \& shade term_name title transparent transparent_all tripleclickwords |
620 | \& shade term_name title transparent transparent_all tripleclickwords |
582 | \& utmpInhibit visualBell |
621 | \& utmpInhibit visualBell |
583 | .Ve |
622 | .Ve |
|
|
623 | .ie n .IP "$success = $term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string)" 4 |
|
|
624 | .el .IP "$success = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4 |
|
|
625 | .IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)" |
|
|
626 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
627 | \&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage. |
584 | .ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4 |
628 | .ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4 |
585 | .el .IP "$rend = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4 |
629 | .el .IP "$rend = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4 |
586 | .IX Item "$rend = $term->rstyle ([$new_rstyle])" |
630 | .IX Item "$rend = $term->rstyle ([$new_rstyle])" |
587 | Return and optionally change the current rendition. Text that is output by |
631 | Return and optionally change the current rendition. Text that is output by |
588 | the terminal application will use this style. |
632 | the terminal application will use this style. |
… | |
… | |
611 | by the next method). |
655 | by the next method). |
612 | .ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 |
656 | .ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 |
613 | .el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4 |
657 | .el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4 |
614 | .IX Item "$oldtext = $term->selection ([$newtext])" |
658 | .IX Item "$oldtext = $term->selection ([$newtext])" |
615 | Return the current selection text and optionally replace it by \f(CW$newtext\fR. |
659 | Return the current selection text and optionally replace it by \f(CW$newtext\fR. |
616 | .Sp |
660 | .ie n .IP "$term\->overlay_simple ($x, $y\fR, \f(CW$text)" 4 |
617 | #=item \f(CW$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$text\fR) |
661 | .el .IP "$term\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 |
618 | # |
662 | .IX Item "$term->overlay_simple ($x, $y, $text)" |
619 | #Create a simple multi-line overlay box. See the next method for details. |
663 | Create a simple multi-line overlay box. See the next method for details. |
620 | # |
|
|
621 | #=cut |
|
|
622 | # |
|
|
623 | #sub urxvt::term::scr_overlay { |
|
|
624 | # my ($self, \f(CW$x\fR, \f(CW$y\fR, \f(CW$text\fR) = \f(CW@_\fR; |
|
|
625 | # |
|
|
626 | # my \f(CW@lines\fR = split /\en/, \f(CW$text\fR; |
|
|
627 | # |
|
|
628 | # my \f(CW$w\fR = 0; |
|
|
629 | # for (map \f(CW$self\fR\->strwidth ($_), \f(CW@lines\fR) { |
|
|
630 | # \f(CW$w\fR = \f(CW$_\fR if \f(CW$w\fR < \f(CW$_\fR; |
|
|
631 | # } |
|
|
632 | # |
|
|
633 | # \f(CW$self\fR\->scr_overlay_new ($x, \f(CW$y\fR, \f(CW$w\fR, scalar \f(CW@lines\fR); |
|
|
634 | # \f(CW$self\fR\->scr_overlay_set (0, \f(CW$_\fR, \f(CW$lines\fR[$_]) for 0.. $#lines; |
|
|
635 | #} |
|
|
636 | .ie n .IP "$term\->overlay ($x, $y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 |
664 | .ie n .IP "$term\->overlay ($x, $y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 |
637 | .el .IP "$term\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4 |
665 | .el .IP "$term\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4 |
638 | .IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" |
666 | .IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" |
639 | Create a new (empty) overlay at the given position with the given |
667 | Create a new (empty) overlay at the given position with the given |
640 | width/height. \f(CW$rstyle\fR defines the initial rendition style |
668 | width/height. \f(CW$rstyle\fR defines the initial rendition style |
… | |
… | |
683 | Convert the given text string into the corresponding locale encoding. |
711 | Convert the given text string into the corresponding locale encoding. |
684 | .ie n .IP "$string = $term\->locale_decode ($octets)" 4 |
712 | .ie n .IP "$string = $term\->locale_decode ($octets)" 4 |
685 | .el .IP "$string = \f(CW$term\fR\->locale_decode ($octets)" 4 |
713 | .el .IP "$string = \f(CW$term\fR\->locale_decode ($octets)" 4 |
686 | .IX Item "$string = $term->locale_decode ($octets)" |
714 | .IX Item "$string = $term->locale_decode ($octets)" |
687 | Convert the given locale-encoded octets into a perl string. |
715 | Convert the given locale-encoded octets into a perl string. |
|
|
716 | .ie n .IP "$term\->scr_xor_span ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4 |
|
|
717 | .el .IP "$term\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4 |
|
|
718 | .IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])" |
|
|
719 | XORs the rendition values in the given span with the provided value |
|
|
720 | (default: \f(CW\*(C`RS_RVid\*(C'\fR). Useful in refresh hooks to provide effects similar |
|
|
721 | to the selection. |
|
|
722 | .ie n .IP "$term\->scr_xor_rect ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4 |
|
|
723 | .el .IP "$term\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4 |
|
|
724 | .IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])" |
|
|
725 | Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing |
|
|
726 | whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults |
|
|
727 | to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines |
|
|
728 | it instead. |
|
|
729 | .IP "$term\->scr_bell" 4 |
|
|
730 | .IX Item "$term->scr_bell" |
|
|
731 | Ring the bell! |
688 | .IP "$term\->scr_add_lines ($string)" 4 |
732 | .IP "$term\->scr_add_lines ($string)" 4 |
689 | .IX Item "$term->scr_add_lines ($string)" |
733 | .IX Item "$term->scr_add_lines ($string)" |
690 | Write the given text string to the screen, as if output by the application |
734 | Write the given text string to the screen, as if output by the application |
691 | running inside the terminal. It may not contain command sequences (escape |
735 | running inside the terminal. It may not contain command sequences (escape |
692 | codes), but is free to use line feeds, carriage returns and tabs. The |
736 | codes), but is free to use line feeds, carriage returns and tabs. The |
… | |
… | |
703 | .IP "$term\->tt_write ($octets)" 4 |
747 | .IP "$term\->tt_write ($octets)" 4 |
704 | .IX Item "$term->tt_write ($octets)" |
748 | .IX Item "$term->tt_write ($octets)" |
705 | Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To |
749 | Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To |
706 | pass characters instead of octets, you should convert your strings first |
750 | pass characters instead of octets, you should convert your strings first |
707 | to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. |
751 | to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. |
|
|
752 | .ie n .IP "$old_events = $term\->pty_ev_events ([$new_events])" 4 |
|
|
753 | .el .IP "$old_events = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4 |
|
|
754 | .IX Item "$old_events = $term->pty_ev_events ([$new_events])" |
|
|
755 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
756 | be used to suppress input and output handling to the pty/tty. See the |
|
|
757 | description of \f(CW\*(C`urxvt::timer\->events\*(C'\fR. Make sure to always restore |
|
|
758 | the previous value. |
708 | .ie n .IP "$windowid = $term\->parent" 4 |
759 | .ie n .IP "$windowid = $term\->parent" 4 |
709 | .el .IP "$windowid = \f(CW$term\fR\->parent" 4 |
760 | .el .IP "$windowid = \f(CW$term\fR\->parent" 4 |
710 | .IX Item "$windowid = $term->parent" |
761 | .IX Item "$windowid = $term->parent" |
711 | Return the window id of the toplevel window. |
762 | Return the window id of the toplevel window. |
712 | .ie n .IP "$windowid = $term\->vt" 4 |
763 | .ie n .IP "$windowid = $term\->vt" 4 |
… | |
… | |
750 | .ie n .IP "$lines_in_scrollback = $term\->nsaved" 4 |
801 | .ie n .IP "$lines_in_scrollback = $term\->nsaved" 4 |
751 | .el .IP "$lines_in_scrollback = \f(CW$term\fR\->nsaved" 4 |
802 | .el .IP "$lines_in_scrollback = \f(CW$term\fR\->nsaved" 4 |
752 | .IX Item "$lines_in_scrollback = $term->nsaved" |
803 | .IX Item "$lines_in_scrollback = $term->nsaved" |
753 | .PD |
804 | .PD |
754 | Return various integers describing terminal characteristics. |
805 | Return various integers describing terminal characteristics. |
|
|
806 | .ie n .IP "$lc_ctype = $term\->locale" 4 |
|
|
807 | .el .IP "$lc_ctype = \f(CW$term\fR\->locale" 4 |
|
|
808 | .IX Item "$lc_ctype = $term->locale" |
|
|
809 | Returns the \s-1LC_CTYPE\s0 category string used by this rxvt\-unicode. |
|
|
810 | .ie n .IP "$x_display = $term\->display_id" 4 |
|
|
811 | .el .IP "$x_display = \f(CW$term\fR\->display_id" 4 |
|
|
812 | .IX Item "$x_display = $term->display_id" |
|
|
813 | Return the \s-1DISPLAY\s0 used by rxvt\-unicode. |
755 | .ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4 |
814 | .ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4 |
756 | .el .IP "$modifiermask = \f(CW$term\fR\->ModLevel3Mask" 4 |
815 | .el .IP "$modifiermask = \f(CW$term\fR\->ModLevel3Mask" 4 |
757 | .IX Item "$modifiermask = $term->ModLevel3Mask" |
816 | .IX Item "$modifiermask = $term->ModLevel3Mask" |
758 | .PD 0 |
817 | .PD 0 |
759 | .ie n .IP "$modifiermask = $term\->ModMetaMask" 4 |
818 | .ie n .IP "$modifiermask = $term\->ModMetaMask" 4 |
… | |
… | |
966 | .Vb 12 |
1025 | .Vb 12 |
967 | \& $term->{socket} = ... |
1026 | \& $term->{socket} = ... |
968 | \& $term->{iow} = urxvt::iow |
1027 | \& $term->{iow} = urxvt::iow |
969 | \& ->new |
1028 | \& ->new |
970 | \& ->fd (fileno $term->{socket}) |
1029 | \& ->fd (fileno $term->{socket}) |
971 | \& ->events (1) # wait for read data |
1030 | \& ->events (urxvt::EVENT_READ) |
972 | \& ->start |
1031 | \& ->start |
973 | \& ->cb (sub { |
1032 | \& ->cb (sub { |
974 | \& my ($iow, $revents) = @_; |
1033 | \& my ($iow, $revents) = @_; |
975 | \& # $revents must be 1 here, no need to check |
1034 | \& # $revents must be 1 here, no need to check |
976 | \& sysread $term->{socket}, my $buf, 8192 |
1035 | \& sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
990 | .IX Item "$iow = $iow->fd ($fd)" |
1049 | .IX Item "$iow = $iow->fd ($fd)" |
991 | Set the filedescriptor (not handle) to watch. |
1050 | Set the filedescriptor (not handle) to watch. |
992 | .ie n .IP "$iow = $iow\->events ($eventmask)" 4 |
1051 | .ie n .IP "$iow = $iow\->events ($eventmask)" 4 |
993 | .el .IP "$iow = \f(CW$iow\fR\->events ($eventmask)" 4 |
1052 | .el .IP "$iow = \f(CW$iow\fR\->events ($eventmask)" 4 |
994 | .IX Item "$iow = $iow->events ($eventmask)" |
1053 | .IX Item "$iow = $iow->events ($eventmask)" |
995 | Set the event mask to watch. Bit #0 (value \f(CW1\fR) enables watching for read |
1054 | Set the event mask to watch. The only allowed values are |
996 | data, Bit #1 (value \f(CW2\fR) enables watching for write data. |
1055 | \&\f(CW\*(C`urxvt::EVENT_READ\*(C'\fR and \f(CW\*(C`urxvt::EVENT_WRITE\*(C'\fR, which might be ORed |
|
|
1056 | together, or \f(CW\*(C`urxvt::EVENT_NONE\*(C'\fR. |
997 | .ie n .IP "$iow = $iow\->start" 4 |
1057 | .ie n .IP "$iow = $iow\->start" 4 |
998 | .el .IP "$iow = \f(CW$iow\fR\->start" 4 |
1058 | .el .IP "$iow = \f(CW$iow\fR\->start" 4 |
999 | .IX Item "$iow = $iow->start" |
1059 | .IX Item "$iow = $iow->start" |
1000 | Start watching for requested events on the given handle. |
1060 | Start watching for requested events on the given handle. |
1001 | .ie n .IP "$iow = $iow\->stop" 4 |
1061 | .ie n .IP "$iow = $iow\->stop" 4 |