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.119 by root, Mon Aug 7 16:04:29 2006 UTC vs.
Revision 1.176 by sf-exg, Sat Apr 17 23:00:45 2010 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/*checkout*/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
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very user friendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
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<xft>: 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
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
107=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
108 116
109Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
110 118
111=item B<-j>|B<+j> 119=item B<-j>|B<+j>
112 120
113Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 122
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
116 124
117Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 126
120I<Please note that transparency of any kind if completely unsupported by 127=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 128
122@@RXVT_NAME@@)!> 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@@)!>
123 136
124=item B<-fade> I<number> 137=item B<-fade> I<number>
125 138
126Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
133is opaque black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
134 147
135=item B<-tint> I<colour> 148=item B<-tint> I<colour>
136 149
137Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
140used to brighten or darken the image in addition to tinting it; resource 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
141I<tintColor>. Example: 158I<tintColor>. Example:
142 159
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 161
145=item B<-sh> 162=item B<-sh> I<number>
146 163
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>). 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>
188
189Compile I<afterimage>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>.
150 192
151=item B<-bg> I<colour> 193=item B<-bg> I<colour>
152 194
153Window background colour; resource B<background>. 195Window background colour; resource B<background>.
154 196
155=item B<-fg> I<colour> 197=item B<-fg> I<colour>
156 198
157Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
158 200
159=item B<-pixmap> I<file[;geom]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160 202
161Compile I<XPM>: Specify XPM file for the background and also optionally 203Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 204optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
165 207
166=item B<-cr> I<colour> 208=item B<-cr> I<colour>
167 209
168The cursor colour; resource B<cursorColor>. 210The cursor colour; resource B<cursorColor>.
169 211
214italic> >> characters are to be printed. See resource B<boldItalicFont> 256italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 257for details.
216 258
217=item B<-is>|B<+is> 259=item B<-is>|B<+is>
218 260
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 261Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 262foreground/background (default). See resource B<intensityStyles> for
221details. 263details.
222 264
223=item B<-name> I<name> 265=item B<-name> I<name>
224 266
242 284
243=item B<-sb>|B<+sb> 285=item B<-sb>|B<+sb>
244 286
245Turn on/off scrollbar; resource B<scrollBar>. 287Turn on/off scrollbar; resource B<scrollBar>.
246 288
289=item B<-sr>|B<+sr>
290
291Put scrollbar on right/left; resource B<scrollBar_right>.
292
293=item B<-st>|B<+st>
294
295Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
296resource B<scrollBar_floating>.
297
247=item B<-si>|B<+si> 298=item B<-si>|B<+si>
248 299
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 300Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 301B<scrollTtyOutput> has opposite effect.
251 302
257=item B<-sw>|B<+sw> 308=item B<-sw>|B<+sw>
258 309
259Turn on/off scrolling with the scrollback buffer as new lines appear. 310Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 311This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 312B<scrollWithBuffer>.
262
263=item B<-sr>|B<+sr>
264
265Put scrollbar on right/left; resource B<scrollBar_right>.
266
267=item B<-st>|B<+st>
268
269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270resource B<scrollBar_floating>.
271 313
272=item B<-ptab>|B<+ptab> 314=item B<-ptab>|B<+ptab>
273 315
274If enabled (default), "Horizontal Tab" characters are being stored as 316If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 317actual wide characters in the screen buffer, which makes it possible to
279 321
280=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
281 323
282Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
283 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
284=item B<-iconic> 330=item B<-iconic>
285 331
286Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
287Alternative form is B<-ic>. 333Alternative form is B<-ic>.
288 334
304 350
305=item B<-bl> 351=item B<-bl>
306 352
307Compile I<frills>: Set MWM hints to request a borderless window, i.e. 353Compile I<frills>: Set MWM hints to request a borderless window, i.e.
308if honoured by the WM, the rxvt-unicode window will not have window 354if honoured by the WM, the rxvt-unicode window will not have window
309decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
310 357
311=item B<-override-redirect> 358=item B<-override-redirect>
312 359
313Compile I<frills>: Sets override-redirect on the window; resource 360Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>. 361B<override-redirect>.
322 369
323=item B<-lsp> I<number> 370=item B<-lsp> I<number>
324 371
325Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
327B<linespace>. 374B<lineSpace>.
375
376=item B<-letsp> I<number>
377
378Compile I<frills>: Amount to adjust the computed character width by
379to control overall letter spacing. Negative values will tighten up the
380letter spacing, positive values will space letters out more. Useful to
381work around odd font metrics; resource B<letterSpace>.
328 382
329=item B<-tn> I<termname> 383=item B<-tn> I<termname>
330 384
331This option specifies the name of the terminal type to be set in the 385This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
386for more info. 440for more info.
387 441
388=item B<-tcw> 442=item B<-tcw>
389 443
390Change the meaning of triple-click selection with the left mouse 444Change the meaning of triple-click selection with the left mouse
445button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 446in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 447the end of the logical line only. resource B<tripleclickwords>.
393 448
394=item B<-insecure> 449=item B<-insecure>
395 450
396Enable "insecure" mode, which currently enables most of the escape 451Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 452sequences that echo strings. See the resource B<insecure> for more
417 472
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 474will not immediately destroy its window when the program executed within
420it exits. Instead, it will wait till it is being killed or closed by the 475it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 476user; resource B<hold>.
477
478=item B<-cd> I<path>
479
480Sets the working directory for the shell (or the command specified via
481B<-e>). The I<path> must be an absolute path and it must exist for
482@@RXVT_NAME@@ to start; resource B<chdir>.
483
484=item B<-xrm> I<string>
485
486Works like the X Toolkit option of the same name, by adding the I<string>
487as if it were specified in a resource file. Resource values specified this
488way take precedence over all other resource specifications.
489
490Note that you need to use the I<same> syntax as in the .Xdefaults file,
491e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
492options can be specified as long-options on the commandline, so use
493of B<-xrm> is mostly limited to cases where you want to specify other
494resources (e.g. for input methods) or for compatibility with other
495programs.
422 496
423=item B<-keysym.>I<sym> I<string> 497=item B<-keysym.>I<sym> I<string>
424 498
425Remap a key symbol. See resource B<keysym>. 499Remap a key symbol. See resource B<keysym>.
426 500
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 535If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462entries and will not tinker with pty/tty permissions - you have to do that 536entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 537yourself if you want that.
464 538
465As an extremely special case, specifying C<-1> will completely suppress 539As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 540pty/tty operations, which is probably only useful in conjunction with some
541perl extension that manages the terminal.
467 542
468Here is a example in perl that illustrates how this option can be used (a 543Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 544longer example is in F<doc/pty-fd>):
470 545
471 use IO::Pty; 546 use IO::Pty;
485Comma-separated list of perl extension scripts to use (or not to use) in 560Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 561this terminal instance. See resource B<perl-ext> for details.
487 562
488=back 563=back
489 564
490=head1 RESOURCES (available also as long-options) 565=head1 RESOURCES
491 566
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 567Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 568options) compiled into your version. All resources are also available as
569long-options.
494 570
495You can set and change the resources using X11 tools like B<xrdb>. Many 571You can set and change the resources using X11 tools like B<xrdb>. Many
496distribution do also load settings from the B<~/.Xresources> file when X 572distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 573starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 574with later settings overwriting earlier ones:
500 1. system-wide app-defaults file, either locale-dependent OR global 576 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 577 2. app-defaults file in $XAPPLRESDIR
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503 4. SCREEN_RESOURCES for the current screen 579 4. SCREEN_RESOURCES for the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline
505 582
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 585common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 586configured, while the class name B<URxvt> allows resources unique to
519=item B<depth:> I<bitdepth> 596=item B<depth:> I<bitdepth>
520 597
521Compile I<xft>: Attempt to find a visual with the given bit depth; 598Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>. 599option B<-depth>.
523 600
601=item B<buffered:> I<boolean>
602
603Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
604On some card/driver combination enabling it slightly decreases
605performance, on most it greatly helps it. The slowdown is small, so it
606should normally be enabled.
607
524=item B<geometry:> I<geom> 608=item B<geometry:> I<geom>
525 609
526Create the window with the specified X window geometry [default 80x24]; 610Create the window with the specified X window geometry [default 80x24];
527option B<-geometry>. 611option B<-geometry>.
528 612
562=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
563 647
564Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
565foreground colour is the default. 649foreground colour is the default.
566 650
567=item B<colorRV:> I<colour>
568
569Use the specified colour as the background for reverse video
570characters.
571
572=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
573 652
574If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 654itself. If unset, use the foreground colour.
655
656=item B<highlightColor:> I<colour>
657
658If set, use the specified colour as the background for highlighted
659characters. If unset, use reverse video.
660
661=item B<highlightTextColor:> I<colour>
662
663If set and highlightColor is set, use the specified colour as the
664foreground for highlighted characters.
576 665
577=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
578 667
579Use the specified colour for the cursor. The default is to use the 668Use the specified colour for the cursor. The default is to use the
580foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
591option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 682
594=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
595 684
596B<True>: specify that jump scrolling should be used. When scrolling 685B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 686of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
687has been read, resulting in fewer updates while still displaying every
688received line; option B<-j>.
689
598B<False>: specify that smooth scrolling should be used; option B<+j>. 690B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
691force a screen refresh on each new line it received; option B<+j>.
599 692
600=item B<inheritPixmap:> I<boolean> 693=item B<skipScroll:> I<boolean>
601 694
602B<True>: make the background inherit the parent windows' pixmap, giving 695B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 696receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 697(around 60 times per second), resulting in far fewer updates. This can
698result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
699option B<-ss>.
605 700
606I<Please note that transparency of any kind if completely unsupported by 701B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 702if the refresh is too fast for the human eye to read anything (or the
703monitor to display anything); option B<+ss>.
704
705=item B<transparent:> I<boolean>
706
707Turn on/off illusion of a transparent window background.
708
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions.
711
712I<Please address all transparency related issues to Sasha Vasko at
713sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608 714
609=item B<fading:> I<number> 715=item B<fading:> I<number>
610 716
611Fade the text by the given percentage when focus is lost; option B<-fade>. 717Fade the text by the given percentage when focus is lost; option B<-fade>.
612 718
620Tint the transparent background pixmap with the given colour; option 726Tint the transparent background pixmap with the given colour; option
621B<-tint>. 727B<-tint>.
622 728
623=item B<shading:> I<number> 729=item B<shading:> I<number>
624 730
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626image in addition to tinting it. 732in addition to tinting it; option B<-sh>.
733
734=item B<blendType:> I<string>
735
736Specify background blending type; option B<-blt>.
737
738=item B<blurRadius:> I<number>
739
740Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>.
742
743=item B<iconFile:> I<file>
744
745Set the application icon pixmap; option B<-icon>.
627 746
628=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
629 748
630Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
631 750
637=item B<borderColor:> I<colour> 756=item B<borderColor:> I<colour>
638 757
639The colour of the border around the text area and between the scrollbar 758The colour of the border around the text area and between the scrollbar
640and the text. 759and the text.
641 760
642=item B<backgroundPixmap:> I<file[;geom]> 761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 762
644Use the specified XPM file (note the `.xpm' extension is optional) for 763Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 764optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 765(default C<0x0+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 767centre (percent). A scale of 0 displays the image with tiling. A scale
649of 1 displays the image without any scaling. A scale of 2 to 9 768of 1 displays the image without any scaling. A scale of 2 to 9 specifies
650specifies an integer number of images in that direction. No image will 769an integer number of images in that direction. No image will be magnified
651be magnified beyond 10 times its original size. The maximum permitted 770beyond 10 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 771Additional operations can be specified after colon B<:op1:op2...>.
772Supported operations are:
773
774 tile force background image to be tiled and not scaled. Equivalent to 0x0
775 propscale will scale image keeping proportions
776 auto will scale image to match window size. Equivalent to 100x100
777 hscale will scale image horizontally to the window size
778 vscale will scale image vertically to the window size
779 scale will scale image to match window size
780 root will tile image as if it was a root window background, auto-adjusting
781 whenever terminal window moves
782
783If used in conjunction with B<-tr> option, the specified pixmap will be
784blended over transparency image using either alpha-blending, or any
785other blending type, specified with B<-blt "type"> option.
653 786
654=item B<path:> I<path> 787=item B<path:> I<path>
655 788
656Specify the colon-delimited search path for finding XPM files. 789Specify the colon-delimited search path for finding background image files.
657 790
658=item B<font:> I<fontlist> 791=item B<font:> I<fontlist>
659 792
660Select the fonts to be used. This is a comma separated list of font names 793Select the fonts to be used. This is a comma separated list of font names
661that are checked in order when trying to find glyphs for characters. The 794that are checked in order when trying to find glyphs for characters. The
684it is named first) and thus defines the character cell grid to be 9 pixels 817it is named first) and thus defines the character cell grid to be 9 pixels
685wide and 15 pixels high. 818wide and 15 pixels high.
686 819
687The second font is just used to add additional unicode characters not in 820The second font is just used to add additional unicode characters not in
688the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
689the bold version of the font does contain less characters, so this is a 822the bold version of the font does contain fewer characters, so this is a
690useful supplement. 823useful supplement.
691 824
692The third font is an Xft font with aliasing turned off, and the characters 825The third font is an Xft font with aliasing turned off, and the characters
693are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 826are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
718text font will being used for the given style. 851text font will being used for the given style.
719 852
720=item B<intensityStyles:> I<boolean> 853=item B<intensityStyles:> I<boolean>
721 854
722When font styles are not enabled, or this option is enabled (B<True>, 855When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 856option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 857intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 858option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 859reachable.
727 860
728=item B<selectstyle:> I<mode>
729
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731xterm style with 2.20 old word selection, or anything else which gives
732xterm style selection.
733
734=item B<scrollstyle:> I<mode>
735
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite.
738
739=item B<title:> I<string> 861=item B<title:> I<string>
740 862
741Set window title string, the default title is the command-line 863Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 864specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 865name; option B<-title>.
751=item B<mapAlert:> I<boolean> 873=item B<mapAlert:> I<boolean>
752 874
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 875B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 876de-iconify (map) on receipt of a bell character [default].
755 877
878=item B<urgentOnBell:> I<boolean>
879
880B<True>: set the urgency hint for the wm on receipt of a bell character.
881B<False>: do not set the urgency hint [default].
882
883@@RXVT_NAME@@ resets the urgency hint on every focus change.
884
756=item B<visualBell:> I<boolean> 885=item B<visualBell:> I<boolean>
757 886
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 887B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 888B<False>: no visual bell [default]; option B<+vb>.
760 889
782 911
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 912 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 913
785This creates a new file in your home directory with the screen contents 914This creates a new file in your home directory with the screen contents
786every time you hit C<Print>. 915every time you hit C<Print>.
916
917=item B<scrollstyle:> I<mode>
918
919Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
920the author's favourite.
787 921
788=item B<scrollBar:> I<boolean> 922=item B<scrollBar:> I<boolean>
789 923
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 924B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 925disable the scrollbar; option B<+sb>.
854=item B<termName:> I<termname> 988=item B<termName:> I<termname>
855 989
856Specifies the terminal type name to be set in the B<TERM> environment 990Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 991variable; option B<-tn>.
858 992
859=item B<linespace:> I<number> 993=item B<lineSpace:> I<number>
860 994
861Specifies number of lines (pixel height) to insert between each row of 995Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 996the display [default 0]; option B<-lsp>.
863 997
864=item B<meta8:> I<boolean> 998=item B<meta8:> I<boolean>
878 1012
879=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
880 1014
881B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1015B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882option B<-bc>. 1016option B<-bc>.
1017
1018=item B<cursorUnderline:> I<boolean>
1019
1020B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1021option B<-uc>.
883 1022
884=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
885 1024
886B<True>: blank the pointer when a key is pressed or after a set number 1025B<True>: blank the pointer when a key is pressed or after a set number
887of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
916=item B<cutchars:> I<string> 1055=item B<cutchars:> I<string>
917 1056
918The characters used as delimiters for double-click word selection 1057The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 1058(whitespace delimiting is added automatically if resource is given).
920 1059
921When the selection extension is in use (the default if compiled in, see 1060When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1061in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 1062characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 1063will be created). In this mode, characters outside ISO-8859-1 can be used.
925 1064
926When the selection extension is not used, only ISO-8859-1 characters can 1065When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 1066be used. If not specified, the built-in default is used:
928 1067
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1068B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 1069
931=item B<preeditType:> I<style> 1070=item B<preeditType:> I<style>
932 1071
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1072B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 1073
988 1127
989Turn on/off secondary screen (default enabled). 1128Turn on/off secondary screen (default enabled).
990 1129
991=item B<secondaryScroll:> I<boolean> 1130=item B<secondaryScroll:> I<boolean>
992 1131
993Turn on/off secondary screen scroll (default enabled). If the this 1132Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1133option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1134scrollback buffer and, when secondaryScreen is off, switching
996instead scroll the screen up. 1135to/from the secondary screen will instead scroll the screen up.
997 1136
998=item B<hold>: I<boolean> 1137=item B<hold>: I<boolean>
999 1138
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1139Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within 1140will not immediately destroy its window when the program executed within
1002it exits. Instead, it will wait till it is being killed or closed by the 1141it exits. Instead, it will wait till it is being killed or closed by the
1003user. 1142user.
1143
1144=item B<chdir>: I<path>
1145
1146Sets the working directory for the shell (or the command specified via
1147B<-e>). The I<path> must be an absolute path and it must exist for
1148@@RXVT_NAME@@ to start. If it isn't specified then the current working
1149directory will be used; option B<-cd>.
1004 1150
1005=item B<keysym.>I<sym>: I<string> 1151=item B<keysym.>I<sym>: I<string>
1006 1152
1007Compile I<frills>: Associate I<string> with keysym I<sym>. The 1153Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008intervening resource name B<keysym.> cannot be omitted. 1154intervening resource name B<keysym.> cannot be omitted.
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1168searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1169omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1170keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025performed in an exact manner; however, the closest match is assured. 1171performed in an exact manner; however, the closest match is assured.
1026 1172
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1173I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1174number), see RESOURCES in C<man 7 X> for futher details.
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace.
1032
1033Please note that you need to double the C<\> in resource files, as
1034Xlib itself does its own de-escaping (you can use C<\033> instead of
1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036processing).
1037 1175
1038You can define a range of keysyms in one shot by providing a I<string> 1176You can define a range of keysyms in one shot by providing a I<string>
1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040should be a character not used by the strings. 1178should be a character not used by the strings.
1041 1179
1055when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1056 1194
1057 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1195 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1058 1196
1059If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1197If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1060is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1198is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1061manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1062C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063 1201
1064 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1065 1203
1123all instances, while B<perl-ext> is used for specific instances. 1261all instances, while B<perl-ext> is used for specific instances.
1124 1262
1125=item B<perl-eval>: I<string> 1263=item B<perl-eval>: I<string>
1126 1264
1127Perl code to be evaluated when all extensions have been registered. See 1265Perl code to be evaluated when all extensions have been registered. See
1128the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1266the @@RXVT_NAME@@perl(3) manpage.
1129will be ignored when running setuid/setgid.
1130 1267
1131=item B<perl-lib>: I<path> 1268=item B<perl-lib>: I<path>
1132 1269
1133Colon-separated list of additional directories that hold extension 1270Colon-separated list of additional directories that hold extension
1134scripts. When looking for extensions specified by the C<perl> resource, 1271scripts. When looking for extensions specified by the C<perl> resource,
1135@@RXVT_NAME@@ will first look in these directories and then in 1272@@RXVT_NAME@@ will first look in these directories and then in
1136F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1273F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1137will be ignored when running setuid/setgid.
1138 1274
1139See the @@RXVT_NAME@@perl(3) manpage. 1275See the @@RXVT_NAME@@perl(3) manpage.
1140 1276
1141=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1277=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142 1278
1154(default: C<M-s>). 1290(default: C<M-s>).
1155 1291
1156=item B<urlLauncher>: I<string> 1292=item B<urlLauncher>: I<string>
1157 1293
1158Specifies the program to be started with a URL argument. Used by the 1294Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions. 1295C<selection-popup> and C<matcher> perl extensions.
1160 1296
1161=item B<transient-for>: I<windowid> 1297=item B<transient-for>: I<windowid>
1162 1298
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1299Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164 1300
1165=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1166 1302
1167Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1168it almost invisible to window managers; option B<-override-redirect>. 1304it almost invisible to window managers; option B<-override-redirect>.
1305
1306=item B<iso14755:> I<boolean>
1307
1308Turn on/off ISO 14755 (default enabled).
1309
1310=item B<iso14755_52:> I<boolean>
1311
1312Turn on/off ISO 14755 5.2 mode (default enabled).
1169 1313
1170=back 1314=back
1171 1315
1172=head1 THE SCROLLBAR 1316=head1 THE SCROLLBAR
1173 1317
1192application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1336application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1337(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1338up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195respectively. 1339respectively.
1196 1340
1197=head1 TEXT SELECTION AND INSERTION 1341=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198 1342
1199The behaviour of text selection and insertion mechanism is similar to 1343The behaviour of text selection and insertion/pasting mechanism is similar
1200I<xterm>(1). 1344to I<xterm>(1).
1201 1345
1202=over 4 1346=over 4
1203 1347
1204=item B<Selection>: 1348=item B<Selecting>:
1205 1349
1206Left click at the beginning of the region, drag to the end of the region 1350Left click at the beginning of the region, drag to the end of the region
1207and release; Right click to extend the marked region; Left double-click 1351and release; Right click to extend the marked region; Left double-click
1208to select a word; Left triple-click to select the entire logical line 1352to select a word; Left triple-click to select the entire logical line
1209(which can span multiple screen lines), unless modified by resource 1353(which can span multiple screen lines), unless modified by resource
1213(Compile: I<frills>) will create a rectangular selection instead of a 1357(Compile: I<frills>) will create a rectangular selection instead of a
1214normal one. In this mode, every selected row becomes its own line in the 1358normal one. In this mode, every selected row becomes its own line in the
1215selection, and trailing whitespace is visually underlined and removed from 1359selection, and trailing whitespace is visually underlined and removed from
1216the selection. 1360the selection.
1217 1361
1218=item B<Insertion>: 1362=item B<Pasting>:
1219 1363
1220Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1364Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221window causes the value of the PRIMARY selection (or CLIPBOARD with the 1365window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222Meta modifier) to be inserted as if it had been typed on the keyboard. 1366B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223 1367
1224Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1368Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225inserted too. 1369inserted too.
1226 1370
1227=back 1371=back
1244 1388
1245=head1 ISO 14755 SUPPORT 1389=head1 ISO 14755 SUPPORT
1246 1390
1247ISO 14755 is a standard for entering and viewing unicode characters 1391ISO 14755 is a standard for entering and viewing unicode characters
1248and character codes using the keyboard. It consists of 4 parts. The 1392and character codes using the keyboard. It consists of 4 parts. The
1249first part is available rxvt-unicode has been compiled with 1393first part is available if rxvt-unicode has been compiled with
1250C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1394C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251with C<--enable-iso14755>. 1395with C<--enable-iso14755>.
1252 1396
1253=over 4 1397=over 4
1254 1398
1361Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1362always swapping the foreground/background colours. This is in contrast to 1506always swapping the foreground/background colours. This is in contrast to
1363I<xterm>(1) where the colours are only swapped if they have not otherwise 1507I<xterm>(1) where the colours are only swapped if they have not otherwise
1364been specified. For example, 1508been specified. For example,
1365 1509
1366=over 4
1367
1368=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1510 @@RXVT_NAME@@ -fg Black -bg White -rv
1369 1511
1370would yield White on Black, while on I<xterm>(1) it would yield Black 1512would yield White on Black, while on I<xterm>(1) it would yield Black on
1371on White. 1513White.
1372
1373=back
1374 1514
1375=head2 ALPHA CHANNEL SUPPORT 1515=head2 ALPHA CHANNEL SUPPORT
1376 1516
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1518their act together, rxvt-unicode will do it's own alpha channel management:
1379(recommended, but B<MUST> have 4 digits/component) colour specifications, 1519
1380in addition to the ones provided by X, where the additional A component 1520You can prefix any color with an opaquenes percentage enclosed in
1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1522(0-100) that specifies the opacity of the color, where C<0> is completely
1523transparent and C<100> is completely opaque. For example, C<[50]red> is a
1524half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1525is the recommended format to specify transparency values, and works with
1526all ways to specify a colour.
1527
1528For complete control, rxvt-unicode also supports
1529C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1530specifications, where the additional C<aaaa> component specifies opacity
1381specifies opacity (alpha) values. The minimum value of C<0> is completely 1531(alpha) values. The minimum value of C<0000> is completely transparent,
1382transparent). You can also prefix any color with C<[a]>, where C<a> is on 1532while C<ffff> is completely opaque). The two example colours from
1383to four hex digits specifiying the opacity value. 1533earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1534C<rgba:0000/ff00/0000/f332>.
1384 1535
1385You probably need to specify B<"-depth 32">, too, and have the luck that 1536You probably need to specify B<"-depth 32">, too, to force a visual with
1386your X-server uses ARGB pixel layout, as X is far from just supporting 1537alpha channels, and have the luck that your X-server uses ARGB pixel
1387ARGB visuals out of the box, and rxvt-unicode just fudges around. 1538layout, as X is far from just supporting ARGB visuals out of the box, and
1539rxvt-unicode just fudges around.
1388 1540
1389For example, the following selects an almost completely transparent red 1541For example, the following selects an almost completely transparent black
1390background, and an almost opaque pink foreground: 1542background, and an almost opaque pink foreground:
1391 1543
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1544 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1393 1545
1394I<Please note that transparency of any kind if completely unsupported by 1546When not using a background image, then the interpretation of the
1395the author. Don't bug him with installation questions!> 1547alpha channel is up to your compositing manager (most interpret it as
1548transparency of course).
1549
1550When using a background pixmap or pseudo-transparency, then the background
1551colour will always behave as if it were completely transparent (so the
1552background image shows instead), regardless of how it was specified, while
1553other colours will either be transparent as specified (the background
1554image will show through) on servers supporting the RENDER extension, or
1555fully opaque on servers not supporting the RENDER EXTENSION.
1556
1557Please note that due to bugs in Xft, specifying alpha values might result
1558in garbage being displayed when the X-server does not support the RENDER
1559extension.
1396 1560
1397=head1 ENVIRONMENT 1561=head1 ENVIRONMENT
1398 1562
1399B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1563B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400 1564
1406resources or on the command line. 1570resources or on the command line.
1407 1571
1408=item B<COLORTERM> 1572=item B<COLORTERM>
1409 1573
1410Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1574Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411compiled with XPM support, and optionally with the added extension 1575compiled with background image support, and optionally with the added
1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1576extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1577screen.
1413 1578
1414=item B<COLORFGBG> 1579=item B<COLORFGBG>
1415 1580
1416Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1581Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1417the colour code used as default foreground/text colour (or the string 1582the colour code used as default foreground/text colour (or the string
1418C<default> to indicate that the default-colour escape sequence is to be 1583C<default> to indicate that the default-colour escape sequence is to be
1419used), C<bg> is the colour code used as default background colour (or the 1584used), C<bg> is the colour code used as default background colour (or the
1420string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1585string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1421was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1586was compiled with background image support. Libraries like C<ncurses>
1422(and do) use this information to optimize screen output. 1587and C<slang> can (and do) use this information to optimize screen output.
1423 1588
1424=item B<WINDOWID> 1589=item B<WINDOWID>
1425 1590
1426Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1591Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1427window, which usually has subwindows for the scrollbar, the terminal 1592window, which usually has subwindows for the scrollbar, the terminal
1433C<--with-terminfo=PATH>. 1598C<--with-terminfo=PATH>.
1434 1599
1435=item B<DISPLAY> 1600=item B<DISPLAY>
1436 1601
1437Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1602Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1438display in its child processes. 1603display in its child processes if C<-display> isn't used to override. It
1604defaults to C<:0> if it doesn't exist.
1439 1605
1440=item B<SHELL> 1606=item B<SHELL>
1441 1607
1442The shell to be used for command execution, defaults to C</bin/sh>. 1608The shell to be used for command execution, defaults to C</bin/sh>.
1443 1609
1518Project Coordinator (changes.txt 2.21a to 2.4.5) 1684Project Coordinator (changes.txt 2.21a to 2.4.5)
1519 1685
1520=item Geoff Wing L<< <gcw@pobox.com> >> 1686=item Geoff Wing L<< <gcw@pobox.com> >>
1521 1687
1522Rewrote screen display and text selection routines. 1688Rewrote screen display and text selection routines.
1523 1689
1524Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1690Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525 1691
1526=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1692=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1527 1693
1528Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1694Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines