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.143 by ayin, Sat Nov 10 09:40:51 2007 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 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>
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. Obsolete form of it is 129Turn on/off illusion of a transparent window background; resource B<transparent>.
122B<-ip> and it should not be used anymore; resource B<transparent>.
123 130
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be 131B<-ip> is still accepted as an obsolete alias but will be removed in
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will 132future versions.
126be phased out in future versions of rxvt!>
127 133
128I<Please address all transparency related issues to Sasha Vasko at 134I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130 136
131=item B<-fade> I<number> 137=item B<-fade> I<number>
184 190
185=item B<-fg> I<colour> 191=item B<-fg> I<colour>
186 192
187Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
188 194
189=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190 196
191Compile I<afterimage>: Specify image file for the background and also 197Compile I<afterimage>: Specify image file for the background and also
192optionally 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
193add quotes to avoid special shell interpretation of the C<;> in the 199add quotes to avoid special shell interpretation of the C<;> in the
194command-line; for more details see resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
244italic> >> characters are to be printed. See resource B<boldItalicFont> 250italic> >> characters are to be printed. See resource B<boldItalicFont>
245for details. 251for details.
246 252
247=item B<-is>|B<+is> 253=item B<-is>|B<+is>
248 254
249Compile I<font-styles>: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
250foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
251details. 257details.
252 258
253=item B<-name> I<name> 259=item B<-name> I<name>
254 260
272 278
273=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
274 280
275Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
276 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
277=item B<-si>|B<+si> 292=item B<-si>|B<+si>
278 293
279Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
280B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
281 296
287=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
288 303
289Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
290This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
291B<scrollWithBuffer>. 306B<scrollWithBuffer>.
292
293=item B<-sr>|B<+sr>
294
295Put scrollbar on right/left; resource B<scrollBar_right>.
296
297=item B<-st>|B<+st>
298
299Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300resource B<scrollBar_floating>.
301 307
302=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
303 309
304If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
305actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
417 423
418=item B<-tcw> 424=item B<-tcw>
419 425
420Change the meaning of triple-click selection with the left mouse 426Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is 427button. Only effective when the original (non-perl) selection code is
422in-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
423end of the logical line only. resource B<tripleclickwords>. 429the end of the logical line only. resource B<tripleclickwords>.
424 430
425=item B<-insecure> 431=item B<-insecure>
426 432
427Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
428sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
448 454
449Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450will not immediately destroy its window when the program executed within 456will not immediately destroy its window when the program executed within
451it 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
452user; 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.
453 472
454=item B<-keysym.>I<sym> I<string> 473=item B<-keysym.>I<sym> I<string>
455 474
456Remap a key symbol. See resource B<keysym>. 475Remap a key symbol. See resource B<keysym>.
457 476
492If 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
493entries 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
494yourself if you want that. 513yourself if you want that.
495 514
496As an extremely special case, specifying C<-1> will completely suppress 515As an extremely special case, specifying C<-1> will completely suppress
497pty/tty operations. 516pty/tty operations, which is probably only useful in conjunction with some
517perl extension that manages the terminal.
498 518
499Here 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
500longer example is in F<doc/pty-fd>): 520longer example is in F<doc/pty-fd>):
501 521
502 use IO::Pty; 522 use IO::Pty;
516Comma-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
517this terminal instance. See resource B<perl-ext> for details. 537this terminal instance. See resource B<perl-ext> for details.
518 538
519=back 539=back
520 540
521=head1 RESOURCES (available also as long-options) 541=head1 RESOURCES
522 542
523Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 543Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524options) compiled into your version. 544options) compiled into your version. All resources are also available as
545long-options.
525 546
526You 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
527distribution do also load settings from the B<~/.Xresources> file when X 548distribution do also load settings from the B<~/.Xresources> file when X
528starts. @@RXVT_NAME@@ will consult the following files/resources in order, 549starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529with later settings overwriting earlier ones: 550with later settings overwriting earlier ones:
531 1. system-wide app-defaults file, either locale-dependent OR global 552 1. system-wide app-defaults file, either locale-dependent OR global
532 2. app-defaults file in $XAPPLRESDIR 553 2. app-defaults file in $XAPPLRESDIR
533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534 4. SCREEN_RESOURCES for the current screen 555 4. SCREEN_RESOURCES for the current screen
535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline
536 558
537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538names: 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
539common 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
540configured, while the class name B<URxvt> allows resources unique to 562configured, while the class name B<URxvt> allows resources unique to
642 664
643B<False>: specify that everything is to be displayed, even 665B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the 666if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>. 667monitor to display anything); option B<+ss>.
646 668
647=item B<inheritPixmap:> I<boolean> 669=item B<transparent:> I<boolean>
648 670
649B<True>: make the background inherit the parent windows' pixmap, giving 671Turn on/off illusion of a transparent window background.
650artificial transparency. B<False>: do not inherit the parent windows'
651pixmap.
652 672
653I<Please note that transparency of any kind if completely unsupported by 673B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654the author. Don't bug him with installation questions!> 674future versions.
675
676I<Please address all transparency related issues to Sasha Vasko at
677sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
655 678
656=item B<fading:> I<number> 679=item B<fading:> I<number>
657 680
658Fade the text by the given percentage when focus is lost; option B<-fade>. 681Fade the text by the given percentage when focus is lost; option B<-fade>.
659 682
693=item B<borderColor:> I<colour> 716=item B<borderColor:> I<colour>
694 717
695The colour of the border around the text area and between the scrollbar 718The colour of the border around the text area and between the scrollbar
696and the text. 719and the text.
697 720
698=item B<backgroundPixmap:> I<file[;geom]> 721=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699 722
700Use the specified image file for the background and also optionally 723Use the specified image file for the background and also
701specify its scaling with a geometry string B<WxH+X+Y>, 724optionally specify its scaling with a geometry string B<WxH+X+Y>,
702in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 725(default C<0x0+50+50>) in which B<"W" / "H"> specify the
703and B<"X" / "Y"> locate the image centre (percent). 726horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
704A scale of 0 displays the image with tiling. A scale of 1 displays the 727centre (percent). A scale of 0 displays the image with tiling. A scale
705image without any scaling. A scale of 2 to 9 specifies an integer 728of 1 displays the image without any scaling. A scale of 2 to 9 specifies
706number of images in that direction. No image will be magnified beyond 729an integer number of images in that direction. No image will be magnified
70710 times its original size. The maximum permitted scale is 1000. 730beyond 10 times its original size. The maximum permitted scale is 1000.
708Special string of B<"auto"> used as a geometry will cause image to be 731Additional operations can be specified after colon B<:op1:op2...>.
709automatically scaled to match window size. 732Supported operations are:
733
734 tile force background image to be tiled and not scaled. Equivalent to 0x0
735 propscale will scale image keeping proportions
736 auto will scale image to match window size. Equivalent to 100x100
737 hscale will scale image horizontally to the window size
738 vscale will scale image vertically to the window size
739 scale will scale image to match window size
740 root will tile image as if it was a root window background, auto-adjusting
741 whenever terminal window moves
742
710If used in conjunction with B<-tr> option - specified pixmap will be 743If used in conjunction with B<-tr> option, the specified pixmap will be
711blended over transparency image using either alpha-blending, or any 744blended over transparency image using either alpha-blending, or any
712other blending type, specified with B<-blt "type"> option. 745other blending type, specified with B<-blt "type"> option.
713[default 0x0+50+50]
714 746
715=item B<path:> I<path> 747=item B<path:> I<path>
716 748
717Specify the colon-delimited search path for finding background image files. 749Specify the colon-delimited search path for finding background image files.
718 750
779text font will being used for the given style. 811text font will being used for the given style.
780 812
781=item B<intensityStyles:> I<boolean> 813=item B<intensityStyles:> I<boolean>
782 814
783When font styles are not enabled, or this option is enabled (B<True>, 815When font styles are not enabled, or this option is enabled (B<True>,
784option B<-is>, the default), bold and italic font styles imply high 816option B<-is>, the default), bold/blink font styles imply high
785intensity foreground/background colours. Disabling this option (B<False>, 817intensity foreground/background colours. Disabling this option (B<False>,
786option B<+is>) disables this behaviour, the high intensity colours are not 818option B<+is>) disables this behaviour, the high intensity colours are not
787reachable. 819reachable.
788 820
789=item B<selectstyle:> I<mode>
790
791Set mouse selection style to B<old> which is 2.20, B<oldword> which
792is xterm style with 2.20 old word selection, or anything else which
793gives xterm style selection. Only effective when the original (non-perl)
794selection code is in use.
795
796=item B<scrollstyle:> I<mode>
797
798Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
799the author's favourite.
800
801=item B<title:> I<string> 821=item B<title:> I<string>
802 822
803Set window title string, the default title is the command-line 823Set window title string, the default title is the command-line
804specified after the B<-e> option, if any, otherwise the application 824specified after the B<-e> option, if any, otherwise the application
805name; option B<-title>. 825name; option B<-title>.
849 869
850 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 870 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
851 871
852This creates a new file in your home directory with the screen contents 872This creates a new file in your home directory with the screen contents
853every time you hit C<Print>. 873every time you hit C<Print>.
874
875=item B<scrollstyle:> I<mode>
876
877Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878the author's favourite.
854 879
855=item B<scrollBar:> I<boolean> 880=item B<scrollBar:> I<boolean>
856 881
857B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 882B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
858disable the scrollbar; option B<+sb>. 883disable the scrollbar; option B<+sb>.
991will be created). In this mode, characters outside ISO-8859-1 can be used. 1016will be created). In this mode, characters outside ISO-8859-1 can be used.
992 1017
993When the selection extension is not used, only ISO-8859-1 characters can 1018When the selection extension is not used, only ISO-8859-1 characters can
994be used. If not specified, the built-in default is used: 1019be used. If not specified, the built-in default is used:
995 1020
996B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
997 1022
998=item B<preeditType:> I<style> 1023=item B<preeditType:> I<style>
999 1024
1000B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1025B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1001 1026
1436=back 1461=back
1437 1462
1438=head2 ALPHA CHANNEL SUPPORT 1463=head2 ALPHA CHANNEL SUPPORT
1439 1464
1440If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1465If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1441their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1466their act together, rxvt-unicode will do it's own alpha channel management:
1442(recommended, but B<MUST> have 4 digits/component) colour specifications, 1467
1443in addition to the ones provided by X, where the additional A component 1468You can prefix any color with an opaquenes percentage enclosed in
1469brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470(0-100) that specifies the opacity of the color, where C<0> is completely
1471transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473is the recommended format to specify transparency values, and works with
1474all ways to specify a colour.
1475
1476For complete control, rxvt-unicode also supports
1477C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1478specifications, where the additional C<aaaa> component specifies opacity
1444specifies opacity (alpha) values. The minimum value of C<0> is completely 1479(alpha) values. The minimum value of C<0000> is completely transparent,
1445transparent). You can also prefix any color with C<[percent]>, where 1480while C<ffff> is completely opaque). The two example colours from
1446C<percent> is a decimal percentage (0-100) that specifies the opacity of 1481earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1447the color, where C<0> is completely transparent and C<100> is completelxy 1482C<rgba:0000/ff00/0000/f332>.
1448opaque.
1449 1483
1450You probably need to specify B<"-depth 32">, too, and have the luck that 1484You probably need to specify B<"-depth 32">, too, to force a visual with
1451your X-server uses ARGB pixel layout, as X is far from just supporting 1485alpha channels, and have the luck that your X-server uses ARGB pixel
1452ARGB visuals out of the box, and rxvt-unicode just fudges around. 1486layout, as X is far from just supporting ARGB visuals out of the box, and
1487rxvt-unicode just fudges around.
1453 1488
1454For example, the following selects an almost completely transparent red 1489For example, the following selects an almost completely transparent black
1455background, and an almost opaque pink foreground: 1490background, and an almost opaque pink foreground:
1456 1491
1457 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1492 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1458 1493
1459I<Please note that transparency of any kind if completely unsupported by 1494When not using a background image, then the interpretation of the
1460the author. Don't bug him with installation questions!> 1495alpha channel is up to your compositing manager (most interpret it as
1496transparency of course).
1497
1498When using a background pixmap or pseudo-transparency, then the background
1499colour will always behave as if it were completely transparent (so the
1500background image shows instead), regardless of how it was specified, while
1501other colours will either be transparent as specified (the background
1502image will show through) on servers supporting the RENDER extension, or
1503fully opaque on servers not supporting the RENDER EXTENSION.
1504
1505Please note that due to bugs in Xft, specifying alpha values might result
1506in garbage being displayed when the X-server does not support the RENDER
1507extension.
1461 1508
1462=head1 ENVIRONMENT 1509=head1 ENVIRONMENT
1463 1510
1464B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1511B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1465 1512

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines