… | |
… | |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | |
18 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
19 | 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 |
20 | frequently asked questions and answer to them and some common |
21 | problems. That document is also accessible on the World-Wide-Web at |
21 | problems. That document is also accessible on the World-Wide-Web at |
22 | L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
22 | L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. |
23 | |
23 | |
24 | =head1 RXVT-UNICODE VS. RXVT |
24 | =head1 RXVT-UNICODE VS. RXVT |
25 | |
25 | |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
26 | 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 |
27 | internally. That means it can store and display most scripts in the |
… | |
… | |
35 | belong into the application, not the terminal emulator (too many things -- |
35 | belong into the application, not the terminal emulator (too many things -- |
36 | such as cursor-movement while editing -- break otherwise), but that might |
36 | such as cursor-movement while editing -- break otherwise), but that might |
37 | change. |
37 | change. |
38 | |
38 | |
39 | If you are looking for a terminal that supports more exotic scripts, let |
39 | If you are looking for a terminal that supports more exotic scripts, let |
40 | me recommend C<mlterm>, which is a very userfriendly, lean and clean |
40 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
41 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
41 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
42 | because the author couldn't get C<mlterm> to use one font for latin1 and |
42 | because the author couldn't get C<mlterm> to use one font for latin1 and |
43 | another for japanese. |
43 | another for japanese. |
44 | |
44 | |
45 | Therefore another design rationale was the use of multiple fonts to |
45 | Therefore another design rationale was the use of multiple fonts to |
… | |
… | |
144 | |
144 | |
145 | =item B<-sh> |
145 | =item B<-sh> |
146 | |
146 | |
147 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
147 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
148 | background image in addition to tinting it (i.e. B<-tint> must be |
148 | background image in addition to tinting it (i.e. B<-tint> must be |
149 | specified, too, e.g. C<-tint white>). |
149 | specified, too, e.g. C<-tint white>); resource I<shading>. |
150 | |
150 | |
151 | =item B<-bg> I<colour> |
151 | =item B<-bg> I<colour> |
152 | |
152 | |
153 | Window background colour; resource B<background>. |
153 | Window background colour; resource B<background>. |
154 | |
154 | |
… | |
… | |
437 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
437 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
438 | |
438 | |
439 | It might be useful to know that @@RXVT_NAME@@ will not close file |
439 | It might be useful to know that @@RXVT_NAME@@ will not close file |
440 | descriptors passed to it (except for stdin/out/err, of course), so you |
440 | descriptors passed to it (except for stdin/out/err, of course), so you |
441 | can use file descriptors to communicate with the programs within the |
441 | can use file descriptors to communicate with the programs within the |
442 | terminal. This works regardless of wether the C<-embed> option was used or |
442 | terminal. This works regardless of whether the C<-embed> option was used or |
443 | not. |
443 | not. |
444 | |
444 | |
445 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
445 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
446 | used (a longer example is in F<doc/embed>): |
446 | used (a longer example is in F<doc/embed>): |
447 | |
447 | |
… | |
… | |
452 | }); |
452 | }); |
453 | |
453 | |
454 | =item B<-pty-fd> I<file descriptor> |
454 | =item B<-pty-fd> I<file descriptor> |
455 | |
455 | |
456 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
456 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
457 | pair but instead use the given filehandle as the tty master. This is |
457 | pair but instead use the given file descriptor as the tty master. This is |
458 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
458 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
459 | without having to run a program within it. |
459 | without having to run a program within it. |
460 | |
460 | |
461 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
461 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
462 | entries and will not tinker with pty/tty permissions - you have to do that |
462 | entries and will not tinker with pty/tty permissions - you have to do that |
… | |
… | |
564 | Use the specified colour to display underlined characters when the |
564 | Use the specified colour to display underlined characters when the |
565 | foreground colour is the default. |
565 | foreground colour is the default. |
566 | |
566 | |
567 | =item B<colorRV:> I<colour> |
567 | =item B<colorRV:> I<colour> |
568 | |
568 | |
569 | Use the specified colour as the background for reverse video |
569 | Use the specified colour as the background for reverse video characters |
570 | characters. |
570 | when OPTION_HC is disabled (--disable-frills). |
571 | |
571 | |
572 | =item B<underlineColor:> I<colour> |
572 | =item B<underlineColor:> I<colour> |
573 | |
573 | |
574 | If set, use the specified colour as the colour for the underline |
574 | If set, use the specified colour as the colour for the underline |
575 | itself. If unset, use the foreground colour. |
575 | itself. If unset, use the foreground colour. |
… | |
… | |
620 | Tint the transparent background pixmap with the given colour; option |
620 | Tint the transparent background pixmap with the given colour; option |
621 | B<-tint>. |
621 | B<-tint>. |
622 | |
622 | |
623 | =item B<shading:> I<number> |
623 | =item B<shading:> I<number> |
624 | |
624 | |
625 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
625 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
626 | image in addition to tinting it. |
626 | in addition to tinting it; option B<-sh>. |
627 | |
627 | |
628 | =item B<scrollColor:> I<colour> |
628 | =item B<scrollColor:> I<colour> |
629 | |
629 | |
630 | Use the specified colour for the scrollbar [default #B2B2B2]. |
630 | Use the specified colour for the scrollbar [default #B2B2B2]. |
631 | |
631 | |
… | |
… | |
719 | |
719 | |
720 | =item B<intensityStyles:> I<boolean> |
720 | =item B<intensityStyles:> I<boolean> |
721 | |
721 | |
722 | When font styles are not enabled, or this option is enabled (B<True>, |
722 | When font styles are not enabled, or this option is enabled (B<True>, |
723 | option B<-is>, the default), bold and italic font styles imply high |
723 | option B<-is>, the default), bold and italic font styles imply high |
724 | intensity foreground/backround colours. Disabling this option (B<False>, |
724 | intensity foreground/background colours. Disabling this option (B<False>, |
725 | option B<+is>) disables this behaviour, the high intensity colours are not |
725 | option B<+is>) disables this behaviour, the high intensity colours are not |
726 | reachable. |
726 | reachable. |
727 | |
727 | |
728 | =item B<selectstyle:> I<mode> |
728 | =item B<selectstyle:> I<mode> |
729 | |
729 | |
… | |
… | |
781 | Example: |
781 | Example: |
782 | |
782 | |
783 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
783 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
784 | |
784 | |
785 | This creates a new file in your home directory with the screen contents |
785 | This creates a new file in your home directory with the screen contents |
786 | everytime you hit C<Print>. |
786 | every time you hit C<Print>. |
787 | |
787 | |
788 | =item B<scrollBar:> I<boolean> |
788 | =item B<scrollBar:> I<boolean> |
789 | |
789 | |
790 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
790 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
791 | disable the scrollbar; option B<+sb>. |
791 | disable the scrollbar; option B<+sb>. |
… | |
… | |
813 | |
813 | |
814 | =item B<scrollWithBuffer:> I<boolean> |
814 | =item B<scrollWithBuffer:> I<boolean> |
815 | |
815 | |
816 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
816 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
817 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
817 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
818 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
818 | with scrollback buffer when tty receives new lines; option B<+sw>. |
819 | |
819 | |
820 | =item B<scrollTtyKeypress:> I<boolean> |
820 | =item B<scrollTtyKeypress:> I<boolean> |
821 | |
821 | |
822 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
822 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
823 | are those which are intercepted by rxvt-unicode for special handling and |
823 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
1026 | |
1026 | |
1027 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1027 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1028 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1028 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1029 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1029 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1030 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1030 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1031 | can start or end with whitespace. |
1031 | can start or end with whitespace. B<This feature is deprecated and will |
|
|
1032 | be removed>. |
1032 | |
1033 | |
1033 | Please note that you need to double the C<\> in resource files, as |
1034 | Please note that you need to double the C<\> in resource files, as |
1034 | Xlib itself does its own de-escaping (you can use C<\033> instead of |
1035 | Xlib itself does its own de-escaping (you can use C<\033> instead of |
1035 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1036 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1036 | processing). |
1037 | processing). |
1037 | |
1038 | |
1038 | You can define a range of keysyms in one shot by providing a I<string> |
1039 | You can define a range of keysyms in one shot by providing a I<string> |
1039 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1040 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1040 | should be a character not used by the strings. |
1041 | should be a character not used by the strings. |
1041 | |
1042 | |
1042 | Its usage can be demonstrated by an example: |
1043 | Its usage can be demonstrated by an example: |
1043 | |
1044 | |
1044 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1045 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
1108 | example, C<default,-selection> will use all the default extension except |
1109 | example, C<default,-selection> will use all the default extension except |
1109 | C<selection>. |
1110 | C<selection>. |
1110 | |
1111 | |
1111 | Extension names can also be followed by an argument in angle brackets |
1112 | Extension names can also be followed by an argument in angle brackets |
1112 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1113 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1113 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1114 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1114 | multiple times with different arguments will pass multiple arguments to |
1115 | multiple times with different arguments will pass multiple arguments to |
1115 | the extension. |
1116 | the extension. |
1116 | |
1117 | |
1117 | Each extension is looked up in the library directories, loaded if |
1118 | Each extension is looked up in the library directories, loaded if |
1118 | necessary, and bound to the current terminal instance. |
1119 | necessary, and bound to the current terminal instance. |
… | |
… | |
1154 | (default: C<M-s>). |
1155 | (default: C<M-s>). |
1155 | |
1156 | |
1156 | =item B<urlLauncher>: I<string> |
1157 | =item B<urlLauncher>: I<string> |
1157 | |
1158 | |
1158 | Specifies the program to be started with a URL argument. Used by the |
1159 | Specifies the program to be started with a URL argument. Used by the |
1159 | C<selection-popup> and C<mark-urls> perl extensions. |
1160 | C<selection-popup> and C<matcher> perl extensions. |
1160 | |
1161 | |
1161 | =item B<transient-for>: I<windowid> |
1162 | =item B<transient-for>: I<windowid> |
1162 | |
1163 | |
1163 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1164 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1164 | |
1165 | |
… | |
… | |
1377 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1378 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1378 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1379 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1379 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1380 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1380 | in addition to the ones provided by X, where the additional A component |
1381 | in addition to the ones provided by X, where the additional A component |
1381 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1382 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1382 | transparent). You can also prefix any color with C<[a]>, where C<a> is on |
1383 | transparent). You can also prefix any color with C<[percent]>, where |
1383 | to four hex digits specifiying the opacity value. |
1384 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
|
|
1385 | the color, where C<0> is completely transparent and C<100> is completelxy |
|
|
1386 | opaque. |
1384 | |
1387 | |
1385 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1388 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1386 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1389 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1387 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1390 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1388 | |
1391 | |
1389 | For example, the following selects an almost completely transparent red |
1392 | For example, the following selects an almost completely transparent red |
1390 | background, and an almost opaque pink foreground: |
1393 | background, and an almost opaque pink foreground: |
1391 | |
1394 | |
1392 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" |
1395 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1393 | |
1396 | |
1394 | I<Please note that transparency of any kind if completely unsupported by |
1397 | I<Please note that transparency of any kind if completely unsupported by |
1395 | the author. Don't bug him with installation questions!> |
1398 | the author. Don't bug him with installation questions!> |
1396 | |
1399 | |
1397 | =head1 ENVIRONMENT |
1400 | =head1 ENVIRONMENT |
… | |
… | |
1401 | =over 4 |
1404 | =over 4 |
1402 | |
1405 | |
1403 | =item B<TERM> |
1406 | =item B<TERM> |
1404 | |
1407 | |
1405 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1408 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1406 | resources or on the commandline. |
1409 | resources or on the command line. |
1407 | |
1410 | |
1408 | =item B<COLORTERM> |
1411 | =item B<COLORTERM> |
1409 | |
1412 | |
1410 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1413 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1411 | compiled with XPM support, and optionally with the added extension |
1414 | compiled with XPM support, and optionally with the added extension |
1412 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1415 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1413 | |
1416 | |
1414 | =item B<COLORFGBG> |
1417 | =item B<COLORFGBG> |
1415 | |
1418 | |