… | |
… | |
92 | |
92 | |
93 | Print out a message describing available options. |
93 | Print out a message describing available options. |
94 | |
94 | |
95 | =item B<-display> I<displayname> |
95 | =item B<-display> I<displayname> |
96 | |
96 | |
97 | Attempt to open a window on the named X display (B<-d> still |
97 | Attempt to open a window on the named X display (the older form B<-d> |
98 | respected). In the absence of this option, the display specified by the |
98 | is still respected. but deprecated). In the absence of this option, the |
99 | 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<xft>: Attempt to find a visual with the given bit depth; |
104 | resource B<depth>. |
104 | resource B<depth>. |
… | |
… | |
128 | |
128 | |
129 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
129 | Turn on/off illusion of a transparent window 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 |
… | |
… | |
152 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
149 | 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. |
150 | 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, |
151 | 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: |
152 | 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 |
153 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
157 | pure black and pure white colors essentially mean no tinting; resource |
154 | pure black and pure white colours essentially mean no tinting; resource |
158 | I<tintColor>. Example: |
155 | I<tintColor>. Example: |
159 | |
156 | |
160 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
157 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
161 | |
158 | |
162 | =item B<-sh> I<number> |
159 | =item B<-sh> I<number> |
… | |
… | |
168 | =item B<-blt> I<string> |
165 | =item B<-blt> I<string> |
169 | |
166 | |
170 | Specify background blending type. If background pixmap is specified |
167 | Specify background blending type. If background pixmap is specified |
171 | at the same time as transparency - such pixmap will be blended over |
168 | at the same time as transparency - such pixmap will be blended over |
172 | transparency image, using method specified. Supported values are : |
169 | transparency image, using method specified. Supported values are : |
173 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
170 | B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>, |
174 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
171 | 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 |
172 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
176 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
173 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
177 | |
174 | |
178 | =item B<-blr> I<HxV> |
175 | =item B<-blr> I<HxV> |
179 | |
176 | |
180 | Apply Gaussian Blur with the specified radii to the transparent |
177 | Apply Gaussian Blur with the specified radii to the transparent |
181 | background image. If single number is specified - both vertical and |
178 | background image. If single number is specified - both vertical and |
182 | horizontal radii are considered to be the same. Setting one of the |
179 | 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 |
180 | radii to 1 and another to a large number creates interesting effects |
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
181 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>; |
185 | resource I<blurRadius>. |
182 | resource I<blurRadius>. |
186 | |
183 | |
|
|
184 | =item B<-icon> I<file> |
|
|
185 | |
|
|
186 | Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This |
|
|
187 | is used by many window managers, taskbars and pagers to represent the |
|
|
188 | application window; resource I<iconFile>. |
|
|
189 | |
187 | =item B<-bg> I<colour> |
190 | =item B<-bg> I<colour> |
188 | |
191 | |
189 | Window background colour; resource B<background>. |
192 | Window background colour; resource B<background>. |
190 | |
193 | |
191 | =item B<-fg> I<colour> |
194 | =item B<-fg> I<colour> |
192 | |
195 | |
193 | Window foreground colour; resource B<foreground>. |
196 | Window foreground colour; resource B<foreground>. |
194 | |
197 | |
195 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
198 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
196 | |
199 | |
197 | Compile I<afterimage>: Specify image file for the background and also |
200 | Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also |
198 | optionally specify its scaling with a geometry string. Note you may need to |
201 | optionally specify its scaling with a geometry string. Note you may need to |
199 | add quotes to avoid special shell interpretation of the C<;> in the |
202 | add quotes to avoid special shell interpretation of the C<;> in the |
200 | command-line; for more details see resource B<backgroundPixmap>. |
203 | command-line; for more details see resource B<backgroundPixmap>. |
201 | |
204 | |
202 | =item B<-cr> I<colour> |
205 | =item B<-cr> I<colour> |
… | |
… | |
315 | |
318 | |
316 | =item B<-bc>|B<+bc> |
319 | =item B<-bc>|B<+bc> |
317 | |
320 | |
318 | Blink the cursor; resource B<cursorBlink>. |
321 | Blink the cursor; resource B<cursorBlink>. |
319 | |
322 | |
|
|
323 | =item B<-uc>|B<+uc> |
|
|
324 | |
|
|
325 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
326 | |
320 | =item B<-iconic> |
327 | =item B<-iconic> |
321 | |
328 | |
322 | Start iconified, if the window manager supports that option. |
329 | Start iconified, if the window manager supports that option. |
323 | Alternative form is B<-ic>. |
330 | Alternative form is B<-ic>. |
324 | |
331 | |
… | |
… | |
340 | |
347 | |
341 | =item B<-bl> |
348 | =item B<-bl> |
342 | |
349 | |
343 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
350 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
344 | if honoured by the WM, the rxvt-unicode window will not have window |
351 | if honoured by the WM, the rxvt-unicode window will not have window |
345 | decorations; resource B<borderLess>. |
352 | decorations; resource B<borderLess>. If the window manager does not |
|
|
353 | support MWM hints (e.g. kwin), enables override-redirect mode. |
346 | |
354 | |
347 | =item B<-override-redirect> |
355 | =item B<-override-redirect> |
348 | |
356 | |
349 | Compile I<frills>: Sets override-redirect on the window; resource |
357 | Compile I<frills>: Sets override-redirect on the window; resource |
350 | B<override-redirect>. |
358 | B<override-redirect>. |
… | |
… | |
359 | =item B<-lsp> I<number> |
367 | =item B<-lsp> I<number> |
360 | |
368 | |
361 | Compile I<frills>: Lines (pixel height) to insert between each row of |
369 | Compile I<frills>: Lines (pixel height) to insert between each row of |
362 | the display. Useful to work around font rendering problems; resource |
370 | the display. Useful to work around font rendering problems; resource |
363 | B<lineSpace>. |
371 | B<lineSpace>. |
|
|
372 | |
|
|
373 | =item B<-letsp> I<number> |
|
|
374 | |
|
|
375 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
376 | to control overall letter spacing. Negative values will tighten up the |
|
|
377 | letter spacing, positive values will space letters out more. Useful to |
|
|
378 | work around odd font metrics; resource B<letterSpace>. |
364 | |
379 | |
365 | =item B<-tn> I<termname> |
380 | =item B<-tn> I<termname> |
366 | |
381 | |
367 | This option specifies the name of the terminal type to be set in the |
382 | This option specifies the name of the terminal type to be set in the |
368 | B<TERM> environment variable. This terminal type must exist in the |
383 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
454 | |
469 | |
455 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
470 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
456 | will not immediately destroy its window when the program executed within |
471 | will not immediately destroy its window when the program executed within |
457 | it exits. Instead, it will wait till it is being killed or closed by the |
472 | it exits. Instead, it will wait till it is being killed or closed by the |
458 | user; resource B<hold>. |
473 | user; resource B<hold>. |
|
|
474 | |
|
|
475 | =item B<-cd> I<path> |
|
|
476 | |
|
|
477 | Sets the working directory for the shell (or the command specified via |
|
|
478 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
479 | @@RXVT_NAME@@ to start; resource B<chdir>. |
459 | |
480 | |
460 | =item B<-xrm> I<string> |
481 | =item B<-xrm> I<string> |
461 | |
482 | |
462 | Works like the X Toolkit option of the same name, by adding the I<string> |
483 | Works like the X Toolkit option of the same name, by adding the I<string> |
463 | as if it were specified in a resource file. Resource values specified this |
484 | as if it were specified in a resource file. Resource values specified this |
… | |
… | |
572 | =item B<depth:> I<bitdepth> |
593 | =item B<depth:> I<bitdepth> |
573 | |
594 | |
574 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
595 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
575 | option B<-depth>. |
596 | option B<-depth>. |
576 | |
597 | |
|
|
598 | =item B<buffered:> I<boolean> |
|
|
599 | |
|
|
600 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
601 | On some card/driver combination enabling it slightly decreases |
|
|
602 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
603 | should normally be enabled. |
|
|
604 | |
577 | =item B<geometry:> I<geom> |
605 | =item B<geometry:> I<geom> |
578 | |
606 | |
579 | Create the window with the specified X window geometry [default 80x24]; |
607 | Create the window with the specified X window geometry [default 80x24]; |
580 | option B<-geometry>. |
608 | option B<-geometry>. |
581 | |
609 | |
… | |
… | |
594 | Use the specified colour for the colour value I<n>, where 0-7 |
622 | Use the specified colour for the colour value I<n>, where 0-7 |
595 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
623 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
596 | high-intensity (bold = bright foreground, blink = bright background) |
624 | high-intensity (bold = bright foreground, blink = bright background) |
597 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
625 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
598 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
626 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
599 | names used are listed in the B<COLORS AND GRAPHICS> section. |
627 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
600 | |
628 | |
601 | Colours higher than 15 cannot be set using resources (yet), but can be |
629 | Colours higher than 15 cannot be set using resources (yet), but can be |
602 | changed using an escape command (see @@RXVT_NAME@@(7)). |
630 | changed using an escape command (see @@RXVT_NAME@@(7)). |
603 | |
631 | |
604 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
632 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
615 | =item B<colorUL:> I<colour> |
643 | =item B<colorUL:> I<colour> |
616 | |
644 | |
617 | Use the specified colour to display underlined characters when the |
645 | Use the specified colour to display underlined characters when the |
618 | foreground colour is the default. |
646 | foreground colour is the default. |
619 | |
647 | |
620 | =item B<colorRV:> I<colour> |
|
|
621 | |
|
|
622 | Use the specified colour as the background for reverse video characters |
|
|
623 | when OPTION_HC is disabled (--disable-frills). |
|
|
624 | |
|
|
625 | =item B<underlineColor:> I<colour> |
648 | =item B<underlineColor:> I<colour> |
626 | |
649 | |
627 | If set, use the specified colour as the colour for the underline |
650 | If set, use the specified colour as the colour for the underline |
628 | itself. If unset, use the foreground colour. |
651 | itself. If unset, use the foreground colour. |
|
|
652 | |
|
|
653 | =item B<highlightColor:> I<colour> |
|
|
654 | |
|
|
655 | If set, use the specified colour as the background for highlighted |
|
|
656 | characters. If unset, use reverse video. |
|
|
657 | |
|
|
658 | =item B<highlightTextColor:> I<colour> |
|
|
659 | |
|
|
660 | If set and highlightColor is set, use the specified colour as the |
|
|
661 | foreground for highlighted characters. |
629 | |
662 | |
630 | =item B<cursorColor:> I<colour> |
663 | =item B<cursorColor:> I<colour> |
631 | |
664 | |
632 | Use the specified colour for the cursor. The default is to use the |
665 | Use the specified colour for the cursor. The default is to use the |
633 | foreground colour; option B<-cr>. |
666 | foreground colour; option B<-cr>. |
… | |
… | |
640 | |
673 | |
641 | =item B<reverseVideo:> I<boolean> |
674 | =item B<reverseVideo:> I<boolean> |
642 | |
675 | |
643 | B<True>: simulate reverse video by foreground and background colours; |
676 | B<True>: simulate reverse video by foreground and background colours; |
644 | option B<-rv>. B<False>: regular screen colours [default]; option |
677 | option B<-rv>. B<False>: regular screen colours [default]; option |
645 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
678 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
646 | |
679 | |
647 | =item B<jumpScroll:> I<boolean> |
680 | =item B<jumpScroll:> I<boolean> |
648 | |
681 | |
649 | B<True>: specify that jump scrolling should be used. When receiving lots |
682 | B<True>: specify that jump scrolling should be used. When receiving lots |
650 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
683 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
… | |
… | |
671 | Turn on/off illusion of a transparent window background. |
704 | Turn on/off illusion of a transparent window background. |
672 | |
705 | |
673 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
706 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
674 | future versions. |
707 | future versions. |
675 | |
708 | |
676 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
677 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
|
|
678 | |
|
|
679 | =item B<fading:> I<number> |
709 | =item B<fading:> I<number> |
680 | |
710 | |
681 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
711 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
682 | |
712 | |
683 | =item B<fadeColor:> I<colour> |
713 | =item B<fadeColor:> I<colour> |
… | |
… | |
699 | |
729 | |
700 | Specify background blending type; option B<-blt>. |
730 | Specify background blending type; option B<-blt>. |
701 | |
731 | |
702 | =item B<blurRadius:> I<number> |
732 | =item B<blurRadius:> I<number> |
703 | |
733 | |
704 | Apply Gaussian Blurr with the specified radius to the transparent |
734 | Apply gaussian blur with the specified radius to the transparent |
705 | background image; option B<-blr>. |
735 | background image; option B<-blr>. |
|
|
736 | |
|
|
737 | =item B<iconFile:> I<file> |
|
|
738 | |
|
|
739 | Set the application icon pixmap; option B<-icon>. |
706 | |
740 | |
707 | =item B<scrollColor:> I<colour> |
741 | =item B<scrollColor:> I<colour> |
708 | |
742 | |
709 | Use the specified colour for the scrollbar [default #B2B2B2]. |
743 | Use the specified colour for the scrollbar [default #B2B2B2]. |
710 | |
744 | |
… | |
… | |
720 | |
754 | |
721 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
755 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
722 | |
756 | |
723 | Use the specified image file for the background and also |
757 | Use the specified image file for the background and also |
724 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
758 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
725 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
759 | (default C<100x100+50+50>) in which B<"W" / "H"> specify the |
726 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
760 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
727 | centre (percent). A scale of 0 displays the image with tiling. A scale |
761 | centre (percent). A scale of 0 displays the image with tiling. |
728 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
762 | The maximum permitted scale is 1000. |
729 | an integer number of images in that direction. No image will be magnified |
|
|
730 | beyond 10 times its original size. The maximum permitted scale is 1000. |
|
|
731 | Additional operations can be specified after colon B<:op1:op2...>. |
763 | Additional operations can be specified after colon B<:op1:op2...>. |
732 | Supported operations are: |
764 | Supported operations are: |
733 | |
765 | |
734 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
766 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
735 | propscale will scale image keeping proportions |
767 | propscale will scale image keeping proportions |
… | |
… | |
739 | scale will scale image to match window size |
771 | scale will scale image to match window size |
740 | root will tile image as if it was a root window background, auto-adjusting |
772 | root will tile image as if it was a root window background, auto-adjusting |
741 | whenever terminal window moves |
773 | whenever terminal window moves |
742 | |
774 | |
743 | If used in conjunction with B<-tr> option, the specified pixmap will be |
775 | If used in conjunction with B<-tr> option, the specified pixmap will be |
744 | blended over transparency image using either alpha-blending, or any |
776 | blended over transparency image using alpha-blending. If I<afterimage> |
745 | other blending type, specified with B<-blt "type"> option. |
777 | support has been compiled in it is possible to choose other blending |
|
|
778 | types with B<-blt "type"> option. |
746 | |
779 | |
747 | =item B<path:> I<path> |
780 | =item B<path:> I<path> |
748 | |
781 | |
749 | Specify the colon-delimited search path for finding background image files. |
782 | Specify the colon-delimited search path for finding background image files. |
750 | |
783 | |
… | |
… | |
777 | it is named first) and thus defines the character cell grid to be 9 pixels |
810 | it is named first) and thus defines the character cell grid to be 9 pixels |
778 | wide and 15 pixels high. |
811 | wide and 15 pixels high. |
779 | |
812 | |
780 | The second font is just used to add additional unicode characters not in |
813 | The second font is just used to add additional unicode characters not in |
781 | the base font, likewise the third, which is unfortunately non-bold, but |
814 | the base font, likewise the third, which is unfortunately non-bold, but |
782 | the bold version of the font does contain less characters, so this is a |
815 | the bold version of the font does contain fewer characters, so this is a |
783 | useful supplement. |
816 | useful supplement. |
784 | |
817 | |
785 | The third font is an Xft font with aliasing turned off, and the characters |
818 | The third font is an Xft font with aliasing turned off, and the characters |
786 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
819 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
787 | contains other characters, but we are not interested in them. |
820 | contains other characters, but we are not interested in them. |
… | |
… | |
838 | =item B<urgentOnBell:> I<boolean> |
871 | =item B<urgentOnBell:> I<boolean> |
839 | |
872 | |
840 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
873 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
841 | B<False>: do not set the urgency hint [default]. |
874 | B<False>: do not set the urgency hint [default]. |
842 | |
875 | |
|
|
876 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
877 | |
843 | =item B<visualBell:> I<boolean> |
878 | =item B<visualBell:> I<boolean> |
844 | |
879 | |
845 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
880 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
846 | B<False>: no visual bell [default]; option B<+vb>. |
881 | B<False>: no visual bell [default]; option B<+vb>. |
847 | |
882 | |
… | |
… | |
971 | =item B<cursorBlink:> I<boolean> |
1006 | =item B<cursorBlink:> I<boolean> |
972 | |
1007 | |
973 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1008 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
974 | option B<-bc>. |
1009 | option B<-bc>. |
975 | |
1010 | |
|
|
1011 | =item B<cursorUnderline:> I<boolean> |
|
|
1012 | |
|
|
1013 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
1014 | option B<-uc>. |
|
|
1015 | |
976 | =item B<pointerBlank:> I<boolean> |
1016 | =item B<pointerBlank:> I<boolean> |
977 | |
1017 | |
978 | B<True>: blank the pointer when a key is pressed or after a set number |
1018 | B<True>: blank the pointer when a key is pressed or after a set number |
979 | of seconds of inactivity. B<False>: the pointer is always visible |
1019 | of seconds of inactivity. B<False>: the pointer is always visible |
980 | [default]. |
1020 | [default]. |
… | |
… | |
993 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1033 | large number (e.g. C<987654321>) to effectively disable the timeout. |
994 | |
1034 | |
995 | =item B<backspacekey:> I<string> |
1035 | =item B<backspacekey:> I<string> |
996 | |
1036 | |
997 | The string to send when the backspace key is pressed. If set to B<DEC> |
1037 | The string to send when the backspace key is pressed. If set to B<DEC> |
998 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
1038 | or unset it will send B<Delete> (code 127) or, with control, B<Backspace> |
999 | (code 8) - which can be reversed with the appropriate DEC private mode |
1039 | (code 8) - which can be reversed with the appropriate DEC private mode |
1000 | escape sequence. |
1040 | escape sequence. |
1001 | |
1041 | |
1002 | =item B<deletekey:> I<string> |
1042 | =item B<deletekey:> I<string> |
1003 | |
1043 | |
… | |
… | |
1082 | |
1122 | |
1083 | =item B<secondaryScroll:> I<boolean> |
1123 | =item B<secondaryScroll:> I<boolean> |
1084 | |
1124 | |
1085 | Turn on/off secondary screen scroll (default enabled). If this |
1125 | Turn on/off secondary screen scroll (default enabled). If this |
1086 | option is enabled, scrolls on the secondary screen will change the |
1126 | option is enabled, scrolls on the secondary screen will change the |
1087 | scrollback buffer and switching to/from the secondary screen will |
1127 | scrollback buffer and, when secondaryScreen is off, switching |
1088 | instead scroll the screen up. |
1128 | to/from the secondary screen will instead scroll the screen up. |
1089 | |
1129 | |
1090 | =item B<hold>: I<boolean> |
1130 | =item B<hold>: I<boolean> |
1091 | |
1131 | |
1092 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1132 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1093 | will not immediately destroy its window when the program executed within |
1133 | will not immediately destroy its window when the program executed within |
1094 | it exits. Instead, it will wait till it is being killed or closed by the |
1134 | it exits. Instead, it will wait till it is being killed or closed by the |
1095 | user. |
1135 | user. |
|
|
1136 | |
|
|
1137 | =item B<chdir>: I<path> |
|
|
1138 | |
|
|
1139 | Sets the working directory for the shell (or the command specified via |
|
|
1140 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1141 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1142 | directory will be used; option B<-cd>. |
1096 | |
1143 | |
1097 | =item B<keysym.>I<sym>: I<string> |
1144 | =item B<keysym.>I<sym>: I<string> |
1098 | |
1145 | |
1099 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1146 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1100 | intervening resource name B<keysym.> cannot be omitted. |
1147 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
1115 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1162 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1116 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1163 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1117 | performed in an exact manner; however, the closest match is assured. |
1164 | performed in an exact manner; however, the closest match is assured. |
1118 | |
1165 | |
1119 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1166 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1120 | number), see RESOURCES in C<man 7 X> for futher details. |
1167 | number), see RESOURCES in C<man 7 X> for further details. |
1121 | |
1168 | |
1122 | You can define a range of keysyms in one shot by providing a I<string> |
1169 | You can define a range of keysyms in one shot by providing a I<string> |
1123 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1170 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1124 | should be a character not used by the strings. |
1171 | should be a character not used by the strings. |
1125 | |
1172 | |
… | |
… | |
1139 | when Control-Meta-c is being pressed": |
1186 | when Control-Meta-c is being pressed": |
1140 | |
1187 | |
1141 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1188 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1142 | |
1189 | |
1143 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1190 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1144 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1191 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1145 | manpage. For example, the F<selection> extension (activated via |
1192 | manpage. For example, the F<selection> extension (activated via |
1146 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1193 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1147 | |
1194 | |
1148 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1195 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1149 | |
1196 | |
1150 | Due the the large number of modifier combinations, a defined key mapping |
1197 | Due the the large number of modifier combinations, a defined key mapping |
1151 | will match if at I<at least> the specified identifiers are being set, and |
1198 | will match if I<at least> the specified identifiers are being set, and |
1152 | no other key mappings with those and more bits are being defined. That |
1199 | no other key mappings with those and more bits are being defined. That |
1153 | means that defining a key map for C<a> will automatically provide |
1200 | means that defining a key map for C<a> will automatically provide |
1154 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
1201 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
1155 | mappings themselves. |
1202 | mappings themselves. |
1156 | |
1203 | |
… | |
… | |
1207 | all instances, while B<perl-ext> is used for specific instances. |
1254 | all instances, while B<perl-ext> is used for specific instances. |
1208 | |
1255 | |
1209 | =item B<perl-eval>: I<string> |
1256 | =item B<perl-eval>: I<string> |
1210 | |
1257 | |
1211 | Perl code to be evaluated when all extensions have been registered. See |
1258 | Perl code to be evaluated when all extensions have been registered. See |
1212 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1259 | the @@RXVT_NAME@@perl(3) manpage. |
1213 | will be ignored when running setuid/setgid. |
|
|
1214 | |
1260 | |
1215 | =item B<perl-lib>: I<path> |
1261 | =item B<perl-lib>: I<path> |
1216 | |
1262 | |
1217 | Colon-separated list of additional directories that hold extension |
1263 | Colon-separated list of additional directories that hold extension |
1218 | scripts. When looking for extensions specified by the C<perl> resource, |
1264 | scripts. When looking for extensions specified by the C<perl> resource, |
1219 | @@RXVT_NAME@@ will first look in these directories and then in |
1265 | @@RXVT_NAME@@ will first look in these directories and then in |
1220 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1266 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1221 | will be ignored when running setuid/setgid. |
|
|
1222 | |
1267 | |
1223 | See the @@RXVT_NAME@@perl(3) manpage. |
1268 | See the @@RXVT_NAME@@perl(3) manpage. |
1224 | |
1269 | |
1225 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1270 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1226 | |
1271 | |
… | |
… | |
1248 | |
1293 | |
1249 | =item B<override-redirect>: I<boolean> |
1294 | =item B<override-redirect>: I<boolean> |
1250 | |
1295 | |
1251 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1296 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1252 | it almost invisible to window managers; option B<-override-redirect>. |
1297 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1298 | |
|
|
1299 | =item B<iso14755:> I<boolean> |
|
|
1300 | |
|
|
1301 | Turn on/off ISO 14755 (default enabled). |
1253 | |
1302 | |
1254 | =item B<iso14755_52:> I<boolean> |
1303 | =item B<iso14755_52:> I<boolean> |
1255 | |
1304 | |
1256 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1305 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1257 | |
1306 | |
… | |
… | |
1400 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1449 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1401 | it can be seen via the I<who(1)> command, and can accept messages. To |
1450 | it can be seen via the I<who(1)> command, and can accept messages. To |
1402 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1451 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1403 | on some systems or setgid to root or to some other group on others. |
1452 | on some systems or setgid to root or to some other group on others. |
1404 | |
1453 | |
1405 | =head1 COLORS AND GRAPHICS |
1454 | =head1 COLOURS AND GRAPHICS |
1406 | |
1455 | |
1407 | In addition to the default foreground and background colours, |
1456 | In addition to the default foreground and background colours, |
1408 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1457 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1409 | high-intensity bold/blink versions of the same). Here is a list of the |
1458 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1410 | colours with their names. |
1459 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1460 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1461 | |
|
|
1462 | Here is a list of the ANSI colours with their names. |
1411 | |
1463 | |
1412 | =begin table |
1464 | =begin table |
1413 | |
1465 | |
1414 | B<color0> (black) = Black |
1466 | B<color0> (black) = Black |
1415 | B<color1> (red) = Red3 |
1467 | B<color1> (red) = Red3 |
… | |
… | |
1435 | It is also possible to specify the colour values of B<foreground>, |
1487 | It is also possible to specify the colour values of B<foreground>, |
1436 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1488 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1437 | a number 0-15, as a convenient shorthand to reference the colour name of |
1489 | a number 0-15, as a convenient shorthand to reference the colour name of |
1438 | color0-color15. |
1490 | color0-color15. |
1439 | |
1491 | |
1440 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1492 | The following text gives values for the standard 88 colour mode (and |
1441 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1493 | values for the 256 colour mode in parentheses). |
1442 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1443 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1444 | |
1494 | |
|
|
1495 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1496 | |
|
|
1497 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1498 | index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 |
|
|
1499 | |
|
|
1500 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1501 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
|
|
1502 | the RGB cube. |
|
|
1503 | |
1445 | Together, all those colours implement the 88 colour xterm colours. Only |
1504 | Together, all those colours implement the 88 (256) colour xterm |
1446 | the first 16 can be changed using resources currently, the rest can only |
1505 | colours. Only the first 16 can be changed using resources currently, the |
1447 | be changed via command sequences ("escape codes"). |
1506 | rest can only be changed via command sequences ("escape codes"). |
|
|
1507 | |
|
|
1508 | Applications are advised to use terminfo or command sequences to discover |
|
|
1509 | number and RGB values of all colours (yes, you can query this...). |
1448 | |
1510 | |
1449 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1511 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1450 | always swapping the foreground/background colours. This is in contrast to |
1512 | always swapping the foreground/background colours. This is in contrast to |
1451 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1513 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1452 | been specified. For example, |
1514 | been specified. For example, |
1453 | |
1515 | |
1454 | =over 4 |
|
|
1455 | |
|
|
1456 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1516 | @@RXVT_NAME@@ -fg Black -bg White -rv |
1457 | |
1517 | |
1458 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1518 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
1459 | on White. |
1519 | White. |
1460 | |
|
|
1461 | =back |
|
|
1462 | |
1520 | |
1463 | =head2 ALPHA CHANNEL SUPPORT |
1521 | =head2 ALPHA CHANNEL SUPPORT |
1464 | |
1522 | |
1465 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1523 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1466 | their act together, rxvt-unicode will do it's own alpha channel management: |
1524 | their act together, rxvt-unicode will do it's own alpha channel management: |
1467 | |
1525 | |
1468 | You can prefix any color with an opaquenes percentage enclosed in |
1526 | You can prefix any colour with an opaqueness percentage enclosed in |
1469 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1527 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1470 | (0-100) that specifies the opacity of the color, where C<0> is completely |
1528 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
1471 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1529 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1472 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1530 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
1473 | is the recommended format to specify transparency values, and works with |
1531 | is the recommended format to specify transparency values, and works with |
1474 | all ways to specify a colour. |
1532 | all ways to specify a colour. |
1475 | |
1533 | |
… | |
… | |
1546 | C<--with-terminfo=PATH>. |
1604 | C<--with-terminfo=PATH>. |
1547 | |
1605 | |
1548 | =item B<DISPLAY> |
1606 | =item B<DISPLAY> |
1549 | |
1607 | |
1550 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1608 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1551 | display in its child processes. |
1609 | display in its child processes if C<-display> isn't used to override. It |
|
|
1610 | defaults to C<:0> if it doesn't exist. |
1552 | |
1611 | |
1553 | =item B<SHELL> |
1612 | =item B<SHELL> |
1554 | |
1613 | |
1555 | The shell to be used for command execution, defaults to C</bin/sh>. |
1614 | The shell to be used for command execution, defaults to C</bin/sh>. |
1556 | |
1615 | |
… | |
… | |
1582 | |
1641 | |
1583 | =over 4 |
1642 | =over 4 |
1584 | |
1643 | |
1585 | =item B</usr/lib/X11/rgb.txt> |
1644 | =item B</usr/lib/X11/rgb.txt> |
1586 | |
1645 | |
1587 | Color names. |
1646 | Colour names. |
1588 | |
1647 | |
1589 | =back |
1648 | =back |
1590 | |
1649 | |
1591 | =head1 SEE ALSO |
1650 | =head1 SEE ALSO |
1592 | |
1651 | |