… | |
… | |
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 |
|
|
114 | possible visual ids) instead of the default, and also allocate a private |
|
|
115 | colormap. All visual types except for DirectColor are supported. |
|
|
116 | |
111 | =item B<-geometry> I<geom> |
117 | =item B<-geometry> I<geom> |
112 | |
118 | |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
119 | Window geometry (B<-g> still respected); resource B<geometry>. |
114 | |
120 | |
115 | =item B<-rv>|B<+rv> |
121 | =item B<-rv>|B<+rv> |
… | |
… | |
121 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
127 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
122 | |
128 | |
123 | =item B<-ss>|B<+ss> |
129 | =item B<-ss>|B<+ss> |
124 | |
130 | |
125 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
131 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
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 | |
132 | |
137 | =item B<-fade> I<number> |
133 | =item B<-fade> I<number> |
138 | |
134 | |
139 | Fade the text by the given percentage when focus is lost. Small values |
135 | 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 |
136 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
143 | =item B<-fadecolor> I<colour> |
139 | =item B<-fadecolor> I<colour> |
144 | |
140 | |
145 | Fade to this colour when fading is used (see B<-fade>). The default colour |
141 | Fade to this colour when fading is used (see B<-fade>). The default colour |
146 | is opaque black. resource B<fadeColor>. |
142 | is opaque black. resource B<fadeColor>. |
147 | |
143 | |
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> |
144 | =item B<-icon> I<file> |
188 | |
145 | |
189 | Compile I<afterimage>: Use the specified image as application icon. This |
146 | Compile I<pixbuf>: Use the specified image as application icon. This |
190 | is used by many window managers, taskbars and pagers to represent the |
147 | is used by many window managers, taskbars and pagers to represent the |
191 | application window; resource I<iconFile>. |
148 | application window; resource I<iconFile>. |
192 | |
149 | |
193 | =item B<-bg> I<colour> |
150 | =item B<-bg> I<colour> |
194 | |
151 | |
195 | Window background colour; resource B<background>. |
152 | Window background colour; resource B<background>. |
196 | |
153 | |
197 | =item B<-fg> I<colour> |
154 | =item B<-fg> I<colour> |
198 | |
155 | |
199 | Window foreground colour; resource B<foreground>. |
156 | 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 | |
157 | |
208 | =item B<-cr> I<colour> |
158 | =item B<-cr> I<colour> |
209 | |
159 | |
210 | The cursor colour; resource B<cursorColor>. |
160 | The cursor colour; resource B<cursorColor>. |
211 | |
161 | |
… | |
… | |
270 | |
220 | |
271 | =item B<-ls>|B<+ls> |
221 | =item B<-ls>|B<+ls> |
272 | |
222 | |
273 | Start as a login-shell/sub-shell; resource B<loginShell>. |
223 | Start as a login-shell/sub-shell; resource B<loginShell>. |
274 | |
224 | |
|
|
225 | =item B<-mc> I<milliseconds> |
|
|
226 | |
|
|
227 | Specify the maximum time between multi-click selections. |
|
|
228 | |
275 | =item B<-ut>|B<+ut> |
229 | =item B<-ut>|B<+ut> |
276 | |
230 | |
277 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
231 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
278 | B<utmpInhibit>. |
232 | B<utmpInhibit>. |
279 | |
233 | |
… | |
… | |
321 | |
275 | |
322 | =item B<-bc>|B<+bc> |
276 | =item B<-bc>|B<+bc> |
323 | |
277 | |
324 | Blink the cursor; resource B<cursorBlink>. |
278 | Blink the cursor; resource B<cursorBlink>. |
325 | |
279 | |
|
|
280 | =item B<-uc>|B<+uc> |
|
|
281 | |
|
|
282 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
283 | |
326 | =item B<-iconic> |
284 | =item B<-iconic> |
327 | |
285 | |
328 | Start iconified, if the window manager supports that option. |
286 | Start iconified, if the window manager supports that option. |
329 | Alternative form is B<-ic>. |
287 | Alternative form is B<-ic>. |
330 | |
288 | |
… | |
… | |
353 | |
311 | |
354 | =item B<-override-redirect> |
312 | =item B<-override-redirect> |
355 | |
313 | |
356 | Compile I<frills>: Sets override-redirect on the window; resource |
314 | Compile I<frills>: Sets override-redirect on the window; resource |
357 | B<override-redirect>. |
315 | B<override-redirect>. |
|
|
316 | |
|
|
317 | =item B<-dockapp> |
|
|
318 | |
|
|
319 | Sets the initial state of the window to WithdrawnState, which makes |
|
|
320 | window managers that support this extension treat it as a dockapp. |
358 | |
321 | |
359 | =item B<-sbg> |
322 | =item B<-sbg> |
360 | |
323 | |
361 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
324 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
362 | drawing characters and just rely on what the specified fonts provide. Use |
325 | drawing characters and just rely on what the specified fonts provide. Use |
… | |
… | |
567 | You can set and change the resources using X11 tools like B<xrdb>. Many |
530 | You can set and change the resources using X11 tools like B<xrdb>. Many |
568 | distribution do also load settings from the B<~/.Xresources> file when X |
531 | distribution do also load settings from the B<~/.Xresources> file when X |
569 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
532 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
570 | with later settings overwriting earlier ones: |
533 | with later settings overwriting earlier ones: |
571 | |
534 | |
572 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
573 | 2. app-defaults file in $XAPPLRESDIR |
535 | 1. app-defaults file in $XAPPLRESDIR |
|
|
536 | 2. $HOME/.Xdefaults |
574 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
537 | 3. RESOURCE_MANAGER property on root-window of screen 0 |
575 | 4. SCREEN_RESOURCES for the current screen |
538 | 4. SCREEN_RESOURCES property on root-window of the current screen |
576 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
539 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
577 | 6. resources specified via -xrm on the commandline |
540 | 6. resources specified via -xrm on the commandline |
578 | |
541 | |
579 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
542 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
580 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
543 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
… | |
… | |
621 | Use the specified colour for the colour value I<n>, where 0-7 |
584 | Use the specified colour for the colour value I<n>, where 0-7 |
622 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
585 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
623 | high-intensity (bold = bright foreground, blink = bright background) |
586 | high-intensity (bold = bright foreground, blink = bright background) |
624 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
587 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
625 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
588 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
626 | names used are listed in the B<COLORS AND GRAPHICS> section. |
589 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
627 | |
590 | |
628 | Colours higher than 15 cannot be set using resources (yet), but can be |
591 | Colours higher than 15 cannot be set using resources (yet), but can be |
629 | changed using an escape command (see @@RXVT_NAME@@(7)). |
592 | changed using an escape command (see @@RXVT_NAME@@(7)). |
630 | |
593 | |
631 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
594 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
642 | =item B<colorUL:> I<colour> |
605 | =item B<colorUL:> I<colour> |
643 | |
606 | |
644 | Use the specified colour to display underlined characters when the |
607 | Use the specified colour to display underlined characters when the |
645 | foreground colour is the default. |
608 | foreground colour is the default. |
646 | |
609 | |
647 | =item B<colorRV:> I<colour> |
|
|
648 | |
|
|
649 | Use the specified colour as the background for reverse video characters |
|
|
650 | when OPTION_HC is disabled (--disable-frills). |
|
|
651 | |
|
|
652 | =item B<underlineColor:> I<colour> |
610 | =item B<underlineColor:> I<colour> |
653 | |
611 | |
654 | If set, use the specified colour as the colour for the underline |
612 | If set, use the specified colour as the colour for the underline |
655 | itself. If unset, use the foreground colour. |
613 | itself. If unset, use the foreground colour. |
|
|
614 | |
|
|
615 | =item B<highlightColor:> I<colour> |
|
|
616 | |
|
|
617 | If set, use the specified colour as the background for highlighted |
|
|
618 | characters. If unset, use reverse video. |
|
|
619 | |
|
|
620 | =item B<highlightTextColor:> I<colour> |
|
|
621 | |
|
|
622 | If set and highlightColor is set, use the specified colour as the |
|
|
623 | foreground for highlighted characters. |
656 | |
624 | |
657 | =item B<cursorColor:> I<colour> |
625 | =item B<cursorColor:> I<colour> |
658 | |
626 | |
659 | Use the specified colour for the cursor. The default is to use the |
627 | Use the specified colour for the cursor. The default is to use the |
660 | foreground colour; option B<-cr>. |
628 | foreground colour; option B<-cr>. |
… | |
… | |
667 | |
635 | |
668 | =item B<reverseVideo:> I<boolean> |
636 | =item B<reverseVideo:> I<boolean> |
669 | |
637 | |
670 | B<True>: simulate reverse video by foreground and background colours; |
638 | B<True>: simulate reverse video by foreground and background colours; |
671 | option B<-rv>. B<False>: regular screen colours [default]; option |
639 | option B<-rv>. B<False>: regular screen colours [default]; option |
672 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
640 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
673 | |
641 | |
674 | =item B<jumpScroll:> I<boolean> |
642 | =item B<jumpScroll:> I<boolean> |
675 | |
643 | |
676 | B<True>: specify that jump scrolling should be used. When receiving lots |
644 | B<True>: specify that jump scrolling should be used. When receiving lots |
677 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
645 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
… | |
… | |
691 | |
659 | |
692 | B<False>: specify that everything is to be displayed, even |
660 | B<False>: specify that everything is to be displayed, even |
693 | if the refresh is too fast for the human eye to read anything (or the |
661 | if the refresh is too fast for the human eye to read anything (or the |
694 | monitor to display anything); option B<+ss>. |
662 | monitor to display anything); option B<+ss>. |
695 | |
663 | |
696 | =item B<transparent:> I<boolean> |
|
|
697 | |
|
|
698 | Turn on/off illusion of a transparent window background. |
|
|
699 | |
|
|
700 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
|
|
701 | future versions. |
|
|
702 | |
|
|
703 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
704 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
|
|
705 | |
|
|
706 | =item B<fading:> I<number> |
664 | =item B<fading:> I<number> |
707 | |
665 | |
708 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
666 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
709 | |
667 | |
710 | =item B<fadeColor:> I<colour> |
668 | =item B<fadeColor:> I<colour> |
711 | |
669 | |
712 | Fade to this colour, when fading is used (see B<fading:>). The default |
670 | Fade to this colour, when fading is used (see B<fading:>). The default |
713 | colour is black; option B<-fadecolor>. |
671 | colour is black; option B<-fadecolor>. |
714 | |
672 | |
715 | =item B<tintColor:> I<colour> |
|
|
716 | |
|
|
717 | Tint the transparent background pixmap with the given colour; option |
|
|
718 | B<-tint>. |
|
|
719 | |
|
|
720 | =item B<shading:> I<number> |
|
|
721 | |
|
|
722 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
|
|
723 | in addition to tinting it; option B<-sh>. |
|
|
724 | |
|
|
725 | =item B<blendType:> I<string> |
|
|
726 | |
|
|
727 | Specify background blending type; option B<-blt>. |
|
|
728 | |
|
|
729 | =item B<blurRadius:> I<number> |
|
|
730 | |
|
|
731 | Apply gaussian blur with the specified radius to the transparent |
|
|
732 | background image; option B<-blr>. |
|
|
733 | |
|
|
734 | =item B<iconFile:> I<file> |
673 | =item B<iconFile:> I<file> |
735 | |
674 | |
736 | Set the application icon pixmap; option B<-icon>. |
675 | Set the application icon pixmap; option B<-icon>. |
737 | |
676 | |
738 | =item B<scrollColor:> I<colour> |
677 | =item B<scrollColor:> I<colour> |
… | |
… | |
746 | |
685 | |
747 | =item B<borderColor:> I<colour> |
686 | =item B<borderColor:> I<colour> |
748 | |
687 | |
749 | The colour of the border around the text area and between the scrollbar |
688 | The colour of the border around the text area and between the scrollbar |
750 | and the text. |
689 | and the text. |
751 | |
|
|
752 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
|
|
753 | |
|
|
754 | Use the specified image file for the background and also |
|
|
755 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
|
|
756 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
|
|
757 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
|
|
758 | centre (percent). A scale of 0 displays the image with tiling. A scale |
|
|
759 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
|
|
760 | an integer number of images in that direction. No image will be magnified |
|
|
761 | beyond 10 times its original size. The maximum permitted scale is 1000. |
|
|
762 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
763 | Supported operations are: |
|
|
764 | |
|
|
765 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
766 | propscale will scale image keeping proportions |
|
|
767 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
768 | hscale will scale image horizontally to the window size |
|
|
769 | vscale will scale image vertically to the window size |
|
|
770 | scale will scale image to match window size |
|
|
771 | root will tile image as if it was a root window background, auto-adjusting |
|
|
772 | whenever terminal window moves |
|
|
773 | |
|
|
774 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
775 | blended over transparency image using either alpha-blending, or any |
|
|
776 | other blending type, specified with B<-blt "type"> option. |
|
|
777 | |
|
|
778 | =item B<path:> I<path> |
|
|
779 | |
|
|
780 | Specify the colon-delimited search path for finding background image files. |
|
|
781 | |
690 | |
782 | =item B<font:> I<fontlist> |
691 | =item B<font:> I<fontlist> |
783 | |
692 | |
784 | Select the fonts to be used. This is a comma separated list of font names |
693 | Select the fonts to be used. This is a comma separated list of font names |
785 | that are checked in order when trying to find glyphs for characters. The |
694 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
808 | it is named first) and thus defines the character cell grid to be 9 pixels |
717 | it is named first) and thus defines the character cell grid to be 9 pixels |
809 | wide and 15 pixels high. |
718 | wide and 15 pixels high. |
810 | |
719 | |
811 | The second font is just used to add additional unicode characters not in |
720 | The second font is just used to add additional unicode characters not in |
812 | the base font, likewise the third, which is unfortunately non-bold, but |
721 | the base font, likewise the third, which is unfortunately non-bold, but |
813 | the bold version of the font does contain less characters, so this is a |
722 | the bold version of the font does contain fewer characters, so this is a |
814 | useful supplement. |
723 | useful supplement. |
815 | |
724 | |
816 | The third font is an Xft font with aliasing turned off, and the characters |
725 | The third font is an Xft font with aliasing turned off, and the characters |
817 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
726 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
818 | contains other characters, but we are not interested in them. |
727 | contains other characters, but we are not interested in them. |
… | |
… | |
882 | |
791 | |
883 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
792 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
884 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
793 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
885 | [default]; option B<+ls>. |
794 | [default]; option B<+ls>. |
886 | |
795 | |
|
|
796 | =item B<multiClickTime:> I<number> |
|
|
797 | |
|
|
798 | Specify the maximum time in milliseconds between multi-click select |
|
|
799 | events. The default is 500 milliseconds; option B<-mc>. |
|
|
800 | |
887 | =item B<utmpInhibit:> I<boolean> |
801 | =item B<utmpInhibit:> I<boolean> |
888 | |
802 | |
889 | B<True>: inhibit writing record into the system log file B<utmp>; |
803 | B<True>: inhibit writing record into the system log file B<utmp>; |
890 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
804 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
891 | [default]; option B<+ut>. |
805 | [default]; option B<+ut>. |
… | |
… | |
908 | =item B<scrollstyle:> I<mode> |
822 | =item B<scrollstyle:> I<mode> |
909 | |
823 | |
910 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
824 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
911 | the author's favourite. |
825 | the author's favourite. |
912 | |
826 | |
|
|
827 | =item B<thickness:> I<number> |
|
|
828 | |
|
|
829 | Set the scrollbar width in pixels. |
|
|
830 | |
913 | =item B<scrollBar:> I<boolean> |
831 | =item B<scrollBar:> I<boolean> |
914 | |
832 | |
915 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
833 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
916 | disable the scrollbar; option B<+sb>. |
834 | disable the scrollbar; option B<+sb>. |
917 | |
835 | |
… | |
… | |
936 | B<False>: do not scroll to bottom when tty receives output; option |
854 | B<False>: do not scroll to bottom when tty receives output; option |
937 | B<+si>. |
855 | B<+si>. |
938 | |
856 | |
939 | =item B<scrollWithBuffer:> I<boolean> |
857 | =item B<scrollWithBuffer:> I<boolean> |
940 | |
858 | |
941 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
859 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
942 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
860 | try to show the same lines) and B<scrollTtyOutput> is False; option |
943 | with scrollback buffer when tty receives new lines; option B<+sw>. |
861 | B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives |
|
|
862 | new lines; option B<+sw>. |
944 | |
863 | |
945 | =item B<scrollTtyKeypress:> I<boolean> |
864 | =item B<scrollTtyKeypress:> I<boolean> |
946 | |
865 | |
947 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
866 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
948 | are those which are intercepted by rxvt-unicode for special handling and |
867 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
1004 | =item B<cursorBlink:> I<boolean> |
923 | =item B<cursorBlink:> I<boolean> |
1005 | |
924 | |
1006 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
925 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1007 | option B<-bc>. |
926 | option B<-bc>. |
1008 | |
927 | |
|
|
928 | =item B<cursorUnderline:> I<boolean> |
|
|
929 | |
|
|
930 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
931 | option B<-uc>. |
|
|
932 | |
1009 | =item B<pointerBlank:> I<boolean> |
933 | =item B<pointerBlank:> I<boolean> |
1010 | |
934 | |
1011 | B<True>: blank the pointer when a key is pressed or after a set number |
935 | B<True>: blank the pointer when a key is pressed or after a set number |
1012 | of seconds of inactivity. B<False>: the pointer is always visible |
936 | of seconds of inactivity. B<False>: the pointer is always visible |
1013 | [default]. |
937 | [default]. |
… | |
… | |
1026 | large number (e.g. C<987654321>) to effectively disable the timeout. |
950 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1027 | |
951 | |
1028 | =item B<backspacekey:> I<string> |
952 | =item B<backspacekey:> I<string> |
1029 | |
953 | |
1030 | The string to send when the backspace key is pressed. If set to B<DEC> |
954 | The string to send when the backspace key is pressed. If set to B<DEC> |
1031 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
955 | or unset it will send B<Delete> (code 127) or, with control, B<Backspace> |
1032 | (code 8) - which can be reversed with the appropriate DEC private mode |
956 | (code 8) - which can be reversed with the appropriate DEC private mode |
1033 | escape sequence. |
957 | escape sequence. |
1034 | |
958 | |
1035 | =item B<deletekey:> I<string> |
959 | =item B<deletekey:> I<string> |
1036 | |
960 | |
… | |
… | |
1132 | Sets the working directory for the shell (or the command specified via |
1056 | Sets the working directory for the shell (or the command specified via |
1133 | B<-e>). The I<path> must be an absolute path and it must exist for |
1057 | B<-e>). The I<path> must be an absolute path and it must exist for |
1134 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
1058 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
1135 | directory will be used; option B<-cd>. |
1059 | directory will be used; option B<-cd>. |
1136 | |
1060 | |
1137 | =item B<keysym.>I<sym>: I<string> |
1061 | =item B<keysym.>I<sym>: I<action> |
1138 | |
1062 | |
1139 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1063 | Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening |
1140 | intervening resource name B<keysym.> cannot be omitted. |
1064 | resource name B<keysym.> cannot be omitted. |
1141 | |
1065 | |
1142 | The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be |
1066 | Using this resource, you can map key combinations such as |
1143 | any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, |
1067 | C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different |
1144 | B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, |
1068 | string than would normally result from that combination, making the |
1145 | and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
1069 | terminal scroll up or down the way you want it, or any other thing an |
1146 | B<2>, B<3>, B<4>, B<5>. |
1070 | extension might provide. |
|
|
1071 | |
|
|
1072 | The key combination that triggers the action, I<sym>, has the following format: |
|
|
1073 | |
|
|
1074 | (modifiers-)key |
|
|
1075 | |
|
|
1076 | Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, |
|
|
1077 | B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, |
|
|
1078 | B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, |
|
|
1079 | B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. |
1147 | |
1080 | |
1148 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1081 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1149 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1082 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1150 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1083 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1151 | current application keymap mode state. |
1084 | current application keymap mode state. |
1152 | |
1085 | |
1153 | The spellings of I<key> can be obtained by using B<xev>(1) command or |
1086 | Due the the large number of modifier combinations, a key mapping will |
1154 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1087 | match if I<at least> the specified identifiers are being set, and no other |
|
|
1088 | key mappings with those and more bits are being defined. That means that |
|
|
1089 | defining a mapping for C<a> will automatically provide definitions for |
|
|
1090 | C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings |
|
|
1091 | themselves. See the C<builtin:> action, below, for a way to work around |
|
|
1092 | this when this is a problem. |
|
|
1093 | |
|
|
1094 | The spelling of I<key> depends on your implementation of X. An easy way to |
|
|
1095 | find a key name is to use the B<xev>(1) command. You can find a list by |
|
|
1096 | looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit |
1155 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1097 | the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym |
1156 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1098 | value (B<0x0000 - 0xFFFF>). |
1157 | performed in an exact manner; however, the closest match is assured. |
|
|
1158 | |
1099 | |
1159 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1100 | As with any resource value, the I<action> string may contain backslash |
|
|
1101 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1160 | number), see RESOURCES in C<man 7 X> for futher details. |
1102 | number), see RESOURCES in C<man 7 X> for further details. |
1161 | |
1103 | |
1162 | You can define a range of keysyms in one shot by providing a I<string> |
1104 | An action starts with an action prefix that selects a certain type |
1163 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1105 | of action, followed by a colon. An action string without colons is |
|
|
1106 | interpreted as a literal string to pass to the tty (as if it was |
|
|
1107 | prefixed with C<string:>). |
|
|
1108 | |
|
|
1109 | The following action prefixes are known - extensions can provide |
|
|
1110 | additional prefixes: |
|
|
1111 | |
|
|
1112 | =over 4 |
|
|
1113 | |
|
|
1114 | =item string:STRING |
|
|
1115 | |
|
|
1116 | If the I<action> starts with C<string:> (or otherwise contains no colons), |
|
|
1117 | then the remaining C<STRING> will be passed to the program running in the |
|
|
1118 | terminal. For example, you could replace whatever Shift-Tab outputs by the |
|
|
1119 | string C<echo rm -rf /> followed by a newline: |
|
|
1120 | |
|
|
1121 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
|
|
1122 | |
|
|
1123 | This could in theory be used to completely redefine your keymap. |
|
|
1124 | |
|
|
1125 | In addition, for actions of this type, you can define a range of |
|
|
1126 | keysyms in one shot by loading the C<keysym-list> perl extension and |
|
|
1127 | providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where |
1164 | should be a character not used by the strings. |
1128 | the delimiter `/' should be a character not used by the strings. |
1165 | |
1129 | |
1166 | Its usage can be demonstrated by an example: |
1130 | Its usage can be demonstrated by an example: |
1167 | |
1131 | |
1168 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1132 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
1169 | |
1133 | |
1170 | The above line is equivalent to the following three lines: |
1134 | The above line is equivalent to the following three lines: |
1171 | |
1135 | |
1172 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1136 | URxvt.keysym.Meta-Control-0x61: string:\033<a> |
1173 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1137 | URxvt.keysym.Meta-Control-0x62: string:\033<b> |
1174 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1138 | URxvt.keysym.Meta-Control-0x63: string:\033<c> |
1175 | |
1139 | |
|
|
1140 | =item command:STRING |
|
|
1141 | |
1176 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1142 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1177 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1143 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
|
|
1144 | the opposite of C<string:> - instead of sending it to the program running |
|
|
1145 | in the terminal, it will be treated as if it were program output). This is |
|
|
1146 | most useful to feed command sequences into @@RXVT_NAME@@. |
|
|
1147 | |
1178 | example the following means "change the current locale to C<zh_CN.GBK> |
1148 | For example the following means "change the current locale to C<zh_CN.GBK> |
1179 | when Control-Meta-c is being pressed": |
1149 | when Control-Meta-c is being pressed": |
1180 | |
1150 | |
1181 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1151 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1182 | |
1152 | |
1183 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1153 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1184 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1154 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1185 | manpage. For example, the F<selection> extension (activated via |
1155 | font-switching at runtime: |
1186 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1187 | |
1156 | |
1188 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1157 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
|
|
1158 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1189 | |
1159 | |
1190 | Due the the large number of modifier combinations, a defined key mapping |
1160 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1191 | will match if at I<at least> the specified identifiers are being set, and |
1161 | info): |
1192 | no other key mappings with those and more bits are being defined. That |
|
|
1193 | means that defining a key map for C<a> will automatically provide |
|
|
1194 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
1195 | mappings themselves. |
|
|
1196 | |
1162 | |
1197 | Unfortunately, this will override built-in key mappings. For example |
1163 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
1164 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1165 | |
|
|
1166 | =item builtin: |
|
|
1167 | |
|
|
1168 | The builtin action is the action that @@RXVT_NAME@@ would execute if no |
|
|
1169 | key binding existed for the key combination. The obvious use is to undo |
|
|
1170 | the effect of existing bindings. The not so obvious use is to reinstate |
|
|
1171 | bindings when another binding overrides too many modifiers. |
|
|
1172 | |
1198 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
1173 | For example if you overwrite the C<Insert> key you will disable |
1199 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
1174 | @@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke |
1200 | user-defined keymap using the C<builtin:> replacement: |
1175 | "holes" into the user-defined keymap using the C<builtin:> replacement: |
1201 | |
1176 | |
1202 | URxvt.keysym.Insert: <my insert key sequence> |
1177 | URxvt.keysym.Insert: <my insert key sequence> |
1203 | URxvt.keysym.S-Insert: builtin: |
1178 | URxvt.keysym.S-Insert: builtin: |
1204 | |
1179 | |
1205 | The first line defines a mapping for C<Insert> and I<any> combination |
1180 | The first line defines a mapping for C<Insert> and I<any> combination |
1206 | of modifiers. The second line re-establishes the default mapping for |
1181 | of modifiers. The second line re-establishes the default mapping for |
1207 | C<Shift-Insert>. |
1182 | C<Shift-Insert>. |
1208 | |
1183 | |
1209 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1184 | =item builtin-string: |
1210 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
|
|
1211 | font-switching at runtime: |
|
|
1212 | |
1185 | |
1213 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1186 | This action is mainly useful to restore string mappings for keys that |
1214 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1187 | have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit |
|
|
1188 | difficult to explain - basically, this action will send the string to the |
|
|
1189 | application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in |
|
|
1190 | action for it. |
1215 | |
1191 | |
1216 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1192 | An example might make it clearer: @@RXVT_NAME@@ normally pastes the |
1217 | info): |
1193 | selection when you press C<Shift-Insert>. With the following bindings, it |
|
|
1194 | would instead emit the (undocumented, but what applications running in the |
|
|
1195 | terminal might expect) sequence C<ESC [ 2 $> instead: |
1218 | |
1196 | |
1219 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1197 | URxvt.keysym.S-Insert: builtin-string: |
1220 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1198 | URxvt.keysym.C-S-Insert: builtin: |
|
|
1199 | |
|
|
1200 | The first line disables the paste functionality for that key |
|
|
1201 | combination, and the second reinstates the default behaviour for |
|
|
1202 | C<Control-Shift-Insert>, which would otherwise be overridden. |
|
|
1203 | |
|
|
1204 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
|
|
1205 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
|
|
1206 | this: |
|
|
1207 | |
|
|
1208 | URxvt.keysym.C-M-c: builtin-string: |
|
|
1209 | URxvt.keysym.C-M-v: builtin-string: |
|
|
1210 | |
|
|
1211 | =item EXTENSION:STRING |
|
|
1212 | |
|
|
1213 | An action of this form invokes the action B<STRING>, if any, provided |
|
|
1214 | by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will |
|
|
1215 | be loaded automatically if necessary. |
|
|
1216 | |
|
|
1217 | Not all extensions define actions, but popular extensions that do |
|
|
1218 | include the I<selection> and I<matcher> extensions (documented in their |
|
|
1219 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
|
|
1220 | respectively). |
|
|
1221 | |
|
|
1222 | From the silly examples department, this will rot13-"encrypt" |
|
|
1223 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
|
|
1224 | keyboards: |
|
|
1225 | |
|
|
1226 | URxvt.keysym.M-C-c: selection:rot13 |
|
|
1227 | |
|
|
1228 | =item perl:STRING *DEPRECATED* |
|
|
1229 | |
|
|
1230 | This is a deprecated way of invoking commands provided by perl |
|
|
1231 | extensions. It is still supported, but should not be used anymore. |
|
|
1232 | |
|
|
1233 | =back |
1221 | |
1234 | |
1222 | =item B<perl-ext-common>: I<string> |
1235 | =item B<perl-ext-common>: I<string> |
1223 | |
1236 | |
1224 | =item B<perl-ext>: I<string> |
1237 | =item B<perl-ext>: I<string> |
1225 | |
1238 | |
… | |
… | |
1227 | use in this terminal instance; option B<-pe>. |
1240 | use in this terminal instance; option B<-pe>. |
1228 | |
1241 | |
1229 | Extension names can be prefixed with a C<-> sign to prohibit using |
1242 | Extension names can be prefixed with a C<-> sign to prohibit using |
1230 | them. This can be useful to selectively disable some extensions loaded |
1243 | them. This can be useful to selectively disable some extensions loaded |
1231 | by default, or specified via the C<perl-ext-common> resource. For |
1244 | by default, or specified via the C<perl-ext-common> resource. For |
1232 | example, C<default,-selection> will use all the default extension except |
1245 | example, C<default,-selection> will use all the default extensions except |
1233 | C<selection>. |
1246 | C<selection>. |
1234 | |
1247 | |
1235 | Extension names can also be followed by an argument in angle brackets |
1248 | The default set includes the C<selection>, C<option-popup>, |
1236 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1249 | C<selection-popup>, C<readline> and C<searchable-scrollback> |
1237 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1250 | extensions, and extensions which are mentioned in B<keysym> resources. |
1238 | multiple times with different arguments will pass multiple arguments to |
1251 | |
1239 | the extension. |
1252 | Any extension such that a corresponding resource is given on the |
|
|
1253 | command line is automatically appended to B<perl-ext>. |
1240 | |
1254 | |
1241 | Each extension is looked up in the library directories, loaded if |
1255 | Each extension is looked up in the library directories, loaded if |
1242 | necessary, and bound to the current terminal instance. |
1256 | necessary, and bound to the current terminal instance. When the library |
|
|
1257 | search path contains multiple extension files of the same name, then the |
|
|
1258 | first one found will be used. |
1243 | |
1259 | |
1244 | If both of these resources are the empty string, then the perl |
1260 | If both of these resources are the empty string, then the perl interpreter |
1245 | interpreter will not be initialized. The idea behind two options is that |
1261 | will not be initialized. The rationale for having two options is that |
1246 | B<perl-ext-common> will be used for extensions that should be available to |
1262 | B<perl-ext-common> will be used for extensions that should be available to |
1247 | all instances, while B<perl-ext> is used for specific instances. |
1263 | all instances, while B<perl-ext> is used for specific instances. |
1248 | |
1264 | |
1249 | =item B<perl-eval>: I<string> |
1265 | =item B<perl-eval>: I<string> |
1250 | |
1266 | |
… | |
… | |
1252 | the @@RXVT_NAME@@perl(3) manpage. |
1268 | the @@RXVT_NAME@@perl(3) manpage. |
1253 | |
1269 | |
1254 | =item B<perl-lib>: I<path> |
1270 | =item B<perl-lib>: I<path> |
1255 | |
1271 | |
1256 | Colon-separated list of additional directories that hold extension |
1272 | Colon-separated list of additional directories that hold extension |
1257 | scripts. When looking for extensions specified by the C<perl> resource, |
1273 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look |
1258 | @@RXVT_NAME@@ will first look in these directories and then in |
1274 | in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and |
1259 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1275 | lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1260 | |
1276 | |
1261 | See the @@RXVT_NAME@@perl(3) manpage. |
1277 | See the @@RXVT_NAME@@perl(3) manpage. |
1262 | |
1278 | |
1263 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1279 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1264 | |
1280 | |
… | |
… | |
1268 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1284 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1269 | |
1285 | |
1270 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1286 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1271 | for details. |
1287 | for details. |
1272 | |
1288 | |
1273 | =item B<searchable-scrollback:> I<keysym> |
1289 | =item B<searchable-scrollback:> I<keysym> *DEPRECATED* |
1274 | |
1290 | |
1275 | Sets the hotkey that starts the incremental scrollback buffer search |
1291 | This resource is deprecated and will be removed. Use a B<keysym> resource |
1276 | (default: C<M-s>). |
1292 | instead, e.g.: |
1277 | |
1293 | |
|
|
1294 | URxvt.keysym.M-s: searchable-scrollback:start |
|
|
1295 | |
1278 | =item B<urlLauncher>: I<string> |
1296 | =item B<url-launcher>: I<string> |
1279 | |
1297 | |
1280 | Specifies the program to be started with a URL argument. Used by the |
1298 | Specifies the program to be started with a URL argument. Used by the |
1281 | C<selection-popup> and C<matcher> perl extensions. |
1299 | C<selection-popup> and C<matcher> perl extensions. |
1282 | |
1300 | |
1283 | =item B<transient-for>: I<windowid> |
1301 | =item B<transient-for>: I<windowid> |
… | |
… | |
1287 | =item B<override-redirect>: I<boolean> |
1305 | =item B<override-redirect>: I<boolean> |
1288 | |
1306 | |
1289 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1307 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1290 | it almost invisible to window managers; option B<-override-redirect>. |
1308 | it almost invisible to window managers; option B<-override-redirect>. |
1291 | |
1309 | |
|
|
1310 | =item B<iso14755:> I<boolean> |
|
|
1311 | |
|
|
1312 | Turn on/off ISO 14755 (default enabled). |
|
|
1313 | |
1292 | =item B<iso14755_52:> I<boolean> |
1314 | =item B<iso14755_52:> I<boolean> |
1293 | |
1315 | |
1294 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1316 | Turn on/off ISO 14755 5.2 mode (default enabled). |
|
|
1317 | |
|
|
1318 | =back |
|
|
1319 | |
|
|
1320 | =head1 BACKGROUND IMAGE OPTIONS AND RESOURCES |
|
|
1321 | |
|
|
1322 | =over 4 |
|
|
1323 | |
|
|
1324 | =item B<-pixmap> I<file[;oplist]> |
|
|
1325 | |
|
|
1326 | =item B<backgroundPixmap:> I<file[;oplist]> |
|
|
1327 | |
|
|
1328 | Compile I<pixbuf>: Use the specified image file as the window's |
|
|
1329 | background and also optionally specify a colon separated list of |
|
|
1330 | operations to modify it. Note that you may need to quote the C<;> |
|
|
1331 | character when using the command line option, as C<;> is usually a |
|
|
1332 | metacharacter in shells. Supported operations are: |
|
|
1333 | |
|
|
1334 | =over 4 |
|
|
1335 | |
|
|
1336 | =item B<WxH+X+Y> |
|
|
1337 | |
|
|
1338 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
|
|
1339 | scale (percent), and B<"X" / "Y"> locate the image centre (percent). A |
|
|
1340 | scale of 0 disables scaling. |
|
|
1341 | |
|
|
1342 | =item B<op=tile> |
|
|
1343 | |
|
|
1344 | enables tiling |
|
|
1345 | |
|
|
1346 | =item B<op=keep-aspect> |
|
|
1347 | |
|
|
1348 | maintain the image aspect ratio when scaling |
|
|
1349 | |
|
|
1350 | =item B<op=root-align> |
|
|
1351 | |
|
|
1352 | use the position of the terminal window relative to the root window as |
|
|
1353 | the image offset, simulating a root window background |
|
|
1354 | |
|
|
1355 | =back |
|
|
1356 | |
|
|
1357 | The default scale and position setting is C<100x100+50+50>. |
|
|
1358 | Alternatively, a predefined set of templates can be used to achieve |
|
|
1359 | the most common setups: |
|
|
1360 | |
|
|
1361 | =over 4 |
|
|
1362 | |
|
|
1363 | =item B<style=tiled> |
|
|
1364 | |
|
|
1365 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
1366 | |
|
|
1367 | =item B<style=aspect-stretched> |
|
|
1368 | |
|
|
1369 | the image is scaled to fill the whole window maintaining the aspect |
|
|
1370 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
1371 | |
|
|
1372 | =item B<style=stretched> |
|
|
1373 | |
|
|
1374 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
1375 | |
|
|
1376 | =item B<style=centered> |
|
|
1377 | |
|
|
1378 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
1379 | |
|
|
1380 | =item B<style=root-tiled> |
|
|
1381 | |
|
|
1382 | the image is tiled with no scaling and using 'root' positioning. |
|
|
1383 | Equivalent to 0x0:op=tile:op=root-align |
|
|
1384 | |
|
|
1385 | =back |
|
|
1386 | |
|
|
1387 | If multiple templates are specified the last one wins. Note that a |
|
|
1388 | template overrides all the scale, position and operations settings. |
|
|
1389 | |
|
|
1390 | If used in conjunction with pseudo-transparency, the specified pixmap |
|
|
1391 | will be blended over the transparent background using alpha-blending. |
|
|
1392 | |
|
|
1393 | =item B<-tr>|B<+tr> |
|
|
1394 | |
|
|
1395 | =item B<transparent:> I<boolean> |
|
|
1396 | |
|
|
1397 | Turn on/off pseudo-transparency by using the root pixmap as background. |
|
|
1398 | |
|
|
1399 | B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but |
|
|
1400 | will be removed in future versions. |
|
|
1401 | |
|
|
1402 | =item B<-tint> I<colour> |
|
|
1403 | |
|
|
1404 | =item B<tintColor:> I<colour> |
|
|
1405 | |
|
|
1406 | Tint the transparent background with the given colour. Note that a |
|
|
1407 | black tint yields a completely black image while a white tint yields |
|
|
1408 | the image unchanged. |
|
|
1409 | |
|
|
1410 | =item B<-sh> I<number> |
|
|
1411 | |
|
|
1412 | =item B<shading:> I<number> |
|
|
1413 | |
|
|
1414 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
|
|
1415 | A value of 100 means no shading. |
|
|
1416 | |
|
|
1417 | =item B<-blr> I<HxV> |
|
|
1418 | |
|
|
1419 | =item B<blurRadius:> I<HxV> |
|
|
1420 | |
|
|
1421 | Apply gaussian blur with the specified radius to the transparent |
|
|
1422 | background. If a single number is specified, the vertical and |
|
|
1423 | horizontal radii are considered to be the same. Setting one of the |
|
|
1424 | radii to 1 and the other to a large number creates interesting effects |
|
|
1425 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
1426 | vertical radius of 0 disables blurring. |
|
|
1427 | |
|
|
1428 | =item B<path:> I<path> |
|
|
1429 | |
|
|
1430 | Specify the colon-delimited search path for finding background image files. |
1295 | |
1431 | |
1296 | =back |
1432 | =back |
1297 | |
1433 | |
1298 | =head1 THE SCROLLBAR |
1434 | =head1 THE SCROLLBAR |
1299 | |
1435 | |
… | |
… | |
1347 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1483 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1348 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1484 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1349 | |
1485 | |
1350 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1486 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1351 | inserted too. |
1487 | inserted too. |
|
|
1488 | |
|
|
1489 | rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and |
|
|
1490 | <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first |
|
|
1491 | binding causes the value of the internal selection to be copied to the |
|
|
1492 | CLIPBOARD selection, while the second binding causes the value of the |
|
|
1493 | CLIPBOARD selection to be inserted. |
1352 | |
1494 | |
1353 | =back |
1495 | =back |
1354 | |
1496 | |
1355 | =head1 CHANGING FONTS |
1497 | =head1 CHANGING FONTS |
1356 | |
1498 | |
… | |
… | |
1438 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1580 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1439 | it can be seen via the I<who(1)> command, and can accept messages. To |
1581 | it can be seen via the I<who(1)> command, and can accept messages. To |
1440 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1582 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1441 | on some systems or setgid to root or to some other group on others. |
1583 | on some systems or setgid to root or to some other group on others. |
1442 | |
1584 | |
1443 | =head1 COLORS AND GRAPHICS |
1585 | =head1 COLOURS AND GRAPHICS |
1444 | |
1586 | |
1445 | In addition to the default foreground and background colours, |
1587 | In addition to the default foreground and background colours, |
1446 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1588 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1447 | high-intensity bold/blink versions of the same). Here is a list of the |
1589 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1448 | colours with their names. |
1590 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1591 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1592 | |
|
|
1593 | Here is a list of the ANSI colours with their names. |
1449 | |
1594 | |
1450 | =begin table |
1595 | =begin table |
1451 | |
1596 | |
1452 | B<color0> (black) = Black |
1597 | B<color0> (black) = Black |
1453 | B<color1> (red) = Red3 |
1598 | B<color1> (red) = Red3 |
… | |
… | |
1473 | It is also possible to specify the colour values of B<foreground>, |
1618 | It is also possible to specify the colour values of B<foreground>, |
1474 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1619 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1475 | a number 0-15, as a convenient shorthand to reference the colour name of |
1620 | a number 0-15, as a convenient shorthand to reference the colour name of |
1476 | color0-color15. |
1621 | color0-color15. |
1477 | |
1622 | |
1478 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1623 | The following text gives values for the standard 88 colour mode (and |
1479 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1624 | values for the 256 colour mode in parentheses). |
1480 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1481 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1482 | |
1625 | |
|
|
1626 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1627 | |
|
|
1628 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1629 | index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5 |
|
|
1630 | |
|
|
1631 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1632 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
|
|
1633 | the RGB cube. |
|
|
1634 | |
1483 | Together, all those colours implement the 88 colour xterm colours. Only |
1635 | Together, all those colours implement the 88 (256) colour xterm |
1484 | the first 16 can be changed using resources currently, the rest can only |
1636 | colours. Only the first 16 can be changed using resources currently, the |
1485 | be changed via command sequences ("escape codes"). |
1637 | rest can only be changed via command sequences ("escape codes"). |
|
|
1638 | |
|
|
1639 | Applications are advised to use terminfo or command sequences to discover |
|
|
1640 | number and RGB values of all colours (yes, you can query this...). |
1486 | |
1641 | |
1487 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1642 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1488 | always swapping the foreground/background colours. This is in contrast to |
1643 | always swapping the foreground/background colours. This is in contrast to |
1489 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1644 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1490 | been specified. For example, |
1645 | been specified. For example, |
1491 | |
1646 | |
1492 | =over 4 |
|
|
1493 | |
|
|
1494 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1647 | @@RXVT_NAME@@ -fg Black -bg White -rv |
1495 | |
1648 | |
1496 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1649 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
1497 | on White. |
1650 | White. |
1498 | |
|
|
1499 | =back |
|
|
1500 | |
1651 | |
1501 | =head2 ALPHA CHANNEL SUPPORT |
1652 | =head2 ALPHA CHANNEL SUPPORT |
1502 | |
1653 | |
1503 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1654 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1504 | their act together, rxvt-unicode will do it's own alpha channel management: |
1655 | their act together, rxvt-unicode will do its own alpha channel management: |
1505 | |
1656 | |
1506 | You can prefix any color with an opaquenes percentage enclosed in |
1657 | You can prefix any colour with an opaqueness percentage enclosed in |
1507 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1658 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1508 | (0-100) that specifies the opacity of the color, where C<0> is completely |
1659 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
1509 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1660 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1510 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1661 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1511 | is the recommended format to specify transparency values, and works with |
1662 | is the recommended format to specify transparency values, and works with |
1512 | all ways to specify a colour. |
1663 | all ways to specify a colour. |
1513 | |
1664 | |
… | |
… | |
1591 | |
1742 | |
1592 | =item B<SHELL> |
1743 | =item B<SHELL> |
1593 | |
1744 | |
1594 | The shell to be used for command execution, defaults to C</bin/sh>. |
1745 | The shell to be used for command execution, defaults to C</bin/sh>. |
1595 | |
1746 | |
1596 | =item B<RXVT_SOCKET> |
1747 | =item B<RXVT_SOCKET> [I<sic>] |
1597 | |
1748 | |
1598 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1749 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1599 | @@RXVT_NAME@@d(1). |
1750 | @@RXVT_NAME@@d(1). |
1600 | |
1751 | |
1601 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1752 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
|
|
1753 | |
|
|
1754 | =item B<URXVT_PERL_LIB> |
|
|
1755 | |
|
|
1756 | Additional F<:>-separated library search path for perl extensions. Will be |
|
|
1757 | searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library |
|
|
1758 | directory. |
|
|
1759 | |
|
|
1760 | =item B<URXVT_PERL_VERBOSITY> |
|
|
1761 | |
|
|
1762 | See L<@@RXVT_NAME@@perl>(3). |
1602 | |
1763 | |
1603 | =item B<HOME> |
1764 | =item B<HOME> |
1604 | |
1765 | |
1605 | Used to locate the default directory for the unix domain socket for |
1766 | Used to locate the default directory for the unix domain socket for |
1606 | daemon communications and to locate various resource files (such as |
1767 | daemon communications and to locate various resource files (such as |
1607 | C<.Xdefaults>) |
1768 | C<.Xdefaults>) |
1608 | |
1769 | |
1609 | =item B<XAPPLRESDIR> |
1770 | =item B<XAPPLRESDIR> |
1610 | |
1771 | |
1611 | Directory where various X resource files are being located. |
1772 | Directory where application-specific X resource files are located. |
1612 | |
1773 | |
1613 | =item B<XENVIRONMENT> |
1774 | =item B<XENVIRONMENT> |
1614 | |
1775 | |
1615 | If set and accessible, gives the name of a X resource file to be loaded by |
1776 | If set and accessible, gives the name of a X resource file to be loaded by |
1616 | @@RXVT_NAME@@. |
1777 | @@RXVT_NAME@@. |
… | |
… | |
1621 | |
1782 | |
1622 | =over 4 |
1783 | =over 4 |
1623 | |
1784 | |
1624 | =item B</usr/lib/X11/rgb.txt> |
1785 | =item B</usr/lib/X11/rgb.txt> |
1625 | |
1786 | |
1626 | Color names. |
1787 | Colour names. |
1627 | |
1788 | |
1628 | =back |
1789 | =back |
1629 | |
1790 | |
1630 | =head1 SEE ALSO |
1791 | =head1 SEE ALSO |
1631 | |
1792 | |
|
|
1793 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), |
1632 | @@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) |
1794 | @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1633 | |
1795 | |
1634 | =head1 CURRENT PROJECT COORDINATOR |
1796 | =head1 CURRENT PROJECT COORDINATOR |
1635 | |
1797 | |
1636 | =over 4 |
1798 | =over 4 |
1637 | |
1799 | |
1638 | =item Project Coordinator |
1800 | =item Project Coordinator |
1639 | |
1801 | |
1640 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1802 | Marc A. Lehmann <rxvt-unicode@schmorp.de>. |
1641 | |
1803 | |
1642 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1804 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1643 | |
1805 | |
1644 | =back |
1806 | =back |
1645 | |
1807 | |
… | |
… | |
1649 | |
1811 | |
1650 | =item John Bovey |
1812 | =item John Bovey |
1651 | |
1813 | |
1652 | University of Kent, 1992, wrote the original Xvt. |
1814 | University of Kent, 1992, wrote the original Xvt. |
1653 | |
1815 | |
1654 | =item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
1816 | =item Rob Nation <nation@rocket.sanders.lockheed.com> |
1655 | |
1817 | |
1656 | very heavily modified Xvt and came up with Rxvt |
1818 | very heavily modified Xvt and came up with Rxvt |
1657 | |
1819 | |
1658 | =item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
1820 | =item Angelo Haritsis <ah@doc.ic.ac.uk> |
1659 | |
1821 | |
1660 | wrote the Greek Keyboard Input (no longer in code) |
1822 | wrote the Greek Keyboard Input (no longer in code) |
1661 | |
1823 | |
1662 | =item mj olesen L<< <olesen@me.QueensU.CA> >> |
1824 | =item mj olesen <olesen@me.QueensU.CA> |
1663 | |
1825 | |
1664 | Wrote the menu system. |
1826 | Wrote the menu system. |
1665 | |
1827 | |
1666 | Project Coordinator (changes.txt 2.11 to 2.21) |
1828 | Project Coordinator (changes.txt 2.11 to 2.21) |
1667 | |
1829 | |
1668 | =item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
1830 | =item Oezguer Kesim <kesim@math.fu-berlin.de> |
1669 | |
1831 | |
1670 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1832 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1671 | |
1833 | |
1672 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1834 | =item Geoff Wing <gcw@pobox.com> |
1673 | |
1835 | |
1674 | Rewrote screen display and text selection routines. |
1836 | Rewrote screen display and text selection routines. |
1675 | |
1837 | |
1676 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1838 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1677 | |
1839 | |
1678 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1840 | =item Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1679 | |
1841 | |
1680 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1842 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1681 | extension, random hacks, numerous bugfixes and extensions. |
1843 | extension, random hacks, numerous bugfixes and extensions. |
1682 | |
1844 | |
1683 | Project Coordinator (Changes 1.0 -) |
1845 | Project Coordinator (Changes 1.0 -) |
1684 | |
1846 | |
1685 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1847 | =item Emanuele Giaquinta <emanuele.giaquinta@gmail.com> |
1686 | |
1848 | |
1687 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
1849 | pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. |
1688 | |
1850 | |
1689 | =back |
1851 | =back |
1690 | |
1852 | |