… | |
… | |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
15 | a significant advantage on a machine serving many X sessions. |
15 | a significant advantage on a machine serving many X sessions. |
16 | |
16 | |
|
|
17 | This document is also available on the World-Wide-Web at |
|
|
18 | L<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 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
22 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
20 | frequently asked questions and answer to them and some common |
23 | frequently asked questions and answer to them and some common |
21 | problems. That document is also accessible on the World-Wide-Web at |
24 | problems. That document is also accessible on the World-Wide-Web at |
22 | L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. |
25 | L<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 | |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
29 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
27 | internally. That means it can store and display most scripts in the |
30 | internally. That means it can store and display most scripts in the |
… | |
… | |
30 | like mongolian or scripts requiring extremely complex combining rules, |
33 | like mongolian or scripts requiring extremely complex combining rules, |
31 | like tibetan or devanagari. Don't expect pretty output when using these |
34 | like tibetan or devanagari. Don't expect pretty output when using these |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
35 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
33 | fine, though. A somewhat difficult case are right-to-left scripts, such |
36 | fine, though. A somewhat difficult case are right-to-left scripts, such |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
37 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
35 | belong into the application, not the terminal emulator (too many things -- |
38 | belong in the application, not the terminal emulator (too many things -- |
36 | such as cursor-movement while editing -- break otherwise), but that might |
39 | such as cursor-movement while editing -- break otherwise), but that might |
37 | change. |
40 | change. |
38 | |
41 | |
39 | If you are looking for a terminal that supports more exotic scripts, let |
42 | If you are looking for a terminal that supports more exotic scripts, let |
40 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
43 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
… | |
… | |
116 | |
119 | |
117 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
120 | Turn 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 | |
121 | Turn on/off illusion of a transparent window background. Obsolete form of it is |
124 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
122 | B<-ip> and it should not be used anymore; resource B<transparent>. |
|
|
123 | |
125 | |
124 | I<Please note that old resource name of B<inheritPixmap> is obsolete and should be |
126 | B<-ip> is still accepted as an obsolete alias but will be removed in |
125 | changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will |
127 | future versions. |
126 | be phased out in future versions of rxvt!> |
|
|
127 | |
128 | |
128 | I<Please address all transparency related issues to Sasha Vasko at |
129 | I<Please address all transparency related issues to Sasha Vasko at |
129 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
130 | sasha@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 | |
133 | Fade the text by the given percentage when focus is lost. Small values |
134 | Fade the text by the given percentage when focus is lost. Small values |
… | |
… | |
145 | transparency is enabled with B<-tr>. This only works for |
146 | transparency is enabled with B<-tr>. This only works for |
146 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
147 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
147 | used to brighten or darken the image in addition to tinting it. |
148 | used to brighten or darken the image in addition to tinting it. |
148 | Please note that certain tint colours can be applied on the server-side, |
149 | Please note that certain tint colours can be applied on the server-side, |
149 | thus yielding performance gain of two orders of magnitude. These colours are: |
150 | thus yielding performance gain of two orders of magnitude. These colours are: |
150 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
151 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
151 | pure black and pure white colors essentially mean no tinting; resource |
152 | pure black and pure white colors essentially mean no tinting; resource |
152 | I<tintColor>. Example: |
153 | I<tintColor>. Example: |
153 | |
154 | |
154 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
155 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
155 | |
156 | |
… | |
… | |
184 | |
185 | |
185 | =item B<-fg> I<colour> |
186 | =item B<-fg> I<colour> |
186 | |
187 | |
187 | Window foreground colour; resource B<foreground>. |
188 | Window 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 | |
191 | Compile I<afterimage>: Specify image file for the background and also |
192 | Compile I<afterimage>: Specify image file for the background and also |
192 | optionally specify its scaling with a geometry string. Note you may need to |
193 | optionally specify its scaling with a geometry string. Note you may need to |
193 | add quotes to avoid special shell interpretation of the C<;> in the |
194 | add quotes to avoid special shell interpretation of the C<;> in the |
194 | command-line; for more details see resource B<backgroundPixmap>. |
195 | command-line; for more details see resource B<backgroundPixmap>. |
195 | |
196 | |
196 | =item B<-cr> I<colour> |
197 | =item B<-cr> I<colour> |
… | |
… | |
417 | |
418 | |
418 | =item B<-tcw> |
419 | =item B<-tcw> |
419 | |
420 | |
420 | Change the meaning of triple-click selection with the left mouse |
421 | Change the meaning of triple-click selection with the left mouse |
421 | button. Only effective when the original (non-perl) selection code is |
422 | button. Only effective when the original (non-perl) selection code is |
422 | in-use. Instead of selecting a full line it will extend the selection the |
423 | in-use. Instead of selecting a full line it will extend the selection to |
423 | end of the logical line only. resource B<tripleclickwords>. |
424 | the end of the logical line only. resource B<tripleclickwords>. |
424 | |
425 | |
425 | =item B<-insecure> |
426 | =item B<-insecure> |
426 | |
427 | |
427 | Enable "insecure" mode, which currently enables most of the escape |
428 | Enable "insecure" mode, which currently enables most of the escape |
428 | sequences that echo strings. See the resource B<insecure> for more |
429 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
448 | |
449 | |
449 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
450 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
450 | will not immediately destroy its window when the program executed within |
451 | will not immediately destroy its window when the program executed within |
451 | it exits. Instead, it will wait till it is being killed or closed by the |
452 | it exits. Instead, it will wait till it is being killed or closed by the |
452 | user; resource B<hold>. |
453 | user; resource B<hold>. |
|
|
454 | |
|
|
455 | =item B<-xrm> I<string> |
|
|
456 | |
|
|
457 | Works like the X Toolkit option of the same name, by adding the I<string> |
|
|
458 | as if it were specified in a resource file. Resource values specified this |
|
|
459 | way take precedence over all other resource specifications. |
|
|
460 | |
|
|
461 | Note that you need to use the I<same> syntax as in the .Xdefaults file, |
|
|
462 | e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific |
|
|
463 | options can be specified as long-options on the commandline, so use |
|
|
464 | of B<-xrm> is mostly limited to cases where you want to specify other |
|
|
465 | resources (e.g. for input methods) or for compatibility with other |
|
|
466 | programs. |
453 | |
467 | |
454 | =item B<-keysym.>I<sym> I<string> |
468 | =item B<-keysym.>I<sym> I<string> |
455 | |
469 | |
456 | Remap a key symbol. See resource B<keysym>. |
470 | Remap a key symbol. See resource B<keysym>. |
457 | |
471 | |
… | |
… | |
492 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
506 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
493 | entries and will not tinker with pty/tty permissions - you have to do that |
507 | entries and will not tinker with pty/tty permissions - you have to do that |
494 | yourself if you want that. |
508 | yourself if you want that. |
495 | |
509 | |
496 | As an extremely special case, specifying C<-1> will completely suppress |
510 | As an extremely special case, specifying C<-1> will completely suppress |
497 | pty/tty operations. |
511 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
512 | perl extension that manages the terminal. |
498 | |
513 | |
499 | Here is a example in perl that illustrates how this option can be used (a |
514 | Here is a example in perl that illustrates how this option can be used (a |
500 | longer example is in F<doc/pty-fd>): |
515 | longer example is in F<doc/pty-fd>): |
501 | |
516 | |
502 | use IO::Pty; |
517 | use IO::Pty; |
… | |
… | |
516 | Comma-separated list of perl extension scripts to use (or not to use) in |
531 | Comma-separated list of perl extension scripts to use (or not to use) in |
517 | this terminal instance. See resource B<perl-ext> for details. |
532 | this 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 | |
523 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
538 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
524 | options) compiled into your version. |
539 | options) compiled into your version. All resources are also available as |
|
|
540 | long-options. |
525 | |
541 | |
526 | You can set and change the resources using X11 tools like B<xrdb>. Many |
542 | You can set and change the resources using X11 tools like B<xrdb>. Many |
527 | distribution do also load settings from the B<~/.Xresources> file when X |
543 | distribution do also load settings from the B<~/.Xresources> file when X |
528 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
544 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
529 | with later settings overwriting earlier ones: |
545 | with 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 | |
537 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
554 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
538 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
555 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
539 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
556 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
540 | configured, while the class name B<URxvt> allows resources unique to |
557 | configured, while the class name B<URxvt> allows resources unique to |
… | |
… | |
642 | |
659 | |
643 | B<False>: specify that everything is to be displayed, even |
660 | B<False>: specify that everything is to be displayed, even |
644 | if the refresh is too fast for the human eye to read anything (or the |
661 | if the refresh is too fast for the human eye to read anything (or the |
645 | monitor to display anything); option B<+ss>. |
662 | monitor to display anything); option B<+ss>. |
646 | |
663 | |
647 | =item B<inheritPixmap:> I<boolean> |
664 | =item B<transparent:> I<boolean> |
648 | |
665 | |
649 | B<True>: make the background inherit the parent windows' pixmap, giving |
666 | Turn on/off illusion of a transparent window background. |
650 | artificial transparency. B<False>: do not inherit the parent windows' |
|
|
651 | pixmap. |
|
|
652 | |
667 | |
653 | I<Please note that transparency of any kind if completely unsupported by |
668 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
654 | the author. Don't bug him with installation questions!> |
669 | future versions. |
|
|
670 | |
|
|
671 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
672 | sasha@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 | |
658 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
676 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
659 | |
677 | |
… | |
… | |
676 | |
694 | |
677 | Specify background blending type; option B<-blt>. |
695 | Specify background blending type; option B<-blt>. |
678 | |
696 | |
679 | =item B<blurRadius:> I<number> |
697 | =item B<blurRadius:> I<number> |
680 | |
698 | |
681 | Apply Gaussian Blurr with the specified radius to the transparent |
699 | Apply Gaussian Blurr with the specified radius to the transparent |
682 | background image; option B<-blr>. |
700 | background image; option B<-blr>. |
683 | |
701 | |
684 | =item B<scrollColor:> I<colour> |
702 | =item B<scrollColor:> I<colour> |
685 | |
703 | |
686 | Use the specified colour for the scrollbar [default #B2B2B2]. |
704 | Use the specified colour for the scrollbar [default #B2B2B2]. |
… | |
… | |
693 | =item B<borderColor:> I<colour> |
711 | =item B<borderColor:> I<colour> |
694 | |
712 | |
695 | The colour of the border around the text area and between the scrollbar |
713 | The colour of the border around the text area and between the scrollbar |
696 | and the text. |
714 | and the text. |
697 | |
715 | |
698 | =item B<backgroundPixmap:> I<file[;geom]> |
716 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
699 | |
717 | |
700 | Use the specified image file for the background and also optionally |
718 | Use the specified image file for the background and also |
701 | specify its scaling with a geometry string B<WxH+X+Y>, |
719 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
702 | in which B<"W" / "H"> specify the horizontal/vertical scale (percent), |
720 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
703 | and B<"X" / "Y"> locate the image centre (percent). |
721 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
704 | A scale of 0 displays the image with tiling. A scale of 1 displays the |
722 | centre (percent). A scale of 0 displays the image with tiling. A scale |
705 | image without any scaling. A scale of 2 to 9 specifies an integer |
723 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
706 | number of images in that direction. No image will be magnified beyond |
724 | an integer number of images in that direction. No image will be magnified |
707 | 10 times its original size. The maximum permitted scale is 1000. |
725 | beyond 10 times its original size. The maximum permitted scale is 1000. |
708 | Special string of B<"auto"> used as a geometry will cause image to be |
726 | Additional operations can be specified after colon B<:op1:op2...>. |
709 | automatically scaled to match window size. |
727 | Supported 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 | |
710 | If used in conjunction with B<-tr> option - specified pixmap will be |
738 | If used in conjunction with B<-tr> option, the specified pixmap will be |
711 | blended over transparency image using either alpha-blending, or any |
739 | blended over transparency image using either alpha-blending, or any |
712 | other blending type, specified with B<-blt "type"> option. |
740 | other 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 | |
717 | Specify the colon-delimited search path for finding background image files. |
744 | Specify the colon-delimited search path for finding background image files. |
718 | |
745 | |
… | |
… | |
991 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
1018 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
992 | |
1019 | |
993 | When the selection extension is not used, only ISO-8859-1 characters can |
1020 | When the selection extension is not used, only ISO-8859-1 characters can |
994 | be used. If not specified, the built-in default is used: |
1021 | be used. If not specified, the built-in default is used: |
995 | |
1022 | |
996 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
1023 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
997 | |
1024 | |
998 | =item B<preeditType:> I<style> |
1025 | =item B<preeditType:> I<style> |
999 | |
1026 | |
1000 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1027 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1001 | |
1028 | |
… | |
… | |
1471 | resources or on the command line. |
1498 | resources or on the command line. |
1472 | |
1499 | |
1473 | =item B<COLORTERM> |
1500 | =item B<COLORTERM> |
1474 | |
1501 | |
1475 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1502 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1476 | compiled with background image support, and optionally with the added |
1503 | compiled with background image support, and optionally with the added |
1477 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
1504 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
1478 | screen. |
1505 | screen. |
1479 | |
1506 | |
1480 | =item B<COLORFGBG> |
1507 | =item B<COLORFGBG> |
1481 | |
1508 | |
1482 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1509 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1483 | the colour code used as default foreground/text colour (or the string |
1510 | the colour code used as default foreground/text colour (or the string |
1484 | C<default> to indicate that the default-colour escape sequence is to be |
1511 | C<default> to indicate that the default-colour escape sequence is to be |
1485 | used), C<bg> is the colour code used as default background colour (or the |
1512 | used), C<bg> is the colour code used as default background colour (or the |
1486 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1513 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1487 | was compiled with background image support. Libraries like C<ncurses> |
1514 | was compiled with background image support. Libraries like C<ncurses> |
1488 | and C<slang> can (and do) use this information to optimize screen output. |
1515 | and C<slang> can (and do) use this information to optimize screen output. |
1489 | |
1516 | |
1490 | =item B<WINDOWID> |
1517 | =item B<WINDOWID> |
1491 | |
1518 | |
1492 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1519 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
… | |
… | |
1584 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1611 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1585 | |
1612 | |
1586 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1613 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1587 | |
1614 | |
1588 | Rewrote screen display and text selection routines. |
1615 | Rewrote screen display and text selection routines. |
1589 | |
1616 | |
1590 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1617 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1591 | |
1618 | |
1592 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1619 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1593 | |
1620 | |
1594 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1621 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |