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.137 by root, Sat Sep 1 09:38:50 2007 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 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
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devanagari. 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
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>
114 122
115=item B<-ss>|B<+ss> 123=item B<-ss>|B<+ss>
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<-ip>|B<+ip> | B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
120 128
121Turn on/off inheriting parent window's pixmap. Alternative form is 129Turn on/off illusion of a transparent window background; resource B<transparent>.
122B<-tr>; resource B<inheritPixmap>.
123 130
124I<Please note that transparency of any kind if completely unsupported by 131B<-ip> is still accepted as an obsolete alias but will be removed in
125the author. Don't bug him with installation questions! Read the FAQ (man 7 132future versions.
126@@RXVT_NAME@@)!> 133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
127 136
128=item B<-fade> I<number> 137=item B<-fade> I<number>
129 138
130Fade 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
131fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
137is opaque black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
138 147
139=item B<-tint> I<colour> 148=item B<-tint> I<colour>
140 149
141Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
142transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
143non-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
144used to brighten or darken the image in addition to tinting it. 153used to brighten or darken the image in addition to tinting it.
145Please note that certain tint colours can be applied on the server-side, 154Please note that certain tint colours can be applied on the server-side,
146thus yielding performance gain of two orders of magnitude. These colours are: 155thus yielding performance gain of two orders of magnitude. These colours are:
147blue, red, green, cyan, magenta, yellow, and those close to them; resource 156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
148I<tintColor>. Example: 158I<tintColor>. Example:
149 159
150 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
151 161
152=item B<-sh> I<number> 162=item B<-sh> I<number>
153 163
154Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
155background image in addition to (or instead of) tinting it; 165background image in addition to (or instead of) tinting it;
156resource I<shading>. 166resource I<shading>.
157 167
158=item B<-blt> I<string> 168=item B<-blt> I<string>
159 169
161at the same time as transparency - such pixmap will be blended over 171at the same time as transparency - such pixmap will be blended over
162transparency image, using method specified. Supported values are : 172transparency image, using method specified. Supported values are :
163B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166alpha-blending; resource I<blendType>. 176alpha-blending. Compile I<afterimage>; resource I<blendType>.
167 177
168=item B<-blr> I<HxV> 178=item B<-blr> I<HxV>
169 179
170Apply Gaussian Blur with the specified radii to the transparent 180Apply Gaussian Blur with the specified radii to the transparent
171background image. If single number is specified - both vertical and 181background image. If single number is specified - both vertical and
172horizontal radii are considered to be the same. Setting one of the 182horizontal radii are considered to be the same. Setting one of the
173radii to 1 and another to a large number creates interesting effects 183radii to 1 and another to a large number creates interesting effects
174on some backgrounds. Maximum radius value is 128; resource I<blurRadius>. 184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
175 186
176=item B<-bg> I<colour> 187=item B<-bg> I<colour>
177 188
178Window background colour; resource B<background>. 189Window background colour; resource B<background>.
179 190
180=item B<-fg> I<colour> 191=item B<-fg> I<colour>
181 192
182Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
183 194
184=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
185 196
186Compile I<afterimage>: Specify image file for the background and also 197Compile I<afterimage>: Specify image file for the background and also
187optionally specify its scaling with a geometry string. Note you may need to 198optionally specify its scaling with a geometry string. Note you may need to
188add quotes to avoid special shell interpretation of the C<;> in the 199add quotes to avoid special shell interpretation of the C<;> in the
189command-line; for more details see resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
190 201
191=item B<-cr> I<colour> 202=item B<-cr> I<colour>
239italic> >> characters are to be printed. See resource B<boldItalicFont> 250italic> >> characters are to be printed. See resource B<boldItalicFont>
240for details. 251for details.
241 252
242=item B<-is>|B<+is> 253=item B<-is>|B<+is>
243 254
244Compile I<font-styles>: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
245foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
246details. 257details.
247 258
248=item B<-name> I<name> 259=item B<-name> I<name>
249 260
267 278
268=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
269 280
270Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
271 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
272=item B<-si>|B<+si> 292=item B<-si>|B<+si>
273 293
274Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
275B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
276 296
282=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
283 303
284Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
285This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
286B<scrollWithBuffer>. 306B<scrollWithBuffer>.
287
288=item B<-sr>|B<+sr>
289
290Put scrollbar on right/left; resource B<scrollBar_right>.
291
292=item B<-st>|B<+st>
293
294Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
295resource B<scrollBar_floating>.
296 307
297=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
298 309
299If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
300actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
412 423
413=item B<-tcw> 424=item B<-tcw>
414 425
415Change the meaning of triple-click selection with the left mouse 426Change the meaning of triple-click selection with the left mouse
416button. Only effective when the original (non-perl) selection code is 427button. Only effective when the original (non-perl) selection code is
417in-use. Instead of selecting a full line it will extend the selection the 428in-use. Instead of selecting a full line it will extend the selection to
418end of the logical line only. resource B<tripleclickwords>. 429the end of the logical line only. resource B<tripleclickwords>.
419 430
420=item B<-insecure> 431=item B<-insecure>
421 432
422Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
423sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
443 454
444Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
445will not immediately destroy its window when the program executed within 456will not immediately destroy its window when the program executed within
446it exits. Instead, it will wait till it is being killed or closed by the 457it exits. Instead, it will wait till it is being killed or closed by the
447user; resource B<hold>. 458user; resource B<hold>.
459
460=item B<-xrm> I<string>
461
462Works like the X Toolkit option of the same name, by adding the I<string>
463as if it were specified in a resource file. Resource values specified this
464way take precedence over all other resource specifications.
465
466Note that you need to use the I<same> syntax as in the .Xdefaults file,
467e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
468options can be specified as long-options on the commandline, so use
469of B<-xrm> is mostly limited to cases where you want to specify other
470resources (e.g. for input methods) or for compatibility with other
471programs.
448 472
449=item B<-keysym.>I<sym> I<string> 473=item B<-keysym.>I<sym> I<string>
450 474
451Remap a key symbol. See resource B<keysym>. 475Remap a key symbol. See resource B<keysym>.
452 476
487If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 511If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
488entries and will not tinker with pty/tty permissions - you have to do that 512entries and will not tinker with pty/tty permissions - you have to do that
489yourself if you want that. 513yourself if you want that.
490 514
491As an extremely special case, specifying C<-1> will completely suppress 515As an extremely special case, specifying C<-1> will completely suppress
492pty/tty operations. 516pty/tty operations, which is probably only useful in conjunction with some
517perl extension that manages the terminal.
493 518
494Here is a example in perl that illustrates how this option can be used (a 519Here is a example in perl that illustrates how this option can be used (a
495longer example is in F<doc/pty-fd>): 520longer example is in F<doc/pty-fd>):
496 521
497 use IO::Pty; 522 use IO::Pty;
511Comma-separated list of perl extension scripts to use (or not to use) in 536Comma-separated list of perl extension scripts to use (or not to use) in
512this terminal instance. See resource B<perl-ext> for details. 537this terminal instance. See resource B<perl-ext> for details.
513 538
514=back 539=back
515 540
516=head1 RESOURCES (available also as long-options) 541=head1 RESOURCES
517 542
518Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 543Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
519options) compiled into your version. 544options) compiled into your version. All resources are also available as
545long-options.
520 546
521You can set and change the resources using X11 tools like B<xrdb>. Many 547You can set and change the resources using X11 tools like B<xrdb>. Many
522distribution do also load settings from the B<~/.Xresources> file when X 548distribution do also load settings from the B<~/.Xresources> file when X
523starts. @@RXVT_NAME@@ will consult the following files/resources in order, 549starts. @@RXVT_NAME@@ will consult the following files/resources in order,
524with later settings overwriting earlier ones: 550with later settings overwriting earlier ones:
526 1. system-wide app-defaults file, either locale-dependent OR global 552 1. system-wide app-defaults file, either locale-dependent OR global
527 2. app-defaults file in $XAPPLRESDIR 553 2. app-defaults file in $XAPPLRESDIR
528 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
529 4. SCREEN_RESOURCES for the current screen 555 4. SCREEN_RESOURCES for the current screen
530 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline
531 558
532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
534common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 561common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
535configured, while the class name B<URxvt> allows resources unique to 562configured, while the class name B<URxvt> allows resources unique to
545=item B<depth:> I<bitdepth> 572=item B<depth:> I<bitdepth>
546 573
547Compile I<xft>: Attempt to find a visual with the given bit depth; 574Compile I<xft>: Attempt to find a visual with the given bit depth;
548option B<-depth>. 575option B<-depth>.
549 576
577=item B<buffered:> I<boolean>
578
579Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
580On some card/driver combination enabling it slightly decreases
581performance, on most it greatly helps it. The slowdown is small, so it
582should normally be enabled.
583
550=item B<geometry:> I<geom> 584=item B<geometry:> I<geom>
551 585
552Create the window with the specified X window geometry [default 80x24]; 586Create the window with the specified X window geometry [default 80x24];
553option B<-geometry>. 587option B<-geometry>.
554 588
637 671
638B<False>: specify that everything is to be displayed, even 672B<False>: specify that everything is to be displayed, even
639if the refresh is too fast for the human eye to read anything (or the 673if the refresh is too fast for the human eye to read anything (or the
640monitor to display anything); option B<+ss>. 674monitor to display anything); option B<+ss>.
641 675
642=item B<inheritPixmap:> I<boolean> 676=item B<transparent:> I<boolean>
643 677
644B<True>: make the background inherit the parent windows' pixmap, giving 678Turn on/off illusion of a transparent window background.
645artificial transparency. B<False>: do not inherit the parent windows'
646pixmap.
647 679
648I<Please note that transparency of any kind if completely unsupported by 680B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
649the author. Don't bug him with installation questions!> 681future versions.
682
683I<Please address all transparency related issues to Sasha Vasko at
684sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
650 685
651=item B<fading:> I<number> 686=item B<fading:> I<number>
652 687
653Fade the text by the given percentage when focus is lost; option B<-fade>. 688Fade the text by the given percentage when focus is lost; option B<-fade>.
654 689
671 706
672Specify background blending type; option B<-blt>. 707Specify background blending type; option B<-blt>.
673 708
674=item B<blurRadius:> I<number> 709=item B<blurRadius:> I<number>
675 710
676Apply Gaussian Blurr with the specified radius to the transparent 711Apply Gaussian Blurr with the specified radius to the transparent
677background image; option B<-blr>. 712background image; option B<-blr>.
678 713
679=item B<scrollColor:> I<colour> 714=item B<scrollColor:> I<colour>
680 715
681Use the specified colour for the scrollbar [default #B2B2B2]. 716Use the specified colour for the scrollbar [default #B2B2B2].
688=item B<borderColor:> I<colour> 723=item B<borderColor:> I<colour>
689 724
690The colour of the border around the text area and between the scrollbar 725The colour of the border around the text area and between the scrollbar
691and the text. 726and the text.
692 727
693=item B<backgroundPixmap:> I<file[;geom]> 728=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
694 729
695Use the specified image file for the background and also optionally 730Use the specified image file for the background and also
696specify its scaling with a geometry string B<WxH+X+Y>, 731optionally specify its scaling with a geometry string B<WxH+X+Y>,
697in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 732(default C<0x0+50+50>) in which B<"W" / "H"> specify the
698and B<"X" / "Y"> locate the image centre (percent). 733horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
699A scale of 0 displays the image with tiling. A scale of 1 displays the 734centre (percent). A scale of 0 displays the image with tiling. A scale
700image without any scaling. A scale of 2 to 9 specifies an integer 735of 1 displays the image without any scaling. A scale of 2 to 9 specifies
701number of images in that direction. No image will be magnified beyond 736an integer number of images in that direction. No image will be magnified
70210 times its original size. The maximum permitted scale is 1000. 737beyond 10 times its original size. The maximum permitted scale is 1000.
703Special string of B<"auto"> used as a geometry will cause image to be 738Additional operations can be specified after colon B<:op1:op2...>.
704automatically scaled to match window size. 739Supported operations are:
740
741 tile force background image to be tiled and not scaled. Equivalent to 0x0
742 propscale will scale image keeping proportions
743 auto will scale image to match window size. Equivalent to 100x100
744 hscale will scale image horizontally to the window size
745 vscale will scale image vertically to the window size
746 scale will scale image to match window size
747 root will tile image as if it was a root window background, auto-adjusting
748 whenever terminal window moves
749
705If used in conjunction with B<-tr> option - specified pixmap will be 750If used in conjunction with B<-tr> option, the specified pixmap will be
706blended over transparency image using either alpha-blending, or any 751blended over transparency image using either alpha-blending, or any
707other blending type, specified with B<-blt "type"> option. 752other blending type, specified with B<-blt "type"> option.
708[default 0x0+50+50]
709 753
710=item B<path:> I<path> 754=item B<path:> I<path>
711 755
712Specify the colon-delimited search path for finding XPM files. 756Specify the colon-delimited search path for finding background image files.
713 757
714=item B<font:> I<fontlist> 758=item B<font:> I<fontlist>
715 759
716Select the fonts to be used. This is a comma separated list of font names 760Select the fonts to be used. This is a comma separated list of font names
717that are checked in order when trying to find glyphs for characters. The 761that are checked in order when trying to find glyphs for characters. The
774text font will being used for the given style. 818text font will being used for the given style.
775 819
776=item B<intensityStyles:> I<boolean> 820=item B<intensityStyles:> I<boolean>
777 821
778When font styles are not enabled, or this option is enabled (B<True>, 822When font styles are not enabled, or this option is enabled (B<True>,
779option B<-is>, the default), bold and italic font styles imply high 823option B<-is>, the default), bold/blink font styles imply high
780intensity foreground/background colours. Disabling this option (B<False>, 824intensity foreground/background colours. Disabling this option (B<False>,
781option B<+is>) disables this behaviour, the high intensity colours are not 825option B<+is>) disables this behaviour, the high intensity colours are not
782reachable. 826reachable.
783 827
784=item B<selectstyle:> I<mode>
785
786Set mouse selection style to B<old> which is 2.20, B<oldword> which
787is xterm style with 2.20 old word selection, or anything else which
788gives xterm style selection. Only effective when the original (non-perl)
789selection code is in use.
790
791=item B<scrollstyle:> I<mode>
792
793Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
794the author's favourite.
795
796=item B<title:> I<string> 828=item B<title:> I<string>
797 829
798Set window title string, the default title is the command-line 830Set window title string, the default title is the command-line
799specified after the B<-e> option, if any, otherwise the application 831specified after the B<-e> option, if any, otherwise the application
800name; option B<-title>. 832name; option B<-title>.
844 876
845 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
846 878
847This creates a new file in your home directory with the screen contents 879This creates a new file in your home directory with the screen contents
848every time you hit C<Print>. 880every time you hit C<Print>.
881
882=item B<scrollstyle:> I<mode>
883
884Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885the author's favourite.
849 886
850=item B<scrollBar:> I<boolean> 887=item B<scrollBar:> I<boolean>
851 888
852B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
853disable the scrollbar; option B<+sb>. 890disable the scrollbar; option B<+sb>.
986will be created). In this mode, characters outside ISO-8859-1 can be used. 1023will be created). In this mode, characters outside ISO-8859-1 can be used.
987 1024
988When the selection extension is not used, only ISO-8859-1 characters can 1025When the selection extension is not used, only ISO-8859-1 characters can
989be used. If not specified, the built-in default is used: 1026be used. If not specified, the built-in default is used:
990 1027
991B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1028B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
992 1029
993=item B<preeditType:> I<style> 1030=item B<preeditType:> I<style>
994 1031
995B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1032B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
996 1033
1084searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1121searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1085omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1122omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1086keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1123keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1087performed in an exact manner; however, the closest match is assured. 1124performed in an exact manner; however, the closest match is assured.
1088 1125
1089I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1126I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1090C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1127number), see RESOURCES in C<man 7 X> for futher details.
1091C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1092C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1093can start or end with whitespace. B<This feature is deprecated and will
1094be removed>.
1095
1096Please note that you need to double the C<\> in resource files, as
1097Xlib itself does its own de-escaping (you can use C<\033> instead of
1098C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1099processing).
1100 1128
1101You can define a range of keysyms in one shot by providing a I<string> 1129You can define a range of keysyms in one shot by providing a I<string>
1102with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1130with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1103should be a character not used by the strings. 1131should be a character not used by the strings.
1104 1132
1440=back 1468=back
1441 1469
1442=head2 ALPHA CHANNEL SUPPORT 1470=head2 ALPHA CHANNEL SUPPORT
1443 1471
1444If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1445their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1473their act together, rxvt-unicode will do it's own alpha channel management:
1446(recommended, but B<MUST> have 4 digits/component) colour specifications, 1474
1447in addition to the ones provided by X, where the additional A component 1475You can prefix any color with an opaquenes percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477(0-100) that specifies the opacity of the color, where C<0> is completely
1478transparent and C<100> is completely opaque. For example, C<[50]red> is a
1479half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with
1481all ways to specify a colour.
1482
1483For complete control, rxvt-unicode also supports
1484C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1485specifications, where the additional C<aaaa> component specifies opacity
1448specifies opacity (alpha) values. The minimum value of C<0> is completely 1486(alpha) values. The minimum value of C<0000> is completely transparent,
1449transparent). You can also prefix any color with C<[percent]>, where 1487while C<ffff> is completely opaque). The two example colours from
1450C<percent> is a decimal percentage (0-100) that specifies the opacity of 1488earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1451the color, where C<0> is completely transparent and C<100> is completelxy 1489C<rgba:0000/ff00/0000/f332>.
1452opaque.
1453 1490
1454You probably need to specify B<"-depth 32">, too, and have the luck that 1491You probably need to specify B<"-depth 32">, too, to force a visual with
1455your X-server uses ARGB pixel layout, as X is far from just supporting 1492alpha channels, and have the luck that your X-server uses ARGB pixel
1456ARGB visuals out of the box, and rxvt-unicode just fudges around. 1493layout, as X is far from just supporting ARGB visuals out of the box, and
1494rxvt-unicode just fudges around.
1457 1495
1458For example, the following selects an almost completely transparent red 1496For example, the following selects an almost completely transparent black
1459background, and an almost opaque pink foreground: 1497background, and an almost opaque pink foreground:
1460 1498
1461 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1499 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1462 1500
1463I<Please note that transparency of any kind if completely unsupported by 1501When not using a background image, then the interpretation of the
1464the author. Don't bug him with installation questions!> 1502alpha channel is up to your compositing manager (most interpret it as
1503transparency of course).
1504
1505When using a background pixmap or pseudo-transparency, then the background
1506colour will always behave as if it were completely transparent (so the
1507background image shows instead), regardless of how it was specified, while
1508other colours will either be transparent as specified (the background
1509image will show through) on servers supporting the RENDER extension, or
1510fully opaque on servers not supporting the RENDER EXTENSION.
1511
1512Please note that due to bugs in Xft, specifying alpha values might result
1513in garbage being displayed when the X-server does not support the RENDER
1514extension.
1465 1515
1466=head1 ENVIRONMENT 1516=head1 ENVIRONMENT
1467 1517
1468B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1518B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1469 1519
1475resources or on the command line. 1525resources or on the command line.
1476 1526
1477=item B<COLORTERM> 1527=item B<COLORTERM>
1478 1528
1479Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1529Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1480compiled with XPM support, and optionally with the added extension 1530compiled with background image support, and optionally with the added
1481C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1531extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1532screen.
1482 1533
1483=item B<COLORFGBG> 1534=item B<COLORFGBG>
1484 1535
1485Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1536Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486the colour code used as default foreground/text colour (or the string 1537the colour code used as default foreground/text colour (or the string
1487C<default> to indicate that the default-colour escape sequence is to be 1538C<default> to indicate that the default-colour escape sequence is to be
1488used), C<bg> is the colour code used as default background colour (or the 1539used), C<bg> is the colour code used as default background colour (or the
1489string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1540string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1541was compiled with background image support. Libraries like C<ncurses>
1491(and do) use this information to optimize screen output. 1542and C<slang> can (and do) use this information to optimize screen output.
1492 1543
1493=item B<WINDOWID> 1544=item B<WINDOWID>
1494 1545
1495Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1546Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1496window, which usually has subwindows for the scrollbar, the terminal 1547window, which usually has subwindows for the scrollbar, the terminal
1587Project Coordinator (changes.txt 2.21a to 2.4.5) 1638Project Coordinator (changes.txt 2.21a to 2.4.5)
1588 1639
1589=item Geoff Wing L<< <gcw@pobox.com> >> 1640=item Geoff Wing L<< <gcw@pobox.com> >>
1590 1641
1591Rewrote screen display and text selection routines. 1642Rewrote screen display and text selection routines.
1592 1643
1593Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1644Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594 1645
1595=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1646=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1596 1647
1597Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1648Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines