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.156 by ayin, Sun Dec 30 22:43:40 2007 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
… …
116 119
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 120Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118 121
119=item B<-tr>|B<+tr> 122=item B<-tr>|B<+tr>
120 123
121Turn on/off illusion of a transparent window background. Obsolete form of it is 124Turn on/off illusion of a transparent window background; resource B<transparent>.
122B<-ip> and it should not be used anymore; resource B<transparent>.
123 125
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be 126B<-ip> is still accepted as an obsolete alias but will be removed in
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will 127future versions.
126be phased out in future versions of rxvt!>
127 128
128I<Please address all transparency related issues to Sasha Vasko at 129I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 130sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130 131
131=item B<-fade> I<number> 132=item B<-fade> I<number>
132 133
133Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
… …
145transparency is enabled with B<-tr>. This only works for 146transparency is enabled with B<-tr>. This only works for
146non-tiled backgrounds, currently. See also the B<-sh> option that can be 147non-tiled backgrounds, currently. See also the B<-sh> option that can be
147used to brighten or darken the image in addition to tinting it. 148used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side, 149Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are: 150thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them; resource 151blue, red, green, cyan, magenta, yellow, and those close to them. Also
152pure black and pure white colors essentially mean no tinting; resource
151I<tintColor>. Example: 153I<tintColor>. Example:
152 154
153 @@RXVT_NAME@@ -tr -tint blue -sh 40 155 @@RXVT_NAME@@ -tr -tint blue -sh 40
154 156
155=item B<-sh> I<number> 157=item B<-sh> I<number>
156 158
157Darken (0 .. 100) or lighten (-1 .. -100) the transparent 159Darken (0 .. 100) or lighten (100 .. 200) the transparent
158background image in addition to (or instead of) tinting it; 160background image in addition to (or instead of) tinting it;
159resource I<shading>. 161resource I<shading>.
160 162
161=item B<-blt> I<string> 163=item B<-blt> I<string>
162 164
… …
183 185
184=item B<-fg> I<colour> 186=item B<-fg> I<colour>
185 187
186Window foreground colour; resource B<foreground>. 188Window foreground colour; resource B<foreground>.
187 189
188=item B<-pixmap> I<file[;geom]> 190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
189 191
190Compile I<afterimage>: Specify image file for the background and also 192Compile I<afterimage>: Specify image file for the background and also
191optionally specify its scaling with a geometry string. Note you may need to 193optionally specify its scaling with a geometry string. Note you may need to
192add quotes to avoid special shell interpretation of the C<;> in the 194add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 195command-line; for more details see resource B<backgroundPixmap>.
194 196
195=item B<-cr> I<colour> 197=item B<-cr> I<colour>
… …
243italic> >> characters are to be printed. See resource B<boldItalicFont> 245italic> >> characters are to be printed. See resource B<boldItalicFont>
244for details. 246for details.
245 247
246=item B<-is>|B<+is> 248=item B<-is>|B<+is>
247 249
248Compile I<font-styles>: Bold/Italic font styles imply high intensity 250Compile I<font-styles>: Bold/Blink font styles imply high intensity
249foreground/background (default). See resource B<intensityStyles> for 251foreground/background (default). See resource B<intensityStyles> for
250details. 252details.
251 253
252=item B<-name> I<name> 254=item B<-name> I<name>
253 255
… …
416 418
417=item B<-tcw> 419=item B<-tcw>
418 420
419Change the meaning of triple-click selection with the left mouse 421Change the meaning of triple-click selection with the left mouse
420button. Only effective when the original (non-perl) selection code is 422button. Only effective when the original (non-perl) selection code is
421in-use. Instead of selecting a full line it will extend the selection the 423in-use. Instead of selecting a full line it will extend the selection to
422end of the logical line only. resource B<tripleclickwords>. 424the end of the logical line only. resource B<tripleclickwords>.
423 425
424=item B<-insecure> 426=item B<-insecure>
425 427
426Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
427sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
… …
447 449
448Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
449will not immediately destroy its window when the program executed within 451will 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 452it exits. Instead, it will wait till it is being killed or closed by the
451user; resource B<hold>. 453user; resource B<hold>.
454
455=item B<-xrm> I<string>
456
457Works like the X Toolkit option of the same name, by adding the I<string>
458as if it were specified in a resource file. Resource values specified this
459way take precedence over all other resource specifications.
460
461Note that you need to use the I<same> syntax as in the .Xdefaults file,
462e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
463options can be specified as long-options on the commandline, so use
464of B<-xrm> is mostly limited to cases where you want to specify other
465resources (e.g. for input methods) or for compatibility with other
466programs.
452 467
453=item B<-keysym.>I<sym> I<string> 468=item B<-keysym.>I<sym> I<string>
454 469
455Remap a key symbol. See resource B<keysym>. 470Remap a key symbol. See resource B<keysym>.
456 471
… …
491If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 506If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
492entries and will not tinker with pty/tty permissions - you have to do that 507entries and will not tinker with pty/tty permissions - you have to do that
493yourself if you want that. 508yourself if you want that.
494 509
495As an extremely special case, specifying C<-1> will completely suppress 510As an extremely special case, specifying C<-1> will completely suppress
496pty/tty operations. 511pty/tty operations, which is probably only useful in conjunction with some
512perl extension that manages the terminal.
497 513
498Here is a example in perl that illustrates how this option can be used (a 514Here is a example in perl that illustrates how this option can be used (a
499longer example is in F<doc/pty-fd>): 515longer example is in F<doc/pty-fd>):
500 516
501 use IO::Pty; 517 use IO::Pty;
… …
515Comma-separated list of perl extension scripts to use (or not to use) in 531Comma-separated list of perl extension scripts to use (or not to use) in
516this terminal instance. See resource B<perl-ext> for details. 532this terminal instance. See resource B<perl-ext> for details.
517 533
518=back 534=back
519 535
520=head1 RESOURCES (available also as long-options) 536=head1 RESOURCES
521 537
522Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 538Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
523options) compiled into your version. 539options) compiled into your version. All resources are also available as
540long-options.
524 541
525You can set and change the resources using X11 tools like B<xrdb>. Many 542You can set and change the resources using X11 tools like B<xrdb>. Many
526distribution do also load settings from the B<~/.Xresources> file when X 543distribution do also load settings from the B<~/.Xresources> file when X
527starts. @@RXVT_NAME@@ will consult the following files/resources in order, 544starts. @@RXVT_NAME@@ will consult the following files/resources in order,
528with later settings overwriting earlier ones: 545with later settings overwriting earlier ones:
… …
530 1. system-wide app-defaults file, either locale-dependent OR global 547 1. system-wide app-defaults file, either locale-dependent OR global
531 2. app-defaults file in $XAPPLRESDIR 548 2. app-defaults file in $XAPPLRESDIR
532 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
533 4. SCREEN_RESOURCES for the current screen 550 4. SCREEN_RESOURCES for the current screen
534 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline
535 553
536Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
537names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 555names: 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 556common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
539configured, while the class name B<URxvt> allows resources unique to 557configured, while the class name B<URxvt> allows resources unique to
… …
641 659
642B<False>: specify that everything is to be displayed, even 660B<False>: specify that everything is to be displayed, even
643if the refresh is too fast for the human eye to read anything (or the 661if the refresh is too fast for the human eye to read anything (or the
644monitor to display anything); option B<+ss>. 662monitor to display anything); option B<+ss>.
645 663
646=item B<inheritPixmap:> I<boolean> 664=item B<transparent:> I<boolean>
647 665
648B<True>: make the background inherit the parent windows' pixmap, giving 666Turn on/off illusion of a transparent window background.
649artificial transparency. B<False>: do not inherit the parent windows'
650pixmap.
651 667
652I<Please note that transparency of any kind if completely unsupported by 668B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
653the author. Don't bug him with installation questions!> 669future versions.
670
671I<Please address all transparency related issues to Sasha Vasko at
672sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
654 673
655=item B<fading:> I<number> 674=item B<fading:> I<number>
656 675
657Fade the text by the given percentage when focus is lost; option B<-fade>. 676Fade the text by the given percentage when focus is lost; option B<-fade>.
658 677
… …
675 694
676Specify background blending type; option B<-blt>. 695Specify background blending type; option B<-blt>.
677 696
678=item B<blurRadius:> I<number> 697=item B<blurRadius:> I<number>
679 698
680Apply Gaussian Blurr with the specified radius to the transparent 699Apply Gaussian Blurr with the specified radius to the transparent
681background image; option B<-blr>. 700background image; option B<-blr>.
682 701
683=item B<scrollColor:> I<colour> 702=item B<scrollColor:> I<colour>
684 703
685Use the specified colour for the scrollbar [default #B2B2B2]. 704Use the specified colour for the scrollbar [default #B2B2B2].
… …
692=item B<borderColor:> I<colour> 711=item B<borderColor:> I<colour>
693 712
694The colour of the border around the text area and between the scrollbar 713The colour of the border around the text area and between the scrollbar
695and the text. 714and the text.
696 715
697=item B<backgroundPixmap:> I<file[;geom]> 716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
698 717
699Use the specified image file for the background and also optionally 718Use the specified image file for the background and also
700specify its scaling with a geometry string B<WxH+X+Y>, 719optionally specify its scaling with a geometry string B<WxH+X+Y>,
701in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
702and B<"X" / "Y"> locate the image centre (percent). 721horizontal/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 722centre (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 723of 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 724an integer number of images in that direction. No image will be magnified
70610 times its original size. The maximum permitted scale is 1000. 725beyond 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 726Additional operations can be specified after colon B<:op1:op2...>.
708automatically scaled to match window size. 727Supported operations are:
728
729 tile force background image to be tiled and not scaled. Equivalent to 0x0
730 propscale will scale image keeping proportions
731 auto will scale image to match window size. Equivalent to 100x100
732 hscale will scale image horizontally to the window size
733 vscale will scale image vertically to the window size
734 scale will scale image to match window size
735 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves
737
709If used in conjunction with B<-tr> option - specified pixmap will be 738If used in conjunction with B<-tr> option, the specified pixmap will be
710blended over transparency image using either alpha-blending, or any 739blended over transparency image using either alpha-blending, or any
711other blending type, specified with B<-blt "type"> option. 740other blending type, specified with B<-blt "type"> option.
712[default 0x0+50+50]
713 741
714=item B<path:> I<path> 742=item B<path:> I<path>
715 743
716Specify the colon-delimited search path for finding background image files. 744Specify the colon-delimited search path for finding background image files.
717 745
… …
778text font will being used for the given style. 806text font will being used for the given style.
779 807
780=item B<intensityStyles:> I<boolean> 808=item B<intensityStyles:> I<boolean>
781 809
782When 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>,
783option B<-is>, the default), bold and italic font styles imply high 811option B<-is>, the default), bold/blink font styles imply high
784intensity foreground/background colours. Disabling this option (B<False>, 812intensity foreground/background colours. Disabling this option (B<False>,
785option B<+is>) disables this behaviour, the high intensity colours are not 813option B<+is>) disables this behaviour, the high intensity colours are not
786reachable. 814reachable.
787
788=item B<selectstyle:> I<mode>
789
790Set mouse selection style to B<old> which is 2.20, B<oldword> which
791is xterm style with 2.20 old word selection, or anything else which
792gives xterm style selection. Only effective when the original (non-perl)
793selection code is in use.
794 815
795=item B<scrollstyle:> I<mode> 816=item B<scrollstyle:> I<mode>
796 817
797Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 818Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
798the author's favourite. 819the author's favourite.
… …
990will be created). In this mode, characters outside ISO-8859-1 can be used. 1011will be created). In this mode, characters outside ISO-8859-1 can be used.
991 1012
992When the selection extension is not used, only ISO-8859-1 characters can 1013When the selection extension is not used, only ISO-8859-1 characters can
993be used. If not specified, the built-in default is used: 1014be used. If not specified, the built-in default is used:
994 1015
995B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1016B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
996 1017
997=item B<preeditType:> I<style> 1018=item B<preeditType:> I<style>
998 1019
999B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1020B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1000 1021
… …
1470resources or on the command line. 1491resources or on the command line.
1471 1492
1472=item B<COLORTERM> 1493=item B<COLORTERM>
1473 1494
1474Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1495Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1475compiled with background image support, and optionally with the added 1496compiled with background image support, and optionally with the added
1476extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 1497extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477screen. 1498screen.
1478 1499
1479=item B<COLORFGBG> 1500=item B<COLORFGBG>
1480 1501
1481Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1502Set 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 1503the colour code used as default foreground/text colour (or the string
1483C<default> to indicate that the default-colour escape sequence is to be 1504C<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 1505used), 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@@ 1506string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1486was compiled with background image support. Libraries like C<ncurses> 1507was compiled with background image support. Libraries like C<ncurses>
1487and C<slang> can (and do) use this information to optimize screen output. 1508and C<slang> can (and do) use this information to optimize screen output.
1488 1509
1489=item B<WINDOWID> 1510=item B<WINDOWID>
1490 1511
1491Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1512Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
… …
1583Project Coordinator (changes.txt 2.21a to 2.4.5) 1604Project Coordinator (changes.txt 2.21a to 2.4.5)
1584 1605
1585=item Geoff Wing L<< <gcw@pobox.com> >> 1606=item Geoff Wing L<< <gcw@pobox.com> >>
1586 1607
1587Rewrote screen display and text selection routines. 1608Rewrote screen display and text selection routines.
1588 1609
1589Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1610Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1590 1611
1591=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1612=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1592 1613
1593Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1614Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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