… | |
… | |
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 |
… | |
… | |
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> |
98 | =item B<-depth> I<bitdepth> |
99 | |
99 | |
100 | Compile I<frills>: Attempt to find a visual with the given bit depth; |
100 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
101 | resource B<depth>. |
101 | resource B<depth>. |
102 | |
102 | |
103 | =item B<-geometry> I<geom> |
103 | =item B<-geometry> I<geom> |
104 | |
104 | |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
… | |
… | |
114 | |
114 | |
115 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
115 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
116 | |
116 | |
117 | Turn on/off inheriting parent window's pixmap. Alternative form is |
117 | Turn on/off inheriting parent window's pixmap. Alternative form is |
118 | 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@@)!> |
119 | |
123 | |
120 | =item B<-fade> I<number> |
124 | =item B<-fade> I<number> |
121 | |
125 | |
122 | 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 |
123 | 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 |
124 | colour; resource B<fading>. |
128 | colour; resource B<fading>. |
125 | |
129 | |
126 | =item B<-fadecolor> I<colour> |
130 | =item B<-fadecolor> I<colour> |
127 | |
131 | |
128 | 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 |
129 | is black. resource B<fadeColor>. |
133 | is opaque black. resource B<fadeColor>. |
130 | |
134 | |
131 | =item B<-tint> I<colour> |
135 | =item B<-tint> I<colour> |
132 | |
136 | |
133 | Tint the transparent background pixmap with the given colour when |
137 | Tint the transparent background pixmap with the given colour when |
134 | 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 |
… | |
… | |
136 | used to brighten or darken the image in addition to tinting it; resource |
140 | used to brighten or darken the image in addition to tinting it; resource |
137 | I<tintColor>. Example: |
141 | I<tintColor>. Example: |
138 | |
142 | |
139 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
143 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
140 | |
144 | |
141 | =item B<-sh> |
145 | =item B<-sh> I<number> |
142 | |
146 | |
143 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
147 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
144 | background image in addition to tinting it (i.e. B<-tint> must be |
148 | background image in addition to (or instead of) tinting it; |
145 | specified, too, e.g. C<-tint white>). |
149 | resource I<shading>. |
|
|
150 | |
|
|
151 | =item B<-blt> I<string> |
|
|
152 | |
|
|
153 | Specify background blending type. If background pixmap is specified |
|
|
154 | at the same time as transparency - such pixmap will be blended over |
|
|
155 | transparency image, using method specified. Supported values are : |
|
|
156 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
|
|
157 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
|
|
158 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
|
|
159 | alpha-blending; resource I<blendType>. |
|
|
160 | |
|
|
161 | =item B<-blr> I<number> |
|
|
162 | |
|
|
163 | Apply Gaussian Blur with the specified radius to the transparent |
|
|
164 | background image; resource I<blurRadius>. |
146 | |
165 | |
147 | =item B<-bg> I<colour> |
166 | =item B<-bg> I<colour> |
148 | |
167 | |
149 | Window background colour; resource B<background>. |
168 | Window background colour; resource B<background>. |
150 | |
169 | |
… | |
… | |
152 | |
171 | |
153 | Window foreground colour; resource B<foreground>. |
172 | Window foreground colour; resource B<foreground>. |
154 | |
173 | |
155 | =item B<-pixmap> I<file[;geom]> |
174 | =item B<-pixmap> I<file[;geom]> |
156 | |
175 | |
157 | Compile I<XPM>: Specify XPM file for the background and also optionally |
176 | Compile I<afterimage>: Specify image file for the background and also |
158 | specify its scaling with a geometry string. Note you may need to |
177 | optionally specify its scaling with a geometry string. Note you may need to |
159 | add quotes to avoid special shell interpretation of the C<;> in the |
178 | add quotes to avoid special shell interpretation of the C<;> in the |
160 | command-line; resource B<backgroundPixmap>. |
179 | command-line; for more details see resource B<backgroundPixmap>. |
161 | |
180 | |
162 | =item B<-cr> I<colour> |
181 | =item B<-cr> I<colour> |
163 | |
182 | |
164 | The cursor colour; resource B<cursorColor>. |
183 | The cursor colour; resource B<cursorColor>. |
165 | |
184 | |
… | |
… | |
182 | that are checked in order when trying to find glyphs for characters. The |
201 | that are checked in order when trying to find glyphs for characters. The |
183 | first font defines the cell size for characters; other fonts might be |
202 | first font defines the cell size for characters; other fonts might be |
184 | smaller, but not (in general) larger. A (hopefully) reasonable default |
203 | smaller, but not (in general) larger. A (hopefully) reasonable default |
185 | font list is always appended to it. See resource B<font> for more details. |
204 | font list is always appended to it. See resource B<font> for more details. |
186 | |
205 | |
187 | In short, to specify an X11 core font, just specify it's name or prefix it |
206 | In short, to specify an X11 core font, just specify its name or prefix it |
188 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
207 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
189 | e.g.: |
208 | e.g.: |
190 | |
209 | |
191 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
210 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
192 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
211 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
382 | for more info. |
401 | for more info. |
383 | |
402 | |
384 | =item B<-tcw> |
403 | =item B<-tcw> |
385 | |
404 | |
386 | Change the meaning of triple-click selection with the left mouse |
405 | Change the meaning of triple-click selection with the left mouse |
|
|
406 | button. Only effective when the original (non-perl) selection code is |
387 | button. Instead of selecting a full line it will extend the selection the |
407 | in-use. Instead of selecting a full line it will extend the selection the |
388 | end of the logical line only. resource B<tripleclickwords>. |
408 | end of the logical line only. resource B<tripleclickwords>. |
389 | |
409 | |
390 | =item B<-insecure> |
410 | =item B<-insecure> |
391 | |
411 | |
392 | Enable "insecure" mode, which currently enables most of the escape |
412 | Enable "insecure" mode, which currently enables most of the escape |
… | |
… | |
420 | |
440 | |
421 | Remap a key symbol. See resource B<keysym>. |
441 | Remap a key symbol. See resource B<keysym>. |
422 | |
442 | |
423 | =item B<-embed> I<windowid> |
443 | =item B<-embed> I<windowid> |
424 | |
444 | |
425 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
445 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
426 | which enables applications to easily embed a terminal. |
446 | which enables applications to easily embed a terminal. |
427 | |
447 | |
428 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
448 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
429 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
449 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
430 | quite a bit, so don't expect it to keep some specific state. It's best to |
450 | quite a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
433 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
453 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
434 | |
454 | |
435 | It might be useful to know that @@RXVT_NAME@@ will not close file |
455 | It might be useful to know that @@RXVT_NAME@@ will not close file |
436 | descriptors passed to it (except for stdin/out/err, of course), so you |
456 | descriptors passed to it (except for stdin/out/err, of course), so you |
437 | can use file descriptors to communicate with the programs within the |
457 | can use file descriptors to communicate with the programs within the |
438 | terminal. This works regardless of wether the C<-embed> option was used or |
458 | terminal. This works regardless of whether the C<-embed> option was used or |
439 | not. |
459 | not. |
440 | |
460 | |
441 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
461 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
442 | used (a longer example is in F<doc/embed>): |
462 | used (a longer example is in F<doc/embed>): |
443 | |
463 | |
… | |
… | |
448 | }); |
468 | }); |
449 | |
469 | |
450 | =item B<-pty-fd> I<file descriptor> |
470 | =item B<-pty-fd> I<file descriptor> |
451 | |
471 | |
452 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
472 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
453 | pair but instead use the given filehandle as the tty master. This is |
473 | pair but instead use the given file descriptor as the tty master. This is |
454 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
474 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
455 | without having to run a program within it. |
475 | without having to run a program within it. |
456 | |
476 | |
457 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
477 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
458 | entries and will not tinker with pty/tty permissions - you have to do that |
478 | entries and will not tinker with pty/tty permissions - you have to do that |
… | |
… | |
512 | |
532 | |
513 | =over 4 |
533 | =over 4 |
514 | |
534 | |
515 | =item B<depth:> I<bitdepth> |
535 | =item B<depth:> I<bitdepth> |
516 | |
536 | |
517 | Compile I<frills>: Attempt to find a visual with the given bit depth; |
537 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
518 | option B<-depth>. |
538 | option B<-depth>. |
519 | |
539 | |
520 | =item B<geometry:> I<geom> |
540 | =item B<geometry:> I<geom> |
521 | |
541 | |
522 | Create the window with the specified X window geometry [default 80x24]; |
542 | Create the window with the specified X window geometry [default 80x24]; |
… | |
… | |
560 | Use the specified colour to display underlined characters when the |
580 | Use the specified colour to display underlined characters when the |
561 | foreground colour is the default. |
581 | foreground colour is the default. |
562 | |
582 | |
563 | =item B<colorRV:> I<colour> |
583 | =item B<colorRV:> I<colour> |
564 | |
584 | |
565 | Use the specified colour as the background for reverse video |
585 | Use the specified colour as the background for reverse video characters |
566 | characters. |
586 | when OPTION_HC is disabled (--disable-frills). |
567 | |
587 | |
568 | =item B<underlineColor:> I<colour> |
588 | =item B<underlineColor:> I<colour> |
569 | |
589 | |
570 | If set, use the specified colour as the colour for the underline |
590 | If set, use the specified colour as the colour for the underline |
571 | itself. If unset, use the foreground colour. |
591 | itself. If unset, use the foreground colour. |
… | |
… | |
597 | |
617 | |
598 | B<True>: make the background inherit the parent windows' pixmap, giving |
618 | B<True>: make the background inherit the parent windows' pixmap, giving |
599 | artificial transparency. B<False>: do not inherit the parent windows' |
619 | artificial transparency. B<False>: do not inherit the parent windows' |
600 | pixmap. |
620 | pixmap. |
601 | |
621 | |
|
|
622 | I<Please note that transparency of any kind if completely unsupported by |
|
|
623 | the author. Don't bug him with installation questions!> |
|
|
624 | |
602 | =item B<fading:> I<number> |
625 | =item B<fading:> I<number> |
603 | |
626 | |
604 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
627 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
605 | |
628 | |
606 | =item B<fadeColor:> I<colour> |
629 | =item B<fadeColor:> I<colour> |
… | |
… | |
613 | Tint the transparent background pixmap with the given colour; option |
636 | Tint the transparent background pixmap with the given colour; option |
614 | B<-tint>. |
637 | B<-tint>. |
615 | |
638 | |
616 | =item B<shading:> I<number> |
639 | =item B<shading:> I<number> |
617 | |
640 | |
618 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
641 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
619 | image in addition to tinting it. |
642 | in addition to tinting it; option B<-sh>. |
|
|
643 | |
|
|
644 | =item B<blendType:> I<string> |
|
|
645 | |
|
|
646 | Specify background blending type; option B<-blt>. |
|
|
647 | |
|
|
648 | =item B<blurRadius:> I<number> |
|
|
649 | |
|
|
650 | Apply Gaussian Blurr with the specified radius to the transparent |
|
|
651 | background image; option B<-blr>. |
620 | |
652 | |
621 | =item B<scrollColor:> I<colour> |
653 | =item B<scrollColor:> I<colour> |
622 | |
654 | |
623 | Use the specified colour for the scrollbar [default #B2B2B2]. |
655 | Use the specified colour for the scrollbar [default #B2B2B2]. |
624 | |
656 | |
… | |
… | |
632 | The colour of the border around the text area and between the scrollbar |
664 | The colour of the border around the text area and between the scrollbar |
633 | and the text. |
665 | and the text. |
634 | |
666 | |
635 | =item B<backgroundPixmap:> I<file[;geom]> |
667 | =item B<backgroundPixmap:> I<file[;geom]> |
636 | |
668 | |
637 | Use the specified XPM file (note the `.xpm' extension is optional) for |
669 | Use the specified image file for the background and also optionally |
638 | the background and also optionally specify its scaling with a geometry |
670 | specify its scaling with a geometry string B<WxH+X+Y>, |
639 | string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
671 | in which B<"W" / "H"> specify the horizontal/vertical scale (percent), |
640 | horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
672 | and B<"X" / "Y"> locate the image centre (percent). |
641 | centre (percent). A scale of 0 displays the image with tiling. A scale |
673 | A scale of 0 displays the image with tiling. A scale of 1 displays the |
642 | of 1 displays the image without any scaling. A scale of 2 to 9 |
674 | image without any scaling. A scale of 2 to 9 specifies an integer |
643 | specifies an integer number of images in that direction. No image will |
675 | number of images in that direction. No image will be magnified beyond |
644 | be magnified beyond 10 times its original size. The maximum permitted |
676 | 10 times its original size. The maximum permitted scale is 1000. |
645 | scale is 1000. [default 0x0+50+50] |
677 | Special string of B<"auto"> used as a geometry will cause image to be |
|
|
678 | automatically scaled to match window size. |
|
|
679 | If used in conjunction with B<-tr> option - specified pixmap will be |
|
|
680 | blended over transparency image using either alpha-blending, or any |
|
|
681 | other blending type, specified with B<-blt "type"> option. |
|
|
682 | [default 0x0+50+50] |
646 | |
683 | |
647 | =item B<path:> I<path> |
684 | =item B<path:> I<path> |
648 | |
685 | |
649 | Specify the colon-delimited search path for finding XPM files. |
686 | Specify the colon-delimited search path for finding XPM files. |
650 | |
687 | |
… | |
… | |
712 | |
749 | |
713 | =item B<intensityStyles:> I<boolean> |
750 | =item B<intensityStyles:> I<boolean> |
714 | |
751 | |
715 | When font styles are not enabled, or this option is enabled (B<True>, |
752 | When font styles are not enabled, or this option is enabled (B<True>, |
716 | option B<-is>, the default), bold and italic font styles imply high |
753 | option B<-is>, the default), bold and italic font styles imply high |
717 | intensity foreground/backround colours. Disabling this option (B<False>, |
754 | intensity foreground/background colours. Disabling this option (B<False>, |
718 | option B<+is>) disables this behaviour, the high intensity colours are not |
755 | option B<+is>) disables this behaviour, the high intensity colours are not |
719 | reachable. |
756 | reachable. |
720 | |
757 | |
721 | =item B<selectstyle:> I<mode> |
758 | =item B<selectstyle:> I<mode> |
722 | |
759 | |
723 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
760 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
724 | xterm style with 2.20 old word selection, or anything else which gives |
761 | is xterm style with 2.20 old word selection, or anything else which |
725 | xterm style selection. |
762 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
763 | selection code is in use. |
726 | |
764 | |
727 | =item B<scrollstyle:> I<mode> |
765 | =item B<scrollstyle:> I<mode> |
728 | |
766 | |
729 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
767 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
730 | the author's favourite. |
768 | the author's favourite. |
… | |
… | |
744 | =item B<mapAlert:> I<boolean> |
782 | =item B<mapAlert:> I<boolean> |
745 | |
783 | |
746 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
784 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
747 | de-iconify (map) on receipt of a bell character [default]. |
785 | de-iconify (map) on receipt of a bell character [default]. |
748 | |
786 | |
|
|
787 | =item B<urgentOnBell:> I<boolean> |
|
|
788 | |
|
|
789 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
|
|
790 | B<False>: do not set the urgency hint [default]. |
|
|
791 | |
749 | =item B<visualBell:> I<boolean> |
792 | =item B<visualBell:> I<boolean> |
750 | |
793 | |
751 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
794 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
752 | B<False>: no visual bell [default]; option B<+vb>. |
795 | B<False>: no visual bell [default]; option B<+vb>. |
753 | |
796 | |
… | |
… | |
774 | Example: |
817 | Example: |
775 | |
818 | |
776 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
819 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
777 | |
820 | |
778 | This creates a new file in your home directory with the screen contents |
821 | This creates a new file in your home directory with the screen contents |
779 | everytime you hit C<Print>. |
822 | every time you hit C<Print>. |
780 | |
823 | |
781 | =item B<scrollBar:> I<boolean> |
824 | =item B<scrollBar:> I<boolean> |
782 | |
825 | |
783 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
826 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
784 | disable the scrollbar; option B<+sb>. |
827 | disable the scrollbar; option B<+sb>. |
… | |
… | |
806 | |
849 | |
807 | =item B<scrollWithBuffer:> I<boolean> |
850 | =item B<scrollWithBuffer:> I<boolean> |
808 | |
851 | |
809 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
852 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
810 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
853 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
811 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
854 | with scrollback buffer when tty receives new lines; option B<+sw>. |
812 | |
855 | |
813 | =item B<scrollTtyKeypress:> I<boolean> |
856 | =item B<scrollTtyKeypress:> I<boolean> |
814 | |
857 | |
815 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
858 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
816 | are those which are intercepted by rxvt-unicode for special handling and |
859 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
909 | =item B<cutchars:> I<string> |
952 | =item B<cutchars:> I<string> |
910 | |
953 | |
911 | The characters used as delimiters for double-click word selection |
954 | The characters used as delimiters for double-click word selection |
912 | (whitespace delimiting is added automatically if resource is given). |
955 | (whitespace delimiting is added automatically if resource is given). |
913 | |
956 | |
914 | When the selection extension is in use (the default if compiled in, see |
957 | When the perl selection extension is in use (the default if compiled |
915 | the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters |
958 | in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these |
916 | will be created (if the resource exists, otherwise, no regex will be |
959 | characters will be created (if the resource exists, otherwise, no regex |
917 | created). In this mode, characters outside ISO-8859-1 can be used. |
960 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
918 | |
961 | |
919 | When the selection extension is not used, only ISO-8859-1 characters can |
962 | When the selection extension is not used, only ISO-8859-1 characters can |
920 | be used. If not specified, the built-in default is used: |
963 | be used. If not specified, the built-in default is used: |
921 | |
964 | |
922 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
965 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
… | |
… | |
981 | |
1024 | |
982 | Turn on/off secondary screen (default enabled). |
1025 | Turn on/off secondary screen (default enabled). |
983 | |
1026 | |
984 | =item B<secondaryScroll:> I<boolean> |
1027 | =item B<secondaryScroll:> I<boolean> |
985 | |
1028 | |
986 | Turn on/off secondary screen scroll (default enabled). If the this |
1029 | Turn on/off secondary screen scroll (default enabled). If this |
987 | option is enabled, scrolls on the secondary screen will change the |
1030 | option is enabled, scrolls on the secondary screen will change the |
988 | scrollback buffer and switching to/from the secondary screen will |
1031 | scrollback buffer and switching to/from the secondary screen will |
989 | instead scroll the screen up. |
1032 | instead scroll the screen up. |
990 | |
1033 | |
991 | =item B<hold>: I<boolean> |
1034 | =item B<hold>: I<boolean> |
… | |
… | |
1019 | |
1062 | |
1020 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1063 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1021 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1064 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1022 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1065 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1023 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1066 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1024 | can start or end with whitespace. |
1067 | can start or end with whitespace. B<This feature is deprecated and will |
|
|
1068 | be removed>. |
1025 | |
1069 | |
1026 | Please note that you need to double the C<\> in resource files, as |
1070 | Please note that you need to double the C<\> in resource files, as |
1027 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
1071 | Xlib itself does its own de-escaping (you can use C<\033> instead of |
1028 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1072 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1029 | processing). |
1073 | processing). |
1030 | |
1074 | |
1031 | You can define a range of keysyms in one shot by providing a I<string> |
1075 | You can define a range of keysyms in one shot by providing a I<string> |
1032 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1076 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1033 | should be a character not used by the strings. |
1077 | should be a character not used by the strings. |
1034 | |
1078 | |
1035 | Its usage can be demonstrated by an example: |
1079 | Its usage can be demonstrated by an example: |
1036 | |
1080 | |
1037 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1081 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
1101 | example, C<default,-selection> will use all the default extension except |
1145 | example, C<default,-selection> will use all the default extension except |
1102 | C<selection>. |
1146 | C<selection>. |
1103 | |
1147 | |
1104 | Extension names can also be followed by an argument in angle brackets |
1148 | Extension names can also be followed by an argument in angle brackets |
1105 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1149 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1106 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1150 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1107 | multiple times with different arguments will pass multiple arguments to |
1151 | multiple times with different arguments will pass multiple arguments to |
1108 | the extension. |
1152 | the extension. |
1109 | |
1153 | |
1110 | Each extension is looked up in the library directories, loaded if |
1154 | Each extension is looked up in the library directories, loaded if |
1111 | necessary, and bound to the current terminal instance. |
1155 | necessary, and bound to the current terminal instance. |
… | |
… | |
1147 | (default: C<M-s>). |
1191 | (default: C<M-s>). |
1148 | |
1192 | |
1149 | =item B<urlLauncher>: I<string> |
1193 | =item B<urlLauncher>: I<string> |
1150 | |
1194 | |
1151 | Specifies the program to be started with a URL argument. Used by the |
1195 | Specifies the program to be started with a URL argument. Used by the |
1152 | C<selection-popup> and C<mark-urls> perl extensions. |
1196 | C<selection-popup> and C<matcher> perl extensions. |
1153 | |
1197 | |
1154 | =item B<transient-for>: I<windowid> |
1198 | =item B<transient-for>: I<windowid> |
1155 | |
1199 | |
1156 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1200 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1157 | |
1201 | |
1158 | =item B<override-redirect>: I<boolean> |
1202 | =item B<override-redirect>: I<boolean> |
1159 | |
1203 | |
1160 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1204 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1161 | it almost invisible to window managers; option B<-override-redirect>. |
1205 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1206 | |
|
|
1207 | =item B<iso14755_52:> I<boolean> |
|
|
1208 | |
|
|
1209 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1162 | |
1210 | |
1163 | =back |
1211 | =back |
1164 | |
1212 | |
1165 | =head1 THE SCROLLBAR |
1213 | =head1 THE SCROLLBAR |
1166 | |
1214 | |
… | |
… | |
1185 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1233 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1186 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1234 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1187 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1235 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1188 | respectively. |
1236 | respectively. |
1189 | |
1237 | |
1190 | =head1 TEXT SELECTION AND INSERTION |
1238 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1191 | |
1239 | |
1192 | The behaviour of text selection and insertion mechanism is similar to |
1240 | The behaviour of text selection and insertion/pasting mechanism is similar |
1193 | I<xterm>(1). |
1241 | to I<xterm>(1). |
1194 | |
1242 | |
1195 | =over 4 |
1243 | =over 4 |
1196 | |
1244 | |
1197 | =item B<Selection>: |
1245 | =item B<Selecting>: |
1198 | |
1246 | |
1199 | Left click at the beginning of the region, drag to the end of the region |
1247 | Left click at the beginning of the region, drag to the end of the region |
1200 | and release; Right click to extend the marked region; Left double-click |
1248 | and release; Right click to extend the marked region; Left double-click |
1201 | to select a word; Left triple-click to select the entire logical line |
1249 | to select a word; Left triple-click to select the entire logical line |
1202 | (which can span multiple screen lines), unless modified by resource |
1250 | (which can span multiple screen lines), unless modified by resource |
… | |
… | |
1206 | (Compile: I<frills>) will create a rectangular selection instead of a |
1254 | (Compile: I<frills>) will create a rectangular selection instead of a |
1207 | normal one. In this mode, every selected row becomes its own line in the |
1255 | normal one. In this mode, every selected row becomes its own line in the |
1208 | selection, and trailing whitespace is visually underlined and removed from |
1256 | selection, and trailing whitespace is visually underlined and removed from |
1209 | the selection. |
1257 | the selection. |
1210 | |
1258 | |
1211 | =item B<Insertion>: |
1259 | =item B<Pasting>: |
1212 | |
1260 | |
1213 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1261 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1214 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1262 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1215 | Meta modifier) to be inserted as if it had been typed on the keyboard. |
1263 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1216 | |
1264 | |
1217 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1265 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1218 | inserted too. |
1266 | inserted too. |
1219 | |
1267 | |
1220 | =back |
1268 | =back |
… | |
… | |
1267 | This mode lets you input characters representing the keycap symbols of |
1315 | This mode lets you input characters representing the keycap symbols of |
1268 | your keyboard, if representable in the current locale encoding. |
1316 | your keyboard, if representable in the current locale encoding. |
1269 | |
1317 | |
1270 | Start by pressing C<Control> and C<Shift> together, then releasing |
1318 | Start by pressing C<Control> and C<Shift> together, then releasing |
1271 | them. The next special key (cursor keys, home etc.) you enter will not |
1319 | them. The next special key (cursor keys, home etc.) you enter will not |
1272 | invoke it's usual function but instead will insert the corresponding |
1320 | invoke its usual function but instead will insert the corresponding |
1273 | keycap symbol. The symbol will only be entered when the key has been |
1321 | keycap symbol. The symbol will only be entered when the key has been |
1274 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1322 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1275 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1323 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1276 | reverse tab (Shift-Tab). |
1324 | reverse tab (Shift-Tab). |
1277 | |
1325 | |
… | |
… | |
1340 | It is also possible to specify the colour values of B<foreground>, |
1388 | It is also possible to specify the colour values of B<foreground>, |
1341 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1389 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1342 | a number 0-15, as a convenient shorthand to reference the colour name of |
1390 | a number 0-15, as a convenient shorthand to reference the colour name of |
1343 | color0-color15. |
1391 | color0-color15. |
1344 | |
1392 | |
1345 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1393 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1346 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1394 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1347 | (recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB> |
1395 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
1348 | and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones |
1396 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
1349 | provided by X, where the additional A component specifies alpha (opacity) |
1397 | |
1350 | values (0 is completely transparent and the maximum is opaque). You |
1398 | Together, all those colours implement the 88 colour xterm colours. Only |
1351 | probably need to specify B<"-depth 32">, too, and have the luck that your |
1399 | the first 16 can be changed using resources currently, the rest can only |
1352 | X-server uses ARGB pixel layout, as X is far from just supporting ARGB |
1400 | be changed via command sequences ("escape codes"). |
1353 | visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1354 | |
1401 | |
1355 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1402 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1356 | always swapping the foreground/background colours. This is in contrast to |
1403 | always swapping the foreground/background colours. This is in contrast to |
1357 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1404 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1358 | been specified. For example, |
1405 | been specified. For example, |
… | |
… | |
1364 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1411 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1365 | on White. |
1412 | on White. |
1366 | |
1413 | |
1367 | =back |
1414 | =back |
1368 | |
1415 | |
|
|
1416 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1417 | |
|
|
1418 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1419 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
|
|
1420 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
|
|
1421 | in addition to the ones provided by X, where the additional A component |
|
|
1422 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
|
|
1423 | transparent). You can also prefix any color with C<[percent]>, where |
|
|
1424 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
|
|
1425 | the color, where C<0> is completely transparent and C<100> is completelxy |
|
|
1426 | opaque. |
|
|
1427 | |
|
|
1428 | You probably need to specify B<"-depth 32">, too, and have the luck that |
|
|
1429 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1430 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1431 | |
|
|
1432 | For example, the following selects an almost completely transparent red |
|
|
1433 | background, and an almost opaque pink foreground: |
|
|
1434 | |
|
|
1435 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
|
|
1436 | |
|
|
1437 | I<Please note that transparency of any kind if completely unsupported by |
|
|
1438 | the author. Don't bug him with installation questions!> |
|
|
1439 | |
1369 | =head1 ENVIRONMENT |
1440 | =head1 ENVIRONMENT |
1370 | |
1441 | |
1371 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1442 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1372 | |
1443 | |
1373 | =over 4 |
1444 | =over 4 |
1374 | |
1445 | |
1375 | =item B<TERM> |
1446 | =item B<TERM> |
1376 | |
1447 | |
1377 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1448 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1378 | resources or on the commandline. |
1449 | resources or on the command line. |
1379 | |
1450 | |
1380 | =item B<COLORTERM> |
1451 | =item B<COLORTERM> |
1381 | |
1452 | |
1382 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1453 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1383 | compiled with XPM support, and optionally with the added extension |
1454 | compiled with XPM support, and optionally with the added extension |
1384 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1455 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1385 | |
1456 | |
1386 | =item B<COLORFGBG> |
1457 | =item B<COLORFGBG> |
1387 | |
1458 | |
… | |
… | |
1405 | C<--with-terminfo=PATH>. |
1476 | C<--with-terminfo=PATH>. |
1406 | |
1477 | |
1407 | =item B<DISPLAY> |
1478 | =item B<DISPLAY> |
1408 | |
1479 | |
1409 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1480 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1410 | display in it's child processes. |
1481 | display in its child processes. |
1411 | |
1482 | |
1412 | =item B<SHELL> |
1483 | =item B<SHELL> |
1413 | |
1484 | |
1414 | The shell to be used for command execution, defaults to C</bin/sh>. |
1485 | The shell to be used for command execution, defaults to C</bin/sh>. |
1415 | |
1486 | |
… | |
… | |
1457 | |
1528 | |
1458 | =item Project Coordinator |
1529 | =item Project Coordinator |
1459 | |
1530 | |
1460 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1531 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1461 | |
1532 | |
1462 | L<http://software.schmorp.de/#rxvt-unicode> |
1533 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1463 | |
1534 | |
1464 | =back |
1535 | =back |
1465 | |
1536 | |
1466 | =head1 AUTHORS |
1537 | =head1 AUTHORS |
1467 | |
1538 | |