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.150 by root, Fri Dec 7 16:14:26 2007 UTC

30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devanagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If 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 40me recommend C<mlterm>, which is a very user friendly, lean and clean
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; resource 148blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource
151I<tintColor>. Example: 150I<tintColor>. Example:
152 151
153 @@RXVT_NAME@@ -tr -tint blue -sh 40 152 @@RXVT_NAME@@ -tr -tint blue -sh 40
154 153
155=item B<-sh> I<number> 154=item B<-sh> I<number>
156 155
157Darken (0 .. 100) or lighten (-1 .. -100) the transparent 156Darken (0 .. 100) or lighten (100 .. 200) the transparent
158background image in addition to (or instead of) tinting it; 157background image in addition to (or instead of) tinting it;
159resource I<shading>. 158resource I<shading>.
160 159
161=item B<-blt> I<string> 160=item B<-blt> I<string>
162 161
183 182
184=item B<-fg> I<colour> 183=item B<-fg> I<colour>
185 184
186Window foreground colour; resource B<foreground>. 185Window foreground colour; resource B<foreground>.
187 186
188=item B<-pixmap> I<file[;geom]> 187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
189 188
190Compile I<afterimage>: Specify image file for the background and also 189Compile I<afterimage>: Specify image file for the background and also
191optionally 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
192add quotes to avoid special shell interpretation of the C<;> in the 191add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 192command-line; for more details see resource B<backgroundPixmap>.
194 193
195=item B<-cr> I<colour> 194=item B<-cr> I<colour>
416 415
417=item B<-tcw> 416=item B<-tcw>
418 417
419Change the meaning of triple-click selection with the left mouse 418Change the meaning of triple-click selection with the left mouse
420button. Only effective when the original (non-perl) selection code is 419button. Only effective when the original (non-perl) selection code is
421in-use. Instead of selecting a full line it will extend the selection the 420in-use. Instead of selecting a full line it will extend the selection to
422end of the logical line only. resource B<tripleclickwords>. 421the end of the logical line only. resource B<tripleclickwords>.
423 422
424=item B<-insecure> 423=item B<-insecure>
425 424
426Enable "insecure" mode, which currently enables most of the escape 425Enable "insecure" mode, which currently enables most of the escape
427sequences that echo strings. See the resource B<insecure> for more 426sequences that echo strings. See the resource B<insecure> for more
447 446
448Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
449will not immediately destroy its window when the program executed within 448will 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 449it exits. Instead, it will wait till it is being killed or closed by the
451user; resource B<hold>. 450user; resource B<hold>.
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.
452 464
453=item B<-keysym.>I<sym> I<string> 465=item B<-keysym.>I<sym> I<string>
454 466
455Remap a key symbol. See resource B<keysym>. 467Remap a key symbol. See resource B<keysym>.
456 468
530 1. system-wide app-defaults file, either locale-dependent OR global 542 1. system-wide app-defaults file, either locale-dependent OR global
531 2. app-defaults file in $XAPPLRESDIR 543 2. app-defaults file in $XAPPLRESDIR
532 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 544 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
533 4. SCREEN_RESOURCES for the current screen 545 4. SCREEN_RESOURCES for the current screen
534 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 546 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547 6. resources specified via -xrm on the commandline
535 548
536Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 549Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
537names: 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
538common 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
539configured, while the class name B<URxvt> allows resources unique to 552configured, while the class name B<URxvt> allows resources unique to
641 654
642B<False>: specify that everything is to be displayed, even 655B<False>: specify that everything is to be displayed, even
643if 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
644monitor to display anything); option B<+ss>. 657monitor to display anything); option B<+ss>.
645 658
646=item B<inheritPixmap:> I<boolean> 659=item B<transparent:> I<boolean>
647 660
648B<True>: make the background inherit the parent windows' pixmap, giving 661Turn on/off illusion of a transparent window background.
649artificial transparency. B<False>: do not inherit the parent windows'
650pixmap.
651 662
652I<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
653the 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@@)!>
654 668
655=item B<fading:> I<number> 669=item B<fading:> I<number>
656 670
657Fade 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>.
658 672
675 689
676Specify background blending type; option B<-blt>. 690Specify background blending type; option B<-blt>.
677 691
678=item B<blurRadius:> I<number> 692=item B<blurRadius:> I<number>
679 693
680Apply Gaussian Blurr with the specified radius to the transparent 694Apply Gaussian Blurr with the specified radius to the transparent
681background image; option B<-blr>. 695background image; option B<-blr>.
682 696
683=item B<scrollColor:> I<colour> 697=item B<scrollColor:> I<colour>
684 698
685Use the specified colour for the scrollbar [default #B2B2B2]. 699Use the specified colour for the scrollbar [default #B2B2B2].
692=item B<borderColor:> I<colour> 706=item B<borderColor:> I<colour>
693 707
694The 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
695and the text. 709and the text.
696 710
697=item B<backgroundPixmap:> I<file[;geom]> 711=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
698 712
699Use the specified image file for the background and also optionally 713Use the specified image file for the background and also
700specify its scaling with a geometry string B<WxH+X+Y>, 714optionally specify its scaling with a geometry string B<WxH+X+Y>,
701in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 715(default C<0x0+50+50>) in which B<"W" / "H"> specify the
702and B<"X" / "Y"> locate the image centre (percent). 716horizontal/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 717centre (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 718of 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 719an integer number of images in that direction. No image will be magnified
70610 times its original size. The maximum permitted scale is 1000. 720beyond 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 721Additional operations can be specified after colon B<:op1:op2...>.
708automatically 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
709If used in conjunction with B<-tr> option - specified pixmap will be 733If used in conjunction with B<-tr> option, the specified pixmap will be
710blended over transparency image using either alpha-blending, or any 734blended over transparency image using either alpha-blending, or any
711other blending type, specified with B<-blt "type"> option. 735other blending type, specified with B<-blt "type"> option.
712[default 0x0+50+50]
713 736
714=item B<path:> I<path> 737=item B<path:> I<path>
715 738
716Specify the colon-delimited search path for finding background image files. 739Specify the colon-delimited search path for finding background image files.
717 740
990will 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.
991 1014
992When 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
993be used. If not specified, the built-in default is used: 1016be used. If not specified, the built-in default is used:
994 1017
995B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1018B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
996 1019
997=item B<preeditType:> I<style> 1020=item B<preeditType:> I<style>
998 1021
999B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1022B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1000 1023
1470resources or on the command line. 1493resources or on the command line.
1471 1494
1472=item B<COLORTERM> 1495=item B<COLORTERM>
1473 1496
1474Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1497Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1475compiled with background image support, and optionally with the added 1498compiled with background image support, and optionally with the added
1476extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 1499extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477screen. 1500screen.
1478 1501
1479=item B<COLORFGBG> 1502=item B<COLORFGBG>
1480 1503
1481Set 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
1482the colour code used as default foreground/text colour (or the string 1505the colour code used as default foreground/text colour (or the string
1483C<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
1484used), 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
1485string 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@@
1486was compiled with background image support. Libraries like C<ncurses> 1509was compiled with background image support. Libraries like C<ncurses>
1487and 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.
1488 1511
1489=item B<WINDOWID> 1512=item B<WINDOWID>
1490 1513
1491Set 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
1583Project Coordinator (changes.txt 2.21a to 2.4.5) 1606Project Coordinator (changes.txt 2.21a to 2.4.5)
1584 1607
1585=item Geoff Wing L<< <gcw@pobox.com> >> 1608=item Geoff Wing L<< <gcw@pobox.com> >>
1586 1609
1587Rewrote screen display and text selection routines. 1610Rewrote screen display and text selection routines.
1588 1611
1589Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1612Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1590 1613
1591=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1614=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1592 1615
1593Forked 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