… | |
… | |
40 | =over 4 |
40 | =over 4 |
41 | |
41 | |
42 | =item selection (enabled by default) |
42 | =item selection (enabled by default) |
43 | |
43 | |
44 | (More) intelligent selection. This extension tries to be more intelligent |
44 | (More) intelligent selection. This extension tries to be more intelligent |
45 | when the user extends selections (double-click). Right now, it tries to |
45 | when the user extends selections (double-click and further clicks). Right |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
46 | now, it tries to select words, urls and complete shell-quoted |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
47 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
48 | C<--quoting-style=shell>. |
48 | |
49 | |
|
|
50 | A double-click usually selects the word under the cursor, further clicks |
|
|
51 | will enlarge the selection. |
|
|
52 | |
|
|
53 | The selection works by trying to match a number of regexes and displaying |
|
|
54 | them in increasing order of length. You can add your own regexes by |
|
|
55 | specifying resources of the form: |
|
|
56 | |
|
|
57 | URxvt.selection.pattern-0: perl-regex |
|
|
58 | URxvt.selection.pattern-1: perl-regex |
|
|
59 | ... |
|
|
60 | |
|
|
61 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
62 | contain at least one pair of capturing parentheses, which will be used for |
|
|
63 | the match. For example, the followign adds a regex that matches everything |
|
|
64 | between two vertical bars: |
|
|
65 | |
|
|
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
67 | |
|
|
68 | You can look at the source of the selection extension to see more |
|
|
69 | interesting uses, such as parsing a line from beginning to end. |
|
|
70 | |
49 | It also offers the following bindable keyboard command: |
71 | This extension also offers following bindable keyboard commands: |
50 | |
72 | |
51 | =over 4 |
73 | =over 4 |
52 | |
74 | |
53 | =item rot13 |
75 | =item rot13 |
54 | |
76 | |
… | |
… | |
67 | |
89 | |
68 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
90 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
69 | text into various other formats/action (such as uri unescaping, perl |
91 | text into various other formats/action (such as uri unescaping, perl |
70 | evalution, web-browser starting etc.), depending on content. |
92 | evalution, web-browser starting etc.), depending on content. |
71 | |
93 | |
|
|
94 | Other extensions can extend this popup menu by pushing a code reference |
|
|
95 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
|
|
96 | popup is displayed. |
|
|
97 | |
|
|
98 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
99 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
100 | It should either return nothing or a string and a code reference. The |
|
|
101 | string will be used as button text and the code reference will be called |
|
|
102 | when the button gets activated and should transform C<$_>. |
|
|
103 | |
|
|
104 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
105 | the selection to C<b>s, but only if the selection currently contains any |
|
|
106 | C<a>s: |
|
|
107 | |
|
|
108 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
109 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
110 | : () |
|
|
111 | }; |
|
|
112 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
113 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
114 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
115 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
116 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
117 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
118 | screen. |
77 | |
119 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
120 | Inputting characters appends them to the regex and continues incremental |
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
121 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
80 | history, C<enter> leaves search mode at the current position and C<escape> |
122 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
123 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
124 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
125 | additionally stores the first match in the current line into the primary |
|
|
126 | selection. |
82 | |
127 | |
83 | =item digital-clock |
128 | =item selection-autotransform |
84 | |
129 | |
85 | Displays a digital clock using the built-in overlay. |
130 | This selection allows you to do automatic transforms on a selection |
|
|
131 | whenever a selection is made. |
|
|
132 | |
|
|
133 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
134 | operator) that modify C<$_> as resources: |
|
|
135 | |
|
|
136 | URxvt.selection-autotransform.0: transform |
|
|
137 | URxvt.selection-autotransform.1: transform |
|
|
138 | ... |
|
|
139 | |
|
|
140 | For example, the following will transform selections of the form |
|
|
141 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
142 | $word>: |
|
|
143 | |
|
|
144 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
145 | |
|
|
146 | And this example matches the same,but replaces it with vi-commands you can |
|
|
147 | paste directly into your (vi :) editor: |
|
|
148 | |
|
|
149 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
150 | |
|
|
151 | Of course, this can be modified to suit your needs and your editor :) |
|
|
152 | |
|
|
153 | To expand the example above to typical perl error messages ("XXX at |
|
|
154 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
155 | |
|
|
156 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
157 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
158 | |
|
|
159 | The first line tells the selection code to treat the unchanging part of |
|
|
160 | every error message as a selection pattern, and the second line transforms |
|
|
161 | the message into vi commands to load the file. |
86 | |
162 | |
87 | =item mark-urls |
163 | =item mark-urls |
88 | |
164 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
165 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
90 | make them clickable. When middle-clicked, the program specified in the |
166 | make them clickable. When middle-clicked, the program specified in the |
91 | resource C<urlLauncher> (default C<x-www-browser>) will be started. |
167 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
168 | the URL as first argument. |
|
|
169 | |
|
|
170 | =item automove-background |
|
|
171 | |
|
|
172 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
173 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
174 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
175 | |
|
|
176 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
92 | |
177 | |
93 | =item block-graphics-to-ascii |
178 | =item block-graphics-to-ascii |
94 | |
179 | |
95 | A not very useful example of filtering all text output to the terminal, |
180 | A not very useful example of filtering all text output to the terminal, |
96 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
181 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
97 | similar-looking ascii character. |
182 | similar-looking ascii character. |
98 | |
183 | |
|
|
184 | =item digital-clock |
|
|
185 | |
|
|
186 | Displays a digital clock using the built-in overlay. |
|
|
187 | |
99 | =item example-refresh-hooks |
188 | =item example-refresh-hooks |
100 | |
189 | |
101 | Displays a very simple digital clock in the upper right corner of the |
190 | Displays a very simple digital clock in the upper right corner of the |
102 | window. Illustrates overwriting the refresh callbacks to create your own |
191 | window. Illustrates overwriting the refresh callbacks to create your own |
103 | overlays or changes. |
192 | overlays or changes. |
|
|
193 | |
|
|
194 | =item selection-pastebin |
|
|
195 | |
|
|
196 | This is a little rarely useful extension that Uploads the selection as |
|
|
197 | textfile to a remote site (or does other things). (The implementation is |
|
|
198 | not currently secure for use in a multiuser environment as it writes to |
|
|
199 | F</tmp> directly.). |
|
|
200 | |
|
|
201 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
202 | i.e. |
|
|
203 | |
|
|
204 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
205 | |
|
|
206 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
207 | the textfile. This command can be set via a resource: |
|
|
208 | |
|
|
209 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
210 | |
|
|
211 | And the default is likely not useful to anybody but the few people around |
|
|
212 | here :) |
|
|
213 | |
|
|
214 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
215 | the same content should lead to the same filename. |
|
|
216 | |
|
|
217 | After a successful upload the selection will be replaced by the text given |
|
|
218 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
219 | for the filename): |
|
|
220 | |
|
|
221 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
104 | |
222 | |
105 | =back |
223 | =back |
106 | |
224 | |
107 | =head1 API DOCUMENTATION |
225 | =head1 API DOCUMENTATION |
108 | |
226 | |
… | |
… | |
208 | =item on_start $term |
326 | =item on_start $term |
209 | |
327 | |
210 | Called at the very end of initialisation of a new terminal, just before |
328 | Called at the very end of initialisation of a new terminal, just before |
211 | returning to the mainloop. |
329 | returning to the mainloop. |
212 | |
330 | |
|
|
331 | =item on_child_start $term, $pid |
|
|
332 | |
|
|
333 | Called just after the child process has been C<fork>ed. |
|
|
334 | |
|
|
335 | =item on_child_exit $term, $status |
|
|
336 | |
|
|
337 | Called just after the child process has exited. C<$status> is the status |
|
|
338 | from C<waitpid>. |
|
|
339 | |
213 | =item on_sel_make $term, $eventtime |
340 | =item on_sel_make $term, $eventtime |
214 | |
341 | |
215 | Called whenever a selection has been made by the user, but before the |
342 | Called whenever a selection has been made by the user, but before the |
216 | selection text is copied, so changes to the beginning, end or type of the |
343 | selection text is copied, so changes to the beginning, end or type of the |
217 | selection will be honored. |
344 | selection will be honored. |
… | |
… | |
309 | |
436 | |
310 | Called whenever the user presses a key combination that has a |
437 | Called whenever the user presses a key combination that has a |
311 | C<perl:string> action bound to it (see description of the B<keysym> |
438 | C<perl:string> action bound to it (see description of the B<keysym> |
312 | resource in the @@RXVT_NAME@@(1) manpage). |
439 | resource in the @@RXVT_NAME@@(1) manpage). |
313 | |
440 | |
|
|
441 | =item on_x_event $term, $event |
|
|
442 | |
|
|
443 | Called on every X event received on the vt window (and possibly other |
|
|
444 | windows). Should only be used as a last resort. Most event structure |
|
|
445 | members are not passed. |
|
|
446 | |
314 | =item on_focus_in $term |
447 | =item on_focus_in $term |
315 | |
448 | |
316 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
449 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
317 | does focus in processing. |
450 | does focus in processing. |
318 | |
451 | |
319 | =item on_focus_out $term |
452 | =item on_focus_out $term |
320 | |
453 | |
321 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
454 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
322 | focus out processing. |
455 | focus out processing. |
|
|
456 | |
|
|
457 | =item on_configure_notify $term, $event |
323 | |
458 | |
324 | =item on_key_press $term, $event, $keysym, $octets |
459 | =item on_key_press $term, $event, $keysym, $octets |
325 | |
460 | |
326 | =item on_key_release $term, $event, $keysym |
461 | =item on_key_release $term, $event, $keysym |
327 | |
462 | |
… | |
… | |
413 | Using this function has the advantage that its output ends up in the |
548 | Using this function has the advantage that its output ends up in the |
414 | correct place, e.g. on stderr of the connecting urxvtc client. |
549 | correct place, e.g. on stderr of the connecting urxvtc client. |
415 | |
550 | |
416 | Messages have a size limit of 1023 bytes currently. |
551 | Messages have a size limit of 1023 bytes currently. |
417 | |
552 | |
418 | =item $is_safe = urxvt::safe |
|
|
419 | |
|
|
420 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
421 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
422 | started setuid or setgid. |
|
|
423 | |
|
|
424 | =item $time = urxvt::NOW |
553 | =item $time = urxvt::NOW |
425 | |
554 | |
426 | Returns the "current time" (as per the event loop). |
555 | Returns the "current time" (as per the event loop). |
427 | |
556 | |
428 | =item urxvt::CurrentTime |
557 | =item urxvt::CurrentTime |
429 | |
558 | |
430 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
559 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
431 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
560 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
432 | Button4Mask, Button5Mask, AnyModifier |
561 | Button4Mask, Button5Mask, AnyModifier |
|
|
562 | |
|
|
563 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
564 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
565 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
566 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
567 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
568 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
569 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
570 | |
|
|
571 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
572 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
573 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
574 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
575 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
576 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
577 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
433 | |
578 | |
434 | Various constants for use in X calls and event processing. |
579 | Various constants for use in X calls and event processing. |
435 | |
580 | |
436 | =back |
581 | =back |
437 | |
582 | |
… | |
… | |
488 | =back |
633 | =back |
489 | |
634 | |
490 | =cut |
635 | =cut |
491 | |
636 | |
492 | BEGIN { |
637 | BEGIN { |
493 | urxvt->bootstrap; |
|
|
494 | |
|
|
495 | # overwrite perl's warn |
638 | # overwrite perl's warn |
496 | *CORE::GLOBAL::warn = sub { |
639 | *CORE::GLOBAL::warn = sub { |
497 | my $msg = join "", @_; |
640 | my $msg = join "", @_; |
498 | $msg .= "\n" |
641 | $msg .= "\n" |
499 | unless $msg =~ /\n$/; |
642 | unless $msg =~ /\n$/; |
500 | urxvt::warn ($msg); |
643 | urxvt::warn ($msg); |
501 | }; |
644 | }; |
502 | |
|
|
503 | # %ENV is the original startup environment |
|
|
504 | delete $ENV{IFS}; |
|
|
505 | delete $ENV{CDPATH}; |
|
|
506 | delete $ENV{BASH_ENV}; |
|
|
507 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
508 | } |
645 | } |
509 | |
646 | |
510 | my @hook_count; |
|
|
511 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
647 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
512 | |
648 | |
513 | sub verbose { |
649 | sub verbose { |
514 | my ($level, $msg) = @_; |
650 | my ($level, $msg) = @_; |
515 | warn "$msg\n" if $level <= $verbosity; |
651 | warn "$msg\n" if $level <= $verbosity; |
516 | } |
652 | } |
517 | |
653 | |
518 | my $extension_pkg = "extension0000"; |
|
|
519 | my %extension_pkg; |
654 | my %extension_pkg; |
520 | |
655 | |
521 | # load a single script into its own package, once only |
656 | # load a single script into its own package, once only |
522 | sub extension_package($) { |
657 | sub extension_package($) { |
523 | my ($path) = @_; |
658 | my ($path) = @_; |
524 | |
659 | |
|
|
660 | no strict 'refs'; |
|
|
661 | |
525 | $extension_pkg{$path} ||= do { |
662 | $extension_pkg{$path} ||= do { |
526 | my $pkg = "urxvt::" . ($extension_pkg++); |
663 | $path =~ /([^\/\\]+)$/; |
|
|
664 | my $pkg = $1; |
|
|
665 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
666 | $pkg = "urxvt::ext::$pkg"; |
527 | |
667 | |
528 | verbose 3, "loading extension '$path' into package '$pkg'"; |
668 | verbose 3, "loading extension '$path' into package '$pkg'"; |
529 | |
669 | |
530 | open my $fh, "<:raw", $path |
670 | open my $fh, "<:raw", $path |
531 | or die "$path: $!"; |
671 | or die "$path: $!"; |
532 | |
672 | |
|
|
673 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
674 | |
533 | my $source = untaint |
675 | my $source = |
534 | "package $pkg; use strict; use utf8;\n" |
676 | "package $pkg; use strict; use utf8;\n" |
535 | . "use base urxvt::term::extension::;\n" |
|
|
536 | . "#line 1 \"$path\"\n{\n" |
677 | . "#line 1 \"$path\"\n{\n" |
537 | . (do { local $/; <$fh> }) |
678 | . (do { local $/; <$fh> }) |
538 | . "\n};\n1"; |
679 | . "\n};\n1"; |
539 | |
680 | |
540 | eval $source |
681 | eval $source |
… | |
… | |
603 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
744 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
604 | if $verbosity >= 11; |
745 | if $verbosity >= 11; |
605 | } |
746 | } |
606 | |
747 | |
607 | if ($htype == 1) { # DESTROY |
748 | if ($htype == 1) { # DESTROY |
608 | if (my $hook = delete $TERM->{_hook}) { |
|
|
609 | for my $htype (0..$#$hook) { |
|
|
610 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
611 | or set_should_invoke $htype, 0; |
|
|
612 | } |
|
|
613 | } |
|
|
614 | |
|
|
615 | # clear package objects |
749 | # clear package objects |
616 | %$_ = () for values %{ $TERM->{_pkg} }; |
750 | %$_ = () for values %{ $TERM->{_pkg} }; |
617 | |
751 | |
618 | # clear package |
752 | # clear package |
619 | %$TERM = (); |
753 | %$TERM = (); |
620 | } |
754 | } |
621 | |
755 | |
622 | $retval |
756 | $retval |
623 | } |
|
|
624 | |
|
|
625 | sub exec_async(@) { |
|
|
626 | my $pid = fork; |
|
|
627 | |
|
|
628 | return |
|
|
629 | if !defined $pid or $pid; |
|
|
630 | |
|
|
631 | %ENV = %{ $TERM->env }; |
|
|
632 | |
|
|
633 | exec @_; |
|
|
634 | _exit 255; |
|
|
635 | } |
757 | } |
636 | |
758 | |
637 | # urxvt::term::extension |
759 | # urxvt::term::extension |
638 | |
760 | |
639 | package urxvt::term::extension; |
761 | package urxvt::term::extension; |
… | |
… | |
645 | while (my ($name, $cb) = each %hook) { |
767 | while (my ($name, $cb) = each %hook) { |
646 | my $htype = $HOOKTYPE{uc $name}; |
768 | my $htype = $HOOKTYPE{uc $name}; |
647 | defined $htype |
769 | defined $htype |
648 | or Carp::croak "unsupported hook type '$name'"; |
770 | or Carp::croak "unsupported hook type '$name'"; |
649 | |
771 | |
|
|
772 | $self->set_should_invoke ($htype, +1) |
650 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
773 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
651 | $hook_count[$htype]++ |
|
|
652 | or urxvt::set_should_invoke $htype, 1; |
|
|
653 | } |
|
|
654 | |
774 | |
655 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
775 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
656 | } |
776 | } |
657 | } |
777 | } |
658 | |
778 | |
… | |
… | |
663 | for my $name (@hook) { |
783 | for my $name (@hook) { |
664 | my $htype = $HOOKTYPE{uc $name}; |
784 | my $htype = $HOOKTYPE{uc $name}; |
665 | defined $htype |
785 | defined $htype |
666 | or Carp::croak "unsupported hook type '$name'"; |
786 | or Carp::croak "unsupported hook type '$name'"; |
667 | |
787 | |
|
|
788 | $self->set_should_invoke ($htype, -1) |
668 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
789 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
669 | --$hook_count[$htype] |
|
|
670 | or urxvt::set_should_invoke $htype, 0; |
|
|
671 | } |
|
|
672 | } |
790 | } |
673 | } |
791 | } |
674 | |
792 | |
675 | our $AUTOLOAD; |
793 | our $AUTOLOAD; |
676 | |
794 | |
… | |
… | |
822 | |
940 | |
823 | Destroy the terminal object (close the window, free resources |
941 | Destroy the terminal object (close the window, free resources |
824 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
942 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
825 | watchers (timers, io watchers) are still active. |
943 | watchers (timers, io watchers) are still active. |
826 | |
944 | |
|
|
945 | =item $term->exec_async ($cmd[, @args]) |
|
|
946 | |
|
|
947 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
|
|
948 | ("starts") programs in the background. This function takes care of setting |
|
|
949 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
|
|
950 | be preferred over explicit calls to C<exec> or C<system>. |
|
|
951 | |
|
|
952 | Returns the pid of the subprocess or C<undef> on error. |
|
|
953 | |
|
|
954 | =cut |
|
|
955 | |
|
|
956 | sub exec_async { |
|
|
957 | my $self = shift; |
|
|
958 | |
|
|
959 | my $pid = fork; |
|
|
960 | |
|
|
961 | return $pid |
|
|
962 | if !defined $pid or $pid; |
|
|
963 | |
|
|
964 | %ENV = %{ $self->env }; |
|
|
965 | |
|
|
966 | exec @_; |
|
|
967 | urxvt::_exit 255; |
|
|
968 | } |
|
|
969 | |
827 | =item $isset = $term->option ($optval[, $set]) |
970 | =item $isset = $term->option ($optval[, $set]) |
828 | |
971 | |
829 | Returns true if the option specified by C<$optval> is enabled, and |
972 | Returns true if the option specified by C<$optval> is enabled, and |
830 | optionally change it. All option values are stored by name in the hash |
973 | optionally change it. All option values are stored by name in the hash |
831 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
974 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
… | |
… | |
833 | Here is a a likely non-exhaustive list of option names, please see the |
976 | Here is a a likely non-exhaustive list of option names, please see the |
834 | source file F</src/optinc.h> to see the actual list: |
977 | source file F</src/optinc.h> to see the actual list: |
835 | |
978 | |
836 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
979 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
837 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
980 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
838 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
981 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
839 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
982 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
840 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
983 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
841 | tripleclickwords utmpInhibit visualBell |
984 | transparent tripleclickwords utmpInhibit visualBell |
842 | |
985 | |
843 | =item $value = $term->resource ($name[, $newval]) |
986 | =item $value = $term->resource ($name[, $newval]) |
844 | |
987 | |
845 | Returns the current resource value associated with a given name and |
988 | Returns the current resource value associated with a given name and |
846 | optionally sets a new value. Setting values is most useful in the C<init> |
989 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
863 | |
1006 | |
864 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1007 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
865 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1008 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
866 | display_name embed ext_bwidth fade font geometry hold iconName |
1009 | display_name embed ext_bwidth fade font geometry hold iconName |
867 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1010 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
868 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1011 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
869 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1012 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
870 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1013 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
871 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1014 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
872 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1015 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
873 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1016 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
874 | shade term_name title transparent transparent_all tripleclickwords |
1017 | secondaryScreen secondaryScroll selectstyle shade term_name title |
875 | utmpInhibit visualBell |
1018 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
1019 | visualBell |
876 | |
1020 | |
877 | =cut |
1021 | =cut |
878 | |
1022 | |
879 | sub resource($$;$) { |
1023 | sub resource($$;$) { |
880 | my ($self, $name) = (shift, shift); |
1024 | my ($self, $name) = (shift, shift); |
… | |
… | |
1081 | |
1225 | |
1082 | =item $windowid = $term->vt |
1226 | =item $windowid = $term->vt |
1083 | |
1227 | |
1084 | Return the window id of the terminal window. |
1228 | Return the window id of the terminal window. |
1085 | |
1229 | |
|
|
1230 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1231 | |
|
|
1232 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1233 | to receive pointer events all the times: |
|
|
1234 | |
|
|
1235 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1236 | |
1086 | =item $window_width = $term->width |
1237 | =item $window_width = $term->width |
1087 | |
1238 | |
1088 | =item $window_height = $term->height |
1239 | =item $window_height = $term->height |
1089 | |
1240 | |
1090 | =item $font_width = $term->fwidth |
1241 | =item $font_width = $term->fwidth |
… | |
… | |
1103 | |
1254 | |
1104 | =item $max_scrollback = $term->saveLines |
1255 | =item $max_scrollback = $term->saveLines |
1105 | |
1256 | |
1106 | =item $nrow_plus_saveLines = $term->total_rows |
1257 | =item $nrow_plus_saveLines = $term->total_rows |
1107 | |
1258 | |
1108 | =item $lines_in_scrollback = $term->nsaved |
1259 | =item $topmost_scrollback_row = $term->top_row |
1109 | |
1260 | |
1110 | Return various integers describing terminal characteristics. |
1261 | Return various integers describing terminal characteristics. |
1111 | |
1262 | |
1112 | =item $x_display = $term->display_id |
1263 | =item $x_display = $term->display_id |
1113 | |
1264 | |
… | |
… | |
1141 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1292 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1142 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1293 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1143 | |
1294 | |
1144 | =item $view_start = $term->view_start ([$newvalue]) |
1295 | =item $view_start = $term->view_start ([$newvalue]) |
1145 | |
1296 | |
1146 | Returns the negative row number of the topmost line. Minimum value is |
1297 | Returns the row number of the topmost displayed line. Maximum value is |
1147 | C<0>, which displays the normal terminal contents. Larger values scroll |
1298 | C<0>, which displays the normal terminal contents. Lower values scroll |
1148 | this many lines into the scrollback buffer. |
1299 | this many lines into the scrollback buffer. |
1149 | |
1300 | |
1150 | =item $term->want_refresh |
1301 | =item $term->want_refresh |
1151 | |
1302 | |
1152 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1303 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1465 | my $env = $self->{term}->env; |
1616 | my $env = $self->{term}->env; |
1466 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1617 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1467 | delete $env->{LC_ALL}; |
1618 | delete $env->{LC_ALL}; |
1468 | $env->{LC_CTYPE} = $self->{term}->locale; |
1619 | $env->{LC_CTYPE} = $self->{term}->locale; |
1469 | |
1620 | |
1470 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1621 | urxvt::term->new ($env, "popup", |
1471 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1622 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1623 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1624 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1472 | "--transient-for" => $self->{term}->parent, |
1625 | "--transient-for" => $self->{term}->parent, |
1473 | "-display" => $self->{term}->display_id, |
1626 | "-display" => $self->{term}->display_id, |
1474 | "-pe" => "urxvt-popup") |
1627 | "-pe" => "urxvt-popup") |
1475 | or die "unable to create popup window\n"; |
1628 | or die "unable to create popup window\n"; |
1476 | } |
1629 | } |
… | |
… | |
1528 | Start the timer. |
1681 | Start the timer. |
1529 | |
1682 | |
1530 | =item $timer = $timer->start ($tstamp) |
1683 | =item $timer = $timer->start ($tstamp) |
1531 | |
1684 | |
1532 | Set the event trigger time to C<$tstamp> and start the timer. |
1685 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1686 | |
|
|
1687 | =item $timer = $timer->after ($delay) |
|
|
1688 | |
|
|
1689 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1533 | |
1690 | |
1534 | =item $timer = $timer->stop |
1691 | =item $timer = $timer->stop |
1535 | |
1692 | |
1536 | Stop the timer. |
1693 | Stop the timer. |
1537 | |
1694 | |