… | |
… | |
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 |
28 | world. Being a terminal emulator, however, some things are very difficult, |
28 | world. Being a terminal emulator, however, some things are very difficult, |
29 | especially cursive scripts such as arabic, vertically written scripts |
29 | especially cursive scripts such as arabic, vertically written scripts |
30 | like mongolian or scripts requiring extremely complex combining rules, |
30 | like mongolian or scripts requiring extremely complex combining rules, |
31 | like tibetan or devenagari. Don't expect pretty output when using these |
31 | like tibetan or devenagari. Don't expect pretty output when using these |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
33 | fine, though. A somewhat difficult case are left-to-right scripts, such |
33 | fine, though. A somewhat difficult case are right-to-left scripts, such |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
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 |
46 | display characters: The idea of a single unicode font which many other |
46 | display characters: The idea of a single unicode font which many other |
47 | programs force onto it's users never made sense to me: You should be able |
47 | programs force onto its users never made sense to me: You should be able |
48 | to choose any font for any script freely. |
48 | to choose any font for any script freely. |
49 | |
49 | |
50 | Apart from that, rxvt-unicode is also much better internationalised than |
50 | Apart from that, rxvt-unicode is also much better internationalised than |
51 | it's predecessor, supports things such as XFT and ISO 14755 that are handy |
51 | its predecessor, supports things such as XFT and ISO 14755 that are handy |
52 | in i18n-environments, is faster, and has a lot less bugs than the original |
52 | in i18n-environments, is faster, and has a lot bugs less than the original |
53 | rxvt. This all in addition to dozens of other small improvements. |
53 | rxvt. This all in addition to dozens of other small improvements. |
54 | |
54 | |
55 | It is still faithfully following the original rxvt idea of being lean |
55 | It is still faithfully following the original rxvt idea of being lean |
56 | and nice on resources: for example, you can still configure rxvt-unicode |
56 | and nice on resources: for example, you can still configure rxvt-unicode |
57 | without most of it's features to get a lean binary. It also comes with |
57 | without most of its features to get a lean binary. It also comes with |
58 | a client/daemon pair that lets you open any number of terminal windows |
58 | a client/daemon pair that lets you open any number of terminal windows |
59 | from within a single process, which makes startup time very fast and |
59 | from within a single process, which makes startup time very fast and |
60 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
60 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
61 | @@RXVT_NAME@@c(1) (client). |
61 | @@RXVT_NAME@@c(1) (client). |
62 | |
62 | |
63 | It also makes technical information about escape sequences (which have |
63 | It also makes technical information about escape sequences (which have |
64 | been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
64 | been extended) more accessible: see @@RXVT_NAME@@(7) for technical |
65 | reference documentation (escape sequences etc.). |
65 | reference documentation (escape sequences etc.). |
66 | |
66 | |
67 | =head1 OPTIONS |
67 | =head1 OPTIONS |
68 | |
68 | |
69 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
69 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
… | |
… | |
93 | |
93 | |
94 | Attempt to open a window on the named X display (B<-d> still |
94 | Attempt to open a window on the named X display (B<-d> still |
95 | respected). In the absence of this option, the display specified by the |
95 | respected). In the absence of this option, the display specified by the |
96 | B<DISPLAY> environment variable is used. |
96 | B<DISPLAY> environment variable is used. |
97 | |
97 | |
|
|
98 | =item B<-depth> I<bitdepth> |
|
|
99 | |
|
|
100 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
101 | resource B<depth>. |
|
|
102 | |
98 | =item B<-geometry> I<geom> |
103 | =item B<-geometry> I<geom> |
99 | |
104 | |
100 | Window geometry (B<-g> still respected); resource B<geometry>. |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
101 | |
106 | |
102 | =item B<-rv>|B<+rv> |
107 | =item B<-rv>|B<+rv> |
… | |
… | |
109 | |
114 | |
110 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
115 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
111 | |
116 | |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
117 | Turn on/off inheriting parent window's pixmap. Alternative form is |
113 | B<-tr>; resource B<inheritPixmap>. |
118 | B<-tr>; resource B<inheritPixmap>. |
|
|
119 | |
|
|
120 | I<Please note that transparency of any kind if completely unsupported by |
|
|
121 | the author. Don't bug him with installation questions! Read the FAQ (man 7 |
|
|
122 | @@RXVT_NAME@@)!> |
114 | |
123 | |
115 | =item B<-fade> I<number> |
124 | =item B<-fade> I<number> |
116 | |
125 | |
117 | Fade the text by the given percentage when focus is lost. Small values |
126 | Fade the text by the given percentage when focus is lost. Small values |
118 | fade a little only, 100 completely replaces all colours by the fade |
127 | fade a little only, 100 completely replaces all colours by the fade |
119 | colour; resource B<fading>. |
128 | colour; resource B<fading>. |
120 | |
129 | |
121 | =item B<-fadecolor> I<colour> |
130 | =item B<-fadecolor> I<colour> |
122 | |
131 | |
123 | Fade to this colour when fading is used (see B<-fade>). The default colour |
132 | Fade to this colour when fading is used (see B<-fade>). The default colour |
124 | is black. resource B<fadeColor>. |
133 | is opaque black. resource B<fadeColor>. |
125 | |
134 | |
126 | =item B<-tint> I<colour> |
135 | =item B<-tint> I<colour> |
127 | |
136 | |
128 | Tint the transparent background pixmap with the given colour when |
137 | Tint the transparent background pixmap with the given colour when |
129 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
138 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
… | |
… | |
135 | |
144 | |
136 | =item B<-sh> |
145 | =item B<-sh> |
137 | |
146 | |
138 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
147 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
139 | 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 |
140 | specified, too, e.g. C<-tint white>). |
149 | specified, too, e.g. C<-tint white>); resource I<shading>. |
141 | |
150 | |
142 | =item B<-bg> I<colour> |
151 | =item B<-bg> I<colour> |
143 | |
152 | |
144 | Window background colour; resource B<background>. |
153 | Window background colour; resource B<background>. |
145 | |
154 | |
… | |
… | |
177 | that are checked in order when trying to find glyphs for characters. The |
186 | that are checked in order when trying to find glyphs for characters. The |
178 | first font defines the cell size for characters; other fonts might be |
187 | first font defines the cell size for characters; other fonts might be |
179 | smaller, but not (in general) larger. A (hopefully) reasonable default |
188 | smaller, but not (in general) larger. A (hopefully) reasonable default |
180 | font list is always appended to it. See resource B<font> for more details. |
189 | font list is always appended to it. See resource B<font> for more details. |
181 | |
190 | |
182 | In short, to specify an X11 core font, just specify it's name or prefix it |
191 | In short, to specify an X11 core font, just specify its name or prefix it |
183 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
192 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
184 | e.g.: |
193 | e.g.: |
185 | |
194 | |
186 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
195 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
187 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
196 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
296 | =item B<-bl> |
305 | =item B<-bl> |
297 | |
306 | |
298 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
307 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
299 | if honoured by the WM, the rxvt-unicode window will not have window |
308 | if honoured by the WM, the rxvt-unicode window will not have window |
300 | decorations; resource B<borderLess>. |
309 | decorations; resource B<borderLess>. |
|
|
310 | |
|
|
311 | =item B<-override-redirect> |
|
|
312 | |
|
|
313 | Compile I<frills>: Sets override-redirect on the window; resource |
|
|
314 | B<override-redirect>. |
301 | |
315 | |
302 | =item B<-sbg> |
316 | =item B<-sbg> |
303 | |
317 | |
304 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
318 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
305 | drawing characters and just rely on what the specified fonts provide. Use |
319 | drawing characters and just rely on what the specified fonts provide. Use |
… | |
… | |
410 | |
424 | |
411 | Remap a key symbol. See resource B<keysym>. |
425 | Remap a key symbol. See resource B<keysym>. |
412 | |
426 | |
413 | =item B<-embed> I<windowid> |
427 | =item B<-embed> I<windowid> |
414 | |
428 | |
415 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
429 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
416 | which enables applications to easily embed a terminal. |
430 | which enables applications to easily embed a terminal. |
417 | |
431 | |
418 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
432 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
419 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
433 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
420 | quite a bit, so don't expect it to keep some specific state. It's best to |
434 | quite a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
423 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
437 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
424 | |
438 | |
425 | 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 |
426 | 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 |
427 | can use file descriptors to communicate with the programs within the |
441 | can use file descriptors to communicate with the programs within the |
428 | 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 |
429 | not. |
443 | not. |
430 | |
444 | |
431 | 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 |
432 | used (a longer example is in F<doc/embed>): |
446 | used (a longer example is in F<doc/embed>): |
433 | |
447 | |
… | |
… | |
438 | }); |
452 | }); |
439 | |
453 | |
440 | =item B<-pty-fd> I<file descriptor> |
454 | =item B<-pty-fd> I<file descriptor> |
441 | |
455 | |
442 | 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 |
443 | 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 |
444 | 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 |
445 | without having to run a program within it. |
459 | without having to run a program within it. |
446 | |
460 | |
447 | 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 |
448 | 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 |
… | |
… | |
500 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
514 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
501 | extensions not documented here): |
515 | extensions not documented here): |
502 | |
516 | |
503 | =over 4 |
517 | =over 4 |
504 | |
518 | |
|
|
519 | =item B<depth:> I<bitdepth> |
|
|
520 | |
|
|
521 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
522 | option B<-depth>. |
|
|
523 | |
505 | =item B<geometry:> I<geom> |
524 | =item B<geometry:> I<geom> |
506 | |
525 | |
507 | Create the window with the specified X window geometry [default 80x24]; |
526 | Create the window with the specified X window geometry [default 80x24]; |
508 | option B<-geometry>. |
527 | option B<-geometry>. |
509 | |
528 | |
… | |
… | |
545 | Use the specified colour to display underlined characters when the |
564 | Use the specified colour to display underlined characters when the |
546 | foreground colour is the default. |
565 | foreground colour is the default. |
547 | |
566 | |
548 | =item B<colorRV:> I<colour> |
567 | =item B<colorRV:> I<colour> |
549 | |
568 | |
550 | Use the specified colour as the background for reverse video |
569 | Use the specified colour as the background for reverse video characters |
551 | characters. |
570 | when OPTION_HC is disabled (--disable-frills). |
552 | |
571 | |
553 | =item B<underlineColor:> I<colour> |
572 | =item B<underlineColor:> I<colour> |
554 | |
573 | |
555 | 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 |
556 | itself. If unset, use the foreground colour. |
575 | itself. If unset, use the foreground colour. |
… | |
… | |
582 | |
601 | |
583 | B<True>: make the background inherit the parent windows' pixmap, giving |
602 | B<True>: make the background inherit the parent windows' pixmap, giving |
584 | artificial transparency. B<False>: do not inherit the parent windows' |
603 | artificial transparency. B<False>: do not inherit the parent windows' |
585 | pixmap. |
604 | pixmap. |
586 | |
605 | |
|
|
606 | I<Please note that transparency of any kind if completely unsupported by |
|
|
607 | the author. Don't bug him with installation questions!> |
|
|
608 | |
587 | =item B<fading:> I<number> |
609 | =item B<fading:> I<number> |
588 | |
610 | |
589 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
611 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
590 | |
612 | |
591 | =item B<fadeColor:> I<colour> |
613 | =item B<fadeColor:> I<colour> |
… | |
… | |
598 | Tint the transparent background pixmap with the given colour; option |
620 | Tint the transparent background pixmap with the given colour; option |
599 | B<-tint>. |
621 | B<-tint>. |
600 | |
622 | |
601 | =item B<shading:> I<number> |
623 | =item B<shading:> I<number> |
602 | |
624 | |
603 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
625 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
604 | image in addition to tinting it. |
626 | in addition to tinting it; option B<-sh>. |
605 | |
627 | |
606 | =item B<scrollColor:> I<colour> |
628 | =item B<scrollColor:> I<colour> |
607 | |
629 | |
608 | Use the specified colour for the scrollbar [default #B2B2B2]. |
630 | Use the specified colour for the scrollbar [default #B2B2B2]. |
609 | |
631 | |
… | |
… | |
627 | of 1 displays the image without any scaling. A scale of 2 to 9 |
649 | of 1 displays the image without any scaling. A scale of 2 to 9 |
628 | specifies an integer number of images in that direction. No image will |
650 | specifies an integer number of images in that direction. No image will |
629 | be magnified beyond 10 times its original size. The maximum permitted |
651 | be magnified beyond 10 times its original size. The maximum permitted |
630 | scale is 1000. [default 0x0+50+50] |
652 | scale is 1000. [default 0x0+50+50] |
631 | |
653 | |
632 | =item B<menu:> I<file[;tag]> |
|
|
633 | |
|
|
634 | Read in the specified menu file (note the `.menu' extension is |
|
|
635 | optional) and also optionally specify a starting tag to find. See the |
|
|
636 | reference documentation for details on the syntax for the menuBar. |
|
|
637 | |
|
|
638 | =item B<path:> I<path> |
654 | =item B<path:> I<path> |
639 | |
655 | |
640 | Specify the colon-delimited search path for finding files (XPM and |
656 | Specify the colon-delimited search path for finding XPM files. |
641 | menus), in addition to the paths specified by the B<RXVTPATH> and |
|
|
642 | B<PATH> environment variables. |
|
|
643 | |
657 | |
644 | =item B<font:> I<fontlist> |
658 | =item B<font:> I<fontlist> |
645 | |
659 | |
646 | Select the fonts to be used. This is a comma separated list of font names |
660 | Select the fonts to be used. This is a comma separated list of font names |
647 | that are checked in order when trying to find glyphs for characters. The |
661 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
657 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
671 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
658 | fonts. |
672 | fonts. |
659 | |
673 | |
660 | For example, this font resource |
674 | For example, this font resource |
661 | |
675 | |
662 | URxvt*font: 9x15bold,\ |
676 | URxvt.font: 9x15bold,\ |
663 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
677 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
664 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
678 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
665 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
679 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
666 | xft:Code2000:antialias=false |
680 | xft:Code2000:antialias=false |
667 | |
681 | |
… | |
… | |
705 | |
719 | |
706 | =item B<intensityStyles:> I<boolean> |
720 | =item B<intensityStyles:> I<boolean> |
707 | |
721 | |
708 | 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>, |
709 | 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 |
710 | intensity foreground/backround colours. Disabling this option (B<False>, |
724 | intensity foreground/background colours. Disabling this option (B<False>, |
711 | 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 |
712 | reachable. |
726 | reachable. |
713 | |
727 | |
714 | =item B<selectstyle:> I<mode> |
728 | =item B<selectstyle:> I<mode> |
715 | |
729 | |
… | |
… | |
764 | |
778 | |
765 | The string will be interpreted as if typed into the shell as-is. |
779 | The string will be interpreted as if typed into the shell as-is. |
766 | |
780 | |
767 | Example: |
781 | Example: |
768 | |
782 | |
769 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
783 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
770 | |
784 | |
771 | 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 |
772 | everytime you hit C<Print>. |
786 | every time you hit C<Print>. |
773 | |
787 | |
774 | =item B<scrollBar:> I<boolean> |
788 | =item B<scrollBar:> I<boolean> |
775 | |
789 | |
776 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
790 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
777 | disable the scrollbar; option B<+sb>. |
791 | disable the scrollbar; option B<+sb>. |
… | |
… | |
799 | |
813 | |
800 | =item B<scrollWithBuffer:> I<boolean> |
814 | =item B<scrollWithBuffer:> I<boolean> |
801 | |
815 | |
802 | 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 |
803 | 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 |
804 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
818 | with scrollback buffer when tty receives new lines; option B<+sw>. |
805 | |
819 | |
806 | =item B<scrollTtyKeypress:> I<boolean> |
820 | =item B<scrollTtyKeypress:> I<boolean> |
807 | |
821 | |
808 | 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 |
809 | 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 |
… | |
… | |
899 | pressed. If unset it will send the sequence traditionally associated |
913 | pressed. If unset it will send the sequence traditionally associated |
900 | with the B<Execute> key. |
914 | with the B<Execute> key. |
901 | |
915 | |
902 | =item B<cutchars:> I<string> |
916 | =item B<cutchars:> I<string> |
903 | |
917 | |
904 | The characters used as delimiters for double-click word selection. The |
918 | The characters used as delimiters for double-click word selection |
905 | built-in default: |
919 | (whitespace delimiting is added automatically if resource is given). |
|
|
920 | |
|
|
921 | When the selection extension is in use (the default if compiled in, see |
|
|
922 | the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters |
|
|
923 | will be created (if the resource exists, otherwise, no regex will be |
|
|
924 | created). In this mode, characters outside ISO-8859-1 can be used. |
|
|
925 | |
|
|
926 | When the selection extension is not used, only ISO-8859-1 characters can |
|
|
927 | be used. If not specified, the built-in default is used: |
906 | |
928 | |
907 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
929 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
908 | |
930 | |
909 | =item B<preeditType:> I<style> |
931 | =item B<preeditType:> I<style> |
910 | |
932 | |
… | |
… | |
946 | default. (Note that many other terminals, including xterm, have these |
968 | default. (Note that many other terminals, including xterm, have these |
947 | sequences enabled by default, which doesn't make it safer, though). |
969 | sequences enabled by default, which doesn't make it safer, though). |
948 | |
970 | |
949 | You can enable them by setting this boolean resource or specifying |
971 | You can enable them by setting this boolean resource or specifying |
950 | B<-insecure> as an option. At the moment, this enables display-answer, |
972 | B<-insecure> as an option. At the moment, this enables display-answer, |
951 | locale, findfont, icon label and window title requests as well as dynamic |
973 | locale, findfont, icon label and window title requests. |
952 | menubar dispatch. |
|
|
953 | |
974 | |
954 | =item B<modifier:> I<modifier> |
975 | =item B<modifier:> I<modifier> |
955 | |
976 | |
956 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
977 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
957 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
978 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
961 | |
982 | |
962 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
983 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
963 | character is passed through. It may contain escape values as described |
984 | character is passed through. It may contain escape values as described |
964 | in the entry on B<keysym> following. |
985 | in the entry on B<keysym> following. |
965 | |
986 | |
966 | =item B<secondaryScreen:> I<bool> |
987 | =item B<secondaryScreen:> I<boolean> |
967 | |
988 | |
968 | Turn on/off secondary screen (default enabled). |
989 | Turn on/off secondary screen (default enabled). |
969 | |
990 | |
970 | =item B<secondaryScroll:> I<bool> |
991 | =item B<secondaryScroll:> I<boolean> |
971 | |
992 | |
972 | Turn on/off secondary screen scroll (default enabled). If the this |
993 | Turn on/off secondary screen scroll (default enabled). If the this |
973 | option is enabled, scrolls on the secondary screen will change the |
994 | option is enabled, scrolls on the secondary screen will change the |
974 | scrollback buffer and switching to/from the secondary screen will |
995 | scrollback buffer and switching to/from the secondary screen will |
975 | instead scroll the screen up. |
996 | instead scroll the screen up. |
976 | |
997 | |
977 | =item B<hold>: I<bool> |
998 | =item B<hold>: I<boolean> |
978 | |
999 | |
979 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1000 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
980 | will not immediately destroy its window when the program executed within |
1001 | will not immediately destroy its window when the program executed within |
981 | it exits. Instead, it will wait till it is being killed or closed by the |
1002 | it exits. Instead, it will wait till it is being killed or closed by the |
982 | user. |
1003 | user. |
… | |
… | |
1005 | |
1026 | |
1006 | 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, |
1007 | 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, |
1008 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1029 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1009 | 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 |
1010 | can start or end with whitespace. |
1031 | can start or end with whitespace. B<This feature is deprecated and will |
|
|
1032 | be removed>. |
1011 | |
1033 | |
1012 | 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 |
1013 | Xlib itself does it's 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 |
1014 | 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 |
1015 | processing). |
1037 | processing). |
1016 | |
1038 | |
1017 | 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> |
1018 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1040 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1019 | should be a character not used by the strings. |
1041 | should be a character not used by the strings. |
1020 | |
1042 | |
1021 | Its usage can be demonstrated by an example: |
1043 | Its usage can be demonstrated by an example: |
1022 | |
1044 | |
1023 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1045 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
1087 | example, C<default,-selection> will use all the default extension except |
1109 | example, C<default,-selection> will use all the default extension except |
1088 | C<selection>. |
1110 | C<selection>. |
1089 | |
1111 | |
1090 | 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 |
1091 | (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 |
1092 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1114 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1093 | multiple times with different arguments will pass multiple arguments to |
1115 | multiple times with different arguments will pass multiple arguments to |
1094 | the extension. |
1116 | the extension. |
1095 | |
1117 | |
1096 | Each extension is looked up in the library directories, loaded if |
1118 | Each extension is looked up in the library directories, loaded if |
1097 | necessary, and bound to the current terminal instance. |
1119 | necessary, and bound to the current terminal instance. |
… | |
… | |
1133 | (default: C<M-s>). |
1155 | (default: C<M-s>). |
1134 | |
1156 | |
1135 | =item B<urlLauncher>: I<string> |
1157 | =item B<urlLauncher>: I<string> |
1136 | |
1158 | |
1137 | 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 |
1138 | C<selection-popup> and C<mark-urls> perl extensions. |
1160 | C<selection-popup> and C<matcher> perl extensions. |
1139 | |
1161 | |
1140 | =item B<transient-for>: I<windowid> |
1162 | =item B<transient-for>: I<windowid> |
1141 | |
1163 | |
1142 | Sets the WM_TRANSIENT_FOR property to the given window iw. |
1164 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
|
|
1165 | |
|
|
1166 | =item B<override-redirect>: I<boolean> |
|
|
1167 | |
|
|
1168 | Compile I<frills>: Sets override-redirect for the terminal window, making |
|
|
1169 | it almost invisible to window managers; option B<-override-redirect>. |
1143 | |
1170 | |
1144 | =back |
1171 | =back |
1145 | |
1172 | |
1146 | =head1 THE SCROLLBAR |
1173 | =head1 THE SCROLLBAR |
1147 | |
1174 | |
… | |
… | |
1189 | selection, and trailing whitespace is visually underlined and removed from |
1216 | selection, and trailing whitespace is visually underlined and removed from |
1190 | the selection. |
1217 | the selection. |
1191 | |
1218 | |
1192 | =item B<Insertion>: |
1219 | =item B<Insertion>: |
1193 | |
1220 | |
1194 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1221 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1195 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
1222 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1196 | inserted as if it had been typed on the keyboard. |
1223 | Meta modifier) to be inserted as if it had been typed on the keyboard. |
|
|
1224 | |
|
|
1225 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
|
|
1226 | inserted too. |
1197 | |
1227 | |
1198 | =back |
1228 | =back |
1199 | |
1229 | |
1200 | =head1 CHANGING FONTS |
1230 | =head1 CHANGING FONTS |
1201 | |
1231 | |
1202 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1232 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1203 | supported in rxvt-unicode. Bug me if you need this. |
1233 | supported in rxvt-unicode. Bug me if you need this. |
1204 | |
1234 | |
1205 | You can, however, switch fonts at runtime using escape sequences (and |
1235 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
1206 | therefore using the menubar), e.g.: |
|
|
1207 | |
1236 | |
1208 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
1237 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1238 | |
|
|
1239 | You can use keyboard shortcuts, too: |
|
|
1240 | |
|
|
1241 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1242 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
1209 | |
1243 | |
1210 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1244 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1211 | |
1245 | |
1212 | =head1 ISO 14755 SUPPORT |
1246 | =head1 ISO 14755 SUPPORT |
1213 | |
1247 | |
… | |
… | |
1241 | This mode lets you input characters representing the keycap symbols of |
1275 | This mode lets you input characters representing the keycap symbols of |
1242 | your keyboard, if representable in the current locale encoding. |
1276 | your keyboard, if representable in the current locale encoding. |
1243 | |
1277 | |
1244 | Start by pressing C<Control> and C<Shift> together, then releasing |
1278 | Start by pressing C<Control> and C<Shift> together, then releasing |
1245 | them. The next special key (cursor keys, home etc.) you enter will not |
1279 | them. The next special key (cursor keys, home etc.) you enter will not |
1246 | invoke it's usual function but instead will insert the corresponding |
1280 | invoke its usual function but instead will insert the corresponding |
1247 | keycap symbol. The symbol will only be entered when the key has been |
1281 | keycap symbol. The symbol will only be entered when the key has been |
1248 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1282 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1249 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1283 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1250 | reverse tab (Shift-Tab). |
1284 | reverse tab (Shift-Tab). |
1251 | |
1285 | |
… | |
… | |
1284 | =head1 COLORS AND GRAPHICS |
1318 | =head1 COLORS AND GRAPHICS |
1285 | |
1319 | |
1286 | In addition to the default foreground and background colours, |
1320 | In addition to the default foreground and background colours, |
1287 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1321 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1288 | high-intensity bold/blink versions of the same). Here is a list of the |
1322 | high-intensity bold/blink versions of the same). Here is a list of the |
1289 | colours with their B<rgb.txt> names. |
1323 | colours with their names. |
1290 | |
1324 | |
1291 | =begin table |
1325 | =begin table |
1292 | |
1326 | |
1293 | B<color0> (black) = Black |
1327 | B<color0> (black) = Black |
1294 | B<color1> (red) = Red3 |
1328 | B<color1> (red) = Red3 |
… | |
… | |
1314 | It is also possible to specify the colour values of B<foreground>, |
1348 | It is also possible to specify the colour values of B<foreground>, |
1315 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1349 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1316 | a number 0-15, as a convenient shorthand to reference the colour name of |
1350 | a number 0-15, as a convenient shorthand to reference the colour name of |
1317 | color0-color15. |
1351 | color0-color15. |
1318 | |
1352 | |
|
|
1353 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
|
|
1354 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
|
|
1355 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1356 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1357 | |
|
|
1358 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1359 | the first 16 can be changed using resources currently, the rest can only |
|
|
1360 | be changed via command sequences ("escape codes"). |
|
|
1361 | |
1319 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1362 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1320 | always swapping the foreground/background colours. This is in contrast to |
1363 | always swapping the foreground/background colours. This is in contrast to |
1321 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1364 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1322 | been specified. For example, |
1365 | been specified. For example, |
1323 | |
1366 | |
… | |
… | |
1328 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1371 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1329 | on White. |
1372 | on White. |
1330 | |
1373 | |
1331 | =back |
1374 | =back |
1332 | |
1375 | |
|
|
1376 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1377 | |
|
|
1378 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1379 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
|
|
1380 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
|
|
1381 | in addition to the ones provided by X, where the additional A component |
|
|
1382 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
|
|
1383 | transparent). You can also prefix any color with C<[percent]>, where |
|
|
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. |
|
|
1387 | |
|
|
1388 | You probably need to specify B<"-depth 32">, too, and have the luck that |
|
|
1389 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1390 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1391 | |
|
|
1392 | For example, the following selects an almost completely transparent red |
|
|
1393 | background, and an almost opaque pink foreground: |
|
|
1394 | |
|
|
1395 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
|
|
1396 | |
|
|
1397 | I<Please note that transparency of any kind if completely unsupported by |
|
|
1398 | the author. Don't bug him with installation questions!> |
|
|
1399 | |
1333 | =head1 ENVIRONMENT |
1400 | =head1 ENVIRONMENT |
1334 | |
1401 | |
1335 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1402 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1336 | |
1403 | |
1337 | =over 4 |
1404 | =over 4 |
1338 | |
1405 | |
1339 | =item B<TERM> |
1406 | =item B<TERM> |
1340 | |
1407 | |
1341 | 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 |
1342 | resources or on the commandline. |
1409 | resources or on the command line. |
1343 | |
1410 | |
1344 | =item B<COLORTERM> |
1411 | =item B<COLORTERM> |
1345 | |
1412 | |
1346 | 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 |
1347 | compiled with XPM support, and optionally with the added extension |
1414 | compiled with XPM support, and optionally with the added extension |
1348 | 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. |
1349 | |
1416 | |
1350 | =item B<COLORFGBG> |
1417 | =item B<COLORFGBG> |
1351 | |
1418 | |
… | |
… | |
1369 | C<--with-terminfo=PATH>. |
1436 | C<--with-terminfo=PATH>. |
1370 | |
1437 | |
1371 | =item B<DISPLAY> |
1438 | =item B<DISPLAY> |
1372 | |
1439 | |
1373 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1440 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1374 | display in it's child processes. |
1441 | display in its child processes. |
1375 | |
1442 | |
1376 | =item B<SHELL> |
1443 | =item B<SHELL> |
1377 | |
1444 | |
1378 | The shell to be used for command execution, defaults to C</bin/sh>. |
1445 | The shell to be used for command execution, defaults to C</bin/sh>. |
1379 | |
|
|
1380 | =item B<RXVTPATH> |
|
|
1381 | |
|
|
1382 | The path where @@RXVT_NAME@@ looks for support files such as menu and xpm |
|
|
1383 | files. |
|
|
1384 | |
|
|
1385 | =item B<PATH> |
|
|
1386 | |
|
|
1387 | Used in the same way as C<RXVTPATH>. |
|
|
1388 | |
1446 | |
1389 | =item B<RXVT_SOCKET> |
1447 | =item B<RXVT_SOCKET> |
1390 | |
1448 | |
1391 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1449 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1392 | @@RXVT_NAME@@d(1). |
1450 | @@RXVT_NAME@@d(1). |
… | |
… | |
1430 | |
1488 | |
1431 | =item Project Coordinator |
1489 | =item Project Coordinator |
1432 | |
1490 | |
1433 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1491 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1434 | |
1492 | |
1435 | L<http://software.schmorp.de/#rxvt-unicode> |
1493 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1436 | |
1494 | |
1437 | =back |
1495 | =back |
1438 | |
1496 | |
1439 | =head1 AUTHORS |
1497 | =head1 AUTHORS |
1440 | |
1498 | |
… | |
… | |
1462 | |
1520 | |
1463 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1521 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1464 | |
1522 | |
1465 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1523 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1466 | |
1524 | |
1467 | Rewrote screen display and text selection routines. Project Coordinator |
1525 | Rewrote screen display and text selection routines. |
|
|
1526 | |
1468 | (changes.txt 2.4.6 - rxvt-unicode) |
1527 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1469 | |
1528 | |
1470 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1529 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1471 | |
1530 | |
1472 | Forked rxvt-unicode, rewrote most of the display code and internal |
1531 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1473 | character handling to store text in unicode, improve xterm |
1532 | extension, random hacks, numerous bugfixes and extensions. |
1474 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1475 | |
1533 | |
1476 | Project Coordinator (Changes 1.0 -) |
1534 | Project Coordinator (Changes 1.0 -) |
1477 | |
1535 | |
|
|
1536 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
|
|
1537 | |
|
|
1538 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1539 | |
1478 | =back |
1540 | =back |
1479 | |
1541 | |