… | |
… | |
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 onto |
|
|
95 | C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. |
|
|
96 | |
|
|
97 | It's sole argument is the popup menu, which can be modified. The selection |
|
|
98 | is in C<$_>, which can be used to decide wether to add something or not. |
|
|
99 | It should either return nothing or a string and a code reference. The |
|
|
100 | string will be used as button text and the code reference will be called |
|
|
101 | when the button gets activated and should transform C<$_>. |
|
|
102 | |
|
|
103 | The following will add an entry C<a to b> that transforms all C<a>s in |
|
|
104 | the selection to C<b>s, but only if the selection currently contains any |
|
|
105 | C<a>s: |
|
|
106 | |
|
|
107 | push urxvt::ext::selection_popup::hook, sub { |
|
|
108 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
109 | : () |
|
|
110 | }; |
|
|
111 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
112 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
113 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
114 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
115 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
116 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
117 | screen. |
77 | |
118 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
119 | 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 |
120 | 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> |
121 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
122 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
123 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
124 | additionally stores the first match in the current line into the primary |
|
|
125 | selection. |
82 | |
126 | |
83 | =item digital-clock |
127 | =item selection-autotransform |
84 | |
128 | |
85 | Displays a digital clock using the built-in overlay. |
129 | This selection allows you to do automatic transforms on a selection |
|
|
130 | whenever a selection is made. |
|
|
131 | |
|
|
132 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
133 | operator) that modify C<$_> as resources: |
|
|
134 | |
|
|
135 | URxvt.selection-autotransform.0: transform |
|
|
136 | URxvt.selection-autotransform.1: transform |
|
|
137 | ... |
|
|
138 | |
|
|
139 | For example, the following will transform selections of the form |
|
|
140 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
141 | $word>: |
|
|
142 | |
|
|
143 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
144 | |
|
|
145 | And this example matches the same,but replaces it with vi-commands you can |
|
|
146 | paste directly into your (vi :) editor: |
|
|
147 | |
|
|
148 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
149 | |
|
|
150 | Of course, this can be modified to suit your needs and your editor :) |
|
|
151 | |
|
|
152 | To expand the example above to typical perl error messages ("XXX at |
|
|
153 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
154 | |
|
|
155 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
156 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
157 | |
|
|
158 | The first line tells the selection code to treat the unchanging part of |
|
|
159 | every error message as a selection pattern, and the second line transforms |
|
|
160 | the message into vi commands to load the file. |
86 | |
161 | |
87 | =item mark-urls |
162 | =item mark-urls |
88 | |
163 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
164 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
90 | make them clickable. When clicked, the program specified in the resource |
165 | make them clickable. When middle-clicked, the program specified in the |
91 | C<urlLauncher> (default C<x-www-browser>) will be started. |
166 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
167 | the URL as first argument. |
|
|
168 | |
|
|
169 | =item automove-background |
|
|
170 | |
|
|
171 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
172 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
173 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
174 | |
|
|
175 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
92 | |
176 | |
93 | =item block-graphics-to-ascii |
177 | =item block-graphics-to-ascii |
94 | |
178 | |
95 | A not very useful example of filtering all text output to the terminal, |
179 | 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 |
180 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
97 | similar-looking ascii character. |
181 | similar-looking ascii character. |
98 | |
182 | |
|
|
183 | =item digital-clock |
|
|
184 | |
|
|
185 | Displays a digital clock using the built-in overlay. |
|
|
186 | |
99 | =item example-refresh-hooks |
187 | =item example-refresh-hooks |
100 | |
188 | |
101 | Displays a very simple digital clock in the upper right corner of the |
189 | Displays a very simple digital clock in the upper right corner of the |
102 | window. Illustrates overwriting the refresh callbacks to create your own |
190 | window. Illustrates overwriting the refresh callbacks to create your own |
103 | overlays or changes. |
191 | overlays or changes. |
|
|
192 | |
|
|
193 | =item selection-pastebin |
|
|
194 | |
|
|
195 | This is a little rarely useful extension that Uploads the selection as |
|
|
196 | textfile to a remote site (or does other things). (The implementation is |
|
|
197 | not currently secure for use in a multiuser environment as it writes to |
|
|
198 | F</tmp> directly.). |
|
|
199 | |
|
|
200 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
|
|
201 | i.e. |
|
|
202 | |
|
|
203 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
|
|
204 | |
|
|
205 | Pressing this combination runs a command with C<%> replaced by the name of |
|
|
206 | the textfile. This command can be set via a resource: |
|
|
207 | |
|
|
208 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
209 | |
|
|
210 | And the default is likely not useful to anybody but the few people around |
|
|
211 | here :) |
|
|
212 | |
|
|
213 | The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
214 | the same content should lead to the same filename. |
|
|
215 | |
|
|
216 | After a successful upload the selection will be replaced by the text given |
|
|
217 | in the C<selection-pastebin-url> resource (again, the % is the placeholder |
|
|
218 | for the filename): |
|
|
219 | |
|
|
220 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
104 | |
221 | |
105 | =back |
222 | =back |
106 | |
223 | |
107 | =head1 API DOCUMENTATION |
224 | =head1 API DOCUMENTATION |
108 | |
225 | |
… | |
… | |
230 | =item on_sel_extend $term |
347 | =item on_sel_extend $term |
231 | |
348 | |
232 | Called whenever the user tries to extend the selection (e.g. with a double |
349 | Called whenever the user tries to extend the selection (e.g. with a double |
233 | click) and is either supposed to return false (normal operation), or |
350 | click) and is either supposed to return false (normal operation), or |
234 | should extend the selection itelf and return true to suppress the built-in |
351 | should extend the selection itelf and return true to suppress the built-in |
235 | processing. |
352 | processing. This can happen multiple times, as long as the callback |
|
|
353 | returns true, it will be called on every further click by the user and is |
|
|
354 | supposed to enlarge the selection more and more, if possible. |
236 | |
355 | |
237 | See the F<selection> example extension. |
356 | See the F<selection> example extension. |
238 | |
357 | |
239 | =item on_view_change $term, $offset |
358 | =item on_view_change $term, $offset |
240 | |
359 | |
… | |
… | |
307 | |
426 | |
308 | Called whenever the user presses a key combination that has a |
427 | Called whenever the user presses a key combination that has a |
309 | C<perl:string> action bound to it (see description of the B<keysym> |
428 | C<perl:string> action bound to it (see description of the B<keysym> |
310 | resource in the @@RXVT_NAME@@(1) manpage). |
429 | resource in the @@RXVT_NAME@@(1) manpage). |
311 | |
430 | |
|
|
431 | =item on_x_event $term, $event |
|
|
432 | |
|
|
433 | Called on every X event received on the vt window (and possibly other |
|
|
434 | windows). Should only be used as a last resort. Most event structure |
|
|
435 | members are not passed. |
|
|
436 | |
312 | =item on_focus_in $term |
437 | =item on_focus_in $term |
313 | |
438 | |
314 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
439 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
315 | does focus in processing. |
440 | does focus in processing. |
316 | |
441 | |
317 | =item on_focus_out $term |
442 | =item on_focus_out $term |
318 | |
443 | |
319 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
444 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
320 | focus out processing. |
445 | focus out processing. |
|
|
446 | |
|
|
447 | =item on_configure_notify $term, $event |
321 | |
448 | |
322 | =item on_key_press $term, $event, $keysym, $octets |
449 | =item on_key_press $term, $event, $keysym, $octets |
323 | |
450 | |
324 | =item on_key_release $term, $event, $keysym |
451 | =item on_key_release $term, $event, $keysym |
325 | |
452 | |
… | |
… | |
411 | Using this function has the advantage that its output ends up in the |
538 | Using this function has the advantage that its output ends up in the |
412 | correct place, e.g. on stderr of the connecting urxvtc client. |
539 | correct place, e.g. on stderr of the connecting urxvtc client. |
413 | |
540 | |
414 | Messages have a size limit of 1023 bytes currently. |
541 | Messages have a size limit of 1023 bytes currently. |
415 | |
542 | |
416 | =item $is_safe = urxvt::safe |
|
|
417 | |
|
|
418 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
419 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
420 | started setuid or setgid. |
|
|
421 | |
|
|
422 | =item $time = urxvt::NOW |
543 | =item $time = urxvt::NOW |
423 | |
544 | |
424 | Returns the "current time" (as per the event loop). |
545 | Returns the "current time" (as per the event loop). |
425 | |
546 | |
426 | =item urxvt::CurrentTime |
547 | =item urxvt::CurrentTime |
427 | |
548 | |
428 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
549 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
429 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
550 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
430 | Button4Mask, Button5Mask, AnyModifier |
551 | Button4Mask, Button5Mask, AnyModifier |
|
|
552 | |
|
|
553 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
554 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
555 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
556 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
557 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
558 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
559 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
560 | |
|
|
561 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
562 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
563 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
564 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
565 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
566 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
567 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
431 | |
568 | |
432 | Various constants for use in X calls and event processing. |
569 | Various constants for use in X calls and event processing. |
433 | |
570 | |
434 | =back |
571 | =back |
435 | |
572 | |
… | |
… | |
486 | =back |
623 | =back |
487 | |
624 | |
488 | =cut |
625 | =cut |
489 | |
626 | |
490 | BEGIN { |
627 | BEGIN { |
491 | urxvt->bootstrap; |
|
|
492 | |
|
|
493 | # overwrite perl's warn |
628 | # overwrite perl's warn |
494 | *CORE::GLOBAL::warn = sub { |
629 | *CORE::GLOBAL::warn = sub { |
495 | my $msg = join "", @_; |
630 | my $msg = join "", @_; |
496 | $msg .= "\n" |
631 | $msg .= "\n" |
497 | unless $msg =~ /\n$/; |
632 | unless $msg =~ /\n$/; |
498 | urxvt::warn ($msg); |
633 | urxvt::warn ($msg); |
499 | }; |
634 | }; |
500 | |
|
|
501 | # delete $ENV{IFS}; |
|
|
502 | # delete $ENV{CDPATH}; |
|
|
503 | # delete $ENV{BASH_ENV}; |
|
|
504 | # $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
|
|
505 | } |
635 | } |
506 | |
636 | |
507 | my @hook_count; |
|
|
508 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
637 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
509 | |
638 | |
510 | sub verbose { |
639 | sub verbose { |
511 | my ($level, $msg) = @_; |
640 | my ($level, $msg) = @_; |
512 | warn "$msg\n" if $level <= $verbosity; |
641 | warn "$msg\n" if $level <= $verbosity; |
513 | } |
642 | } |
514 | |
643 | |
515 | my $extension_pkg = "extension0000"; |
|
|
516 | my %extension_pkg; |
644 | my %extension_pkg; |
517 | |
645 | |
518 | # load a single script into its own package, once only |
646 | # load a single script into its own package, once only |
519 | sub extension_package($) { |
647 | sub extension_package($) { |
520 | my ($path) = @_; |
648 | my ($path) = @_; |
521 | |
649 | |
|
|
650 | no strict 'refs'; |
|
|
651 | |
522 | $extension_pkg{$path} ||= do { |
652 | $extension_pkg{$path} ||= do { |
523 | my $pkg = "urxvt::" . ($extension_pkg++); |
653 | $path =~ /([^\/\\]+)$/; |
|
|
654 | my $pkg = $1; |
|
|
655 | $pkg =~ s/[^[:word:]]/_/g; |
|
|
656 | $pkg = "urxvt::ext::$pkg"; |
524 | |
657 | |
525 | verbose 3, "loading extension '$path' into package '$pkg'"; |
658 | verbose 3, "loading extension '$path' into package '$pkg'"; |
526 | |
659 | |
527 | open my $fh, "<:raw", $path |
660 | open my $fh, "<:raw", $path |
528 | or die "$path: $!"; |
661 | or die "$path: $!"; |
529 | |
662 | |
|
|
663 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
|
|
664 | |
530 | my $source = untaint |
665 | my $source = |
531 | "package $pkg; use strict; use utf8;\n" |
666 | "package $pkg; use strict; use utf8;\n" |
532 | . "use base urxvt::term::extension::;\n" |
|
|
533 | . "#line 1 \"$path\"\n{\n" |
667 | . "#line 1 \"$path\"\n{\n" |
534 | . (do { local $/; <$fh> }) |
668 | . (do { local $/; <$fh> }) |
535 | . "\n};\n1"; |
669 | . "\n};\n1"; |
536 | |
670 | |
537 | eval $source |
671 | eval $source |
… | |
… | |
594 | if ($@) { |
728 | if ($@) { |
595 | $TERM->ungrab; # better to lose the grab than the session |
729 | $TERM->ungrab; # better to lose the grab than the session |
596 | warn $@; |
730 | warn $@; |
597 | } |
731 | } |
598 | } |
732 | } |
|
|
733 | |
|
|
734 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
735 | if $verbosity >= 11; |
599 | } |
736 | } |
600 | |
737 | |
601 | if ($htype == 1) { # DESTROY |
738 | if ($htype == 1) { # DESTROY |
602 | if (my $hook = delete $TERM->{_hook}) { |
|
|
603 | for my $htype (0..$#$hook) { |
|
|
604 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
605 | or set_should_invoke $htype, 0; |
|
|
606 | } |
|
|
607 | } |
|
|
608 | |
|
|
609 | # clear package objects |
739 | # clear package objects |
610 | %$_ = () for values %{ $TERM->{_pkg} }; |
740 | %$_ = () for values %{ $TERM->{_pkg} }; |
611 | |
741 | |
612 | # clear package |
742 | # clear package |
613 | %$TERM = (); |
743 | %$TERM = (); |
614 | } |
744 | } |
615 | |
745 | |
616 | $retval |
746 | $retval |
|
|
747 | } |
|
|
748 | |
|
|
749 | sub exec_async(@) { |
|
|
750 | my $pid = fork; |
|
|
751 | |
|
|
752 | return |
|
|
753 | if !defined $pid or $pid; |
|
|
754 | |
|
|
755 | %ENV = %{ $TERM->env }; |
|
|
756 | |
|
|
757 | exec @_; |
|
|
758 | _exit 255; |
617 | } |
759 | } |
618 | |
760 | |
619 | # urxvt::term::extension |
761 | # urxvt::term::extension |
620 | |
762 | |
621 | package urxvt::term::extension; |
763 | package urxvt::term::extension; |
… | |
… | |
627 | while (my ($name, $cb) = each %hook) { |
769 | while (my ($name, $cb) = each %hook) { |
628 | my $htype = $HOOKTYPE{uc $name}; |
770 | my $htype = $HOOKTYPE{uc $name}; |
629 | defined $htype |
771 | defined $htype |
630 | or Carp::croak "unsupported hook type '$name'"; |
772 | or Carp::croak "unsupported hook type '$name'"; |
631 | |
773 | |
|
|
774 | $self->set_should_invoke ($htype, +1) |
632 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
775 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
633 | $hook_count[$htype]++ |
|
|
634 | or urxvt::set_should_invoke $htype, 1; |
|
|
635 | } |
|
|
636 | |
776 | |
637 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
777 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
638 | } |
778 | } |
639 | } |
779 | } |
640 | |
780 | |
… | |
… | |
645 | for my $name (@hook) { |
785 | for my $name (@hook) { |
646 | my $htype = $HOOKTYPE{uc $name}; |
786 | my $htype = $HOOKTYPE{uc $name}; |
647 | defined $htype |
787 | defined $htype |
648 | or Carp::croak "unsupported hook type '$name'"; |
788 | or Carp::croak "unsupported hook type '$name'"; |
649 | |
789 | |
|
|
790 | $self->set_should_invoke ($htype, -1) |
650 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
791 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
651 | --$hook_count[$htype] |
|
|
652 | or urxvt::set_should_invoke $htype, 0; |
|
|
653 | } |
|
|
654 | } |
792 | } |
655 | } |
793 | } |
656 | |
794 | |
657 | our $AUTOLOAD; |
795 | our $AUTOLOAD; |
658 | |
796 | |
… | |
… | |
815 | Here is a a likely non-exhaustive list of option names, please see the |
953 | Here is a a likely non-exhaustive list of option names, please see the |
816 | source file F</src/optinc.h> to see the actual list: |
954 | source file F</src/optinc.h> to see the actual list: |
817 | |
955 | |
818 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
956 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
819 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
957 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
820 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
958 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
821 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
959 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
822 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
960 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
823 | tripleclickwords utmpInhibit visualBell |
961 | transparent tripleclickwords utmpInhibit visualBell |
824 | |
962 | |
825 | =item $value = $term->resource ($name[, $newval]) |
963 | =item $value = $term->resource ($name[, $newval]) |
826 | |
964 | |
827 | Returns the current resource value associated with a given name and |
965 | Returns the current resource value associated with a given name and |
828 | optionally sets a new value. Setting values is most useful in the C<init> |
966 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
845 | |
983 | |
846 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
984 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
847 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
985 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
848 | display_name embed ext_bwidth fade font geometry hold iconName |
986 | display_name embed ext_bwidth fade font geometry hold iconName |
849 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
987 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
850 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
988 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
851 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
989 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
852 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
990 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
853 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
991 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
854 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
992 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
855 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
993 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
856 | shade term_name title transparent transparent_all tripleclickwords |
994 | secondaryScreen secondaryScroll selectstyle shade term_name title |
857 | utmpInhibit visualBell |
995 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
|
|
996 | visualBell |
858 | |
997 | |
859 | =cut |
998 | =cut |
860 | |
999 | |
861 | sub resource($$;$) { |
1000 | sub resource($$;$) { |
862 | my ($self, $name) = (shift, shift); |
1001 | my ($self, $name) = (shift, shift); |
… | |
… | |
897 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1036 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
898 | |
1037 | |
899 | Return the current values of the selection mark, begin or end positions, |
1038 | Return the current values of the selection mark, begin or end positions, |
900 | and optionally set them to new values. |
1039 | and optionally set them to new values. |
901 | |
1040 | |
|
|
1041 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1042 | |
|
|
1043 | Tries to make a selection as set by C<selection_beg> and |
|
|
1044 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1045 | rectangular selection will be made. This is the prefered function to make |
|
|
1046 | a selection. |
|
|
1047 | |
902 | =item $success = $term->selection_grab ($eventtime) |
1048 | =item $success = $term->selection_grab ($eventtime) |
903 | |
1049 | |
904 | Try to request the primary selection from the server (for example, as set |
1050 | Try to request the primary selection text from the server (for example, as |
905 | by the next method). |
1051 | set by the next method). No visual feedback will be given. This function |
|
|
1052 | is mostly useful from within C<on_sel_grab> hooks. |
906 | |
1053 | |
907 | =item $oldtext = $term->selection ([$newtext]) |
1054 | =item $oldtext = $term->selection ([$newtext]) |
908 | |
1055 | |
909 | Return the current selection text and optionally replace it by C<$newtext>. |
1056 | Return the current selection text and optionally replace it by C<$newtext>. |
910 | |
1057 | |
… | |
… | |
1003 | Convert the given locale-encoded octets into a perl string. |
1150 | Convert the given locale-encoded octets into a perl string. |
1004 | |
1151 | |
1005 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1152 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1006 | |
1153 | |
1007 | XORs the rendition values in the given span with the provided value |
1154 | XORs the rendition values in the given span with the provided value |
1008 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1155 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
1009 | to the selection. |
1156 | refresh hooks to provide effects similar to the selection. |
1010 | |
1157 | |
1011 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1158 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1012 | |
1159 | |
1013 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1160 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1014 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1161 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1015 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1162 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1016 | it instead. |
1163 | it instead. Both styles I<MUST NOT> contain font styles. |
1017 | |
1164 | |
1018 | =item $term->scr_bell |
1165 | =item $term->scr_bell |
1019 | |
1166 | |
1020 | Ring the bell! |
1167 | Ring the bell! |
1021 | |
1168 | |
… | |
… | |
1055 | |
1202 | |
1056 | =item $windowid = $term->vt |
1203 | =item $windowid = $term->vt |
1057 | |
1204 | |
1058 | Return the window id of the terminal window. |
1205 | Return the window id of the terminal window. |
1059 | |
1206 | |
|
|
1207 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1208 | |
|
|
1209 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1210 | to receive pointer events all the times: |
|
|
1211 | |
|
|
1212 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1213 | |
1060 | =item $window_width = $term->width |
1214 | =item $window_width = $term->width |
1061 | |
1215 | |
1062 | =item $window_height = $term->height |
1216 | =item $window_height = $term->height |
1063 | |
1217 | |
1064 | =item $font_width = $term->fwidth |
1218 | =item $font_width = $term->fwidth |
… | |
… | |
1077 | |
1231 | |
1078 | =item $max_scrollback = $term->saveLines |
1232 | =item $max_scrollback = $term->saveLines |
1079 | |
1233 | |
1080 | =item $nrow_plus_saveLines = $term->total_rows |
1234 | =item $nrow_plus_saveLines = $term->total_rows |
1081 | |
1235 | |
1082 | =item $lines_in_scrollback = $term->nsaved |
1236 | =item $topmost_scrollback_row = $term->top_row |
1083 | |
1237 | |
1084 | Return various integers describing terminal characteristics. |
1238 | Return various integers describing terminal characteristics. |
1085 | |
1239 | |
1086 | =item $x_display = $term->display_id |
1240 | =item $x_display = $term->display_id |
1087 | |
1241 | |
… | |
… | |
1115 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1269 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1116 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1270 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1117 | |
1271 | |
1118 | =item $view_start = $term->view_start ([$newvalue]) |
1272 | =item $view_start = $term->view_start ([$newvalue]) |
1119 | |
1273 | |
1120 | Returns the negative row number of the topmost line. Minimum value is |
1274 | Returns the row number of the topmost displayed line. Maximum value is |
1121 | C<0>, which displays the normal terminal contents. Larger values scroll |
1275 | C<0>, which displays the normal terminal contents. Lower values scroll |
1122 | this many lines into the scrollback buffer. |
1276 | this many lines into the scrollback buffer. |
1123 | |
1277 | |
1124 | =item $term->want_refresh |
1278 | =item $term->want_refresh |
1125 | |
1279 | |
1126 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1280 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
… | |
… | |
1205 | Return the row number of the first/last row of the line, respectively. |
1359 | Return the row number of the first/last row of the line, respectively. |
1206 | |
1360 | |
1207 | =item $offset = $line->offset_of ($row, $col) |
1361 | =item $offset = $line->offset_of ($row, $col) |
1208 | |
1362 | |
1209 | Returns the character offset of the given row|col pair within the logical |
1363 | Returns the character offset of the given row|col pair within the logical |
1210 | line. |
1364 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1365 | offsets outside the string. |
1211 | |
1366 | |
1212 | =item ($row, $col) = $line->coord_of ($offset) |
1367 | =item ($row, $col) = $line->coord_of ($offset) |
1213 | |
1368 | |
1214 | Translates a string offset into terminal coordinates again. |
1369 | Translates a string offset into terminal coordinates again. |
1215 | |
1370 | |
… | |
… | |
1438 | my $env = $self->{term}->env; |
1593 | my $env = $self->{term}->env; |
1439 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1594 | # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. |
1440 | delete $env->{LC_ALL}; |
1595 | delete $env->{LC_ALL}; |
1441 | $env->{LC_CTYPE} = $self->{term}->locale; |
1596 | $env->{LC_CTYPE} = $self->{term}->locale; |
1442 | |
1597 | |
1443 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1598 | urxvt::term->new ($env, "popup", |
1444 | "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, |
1599 | "--perl-lib" => "", "--perl-ext-common" => "", |
|
|
1600 | "-pty-fd" => -1, "-sl" => 0, |
|
|
1601 | "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", |
1445 | "--transient-for" => $self->{term}->parent, |
1602 | "--transient-for" => $self->{term}->parent, |
1446 | "-display" => $self->{term}->display_id, |
1603 | "-display" => $self->{term}->display_id, |
1447 | "-pe" => "urxvt-popup") |
1604 | "-pe" => "urxvt-popup") |
1448 | or die "unable to create popup window\n"; |
1605 | or die "unable to create popup window\n"; |
1449 | } |
1606 | } |
… | |
… | |
1501 | Start the timer. |
1658 | Start the timer. |
1502 | |
1659 | |
1503 | =item $timer = $timer->start ($tstamp) |
1660 | =item $timer = $timer->start ($tstamp) |
1504 | |
1661 | |
1505 | Set the event trigger time to C<$tstamp> and start the timer. |
1662 | Set the event trigger time to C<$tstamp> and start the timer. |
|
|
1663 | |
|
|
1664 | =item $timer = $timer->after ($delay) |
|
|
1665 | |
|
|
1666 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1506 | |
1667 | |
1507 | =item $timer = $timer->stop |
1668 | =item $timer = $timer->stop |
1508 | |
1669 | |
1509 | Stop the timer. |
1670 | Stop the timer. |
1510 | |
1671 | |
… | |
… | |
1570 | |
1731 | |
1571 | =item == 0 - fatal messages |
1732 | =item == 0 - fatal messages |
1572 | |
1733 | |
1573 | =item >= 3 - script loading and management |
1734 | =item >= 3 - script loading and management |
1574 | |
1735 | |
1575 | =item >=10 - all events received |
1736 | =item >=10 - all called hooks |
|
|
1737 | |
|
|
1738 | =item >=11 - hook reutrn values |
1576 | |
1739 | |
1577 | =back |
1740 | =back |
1578 | |
1741 | |
1579 | =head1 AUTHOR |
1742 | =head1 AUTHOR |
1580 | |
1743 | |