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.151 by root, Wed Dec 12 19:55:55 2007 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile 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;
101resource B<depth>. 104resource B<depth>.
102 105
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
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
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
103=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
104 117
105Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
106 119
107=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
113Turn 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>.
114 127
115=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
116 129
117Turn 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>.
118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background; resource B<transparent>.
122
123B<-ip> is still accepted as an obsolete alias but will be removed in
124future versions.
125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
128 131
129=item B<-fade> I<number> 132=item B<-fade> I<number>
130 133
131Fade 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
132fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
135=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
136 139
137Fade 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
138is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
139 142
140=item B<-tint> I<colour> 143=item B<-icon> I<file>
141 144
142Tint the transparent background pixmap with the given colour when 145Compile I<pixbuf>: Use the specified image as application icon. This
143transparency is enabled with B<-tr>. This only works for 146is used by many window managers, taskbars and pagers to represent the
144non-tiled backgrounds, currently. See also the B<-sh> option that can be 147application window; resource I<iconFile>.
145used to brighten or darken the image in addition to tinting it.
146Please note that certain tint colours can be applied on the server-side,
147thus yielding performance gain of two orders of magnitude. These colours are:
148blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource
150I<tintColor>. Example:
151
152 @@RXVT_NAME@@ -tr -tint blue -sh 40
153
154=item B<-sh> I<number>
155
156Darken (0 .. 100) or lighten (100 .. 200) the transparent
157background image in addition to (or instead of) tinting it;
158resource I<shading>.
159
160=item B<-blt> I<string>
161
162Specify background blending type. If background pixmap is specified
163at the same time as transparency - such pixmap will be blended over
164transparency image, using method specified. Supported values are :
165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168alpha-blending. Compile I<afterimage>; resource I<blendType>.
169
170=item B<-blr> I<HxV>
171
172Apply Gaussian Blur with the specified radii to the transparent
173background image. If single number is specified - both vertical and
174horizontal radii are considered to be the same. Setting one of the
175radii to 1 and another to a large number creates interesting effects
176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177resource I<blurRadius>.
178 148
179=item B<-bg> I<colour> 149=item B<-bg> I<colour>
180 150
181Window background colour; resource B<background>. 151Window background colour; resource B<background>.
182 152
183=item B<-fg> I<colour> 153=item B<-fg> I<colour>
184 154
185Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
186
187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
188
189Compile I<afterimage>: Specify image file for the background and also
190optionally specify its scaling with a geometry string. Note you may need to
191add quotes to avoid special shell interpretation of the C<;> in the
192command-line; for more details see resource B<backgroundPixmap>.
193 156
194=item B<-cr> I<colour> 157=item B<-cr> I<colour>
195 158
196The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
197 160
242italic> >> characters are to be printed. See resource B<boldItalicFont> 205italic> >> characters are to be printed. See resource B<boldItalicFont>
243for details. 206for details.
244 207
245=item B<-is>|B<+is> 208=item B<-is>|B<+is>
246 209
247Compile I<font-styles>: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Blink font styles imply high intensity
248foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
249details. 212details.
250 213
251=item B<-name> I<name> 214=item B<-name> I<name>
252 215
270 233
271=item B<-sb>|B<+sb> 234=item B<-sb>|B<+sb>
272 235
273Turn on/off scrollbar; resource B<scrollBar>. 236Turn on/off scrollbar; resource B<scrollBar>.
274 237
238=item B<-sr>|B<+sr>
239
240Put scrollbar on right/left; resource B<scrollBar_right>.
241
242=item B<-st>|B<+st>
243
244Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
245resource B<scrollBar_floating>.
246
275=item B<-si>|B<+si> 247=item B<-si>|B<+si>
276 248
277Turn on/off scroll-to-bottom on TTY output inhibit; resource 249Turn on/off scroll-to-bottom on TTY output inhibit; resource
278B<scrollTtyOutput> has opposite effect. 250B<scrollTtyOutput> has opposite effect.
279 251
285=item B<-sw>|B<+sw> 257=item B<-sw>|B<+sw>
286 258
287Turn on/off scrolling with the scrollback buffer as new lines appear. 259Turn on/off scrolling with the scrollback buffer as new lines appear.
288This only takes effect if B<-si> is also given; resource 260This only takes effect if B<-si> is also given; resource
289B<scrollWithBuffer>. 261B<scrollWithBuffer>.
290
291=item B<-sr>|B<+sr>
292
293Put scrollbar on right/left; resource B<scrollBar_right>.
294
295=item B<-st>|B<+st>
296
297Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298resource B<scrollBar_floating>.
299 262
300=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
301 264
302If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
303actual wide characters in the screen buffer, which makes it possible to 266actual wide characters in the screen buffer, which makes it possible to
307 270
308=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
309 272
310Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
311 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
312=item B<-iconic> 279=item B<-iconic>
313 280
314Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
315Alternative form is B<-ic>. 282Alternative form is B<-ic>.
316 283
332 299
333=item B<-bl> 300=item B<-bl>
334 301
335Compile I<frills>: Set MWM hints to request a borderless window, i.e. 302Compile I<frills>: Set MWM hints to request a borderless window, i.e.
336if honoured by the WM, the rxvt-unicode window will not have window 303if honoured by the WM, the rxvt-unicode window will not have window
337decorations; resource B<borderLess>. 304decorations; resource B<borderLess>. If the window manager does not
305support MWM hints (e.g. kwin), enables override-redirect mode.
338 306
339=item B<-override-redirect> 307=item B<-override-redirect>
340 308
341Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
342B<override-redirect>. 310B<override-redirect>.
351=item B<-lsp> I<number> 319=item B<-lsp> I<number>
352 320
353Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
354the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
355B<lineSpace>. 323B<lineSpace>.
324
325=item B<-letsp> I<number>
326
327Compile I<frills>: Amount to adjust the computed character width by
328to control overall letter spacing. Negative values will tighten up the
329letter spacing, positive values will space letters out more. Useful to
330work around odd font metrics; resource B<letterSpace>.
356 331
357=item B<-tn> I<termname> 332=item B<-tn> I<termname>
358 333
359This option specifies the name of the terminal type to be set in the 334This option specifies the name of the terminal type to be set in the
360B<TERM> environment variable. This terminal type must exist in the 335B<TERM> environment variable. This terminal type must exist in the
447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448will not immediately destroy its window when the program executed within 423will not immediately destroy its window when the program executed within
449it exits. Instead, it will wait till it is being killed or closed by the 424it exits. Instead, it will wait till it is being killed or closed by the
450user; resource B<hold>. 425user; resource B<hold>.
451 426
427=item B<-cd> I<path>
428
429Sets the working directory for the shell (or the command specified via
430B<-e>). The I<path> must be an absolute path and it must exist for
431@@RXVT_NAME@@ to start; resource B<chdir>.
432
452=item B<-xrm> I<string> 433=item B<-xrm> I<string>
453 434
454Works like the X Toolkit option of the same name, by adding the I<string> 435Works like the X Toolkit option of the same name, by adding the I<string>
455as if it were specified in a resource file. Resource values specified this 436as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications. 437way take precedence over all other resource specifications.
539You 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
540distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
541starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
542with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
543 524
544 1. system-wide app-defaults file, either locale-dependent OR global
545 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
546 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
547 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
548 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549 6. resources specified via -xrm on the commandline 530 6. resources specified via -xrm on the commandline
550 531
551Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
552names: 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
564=item B<depth:> I<bitdepth> 545=item B<depth:> I<bitdepth>
565 546
566Compile I<xft>: Attempt to find a visual with the given bit depth; 547Compile I<xft>: Attempt to find a visual with the given bit depth;
567option B<-depth>. 548option B<-depth>.
568 549
550=item B<buffered:> I<boolean>
551
552Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
553On some card/driver combination enabling it slightly decreases
554performance, on most it greatly helps it. The slowdown is small, so it
555should normally be enabled.
556
569=item B<geometry:> I<geom> 557=item B<geometry:> I<geom>
570 558
571Create the window with the specified X window geometry [default 80x24]; 559Create the window with the specified X window geometry [default 80x24];
572option B<-geometry>. 560option B<-geometry>.
573 561
586Use 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
587corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
588high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
589colours. 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,
5903=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
591names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
592 580
593Colours 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
594changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
595 583
596Colours 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
607=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
608 596
609Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
610foreground colour is the default. 598foreground colour is the default.
611 599
612=item B<colorRV:> I<colour>
613
614Use the specified colour as the background for reverse video characters
615when OPTION_HC is disabled (--disable-frills).
616
617=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
618 601
619If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
620itself. 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.
621 614
622=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
623 616
624Use 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
625foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
632 625
633=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
634 627
635B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
636option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
637B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
638 631
639=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
640 633
641B<True>: specify that jump scrolling should be used. When receiving lots 634B<True>: specify that jump scrolling should be used. When receiving lots
642of 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
656 649
657B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
658if 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
659monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
660 653
661=item B<transparent:> I<boolean>
662
663Turn on/off illusion of a transparent window background.
664
665B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
666future versions.
667
668I<Please address all transparency related issues to Sasha Vasko at
669sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
670
671=item B<fading:> I<number> 654=item B<fading:> I<number>
672 655
673Fade 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>.
674 657
675=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
676 659
677Fade 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
678colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
679 662
680=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
681 664
682Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
683B<-tint>.
684
685=item B<shading:> I<number>
686
687Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
688in addition to tinting it; option B<-sh>.
689
690=item B<blendType:> I<string>
691
692Specify background blending type; option B<-blt>.
693
694=item B<blurRadius:> I<number>
695
696Apply Gaussian Blurr with the specified radius to the transparent
697background image; option B<-blr>.
698 666
699=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
700 668
701Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
702 670
707 675
708=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
709 677
710The 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
711and the text. 679and the text.
712
713=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
714
715Use the specified image file for the background and also
716optionally specify its scaling with a geometry string B<WxH+X+Y>,
717(default C<0x0+50+50>) in which B<"W" / "H"> specify the
718horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
719centre (percent). A scale of 0 displays the image with tiling. A scale
720of 1 displays the image without any scaling. A scale of 2 to 9 specifies
721an integer number of images in that direction. No image will be magnified
722beyond 10 times its original size. The maximum permitted scale is 1000.
723Additional operations can be specified after colon B<:op1:op2...>.
724Supported operations are:
725
726 tile force background image to be tiled and not scaled. Equivalent to 0x0,
727 propscale will scale image keeping proportions,
728 auto will scale image to match window size. Equivalent to 100x100;
729 hscale will scale image horizontally to the window size;
730 vscale will scale image vertically to the window size;
731 scale will scale image to match window size;
732 root will tile image as if it was a root window background, auto-adjusting
733 whenever terminal window moves.
734
735If used in conjunction with B<-tr> option, the specified pixmap will be
736blended over transparency image using either alpha-blending, or any
737other blending type, specified with B<-blt "type"> option.
738
739=item B<path:> I<path>
740
741Specify the colon-delimited search path for finding background image files.
742 680
743=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
744 682
745Select 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
746that 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
769it 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
770wide and 15 pixels high. 708wide and 15 pixels high.
771 709
772The 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
773the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
774the 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
775useful supplement. 713useful supplement.
776 714
777The 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
778are 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
779contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
803text font will being used for the given style. 741text font will being used for the given style.
804 742
805=item B<intensityStyles:> I<boolean> 743=item B<intensityStyles:> I<boolean>
806 744
807When font styles are not enabled, or this option is enabled (B<True>, 745When font styles are not enabled, or this option is enabled (B<True>,
808option B<-is>, the default), bold and italic font styles imply high 746option B<-is>, the default), bold/blink font styles imply high
809intensity foreground/background colours. Disabling this option (B<False>, 747intensity foreground/background colours. Disabling this option (B<False>,
810option B<+is>) disables this behaviour, the high intensity colours are not 748option B<+is>) disables this behaviour, the high intensity colours are not
811reachable. 749reachable.
812 750
813=item B<selectstyle:> I<mode>
814
815Set mouse selection style to B<old> which is 2.20, B<oldword> which
816is xterm style with 2.20 old word selection, or anything else which
817gives xterm style selection. Only effective when the original (non-perl)
818selection code is in use.
819
820=item B<scrollstyle:> I<mode>
821
822Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
823the author's favourite.
824
825=item B<title:> I<string> 751=item B<title:> I<string>
826 752
827Set window title string, the default title is the command-line 753Set window title string, the default title is the command-line
828specified after the B<-e> option, if any, otherwise the application 754specified after the B<-e> option, if any, otherwise the application
829name; option B<-title>. 755name; option B<-title>.
842=item B<urgentOnBell:> I<boolean> 768=item B<urgentOnBell:> I<boolean>
843 769
844B<True>: set the urgency hint for the wm on receipt of a bell character. 770B<True>: set the urgency hint for the wm on receipt of a bell character.
845B<False>: do not set the urgency hint [default]. 771B<False>: do not set the urgency hint [default].
846 772
773@@RXVT_NAME@@ resets the urgency hint on every focus change.
774
847=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
848 776
849B<True>: use visual bell on receipt of a bell character; option B<-vb>. 777B<True>: use visual bell on receipt of a bell character; option B<-vb>.
850B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
851 779
874 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 802 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875 803
876This creates a new file in your home directory with the screen contents 804This creates a new file in your home directory with the screen contents
877every time you hit C<Print>. 805every time you hit C<Print>.
878 806
807=item B<scrollstyle:> I<mode>
808
809Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
810the author's favourite.
811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
879=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
880 817
881B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
883 820
902B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
903B<+si>. 840B<+si>.
904 841
905=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
906 843
907B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
908B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
909with 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>.
910 848
911=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
912 850
913B<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
914are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
970=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
971 909
972B<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];
973option B<-bc>. 911option B<-bc>.
974 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
975=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
976 919
977B<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
978of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
979[default]. 922[default].
992large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
993 936
994=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
995 938
996The 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>
997or 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>
998(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
999escape sequence. 942escape sequence.
1000 943
1001=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
1002 945
1081 1024
1082=item B<secondaryScroll:> I<boolean> 1025=item B<secondaryScroll:> I<boolean>
1083 1026
1084Turn on/off secondary screen scroll (default enabled). If this 1027Turn on/off secondary screen scroll (default enabled). If this
1085option is enabled, scrolls on the secondary screen will change the 1028option is enabled, scrolls on the secondary screen will change the
1086scrollback buffer and switching to/from the secondary screen will 1029scrollback buffer and, when secondaryScreen is off, switching
1087instead scroll the screen up. 1030to/from the secondary screen will instead scroll the screen up.
1088 1031
1089=item B<hold>: I<boolean> 1032=item B<hold>: I<boolean>
1090 1033
1091Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1034Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1092will not immediately destroy its window when the program executed within 1035will not immediately destroy its window when the program executed within
1093it exits. Instead, it will wait till it is being killed or closed by the 1036it exits. Instead, it will wait till it is being killed or closed by the
1094user. 1037user.
1038
1039=item B<chdir>: I<path>
1040
1041Sets the working directory for the shell (or the command specified via
1042B<-e>). The I<path> must be an absolute path and it must exist for
1043@@RXVT_NAME@@ to start. If it isn't specified then the current working
1044directory will be used; option B<-cd>.
1095 1045
1096=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<string>
1097 1047
1098Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<string> with keysym I<sym>. The
1099intervening resource name B<keysym.> cannot be omitted. 1049intervening resource name B<keysym.> cannot be omitted.
1114omitting 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
1115keysym 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
1116performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1117 1067
1118I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1119number), see RESOURCES in C<man 7 X> for futher details. 1069number), see RESOURCES in C<man 7 X> for further details.
1120 1070
1121You 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>
1122with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1123should be a character not used by the strings. 1074should be a character not used by the strings.
1124 1075
1125Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1126 1077
1127 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1078 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1128 1079
1129The above line is equivalent to the following three lines: 1080The above line is equivalent to the following three lines:
1130 1081
1131 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1082 URxvt.keysym.Meta-Control-0x61: \033<a>
1132 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1083 URxvt.keysym.Meta-Control-0x62: \033<b>
1133 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1084 URxvt.keysym.Meta-Control-0x63: \033<c>
1134 1085
1135If 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>
1136is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1087is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1137example 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>
1138when Control-Meta-c is being pressed": 1089when Control-Meta-c is being pressed":
1139 1090
1140 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
1141 1092
1142If 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>
1143is 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)
1144manpage. For example, the F<selection> extension (activated via 1095manpage. For example, the F<selection> extension (activated via
1145C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1096C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1146 1097
1147 URxvt.keysym.M-C-c: perl:selection:rot13 1098 URxvt.keysym.M-C-c: perl:selection:rot13
1148 1099
1149Due the the large number of modifier combinations, a defined key mapping 1100Due the the large number of modifier combinations, a defined key mapping
1150will 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
1151no 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
1152means that defining a key map for C<a> will automatically provide 1103means that defining a key map for C<a> will automatically provide
1153definitions 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
1154mappings themselves. 1105mappings themselves.
1155 1106
1206all instances, while B<perl-ext> is used for specific instances. 1157all instances, while B<perl-ext> is used for specific instances.
1207 1158
1208=item B<perl-eval>: I<string> 1159=item B<perl-eval>: I<string>
1209 1160
1210Perl code to be evaluated when all extensions have been registered. See 1161Perl code to be evaluated when all extensions have been registered. See
1211the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1162the @@RXVT_NAME@@perl(3) manpage.
1212will be ignored when running setuid/setgid.
1213 1163
1214=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1215 1165
1216Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1217scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1218@@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
1219F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1220will be ignored when running setuid/setgid.
1221 1170
1222See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1223 1172
1224=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1225 1174
1234=item B<searchable-scrollback:> I<keysym> 1183=item B<searchable-scrollback:> I<keysym>
1235 1184
1236Sets the hotkey that starts the incremental scrollback buffer search 1185Sets the hotkey that starts the incremental scrollback buffer search
1237(default: C<M-s>). 1186(default: C<M-s>).
1238 1187
1239=item B<urlLauncher>: I<string> 1188=item B<url-launcher>: I<string>
1240 1189
1241Specifies the program to be started with a URL argument. Used by the 1190Specifies the program to be started with a URL argument. Used by the
1242C<selection-popup> and C<matcher> perl extensions. 1191C<selection-popup> and C<matcher> perl extensions.
1243 1192
1244=item B<transient-for>: I<windowid> 1193=item B<transient-for>: I<windowid>
1248=item B<override-redirect>: I<boolean> 1197=item B<override-redirect>: I<boolean>
1249 1198
1250Compile I<frills>: Sets override-redirect for the terminal window, making 1199Compile I<frills>: Sets override-redirect for the terminal window, making
1251it almost invisible to window managers; option B<-override-redirect>. 1200it almost invisible to window managers; option B<-override-redirect>.
1252 1201
1202=item B<iso14755:> I<boolean>
1203
1204Turn on/off ISO 14755 (default enabled).
1205
1253=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1254 1207
1255Turn on/off ISO 14755 5.2 mode (default enabled). 1208Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210=back
1211
1212=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1213
1214=over 4
1215
1216=item B<-pixmap> I<file[;oplist]>
1217
1218=item B<backgroundPixmap:> I<file[;oplist]>
1219
1220Compile I<pixbuf>: Use the specified image file as the window's
1221background and also optionally specify a colon separated list of
1222operations to modify it. Note that you may need to quote the C<;>
1223character when using the command line option, as C<;> is usually a
1224metacharacter in shells. Supported operations are:
1225
1226=over 4
1227
1228=item B<WxH+X+Y>
1229
1230sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1231scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1232scale of 0 disables scaling.
1233
1234=item B<op=tile>
1235
1236enables tiling
1237
1238=item B<op=keep-aspect>
1239
1240maintain the image aspect ratio when scaling
1241
1242=item B<op=root-align>
1243
1244use the position of the terminal window relative to the root window as
1245the image offset, simulating a root window background
1246
1247=back
1248
1249The default scale and position setting is C<100x100+50+50>.
1250Alternatively, a predefined set of templates can be used to achieve
1251the most common setups:
1252
1253=over 4
1254
1255=item B<style=tiled>
1256
1257the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1258
1259=item B<style=aspect-stretched>
1260
1261the image is scaled to fill the whole window maintaining the aspect
1262ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1263
1264=item B<style=stretched>
1265
1266the image is scaled to fill the whole window. Equivalent to 100x100
1267
1268=item B<style=centered>
1269
1270the image is centered with no scaling. Equivalent to 0x0+50+50
1271
1272=item B<style=root-tiled>
1273
1274the image is tiled with no scaling and using 'root' positioning.
1275Equivalent to 0x0:op=tile:op=root-align
1276
1277=back
1278
1279If multiple templates are specified the last one wins. Note that a
1280template overrides all the scale, position and operations settings.
1281
1282If used in conjunction with pseudo-transparency, the specified pixmap
1283will be blended over the transparent background using alpha-blending.
1284
1285=item B<-tr>|B<+tr>
1286
1287=item B<transparent:> I<boolean>
1288
1289Turn on/off pseudo-transparency by using the root pixmap as background.
1290
1291B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1292will be removed in future versions.
1293
1294=item B<-tint> I<colour>
1295
1296=item B<tintColor:> I<colour>
1297
1298Tint the transparent background with the given colour. Note that a
1299black tint yields a completely black image while a white tint yields
1300the image unchanged.
1301
1302=item B<-sh> I<number>
1303
1304=item B<shading:> I<number>
1305
1306Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1307A value of 100 means no shading.
1308
1309=item B<-blr> I<HxV>
1310
1311=item B<blurRadius:> I<HxV>
1312
1313Apply gaussian blur with the specified radius to the transparent
1314background. If a single number is specified, the vertical and
1315horizontal radii are considered to be the same. Setting one of the
1316radii to 1 and the other to a large number creates interesting effects
1317on some backgrounds. The maximum radius value is 128. An horizontal or
1318vertical radius of 0 disables blurring.
1319
1320=item B<path:> I<path>
1321
1322Specify the colon-delimited search path for finding background image files.
1256 1323
1257=back 1324=back
1258 1325
1259=head1 THE SCROLLBAR 1326=head1 THE SCROLLBAR
1260 1327
1399B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1466B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1400it can be seen via the I<who(1)> command, and can accept messages. To 1467it can be seen via the I<who(1)> command, and can accept messages. To
1401allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1468allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1402on some systems or setgid to root or to some other group on others. 1469on some systems or setgid to root or to some other group on others.
1403 1470
1404=head1 COLORS AND GRAPHICS 1471=head1 COLOURS AND GRAPHICS
1405 1472
1406In addition to the default foreground and background colours, 1473In addition to the default foreground and background colours,
1407B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1474B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1408high-intensity bold/blink versions of the same). Here is a list of the 1475high-intensity (potentially bold/blink) versions of the same, and 72 (or
1409colours with their names. 1476240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1477cube plus a 8 (24) colour greyscale ramp.
1478
1479Here is a list of the ANSI colours with their names.
1410 1480
1411=begin table 1481=begin table
1412 1482
1413 B<color0> (black) = Black 1483 B<color0> (black) = Black
1414 B<color1> (red) = Red3 1484 B<color1> (red) = Red3
1434It is also possible to specify the colour values of B<foreground>, 1504It is also possible to specify the colour values of B<foreground>,
1435B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1505B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1436a number 0-15, as a convenient shorthand to reference the colour name of 1506a number 0-15, as a convenient shorthand to reference the colour name of
1437color0-color15. 1507color0-color15.
1438 1508
1439In addition to the colours defined above, @@RXVT_NAME@@ offers an 1509The following text gives values for the standard 88 colour mode (and
1440additional 72 colours. The first 64 of those (with indices 16 to 79) 1510values for the 256 colour mode in parentheses).
1441consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144216>), followed by 8 additional shades of gray (with indices 80 to 87).
1443 1511
1512The RGB cube uses indices 16..79 (16..231) using the following formulas:
1513
1514 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1515 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1516
1517The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1518steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1519the RGB cube.
1520
1444Together, all those colours implement the 88 colour xterm colours. Only 1521Together, all those colours implement the 88 (256) colour xterm
1445the first 16 can be changed using resources currently, the rest can only 1522colours. Only the first 16 can be changed using resources currently, the
1446be changed via command sequences ("escape codes"). 1523rest can only be changed via command sequences ("escape codes").
1524
1525Applications are advised to use terminfo or command sequences to discover
1526number and RGB values of all colours (yes, you can query this...).
1447 1527
1448Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1528Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1449always swapping the foreground/background colours. This is in contrast to 1529always swapping the foreground/background colours. This is in contrast to
1450I<xterm>(1) where the colours are only swapped if they have not otherwise 1530I<xterm>(1) where the colours are only swapped if they have not otherwise
1451been specified. For example, 1531been specified. For example,
1452 1532
1453=over 4
1454
1455=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1533 @@RXVT_NAME@@ -fg Black -bg White -rv
1456 1534
1457would yield White on Black, while on I<xterm>(1) it would yield Black 1535would yield White on Black, while on I<xterm>(1) it would yield Black on
1458on White. 1536White.
1459
1460=back
1461 1537
1462=head2 ALPHA CHANNEL SUPPORT 1538=head2 ALPHA CHANNEL SUPPORT
1463 1539
1464If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1540If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1465their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1541their act together, rxvt-unicode will do its own alpha channel management:
1466(recommended, but B<MUST> have 4 digits/component) colour specifications, 1542
1467in addition to the ones provided by X, where the additional A component 1543You can prefix any colour with an opaqueness percentage enclosed in
1544brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1545(0-100) that specifies the opacity of the colour, where C<0> is completely
1546transparent and C<100> is completely opaque. For example, C<[50]red> is a
1547half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1548is the recommended format to specify transparency values, and works with
1549all ways to specify a colour.
1550
1551For complete control, rxvt-unicode also supports
1552C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1553specifications, where the additional C<aaaa> component specifies opacity
1468specifies opacity (alpha) values. The minimum value of C<0> is completely 1554(alpha) values. The minimum value of C<0000> is completely transparent,
1469transparent). You can also prefix any color with C<[percent]>, where 1555while C<ffff> is completely opaque). The two example colours from
1470C<percent> is a decimal percentage (0-100) that specifies the opacity of 1556earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1471the color, where C<0> is completely transparent and C<100> is completelxy 1557C<rgba:0000/ff00/0000/f332>.
1472opaque.
1473 1558
1474You probably need to specify B<"-depth 32">, too, and have the luck that 1559You probably need to specify B<"-depth 32">, too, to force a visual with
1475your X-server uses ARGB pixel layout, as X is far from just supporting 1560alpha channels, and have the luck that your X-server uses ARGB pixel
1476ARGB visuals out of the box, and rxvt-unicode just fudges around. 1561layout, as X is far from just supporting ARGB visuals out of the box, and
1562rxvt-unicode just fudges around.
1477 1563
1478For example, the following selects an almost completely transparent red 1564For example, the following selects an almost completely transparent black
1479background, and an almost opaque pink foreground: 1565background, and an almost opaque pink foreground:
1480 1566
1481 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1567 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482 1568
1483I<Please note that transparency of any kind if completely unsupported by 1569When not using a background image, then the interpretation of the
1484the author. Don't bug him with installation questions!> 1570alpha channel is up to your compositing manager (most interpret it as
1571transparency of course).
1572
1573When using a background pixmap or pseudo-transparency, then the background
1574colour will always behave as if it were completely transparent (so the
1575background image shows instead), regardless of how it was specified, while
1576other colours will either be transparent as specified (the background
1577image will show through) on servers supporting the RENDER extension, or
1578fully opaque on servers not supporting the RENDER EXTENSION.
1579
1580Please note that due to bugs in Xft, specifying alpha values might result
1581in garbage being displayed when the X-server does not support the RENDER
1582extension.
1485 1583
1486=head1 ENVIRONMENT 1584=head1 ENVIRONMENT
1487 1585
1488B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1586B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489 1587
1523C<--with-terminfo=PATH>. 1621C<--with-terminfo=PATH>.
1524 1622
1525=item B<DISPLAY> 1623=item B<DISPLAY>
1526 1624
1527Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1625Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1528display in its child processes. 1626display in its child processes if C<-display> isn't used to override. It
1627defaults to C<:0> if it doesn't exist.
1529 1628
1530=item B<SHELL> 1629=item B<SHELL>
1531 1630
1532The shell to be used for command execution, defaults to C</bin/sh>. 1631The shell to be used for command execution, defaults to C</bin/sh>.
1533 1632
1534=item B<RXVT_SOCKET> 1633=item B<RXVT_SOCKET> [I<sic>]
1535 1634
1536The unix domain socket path used by @@RXVT_NAME@@c(1) and 1635The unix domain socket path used by @@RXVT_NAME@@c(1) and
1537@@RXVT_NAME@@d(1). 1636@@RXVT_NAME@@d(1).
1538 1637
1539Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1638Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1639
1640=item B<URXVT_PERL_LIB>
1641
1642Additional F<:>-separated library search path for perl extensions. Will be
1643searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1644directory.
1645
1646=item B<URXVT_PERL_VERBOSITY>
1647
1648See L<@@RXVT_NAME@@perl>(3).
1540 1649
1541=item B<HOME> 1650=item B<HOME>
1542 1651
1543Used to locate the default directory for the unix domain socket for 1652Used to locate the default directory for the unix domain socket for
1544daemon communications and to locate various resource files (such as 1653daemon communications and to locate various resource files (such as
1545C<.Xdefaults>) 1654C<.Xdefaults>)
1546 1655
1547=item B<XAPPLRESDIR> 1656=item B<XAPPLRESDIR>
1548 1657
1549Directory where various X resource files are being located. 1658Directory where application-specific X resource files are located.
1550 1659
1551=item B<XENVIRONMENT> 1660=item B<XENVIRONMENT>
1552 1661
1553If set and accessible, gives the name of a X resource file to be loaded by 1662If set and accessible, gives the name of a X resource file to be loaded by
1554@@RXVT_NAME@@. 1663@@RXVT_NAME@@.
1559 1668
1560=over 4 1669=over 4
1561 1670
1562=item B</usr/lib/X11/rgb.txt> 1671=item B</usr/lib/X11/rgb.txt>
1563 1672
1564Color names. 1673Colour names.
1565 1674
1566=back 1675=back
1567 1676
1568=head1 SEE ALSO 1677=head1 SEE ALSO
1569 1678
1679@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1570@@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) 1680@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1571 1681
1572=head1 CURRENT PROJECT COORDINATOR 1682=head1 CURRENT PROJECT COORDINATOR
1573 1683
1574=over 4 1684=over 4
1575 1685
1576=item Project Coordinator 1686=item Project Coordinator
1577 1687
1578Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1688Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1579 1689
1580L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1690L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1581 1691
1582=back 1692=back
1583 1693
1587 1697
1588=item John Bovey 1698=item John Bovey
1589 1699
1590University of Kent, 1992, wrote the original Xvt. 1700University of Kent, 1992, wrote the original Xvt.
1591 1701
1592=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1702=item Rob Nation <nation@rocket.sanders.lockheed.com>
1593 1703
1594very heavily modified Xvt and came up with Rxvt 1704very heavily modified Xvt and came up with Rxvt
1595 1705
1596=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1706=item Angelo Haritsis <ah@doc.ic.ac.uk>
1597 1707
1598wrote the Greek Keyboard Input (no longer in code) 1708wrote the Greek Keyboard Input (no longer in code)
1599 1709
1600=item mj olesen L<< <olesen@me.QueensU.CA> >> 1710=item mj olesen <olesen@me.QueensU.CA>
1601 1711
1602Wrote the menu system. 1712Wrote the menu system.
1603 1713
1604Project Coordinator (changes.txt 2.11 to 2.21) 1714Project Coordinator (changes.txt 2.11 to 2.21)
1605 1715
1606=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1716=item Oezguer Kesim <kesim@math.fu-berlin.de>
1607 1717
1608Project Coordinator (changes.txt 2.21a to 2.4.5) 1718Project Coordinator (changes.txt 2.21a to 2.4.5)
1609 1719
1610=item Geoff Wing L<< <gcw@pobox.com> >> 1720=item Geoff Wing <gcw@pobox.com>
1611 1721
1612Rewrote screen display and text selection routines. 1722Rewrote screen display and text selection routines.
1613 1723
1614Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1724Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1615 1725
1616=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1726=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1617 1727
1618Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1728Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1619extension, random hacks, numerous bugfixes and extensions. 1729extension, random hacks, numerous bugfixes and extensions.
1620 1730
1621Project Coordinator (Changes 1.0 -) 1731Project Coordinator (Changes 1.0 -)
1622 1732
1623=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1733=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1624 1734
1625Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1735pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1626 1736
1627=back 1737=back
1628 1738

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines