ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 UTC

… …
98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display 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
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource 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
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
… …
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 127
123=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
124 129
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 131
137=item B<-fade> I<number> 132=item B<-fade> I<number>
138 133
139Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
… …
143=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
144 139
145Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
147 142
148=item B<-tint> I<colour>
149
150Tint the transparent background pixmap with the given colour when
151transparency is enabled with B<-tr>. This only works for
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file> 143=item B<-icon> I<file>
188 144
189Compile I<afterimage>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 147application window; resource I<iconFile>.
192 148
193=item B<-bg> I<colour> 149=item B<-bg> I<colour>
194 150
195Window background colour; resource B<background>. 151Window background colour; resource B<background>.
196 152
197=item B<-fg> I<colour> 153=item B<-fg> I<colour>
198 154
199Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203Compile I<afterimage>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>.
207 156
208=item B<-cr> I<colour> 157=item B<-cr> I<colour>
209 158
210The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
211 160
… …
320on a tab character is displayed as a wide cursor; resource B<pastableTabs>. 269on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
321 270
322=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
323 272
324Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
325 278
326=item B<-iconic> 279=item B<-iconic>
327 280
328Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
329Alternative form is B<-ic>. 282Alternative form is B<-ic>.
… …
567You can set and change the resources using X11 tools like B<xrdb>. Many 520You can set and change the resources using X11 tools like B<xrdb>. Many
568distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
569starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
570with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
571 524
572 1. system-wide app-defaults file, either locale-dependent OR global
573 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
574 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
575 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
576 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
577 6. resources specified via -xrm on the commandline 530 6. resources specified via -xrm on the commandline
578 531
579Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
580names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
621Use the specified colour for the colour value I<n>, where 0-7 574Use the specified colour for the colour value I<n>, where 0-7
622corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
623high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
624colours. The canonical names are as follows: 0=black, 1=red, 2=green, 577colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6253=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5783=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
626names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
627 580
628Colours higher than 15 cannot be set using resources (yet), but can be 581Colours higher than 15 cannot be set using resources (yet), but can be
629changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
630 583
631Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 584Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
642=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
643 596
644Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
645foreground colour is the default. 598foreground colour is the default.
646 599
647=item B<colorRV:> I<colour>
648
649Use the specified colour as the background for reverse video characters
650when OPTION_HC is disabled (--disable-frills).
651
652=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
653 601
654If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
655itself. If unset, use the foreground colour. 603itself. If unset, use the foreground colour.
604
605=item B<highlightColor:> I<colour>
606
607If set, use the specified colour as the background for highlighted
608characters. If unset, use reverse video.
609
610=item B<highlightTextColor:> I<colour>
611
612If set and highlightColor is set, use the specified colour as the
613foreground for highlighted characters.
656 614
657=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
658 616
659Use the specified colour for the cursor. The default is to use the 617Use the specified colour for the cursor. The default is to use the
660foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
… …
667 625
668=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
669 627
670B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
671option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
672B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
673 631
674=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
675 633
676B<True>: specify that jump scrolling should be used. When receiving lots 634B<True>: specify that jump scrolling should be used. When receiving lots
677of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 635of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
691 649
692B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
693if the refresh is too fast for the human eye to read anything (or the 651if the refresh is too fast for the human eye to read anything (or the
694monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
695 653
696=item B<transparent:> I<boolean>
697
698Turn on/off illusion of a transparent window background.
699
700B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
701future versions.
702
703I<Please address all transparency related issues to Sasha Vasko at
704sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
705
706=item B<fading:> I<number> 654=item B<fading:> I<number>
707 655
708Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
709 657
710=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
711 659
712Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
713colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
714 662
715=item B<tintColor:> I<colour>
716
717Tint the transparent background pixmap with the given colour; option
718B<-tint>.
719
720=item B<shading:> I<number>
721
722Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
723in addition to tinting it; option B<-sh>.
724
725=item B<blendType:> I<string>
726
727Specify background blending type; option B<-blt>.
728
729=item B<blurRadius:> I<number>
730
731Apply gaussian blur with the specified radius to the transparent
732background image; option B<-blr>.
733
734=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
735 664
736Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
737 666
738=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
746 675
747=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
748 677
749The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
750and the text. 679and the text.
751
752=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
753
754Use the specified image file for the background and also
755optionally specify its scaling with a geometry string B<WxH+X+Y>,
756(default C<0x0+50+50>) in which B<"W" / "H"> specify the
757horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
758centre (percent). A scale of 0 displays the image with tiling. A scale
759of 1 displays the image without any scaling. A scale of 2 to 9 specifies
760an integer number of images in that direction. No image will be magnified
761beyond 10 times its original size. The maximum permitted scale is 1000.
762Additional operations can be specified after colon B<:op1:op2...>.
763Supported 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
774If used in conjunction with B<-tr> option, the specified pixmap will be
775blended over transparency image using either alpha-blending, or any
776other blending type, specified with B<-blt "type"> option.
777
778=item B<path:> I<path>
779
780Specify the colon-delimited search path for finding background image files.
781 680
782=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
783 682
784Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
785that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
… …
808it is named first) and thus defines the character cell grid to be 9 pixels 707it is named first) and thus defines the character cell grid to be 9 pixels
809wide and 15 pixels high. 708wide and 15 pixels high.
810 709
811The second font is just used to add additional unicode characters not in 710The second font is just used to add additional unicode characters not in
812the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
813the bold version of the font does contain less characters, so this is a 712the bold version of the font does contain fewer characters, so this is a
814useful supplement. 713useful supplement.
815 714
816The third font is an Xft font with aliasing turned off, and the characters 715The third font is an Xft font with aliasing turned off, and the characters
817are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 716are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
818contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
… …
908=item B<scrollstyle:> I<mode> 807=item B<scrollstyle:> I<mode>
909 808
910Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 809Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
911the author's favourite. 810the author's favourite.
912 811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
913=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
914 817
915B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
916disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
917 820
… …
936B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
937B<+si>. 840B<+si>.
938 841
939=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
940 843
941B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
942B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
943with scrollback buffer when tty receives new lines; option B<+sw>. 846B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
847new lines; option B<+sw>.
944 848
945=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
946 850
947B<True>: scroll to bottom when a non-special key is pressed. Special keys 851B<True>: scroll to bottom when a non-special key is pressed. Special keys
948are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
… …
1004=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
1005 909
1006B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 910B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1007option B<-bc>. 911option B<-bc>.
1008 912
913=item B<cursorUnderline:> I<boolean>
914
915B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
916option B<-uc>.
917
1009=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
1010 919
1011B<True>: blank the pointer when a key is pressed or after a set number 920B<True>: blank the pointer when a key is pressed or after a set number
1012of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
1013[default]. 922[default].
… …
1026large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
1027 936
1028=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
1029 938
1030The string to send when the backspace key is pressed. If set to B<DEC> 939The string to send when the backspace key is pressed. If set to B<DEC>
1031or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 940or 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 941(code 8) - which can be reversed with the appropriate DEC private mode
1033escape sequence. 942escape sequence.
1034 943
1035=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
1036 945
… …
1155omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1064omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1156keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1065keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1157performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1158 1067
1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1160number), see RESOURCES in C<man 7 X> for futher details. 1069number), see RESOURCES in C<man 7 X> for further details.
1161 1070
1162You can define a range of keysyms in one shot by providing a I<string> 1071You can define a range of keysyms in one shot by
1072loading the C<keysym-list> perl extension and providing a I<string>
1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1164should be a character not used by the strings. 1074should be a character not used by the strings.
1165 1075
1166Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1167 1077
1168 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1078 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1169 1079
1170The above line is equivalent to the following three lines: 1080The above line is equivalent to the following three lines:
1171 1081
1172 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1082 URxvt.keysym.Meta-Control-0x61: \033<a>
1173 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1083 URxvt.keysym.Meta-Control-0x62: \033<b>
1174 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1084 URxvt.keysym.Meta-Control-0x63: \033<c>
1175 1085
1176If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1086If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1177is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1087is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1178example the following means "change the current locale to C<zh_CN.GBK> 1088example the following means "change the current locale to C<zh_CN.GBK>
1179when Control-Meta-c is being pressed": 1089when Control-Meta-c is being pressed":
1180 1090
1181 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1091 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1182 1092
1183If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1093If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1184is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1094is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1185manpage. For example, the F<selection> extension (activated via 1095manpage. For example, the F<selection> extension (activated via
1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1096C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187 1097
1188 URxvt.keysym.M-C-c: perl:selection:rot13 1098 URxvt.keysym.M-C-c: perl:selection:rot13
1189 1099
1190Due the the large number of modifier combinations, a defined key mapping 1100Due the the large number of modifier combinations, a defined key mapping
1191will match if at I<at least> the specified identifiers are being set, and 1101will match if I<at least> the specified identifiers are being set, and
1192no other key mappings with those and more bits are being defined. That 1102no other key mappings with those and more bits are being defined. That
1193means that defining a key map for C<a> will automatically provide 1103means that defining a key map for C<a> will automatically provide
1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1104definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195mappings themselves. 1105mappings themselves.
1196 1106
… …
1252the @@RXVT_NAME@@perl(3) manpage. 1162the @@RXVT_NAME@@perl(3) manpage.
1253 1163
1254=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1255 1165
1256Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1257scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1258@@RXVT_NAME@@ will first look in these directories and then in 1168in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1259F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260 1170
1261See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1262 1172
1263=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1264 1174
… …
1287=item B<override-redirect>: I<boolean> 1197=item B<override-redirect>: I<boolean>
1288 1198
1289Compile I<frills>: Sets override-redirect for the terminal window, making 1199Compile I<frills>: Sets override-redirect for the terminal window, making
1290it almost invisible to window managers; option B<-override-redirect>. 1200it almost invisible to window managers; option B<-override-redirect>.
1291 1201
1202=item B<iso14755:> I<boolean>
1203
1204Turn on/off ISO 14755 (default enabled).
1205
1292=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1293 1207
1294Turn on/off ISO 14755 5.2 mode (default enabled). 1208Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1211
1212=item B<-pixmap> I<file[;oplist]>
1213
1214=item B<backgroundPixmap:> I<file[;oplist]>
1215
1216Compile I<pixbuf>: Use the specified image file as the window's
1217background and also optionally specify a colon separated list of
1218operations to modify it. Note that you may need to quote the C<;>
1219character when using the command line option, as C<;> is usually a
1220metacharacter in shells. Supported operations are:
1221
1222=over 4
1223
1224=item B<WxH+X+Y>
1225
1226sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1227scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1228scale of 0 disables scaling.
1229
1230=item B<op=tile>
1231
1232enables tiling
1233
1234=item B<op=keep-aspect>
1235
1236maintain the image aspect ratio when scaling
1237
1238=item B<op=root-align>
1239
1240use the position of the terminal window relative to the root window as
1241the image offset, simulating a root window background
1242
1243=back
1244
1245The default scale and position setting is C<100x100+50+50>.
1246Alternatively, a predefined set of templates can be used to achieve
1247the most common setups:
1248
1249=over 4
1250
1251=item B<style=tiled>
1252
1253the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1254
1255=item B<style=aspect-stretched>
1256
1257the image is scaled to fill the whole window maintaining the aspect
1258ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1259
1260=item B<style=stretched>
1261
1262the image is scaled to fill the whole window. Equivalent to 100x100
1263
1264=item B<style=centered>
1265
1266the image is centered with no scaling. Equivalent to 0x0+50+50
1267
1268=item B<style=root-tiled>
1269
1270the image is tiled with no scaling and using 'root' positioning.
1271Equivalent to 0x0:op=tile:op=root-align
1272
1273=back
1274
1275If multiple templates are specified the last one wins. Note that a
1276template overrides all the scale, position and operations settings.
1277
1278If used in conjunction with pseudo-transparency, the specified pixmap
1279will be blended over the transparent background using alpha-blending.
1280
1281=item B<-tr>|B<+tr>
1282
1283=item B<transparent:> I<boolean>
1284
1285Turn on/off pseudo-transparency by using the root pixmap as background.
1286
1287B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1288will be removed in future versions.
1289
1290=item B<-tint> I<colour>
1291
1292=item B<tintColor:> I<colour>
1293
1294Tint the transparent background with the given colour. Note that a
1295black tint yields a completely black image while a white tint yields
1296the image unchanged.
1297
1298=item B<-sh> I<number>
1299
1300=item B<shading:> I<number>
1301
1302Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1303A value of 100 means no shading.
1304
1305=item B<-blr> I<HxV>
1306
1307=item B<blurRadius:> I<HxV>
1308
1309Apply gaussian blur with the specified radius to the transparent
1310background. If a single number is specified, the vertical and
1311horizontal radii are considered to be the same. Setting one of the
1312radii to 1 and the other to a large number creates interesting effects
1313on some backgrounds. The maximum radius value is 128. An horizontal or
1314vertical radius of 0 disables blurring.
1315
1316=item B<path:> I<path>
1317
1318Specify the colon-delimited search path for finding background image files.
1295 1319
1296=back 1320=back
1297 1321
1298=head1 THE SCROLLBAR 1322=head1 THE SCROLLBAR
1299 1323
… …
1438B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1462B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1439it can be seen via the I<who(1)> command, and can accept messages. To 1463it can be seen via the I<who(1)> command, and can accept messages. To
1440allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1464allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1441on some systems or setgid to root or to some other group on others. 1465on some systems or setgid to root or to some other group on others.
1442 1466
1443=head1 COLORS AND GRAPHICS 1467=head1 COLOURS AND GRAPHICS
1444 1468
1445In addition to the default foreground and background colours, 1469In addition to the default foreground and background colours,
1446B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1470B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1447high-intensity bold/blink versions of the same). Here is a list of the 1471high-intensity (potentially bold/blink) versions of the same, and 72 (or
1448colours with their names. 1472240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1473cube plus a 8 (24) colour greyscale ramp.
1474
1475Here is a list of the ANSI colours with their names.
1449 1476
1450=begin table 1477=begin table
1451 1478
1452 B<color0> (black) = Black 1479 B<color0> (black) = Black
1453 B<color1> (red) = Red3 1480 B<color1> (red) = Red3
… …
1473It is also possible to specify the colour values of B<foreground>, 1500It is also possible to specify the colour values of B<foreground>,
1474B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1501B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1475a number 0-15, as a convenient shorthand to reference the colour name of 1502a number 0-15, as a convenient shorthand to reference the colour name of
1476color0-color15. 1503color0-color15.
1477 1504
1478In addition to the colours defined above, @@RXVT_NAME@@ offers an 1505The following text gives values for the standard 88 colour mode (and
1479additional 72 colours. The first 64 of those (with indices 16 to 79) 1506values for the 256 colour mode in parentheses).
1480consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
148116>), followed by 8 additional shades of gray (with indices 80 to 87).
1482 1507
1508The RGB cube uses indices 16..79 (16..231) using the following formulas:
1509
1510 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1511 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1512
1513The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1514steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1515the RGB cube.
1516
1483Together, all those colours implement the 88 colour xterm colours. Only 1517Together, all those colours implement the 88 (256) colour xterm
1484the first 16 can be changed using resources currently, the rest can only 1518colours. Only the first 16 can be changed using resources currently, the
1485be changed via command sequences ("escape codes"). 1519rest can only be changed via command sequences ("escape codes").
1520
1521Applications are advised to use terminfo or command sequences to discover
1522number and RGB values of all colours (yes, you can query this...).
1486 1523
1487Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1524Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1488always swapping the foreground/background colours. This is in contrast to 1525always swapping the foreground/background colours. This is in contrast to
1489I<xterm>(1) where the colours are only swapped if they have not otherwise 1526I<xterm>(1) where the colours are only swapped if they have not otherwise
1490been specified. For example, 1527been specified. For example,
1491 1528
1492=over 4
1493
1494=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1529 @@RXVT_NAME@@ -fg Black -bg White -rv
1495 1530
1496would yield White on Black, while on I<xterm>(1) it would yield Black 1531would yield White on Black, while on I<xterm>(1) it would yield Black on
1497on White. 1532White.
1498
1499=back
1500 1533
1501=head2 ALPHA CHANNEL SUPPORT 1534=head2 ALPHA CHANNEL SUPPORT
1502 1535
1503If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1536If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1504their act together, rxvt-unicode will do it's own alpha channel management: 1537their act together, rxvt-unicode will do its own alpha channel management:
1505 1538
1506You can prefix any color with an opaquenes percentage enclosed in 1539You can prefix any colour with an opaqueness percentage enclosed in
1507brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1540brackets, 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 1541(0-100) that specifies the opacity of the colour, where C<0> is completely
1509transparent and C<100> is completely opaque. For example, C<[50]red> is a 1542transparent and C<100> is completely opaque. For example, C<[50]red> is a
1510half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1543half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1511is the recommended format to specify transparency values, and works with 1544is the recommended format to specify transparency values, and works with
1512all ways to specify a colour. 1545all ways to specify a colour.
1513 1546
… …
1591 1624
1592=item B<SHELL> 1625=item B<SHELL>
1593 1626
1594The shell to be used for command execution, defaults to C</bin/sh>. 1627The shell to be used for command execution, defaults to C</bin/sh>.
1595 1628
1596=item B<RXVT_SOCKET> 1629=item B<RXVT_SOCKET> [I<sic>]
1597 1630
1598The unix domain socket path used by @@RXVT_NAME@@c(1) and 1631The unix domain socket path used by @@RXVT_NAME@@c(1) and
1599@@RXVT_NAME@@d(1). 1632@@RXVT_NAME@@d(1).
1600 1633
1601Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1634Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1635
1636=item B<URXVT_PERL_LIB>
1637
1638Additional F<:>-separated library search path for perl extensions. Will be
1639searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1640directory.
1641
1642=item B<URXVT_PERL_VERBOSITY>
1643
1644See L<@@RXVT_NAME@@perl>(3).
1602 1645
1603=item B<HOME> 1646=item B<HOME>
1604 1647
1605Used to locate the default directory for the unix domain socket for 1648Used to locate the default directory for the unix domain socket for
1606daemon communications and to locate various resource files (such as 1649daemon communications and to locate various resource files (such as
1607C<.Xdefaults>) 1650C<.Xdefaults>)
1608 1651
1609=item B<XAPPLRESDIR> 1652=item B<XAPPLRESDIR>
1610 1653
1611Directory where various X resource files are being located. 1654Directory where application-specific X resource files are located.
1612 1655
1613=item B<XENVIRONMENT> 1656=item B<XENVIRONMENT>
1614 1657
1615If set and accessible, gives the name of a X resource file to be loaded by 1658If set and accessible, gives the name of a X resource file to be loaded by
1616@@RXVT_NAME@@. 1659@@RXVT_NAME@@.
… …
1621 1664
1622=over 4 1665=over 4
1623 1666
1624=item B</usr/lib/X11/rgb.txt> 1667=item B</usr/lib/X11/rgb.txt>
1625 1668
1626Color names. 1669Colour names.
1627 1670
1628=back 1671=back
1629 1672
1630=head1 SEE ALSO 1673=head1 SEE ALSO
1631 1674
1675@@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) 1676@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1633 1677
1634=head1 CURRENT PROJECT COORDINATOR 1678=head1 CURRENT PROJECT COORDINATOR
1635 1679
1636=over 4 1680=over 4
1637 1681
… …
1682 1726
1683Project Coordinator (Changes 1.0 -) 1727Project Coordinator (Changes 1.0 -)
1684 1728
1685=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1729=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1686 1730
1687Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1731pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1688 1732
1689=back 1733=back
1690 1734

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines