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.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs.
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC

116 116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118 118
119=item B<-tr>|B<+tr> 119=item B<-tr>|B<+tr>
120 120
121Turn on/off illusion of a transparent window background. Obsolete form of it is 121Turn on/off illusion of a transparent window background; resource B<transparent>.
122B<-ip> and it should not be used anymore; resource B<transparent>.
123 122
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be 123B<-ip> is still accepted as an obsolete alias but will be removed in
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will 124future versions.
126be phased out in future versions of rxvt!>
127 125
128I<Please address all transparency related issues to Sasha Vasko at 126I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130 128
131=item B<-fade> I<number> 129=item B<-fade> I<number>
132 130
133Fade the text by the given percentage when focus is lost. Small values 131Fade the text by the given percentage when focus is lost. Small values
145transparency is enabled with B<-tr>. This only works for 143transparency is enabled with B<-tr>. This only works for
146non-tiled backgrounds, currently. See also the B<-sh> option that can be 144non-tiled backgrounds, currently. See also the B<-sh> option that can be
147used to brighten or darken the image in addition to tinting it. 145used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side, 146Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are: 147thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also 148blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentialy mean no tinting; resource 149pure black and pure white colors essentially mean no tinting; resource
152I<tintColor>. Example: 150I<tintColor>. Example:
153 151
154 @@RXVT_NAME@@ -tr -tint blue -sh 40 152 @@RXVT_NAME@@ -tr -tint blue -sh 40
155 153
156=item B<-sh> I<number> 154=item B<-sh> I<number>
184 182
185=item B<-fg> I<colour> 183=item B<-fg> I<colour>
186 184
187Window foreground colour; resource B<foreground>. 185Window foreground colour; resource B<foreground>.
188 186
189=item B<-pixmap> I<file[;geom]> 187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190 188
191Compile I<afterimage>: Specify image file for the background and also 189Compile I<afterimage>: Specify image file for the background and also
192optionally specify its scaling with a geometry string. Note you may need to 190optionally specify its scaling with a geometry string. Note you may need to
193add quotes to avoid special shell interpretation of the C<;> in the 191add quotes to avoid special shell interpretation of the C<;> in the
194command-line; for more details see resource B<backgroundPixmap>. 192command-line; for more details see resource B<backgroundPixmap>.
195 193
196=item B<-cr> I<colour> 194=item B<-cr> I<colour>
449Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450will not immediately destroy its window when the program executed within 448will 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 449it exits. Instead, it will wait till it is being killed or closed by the
452user; resource B<hold>. 450user; resource B<hold>.
453 451
452=item B<-xrm> I<string>
453
454Works 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
456way take precedence over all other resource specifications.
457
458Note that you need to use the I<same> syntax as in the .Xdefaults file,
459e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
460options can be specified as long-options on the commandline, so use
461of B<-xrm> is mostly limited to cases where you want to specify other
462resources (e.g. for input methods) or for compatibility with other
463programs.
464
454=item B<-keysym.>I<sym> I<string> 465=item B<-keysym.>I<sym> I<string>
455 466
456Remap a key symbol. See resource B<keysym>. 467Remap a key symbol. See resource B<keysym>.
457 468
458=item B<-embed> I<windowid> 469=item B<-embed> I<windowid>
531 1. system-wide app-defaults file, either locale-dependent OR global 542 1. system-wide app-defaults file, either locale-dependent OR global
532 2. app-defaults file in $XAPPLRESDIR 543 2. app-defaults file in $XAPPLRESDIR
533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 544 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534 4. SCREEN_RESOURCES for the current screen 545 4. SCREEN_RESOURCES for the current screen
535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 546 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547 6. resources specified via -xrm on the commandline
536 548
537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 549Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 550names: 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 551common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
540configured, while the class name B<URxvt> allows resources unique to 552configured, while the class name B<URxvt> allows resources unique to
642 654
643B<False>: specify that everything is to be displayed, even 655B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the 656if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>. 657monitor to display anything); option B<+ss>.
646 658
647=item B<inheritPixmap:> I<boolean> 659=item B<transparent:> I<boolean>
648 660
649B<True>: make the background inherit the parent windows' pixmap, giving 661Turn on/off illusion of a transparent window background.
650artificial transparency. B<False>: do not inherit the parent windows'
651pixmap.
652 662
653I<Please note that transparency of any kind if completely unsupported by 663B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654the author. Don't bug him with installation questions!> 664future versions.
665
666I<Please address all transparency related issues to Sasha Vasko at
667sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
655 668
656=item B<fading:> I<number> 669=item B<fading:> I<number>
657 670
658Fade the text by the given percentage when focus is lost; option B<-fade>. 671Fade the text by the given percentage when focus is lost; option B<-fade>.
659 672
676 689
677Specify background blending type; option B<-blt>. 690Specify background blending type; option B<-blt>.
678 691
679=item B<blurRadius:> I<number> 692=item B<blurRadius:> I<number>
680 693
681Apply Gaussian Blurr with the specified radius to the transparent 694Apply Gaussian Blurr with the specified radius to the transparent
682background image; option B<-blr>. 695background image; option B<-blr>.
683 696
684=item B<scrollColor:> I<colour> 697=item B<scrollColor:> I<colour>
685 698
686Use the specified colour for the scrollbar [default #B2B2B2]. 699Use the specified colour for the scrollbar [default #B2B2B2].
693=item B<borderColor:> I<colour> 706=item B<borderColor:> I<colour>
694 707
695The colour of the border around the text area and between the scrollbar 708The colour of the border around the text area and between the scrollbar
696and the text. 709and the text.
697 710
698=item B<backgroundPixmap:> I<file[;geom]> 711=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699 712
700Use the specified image file for the background and also optionally 713Use the specified image file for the background and also
701specify its scaling with a geometry string B<WxH+X+Y>, 714optionally specify its scaling with a geometry string B<WxH+X+Y>,
702in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 715(default C<0x0+50+50>) in which B<"W" / "H"> specify the
703and B<"X" / "Y"> locate the image centre (percent). 716horizontal/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 717centre (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 718of 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 719an integer number of images in that direction. No image will be magnified
70710 times its original size. The maximum permitted scale is 1000. 720beyond 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 721Additional operations can be specified after colon B<:op1:op2...>.
709automatically scaled to match window size. 722Supported operations are:
723
724 tile force background image to be tiled and not scaled. Equivalent to 0x0,
725 propscale will scale image keeping proportions,
726 auto will scale image to match window size. Equivalent to 100x100;
727 hscale will scale image horizontally to the window size;
728 vscale will scale image vertically to the window size;
729 scale will scale image to match window size;
730 root will tile image as if it was a root window background, auto-adjusting
731 whenever terminal window moves.
732
710If used in conjunction with B<-tr> option - specified pixmap will be 733If used in conjunction with B<-tr> option, the specified pixmap will be
711blended over transparency image using either alpha-blending, or any 734blended over transparency image using either alpha-blending, or any
712other blending type, specified with B<-blt "type"> option. 735other blending type, specified with B<-blt "type"> option.
713[default 0x0+50+50]
714 736
715=item B<path:> I<path> 737=item B<path:> I<path>
716 738
717Specify the colon-delimited search path for finding background image files. 739Specify the colon-delimited search path for finding background image files.
718 740
991will be created). In this mode, characters outside ISO-8859-1 can be used. 1013will be created). In this mode, characters outside ISO-8859-1 can be used.
992 1014
993When the selection extension is not used, only ISO-8859-1 characters can 1015When the selection extension is not used, only ISO-8859-1 characters can
994be used. If not specified, the built-in default is used: 1016be used. If not specified, the built-in default is used:
995 1017
996B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1018B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
997 1019
998=item B<preeditType:> I<style> 1020=item B<preeditType:> I<style>
999 1021
1000B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1022B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1001 1023
1471resources or on the command line. 1493resources or on the command line.
1472 1494
1473=item B<COLORTERM> 1495=item B<COLORTERM>
1474 1496
1475Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1497Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1476compiled with background image support, and optionally with the added 1498compiled with background image support, and optionally with the added
1477extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 1499extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1478screen. 1500screen.
1479 1501
1480=item B<COLORFGBG> 1502=item B<COLORFGBG>
1481 1503
1482Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1504Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1483the colour code used as default foreground/text colour (or the string 1505the colour code used as default foreground/text colour (or the string
1484C<default> to indicate that the default-colour escape sequence is to be 1506C<default> to indicate that the default-colour escape sequence is to be
1485used), C<bg> is the colour code used as default background colour (or the 1507used), C<bg> is the colour code used as default background colour (or the
1486string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1508string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1487was compiled with background image support. Libraries like C<ncurses> 1509was compiled with background image support. Libraries like C<ncurses>
1488and C<slang> can (and do) use this information to optimize screen output. 1510and C<slang> can (and do) use this information to optimize screen output.
1489 1511
1490=item B<WINDOWID> 1512=item B<WINDOWID>
1491 1513
1492Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1514Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1584Project Coordinator (changes.txt 2.21a to 2.4.5) 1606Project Coordinator (changes.txt 2.21a to 2.4.5)
1585 1607
1586=item Geoff Wing L<< <gcw@pobox.com> >> 1608=item Geoff Wing L<< <gcw@pobox.com> >>
1587 1609
1588Rewrote screen display and text selection routines. 1610Rewrote screen display and text selection routines.
1589 1611
1590Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1612Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1591 1613
1592=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1614=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1593 1615
1594Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1616Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines