… | |
… | |
124 | |
124 | |
125 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
125 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
126 | |
126 | |
127 | =item B<-tr>|B<+tr> |
127 | =item B<-tr>|B<+tr> |
128 | |
128 | |
129 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
129 | Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>. |
130 | |
130 | |
131 | B<-ip> is still accepted as an obsolete alias but will be removed in |
131 | B<-ip> is still accepted as an obsolete alias but will be removed in |
132 | future versions. |
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 | |
133 | |
137 | =item B<-fade> I<number> |
134 | =item B<-fade> I<number> |
138 | |
135 | |
139 | Fade the text by the given percentage when focus is lost. Small values |
136 | 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 |
137 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
145 | Fade to this colour when fading is used (see B<-fade>). The default colour |
142 | Fade to this colour when fading is used (see B<-fade>). The default colour |
146 | is opaque black. resource B<fadeColor>. |
143 | is opaque black. resource B<fadeColor>. |
147 | |
144 | |
148 | =item B<-tint> I<colour> |
145 | =item B<-tint> I<colour> |
149 | |
146 | |
150 | Tint the transparent background pixmap with the given colour when |
147 | Tint the transparent background with the given colour; |
151 | transparency is enabled with B<-tr>. This only works for |
148 | resource I<tintColor>. |
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 | |
149 | |
162 | =item B<-sh> I<number> |
150 | =item B<-sh> I<number> |
163 | |
151 | |
164 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
152 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
165 | background image in addition to (or instead of) tinting it; |
153 | A value of 100 means no shading; resource I<shading>. |
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 | |
154 | |
178 | =item B<-blr> I<HxV> |
155 | =item B<-blr> I<HxV> |
179 | |
156 | |
180 | Apply Gaussian Blur with the specified radii to the transparent |
157 | Apply Gaussian Blur with the specified radii to the transparent |
181 | background image. If single number is specified - both vertical and |
158 | background. If a single number is specified, the vertical and |
182 | horizontal radii are considered to be the same. Setting one of the |
159 | 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 |
160 | radii to 1 and the other to a large number creates interesting effects |
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
161 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
162 | vertical radius of 0 disables blurring; |
185 | resource I<blurRadius>. |
163 | resource I<blurRadius>. |
186 | |
164 | |
|
|
165 | =item B<-icon> I<file> |
|
|
166 | |
|
|
167 | Compile I<pixbuf>: Use the specified image as application icon. This |
|
|
168 | is used by many window managers, taskbars and pagers to represent the |
|
|
169 | application window; resource I<iconFile>. |
|
|
170 | |
187 | =item B<-bg> I<colour> |
171 | =item B<-bg> I<colour> |
188 | |
172 | |
189 | Window background colour; resource B<background>. |
173 | Window background colour; resource B<background>. |
190 | |
174 | |
191 | =item B<-fg> I<colour> |
175 | =item B<-fg> I<colour> |
192 | |
176 | |
193 | Window foreground colour; resource B<foreground>. |
177 | Window foreground colour; resource B<foreground>. |
194 | |
178 | |
195 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
179 | =item B<-pixmap> I<file[;oplist]> |
196 | |
180 | |
197 | Compile I<afterimage>: Specify image file for the background and also |
181 | Compile I<pixbuf>: Specify image file for the background and also |
198 | optionally specify its scaling with a geometry string. Note you may need to |
182 | optionally specify a list of operations to modify it. Note you may need to |
199 | add quotes to avoid special shell interpretation of the C<;> in the |
183 | add quotes to avoid special shell interpretation of the C<;> in the |
200 | command-line; for more details see resource B<backgroundPixmap>. |
184 | command-line; for more details see resource B<backgroundPixmap>. |
201 | |
185 | |
202 | =item B<-cr> I<colour> |
186 | =item B<-cr> I<colour> |
203 | |
187 | |
… | |
… | |
315 | |
299 | |
316 | =item B<-bc>|B<+bc> |
300 | =item B<-bc>|B<+bc> |
317 | |
301 | |
318 | Blink the cursor; resource B<cursorBlink>. |
302 | Blink the cursor; resource B<cursorBlink>. |
319 | |
303 | |
|
|
304 | =item B<-uc>|B<+uc> |
|
|
305 | |
|
|
306 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
307 | |
320 | =item B<-iconic> |
308 | =item B<-iconic> |
321 | |
309 | |
322 | Start iconified, if the window manager supports that option. |
310 | Start iconified, if the window manager supports that option. |
323 | Alternative form is B<-ic>. |
311 | Alternative form is B<-ic>. |
324 | |
312 | |
… | |
… | |
360 | =item B<-lsp> I<number> |
348 | =item B<-lsp> I<number> |
361 | |
349 | |
362 | Compile I<frills>: Lines (pixel height) to insert between each row of |
350 | Compile I<frills>: Lines (pixel height) to insert between each row of |
363 | the display. Useful to work around font rendering problems; resource |
351 | the display. Useful to work around font rendering problems; resource |
364 | B<lineSpace>. |
352 | B<lineSpace>. |
|
|
353 | |
|
|
354 | =item B<-letsp> I<number> |
|
|
355 | |
|
|
356 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
357 | to control overall letter spacing. Negative values will tighten up the |
|
|
358 | letter spacing, positive values will space letters out more. Useful to |
|
|
359 | work around odd font metrics; resource B<letterSpace>. |
365 | |
360 | |
366 | =item B<-tn> I<termname> |
361 | =item B<-tn> I<termname> |
367 | |
362 | |
368 | This option specifies the name of the terminal type to be set in the |
363 | This option specifies the name of the terminal type to be set in the |
369 | B<TERM> environment variable. This terminal type must exist in the |
364 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
554 | You can set and change the resources using X11 tools like B<xrdb>. Many |
549 | You can set and change the resources using X11 tools like B<xrdb>. Many |
555 | distribution do also load settings from the B<~/.Xresources> file when X |
550 | distribution do also load settings from the B<~/.Xresources> file when X |
556 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
551 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
557 | with later settings overwriting earlier ones: |
552 | with later settings overwriting earlier ones: |
558 | |
553 | |
559 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
560 | 2. app-defaults file in $XAPPLRESDIR |
554 | 1. app-defaults file in $XAPPLRESDIR |
|
|
555 | 2. $HOME/.Xdefaults |
561 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
556 | 3. RESOURCE_MANAGER property on root-window of screen 0 |
562 | 4. SCREEN_RESOURCES for the current screen |
557 | 4. SCREEN_RESOURCES property on root-window of the current screen |
563 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
558 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
564 | 6. resources specified via -xrm on the commandline |
559 | 6. resources specified via -xrm on the commandline |
565 | |
560 | |
566 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
561 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
567 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
562 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
… | |
… | |
608 | Use the specified colour for the colour value I<n>, where 0-7 |
603 | Use the specified colour for the colour value I<n>, where 0-7 |
609 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
604 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
610 | high-intensity (bold = bright foreground, blink = bright background) |
605 | high-intensity (bold = bright foreground, blink = bright background) |
611 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
606 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
612 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
607 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
613 | names used are listed in the B<COLORS AND GRAPHICS> section. |
608 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
614 | |
609 | |
615 | Colours higher than 15 cannot be set using resources (yet), but can be |
610 | Colours higher than 15 cannot be set using resources (yet), but can be |
616 | changed using an escape command (see @@RXVT_NAME@@(7)). |
611 | changed using an escape command (see @@RXVT_NAME@@(7)). |
617 | |
612 | |
618 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
613 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
629 | =item B<colorUL:> I<colour> |
624 | =item B<colorUL:> I<colour> |
630 | |
625 | |
631 | Use the specified colour to display underlined characters when the |
626 | Use the specified colour to display underlined characters when the |
632 | foreground colour is the default. |
627 | foreground colour is the default. |
633 | |
628 | |
634 | =item B<colorRV:> I<colour> |
|
|
635 | |
|
|
636 | Use the specified colour as the background for reverse video characters |
|
|
637 | when OPTION_HC is disabled (--disable-frills). |
|
|
638 | |
|
|
639 | =item B<underlineColor:> I<colour> |
629 | =item B<underlineColor:> I<colour> |
640 | |
630 | |
641 | If set, use the specified colour as the colour for the underline |
631 | If set, use the specified colour as the colour for the underline |
642 | itself. If unset, use the foreground colour. |
632 | itself. If unset, use the foreground colour. |
|
|
633 | |
|
|
634 | =item B<highlightColor:> I<colour> |
|
|
635 | |
|
|
636 | If set, use the specified colour as the background for highlighted |
|
|
637 | characters. If unset, use reverse video. |
|
|
638 | |
|
|
639 | =item B<highlightTextColor:> I<colour> |
|
|
640 | |
|
|
641 | If set and highlightColor is set, use the specified colour as the |
|
|
642 | foreground for highlighted characters. |
643 | |
643 | |
644 | =item B<cursorColor:> I<colour> |
644 | =item B<cursorColor:> I<colour> |
645 | |
645 | |
646 | Use the specified colour for the cursor. The default is to use the |
646 | Use the specified colour for the cursor. The default is to use the |
647 | foreground colour; option B<-cr>. |
647 | foreground colour; option B<-cr>. |
… | |
… | |
654 | |
654 | |
655 | =item B<reverseVideo:> I<boolean> |
655 | =item B<reverseVideo:> I<boolean> |
656 | |
656 | |
657 | B<True>: simulate reverse video by foreground and background colours; |
657 | B<True>: simulate reverse video by foreground and background colours; |
658 | option B<-rv>. B<False>: regular screen colours [default]; option |
658 | option B<-rv>. B<False>: regular screen colours [default]; option |
659 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
659 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
660 | |
660 | |
661 | =item B<jumpScroll:> I<boolean> |
661 | =item B<jumpScroll:> I<boolean> |
662 | |
662 | |
663 | B<True>: specify that jump scrolling should be used. When receiving lots |
663 | B<True>: specify that jump scrolling should be used. When receiving lots |
664 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
664 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
… | |
… | |
680 | if the refresh is too fast for the human eye to read anything (or the |
680 | if the refresh is too fast for the human eye to read anything (or the |
681 | monitor to display anything); option B<+ss>. |
681 | monitor to display anything); option B<+ss>. |
682 | |
682 | |
683 | =item B<transparent:> I<boolean> |
683 | =item B<transparent:> I<boolean> |
684 | |
684 | |
685 | Turn on/off illusion of a transparent window background. |
685 | Turn on/off pseudo-transparency by using the root pixmap as background. |
686 | |
686 | |
687 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
687 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
688 | future versions. |
688 | future versions. |
689 | |
689 | |
690 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
691 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
|
|
692 | |
|
|
693 | =item B<fading:> I<number> |
690 | =item B<fading:> I<number> |
694 | |
691 | |
695 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
692 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
696 | |
693 | |
697 | =item B<fadeColor:> I<colour> |
694 | =item B<fadeColor:> I<colour> |
… | |
… | |
699 | Fade to this colour, when fading is used (see B<fading:>). The default |
696 | Fade to this colour, when fading is used (see B<fading:>). The default |
700 | colour is black; option B<-fadecolor>. |
697 | colour is black; option B<-fadecolor>. |
701 | |
698 | |
702 | =item B<tintColor:> I<colour> |
699 | =item B<tintColor:> I<colour> |
703 | |
700 | |
704 | Tint the transparent background pixmap with the given colour; option |
701 | Tint the transparent background with the given colour. If the RENDER |
705 | B<-tint>. |
702 | extension is not available only black, red, green, yellow, blue, |
|
|
703 | magenta, cyan and white tints can be performed server-side. Note that |
|
|
704 | a black tint yields a completely black image while a white tint yields |
|
|
705 | the image unchanged; option B<-tint>. |
706 | |
706 | |
707 | =item B<shading:> I<number> |
707 | =item B<shading:> I<number> |
708 | |
708 | |
709 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
709 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
710 | in addition to tinting it; option B<-sh>. |
710 | A value of 100 means no shading; option B<-sh>. |
711 | |
|
|
712 | =item B<blendType:> I<string> |
|
|
713 | |
|
|
714 | Specify background blending type; option B<-blt>. |
|
|
715 | |
711 | |
716 | =item B<blurRadius:> I<number> |
712 | =item B<blurRadius:> I<number> |
717 | |
713 | |
718 | Apply Gaussian Blurr with the specified radius to the transparent |
714 | Apply gaussian blur with the specified radius to the transparent |
719 | background image; option B<-blr>. |
715 | background; option B<-blr>. |
|
|
716 | |
|
|
717 | =item B<iconFile:> I<file> |
|
|
718 | |
|
|
719 | Set the application icon pixmap; option B<-icon>. |
720 | |
720 | |
721 | =item B<scrollColor:> I<colour> |
721 | =item B<scrollColor:> I<colour> |
722 | |
722 | |
723 | Use the specified colour for the scrollbar [default #B2B2B2]. |
723 | Use the specified colour for the scrollbar [default #B2B2B2]. |
724 | |
724 | |
… | |
… | |
730 | =item B<borderColor:> I<colour> |
730 | =item B<borderColor:> I<colour> |
731 | |
731 | |
732 | The colour of the border around the text area and between the scrollbar |
732 | The colour of the border around the text area and between the scrollbar |
733 | and the text. |
733 | and the text. |
734 | |
734 | |
735 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
735 | =item B<backgroundPixmap:> I<file[;oplist]> |
736 | |
736 | |
737 | Use the specified image file for the background and also |
737 | Use the specified image file for the background and also |
738 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
738 | optionally specify a colon separated list of operations to modify it. |
739 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
|
|
740 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
|
|
741 | centre (percent). A scale of 0 displays the image with tiling. A scale |
|
|
742 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
|
|
743 | an integer number of images in that direction. No image will be magnified |
|
|
744 | beyond 10 times its original size. The maximum permitted scale is 1000. |
|
|
745 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
746 | Supported operations are: |
739 | Supported operations are: |
747 | |
740 | |
748 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
741 | =over 4 |
749 | propscale will scale image keeping proportions |
742 | |
750 | auto will scale image to match window size. Equivalent to 100x100 |
743 | =item B<WxH+X+Y> |
751 | hscale will scale image horizontally to the window size |
744 | |
752 | vscale will scale image vertically to the window size |
745 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
753 | scale will scale image to match window size |
746 | scale (percent), and B<"X" / "Y"> locate the image centre (percent). A |
754 | root will tile image as if it was a root window background, auto-adjusting |
747 | scale of 0 disables scaling. |
755 | whenever terminal window moves |
748 | |
|
|
749 | =item B<op=tile> |
|
|
750 | |
|
|
751 | enables tiling |
|
|
752 | |
|
|
753 | =item B<op=keep-aspect> |
|
|
754 | |
|
|
755 | maintain the image aspect ratio when scaling |
|
|
756 | |
|
|
757 | =item B<op=root-align> |
|
|
758 | |
|
|
759 | use the position of the terminal window relative to the root window as |
|
|
760 | the image offset, simulating a root window background |
|
|
761 | |
|
|
762 | =back |
|
|
763 | |
|
|
764 | The default scale and position setting is C<100x100+50+50>. |
|
|
765 | Alternatively, a predefined set of templates can be used to achieve |
|
|
766 | the most common setups: |
|
|
767 | |
|
|
768 | =over 4 |
|
|
769 | |
|
|
770 | =item B<style=tiled> |
|
|
771 | |
|
|
772 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
773 | |
|
|
774 | =item B<style=aspect-stretched> |
|
|
775 | |
|
|
776 | the image is scaled to fill the whole window maintaining the aspect |
|
|
777 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
778 | |
|
|
779 | =item B<style=stretched> |
|
|
780 | |
|
|
781 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
782 | |
|
|
783 | =item B<style=centered> |
|
|
784 | |
|
|
785 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
786 | |
|
|
787 | =item B<style=root-tiled> |
|
|
788 | |
|
|
789 | the image is tiled with no scaling and using 'root' positioning. |
|
|
790 | Equivalent to 0x0:op=tile:op=root-align |
|
|
791 | |
|
|
792 | =back |
|
|
793 | |
|
|
794 | If multiple templates are specified the last one wins. Note that a |
|
|
795 | template overrides all the scale, position and operations settings. |
756 | |
796 | |
757 | If used in conjunction with B<-tr> option, the specified pixmap will be |
797 | If used in conjunction with B<-tr> option, the specified pixmap will be |
758 | blended over transparency image using either alpha-blending, or any |
798 | blended over the transparent background using alpha-blending. |
759 | other blending type, specified with B<-blt "type"> option. |
|
|
760 | |
799 | |
761 | =item B<path:> I<path> |
800 | =item B<path:> I<path> |
762 | |
801 | |
763 | Specify the colon-delimited search path for finding background image files. |
802 | Specify the colon-delimited search path for finding background image files. |
764 | |
803 | |
… | |
… | |
791 | it is named first) and thus defines the character cell grid to be 9 pixels |
830 | it is named first) and thus defines the character cell grid to be 9 pixels |
792 | wide and 15 pixels high. |
831 | wide and 15 pixels high. |
793 | |
832 | |
794 | The second font is just used to add additional unicode characters not in |
833 | The second font is just used to add additional unicode characters not in |
795 | the base font, likewise the third, which is unfortunately non-bold, but |
834 | the base font, likewise the third, which is unfortunately non-bold, but |
796 | the bold version of the font does contain less characters, so this is a |
835 | the bold version of the font does contain fewer characters, so this is a |
797 | useful supplement. |
836 | useful supplement. |
798 | |
837 | |
799 | The third font is an Xft font with aliasing turned off, and the characters |
838 | The third font is an Xft font with aliasing turned off, and the characters |
800 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
839 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
801 | contains other characters, but we are not interested in them. |
840 | contains other characters, but we are not interested in them. |
… | |
… | |
852 | =item B<urgentOnBell:> I<boolean> |
891 | =item B<urgentOnBell:> I<boolean> |
853 | |
892 | |
854 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
893 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
855 | B<False>: do not set the urgency hint [default]. |
894 | B<False>: do not set the urgency hint [default]. |
856 | |
895 | |
|
|
896 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
897 | |
857 | =item B<visualBell:> I<boolean> |
898 | =item B<visualBell:> I<boolean> |
858 | |
899 | |
859 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
900 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
860 | B<False>: no visual bell [default]; option B<+vb>. |
901 | B<False>: no visual bell [default]; option B<+vb>. |
861 | |
902 | |
… | |
… | |
889 | =item B<scrollstyle:> I<mode> |
930 | =item B<scrollstyle:> I<mode> |
890 | |
931 | |
891 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
932 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
892 | the author's favourite. |
933 | the author's favourite. |
893 | |
934 | |
|
|
935 | =item B<thickness:> I<number> |
|
|
936 | |
|
|
937 | Set the scrollbar width in pixels. |
|
|
938 | |
894 | =item B<scrollBar:> I<boolean> |
939 | =item B<scrollBar:> I<boolean> |
895 | |
940 | |
896 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
941 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
897 | disable the scrollbar; option B<+sb>. |
942 | disable the scrollbar; option B<+sb>. |
898 | |
943 | |
… | |
… | |
917 | B<False>: do not scroll to bottom when tty receives output; option |
962 | B<False>: do not scroll to bottom when tty receives output; option |
918 | B<+si>. |
963 | B<+si>. |
919 | |
964 | |
920 | =item B<scrollWithBuffer:> I<boolean> |
965 | =item B<scrollWithBuffer:> I<boolean> |
921 | |
966 | |
922 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
967 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
923 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
968 | try to show the same lines) and B<scrollTtyOutput> is False; option |
924 | with scrollback buffer when tty receives new lines; option B<+sw>. |
969 | B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives |
|
|
970 | new lines; option B<+sw>. |
925 | |
971 | |
926 | =item B<scrollTtyKeypress:> I<boolean> |
972 | =item B<scrollTtyKeypress:> I<boolean> |
927 | |
973 | |
928 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
974 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
929 | are those which are intercepted by rxvt-unicode for special handling and |
975 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
985 | =item B<cursorBlink:> I<boolean> |
1031 | =item B<cursorBlink:> I<boolean> |
986 | |
1032 | |
987 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1033 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
988 | option B<-bc>. |
1034 | option B<-bc>. |
989 | |
1035 | |
|
|
1036 | =item B<cursorUnderline:> I<boolean> |
|
|
1037 | |
|
|
1038 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
1039 | option B<-uc>. |
|
|
1040 | |
990 | =item B<pointerBlank:> I<boolean> |
1041 | =item B<pointerBlank:> I<boolean> |
991 | |
1042 | |
992 | B<True>: blank the pointer when a key is pressed or after a set number |
1043 | B<True>: blank the pointer when a key is pressed or after a set number |
993 | of seconds of inactivity. B<False>: the pointer is always visible |
1044 | of seconds of inactivity. B<False>: the pointer is always visible |
994 | [default]. |
1045 | [default]. |
… | |
… | |
1007 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1058 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1008 | |
1059 | |
1009 | =item B<backspacekey:> I<string> |
1060 | =item B<backspacekey:> I<string> |
1010 | |
1061 | |
1011 | The string to send when the backspace key is pressed. If set to B<DEC> |
1062 | The string to send when the backspace key is pressed. If set to B<DEC> |
1012 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
1063 | or unset it will send B<Delete> (code 127) or, with control, B<Backspace> |
1013 | (code 8) - which can be reversed with the appropriate DEC private mode |
1064 | (code 8) - which can be reversed with the appropriate DEC private mode |
1014 | escape sequence. |
1065 | escape sequence. |
1015 | |
1066 | |
1016 | =item B<deletekey:> I<string> |
1067 | =item B<deletekey:> I<string> |
1017 | |
1068 | |
… | |
… | |
1136 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1187 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1137 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1188 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1138 | performed in an exact manner; however, the closest match is assured. |
1189 | performed in an exact manner; however, the closest match is assured. |
1139 | |
1190 | |
1140 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1191 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1141 | number), see RESOURCES in C<man 7 X> for futher details. |
1192 | number), see RESOURCES in C<man 7 X> for further details. |
1142 | |
1193 | |
1143 | You can define a range of keysyms in one shot by providing a I<string> |
1194 | You can define a range of keysyms in one shot by |
|
|
1195 | loading the C<keysym-list> perl extension and providing a I<string> |
1144 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1196 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1145 | should be a character not used by the strings. |
1197 | should be a character not used by the strings. |
1146 | |
1198 | |
1147 | Its usage can be demonstrated by an example: |
1199 | Its usage can be demonstrated by an example: |
1148 | |
1200 | |
1149 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1201 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
1150 | |
1202 | |
1151 | The above line is equivalent to the following three lines: |
1203 | The above line is equivalent to the following three lines: |
1152 | |
1204 | |
1153 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1205 | URxvt.keysym.Meta-Control-0x61: \033<a> |
1154 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1206 | URxvt.keysym.Meta-Control-0x62: \033<b> |
1155 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1207 | URxvt.keysym.Meta-Control-0x63: \033<c> |
1156 | |
1208 | |
1157 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1209 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1158 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1210 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1159 | example the following means "change the current locale to C<zh_CN.GBK> |
1211 | example the following means "change the current locale to C<zh_CN.GBK> |
1160 | when Control-Meta-c is being pressed": |
1212 | when Control-Meta-c is being pressed": |
1161 | |
1213 | |
1162 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1214 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1163 | |
1215 | |
1164 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1216 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1165 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1217 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1166 | manpage. For example, the F<selection> extension (activated via |
1218 | manpage. For example, the F<selection> extension (activated via |
1167 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1219 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1168 | |
1220 | |
1169 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1221 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1170 | |
1222 | |
1171 | Due the the large number of modifier combinations, a defined key mapping |
1223 | Due the the large number of modifier combinations, a defined key mapping |
1172 | will match if at I<at least> the specified identifiers are being set, and |
1224 | will match if I<at least> the specified identifiers are being set, and |
1173 | no other key mappings with those and more bits are being defined. That |
1225 | no other key mappings with those and more bits are being defined. That |
1174 | means that defining a key map for C<a> will automatically provide |
1226 | means that defining a key map for C<a> will automatically provide |
1175 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
1227 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
1176 | mappings themselves. |
1228 | mappings themselves. |
1177 | |
1229 | |
… | |
… | |
1233 | the @@RXVT_NAME@@perl(3) manpage. |
1285 | the @@RXVT_NAME@@perl(3) manpage. |
1234 | |
1286 | |
1235 | =item B<perl-lib>: I<path> |
1287 | =item B<perl-lib>: I<path> |
1236 | |
1288 | |
1237 | Colon-separated list of additional directories that hold extension |
1289 | Colon-separated list of additional directories that hold extension |
1238 | scripts. When looking for extensions specified by the C<perl> resource, |
1290 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look |
1239 | @@RXVT_NAME@@ will first look in these directories and then in |
1291 | in these directories, then in C<$RXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and |
1240 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1292 | lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1241 | |
1293 | |
1242 | See the @@RXVT_NAME@@perl(3) manpage. |
1294 | See the @@RXVT_NAME@@perl(3) manpage. |
1243 | |
1295 | |
1244 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1296 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1245 | |
1297 | |
… | |
… | |
1267 | |
1319 | |
1268 | =item B<override-redirect>: I<boolean> |
1320 | =item B<override-redirect>: I<boolean> |
1269 | |
1321 | |
1270 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1322 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1271 | it almost invisible to window managers; option B<-override-redirect>. |
1323 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1324 | |
|
|
1325 | =item B<iso14755:> I<boolean> |
|
|
1326 | |
|
|
1327 | Turn on/off ISO 14755 (default enabled). |
1272 | |
1328 | |
1273 | =item B<iso14755_52:> I<boolean> |
1329 | =item B<iso14755_52:> I<boolean> |
1274 | |
1330 | |
1275 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1331 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1276 | |
1332 | |
… | |
… | |
1419 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1475 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1420 | it can be seen via the I<who(1)> command, and can accept messages. To |
1476 | it can be seen via the I<who(1)> command, and can accept messages. To |
1421 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1477 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1422 | on some systems or setgid to root or to some other group on others. |
1478 | on some systems or setgid to root or to some other group on others. |
1423 | |
1479 | |
1424 | =head1 COLORS AND GRAPHICS |
1480 | =head1 COLOURS AND GRAPHICS |
1425 | |
1481 | |
1426 | In addition to the default foreground and background colours, |
1482 | In addition to the default foreground and background colours, |
1427 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1483 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1428 | high-intensity bold/blink versions of the same). Here is a list of the |
1484 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1429 | colours with their names. |
1485 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1486 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1487 | |
|
|
1488 | Here is a list of the ANSI colours with their names. |
1430 | |
1489 | |
1431 | =begin table |
1490 | =begin table |
1432 | |
1491 | |
1433 | B<color0> (black) = Black |
1492 | B<color0> (black) = Black |
1434 | B<color1> (red) = Red3 |
1493 | B<color1> (red) = Red3 |
… | |
… | |
1454 | It is also possible to specify the colour values of B<foreground>, |
1513 | It is also possible to specify the colour values of B<foreground>, |
1455 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1514 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1456 | a number 0-15, as a convenient shorthand to reference the colour name of |
1515 | a number 0-15, as a convenient shorthand to reference the colour name of |
1457 | color0-color15. |
1516 | color0-color15. |
1458 | |
1517 | |
1459 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1518 | The following text gives values for the standard 88 colour mode (and |
1460 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1519 | values for the 256 colour mode in parentheses). |
1461 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1462 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1463 | |
1520 | |
|
|
1521 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1522 | |
|
|
1523 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1524 | index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 |
|
|
1525 | |
|
|
1526 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1527 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
|
|
1528 | the RGB cube. |
|
|
1529 | |
1464 | Together, all those colours implement the 88 colour xterm colours. Only |
1530 | Together, all those colours implement the 88 (256) colour xterm |
1465 | the first 16 can be changed using resources currently, the rest can only |
1531 | colours. Only the first 16 can be changed using resources currently, the |
1466 | be changed via command sequences ("escape codes"). |
1532 | rest can only be changed via command sequences ("escape codes"). |
|
|
1533 | |
|
|
1534 | Applications are advised to use terminfo or command sequences to discover |
|
|
1535 | number and RGB values of all colours (yes, you can query this...). |
1467 | |
1536 | |
1468 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1537 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1469 | always swapping the foreground/background colours. This is in contrast to |
1538 | always swapping the foreground/background colours. This is in contrast to |
1470 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1539 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1471 | been specified. For example, |
1540 | been specified. For example, |
1472 | |
1541 | |
1473 | =over 4 |
|
|
1474 | |
|
|
1475 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1542 | @@RXVT_NAME@@ -fg Black -bg White -rv |
1476 | |
1543 | |
1477 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1544 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
1478 | on White. |
1545 | White. |
1479 | |
|
|
1480 | =back |
|
|
1481 | |
1546 | |
1482 | =head2 ALPHA CHANNEL SUPPORT |
1547 | =head2 ALPHA CHANNEL SUPPORT |
1483 | |
1548 | |
1484 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1549 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1485 | their act together, rxvt-unicode will do it's own alpha channel management: |
1550 | their act together, rxvt-unicode will do its own alpha channel management: |
1486 | |
1551 | |
1487 | You can prefix any color with an opaquenes percentage enclosed in |
1552 | You can prefix any colour with an opaqueness percentage enclosed in |
1488 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1553 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1489 | (0-100) that specifies the opacity of the color, where C<0> is completely |
1554 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
1490 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1555 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1491 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1556 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1492 | is the recommended format to specify transparency values, and works with |
1557 | is the recommended format to specify transparency values, and works with |
1493 | all ways to specify a colour. |
1558 | all ways to specify a colour. |
1494 | |
1559 | |
… | |
… | |
1572 | |
1637 | |
1573 | =item B<SHELL> |
1638 | =item B<SHELL> |
1574 | |
1639 | |
1575 | The shell to be used for command execution, defaults to C</bin/sh>. |
1640 | The shell to be used for command execution, defaults to C</bin/sh>. |
1576 | |
1641 | |
1577 | =item B<RXVT_SOCKET> |
1642 | =item B<RXVT_SOCKET> (sic) |
1578 | |
1643 | |
1579 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1644 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1580 | @@RXVT_NAME@@d(1). |
1645 | @@RXVT_NAME@@d(1). |
1581 | |
1646 | |
1582 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1647 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
|
|
1648 | |
|
|
1649 | =item B<RXVT_PERL_LIB> (sic) |
|
|
1650 | |
|
|
1651 | Additional F<:>-separated library search path for perl extensions. Will be |
|
|
1652 | searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library |
|
|
1653 | directory. |
1583 | |
1654 | |
1584 | =item B<HOME> |
1655 | =item B<HOME> |
1585 | |
1656 | |
1586 | Used to locate the default directory for the unix domain socket for |
1657 | Used to locate the default directory for the unix domain socket for |
1587 | daemon communications and to locate various resource files (such as |
1658 | daemon communications and to locate various resource files (such as |
1588 | C<.Xdefaults>) |
1659 | C<.Xdefaults>) |
1589 | |
1660 | |
1590 | =item B<XAPPLRESDIR> |
1661 | =item B<XAPPLRESDIR> |
1591 | |
1662 | |
1592 | Directory where various X resource files are being located. |
1663 | Directory where application-specific X resource files are located. |
1593 | |
1664 | |
1594 | =item B<XENVIRONMENT> |
1665 | =item B<XENVIRONMENT> |
1595 | |
1666 | |
1596 | If set and accessible, gives the name of a X resource file to be loaded by |
1667 | If set and accessible, gives the name of a X resource file to be loaded by |
1597 | @@RXVT_NAME@@. |
1668 | @@RXVT_NAME@@. |
… | |
… | |
1602 | |
1673 | |
1603 | =over 4 |
1674 | =over 4 |
1604 | |
1675 | |
1605 | =item B</usr/lib/X11/rgb.txt> |
1676 | =item B</usr/lib/X11/rgb.txt> |
1606 | |
1677 | |
1607 | Color names. |
1678 | Colour names. |
1608 | |
1679 | |
1609 | =back |
1680 | =back |
1610 | |
1681 | |
1611 | =head1 SEE ALSO |
1682 | =head1 SEE ALSO |
1612 | |
1683 | |
… | |
… | |
1663 | |
1734 | |
1664 | Project Coordinator (Changes 1.0 -) |
1735 | Project Coordinator (Changes 1.0 -) |
1665 | |
1736 | |
1666 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1737 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1667 | |
1738 | |
1668 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
1739 | pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. |
1669 | |
1740 | |
1670 | =back |
1741 | =back |
1671 | |
1742 | |