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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs.
Revision 1.158 by root, Wed Jan 23 14:33: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
… …
242italic> >> characters are to be printed. See resource B<boldItalicFont> 245italic> >> characters are to be printed. See resource B<boldItalicFont>
243for details. 246for details.
244 247
245=item B<-is>|B<+is> 248=item B<-is>|B<+is>
246 249
247Compile I<font-styles>: Bold/Italic font styles imply high intensity 250Compile I<font-styles>: Bold/Blink font styles imply high intensity
248foreground/background (default). See resource B<intensityStyles> for 251foreground/background (default). See resource B<intensityStyles> for
249details. 252details.
250 253
251=item B<-name> I<name> 254=item B<-name> I<name>
252 255
… …
270 273
271=item B<-sb>|B<+sb> 274=item B<-sb>|B<+sb>
272 275
273Turn on/off scrollbar; resource B<scrollBar>. 276Turn on/off scrollbar; resource B<scrollBar>.
274 277
278=item B<-sr>|B<+sr>
279
280Put scrollbar on right/left; resource B<scrollBar_right>.
281
282=item B<-st>|B<+st>
283
284Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
285resource B<scrollBar_floating>.
286
275=item B<-si>|B<+si> 287=item B<-si>|B<+si>
276 288
277Turn on/off scroll-to-bottom on TTY output inhibit; resource 289Turn on/off scroll-to-bottom on TTY output inhibit; resource
278B<scrollTtyOutput> has opposite effect. 290B<scrollTtyOutput> has opposite effect.
279 291
… …
285=item B<-sw>|B<+sw> 297=item B<-sw>|B<+sw>
286 298
287Turn on/off scrolling with the scrollback buffer as new lines appear. 299Turn on/off scrolling with the scrollback buffer as new lines appear.
288This only takes effect if B<-si> is also given; resource 300This only takes effect if B<-si> is also given; resource
289B<scrollWithBuffer>. 301B<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 302
300=item B<-ptab>|B<+ptab> 303=item B<-ptab>|B<+ptab>
301 304
302If enabled (default), "Horizontal Tab" characters are being stored as 305If enabled (default), "Horizontal Tab" characters are being stored as
303actual wide characters in the screen buffer, which makes it possible to 306actual wide characters in the screen buffer, which makes it possible to
… …
721an integer number of images in that direction. No image will be magnified 724an integer number of images in that direction. No image will be magnified
722beyond 10 times its original size. The maximum permitted scale is 1000. 725beyond 10 times its original size. The maximum permitted scale is 1000.
723Additional operations can be specified after colon B<:op1:op2...>. 726Additional operations can be specified after colon B<:op1:op2...>.
724Supported operations are: 727Supported operations are:
725 728
726 tile force background image to be tiled and not scaled. Equivalent to 0x0, 729 tile force background image to be tiled and not scaled. Equivalent to 0x0
727 propscale will scale image keeping proportions, 730 propscale will scale image keeping proportions
728 auto will scale image to match window size. Equivalent to 100x100; 731 auto will scale image to match window size. Equivalent to 100x100
729 hscale will scale image horizontally to the window size; 732 hscale will scale image horizontally to the window size
730 vscale will scale image vertically to the window size; 733 vscale will scale image vertically to the window size
731 scale will scale image to match window size; 734 scale will scale image to match window size
732 root will tile image as if it was a root window background, auto-adjusting 735 root will tile image as if it was a root window background, auto-adjusting
733 whenever terminal window moves. 736 whenever terminal window moves
734 737
735If used in conjunction with B<-tr> option, the specified pixmap will be 738If used in conjunction with B<-tr> option, the specified pixmap will be
736blended over transparency image using either alpha-blending, or any 739blended over transparency image using either alpha-blending, or any
737other blending type, specified with B<-blt "type"> option. 740other blending type, specified with B<-blt "type"> option.
738 741
… …
803text font will being used for the given style. 806text font will being used for the given style.
804 807
805=item B<intensityStyles:> I<boolean> 808=item B<intensityStyles:> I<boolean>
806 809
807When font styles are not enabled, or this option is enabled (B<True>, 810When font styles are not enabled, or this option is enabled (B<True>,
808option B<-is>, the default), bold and italic font styles imply high 811option B<-is>, the default), bold/blink font styles imply high
809intensity foreground/background colours. Disabling this option (B<False>, 812intensity foreground/background colours. Disabling this option (B<False>,
810option B<+is>) disables this behaviour, the high intensity colours are not 813option B<+is>) disables this behaviour, the high intensity colours are not
811reachable. 814reachable.
812 815
813=item B<selectstyle:> I<mode>
814
815Set mouse selection style to B<old> which is 2.20, B<oldword> which
816is xterm style with 2.20 old word selection, or anything else which
817gives xterm style selection. Only effective when the original (non-perl)
818selection code is in use.
819
820=item B<scrollstyle:> I<mode>
821
822Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
823the author's favourite.
824
825=item B<title:> I<string> 816=item B<title:> I<string>
826 817
827Set window title string, the default title is the command-line 818Set window title string, the default title is the command-line
828specified after the B<-e> option, if any, otherwise the application 819specified after the B<-e> option, if any, otherwise the application
829name; option B<-title>. 820name; option B<-title>.
… …
873 864
874 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 865 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875 866
876This creates a new file in your home directory with the screen contents 867This creates a new file in your home directory with the screen contents
877every time you hit C<Print>. 868every time you hit C<Print>.
869
870=item B<scrollstyle:> I<mode>
871
872Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
873the author's favourite.
878 874
879=item B<scrollBar:> I<boolean> 875=item B<scrollBar:> I<boolean>
880 876
881B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 877B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882disable the scrollbar; option B<+sb>. 878disable the scrollbar; option B<+sb>.
… …
1457would yield White on Black, while on I<xterm>(1) it would yield Black 1453would yield White on Black, while on I<xterm>(1) it would yield Black
1458on White. 1454on White.
1459 1455
1460=back 1456=back
1461 1457
1462=head2 ALPHA CHANNEL SUPPORT 1458=head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS
1463 1459
1464If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1465their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1461their act together, rxvt-unicode will do it's own alpha channel management:
1466(recommended, but B<MUST> have 4 digits/component) colour specifications, 1462
1467in addition to the ones provided by X, where the additional A component 1463You can prefix any color with an opaquenes percentage enclosed in
1464brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1465(0-100) that specifies the opacity of the color, where C<0> is completely
1466transparent and C<100> is completely opaque. For example, C<[50]red> is a
1467half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1468is the recommended format to specify transparency values, and works with
1469all ways to specify a colour.
1470
1471For complete control, rxvt-unicode also supports
1472C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1473specifications, where the additional C<aaaa> component specifies opacity
1468specifies opacity (alpha) values. The minimum value of C<0> is completely 1474(alpha) values. The minimum value of C<0000> is completely transparent,
1469transparent). You can also prefix any color with C<[percent]>, where 1475while C<ffff> is completely opaque). The two example colours from
1470C<percent> is a decimal percentage (0-100) that specifies the opacity of 1476earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1471the color, where C<0> is completely transparent and C<100> is completelxy 1477C<rgba:0000/ff00/0000/f332>.
1472opaque.
1473 1478
1474You probably need to specify B<"-depth 32">, too, and have the luck that 1479You probably need to specify B<"-depth 32">, too, to force a visual with
1475your X-server uses ARGB pixel layout, as X is far from just supporting 1480alpha channels, and have the luck that your X-server uses ARGB pixel
1476ARGB visuals out of the box, and rxvt-unicode just fudges around. 1481layout, as X is far from just supporting ARGB visuals out of the box, and
1482rxvt-unicode just fudges around.
1477 1483
1478For example, the following selects an almost completely transparent red 1484For example, the following selects an almost completely transparent black
1479background, and an almost opaque pink foreground: 1485background, and an almost opaque pink foreground:
1480 1486
1481 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1487 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482 1488
1483I<Please note that transparency of any kind if completely unsupported by 1489When not using a background image, then the interpretation of the
1484the author. Don't bug him with installation questions!> 1490alpha channel is up to your compositing manager (most interpret it as
1491transparency of course).
1492
1493When using a background pixmap or pseudo-transparency, then the background
1494colour will always behave as if it were completely transparent (so the
1495background image shows instead), regardless of how it was specified, while
1496other colours will either be transparent as specified (the background
1497image will show through) on servers supporting the RENDER extension, or
1498fully opaque on servers not supporting the RENDER EXTENSION.
1499
1500Please note that due to bugs in Xft, specifying alpha values might result
1501in garbage being displayed when the X-server does not support the RENDER
1502extension.
1485 1503
1486=head1 ENVIRONMENT 1504=head1 ENVIRONMENT
1487 1505
1488B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1506B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489 1507

Diff Legend

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