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.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs.
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines