… | |
… | |
98 | is still respected. but deprecated). In the absence of this option, the |
98 | is still respected. but deprecated). In the absence of this option, the |
99 | display specified by the B<DISPLAY> environment variable is used. |
99 | display specified by the B<DISPLAY> environment variable is used. |
100 | |
100 | |
101 | =item B<-depth> I<bitdepth> |
101 | =item B<-depth> I<bitdepth> |
102 | |
102 | |
103 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
103 | Compile I<frills>: Attempt to find a visual with the given bit depth; |
104 | resource B<depth>. |
104 | resource B<depth>. |
105 | |
105 | |
106 | [Please note that many X servers (and libXft) are buggy with |
106 | [Please note that many X servers (and libXft) are buggy with |
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
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> |
|
|
112 | |
|
|
113 | Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible |
|
|
114 | visual ids). |
|
|
115 | |
111 | =item B<-geometry> I<geom> |
116 | =item B<-geometry> I<geom> |
112 | |
117 | |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
118 | Window geometry (B<-g> still respected); resource B<geometry>. |
114 | |
119 | |
115 | =item B<-rv>|B<+rv> |
120 | =item B<-rv>|B<+rv> |
… | |
… | |
121 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
126 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
122 | |
127 | |
123 | =item B<-ss>|B<+ss> |
128 | =item B<-ss>|B<+ss> |
124 | |
129 | |
125 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
130 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
126 | |
|
|
127 | =item B<-tr>|B<+tr> |
|
|
128 | |
|
|
129 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
|
|
130 | |
|
|
131 | B<-ip> is still accepted as an obsolete alias but will be removed in |
|
|
132 | future versions. |
|
|
133 | |
|
|
134 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
135 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
|
|
136 | |
131 | |
137 | =item B<-fade> I<number> |
132 | =item B<-fade> I<number> |
138 | |
133 | |
139 | Fade the text by the given percentage when focus is lost. Small values |
134 | Fade the text by the given percentage when focus is lost. Small values |
140 | fade a little only, 100 completely replaces all colours by the fade |
135 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
143 | =item B<-fadecolor> I<colour> |
138 | =item B<-fadecolor> I<colour> |
144 | |
139 | |
145 | Fade to this colour when fading is used (see B<-fade>). The default colour |
140 | Fade to this colour when fading is used (see B<-fade>). The default colour |
146 | is opaque black. resource B<fadeColor>. |
141 | is opaque black. resource B<fadeColor>. |
147 | |
142 | |
148 | =item B<-tint> I<colour> |
|
|
149 | |
|
|
150 | Tint the transparent background pixmap with the given colour when |
|
|
151 | transparency is enabled with B<-tr>. This only works for |
|
|
152 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
|
|
153 | used to brighten or darken the image in addition to tinting it. |
|
|
154 | Please note that certain tint colours can be applied on the server-side, |
|
|
155 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
156 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
|
|
157 | pure black and pure white colors essentially mean no tinting; resource |
|
|
158 | I<tintColor>. Example: |
|
|
159 | |
|
|
160 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
|
|
161 | |
|
|
162 | =item B<-sh> I<number> |
|
|
163 | |
|
|
164 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
|
|
165 | background image in addition to (or instead of) tinting it; |
|
|
166 | resource I<shading>. |
|
|
167 | |
|
|
168 | =item B<-blt> I<string> |
|
|
169 | |
|
|
170 | Specify background blending type. If background pixmap is specified |
|
|
171 | at the same time as transparency - such pixmap will be blended over |
|
|
172 | transparency image, using method specified. Supported values are : |
|
|
173 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
|
|
174 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
|
|
175 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
|
|
176 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
|
|
177 | |
|
|
178 | =item B<-blr> I<HxV> |
|
|
179 | |
|
|
180 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
181 | background image. If single number is specified - both vertical and |
|
|
182 | horizontal radii are considered to be the same. Setting one of the |
|
|
183 | radii to 1 and another to a large number creates interesting effects |
|
|
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
|
|
185 | resource I<blurRadius>. |
|
|
186 | |
|
|
187 | =item B<-icon> I<file> |
143 | =item B<-icon> I<file> |
188 | |
144 | |
189 | Compile I<afterimage>: Use the specified image as application icon. This |
145 | Compile I<pixbuf>: Use the specified image as application icon. This |
190 | is used by many window managers, taskbars and pagers to represent the |
146 | is used by many window managers, taskbars and pagers to represent the |
191 | application window; resource I<iconFile>. |
147 | application window; resource I<iconFile>. |
192 | |
148 | |
193 | =item B<-bg> I<colour> |
149 | =item B<-bg> I<colour> |
194 | |
150 | |
195 | Window background colour; resource B<background>. |
151 | Window background colour; resource B<background>. |
196 | |
152 | |
197 | =item B<-fg> I<colour> |
153 | =item B<-fg> I<colour> |
198 | |
154 | |
199 | Window foreground colour; resource B<foreground>. |
155 | Window foreground colour; resource B<foreground>. |
200 | |
|
|
201 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
|
|
202 | |
|
|
203 | Compile I<afterimage>: Specify image file for the background and also |
|
|
204 | optionally specify its scaling with a geometry string. Note you may need to |
|
|
205 | add quotes to avoid special shell interpretation of the C<;> in the |
|
|
206 | command-line; for more details see resource B<backgroundPixmap>. |
|
|
207 | |
156 | |
208 | =item B<-cr> I<colour> |
157 | =item B<-cr> I<colour> |
209 | |
158 | |
210 | The cursor colour; resource B<cursorColor>. |
159 | The cursor colour; resource B<cursorColor>. |
211 | |
160 | |
… | |
… | |
357 | |
306 | |
358 | =item B<-override-redirect> |
307 | =item B<-override-redirect> |
359 | |
308 | |
360 | Compile I<frills>: Sets override-redirect on the window; resource |
309 | Compile I<frills>: Sets override-redirect on the window; resource |
361 | B<override-redirect>. |
310 | B<override-redirect>. |
|
|
311 | |
|
|
312 | =item B<-dockapp> |
|
|
313 | |
|
|
314 | Sets the initial state of the window to WithdrawnState, which makes |
|
|
315 | window managers that support this extension treat it as a dockapp. |
362 | |
316 | |
363 | =item B<-sbg> |
317 | =item B<-sbg> |
364 | |
318 | |
365 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
319 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
366 | drawing characters and just rely on what the specified fonts provide. Use |
320 | drawing characters and just rely on what the specified fonts provide. Use |
… | |
… | |
571 | You can set and change the resources using X11 tools like B<xrdb>. Many |
525 | You can set and change the resources using X11 tools like B<xrdb>. Many |
572 | distribution do also load settings from the B<~/.Xresources> file when X |
526 | distribution do also load settings from the B<~/.Xresources> file when X |
573 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
527 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
574 | with later settings overwriting earlier ones: |
528 | with later settings overwriting earlier ones: |
575 | |
529 | |
576 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
577 | 2. app-defaults file in $XAPPLRESDIR |
530 | 1. app-defaults file in $XAPPLRESDIR |
|
|
531 | 2. $HOME/.Xdefaults |
578 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
532 | 3. RESOURCE_MANAGER property on root-window of screen 0 |
579 | 4. SCREEN_RESOURCES for the current screen |
533 | 4. SCREEN_RESOURCES property on root-window of the current screen |
580 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
534 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
581 | 6. resources specified via -xrm on the commandline |
535 | 6. resources specified via -xrm on the commandline |
582 | |
536 | |
583 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
537 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
584 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
538 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
… | |
… | |
625 | Use the specified colour for the colour value I<n>, where 0-7 |
579 | Use the specified colour for the colour value I<n>, where 0-7 |
626 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
580 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
627 | high-intensity (bold = bright foreground, blink = bright background) |
581 | high-intensity (bold = bright foreground, blink = bright background) |
628 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
582 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
629 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
583 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
630 | names used are listed in the B<COLORS AND GRAPHICS> section. |
584 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
631 | |
585 | |
632 | Colours higher than 15 cannot be set using resources (yet), but can be |
586 | Colours higher than 15 cannot be set using resources (yet), but can be |
633 | changed using an escape command (see @@RXVT_NAME@@(7)). |
587 | changed using an escape command (see @@RXVT_NAME@@(7)). |
634 | |
588 | |
635 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
589 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
646 | =item B<colorUL:> I<colour> |
600 | =item B<colorUL:> I<colour> |
647 | |
601 | |
648 | Use the specified colour to display underlined characters when the |
602 | Use the specified colour to display underlined characters when the |
649 | foreground colour is the default. |
603 | foreground colour is the default. |
650 | |
604 | |
651 | =item B<colorRV:> I<colour> |
|
|
652 | |
|
|
653 | Use the specified colour as the background for reverse video characters |
|
|
654 | when OPTION_HC is disabled (--disable-frills). |
|
|
655 | |
|
|
656 | =item B<underlineColor:> I<colour> |
605 | =item B<underlineColor:> I<colour> |
657 | |
606 | |
658 | If set, use the specified colour as the colour for the underline |
607 | If set, use the specified colour as the colour for the underline |
659 | itself. If unset, use the foreground colour. |
608 | itself. If unset, use the foreground colour. |
|
|
609 | |
|
|
610 | =item B<highlightColor:> I<colour> |
|
|
611 | |
|
|
612 | If set, use the specified colour as the background for highlighted |
|
|
613 | characters. If unset, use reverse video. |
|
|
614 | |
|
|
615 | =item B<highlightTextColor:> I<colour> |
|
|
616 | |
|
|
617 | If set and highlightColor is set, use the specified colour as the |
|
|
618 | foreground for highlighted characters. |
660 | |
619 | |
661 | =item B<cursorColor:> I<colour> |
620 | =item B<cursorColor:> I<colour> |
662 | |
621 | |
663 | Use the specified colour for the cursor. The default is to use the |
622 | Use the specified colour for the cursor. The default is to use the |
664 | foreground colour; option B<-cr>. |
623 | foreground colour; option B<-cr>. |
… | |
… | |
671 | |
630 | |
672 | =item B<reverseVideo:> I<boolean> |
631 | =item B<reverseVideo:> I<boolean> |
673 | |
632 | |
674 | B<True>: simulate reverse video by foreground and background colours; |
633 | B<True>: simulate reverse video by foreground and background colours; |
675 | option B<-rv>. B<False>: regular screen colours [default]; option |
634 | option B<-rv>. B<False>: regular screen colours [default]; option |
676 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
635 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
677 | |
636 | |
678 | =item B<jumpScroll:> I<boolean> |
637 | =item B<jumpScroll:> I<boolean> |
679 | |
638 | |
680 | B<True>: specify that jump scrolling should be used. When receiving lots |
639 | B<True>: specify that jump scrolling should be used. When receiving lots |
681 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
640 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
… | |
… | |
695 | |
654 | |
696 | B<False>: specify that everything is to be displayed, even |
655 | B<False>: specify that everything is to be displayed, even |
697 | if the refresh is too fast for the human eye to read anything (or the |
656 | if the refresh is too fast for the human eye to read anything (or the |
698 | monitor to display anything); option B<+ss>. |
657 | monitor to display anything); option B<+ss>. |
699 | |
658 | |
700 | =item B<transparent:> I<boolean> |
|
|
701 | |
|
|
702 | Turn on/off illusion of a transparent window background. |
|
|
703 | |
|
|
704 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
|
|
705 | future versions. |
|
|
706 | |
|
|
707 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
708 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
|
|
709 | |
|
|
710 | =item B<fading:> I<number> |
659 | =item B<fading:> I<number> |
711 | |
660 | |
712 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
661 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
713 | |
662 | |
714 | =item B<fadeColor:> I<colour> |
663 | =item B<fadeColor:> I<colour> |
715 | |
664 | |
716 | Fade to this colour, when fading is used (see B<fading:>). The default |
665 | Fade to this colour, when fading is used (see B<fading:>). The default |
717 | colour is black; option B<-fadecolor>. |
666 | colour is black; option B<-fadecolor>. |
718 | |
667 | |
719 | =item B<tintColor:> I<colour> |
|
|
720 | |
|
|
721 | Tint the transparent background pixmap with the given colour; option |
|
|
722 | B<-tint>. |
|
|
723 | |
|
|
724 | =item B<shading:> I<number> |
|
|
725 | |
|
|
726 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
|
|
727 | in addition to tinting it; option B<-sh>. |
|
|
728 | |
|
|
729 | =item B<blendType:> I<string> |
|
|
730 | |
|
|
731 | Specify background blending type; option B<-blt>. |
|
|
732 | |
|
|
733 | =item B<blurRadius:> I<number> |
|
|
734 | |
|
|
735 | Apply gaussian blur with the specified radius to the transparent |
|
|
736 | background image; option B<-blr>. |
|
|
737 | |
|
|
738 | =item B<iconFile:> I<file> |
668 | =item B<iconFile:> I<file> |
739 | |
669 | |
740 | Set the application icon pixmap; option B<-icon>. |
670 | Set the application icon pixmap; option B<-icon>. |
741 | |
671 | |
742 | =item B<scrollColor:> I<colour> |
672 | =item B<scrollColor:> I<colour> |
… | |
… | |
750 | |
680 | |
751 | =item B<borderColor:> I<colour> |
681 | =item B<borderColor:> I<colour> |
752 | |
682 | |
753 | The colour of the border around the text area and between the scrollbar |
683 | The colour of the border around the text area and between the scrollbar |
754 | and the text. |
684 | and the text. |
755 | |
|
|
756 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
|
|
757 | |
|
|
758 | Use the specified image file for the background and also |
|
|
759 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
|
|
760 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
|
|
761 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
|
|
762 | centre (percent). A scale of 0 displays the image with tiling. A scale |
|
|
763 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
|
|
764 | an integer number of images in that direction. No image will be magnified |
|
|
765 | beyond 10 times its original size. The maximum permitted scale is 1000. |
|
|
766 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
767 | Supported operations are: |
|
|
768 | |
|
|
769 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
770 | propscale will scale image keeping proportions |
|
|
771 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
772 | hscale will scale image horizontally to the window size |
|
|
773 | vscale will scale image vertically to the window size |
|
|
774 | scale will scale image to match window size |
|
|
775 | root will tile image as if it was a root window background, auto-adjusting |
|
|
776 | whenever terminal window moves |
|
|
777 | |
|
|
778 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
779 | blended over transparency image using either alpha-blending, or any |
|
|
780 | other blending type, specified with B<-blt "type"> option. |
|
|
781 | |
|
|
782 | =item B<path:> I<path> |
|
|
783 | |
|
|
784 | Specify the colon-delimited search path for finding background image files. |
|
|
785 | |
685 | |
786 | =item B<font:> I<fontlist> |
686 | =item B<font:> I<fontlist> |
787 | |
687 | |
788 | Select the fonts to be used. This is a comma separated list of font names |
688 | Select the fonts to be used. This is a comma separated list of font names |
789 | that are checked in order when trying to find glyphs for characters. The |
689 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
812 | it is named first) and thus defines the character cell grid to be 9 pixels |
712 | it is named first) and thus defines the character cell grid to be 9 pixels |
813 | wide and 15 pixels high. |
713 | wide and 15 pixels high. |
814 | |
714 | |
815 | The second font is just used to add additional unicode characters not in |
715 | The second font is just used to add additional unicode characters not in |
816 | the base font, likewise the third, which is unfortunately non-bold, but |
716 | the base font, likewise the third, which is unfortunately non-bold, but |
817 | the bold version of the font does contain less characters, so this is a |
717 | the bold version of the font does contain fewer characters, so this is a |
818 | useful supplement. |
718 | useful supplement. |
819 | |
719 | |
820 | The third font is an Xft font with aliasing turned off, and the characters |
720 | The third font is an Xft font with aliasing turned off, and the characters |
821 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
721 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
822 | contains other characters, but we are not interested in them. |
722 | contains other characters, but we are not interested in them. |
… | |
… | |
912 | =item B<scrollstyle:> I<mode> |
812 | =item B<scrollstyle:> I<mode> |
913 | |
813 | |
914 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
814 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
915 | the author's favourite. |
815 | the author's favourite. |
916 | |
816 | |
|
|
817 | =item B<thickness:> I<number> |
|
|
818 | |
|
|
819 | Set the scrollbar width in pixels. |
|
|
820 | |
917 | =item B<scrollBar:> I<boolean> |
821 | =item B<scrollBar:> I<boolean> |
918 | |
822 | |
919 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
823 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
920 | disable the scrollbar; option B<+sb>. |
824 | disable the scrollbar; option B<+sb>. |
921 | |
825 | |
… | |
… | |
940 | B<False>: do not scroll to bottom when tty receives output; option |
844 | B<False>: do not scroll to bottom when tty receives output; option |
941 | B<+si>. |
845 | B<+si>. |
942 | |
846 | |
943 | =item B<scrollWithBuffer:> I<boolean> |
847 | =item B<scrollWithBuffer:> I<boolean> |
944 | |
848 | |
945 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
849 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
946 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
850 | try to show the same lines) and B<scrollTtyOutput> is False; option |
947 | with scrollback buffer when tty receives new lines; option B<+sw>. |
851 | B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives |
|
|
852 | new lines; option B<+sw>. |
948 | |
853 | |
949 | =item B<scrollTtyKeypress:> I<boolean> |
854 | =item B<scrollTtyKeypress:> I<boolean> |
950 | |
855 | |
951 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
856 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
952 | are those which are intercepted by rxvt-unicode for special handling and |
857 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
1035 | large number (e.g. C<987654321>) to effectively disable the timeout. |
940 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1036 | |
941 | |
1037 | =item B<backspacekey:> I<string> |
942 | =item B<backspacekey:> I<string> |
1038 | |
943 | |
1039 | The string to send when the backspace key is pressed. If set to B<DEC> |
944 | The string to send when the backspace key is pressed. If set to B<DEC> |
1040 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
945 | or unset it will send B<Delete> (code 127) or, with control, B<Backspace> |
1041 | (code 8) - which can be reversed with the appropriate DEC private mode |
946 | (code 8) - which can be reversed with the appropriate DEC private mode |
1042 | escape sequence. |
947 | escape sequence. |
1043 | |
948 | |
1044 | =item B<deletekey:> I<string> |
949 | =item B<deletekey:> I<string> |
1045 | |
950 | |
… | |
… | |
1141 | Sets the working directory for the shell (or the command specified via |
1046 | Sets the working directory for the shell (or the command specified via |
1142 | B<-e>). The I<path> must be an absolute path and it must exist for |
1047 | B<-e>). The I<path> must be an absolute path and it must exist for |
1143 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
1048 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
1144 | directory will be used; option B<-cd>. |
1049 | directory will be used; option B<-cd>. |
1145 | |
1050 | |
1146 | =item B<keysym.>I<sym>: I<string> |
1051 | =item B<keysym.>I<sym>: I<action> |
1147 | |
1052 | |
1148 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1053 | Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening |
1149 | intervening resource name B<keysym.> cannot be omitted. |
1054 | resource name B<keysym.> cannot be omitted. |
1150 | |
1055 | |
1151 | The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be |
1056 | Using this resource, you can map key combinations such as |
1152 | any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, |
1057 | C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different |
1153 | B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, |
1058 | string than would normally result from that combination, making the |
1154 | and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
1059 | terminal scroll up or down the way you want it, or any other thing an |
1155 | B<2>, B<3>, B<4>, B<5>. |
1060 | extension might provide. |
|
|
1061 | |
|
|
1062 | The key combination that triggers the action, I<sym>, has the following format: |
|
|
1063 | |
|
|
1064 | (modifiers-)key |
|
|
1065 | |
|
|
1066 | Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, |
|
|
1067 | B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, |
|
|
1068 | B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, |
|
|
1069 | B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. |
1156 | |
1070 | |
1157 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1071 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1158 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1072 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1159 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1073 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1160 | current application keymap mode state. |
1074 | current application keymap mode state. |
1161 | |
1075 | |
1162 | The spellings of I<key> can be obtained by using B<xev>(1) command or |
1076 | Due the the large number of modifier combinations, a key mapping will |
1163 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1077 | match if I<at least> the specified identifiers are being set, and no other |
|
|
1078 | key mappings with those and more bits are being defined. That means that |
|
|
1079 | defining a mapping for C<a> will automatically provide definitions for |
|
|
1080 | C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings |
|
|
1081 | themselves. See the C<builtin:> action, below, for a way to work around |
|
|
1082 | this when this is a problem. |
|
|
1083 | |
|
|
1084 | The spelling of I<key> depends on your implementation of X. An easy way to |
|
|
1085 | find a key name is to use the B<xev>(1) command. You can find a list by |
|
|
1086 | looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit |
1164 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1087 | the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym |
1165 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1088 | value (B<0x0000 - 0xFFFF>). |
1166 | performed in an exact manner; however, the closest match is assured. |
|
|
1167 | |
1089 | |
1168 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1090 | As with any resource value, the I<action> string may contain backslash |
|
|
1091 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1169 | number), see RESOURCES in C<man 7 X> for futher details. |
1092 | number), see RESOURCES in C<man 7 X> for further details. |
1170 | |
1093 | |
1171 | You can define a range of keysyms in one shot by providing a I<string> |
1094 | An action starts with an action prefix that selects a certain type |
1172 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1095 | of action, followed by a colon. An action string without colons is |
1173 | should be a character not used by the strings. |
1096 | interpreted as a literal string to pass to the tty (as if it was |
|
|
1097 | prefixed with C<string:>). |
1174 | |
1098 | |
1175 | Its usage can be demonstrated by an example: |
1099 | The following action prefixes are known - extensions can provide |
|
|
1100 | additional prefixes: |
1176 | |
1101 | |
1177 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1102 | =over 4 |
1178 | |
1103 | |
1179 | The above line is equivalent to the following three lines: |
1104 | =item string:STRING |
1180 | |
1105 | |
1181 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1106 | If the I<action> starts with C<string:> (or otherwise contains no colons), |
1182 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1107 | then the remaining C<STRING> will be passed to the program running in the |
1183 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1108 | terminal. For example, you could replace whatever Shift-Tab outputs by the |
|
|
1109 | string C<echo rm -rf /> followed by a newline: |
1184 | |
1110 | |
|
|
1111 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
|
|
1112 | |
|
|
1113 | This could in theory be used to completely redefine your keymap. |
|
|
1114 | |
|
|
1115 | =item command:STRING |
|
|
1116 | |
1185 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1117 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1186 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1118 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
|
|
1119 | the opposite of C<string:> - instead of sending it to the program running |
|
|
1120 | in the terminal, it will be treated as if it were program output). This is |
|
|
1121 | most useful to feed command sequences into @@RXVT_NAME@@. |
|
|
1122 | |
1187 | example the following means "change the current locale to C<zh_CN.GBK> |
1123 | For example the following means "change the current locale to C<zh_CN.GBK> |
1188 | when Control-Meta-c is being pressed": |
1124 | when Control-Meta-c is being pressed": |
1189 | |
1125 | |
1190 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1126 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1191 | |
1127 | |
1192 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1128 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1193 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1129 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1194 | manpage. For example, the F<selection> extension (activated via |
1130 | font-switching at runtime: |
1195 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1196 | |
1131 | |
1197 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1132 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
|
|
1133 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1198 | |
1134 | |
1199 | Due the the large number of modifier combinations, a defined key mapping |
1135 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1200 | will match if at I<at least> the specified identifiers are being set, and |
1136 | info): |
1201 | no other key mappings with those and more bits are being defined. That |
|
|
1202 | means that defining a key map for C<a> will automatically provide |
|
|
1203 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
1204 | mappings themselves. |
|
|
1205 | |
1137 | |
1206 | Unfortunately, this will override built-in key mappings. For example |
1138 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
1139 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1140 | |
|
|
1141 | =item builtin: |
|
|
1142 | |
|
|
1143 | The builtin action is the action that @@RXVT_NAME@@ would execute if no |
|
|
1144 | key binding existed for the key combination. The obvious use is to undo |
|
|
1145 | the effect of existing bindings. The not so obvious use is to reinstate |
|
|
1146 | bindings when another binding overrides too many modifiers. |
|
|
1147 | |
1207 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
1148 | For example if you overwrite the C<Insert> key you will disable |
1208 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
1149 | @@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke |
1209 | user-defined keymap using the C<builtin:> replacement: |
1150 | "holes" into the user-defined keymap using the C<builtin:> replacement: |
1210 | |
1151 | |
1211 | URxvt.keysym.Insert: <my insert key sequence> |
1152 | URxvt.keysym.Insert: <my insert key sequence> |
1212 | URxvt.keysym.S-Insert: builtin: |
1153 | URxvt.keysym.S-Insert: builtin: |
1213 | |
1154 | |
1214 | The first line defines a mapping for C<Insert> and I<any> combination |
1155 | The first line defines a mapping for C<Insert> and I<any> combination |
1215 | of modifiers. The second line re-establishes the default mapping for |
1156 | of modifiers. The second line re-establishes the default mapping for |
1216 | C<Shift-Insert>. |
1157 | C<Shift-Insert>. |
1217 | |
1158 | |
1218 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1159 | =item builtin-string: |
1219 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
|
|
1220 | font-switching at runtime: |
|
|
1221 | |
1160 | |
1222 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1161 | This action is mainly useful to restore string mappings for keys that |
1223 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1162 | have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit |
|
|
1163 | difficult to explain - basically, this action will send the string to the |
|
|
1164 | application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in |
|
|
1165 | action for it. |
1224 | |
1166 | |
1225 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1167 | An example might make it clearer: @@RXVT_NAME@@ normally pastes the |
1226 | info): |
1168 | selection when you press C<Shift-Insert>. With the following bindings, it |
|
|
1169 | would instead emit the (undocumented, but what applications running in the |
|
|
1170 | terminal might expect) sequence C<ESC [ 2 $> instead: |
1227 | |
1171 | |
1228 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1172 | URxvt.keysym.S-Insert: builtin-string: |
1229 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1173 | URxvt.keysym.C-S-Insert: builtin: |
|
|
1174 | |
|
|
1175 | The first line disables the paste functionality for that key |
|
|
1176 | combination, and the second reinstates the default behaviour for |
|
|
1177 | C<Control-Shift-Insert>, which would otherwise be overridden. |
|
|
1178 | |
|
|
1179 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
|
|
1180 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
|
|
1181 | this: |
|
|
1182 | |
|
|
1183 | URxvt.keysym.C-S-c: builtin-string: |
|
|
1184 | URxvt.keysym.C-S-v: builtin-string: |
|
|
1185 | |
|
|
1186 | =item EXTENSION:STRING |
|
|
1187 | |
|
|
1188 | An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) |
|
|
1189 | extension of the same name. The extension will be loaded automatically if |
|
|
1190 | necessary. |
|
|
1191 | |
|
|
1192 | Not all extensions define key actions, but popular extensions that do |
|
|
1193 | include the I<selection> and I<matcher> extensions (documented in their |
|
|
1194 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
|
|
1195 | respectively). |
|
|
1196 | |
|
|
1197 | From the silly examples department, this will rot13-"encrypt" |
|
|
1198 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
|
|
1199 | keyboards: |
|
|
1200 | |
|
|
1201 | URxvt.keysym.M-C-c: selection:rot13 |
|
|
1202 | |
|
|
1203 | =item perl:STRING *DEPRECATED* |
|
|
1204 | |
|
|
1205 | This is a deprecated way of passing key mappings to perl extensions. It is |
|
|
1206 | still supported, but should not be used anymore. |
|
|
1207 | |
|
|
1208 | =back |
1230 | |
1209 | |
1231 | =item B<perl-ext-common>: I<string> |
1210 | =item B<perl-ext-common>: I<string> |
1232 | |
1211 | |
1233 | =item B<perl-ext>: I<string> |
1212 | =item B<perl-ext>: I<string> |
1234 | |
1213 | |
… | |
… | |
1236 | use in this terminal instance; option B<-pe>. |
1215 | use in this terminal instance; option B<-pe>. |
1237 | |
1216 | |
1238 | Extension names can be prefixed with a C<-> sign to prohibit using |
1217 | Extension names can be prefixed with a C<-> sign to prohibit using |
1239 | them. This can be useful to selectively disable some extensions loaded |
1218 | them. This can be useful to selectively disable some extensions loaded |
1240 | by default, or specified via the C<perl-ext-common> resource. For |
1219 | by default, or specified via the C<perl-ext-common> resource. For |
1241 | example, C<default,-selection> will use all the default extension except |
1220 | example, C<default,-selection> will use all the default extensions except |
1242 | C<selection>. |
1221 | C<selection>. |
1243 | |
1222 | |
1244 | Extension names can also be followed by an argument in angle brackets |
1223 | The default set includes the C<selection>, C<option-popup>, |
1245 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1224 | C<selection-popup> and C<readline> extensions, any extensions that define |
1246 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1225 | keybindings via C<BINDING> meta comments, extensions loaded because |
1247 | multiple times with different arguments will pass multiple arguments to |
1226 | their resources/commandline switches were used, and extensions which are |
1248 | the extension. |
1227 | mentioned in B<keysym> resources. |
1249 | |
1228 | |
1250 | Each extension is looked up in the library directories, loaded if |
1229 | Each extension is looked up in the library directories, loaded if |
1251 | necessary, and bound to the current terminal instance. |
1230 | necessary, and bound to the current terminal instance. When the library |
|
|
1231 | search path contains multiple extension files of the same name, then the |
|
|
1232 | first one found will be used. |
1252 | |
1233 | |
1253 | If both of these resources are the empty string, then the perl |
1234 | If both of these resources are the empty string, then the perl interpreter |
1254 | interpreter will not be initialized. The idea behind two options is that |
1235 | will not be initialized. The rationale for having two options is that |
1255 | B<perl-ext-common> will be used for extensions that should be available to |
1236 | B<perl-ext-common> will be used for extensions that should be available to |
1256 | all instances, while B<perl-ext> is used for specific instances. |
1237 | all instances, while B<perl-ext> is used for specific instances. |
1257 | |
1238 | |
1258 | =item B<perl-eval>: I<string> |
1239 | =item B<perl-eval>: I<string> |
1259 | |
1240 | |
… | |
… | |
1261 | the @@RXVT_NAME@@perl(3) manpage. |
1242 | the @@RXVT_NAME@@perl(3) manpage. |
1262 | |
1243 | |
1263 | =item B<perl-lib>: I<path> |
1244 | =item B<perl-lib>: I<path> |
1264 | |
1245 | |
1265 | Colon-separated list of additional directories that hold extension |
1246 | Colon-separated list of additional directories that hold extension |
1266 | scripts. When looking for extensions specified by the C<perl> resource, |
1247 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look |
1267 | @@RXVT_NAME@@ will first look in these directories and then in |
1248 | in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and |
1268 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1249 | lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1269 | |
1250 | |
1270 | See the @@RXVT_NAME@@perl(3) manpage. |
1251 | See the @@RXVT_NAME@@perl(3) manpage. |
1271 | |
1252 | |
1272 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1253 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1273 | |
1254 | |
… | |
… | |
1277 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1258 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1278 | |
1259 | |
1279 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1260 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1280 | for details. |
1261 | for details. |
1281 | |
1262 | |
1282 | =item B<searchable-scrollback:> I<keysym> |
1263 | =item B<searchable-scrollback:> I<keysym> *DEPRECATED* |
1283 | |
1264 | |
1284 | Sets the hotkey that starts the incremental scrollback buffer search |
1265 | This resource is deprecated and will be removed. Use a B<keysym> resource |
1285 | (default: C<M-s>). |
1266 | instead, e.g.: |
1286 | |
1267 | |
|
|
1268 | URxvt.keysym.M-s: searchable-scrollback:start |
|
|
1269 | |
1287 | =item B<urlLauncher>: I<string> |
1270 | =item B<url-launcher>: I<string> |
1288 | |
1271 | |
1289 | Specifies the program to be started with a URL argument. Used by the |
1272 | Specifies the program to be started with a URL argument. Used by the |
1290 | C<selection-popup> and C<matcher> perl extensions. |
1273 | C<selection-popup> and C<matcher> perl extensions. |
1291 | |
1274 | |
1292 | =item B<transient-for>: I<windowid> |
1275 | =item B<transient-for>: I<windowid> |
… | |
… | |
1296 | =item B<override-redirect>: I<boolean> |
1279 | =item B<override-redirect>: I<boolean> |
1297 | |
1280 | |
1298 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1281 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1299 | it almost invisible to window managers; option B<-override-redirect>. |
1282 | it almost invisible to window managers; option B<-override-redirect>. |
1300 | |
1283 | |
|
|
1284 | =item B<iso14755:> I<boolean> |
|
|
1285 | |
|
|
1286 | Turn on/off ISO 14755 (default enabled). |
|
|
1287 | |
1301 | =item B<iso14755_52:> I<boolean> |
1288 | =item B<iso14755_52:> I<boolean> |
1302 | |
1289 | |
1303 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1290 | Turn on/off ISO 14755 5.2 mode (default enabled). |
|
|
1291 | |
|
|
1292 | =back |
|
|
1293 | |
|
|
1294 | =head1 BACKGROUND IMAGE OPTIONS AND RESOURCES |
|
|
1295 | |
|
|
1296 | =over 4 |
|
|
1297 | |
|
|
1298 | =item B<-pixmap> I<file[;oplist]> |
|
|
1299 | |
|
|
1300 | =item B<backgroundPixmap:> I<file[;oplist]> |
|
|
1301 | |
|
|
1302 | Compile I<pixbuf>: Use the specified image file as the window's |
|
|
1303 | background and also optionally specify a colon separated list of |
|
|
1304 | operations to modify it. Note that you may need to quote the C<;> |
|
|
1305 | character when using the command line option, as C<;> is usually a |
|
|
1306 | metacharacter in shells. Supported operations are: |
|
|
1307 | |
|
|
1308 | =over 4 |
|
|
1309 | |
|
|
1310 | =item B<WxH+X+Y> |
|
|
1311 | |
|
|
1312 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
|
|
1313 | scale (percent), and B<"X" / "Y"> locate the image centre (percent). A |
|
|
1314 | scale of 0 disables scaling. |
|
|
1315 | |
|
|
1316 | =item B<op=tile> |
|
|
1317 | |
|
|
1318 | enables tiling |
|
|
1319 | |
|
|
1320 | =item B<op=keep-aspect> |
|
|
1321 | |
|
|
1322 | maintain the image aspect ratio when scaling |
|
|
1323 | |
|
|
1324 | =item B<op=root-align> |
|
|
1325 | |
|
|
1326 | use the position of the terminal window relative to the root window as |
|
|
1327 | the image offset, simulating a root window background |
|
|
1328 | |
|
|
1329 | =back |
|
|
1330 | |
|
|
1331 | The default scale and position setting is C<100x100+50+50>. |
|
|
1332 | Alternatively, a predefined set of templates can be used to achieve |
|
|
1333 | the most common setups: |
|
|
1334 | |
|
|
1335 | =over 4 |
|
|
1336 | |
|
|
1337 | =item B<style=tiled> |
|
|
1338 | |
|
|
1339 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
1340 | |
|
|
1341 | =item B<style=aspect-stretched> |
|
|
1342 | |
|
|
1343 | the image is scaled to fill the whole window maintaining the aspect |
|
|
1344 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
1345 | |
|
|
1346 | =item B<style=stretched> |
|
|
1347 | |
|
|
1348 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
1349 | |
|
|
1350 | =item B<style=centered> |
|
|
1351 | |
|
|
1352 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
1353 | |
|
|
1354 | =item B<style=root-tiled> |
|
|
1355 | |
|
|
1356 | the image is tiled with no scaling and using 'root' positioning. |
|
|
1357 | Equivalent to 0x0:op=tile:op=root-align |
|
|
1358 | |
|
|
1359 | =back |
|
|
1360 | |
|
|
1361 | If multiple templates are specified the last one wins. Note that a |
|
|
1362 | template overrides all the scale, position and operations settings. |
|
|
1363 | |
|
|
1364 | If used in conjunction with pseudo-transparency, the specified pixmap |
|
|
1365 | will be blended over the transparent background using alpha-blending. |
|
|
1366 | |
|
|
1367 | =item B<-tr>|B<+tr> |
|
|
1368 | |
|
|
1369 | =item B<transparent:> I<boolean> |
|
|
1370 | |
|
|
1371 | Turn on/off pseudo-transparency by using the root pixmap as background. |
|
|
1372 | |
|
|
1373 | B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but |
|
|
1374 | will be removed in future versions. |
|
|
1375 | |
|
|
1376 | =item B<-tint> I<colour> |
|
|
1377 | |
|
|
1378 | =item B<tintColor:> I<colour> |
|
|
1379 | |
|
|
1380 | Tint the transparent background with the given colour. Note that a |
|
|
1381 | black tint yields a completely black image while a white tint yields |
|
|
1382 | the image unchanged. |
|
|
1383 | |
|
|
1384 | =item B<-sh> I<number> |
|
|
1385 | |
|
|
1386 | =item B<shading:> I<number> |
|
|
1387 | |
|
|
1388 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
|
|
1389 | A value of 100 means no shading. |
|
|
1390 | |
|
|
1391 | =item B<-blr> I<HxV> |
|
|
1392 | |
|
|
1393 | =item B<blurRadius:> I<HxV> |
|
|
1394 | |
|
|
1395 | Apply gaussian blur with the specified radius to the transparent |
|
|
1396 | background. If a single number is specified, the vertical and |
|
|
1397 | horizontal radii are considered to be the same. Setting one of the |
|
|
1398 | radii to 1 and the other to a large number creates interesting effects |
|
|
1399 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
1400 | vertical radius of 0 disables blurring. |
|
|
1401 | |
|
|
1402 | =item B<path:> I<path> |
|
|
1403 | |
|
|
1404 | Specify the colon-delimited search path for finding background image files. |
1304 | |
1405 | |
1305 | =back |
1406 | =back |
1306 | |
1407 | |
1307 | =head1 THE SCROLLBAR |
1408 | =head1 THE SCROLLBAR |
1308 | |
1409 | |
… | |
… | |
1356 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1457 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1357 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1458 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1358 | |
1459 | |
1359 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1460 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1360 | inserted too. |
1461 | inserted too. |
|
|
1462 | |
|
|
1463 | rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and |
|
|
1464 | <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first |
|
|
1465 | binding causes the value of the internal selection to be copied to the |
|
|
1466 | CLIPBOARD selection, while the second binding causes the value of the |
|
|
1467 | CLIPBOARD selection to be inserted. |
1361 | |
1468 | |
1362 | =back |
1469 | =back |
1363 | |
1470 | |
1364 | =head1 CHANGING FONTS |
1471 | =head1 CHANGING FONTS |
1365 | |
1472 | |
… | |
… | |
1447 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1554 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1448 | it can be seen via the I<who(1)> command, and can accept messages. To |
1555 | it can be seen via the I<who(1)> command, and can accept messages. To |
1449 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1556 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1450 | on some systems or setgid to root or to some other group on others. |
1557 | on some systems or setgid to root or to some other group on others. |
1451 | |
1558 | |
1452 | =head1 COLORS AND GRAPHICS |
1559 | =head1 COLOURS AND GRAPHICS |
1453 | |
1560 | |
1454 | In addition to the default foreground and background colours, |
1561 | In addition to the default foreground and background colours, |
1455 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1562 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1456 | high-intensity bold/blink versions of the same). Here is a list of the |
1563 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1457 | colours with their names. |
1564 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1565 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1566 | |
|
|
1567 | Here is a list of the ANSI colours with their names. |
1458 | |
1568 | |
1459 | =begin table |
1569 | =begin table |
1460 | |
1570 | |
1461 | B<color0> (black) = Black |
1571 | B<color0> (black) = Black |
1462 | B<color1> (red) = Red3 |
1572 | B<color1> (red) = Red3 |
… | |
… | |
1482 | It is also possible to specify the colour values of B<foreground>, |
1592 | It is also possible to specify the colour values of B<foreground>, |
1483 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1593 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1484 | a number 0-15, as a convenient shorthand to reference the colour name of |
1594 | a number 0-15, as a convenient shorthand to reference the colour name of |
1485 | color0-color15. |
1595 | color0-color15. |
1486 | |
1596 | |
1487 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1597 | The following text gives values for the standard 88 colour mode (and |
1488 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1598 | values for the 256 colour mode in parentheses). |
1489 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1490 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1491 | |
1599 | |
|
|
1600 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1601 | |
|
|
1602 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1603 | index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5 |
|
|
1604 | |
|
|
1605 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1606 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
|
|
1607 | the RGB cube. |
|
|
1608 | |
1492 | Together, all those colours implement the 88 colour xterm colours. Only |
1609 | Together, all those colours implement the 88 (256) colour xterm |
1493 | the first 16 can be changed using resources currently, the rest can only |
1610 | colours. Only the first 16 can be changed using resources currently, the |
1494 | be changed via command sequences ("escape codes"). |
1611 | rest can only be changed via command sequences ("escape codes"). |
|
|
1612 | |
|
|
1613 | Applications are advised to use terminfo or command sequences to discover |
|
|
1614 | number and RGB values of all colours (yes, you can query this...). |
1495 | |
1615 | |
1496 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1616 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1497 | always swapping the foreground/background colours. This is in contrast to |
1617 | always swapping the foreground/background colours. This is in contrast to |
1498 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1618 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1499 | been specified. For example, |
1619 | been specified. For example, |
… | |
… | |
1504 | White. |
1624 | White. |
1505 | |
1625 | |
1506 | =head2 ALPHA CHANNEL SUPPORT |
1626 | =head2 ALPHA CHANNEL SUPPORT |
1507 | |
1627 | |
1508 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1628 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1509 | their act together, rxvt-unicode will do it's own alpha channel management: |
1629 | their act together, rxvt-unicode will do its own alpha channel management: |
1510 | |
1630 | |
1511 | You can prefix any color with an opaquenes percentage enclosed in |
1631 | You can prefix any colour with an opaqueness percentage enclosed in |
1512 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1632 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1513 | (0-100) that specifies the opacity of the color, where C<0> is completely |
1633 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
1514 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1634 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1515 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1635 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1516 | is the recommended format to specify transparency values, and works with |
1636 | is the recommended format to specify transparency values, and works with |
1517 | all ways to specify a colour. |
1637 | all ways to specify a colour. |
1518 | |
1638 | |
… | |
… | |
1596 | |
1716 | |
1597 | =item B<SHELL> |
1717 | =item B<SHELL> |
1598 | |
1718 | |
1599 | The shell to be used for command execution, defaults to C</bin/sh>. |
1719 | The shell to be used for command execution, defaults to C</bin/sh>. |
1600 | |
1720 | |
1601 | =item B<RXVT_SOCKET> |
1721 | =item B<RXVT_SOCKET> [I<sic>] |
1602 | |
1722 | |
1603 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1723 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1604 | @@RXVT_NAME@@d(1). |
1724 | @@RXVT_NAME@@d(1). |
1605 | |
1725 | |
1606 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1726 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
|
|
1727 | |
|
|
1728 | =item B<URXVT_PERL_LIB> |
|
|
1729 | |
|
|
1730 | Additional F<:>-separated library search path for perl extensions. Will be |
|
|
1731 | searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library |
|
|
1732 | directory. |
|
|
1733 | |
|
|
1734 | =item B<URXVT_PERL_VERBOSITY> |
|
|
1735 | |
|
|
1736 | See L<@@RXVT_NAME@@perl>(3). |
1607 | |
1737 | |
1608 | =item B<HOME> |
1738 | =item B<HOME> |
1609 | |
1739 | |
1610 | Used to locate the default directory for the unix domain socket for |
1740 | Used to locate the default directory for the unix domain socket for |
1611 | daemon communications and to locate various resource files (such as |
1741 | daemon communications and to locate various resource files (such as |
1612 | C<.Xdefaults>) |
1742 | C<.Xdefaults>) |
1613 | |
1743 | |
1614 | =item B<XAPPLRESDIR> |
1744 | =item B<XAPPLRESDIR> |
1615 | |
1745 | |
1616 | Directory where various X resource files are being located. |
1746 | Directory where application-specific X resource files are located. |
1617 | |
1747 | |
1618 | =item B<XENVIRONMENT> |
1748 | =item B<XENVIRONMENT> |
1619 | |
1749 | |
1620 | If set and accessible, gives the name of a X resource file to be loaded by |
1750 | If set and accessible, gives the name of a X resource file to be loaded by |
1621 | @@RXVT_NAME@@. |
1751 | @@RXVT_NAME@@. |
… | |
… | |
1626 | |
1756 | |
1627 | =over 4 |
1757 | =over 4 |
1628 | |
1758 | |
1629 | =item B</usr/lib/X11/rgb.txt> |
1759 | =item B</usr/lib/X11/rgb.txt> |
1630 | |
1760 | |
1631 | Color names. |
1761 | Colour names. |
1632 | |
1762 | |
1633 | =back |
1763 | =back |
1634 | |
1764 | |
1635 | =head1 SEE ALSO |
1765 | =head1 SEE ALSO |
1636 | |
1766 | |
|
|
1767 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), |
1637 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1768 | @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1638 | |
1769 | |
1639 | =head1 CURRENT PROJECT COORDINATOR |
1770 | =head1 CURRENT PROJECT COORDINATOR |
1640 | |
1771 | |
1641 | =over 4 |
1772 | =over 4 |
1642 | |
1773 | |
1643 | =item Project Coordinator |
1774 | =item Project Coordinator |
1644 | |
1775 | |
1645 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1776 | Marc A. Lehmann <rxvt-unicode@schmorp.de>. |
1646 | |
1777 | |
1647 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1778 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1648 | |
1779 | |
1649 | =back |
1780 | =back |
1650 | |
1781 | |
… | |
… | |
1654 | |
1785 | |
1655 | =item John Bovey |
1786 | =item John Bovey |
1656 | |
1787 | |
1657 | University of Kent, 1992, wrote the original Xvt. |
1788 | University of Kent, 1992, wrote the original Xvt. |
1658 | |
1789 | |
1659 | =item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
1790 | =item Rob Nation <nation@rocket.sanders.lockheed.com> |
1660 | |
1791 | |
1661 | very heavily modified Xvt and came up with Rxvt |
1792 | very heavily modified Xvt and came up with Rxvt |
1662 | |
1793 | |
1663 | =item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
1794 | =item Angelo Haritsis <ah@doc.ic.ac.uk> |
1664 | |
1795 | |
1665 | wrote the Greek Keyboard Input (no longer in code) |
1796 | wrote the Greek Keyboard Input (no longer in code) |
1666 | |
1797 | |
1667 | =item mj olesen L<< <olesen@me.QueensU.CA> >> |
1798 | =item mj olesen <olesen@me.QueensU.CA> |
1668 | |
1799 | |
1669 | Wrote the menu system. |
1800 | Wrote the menu system. |
1670 | |
1801 | |
1671 | Project Coordinator (changes.txt 2.11 to 2.21) |
1802 | Project Coordinator (changes.txt 2.11 to 2.21) |
1672 | |
1803 | |
1673 | =item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
1804 | =item Oezguer Kesim <kesim@math.fu-berlin.de> |
1674 | |
1805 | |
1675 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1806 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1676 | |
1807 | |
1677 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1808 | =item Geoff Wing <gcw@pobox.com> |
1678 | |
1809 | |
1679 | Rewrote screen display and text selection routines. |
1810 | Rewrote screen display and text selection routines. |
1680 | |
1811 | |
1681 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1812 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1682 | |
1813 | |
1683 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1814 | =item Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1684 | |
1815 | |
1685 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1816 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1686 | extension, random hacks, numerous bugfixes and extensions. |
1817 | extension, random hacks, numerous bugfixes and extensions. |
1687 | |
1818 | |
1688 | Project Coordinator (Changes 1.0 -) |
1819 | Project Coordinator (Changes 1.0 -) |
1689 | |
1820 | |
1690 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1821 | =item Emanuele Giaquinta <emanuele.giaquinta@gmail.com> |
1691 | |
1822 | |
1692 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
1823 | pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. |
1693 | |
1824 | |
1694 | =back |
1825 | =back |
1695 | |
1826 | |