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.153 by root, Wed Dec 12 19:57:13 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>
… …
184 185
185=item B<-fg> I<colour> 186=item B<-fg> I<colour>
186 187
187Window foreground colour; resource B<foreground>. 188Window foreground colour; resource B<foreground>.
188 189
189=item B<-pixmap> I<file[;geom]> 190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190 191
191Compile I<afterimage>: Specify image file for the background and also 192Compile I<afterimage>: Specify image file for the background and also
192optionally 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
193add quotes to avoid special shell interpretation of the C<;> in the 194add quotes to avoid special shell interpretation of the C<;> in the
194command-line; for more details see resource B<backgroundPixmap>. 195command-line; for more details see resource B<backgroundPixmap>.
… …
417 418
418=item B<-tcw> 419=item B<-tcw>
419 420
420Change the meaning of triple-click selection with the left mouse 421Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is 422button. Only effective when the original (non-perl) selection code is
422in-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
423end of the logical line only. resource B<tripleclickwords>. 424the end of the logical line only. resource B<tripleclickwords>.
424 425
425=item B<-insecure> 426=item B<-insecure>
426 427
427Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
428sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
… …
448 449
449Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450will not immediately destroy its window when the program executed within 451will 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 452it exits. Instead, it will wait till it is being killed or closed by the
452user; 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.
453 467
454=item B<-keysym.>I<sym> I<string> 468=item B<-keysym.>I<sym> I<string>
455 469
456Remap a key symbol. See resource B<keysym>. 470Remap a key symbol. See resource B<keysym>.
457 471
… …
492If 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
493entries 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
494yourself if you want that. 508yourself if you want that.
495 509
496As an extremely special case, specifying C<-1> will completely suppress 510As an extremely special case, specifying C<-1> will completely suppress
497pty/tty operations. 511pty/tty operations, which is probably only useful in conjunction with some
512perl extension that manages the terminal.
498 513
499Here 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
500longer example is in F<doc/pty-fd>): 515longer example is in F<doc/pty-fd>):
501 516
502 use IO::Pty; 517 use IO::Pty;
… …
516Comma-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
517this terminal instance. See resource B<perl-ext> for details. 532this terminal instance. See resource B<perl-ext> for details.
518 533
519=back 534=back
520 535
521=head1 RESOURCES (available also as long-options) 536=head1 RESOURCES
522 537
523Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 538Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524options) compiled into your version. 539options) compiled into your version. All resources are also available as
540long-options.
525 541
526You 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
527distribution do also load settings from the B<~/.Xresources> file when X 543distribution do also load settings from the B<~/.Xresources> file when X
528starts. @@RXVT_NAME@@ will consult the following files/resources in order, 544starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529with later settings overwriting earlier ones: 545with later settings overwriting earlier ones:
… …
531 1. system-wide app-defaults file, either locale-dependent OR global 547 1. system-wide app-defaults file, either locale-dependent OR global
532 2. app-defaults file in $XAPPLRESDIR 548 2. app-defaults file in $XAPPLRESDIR
533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534 4. SCREEN_RESOURCES for the current screen 550 4. SCREEN_RESOURCES for the current screen
535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline
536 553
537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538names: 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
539common 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
540configured, while the class name B<URxvt> allows resources unique to 557configured, while the class name B<URxvt> allows resources unique to
… …
642 659
643B<False>: specify that everything is to be displayed, even 660B<False>: specify that everything is to be displayed, even
644if 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
645monitor to display anything); option B<+ss>. 662monitor to display anything); option B<+ss>.
646 663
647=item B<inheritPixmap:> I<boolean> 664=item B<transparent:> I<boolean>
648 665
649B<True>: make the background inherit the parent windows' pixmap, giving 666Turn on/off illusion of a transparent window background.
650artificial transparency. B<False>: do not inherit the parent windows'
651pixmap.
652 667
653I<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
654the 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@@)!>
655 673
656=item B<fading:> I<number> 674=item B<fading:> I<number>
657 675
658Fade 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>.
659 677
… …
693=item B<borderColor:> I<colour> 711=item B<borderColor:> I<colour>
694 712
695The 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
696and the text. 714and the text.
697 715
698=item B<backgroundPixmap:> I<file[;geom]> 716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699 717
700Use the specified image file for the background and also optionally 718Use the specified image file for the background and also
701specify its scaling with a geometry string B<WxH+X+Y>, 719optionally specify its scaling with a geometry string B<WxH+X+Y>,
702in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
703and B<"X" / "Y"> locate the image centre (percent). 721horizontal/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 722centre (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 723of 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 724an integer number of images in that direction. No image will be magnified
70710 times its original size. The maximum permitted scale is 1000. 725beyond 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 726Additional operations can be specified after colon B<:op1:op2...>.
709automatically 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
710If used in conjunction with B<-tr> option - specified pixmap will be 738If used in conjunction with B<-tr> option, the specified pixmap will be
711blended over transparency image using either alpha-blending, or any 739blended over transparency image using either alpha-blending, or any
712other blending type, specified with B<-blt "type"> option. 740other blending type, specified with B<-blt "type"> option.
713[default 0x0+50+50]
714 741
715=item B<path:> I<path> 742=item B<path:> I<path>
716 743
717Specify the colon-delimited search path for finding background image files. 744Specify the colon-delimited search path for finding background image files.
718 745
… …
991will be created). In this mode, characters outside ISO-8859-1 can be used. 1018will be created). In this mode, characters outside ISO-8859-1 can be used.
992 1019
993When the selection extension is not used, only ISO-8859-1 characters can 1020When the selection extension is not used, only ISO-8859-1 characters can
994be used. If not specified, the built-in default is used: 1021be used. If not specified, the built-in default is used:
995 1022
996B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1023B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
997 1024
998=item B<preeditType:> I<style> 1025=item B<preeditType:> I<style>
999 1026
1000B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1027B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1001 1028

Diff Legend

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