… | |
… | |
84 | far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 |
84 | far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 |
85 | Orange'. |
85 | Orange'. |
86 | |
86 | |
87 | The following options are available: |
87 | The following options are available: |
88 | |
88 | |
89 | =over 4 |
89 | =over |
90 | |
90 | |
91 | =item B<-help>, B<--help> |
91 | =item B<-help>, B<--help> |
92 | |
92 | |
93 | Print out a message describing available options. |
93 | Print out a message describing available options. |
94 | |
94 | |
… | |
… | |
108 | of graphical corruption. This is harmless, but we can't do anything about |
108 | of graphical corruption. This is harmless, but we can't do anything about |
109 | this, so watch out] |
109 | this, so watch out] |
110 | |
110 | |
111 | =item B<-visual> I<visualID> |
111 | =item B<-visual> I<visualID> |
112 | |
112 | |
113 | Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible |
113 | Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for |
114 | visual ids). |
114 | possible visual ids) instead of the default, and also allocate a private |
|
|
115 | colormap. All visual types except for DirectColor are supported. |
115 | |
116 | |
116 | =item B<-geometry> I<geom> |
117 | =item B<-geometry> I<geom> |
117 | |
118 | |
118 | Window geometry (B<-g> still respected); resource B<geometry>. |
119 | Window geometry (B<-g> still respected); resource B<geometry>. |
119 | |
120 | |
… | |
… | |
126 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
127 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
127 | |
128 | |
128 | =item B<-ss>|B<+ss> |
129 | =item B<-ss>|B<+ss> |
129 | |
130 | |
130 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
131 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
|
|
132 | |
|
|
133 | =item B<-fps> I<number> |
|
|
134 | |
|
|
135 | Compile I<frills>: Set the refresh interval (in frames per second or |
|
|
136 | negative seconds); resource B<refreshRate>. |
131 | |
137 | |
132 | =item B<-fade> I<number> |
138 | =item B<-fade> I<number> |
133 | |
139 | |
134 | Fade the text by the given percentage when focus is lost. Small values |
140 | Fade the text by the given percentage when focus is lost. Small values |
135 | fade a little only, 100 completely replaces all colours by the fade |
141 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
219 | |
225 | |
220 | =item B<-ls>|B<+ls> |
226 | =item B<-ls>|B<+ls> |
221 | |
227 | |
222 | Start as a login-shell/sub-shell; resource B<loginShell>. |
228 | Start as a login-shell/sub-shell; resource B<loginShell>. |
223 | |
229 | |
|
|
230 | =item B<-mc> I<milliseconds> |
|
|
231 | |
|
|
232 | Specify the maximum time between multi-click selections. |
|
|
233 | |
224 | =item B<-ut>|B<+ut> |
234 | =item B<-ut>|B<+ut> |
225 | |
235 | |
226 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
236 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
227 | B<utmpInhibit>. |
237 | B<utmpInhibit>. |
228 | |
238 | |
… | |
… | |
306 | |
316 | |
307 | =item B<-override-redirect> |
317 | =item B<-override-redirect> |
308 | |
318 | |
309 | Compile I<frills>: Sets override-redirect on the window; resource |
319 | Compile I<frills>: Sets override-redirect on the window; resource |
310 | B<override-redirect>. |
320 | B<override-redirect>. |
|
|
321 | |
|
|
322 | =item B<-dockapp> |
|
|
323 | |
|
|
324 | Sets the initial state of the window to WithdrawnState, which makes |
|
|
325 | window managers that support this extension treat it as a dockapp. |
311 | |
326 | |
312 | =item B<-sbg> |
327 | =item B<-sbg> |
313 | |
328 | |
314 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
329 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
315 | drawing characters and just rely on what the specified fonts provide. Use |
330 | drawing characters and just rely on what the specified fonts provide. Use |
… | |
… | |
370 | =item B<-pt> I<style> |
385 | =item B<-pt> I<style> |
371 | |
386 | |
372 | Compile I<XIM>: input style for input method; B<OverTheSpot>, |
387 | Compile I<XIM>: input style for input method; B<OverTheSpot>, |
373 | B<OffTheSpot>, B<Root>; resource B<preeditType>. |
388 | B<OffTheSpot>, B<Root>; resource B<preeditType>. |
374 | |
389 | |
|
|
390 | If the perl extension C<xim-onthespot> is used (which is the default), |
|
|
391 | then additionally the C<OnTheSpot> preedit type is available. |
|
|
392 | |
375 | =item B<-im> I<text> |
393 | =item B<-im> I<text> |
376 | |
394 | |
377 | Compile I<XIM>: input method name. resource B<inputMethod>. |
395 | Compile I<XIM>: input method name. resource B<inputMethod>. |
378 | |
396 | |
379 | =item B<-imlocale> I<string> |
397 | =item B<-imlocale> I<string> |
… | |
… | |
393 | Change the meaning of triple-click selection with the left mouse |
411 | Change the meaning of triple-click selection with the left mouse |
394 | button. Only effective when the original (non-perl) selection code is |
412 | button. Only effective when the original (non-perl) selection code is |
395 | in-use. Instead of selecting a full line it will extend the selection to |
413 | in-use. Instead of selecting a full line it will extend the selection to |
396 | the end of the logical line only. resource B<tripleclickwords>. |
414 | the end of the logical line only. resource B<tripleclickwords>. |
397 | |
415 | |
|
|
416 | =item B<-dpb>|B<+dpb> |
|
|
417 | |
|
|
418 | Compile frills: Disable (or enable) emitting bracketed paste mode |
|
|
419 | sequences (default enabled). Bracketed paste mode allows programs |
|
|
420 | to detect when something is pasted. Since more and more programs |
|
|
421 | abuse this, these sequences can be disabled. The command sequences to |
|
|
422 | enable and query paste mode will still work, but the actual bracket |
|
|
423 | sequences will no longer be emitted. You can also toggle this from the |
|
|
424 | ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>. |
|
|
425 | |
398 | =item B<-insecure> |
426 | =item B<-insecure> |
399 | |
427 | |
400 | Enable "insecure" mode, which currently enables most of the escape |
428 | Enable "insecure" mode, which currently enables most of the escape |
401 | sequences that echo strings. See the resource B<insecure> for more |
429 | sequences that echo strings. See the resource B<insecure> for more |
402 | info. |
430 | info. |
… | |
… | |
414 | |
442 | |
415 | =item B<-ssr>|B<+ssr> |
443 | =item B<-ssr>|B<+ssr> |
416 | |
444 | |
417 | Turn on/off secondary screen scroll (default enabled); resource |
445 | Turn on/off secondary screen scroll (default enabled); resource |
418 | B<secondaryScroll>. |
446 | B<secondaryScroll>. |
|
|
447 | |
|
|
448 | =item B<-rm> I<mode> |
|
|
449 | |
|
|
450 | Compile I<frills>: Sets long line rewrapping behaviour on window resizes |
|
|
451 | to one of B<auto> (the default), B<always> or B<never>. The latter two |
|
|
452 | modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback |
|
|
453 | is non-empty, and wings lines (acts like B<never>) otherwise; resource |
|
|
454 | B<rewrapMode>. |
419 | |
455 | |
420 | =item B<-hold>|B<+hold> |
456 | =item B<-hold>|B<+hold> |
421 | |
457 | |
422 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
458 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
423 | will not immediately destroy its window when the program executed within |
459 | will not immediately destroy its window when the program executed within |
… | |
… | |
501 | close $pty; |
537 | close $pty; |
502 | |
538 | |
503 | # now communicate with rxvt |
539 | # now communicate with rxvt |
504 | my $slave = $pty->slave; |
540 | my $slave = $pty->slave; |
505 | while (<$slave>) { print $slave "got <$_>\n" } |
541 | while (<$slave>) { print $slave "got <$_>\n" } |
|
|
542 | |
|
|
543 | Note that, despite what the name might imply, the file descriptor does not |
|
|
544 | need to be a pty, it can be a bi-directional pipe as well (e.g. a unix |
|
|
545 | domain or tcp socket). While tty operations cannot be done in this case, |
|
|
546 | B<@@RXVT_NAME@@> can still be remote controlled with it: |
|
|
547 | |
|
|
548 | use Socket; |
|
|
549 | use Fcntl; |
|
|
550 | |
|
|
551 | socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC; |
|
|
552 | fcntl $slave, Fcntl::F_SETFD, 0; |
|
|
553 | system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &"; |
|
|
554 | close $slave; |
|
|
555 | |
|
|
556 | syswrite $URXVT, "Type a secret password: "; |
|
|
557 | my $secret = do { local $/ = "\r"; <$URXVT> }; |
|
|
558 | print "Not so secret anymore: $secret\n"; |
506 | |
559 | |
507 | =item B<-pe> I<string> |
560 | =item B<-pe> I<string> |
508 | |
561 | |
509 | Comma-separated list of perl extension scripts to use (or not to use) in |
562 | Comma-separated list of perl extension scripts to use (or not to use) in |
510 | this terminal instance. See resource B<perl-ext> for details. |
563 | this terminal instance. See resource B<perl-ext> for details. |
… | |
… | |
538 | be used. Command-line arguments can be used to override resource |
591 | be used. Command-line arguments can be used to override resource |
539 | settings. The following resources are supported (you might want to |
592 | settings. The following resources are supported (you might want to |
540 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
593 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
541 | extensions not documented here): |
594 | extensions not documented here): |
542 | |
595 | |
543 | =over 4 |
596 | =over |
544 | |
597 | |
545 | =item B<depth:> I<bitdepth> |
598 | =item B<depth:> I<bitdepth> |
546 | |
599 | |
547 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
600 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
548 | option B<-depth>. |
601 | option B<-depth>. |
… | |
… | |
649 | |
702 | |
650 | B<False>: specify that everything is to be displayed, even |
703 | B<False>: specify that everything is to be displayed, even |
651 | if the refresh is too fast for the human eye to read anything (or the |
704 | if the refresh is too fast for the human eye to read anything (or the |
652 | monitor to display anything); option B<+ss>. |
705 | monitor to display anything); option B<+ss>. |
653 | |
706 | |
|
|
707 | =item B<refreshRate:> I<number> |
|
|
708 | |
|
|
709 | Compile I<frills>: When positive, sets the maximum refreshes per second |
|
|
710 | (the default is C<60>). When zero or negative, sets the minimum interval |
|
|
711 | between refreshes, negated. That is, positive numbers limit the number |
|
|
712 | of refreshes per second to that number, similar to a fps limiter in |
|
|
713 | games. A negative number gets negated and directly sets the minimum |
|
|
714 | interval between refreshes, that is, C<10> and C<-0.1> both specify |
|
|
715 | the same refresh interval (likewise C<50> and C<0.02>). Finally, zero |
|
|
716 | makes @@RXVT_NAME@@ refresh as fast as possible. Fractional values are |
|
|
717 | supported; option B<-fps>. |
|
|
718 | |
654 | =item B<fading:> I<number> |
719 | =item B<fading:> I<number> |
655 | |
720 | |
656 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
721 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
657 | |
722 | |
658 | =item B<fadeColor:> I<colour> |
723 | =item B<fadeColor:> I<colour> |
… | |
… | |
781 | |
846 | |
782 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
847 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
783 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
848 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
784 | [default]; option B<+ls>. |
849 | [default]; option B<+ls>. |
785 | |
850 | |
|
|
851 | =item B<multiClickTime:> I<number> |
|
|
852 | |
|
|
853 | Specify the maximum time in milliseconds between multi-click select |
|
|
854 | events. The default is 500 milliseconds; option B<-mc>. |
|
|
855 | |
786 | =item B<utmpInhibit:> I<boolean> |
856 | =item B<utmpInhibit:> I<boolean> |
787 | |
857 | |
788 | B<True>: inhibit writing record into the system log file B<utmp>; |
858 | B<True>: inhibit writing record into the system log file B<utmp>; |
789 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
859 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
790 | [default]; option B<+ut>. |
860 | [default]; option B<+ut>. |
… | |
… | |
833 | Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
903 | Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
834 | thumb with the pointer on middle button press/drag. |
904 | thumb with the pointer on middle button press/drag. |
835 | |
905 | |
836 | =item B<scrollTtyOutput:> I<boolean> |
906 | =item B<scrollTtyOutput:> I<boolean> |
837 | |
907 | |
838 | B<True>: scroll to bottom when tty receives output; option B<-si>. |
908 | B<True>: scroll to bottom when tty receives output; option B<+si>. |
839 | B<False>: do not scroll to bottom when tty receives output; option |
909 | B<False>: do not scroll to bottom when tty receives output; option |
840 | B<+si>. |
910 | B<-si>. |
841 | |
911 | |
842 | =item B<scrollWithBuffer:> I<boolean> |
912 | =item B<scrollWithBuffer:> I<boolean> |
843 | |
913 | |
844 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
914 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
845 | try to show the same lines) and B<scrollTtyOutput> is False; option |
915 | try to show the same lines) and B<scrollTtyOutput> is False; option |
… | |
… | |
853 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
923 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
854 | bottom when a non-special key is pressed; option B<+sk>. |
924 | bottom when a non-special key is pressed; option B<+sk>. |
855 | |
925 | |
856 | =item B<saveLines:> I<number> |
926 | =item B<saveLines:> I<number> |
857 | |
927 | |
858 | Save I<number> lines in the scrollback buffer [default 64]. This |
928 | Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>. |
859 | resource is limited on most machines to 65535; option B<-sl>. |
|
|
860 | |
929 | |
861 | =item B<internalBorder:> I<number> |
930 | =item B<internalBorder:> I<number> |
862 | |
931 | |
863 | Internal border of I<number> pixels. This resource is limited to 100; |
932 | Internal border of I<number> pixels. This resource is limited to 100; |
864 | option B<-b>. |
933 | option B<-b>. |
… | |
… | |
927 | |
996 | |
928 | =item B<pointerColor2:> I<colour> |
997 | =item B<pointerColor2:> I<colour> |
929 | |
998 | |
930 | Mouse pointer background colour. |
999 | Mouse pointer background colour. |
931 | |
1000 | |
|
|
1001 | =item B<pointerShape:> I<string> |
|
|
1002 | |
|
|
1003 | Compile I<frills>: Specifies the name of the mouse pointer shape |
|
|
1004 | [default B<xterm>]. See the macros in the B<X11/cursorfont.h> include |
|
|
1005 | file for possible values (omit the C<XC_> prefix). |
|
|
1006 | |
932 | =item B<pointerBlankDelay:> I<number> |
1007 | =item B<pointerBlankDelay:> I<number> |
933 | |
1008 | |
934 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
1009 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
935 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1010 | large number (e.g. C<987654321>) to effectively disable the timeout. |
936 | |
1011 | |
… | |
… | |
962 | |
1037 | |
963 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
1038 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
964 | |
1039 | |
965 | =item B<preeditType:> I<style> |
1040 | =item B<preeditType:> I<style> |
966 | |
1041 | |
967 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1042 | B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
968 | |
1043 | |
969 | =item B<inputMethod:> I<name> |
1044 | =item B<inputMethod:> I<name> |
970 | |
1045 | |
971 | I<name> of inputMethod to use; option B<-im>. |
1046 | I<name> of inputMethod to use; option B<-im>. |
972 | |
1047 | |
… | |
… | |
990 | |
1065 | |
991 | Change the meaning of triple-click selection with the left mouse |
1066 | Change the meaning of triple-click selection with the left mouse |
992 | button. Instead of selecting a full line it will extend the selection to |
1067 | button. Instead of selecting a full line it will extend the selection to |
993 | the end of the logical line only; option B<-tcw>. |
1068 | the end of the logical line only; option B<-tcw>. |
994 | |
1069 | |
|
|
1070 | =item B<disablePasteBrackets:> I<boolean> |
|
|
1071 | |
|
|
1072 | Prevent emission of paste bracket sequences; option B<-dpb>. |
|
|
1073 | |
995 | =item B<insecure:> I<boolean> |
1074 | =item B<insecure:> I<boolean> |
996 | |
1075 | |
997 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
1076 | Enable "insecure" mode. Rxvt-unicode offers some escape sequences that |
998 | echo arbitrary strings like the icon name or the locale. This could be |
1077 | echo arbitrary strings like the icon name or the locale. This could be |
999 | abused if somebody gets 8-bit-clean access to your display, whether |
1078 | abused if somebody gets 8-bit-clean access to your display, whether |
1000 | through a mail client displaying mail bodies unfiltered or through |
1079 | through a mail client displaying mail bodies unfiltered or through |
1001 | write(1) or any other means. Therefore, these sequences are disabled by |
1080 | write(1) or any other means. Therefore, these sequences are disabled by |
1002 | default. (Note that many other terminals, including xterm, have these |
1081 | default. (Note that many other terminals, including xterm, have these |
… | |
… | |
1020 | |
1099 | |
1021 | =item B<secondaryScreen:> I<boolean> |
1100 | =item B<secondaryScreen:> I<boolean> |
1022 | |
1101 | |
1023 | Turn on/off secondary screen (default enabled). |
1102 | Turn on/off secondary screen (default enabled). |
1024 | |
1103 | |
|
|
1104 | =item B<rewrapMode:> I<mode> |
|
|
1105 | |
|
|
1106 | Sets long line rewrap behaviour on window resize to one of B<auto> |
|
|
1107 | (default), B<always> or B<never>. |
|
|
1108 | |
1025 | =item B<secondaryScroll:> I<boolean> |
1109 | =item B<secondaryScroll:> I<boolean> |
1026 | |
1110 | |
1027 | Turn on/off secondary screen scroll (default enabled). If this |
1111 | Turn on/off secondary screen scroll (default enabled). If this |
1028 | option is enabled, scrolls on the secondary screen will change the |
1112 | option is enabled, scrolls on the secondary screen will change the |
1029 | scrollback buffer and, when secondaryScreen is off, switching |
1113 | scrollback buffer and, when secondaryScreen is off, switching |
… | |
… | |
1056 | |
1140 | |
1057 | The key combination that triggers the action, I<sym>, has the following format: |
1141 | The key combination that triggers the action, I<sym>, has the following format: |
1058 | |
1142 | |
1059 | (modifiers-)key |
1143 | (modifiers-)key |
1060 | |
1144 | |
1061 | Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, |
1145 | Where I<modifiers> can be any combination of the following full or |
1062 | B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, |
1146 | abbreviated modifier names: |
1063 | B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, |
1147 | |
1064 | B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. |
1148 | =begin table |
|
|
1149 | |
|
|
1150 | B<ISOLevel3> B<I> |
|
|
1151 | B<AppKeypad> B<K> |
|
|
1152 | B<Control> B<C> |
|
|
1153 | B<NumLock> B<N> |
|
|
1154 | B<Shift> B<S> |
|
|
1155 | B<Meta> B<M> I<or> B<A> |
|
|
1156 | B<Lock> B<L> |
|
|
1157 | B<Mod1> B<1> |
|
|
1158 | B<Mod2> B<2> |
|
|
1159 | B<Mod3> B<3> |
|
|
1160 | B<Mod4> B<4> |
|
|
1161 | B<Mod5> B<5> |
|
|
1162 | |
|
|
1163 | =end table |
1065 | |
1164 | |
1066 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1165 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1067 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1166 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1068 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1167 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1069 | current application keymap mode state. |
1168 | current application keymap mode state. |
… | |
… | |
1085 | As with any resource value, the I<action> string may contain backslash |
1184 | As with any resource value, the I<action> string may contain backslash |
1086 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1185 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1087 | number), see RESOURCES in C<man 7 X> for further details. |
1186 | number), see RESOURCES in C<man 7 X> for further details. |
1088 | |
1187 | |
1089 | An action starts with an action prefix that selects a certain type |
1188 | An action starts with an action prefix that selects a certain type |
1090 | of action, followed by a colon. An action strings without colons is |
1189 | of action, followed by a colon. An action string without colons is |
1091 | interpreted as a literal string to pass to the tty (as if they were |
1190 | interpreted as a literal string to pass to the tty (as if it was |
1092 | prefixed with C<string:>). |
1191 | prefixed with C<string:>). |
1093 | |
1192 | |
1094 | The following action prefixes are known - extensions can provide |
1193 | The following action prefixes are known - extensions can provide |
1095 | additional prefixes: |
1194 | additional prefixes: |
1096 | |
1195 | |
1097 | =over 4 |
1196 | =over |
1098 | |
1197 | |
1099 | =item string:STRING |
1198 | =item string:STRING |
1100 | |
1199 | |
1101 | If the I<action> starts with C<string:> (or otherwise contains no colons), |
1200 | If the I<action> starts with C<string:> (or otherwise contains no colons), |
1102 | then the remaining C<STRING> will be passed to the program running in the |
1201 | then the remaining C<STRING> will be passed to the program running in the |
… | |
… | |
1104 | string C<echo rm -rf /> followed by a newline: |
1203 | string C<echo rm -rf /> followed by a newline: |
1105 | |
1204 | |
1106 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
1205 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
1107 | |
1206 | |
1108 | This could in theory be used to completely redefine your keymap. |
1207 | This could in theory be used to completely redefine your keymap. |
|
|
1208 | |
|
|
1209 | In addition, for actions of this type, you can define a range of |
|
|
1210 | keysyms in one shot by loading the C<keysym-list> perl extension and |
|
|
1211 | providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where |
|
|
1212 | the delimiter `/' should be a character not used by the strings. |
|
|
1213 | |
|
|
1214 | Its usage can be demonstrated by an example: |
|
|
1215 | |
|
|
1216 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
|
|
1217 | |
|
|
1218 | The above line is equivalent to the following three lines: |
|
|
1219 | |
|
|
1220 | URxvt.keysym.Meta-Control-0x61: string:\033<a> |
|
|
1221 | URxvt.keysym.Meta-Control-0x62: string:\033<b> |
|
|
1222 | URxvt.keysym.Meta-Control-0x63: string:\033<c> |
1109 | |
1223 | |
1110 | =item command:STRING |
1224 | =item command:STRING |
1111 | |
1225 | |
1112 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1226 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1113 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
1227 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
… | |
… | |
1173 | |
1287 | |
1174 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
1288 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
1175 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
1289 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
1176 | this: |
1290 | this: |
1177 | |
1291 | |
1178 | URxvt.keysym.C-S-c: builtin-string: |
1292 | URxvt.keysym.C-M-c: builtin-string: |
1179 | URxvt.keysym.C-S-v: builtin-string: |
1293 | URxvt.keysym.C-M-v: builtin-string: |
1180 | |
1294 | |
1181 | =item EXTENSION:STRING |
1295 | =item EXTENSION:STRING |
1182 | |
1296 | |
1183 | An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) |
1297 | An action of this form invokes the action B<STRING>, if any, provided |
1184 | extension of the same name. The extension will be loaded automatically if |
1298 | by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will |
1185 | neccessary. |
1299 | be loaded automatically if necessary. |
1186 | |
1300 | |
1187 | Not all extensions define key actions, but popular extensions that do |
1301 | Not all extensions define actions, but popular extensions that do |
1188 | include the I<selection> and I<matcher> extensions (documented in their |
1302 | include the I<selection> and I<matcher> extensions (documented in their |
1189 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
1303 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
1190 | respectively). |
1304 | respectively). |
1191 | |
1305 | |
1192 | From the silly examples department, this will rot13-"encrypt" |
1306 | From the silly examples department, this will rot13-"encrypt" |
1193 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
1307 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
1194 | keyboards: |
1308 | keyboards: |
1195 | |
1309 | |
1196 | URxvt.keysym.M-C-c: selection:rot13 |
1310 | URxvt.keysym.M-C-c: selection:rot13 |
1197 | |
1311 | |
1198 | =item perl:STRING |
1312 | =item perl:STRING *DEPRECATED* |
1199 | |
1313 | |
1200 | This is a deprecated way of passing key mappings to perl extensions. It is |
1314 | This is a deprecated way of invoking commands provided by perl |
1201 | still supported, but should not be used anymore. |
1315 | extensions. It is still supported, but should not be used anymore. |
1202 | |
1316 | |
1203 | =back |
1317 | =back |
1204 | |
|
|
1205 | In addition, you can define a range of keysyms in one shot by loading |
|
|
1206 | the C<keysym-list> perl extension and providing a I<string> with pattern |
|
|
1207 | B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a |
|
|
1208 | character not used by the strings. |
|
|
1209 | |
|
|
1210 | Its usage can be demonstrated by an example: |
|
|
1211 | |
|
|
1212 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
|
|
1213 | |
|
|
1214 | The above line is equivalent to the following three lines: |
|
|
1215 | |
|
|
1216 | URxvt.keysym.Meta-Control-0x61: \033<a> |
|
|
1217 | URxvt.keysym.Meta-Control-0x62: \033<b> |
|
|
1218 | URxvt.keysym.Meta-Control-0x63: \033<c> |
|
|
1219 | |
1318 | |
1220 | =item B<perl-ext-common>: I<string> |
1319 | =item B<perl-ext-common>: I<string> |
1221 | |
1320 | |
1222 | =item B<perl-ext>: I<string> |
1321 | =item B<perl-ext>: I<string> |
1223 | |
1322 | |
1224 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
1323 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
1225 | use in this terminal instance; option B<-pe>. |
1324 | use in this terminal instance; option B<-pe>. |
1226 | |
1325 | |
1227 | Extension names can be prefixed with a C<-> sign to prohibit using |
1326 | Extension names can be prefixed with a C<-> sign to remove them again, in |
1228 | them. This can be useful to selectively disable some extensions loaded |
1327 | case they had been specified earlier. This can be useful to selectively |
1229 | by default, or specified via the C<perl-ext-common> resource. For |
1328 | disable some extensions loaded by default, or specified via the |
1230 | example, C<default,-selection> will use all the default extension except |
1329 | C<perl-ext-common> resource. For example, C<default,-selection> will use |
1231 | C<selection>. |
1330 | all the default extensions except C<selection>. |
1232 | |
1331 | |
1233 | Extension names can also be followed by an argument in angle brackets |
1332 | To prohibit autoloading of extensions, you can prefix them with C</>, |
1234 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1333 | which will make urxvt refuse to automatically load them (this can be |
1235 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1334 | overridden, however, by specifying the extension name again without a |
1236 | multiple times with different arguments will pass multiple arguments to |
1335 | prefix, though). This does not prohibit extensions themselves loading |
1237 | the extension. |
1336 | other extensions. For example, C<default,/background> will keep the |
|
|
1337 | C<background> extension from being loaded when a background OSC sequence |
|
|
1338 | is received. |
|
|
1339 | |
|
|
1340 | The default set includes the C<selection>, C<option-popup>, |
|
|
1341 | C<selection-popup>, C<readline>, C<searchable-scrollback> and |
|
|
1342 | C<confirm-paste> extensions, as well as any extensions which are mentioned |
|
|
1343 | in B<keysym> resources. |
|
|
1344 | |
|
|
1345 | Any extension such that a corresponding resource is given on the |
|
|
1346 | command line is automatically appended to B<perl-ext>. |
1238 | |
1347 | |
1239 | Each extension is looked up in the library directories, loaded if |
1348 | Each extension is looked up in the library directories, loaded if |
1240 | necessary, and bound to the current terminal instance. |
1349 | necessary, and bound to the current terminal instance. When the library |
|
|
1350 | search path contains multiple extension files of the same name, then the |
|
|
1351 | first one found will be used. |
1241 | |
1352 | |
1242 | If both of these resources are the empty string, then the perl |
1353 | If both of these resources are the empty string, then the perl interpreter |
1243 | interpreter will not be initialized. The idea behind two options is that |
1354 | will not be initialized. The rationale for having two options is that |
1244 | B<perl-ext-common> will be used for extensions that should be available to |
1355 | B<perl-ext-common> will be used for extensions that should be available to |
1245 | all instances, while B<perl-ext> is used for specific instances. |
1356 | all instances, while B<perl-ext> is used for specific instances. |
1246 | |
1357 | |
1247 | =item B<perl-eval>: I<string> |
1358 | =item B<perl-eval>: I<string> |
1248 | |
1359 | |
… | |
… | |
1266 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1377 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1267 | |
1378 | |
1268 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1379 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1269 | for details. |
1380 | for details. |
1270 | |
1381 | |
1271 | =item B<searchable-scrollback:> I<keysym> |
1382 | =item B<searchable-scrollback:> I<keysym> *DEPRECATED* |
1272 | |
1383 | |
1273 | Sets the hotkey that starts the incremental scrollback buffer search |
1384 | This resource is deprecated and will be removed. Use a B<keysym> resource |
1274 | (default: C<M-s>). |
1385 | instead, e.g.: |
|
|
1386 | |
|
|
1387 | URxvt.keysym.M-s: searchable-scrollback:start |
1275 | |
1388 | |
1276 | =item B<url-launcher>: I<string> |
1389 | =item B<url-launcher>: I<string> |
1277 | |
1390 | |
1278 | Specifies the program to be started with a URL argument. Used by the |
1391 | Specifies the program to be started with a URL argument. Used by the |
1279 | C<selection-popup> and C<matcher> perl extensions. |
1392 | C<selection-popup> and C<matcher> perl extensions. |
… | |
… | |
1292 | Turn on/off ISO 14755 (default enabled). |
1405 | Turn on/off ISO 14755 (default enabled). |
1293 | |
1406 | |
1294 | =item B<iso14755_52:> I<boolean> |
1407 | =item B<iso14755_52:> I<boolean> |
1295 | |
1408 | |
1296 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1409 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1297 | |
|
|
1298 | =back |
|
|
1299 | |
|
|
1300 | =head1 BACKGROUND IMAGE OPTIONS AND RESOURCES |
|
|
1301 | |
|
|
1302 | =over 4 |
|
|
1303 | |
|
|
1304 | =item B<-pixmap> I<file[;oplist]> |
|
|
1305 | |
|
|
1306 | =item B<backgroundPixmap:> I<file[;oplist]> |
|
|
1307 | |
|
|
1308 | Compile I<pixbuf>: Use the specified image file as the window's |
|
|
1309 | background and also optionally specify a colon separated list of |
|
|
1310 | operations to modify it. Note that you may need to quote the C<;> |
|
|
1311 | character when using the command line option, as C<;> is usually a |
|
|
1312 | metacharacter in shells. Supported operations are: |
|
|
1313 | |
|
|
1314 | =over 4 |
|
|
1315 | |
|
|
1316 | =item B<WxH+X+Y> |
|
|
1317 | |
|
|
1318 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
|
|
1319 | scale (percent), and B<"X" / "Y"> locate the image centre (percent). A |
|
|
1320 | scale of 0 disables scaling. |
|
|
1321 | |
|
|
1322 | =item B<op=tile> |
|
|
1323 | |
|
|
1324 | enables tiling |
|
|
1325 | |
|
|
1326 | =item B<op=keep-aspect> |
|
|
1327 | |
|
|
1328 | maintain the image aspect ratio when scaling |
|
|
1329 | |
|
|
1330 | =item B<op=root-align> |
|
|
1331 | |
|
|
1332 | use the position of the terminal window relative to the root window as |
|
|
1333 | the image offset, simulating a root window background |
|
|
1334 | |
|
|
1335 | =back |
|
|
1336 | |
|
|
1337 | The default scale and position setting is C<100x100+50+50>. |
|
|
1338 | Alternatively, a predefined set of templates can be used to achieve |
|
|
1339 | the most common setups: |
|
|
1340 | |
|
|
1341 | =over 4 |
|
|
1342 | |
|
|
1343 | =item B<style=tiled> |
|
|
1344 | |
|
|
1345 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
1346 | |
|
|
1347 | =item B<style=aspect-stretched> |
|
|
1348 | |
|
|
1349 | the image is scaled to fill the whole window maintaining the aspect |
|
|
1350 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
1351 | |
|
|
1352 | =item B<style=stretched> |
|
|
1353 | |
|
|
1354 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
1355 | |
|
|
1356 | =item B<style=centered> |
|
|
1357 | |
|
|
1358 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
1359 | |
|
|
1360 | =item B<style=root-tiled> |
|
|
1361 | |
|
|
1362 | the image is tiled with no scaling and using 'root' positioning. |
|
|
1363 | Equivalent to 0x0:op=tile:op=root-align |
|
|
1364 | |
|
|
1365 | =back |
|
|
1366 | |
|
|
1367 | If multiple templates are specified the last one wins. Note that a |
|
|
1368 | template overrides all the scale, position and operations settings. |
|
|
1369 | |
|
|
1370 | If used in conjunction with pseudo-transparency, the specified pixmap |
|
|
1371 | will be blended over the transparent background using alpha-blending. |
|
|
1372 | |
|
|
1373 | =item B<-tr>|B<+tr> |
|
|
1374 | |
|
|
1375 | =item B<transparent:> I<boolean> |
|
|
1376 | |
|
|
1377 | Turn on/off pseudo-transparency by using the root pixmap as background. |
|
|
1378 | |
|
|
1379 | B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but |
|
|
1380 | will be removed in future versions. |
|
|
1381 | |
|
|
1382 | =item B<-tint> I<colour> |
|
|
1383 | |
|
|
1384 | =item B<tintColor:> I<colour> |
|
|
1385 | |
|
|
1386 | Tint the transparent background with the given colour. Note that a |
|
|
1387 | black tint yields a completely black image while a white tint yields |
|
|
1388 | the image unchanged. |
|
|
1389 | |
|
|
1390 | =item B<-sh> I<number> |
|
|
1391 | |
|
|
1392 | =item B<shading:> I<number> |
|
|
1393 | |
|
|
1394 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
|
|
1395 | A value of 100 means no shading. |
|
|
1396 | |
|
|
1397 | =item B<-blr> I<HxV> |
|
|
1398 | |
|
|
1399 | =item B<blurRadius:> I<HxV> |
|
|
1400 | |
|
|
1401 | Apply gaussian blur with the specified radius to the transparent |
|
|
1402 | background. If a single number is specified, the vertical and |
|
|
1403 | horizontal radii are considered to be the same. Setting one of the |
|
|
1404 | radii to 1 and the other to a large number creates interesting effects |
|
|
1405 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
1406 | vertical radius of 0 disables blurring. |
|
|
1407 | |
|
|
1408 | =item B<path:> I<path> |
|
|
1409 | |
|
|
1410 | Specify the colon-delimited search path for finding background image files. |
|
|
1411 | |
1410 | |
1412 | =back |
1411 | =back |
1413 | |
1412 | |
1414 | =head1 THE SCROLLBAR |
1413 | =head1 THE SCROLLBAR |
1415 | |
1414 | |
… | |
… | |
1439 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1438 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1440 | |
1439 | |
1441 | The behaviour of text selection and insertion/pasting mechanism is similar |
1440 | The behaviour of text selection and insertion/pasting mechanism is similar |
1442 | to I<xterm>(1). |
1441 | to I<xterm>(1). |
1443 | |
1442 | |
1444 | =over 4 |
1443 | =over |
1445 | |
1444 | |
1446 | =item B<Selecting>: |
1445 | =item B<Selecting>: |
1447 | |
1446 | |
1448 | Left click at the beginning of the region, drag to the end of the region |
1447 | Left click at the beginning of the region, drag to the end of the region |
1449 | and release; Right click to extend the marked region; Left double-click |
1448 | and release; Right click to extend the marked region; Left double-click |
… | |
… | |
1496 | and character codes using the keyboard. It consists of 4 parts. The |
1495 | and character codes using the keyboard. It consists of 4 parts. The |
1497 | first part is available if rxvt-unicode has been compiled with |
1496 | first part is available if rxvt-unicode has been compiled with |
1498 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1497 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1499 | with C<--enable-iso14755>. |
1498 | with C<--enable-iso14755>. |
1500 | |
1499 | |
1501 | =over 4 |
1500 | =over |
1502 | |
1501 | |
1503 | =item * 5.1: Basic method |
1502 | =item * 5.1: Basic method |
1504 | |
1503 | |
1505 | This allows you to enter unicode characters using their hexcode. |
1504 | This allows you to enter unicode characters using their hexcode. |
1506 | |
1505 | |
… | |
… | |
1567 | In addition to the default foreground and background colours, |
1566 | In addition to the default foreground and background colours, |
1568 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1567 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1569 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1568 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1570 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
1569 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
1571 | cube plus a 8 (24) colour greyscale ramp. |
1570 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1571 | |
|
|
1572 | B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes |
|
|
1573 | C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the |
|
|
1574 | number of 24-bit colours that can be used is limited: an internal 7x7x5 (256 |
|
|
1575 | colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the |
|
|
1576 | 24-bit colour space. When indexing collisions happen, the nearest old colour in |
|
|
1577 | the cube will be adapted to the new 24-bit RGB colour. That means one cannot |
|
|
1578 | use many similar 24-bit colours. It's typically not a problem in common |
|
|
1579 | scenarios. |
1572 | |
1580 | |
1573 | Here is a list of the ANSI colours with their names. |
1581 | Here is a list of the ANSI colours with their names. |
1574 | |
1582 | |
1575 | =begin table |
1583 | =begin table |
1576 | |
1584 | |
… | |
… | |
1677 | |
1685 | |
1678 | =head1 ENVIRONMENT |
1686 | =head1 ENVIRONMENT |
1679 | |
1687 | |
1680 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1688 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1681 | |
1689 | |
1682 | =over 4 |
1690 | =over |
1683 | |
1691 | |
1684 | =item B<TERM> |
1692 | =item B<TERM> |
1685 | |
1693 | |
1686 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1694 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1687 | resources or on the command line. |
1695 | resources or on the command line. |
… | |
… | |
1758 | |
1766 | |
1759 | =back |
1767 | =back |
1760 | |
1768 | |
1761 | =head1 FILES |
1769 | =head1 FILES |
1762 | |
1770 | |
1763 | =over 4 |
1771 | =over |
1764 | |
1772 | |
1765 | =item B</usr/lib/X11/rgb.txt> |
1773 | =item B</usr/lib/X11/rgb.txt> |
1766 | |
1774 | |
1767 | Colour names. |
1775 | Colour names. |
1768 | |
1776 | |
… | |
… | |
1773 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), |
1781 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), |
1774 | @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1782 | @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1775 | |
1783 | |
1776 | =head1 CURRENT PROJECT COORDINATOR |
1784 | =head1 CURRENT PROJECT COORDINATOR |
1777 | |
1785 | |
1778 | =over 4 |
1786 | =over |
1779 | |
1787 | |
1780 | =item Project Coordinator |
1788 | =item Project Coordinator |
1781 | |
1789 | |
1782 | Marc A. Lehmann <rxvt-unicode@schmorp.de>. |
1790 | Marc A. Lehmann <rxvt-unicode@schmorp.de>. |
1783 | |
1791 | |
… | |
… | |
1785 | |
1793 | |
1786 | =back |
1794 | =back |
1787 | |
1795 | |
1788 | =head1 AUTHORS |
1796 | =head1 AUTHORS |
1789 | |
1797 | |
1790 | =over 4 |
1798 | =over |
1791 | |
1799 | |
1792 | =item John Bovey |
1800 | =item John Bovey |
1793 | |
1801 | |
1794 | University of Kent, 1992, wrote the original Xvt. |
1802 | University of Kent, 1992, wrote the original Xvt. |
1795 | |
1803 | |