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.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
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>
417 415
418=item B<-tcw> 416=item B<-tcw>
419 417
420Change the meaning of triple-click selection with the left mouse 418Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is 419button. Only effective when the original (non-perl) selection code is
422in-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
423end of the logical line only. resource B<tripleclickwords>. 421the end of the logical line only. resource B<tripleclickwords>.
424 422
425=item B<-insecure> 423=item B<-insecure>
426 424
427Enable "insecure" mode, which currently enables most of the escape 425Enable "insecure" mode, which currently enables most of the escape
428sequences that echo strings. See the resource B<insecure> for more 426sequences that echo strings. See the resource B<insecure> for more
448 446
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>.
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.
453 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
492If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 503If 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 504entries and will not tinker with pty/tty permissions - you have to do that
494yourself if you want that. 505yourself if you want that.
495 506
496As an extremely special case, specifying C<-1> will completely suppress 507As an extremely special case, specifying C<-1> will completely suppress
497pty/tty operations. 508pty/tty operations, which is probably only useful in conjunction with some
509perl extension that manages the terminal.
498 510
499Here is a example in perl that illustrates how this option can be used (a 511Here is a example in perl that illustrates how this option can be used (a
500longer example is in F<doc/pty-fd>): 512longer example is in F<doc/pty-fd>):
501 513
502 use IO::Pty; 514 use IO::Pty;
516Comma-separated list of perl extension scripts to use (or not to use) in 528Comma-separated list of perl extension scripts to use (or not to use) in
517this terminal instance. See resource B<perl-ext> for details. 529this terminal instance. See resource B<perl-ext> for details.
518 530
519=back 531=back
520 532
521=head1 RESOURCES (available also as long-options) 533=head1 RESOURCES
522 534
523Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 535Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524options) compiled into your version. 536options) compiled into your version. All resources are also available as
537long-options.
525 538
526You can set and change the resources using X11 tools like B<xrdb>. Many 539You 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 540distribution do also load settings from the B<~/.Xresources> file when X
528starts. @@RXVT_NAME@@ will consult the following files/resources in order, 541starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529with later settings overwriting earlier ones: 542with later settings overwriting earlier ones:
531 1. system-wide app-defaults file, either locale-dependent OR global 544 1. system-wide app-defaults file, either locale-dependent OR global
532 2. app-defaults file in $XAPPLRESDIR 545 2. app-defaults file in $XAPPLRESDIR
533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 546 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534 4. SCREEN_RESOURCES for the current screen 547 4. SCREEN_RESOURCES for the current screen
535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 548 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549 6. resources specified via -xrm on the commandline
536 550
537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 551Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538names: 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
539common 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
540configured, while the class name B<URxvt> allows resources unique to 554configured, while the class name B<URxvt> allows resources unique to
642 656
643B<False>: specify that everything is to be displayed, even 657B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the 658if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>. 659monitor to display anything); option B<+ss>.
646 660
647=item B<inheritPixmap:> I<boolean> 661=item B<transparent:> I<boolean>
648 662
649B<True>: make the background inherit the parent windows' pixmap, giving 663Turn on/off illusion of a transparent window background.
650artificial transparency. B<False>: do not inherit the parent windows'
651pixmap.
652 664
653I<Please note that transparency of any kind if completely unsupported by 665B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654the author. Don't bug him with installation questions!> 666future versions.
667
668I<Please address all transparency related issues to Sasha Vasko at
669sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
655 670
656=item B<fading:> I<number> 671=item B<fading:> I<number>
657 672
658Fade the text by the given percentage when focus is lost; option B<-fade>. 673Fade the text by the given percentage when focus is lost; option B<-fade>.
659 674
695The colour of the border around the text area and between the scrollbar 710The colour of the border around the text area and between the scrollbar
696and the text. 711and the text.
697 712
698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 713=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699 714
700Use the specified image file for the background and also optionally 715Use the specified image file for the background and also
701specify its scaling with a geometry string B<WxH+X+Y>, 716optionally specify its scaling with a geometry string B<WxH+X+Y>,
702in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 717(default C<0x0+50+50>) in which B<"W" / "H"> specify the
703and B<"X" / "Y"> locate the image centre (percent). 718horizontal/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 719centre (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 720of 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 721an integer number of images in that direction. No image will be magnified
70710 times its original size. The maximum permitted scale is 1000. 722beyond 10 times its original size. The maximum permitted scale is 1000.
708Additional operations can be specified after colon B<:op1:op2...>. 723Additional operations can be specified after colon B<:op1:op2...>.
709Supported operations are: 724Supported operations are:
725
710 B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0, 726 tile force background image to be tiled and not scaled. Equivalent to 0x0,
711 B<"propscale"> - will scale image keeping proportions, 727 propscale will scale image keeping proportions,
712 B<"auto"> - will scale image to match window size. Equivalent to 100x100; 728 auto will scale image to match window size. Equivalent to 100x100;
713 B<"hscale"> - will scale image horizontally to the window size; 729 hscale will scale image horizontally to the window size;
714 B<"vscale"> - will scale image vertically to the window size; 730 vscale will scale image vertically to the window size;
715 B<"scale"> - will scale image to match window size; 731 scale will scale image to match window size;
716 B<"root"> - will tile image as if it was a root window background, auto-adjusting 732 root will tile image as if it was a root window background, auto-adjusting
717 whenever terminal window moves. 733 whenever terminal window moves.
718 734
719If used in conjunction with B<-tr> option - specified pixmap will be 735If used in conjunction with B<-tr> option, the specified pixmap will be
720blended over transparency image using either alpha-blending, or any 736blended over transparency image using either alpha-blending, or any
721other blending type, specified with B<-blt "type"> option. 737other blending type, specified with B<-blt "type"> option.
722[default 0x0+50+50]
723 738
724=item B<path:> I<path> 739=item B<path:> I<path>
725 740
726Specify the colon-delimited search path for finding background image files. 741Specify the colon-delimited search path for finding background image files.
727 742
1000will be created). In this mode, characters outside ISO-8859-1 can be used. 1015will be created). In this mode, characters outside ISO-8859-1 can be used.
1001 1016
1002When the selection extension is not used, only ISO-8859-1 characters can 1017When the selection extension is not used, only ISO-8859-1 characters can
1003be used. If not specified, the built-in default is used: 1018be used. If not specified, the built-in default is used:
1004 1019
1005B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1020B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1006 1021
1007=item B<preeditType:> I<style> 1022=item B<preeditType:> I<style>
1008 1023
1009B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1024B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1010 1025

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines