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.150 by root, Fri Dec 7 16:14:26 2007 UTC vs.
Revision 1.191 by sf-exg, Thu Dec 9 14:19:39 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/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<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>
116 124
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118 126
119=item B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
120 128
121Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122 130
123B<-ip> is still accepted as an obsolete alias but will be removed in 131B<-ip> is still accepted as an obsolete alias but will be removed in
124future versions. 132future versions.
125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
128 133
129=item B<-fade> I<number> 134=item B<-fade> I<number>
130 135
131Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
132fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
137Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
138is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
139 144
140=item B<-tint> I<colour> 145=item B<-tint> I<colour>
141 146
142Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
143transparency is enabled with B<-tr>. This only works for 148resource I<tintColor>.
144non-tiled backgrounds, currently. See also the B<-sh> option that can be
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 149
154=item B<-sh> I<number> 150=item B<-sh> I<number>
155 151
156Darken (0 .. 100) or lighten (100 .. 200) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
157background image in addition to (or instead of) tinting it; 153A value of 100 means no shading; resource I<shading>.
158resource I<shading>.
159 154
160=item B<-blt> I<string> 155=item B<-blt> I<string>
161 156
162Specify background blending type. If background pixmap is specified 157Specify background blending type. If background pixmap is specified
163at the same time as transparency - such pixmap will be blended over 158at the same time as transparency - such pixmap will be blended over
164transparency image, using method specified. Supported values are : 159the transparent background, using the method specified. Supported values are:
165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
169 164
170=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
171 166
172Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
173background image. If single number is specified - both vertical and 168background. If a single number is specified - both vertical and
174horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
175radii to 1 and another to a large number creates interesting effects 170radii to 1 and another to a large number creates interesting effects
176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 171on some backgrounds. Maximum radius value is 128;
177resource I<blurRadius>. 172resource I<blurRadius>.
178 173
174=item B<-icon> I<file>
175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>.
179
179=item B<-bg> I<colour> 180=item B<-bg> I<colour>
180 181
181Window background colour; resource B<background>. 182Window background colour; resource B<background>.
182 183
183=item B<-fg> I<colour> 184=item B<-fg> I<colour>
184 185
185Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
186 187
187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
188 189
189Compile I<afterimage>: Specify image file for the background and also 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
190optionally specify its scaling with a geometry string. Note you may need to 191optionally specify its scaling with a geometry string. Note you may need to
191add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
192command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
193 194
194=item B<-cr> I<colour> 195=item B<-cr> I<colour>
242italic> >> characters are to be printed. See resource B<boldItalicFont> 243italic> >> characters are to be printed. See resource B<boldItalicFont>
243for details. 244for details.
244 245
245=item B<-is>|B<+is> 246=item B<-is>|B<+is>
246 247
247Compile I<font-styles>: Bold/Italic font styles imply high intensity 248Compile I<font-styles>: Bold/Blink font styles imply high intensity
248foreground/background (default). See resource B<intensityStyles> for 249foreground/background (default). See resource B<intensityStyles> for
249details. 250details.
250 251
251=item B<-name> I<name> 252=item B<-name> I<name>
252 253
270 271
271=item B<-sb>|B<+sb> 272=item B<-sb>|B<+sb>
272 273
273Turn on/off scrollbar; resource B<scrollBar>. 274Turn on/off scrollbar; resource B<scrollBar>.
274 275
276=item B<-sr>|B<+sr>
277
278Put scrollbar on right/left; resource B<scrollBar_right>.
279
280=item B<-st>|B<+st>
281
282Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
283resource B<scrollBar_floating>.
284
275=item B<-si>|B<+si> 285=item B<-si>|B<+si>
276 286
277Turn on/off scroll-to-bottom on TTY output inhibit; resource 287Turn on/off scroll-to-bottom on TTY output inhibit; resource
278B<scrollTtyOutput> has opposite effect. 288B<scrollTtyOutput> has opposite effect.
279 289
285=item B<-sw>|B<+sw> 295=item B<-sw>|B<+sw>
286 296
287Turn on/off scrolling with the scrollback buffer as new lines appear. 297Turn on/off scrolling with the scrollback buffer as new lines appear.
288This only takes effect if B<-si> is also given; resource 298This only takes effect if B<-si> is also given; resource
289B<scrollWithBuffer>. 299B<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 300
300=item B<-ptab>|B<+ptab> 301=item B<-ptab>|B<+ptab>
301 302
302If enabled (default), "Horizontal Tab" characters are being stored as 303If enabled (default), "Horizontal Tab" characters are being stored as
303actual wide characters in the screen buffer, which makes it possible to 304actual wide characters in the screen buffer, which makes it possible to
307 308
308=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
309 310
310Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
311 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
312=item B<-iconic> 317=item B<-iconic>
313 318
314Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
315Alternative form is B<-ic>. 320Alternative form is B<-ic>.
316 321
332 337
333=item B<-bl> 338=item B<-bl>
334 339
335Compile I<frills>: Set MWM hints to request a borderless window, i.e. 340Compile 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 341if honoured by the WM, the rxvt-unicode window will not have window
337decorations; resource B<borderLess>. 342decorations; resource B<borderLess>. If the window manager does not
343support MWM hints (e.g. kwin), enables override-redirect mode.
338 344
339=item B<-override-redirect> 345=item B<-override-redirect>
340 346
341Compile I<frills>: Sets override-redirect on the window; resource 347Compile I<frills>: Sets override-redirect on the window; resource
342B<override-redirect>. 348B<override-redirect>.
351=item B<-lsp> I<number> 357=item B<-lsp> I<number>
352 358
353Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
354the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
355B<lineSpace>. 361B<lineSpace>.
362
363=item B<-letsp> I<number>
364
365Compile I<frills>: Amount to adjust the computed character width by
366to control overall letter spacing. Negative values will tighten up the
367letter spacing, positive values will space letters out more. Useful to
368work around odd font metrics; resource B<letterSpace>.
356 369
357=item B<-tn> I<termname> 370=item B<-tn> I<termname>
358 371
359This option specifies the name of the terminal type to be set in the 372This option specifies the name of the terminal type to be set in the
360B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448will not immediately destroy its window when the program executed within 461will 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 462it exits. Instead, it will wait till it is being killed or closed by the
450user; resource B<hold>. 463user; resource B<hold>.
451 464
465=item B<-cd> I<path>
466
467Sets the working directory for the shell (or the command specified via
468B<-e>). The I<path> must be an absolute path and it must exist for
469@@RXVT_NAME@@ to start; resource B<chdir>.
470
452=item B<-xrm> I<string> 471=item B<-xrm> I<string>
453 472
454Works like the X Toolkit option of the same name, by adding the I<string> 473Works 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 474as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications. 475way take precedence over all other resource specifications.
503If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 522If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
504entries and will not tinker with pty/tty permissions - you have to do that 523entries and will not tinker with pty/tty permissions - you have to do that
505yourself if you want that. 524yourself if you want that.
506 525
507As an extremely special case, specifying C<-1> will completely suppress 526As an extremely special case, specifying C<-1> will completely suppress
508pty/tty operations. 527pty/tty operations, which is probably only useful in conjunction with some
528perl extension that manages the terminal.
509 529
510Here is a example in perl that illustrates how this option can be used (a 530Here is a example in perl that illustrates how this option can be used (a
511longer example is in F<doc/pty-fd>): 531longer example is in F<doc/pty-fd>):
512 532
513 use IO::Pty; 533 use IO::Pty;
527Comma-separated list of perl extension scripts to use (or not to use) in 547Comma-separated list of perl extension scripts to use (or not to use) in
528this terminal instance. See resource B<perl-ext> for details. 548this terminal instance. See resource B<perl-ext> for details.
529 549
530=back 550=back
531 551
532=head1 RESOURCES (available also as long-options) 552=head1 RESOURCES
533 553
534Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 554Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535options) compiled into your version. 555options) compiled into your version. All resources are also available as
556long-options.
536 557
537You can set and change the resources using X11 tools like B<xrdb>. Many 558You can set and change the resources using X11 tools like B<xrdb>. Many
538distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
539starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
562=item B<depth:> I<bitdepth> 583=item B<depth:> I<bitdepth>
563 584
564Compile I<xft>: Attempt to find a visual with the given bit depth; 585Compile I<xft>: Attempt to find a visual with the given bit depth;
565option B<-depth>. 586option B<-depth>.
566 587
588=item B<buffered:> I<boolean>
589
590Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
591On some card/driver combination enabling it slightly decreases
592performance, on most it greatly helps it. The slowdown is small, so it
593should normally be enabled.
594
567=item B<geometry:> I<geom> 595=item B<geometry:> I<geom>
568 596
569Create the window with the specified X window geometry [default 80x24]; 597Create the window with the specified X window geometry [default 80x24];
570option B<-geometry>. 598option B<-geometry>.
571 599
584Use the specified colour for the colour value I<n>, where 0-7 612Use the specified colour for the colour value I<n>, where 0-7
585corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
586high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
587colours. The canonical names are as follows: 0=black, 1=red, 2=green, 615colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5883=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6163=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
589names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
590 618
591Colours higher than 15 cannot be set using resources (yet), but can be 619Colours higher than 15 cannot be set using resources (yet), but can be
592changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
593 621
594Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 622Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
605=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
606 634
607Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
608foreground colour is the default. 636foreground colour is the default.
609 637
610=item B<colorRV:> I<colour>
611
612Use the specified colour as the background for reverse video characters
613when OPTION_HC is disabled (--disable-frills).
614
615=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
616 639
617If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
618itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
642
643=item B<highlightColor:> I<colour>
644
645If set, use the specified colour as the background for highlighted
646characters. If unset, use reverse video.
647
648=item B<highlightTextColor:> I<colour>
649
650If set and highlightColor is set, use the specified colour as the
651foreground for highlighted characters.
619 652
620=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
621 654
622Use the specified colour for the cursor. The default is to use the 655Use the specified colour for the cursor. The default is to use the
623foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
630 663
631=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
632 665
633B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
634option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
635B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636 669
637=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
638 671
639B<True>: specify that jump scrolling should be used. When receiving lots 672B<True>: specify that jump scrolling should be used. When receiving lots
640of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
656if the refresh is too fast for the human eye to read anything (or the 689if the refresh is too fast for the human eye to read anything (or the
657monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
658 691
659=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
660 693
661Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
662 695
663B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664future versions. 697future versions.
665 698
666I<Please address all transparency related issues to Sasha Vasko at
667sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
668
669=item B<fading:> I<number> 699=item B<fading:> I<number>
670 700
671Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
672 702
673=item B<fadeColor:> I<colour> 703=item B<fadeColor:> I<colour>
675Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
676colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
677 707
678=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
679 709
680Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
681B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
682 715
683=item B<shading:> I<number> 716=item B<shading:> I<number>
684 717
685Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
686in addition to tinting it; option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
687 720
688=item B<blendType:> I<string> 721=item B<blendType:> I<string>
689 722
690Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
691 724
692=item B<blurRadius:> I<number> 725=item B<blurRadius:> I<number>
693 726
694Apply Gaussian Blurr with the specified radius to the transparent 727Apply gaussian blur with the specified radius to the transparent
695background image; option B<-blr>. 728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
696 733
697=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
698 735
699Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
700 737
710 747
711=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
712 749
713Use the specified image file for the background and also 750Use the specified image file for the background and also
714optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify its scaling with a geometry string B<WxH+X+Y>,
715(default C<0x0+50+50>) in which B<"W" / "H"> specify the 752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
716horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
717centre (percent). A scale of 0 displays the image with tiling. A scale 754centre (percent). A scale of 0 displays the image with tiling.
718of 1 displays the image without any scaling. A scale of 2 to 9 specifies 755The maximum permitted scale is 1000.
719an integer number of images in that direction. No image will be magnified
720beyond 10 times its original size. The maximum permitted scale is 1000.
721Additional operations can be specified after colon B<:op1:op2...>. 756Additional operations can be specified after colon B<:op1:op2...>.
722Supported operations are: 757Supported operations are:
723 758
724 tile force background image to be tiled and not scaled. Equivalent to 0x0, 759 tile force background image to be tiled and not scaled. Equivalent to 0x0
725 propscale will scale image keeping proportions, 760 propscale will scale image keeping proportions
726 auto will scale image to match window size. Equivalent to 100x100; 761 auto will scale image to match window size. Equivalent to 100x100
727 hscale will scale image horizontally to the window size; 762 hscale will scale image horizontally to the window size
728 vscale will scale image vertically to the window size; 763 vscale will scale image vertically to the window size
729 scale will scale image to match window size; 764 scale will scale image to match window size
730 root will tile image as if it was a root window background, auto-adjusting 765 root will tile image as if it was a root window background, auto-adjusting
731 whenever terminal window moves. 766 whenever terminal window moves
732 767
733If used in conjunction with B<-tr> option, the specified pixmap will be 768If used in conjunction with B<-tr> option, the specified pixmap will be
734blended over transparency image using either alpha-blending, or any 769blended over the transparent background using alpha-blending. If I<afterimage>
735other blending type, specified with B<-blt "type"> option. 770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
736 772
737=item B<path:> I<path> 773=item B<path:> I<path>
738 774
739Specify the colon-delimited search path for finding background image files. 775Specify the colon-delimited search path for finding background image files.
740 776
767it is named first) and thus defines the character cell grid to be 9 pixels 803it is named first) and thus defines the character cell grid to be 9 pixels
768wide and 15 pixels high. 804wide and 15 pixels high.
769 805
770The second font is just used to add additional unicode characters not in 806The second font is just used to add additional unicode characters not in
771the base font, likewise the third, which is unfortunately non-bold, but 807the base font, likewise the third, which is unfortunately non-bold, but
772the bold version of the font does contain less characters, so this is a 808the bold version of the font does contain fewer characters, so this is a
773useful supplement. 809useful supplement.
774 810
775The third font is an Xft font with aliasing turned off, and the characters 811The third font is an Xft font with aliasing turned off, and the characters
776are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 812are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
777contains other characters, but we are not interested in them. 813contains other characters, but we are not interested in them.
801text font will being used for the given style. 837text font will being used for the given style.
802 838
803=item B<intensityStyles:> I<boolean> 839=item B<intensityStyles:> I<boolean>
804 840
805When font styles are not enabled, or this option is enabled (B<True>, 841When font styles are not enabled, or this option is enabled (B<True>,
806option B<-is>, the default), bold and italic font styles imply high 842option B<-is>, the default), bold/blink font styles imply high
807intensity foreground/background colours. Disabling this option (B<False>, 843intensity foreground/background colours. Disabling this option (B<False>,
808option B<+is>) disables this behaviour, the high intensity colours are not 844option B<+is>) disables this behaviour, the high intensity colours are not
809reachable. 845reachable.
810 846
811=item B<selectstyle:> I<mode>
812
813Set mouse selection style to B<old> which is 2.20, B<oldword> which
814is xterm style with 2.20 old word selection, or anything else which
815gives xterm style selection. Only effective when the original (non-perl)
816selection code is in use.
817
818=item B<scrollstyle:> I<mode>
819
820Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
821the author's favourite.
822
823=item B<title:> I<string> 847=item B<title:> I<string>
824 848
825Set window title string, the default title is the command-line 849Set window title string, the default title is the command-line
826specified after the B<-e> option, if any, otherwise the application 850specified after the B<-e> option, if any, otherwise the application
827name; option B<-title>. 851name; option B<-title>.
840=item B<urgentOnBell:> I<boolean> 864=item B<urgentOnBell:> I<boolean>
841 865
842B<True>: set the urgency hint for the wm on receipt of a bell character. 866B<True>: set the urgency hint for the wm on receipt of a bell character.
843B<False>: do not set the urgency hint [default]. 867B<False>: do not set the urgency hint [default].
844 868
869@@RXVT_NAME@@ resets the urgency hint on every focus change.
870
845=item B<visualBell:> I<boolean> 871=item B<visualBell:> I<boolean>
846 872
847B<True>: use visual bell on receipt of a bell character; option B<-vb>. 873B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848B<False>: no visual bell [default]; option B<+vb>. 874B<False>: no visual bell [default]; option B<+vb>.
849 875
871 897
872 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 898 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873 899
874This creates a new file in your home directory with the screen contents 900This creates a new file in your home directory with the screen contents
875every time you hit C<Print>. 901every time you hit C<Print>.
902
903=item B<scrollstyle:> I<mode>
904
905Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
906the author's favourite.
876 907
877=item B<scrollBar:> I<boolean> 908=item B<scrollBar:> I<boolean>
878 909
879B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 910B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880disable the scrollbar; option B<+sb>. 911disable the scrollbar; option B<+sb>.
968=item B<cursorBlink:> I<boolean> 999=item B<cursorBlink:> I<boolean>
969 1000
970B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1001B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971option B<-bc>. 1002option B<-bc>.
972 1003
1004=item B<cursorUnderline:> I<boolean>
1005
1006B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1007option B<-uc>.
1008
973=item B<pointerBlank:> I<boolean> 1009=item B<pointerBlank:> I<boolean>
974 1010
975B<True>: blank the pointer when a key is pressed or after a set number 1011B<True>: blank the pointer when a key is pressed or after a set number
976of seconds of inactivity. B<False>: the pointer is always visible 1012of seconds of inactivity. B<False>: the pointer is always visible
977[default]. 1013[default].
990large number (e.g. C<987654321>) to effectively disable the timeout. 1026large number (e.g. C<987654321>) to effectively disable the timeout.
991 1027
992=item B<backspacekey:> I<string> 1028=item B<backspacekey:> I<string>
993 1029
994The string to send when the backspace key is pressed. If set to B<DEC> 1030The string to send when the backspace key is pressed. If set to B<DEC>
995or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1031or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
996(code 8) - which can be reversed with the appropriate DEC private mode 1032(code 8) - which can be reversed with the appropriate DEC private mode
997escape sequence. 1033escape sequence.
998 1034
999=item B<deletekey:> I<string> 1035=item B<deletekey:> I<string>
1000 1036
1079 1115
1080=item B<secondaryScroll:> I<boolean> 1116=item B<secondaryScroll:> I<boolean>
1081 1117
1082Turn on/off secondary screen scroll (default enabled). If this 1118Turn on/off secondary screen scroll (default enabled). If this
1083option is enabled, scrolls on the secondary screen will change the 1119option is enabled, scrolls on the secondary screen will change the
1084scrollback buffer and switching to/from the secondary screen will 1120scrollback buffer and, when secondaryScreen is off, switching
1085instead scroll the screen up. 1121to/from the secondary screen will instead scroll the screen up.
1086 1122
1087=item B<hold>: I<boolean> 1123=item B<hold>: I<boolean>
1088 1124
1089Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1125Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090will not immediately destroy its window when the program executed within 1126will not immediately destroy its window when the program executed within
1091it exits. Instead, it will wait till it is being killed or closed by the 1127it exits. Instead, it will wait till it is being killed or closed by the
1092user. 1128user.
1129
1130=item B<chdir>: I<path>
1131
1132Sets the working directory for the shell (or the command specified via
1133B<-e>). The I<path> must be an absolute path and it must exist for
1134@@RXVT_NAME@@ to start. If it isn't specified then the current working
1135directory will be used; option B<-cd>.
1093 1136
1094=item B<keysym.>I<sym>: I<string> 1137=item B<keysym.>I<sym>: I<string>
1095 1138
1096Compile I<frills>: Associate I<string> with keysym I<sym>. The 1139Compile I<frills>: Associate I<string> with keysym I<sym>. The
1097intervening resource name B<keysym.> cannot be omitted. 1140intervening resource name B<keysym.> cannot be omitted.
1112omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1155omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1113keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1156keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1114performed in an exact manner; however, the closest match is assured. 1157performed in an exact manner; however, the closest match is assured.
1115 1158
1116I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1117number), see RESOURCES in C<man 7 X> for futher details. 1160number), see RESOURCES in C<man 7 X> for further details.
1118 1161
1119You can define a range of keysyms in one shot by providing a I<string> 1162You can define a range of keysyms in one shot by providing a I<string>
1120with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1121should be a character not used by the strings. 1164should be a character not used by the strings.
1122 1165
1136when Control-Meta-c is being pressed": 1179when Control-Meta-c is being pressed":
1137 1180
1138 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1181 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139 1182
1140If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1183If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1141is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1184is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1142manpage. For example, the F<selection> extension (activated via 1185manpage. For example, the F<selection> extension (activated via
1143C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144 1187
1145 URxvt.keysym.M-C-c: perl:selection:rot13 1188 URxvt.keysym.M-C-c: perl:selection:rot13
1146 1189
1147Due the the large number of modifier combinations, a defined key mapping 1190Due the the large number of modifier combinations, a defined key mapping
1148will match if at I<at least> the specified identifiers are being set, and 1191will match if I<at least> the specified identifiers are being set, and
1149no other key mappings with those and more bits are being defined. That 1192no other key mappings with those and more bits are being defined. That
1150means that defining a key map for C<a> will automatically provide 1193means that defining a key map for C<a> will automatically provide
1151definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1152mappings themselves. 1195mappings themselves.
1153 1196
1204all instances, while B<perl-ext> is used for specific instances. 1247all instances, while B<perl-ext> is used for specific instances.
1205 1248
1206=item B<perl-eval>: I<string> 1249=item B<perl-eval>: I<string>
1207 1250
1208Perl code to be evaluated when all extensions have been registered. See 1251Perl code to be evaluated when all extensions have been registered. See
1209the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1252the @@RXVT_NAME@@perl(3) manpage.
1210will be ignored when running setuid/setgid.
1211 1253
1212=item B<perl-lib>: I<path> 1254=item B<perl-lib>: I<path>
1213 1255
1214Colon-separated list of additional directories that hold extension 1256Colon-separated list of additional directories that hold extension
1215scripts. When looking for extensions specified by the C<perl> resource, 1257scripts. When looking for extensions specified by the C<perl> resource,
1216@@RXVT_NAME@@ will first look in these directories and then in 1258@@RXVT_NAME@@ will first look in these directories and then in
1217F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1259F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218will be ignored when running setuid/setgid.
1219 1260
1220See the @@RXVT_NAME@@perl(3) manpage. 1261See the @@RXVT_NAME@@perl(3) manpage.
1221 1262
1222=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1263=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223 1264
1245 1286
1246=item B<override-redirect>: I<boolean> 1287=item B<override-redirect>: I<boolean>
1247 1288
1248Compile I<frills>: Sets override-redirect for the terminal window, making 1289Compile I<frills>: Sets override-redirect for the terminal window, making
1249it almost invisible to window managers; option B<-override-redirect>. 1290it almost invisible to window managers; option B<-override-redirect>.
1291
1292=item B<iso14755:> I<boolean>
1293
1294Turn on/off ISO 14755 (default enabled).
1250 1295
1251=item B<iso14755_52:> I<boolean> 1296=item B<iso14755_52:> I<boolean>
1252 1297
1253Turn on/off ISO 14755 5.2 mode (default enabled). 1298Turn on/off ISO 14755 5.2 mode (default enabled).
1254 1299
1397B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1442B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1398it can be seen via the I<who(1)> command, and can accept messages. To 1443it can be seen via the I<who(1)> command, and can accept messages. To
1399allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1444allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1400on some systems or setgid to root or to some other group on others. 1445on some systems or setgid to root or to some other group on others.
1401 1446
1402=head1 COLORS AND GRAPHICS 1447=head1 COLOURS AND GRAPHICS
1403 1448
1404In addition to the default foreground and background colours, 1449In addition to the default foreground and background colours,
1405B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1450B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1406high-intensity bold/blink versions of the same). Here is a list of the 1451high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407colours with their names. 1452240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1453cube plus a 8 (24) colour greyscale ramp.
1454
1455Here is a list of the ANSI colours with their names.
1408 1456
1409=begin table 1457=begin table
1410 1458
1411 B<color0> (black) = Black 1459 B<color0> (black) = Black
1412 B<color1> (red) = Red3 1460 B<color1> (red) = Red3
1432It is also possible to specify the colour values of B<foreground>, 1480It is also possible to specify the colour values of B<foreground>,
1433B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1481B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1434a number 0-15, as a convenient shorthand to reference the colour name of 1482a number 0-15, as a convenient shorthand to reference the colour name of
1435color0-color15. 1483color0-color15.
1436 1484
1437In addition to the colours defined above, @@RXVT_NAME@@ offers an 1485The following text gives values for the standard 88 colour mode (and
1438additional 72 colours. The first 64 of those (with indices 16 to 79) 1486values for the 256 colour mode in parentheses).
1439consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144016>), followed by 8 additional shades of gray (with indices 80 to 87).
1441 1487
1488The RGB cube uses indices 16..79 (16..231) using the following formulas:
1489
1490 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1491 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1492
1493The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1494steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1495the RGB cube.
1496
1442Together, all those colours implement the 88 colour xterm colours. Only 1497Together, all those colours implement the 88 (256) colour xterm
1443the first 16 can be changed using resources currently, the rest can only 1498colours. Only the first 16 can be changed using resources currently, the
1444be changed via command sequences ("escape codes"). 1499rest can only be changed via command sequences ("escape codes").
1500
1501Applications are advised to use terminfo or command sequences to discover
1502number and RGB values of all colours (yes, you can query this...).
1445 1503
1446Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1504Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447always swapping the foreground/background colours. This is in contrast to 1505always swapping the foreground/background colours. This is in contrast to
1448I<xterm>(1) where the colours are only swapped if they have not otherwise 1506I<xterm>(1) where the colours are only swapped if they have not otherwise
1449been specified. For example, 1507been specified. For example,
1450 1508
1451=over 4
1452
1453=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1509 @@RXVT_NAME@@ -fg Black -bg White -rv
1454 1510
1455would yield White on Black, while on I<xterm>(1) it would yield Black 1511would yield White on Black, while on I<xterm>(1) it would yield Black on
1456on White. 1512White.
1457
1458=back
1459 1513
1460=head2 ALPHA CHANNEL SUPPORT 1514=head2 ALPHA CHANNEL SUPPORT
1461 1515
1462If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1516If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1517their act together, rxvt-unicode will do it's own alpha channel management:
1464(recommended, but B<MUST> have 4 digits/component) colour specifications, 1518
1465in addition to the ones provided by X, where the additional A component 1519You can prefix any colour with an opaqueness percentage enclosed in
1520brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1521(0-100) that specifies the opacity of the colour, where C<0> is completely
1522transparent and C<100> is completely opaque. For example, C<[50]red> is a
1523half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1524is the recommended format to specify transparency values, and works with
1525all ways to specify a colour.
1526
1527For complete control, rxvt-unicode also supports
1528C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1529specifications, where the additional C<aaaa> component specifies opacity
1466specifies opacity (alpha) values. The minimum value of C<0> is completely 1530(alpha) values. The minimum value of C<0000> is completely transparent,
1467transparent). You can also prefix any color with C<[percent]>, where 1531while C<ffff> is completely opaque). The two example colours from
1468C<percent> is a decimal percentage (0-100) that specifies the opacity of 1532earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1469the color, where C<0> is completely transparent and C<100> is completelxy 1533C<rgba:0000/ff00/0000/f332>.
1470opaque.
1471 1534
1472You probably need to specify B<"-depth 32">, too, and have the luck that 1535You probably need to specify B<"-depth 32">, too, to force a visual with
1473your X-server uses ARGB pixel layout, as X is far from just supporting 1536alpha channels, and have the luck that your X-server uses ARGB pixel
1474ARGB visuals out of the box, and rxvt-unicode just fudges around. 1537layout, as X is far from just supporting ARGB visuals out of the box, and
1538rxvt-unicode just fudges around.
1475 1539
1476For example, the following selects an almost completely transparent red 1540For example, the following selects an almost completely transparent black
1477background, and an almost opaque pink foreground: 1541background, and an almost opaque pink foreground:
1478 1542
1479 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1543 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480 1544
1481I<Please note that transparency of any kind if completely unsupported by 1545When not using a background image, then the interpretation of the
1482the author. Don't bug him with installation questions!> 1546alpha channel is up to your compositing manager (most interpret it as
1547transparency of course).
1548
1549When using a background pixmap or pseudo-transparency, then the background
1550colour will always behave as if it were completely transparent (so the
1551background image shows instead), regardless of how it was specified, while
1552other colours will either be transparent as specified (the background
1553image will show through) on servers supporting the RENDER extension, or
1554fully opaque on servers not supporting the RENDER EXTENSION.
1555
1556Please note that due to bugs in Xft, specifying alpha values might result
1557in garbage being displayed when the X-server does not support the RENDER
1558extension.
1483 1559
1484=head1 ENVIRONMENT 1560=head1 ENVIRONMENT
1485 1561
1486B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1562B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487 1563
1521C<--with-terminfo=PATH>. 1597C<--with-terminfo=PATH>.
1522 1598
1523=item B<DISPLAY> 1599=item B<DISPLAY>
1524 1600
1525Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1601Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526display in its child processes. 1602display in its child processes if C<-display> isn't used to override. It
1603defaults to C<:0> if it doesn't exist.
1527 1604
1528=item B<SHELL> 1605=item B<SHELL>
1529 1606
1530The shell to be used for command execution, defaults to C</bin/sh>. 1607The shell to be used for command execution, defaults to C</bin/sh>.
1531 1608
1557 1634
1558=over 4 1635=over 4
1559 1636
1560=item B</usr/lib/X11/rgb.txt> 1637=item B</usr/lib/X11/rgb.txt>
1561 1638
1562Color names. 1639Colour names.
1563 1640
1564=back 1641=back
1565 1642
1566=head1 SEE ALSO 1643=head1 SEE ALSO
1567 1644
1618 1695
1619Project Coordinator (Changes 1.0 -) 1696Project Coordinator (Changes 1.0 -)
1620 1697
1621=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1698=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1622 1699
1623Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1700pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1624 1701
1625=back 1702=back
1626 1703

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines