… | |
… | |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
15 | a significant advantage on a machine serving many X sessions. |
15 | a significant advantage on a machine serving many X sessions. |
16 | |
16 | |
|
|
17 | This document is also available on the World-Wide-Web at |
|
|
18 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>. |
|
|
19 | |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
20 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | |
21 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
22 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
20 | frequently asked questions and answer to them and some common |
23 | frequently asked questions and answer to them and some common |
21 | problems. That document is also accessible on the World-Wide-Web at |
24 | problems. That document is also accessible on the World-Wide-Web at |
22 | L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. |
25 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>. |
23 | |
26 | |
24 | =head1 RXVT-UNICODE VS. RXVT |
27 | =head1 RXVT-UNICODE VS. RXVT |
25 | |
28 | |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
29 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
27 | internally. That means it can store and display most scripts in the |
30 | internally. That means it can store and display most scripts in the |
… | |
… | |
30 | like mongolian or scripts requiring extremely complex combining rules, |
33 | like mongolian or scripts requiring extremely complex combining rules, |
31 | like tibetan or devanagari. Don't expect pretty output when using these |
34 | like tibetan or devanagari. Don't expect pretty output when using these |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
35 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
33 | fine, though. A somewhat difficult case are right-to-left scripts, such |
36 | fine, though. A somewhat difficult case are right-to-left scripts, such |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
37 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
35 | belong into the application, not the terminal emulator (too many things -- |
38 | belong in the application, not the terminal emulator (too many things -- |
36 | such as cursor-movement while editing -- break otherwise), but that might |
39 | such as cursor-movement while editing -- break otherwise), but that might |
37 | change. |
40 | change. |
38 | |
41 | |
39 | If you are looking for a terminal that supports more exotic scripts, let |
42 | If you are looking for a terminal that supports more exotic scripts, let |
40 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
43 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
… | |
… | |
89 | |
92 | |
90 | Print out a message describing available options. |
93 | Print out a message describing available options. |
91 | |
94 | |
92 | =item B<-display> I<displayname> |
95 | =item B<-display> I<displayname> |
93 | |
96 | |
94 | Attempt to open a window on the named X display (B<-d> still |
97 | Attempt to open a window on the named X display (the older form B<-d> |
95 | respected). In the absence of this option, the display specified by the |
98 | is still respected. but deprecated). In the absence of this option, the |
96 | B<DISPLAY> environment variable is used. |
99 | display specified by the B<DISPLAY> environment variable is used. |
97 | |
100 | |
98 | =item B<-depth> I<bitdepth> |
101 | =item B<-depth> I<bitdepth> |
99 | |
102 | |
100 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
103 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
101 | resource B<depth>. |
104 | resource B<depth>. |
102 | |
105 | |
|
|
106 | [Please note that many X servers (and libXft) are buggy with |
|
|
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
|
|
108 | of graphical corruption. This is harmless, but we can't do anything about |
|
|
109 | this, so watch out] |
|
|
110 | |
103 | =item B<-geometry> I<geom> |
111 | =item B<-geometry> I<geom> |
104 | |
112 | |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
106 | |
114 | |
107 | =item B<-rv>|B<+rv> |
115 | =item B<-rv>|B<+rv> |
… | |
… | |
116 | |
124 | |
117 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
125 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
118 | |
126 | |
119 | =item B<-tr>|B<+tr> |
127 | =item B<-tr>|B<+tr> |
120 | |
128 | |
121 | Turn on/off illusion of a transparent window background. Obsolete form of it is |
129 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
122 | B<-ip> and it should not be used anymore; resource B<transparent>. |
|
|
123 | |
130 | |
124 | I<Please note that old resource name of B<inheritPixmap> is obsolete and should be |
131 | B<-ip> is still accepted as an obsolete alias but will be removed in |
125 | changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will |
132 | future versions. |
126 | be phased out in future versions of rxvt!> |
|
|
127 | |
133 | |
128 | I<Please address all transparency related issues to Sasha Vasko at |
134 | I<Please address all transparency related issues to Sasha Vasko at |
129 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
135 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
130 | |
136 | |
131 | =item B<-fade> I<number> |
137 | =item B<-fade> I<number> |
132 | |
138 | |
133 | Fade the text by the given percentage when focus is lost. Small values |
139 | Fade the text by the given percentage when focus is lost. Small values |
… | |
… | |
145 | transparency is enabled with B<-tr>. This only works for |
151 | transparency is enabled with B<-tr>. This only works for |
146 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
152 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
147 | used to brighten or darken the image in addition to tinting it. |
153 | used to brighten or darken the image in addition to tinting it. |
148 | Please note that certain tint colours can be applied on the server-side, |
154 | Please note that certain tint colours can be applied on the server-side, |
149 | thus yielding performance gain of two orders of magnitude. These colours are: |
155 | thus yielding performance gain of two orders of magnitude. These colours are: |
150 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
156 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
151 | pure black and pure white colors essentially mean no tinting; resource |
157 | pure black and pure white colors essentially mean no tinting; resource |
152 | I<tintColor>. Example: |
158 | I<tintColor>. Example: |
153 | |
159 | |
154 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
160 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
155 | |
161 | |
… | |
… | |
176 | horizontal radii are considered to be the same. Setting one of the |
182 | horizontal radii are considered to be the same. Setting one of the |
177 | radii to 1 and another to a large number creates interesting effects |
183 | radii to 1 and another to a large number creates interesting effects |
178 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
179 | resource I<blurRadius>. |
185 | resource I<blurRadius>. |
180 | |
186 | |
|
|
187 | =item B<-icon> I<file> |
|
|
188 | |
|
|
189 | Compile I<afterimage>: Use the specified image as application icon. This |
|
|
190 | is used by many window managers, taskbars and pagers to represent the |
|
|
191 | appliation window; resource I<iconFile>. |
|
|
192 | |
181 | =item B<-bg> I<colour> |
193 | =item B<-bg> I<colour> |
182 | |
194 | |
183 | Window background colour; resource B<background>. |
195 | Window background colour; resource B<background>. |
184 | |
196 | |
185 | =item B<-fg> I<colour> |
197 | =item B<-fg> I<colour> |
186 | |
198 | |
187 | Window foreground colour; resource B<foreground>. |
199 | Window foreground colour; resource B<foreground>. |
188 | |
200 | |
189 | =item B<-pixmap> I<file[;geom]> |
201 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
190 | |
202 | |
191 | Compile I<afterimage>: Specify image file for the background and also |
203 | Compile I<afterimage>: Specify image file for the background and also |
192 | optionally specify its scaling with a geometry string. Note you may need to |
204 | optionally specify its scaling with a geometry string. Note you may need to |
193 | add quotes to avoid special shell interpretation of the C<;> in the |
205 | add quotes to avoid special shell interpretation of the C<;> in the |
194 | command-line; for more details see resource B<backgroundPixmap>. |
206 | command-line; for more details see resource B<backgroundPixmap>. |
195 | |
207 | |
196 | =item B<-cr> I<colour> |
208 | =item B<-cr> I<colour> |
… | |
… | |
244 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
256 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
245 | for details. |
257 | for details. |
246 | |
258 | |
247 | =item B<-is>|B<+is> |
259 | =item B<-is>|B<+is> |
248 | |
260 | |
249 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
261 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
250 | foreground/background (default). See resource B<intensityStyles> for |
262 | foreground/background (default). See resource B<intensityStyles> for |
251 | details. |
263 | details. |
252 | |
264 | |
253 | =item B<-name> I<name> |
265 | =item B<-name> I<name> |
254 | |
266 | |
… | |
… | |
272 | |
284 | |
273 | =item B<-sb>|B<+sb> |
285 | =item B<-sb>|B<+sb> |
274 | |
286 | |
275 | Turn on/off scrollbar; resource B<scrollBar>. |
287 | Turn on/off scrollbar; resource B<scrollBar>. |
276 | |
288 | |
|
|
289 | =item B<-sr>|B<+sr> |
|
|
290 | |
|
|
291 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
292 | |
|
|
293 | =item B<-st>|B<+st> |
|
|
294 | |
|
|
295 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
296 | resource B<scrollBar_floating>. |
|
|
297 | |
277 | =item B<-si>|B<+si> |
298 | =item B<-si>|B<+si> |
278 | |
299 | |
279 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
300 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
280 | B<scrollTtyOutput> has opposite effect. |
301 | B<scrollTtyOutput> has opposite effect. |
281 | |
302 | |
… | |
… | |
287 | =item B<-sw>|B<+sw> |
308 | =item B<-sw>|B<+sw> |
288 | |
309 | |
289 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
310 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
290 | This only takes effect if B<-si> is also given; resource |
311 | This only takes effect if B<-si> is also given; resource |
291 | B<scrollWithBuffer>. |
312 | B<scrollWithBuffer>. |
292 | |
|
|
293 | =item B<-sr>|B<+sr> |
|
|
294 | |
|
|
295 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
296 | |
|
|
297 | =item B<-st>|B<+st> |
|
|
298 | |
|
|
299 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
300 | resource B<scrollBar_floating>. |
|
|
301 | |
313 | |
302 | =item B<-ptab>|B<+ptab> |
314 | =item B<-ptab>|B<+ptab> |
303 | |
315 | |
304 | If enabled (default), "Horizontal Tab" characters are being stored as |
316 | If enabled (default), "Horizontal Tab" characters are being stored as |
305 | actual wide characters in the screen buffer, which makes it possible to |
317 | actual wide characters in the screen buffer, which makes it possible to |
… | |
… | |
334 | |
346 | |
335 | =item B<-bl> |
347 | =item B<-bl> |
336 | |
348 | |
337 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
349 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
338 | if honoured by the WM, the rxvt-unicode window will not have window |
350 | if honoured by the WM, the rxvt-unicode window will not have window |
339 | decorations; resource B<borderLess>. |
351 | decorations; resource B<borderLess>. If the window manager does not |
|
|
352 | support MWM hints (e.g. kwin), enables override-redirect mode. |
340 | |
353 | |
341 | =item B<-override-redirect> |
354 | =item B<-override-redirect> |
342 | |
355 | |
343 | Compile I<frills>: Sets override-redirect on the window; resource |
356 | Compile I<frills>: Sets override-redirect on the window; resource |
344 | B<override-redirect>. |
357 | B<override-redirect>. |
… | |
… | |
417 | |
430 | |
418 | =item B<-tcw> |
431 | =item B<-tcw> |
419 | |
432 | |
420 | Change the meaning of triple-click selection with the left mouse |
433 | Change the meaning of triple-click selection with the left mouse |
421 | button. Only effective when the original (non-perl) selection code is |
434 | button. Only effective when the original (non-perl) selection code is |
422 | in-use. Instead of selecting a full line it will extend the selection the |
435 | in-use. Instead of selecting a full line it will extend the selection to |
423 | end of the logical line only. resource B<tripleclickwords>. |
436 | the end of the logical line only. resource B<tripleclickwords>. |
424 | |
437 | |
425 | =item B<-insecure> |
438 | =item B<-insecure> |
426 | |
439 | |
427 | Enable "insecure" mode, which currently enables most of the escape |
440 | Enable "insecure" mode, which currently enables most of the escape |
428 | sequences that echo strings. See the resource B<insecure> for more |
441 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
448 | |
461 | |
449 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
462 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
450 | will not immediately destroy its window when the program executed within |
463 | will not immediately destroy its window when the program executed within |
451 | it exits. Instead, it will wait till it is being killed or closed by the |
464 | it exits. Instead, it will wait till it is being killed or closed by the |
452 | user; resource B<hold>. |
465 | user; resource B<hold>. |
|
|
466 | |
|
|
467 | =item B<-cd> I<path> |
|
|
468 | |
|
|
469 | Sets the working directory for the shell (or the command specified via |
|
|
470 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
471 | @@RXVT_NAME@@ to start; resource B<chdir>. |
|
|
472 | |
|
|
473 | =item B<-xrm> I<string> |
|
|
474 | |
|
|
475 | Works like the X Toolkit option of the same name, by adding the I<string> |
|
|
476 | as if it were specified in a resource file. Resource values specified this |
|
|
477 | way take precedence over all other resource specifications. |
|
|
478 | |
|
|
479 | Note that you need to use the I<same> syntax as in the .Xdefaults file, |
|
|
480 | e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific |
|
|
481 | options can be specified as long-options on the commandline, so use |
|
|
482 | of B<-xrm> is mostly limited to cases where you want to specify other |
|
|
483 | resources (e.g. for input methods) or for compatibility with other |
|
|
484 | programs. |
453 | |
485 | |
454 | =item B<-keysym.>I<sym> I<string> |
486 | =item B<-keysym.>I<sym> I<string> |
455 | |
487 | |
456 | Remap a key symbol. See resource B<keysym>. |
488 | Remap a key symbol. See resource B<keysym>. |
457 | |
489 | |
… | |
… | |
492 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
524 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
493 | entries and will not tinker with pty/tty permissions - you have to do that |
525 | entries and will not tinker with pty/tty permissions - you have to do that |
494 | yourself if you want that. |
526 | yourself if you want that. |
495 | |
527 | |
496 | As an extremely special case, specifying C<-1> will completely suppress |
528 | As an extremely special case, specifying C<-1> will completely suppress |
497 | pty/tty operations. |
529 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
530 | perl extension that manages the terminal. |
498 | |
531 | |
499 | Here is a example in perl that illustrates how this option can be used (a |
532 | Here is a example in perl that illustrates how this option can be used (a |
500 | longer example is in F<doc/pty-fd>): |
533 | longer example is in F<doc/pty-fd>): |
501 | |
534 | |
502 | use IO::Pty; |
535 | use IO::Pty; |
… | |
… | |
516 | Comma-separated list of perl extension scripts to use (or not to use) in |
549 | Comma-separated list of perl extension scripts to use (or not to use) in |
517 | this terminal instance. See resource B<perl-ext> for details. |
550 | this terminal instance. See resource B<perl-ext> for details. |
518 | |
551 | |
519 | =back |
552 | =back |
520 | |
553 | |
521 | =head1 RESOURCES (available also as long-options) |
554 | =head1 RESOURCES |
522 | |
555 | |
523 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
556 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
524 | options) compiled into your version. |
557 | options) compiled into your version. All resources are also available as |
|
|
558 | long-options. |
525 | |
559 | |
526 | You can set and change the resources using X11 tools like B<xrdb>. Many |
560 | You can set and change the resources using X11 tools like B<xrdb>. Many |
527 | distribution do also load settings from the B<~/.Xresources> file when X |
561 | distribution do also load settings from the B<~/.Xresources> file when X |
528 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
562 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
529 | with later settings overwriting earlier ones: |
563 | with later settings overwriting earlier ones: |
… | |
… | |
531 | 1. system-wide app-defaults file, either locale-dependent OR global |
565 | 1. system-wide app-defaults file, either locale-dependent OR global |
532 | 2. app-defaults file in $XAPPLRESDIR |
566 | 2. app-defaults file in $XAPPLRESDIR |
533 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
567 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
534 | 4. SCREEN_RESOURCES for the current screen |
568 | 4. SCREEN_RESOURCES for the current screen |
535 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
569 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
|
|
570 | 6. resources specified via -xrm on the commandline |
536 | |
571 | |
537 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
572 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
538 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
573 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
539 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
574 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
540 | configured, while the class name B<URxvt> allows resources unique to |
575 | configured, while the class name B<URxvt> allows resources unique to |
… | |
… | |
550 | =item B<depth:> I<bitdepth> |
585 | =item B<depth:> I<bitdepth> |
551 | |
586 | |
552 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
587 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
553 | option B<-depth>. |
588 | option B<-depth>. |
554 | |
589 | |
|
|
590 | =item B<buffered:> I<boolean> |
|
|
591 | |
|
|
592 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
593 | On some card/driver combination enabling it slightly decreases |
|
|
594 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
595 | should normally be enabled. |
|
|
596 | |
555 | =item B<geometry:> I<geom> |
597 | =item B<geometry:> I<geom> |
556 | |
598 | |
557 | Create the window with the specified X window geometry [default 80x24]; |
599 | Create the window with the specified X window geometry [default 80x24]; |
558 | option B<-geometry>. |
600 | option B<-geometry>. |
559 | |
601 | |
… | |
… | |
642 | |
684 | |
643 | B<False>: specify that everything is to be displayed, even |
685 | B<False>: specify that everything is to be displayed, even |
644 | if the refresh is too fast for the human eye to read anything (or the |
686 | if the refresh is too fast for the human eye to read anything (or the |
645 | monitor to display anything); option B<+ss>. |
687 | monitor to display anything); option B<+ss>. |
646 | |
688 | |
647 | =item B<inheritPixmap:> I<boolean> |
689 | =item B<transparent:> I<boolean> |
648 | |
690 | |
649 | B<True>: make the background inherit the parent windows' pixmap, giving |
691 | Turn on/off illusion of a transparent window background. |
650 | artificial transparency. B<False>: do not inherit the parent windows' |
|
|
651 | pixmap. |
|
|
652 | |
692 | |
653 | I<Please note that transparency of any kind if completely unsupported by |
693 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
654 | the author. Don't bug him with installation questions!> |
694 | future versions. |
|
|
695 | |
|
|
696 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
697 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
655 | |
698 | |
656 | =item B<fading:> I<number> |
699 | =item B<fading:> I<number> |
657 | |
700 | |
658 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
701 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
659 | |
702 | |
… | |
… | |
676 | |
719 | |
677 | Specify background blending type; option B<-blt>. |
720 | Specify background blending type; option B<-blt>. |
678 | |
721 | |
679 | =item B<blurRadius:> I<number> |
722 | =item B<blurRadius:> I<number> |
680 | |
723 | |
681 | Apply Gaussian Blurr with the specified radius to the transparent |
724 | Apply gaussian blur with the specified radius to the transparent |
682 | background image; option B<-blr>. |
725 | background image; option B<-blr>. |
|
|
726 | |
|
|
727 | =item B<iconFile:> I<file> |
|
|
728 | |
|
|
729 | Set the application icon pixmap; option B<-icon>. |
683 | |
730 | |
684 | =item B<scrollColor:> I<colour> |
731 | =item B<scrollColor:> I<colour> |
685 | |
732 | |
686 | Use the specified colour for the scrollbar [default #B2B2B2]. |
733 | Use the specified colour for the scrollbar [default #B2B2B2]. |
687 | |
734 | |
… | |
… | |
693 | =item B<borderColor:> I<colour> |
740 | =item B<borderColor:> I<colour> |
694 | |
741 | |
695 | The colour of the border around the text area and between the scrollbar |
742 | The colour of the border around the text area and between the scrollbar |
696 | and the text. |
743 | and the text. |
697 | |
744 | |
698 | =item B<backgroundPixmap:> I<file[;geom]> |
745 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
699 | |
746 | |
700 | Use the specified image file for the background and also optionally |
747 | Use the specified image file for the background and also |
701 | specify its scaling with a geometry string B<WxH+X+Y>, |
748 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
702 | in which B<"W" / "H"> specify the horizontal/vertical scale (percent), |
749 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
703 | and B<"X" / "Y"> locate the image centre (percent). |
750 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
704 | A scale of 0 displays the image with tiling. A scale of 1 displays the |
751 | centre (percent). A scale of 0 displays the image with tiling. A scale |
705 | image without any scaling. A scale of 2 to 9 specifies an integer |
752 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
706 | number of images in that direction. No image will be magnified beyond |
753 | an integer number of images in that direction. No image will be magnified |
707 | 10 times its original size. The maximum permitted scale is 1000. |
754 | beyond 10 times its original size. The maximum permitted scale is 1000. |
708 | Special string of B<"auto"> used as a geometry will cause image to be |
755 | Additional operations can be specified after colon B<:op1:op2...>. |
709 | automatically scaled to match window size. |
756 | Supported operations are: |
|
|
757 | |
|
|
758 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
759 | propscale will scale image keeping proportions |
|
|
760 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
761 | hscale will scale image horizontally to the window size |
|
|
762 | vscale will scale image vertically to the window size |
|
|
763 | scale will scale image to match window size |
|
|
764 | root will tile image as if it was a root window background, auto-adjusting |
|
|
765 | whenever terminal window moves |
|
|
766 | |
710 | If used in conjunction with B<-tr> option - specified pixmap will be |
767 | If used in conjunction with B<-tr> option, the specified pixmap will be |
711 | blended over transparency image using either alpha-blending, or any |
768 | blended over transparency image using either alpha-blending, or any |
712 | other blending type, specified with B<-blt "type"> option. |
769 | other blending type, specified with B<-blt "type"> option. |
713 | [default 0x0+50+50] |
|
|
714 | |
770 | |
715 | =item B<path:> I<path> |
771 | =item B<path:> I<path> |
716 | |
772 | |
717 | Specify the colon-delimited search path for finding background image files. |
773 | Specify the colon-delimited search path for finding background image files. |
718 | |
774 | |
… | |
… | |
779 | text font will being used for the given style. |
835 | text font will being used for the given style. |
780 | |
836 | |
781 | =item B<intensityStyles:> I<boolean> |
837 | =item B<intensityStyles:> I<boolean> |
782 | |
838 | |
783 | When font styles are not enabled, or this option is enabled (B<True>, |
839 | When font styles are not enabled, or this option is enabled (B<True>, |
784 | option B<-is>, the default), bold and italic font styles imply high |
840 | option B<-is>, the default), bold/blink font styles imply high |
785 | intensity foreground/background colours. Disabling this option (B<False>, |
841 | intensity foreground/background colours. Disabling this option (B<False>, |
786 | option B<+is>) disables this behaviour, the high intensity colours are not |
842 | option B<+is>) disables this behaviour, the high intensity colours are not |
787 | reachable. |
843 | reachable. |
788 | |
844 | |
789 | =item B<selectstyle:> I<mode> |
|
|
790 | |
|
|
791 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
|
|
792 | is xterm style with 2.20 old word selection, or anything else which |
|
|
793 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
794 | selection code is in use. |
|
|
795 | |
|
|
796 | =item B<scrollstyle:> I<mode> |
|
|
797 | |
|
|
798 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
799 | the author's favourite. |
|
|
800 | |
|
|
801 | =item B<title:> I<string> |
845 | =item B<title:> I<string> |
802 | |
846 | |
803 | Set window title string, the default title is the command-line |
847 | Set window title string, the default title is the command-line |
804 | specified after the B<-e> option, if any, otherwise the application |
848 | specified after the B<-e> option, if any, otherwise the application |
805 | name; option B<-title>. |
849 | name; option B<-title>. |
… | |
… | |
818 | =item B<urgentOnBell:> I<boolean> |
862 | =item B<urgentOnBell:> I<boolean> |
819 | |
863 | |
820 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
864 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
821 | B<False>: do not set the urgency hint [default]. |
865 | B<False>: do not set the urgency hint [default]. |
822 | |
866 | |
|
|
867 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
868 | |
823 | =item B<visualBell:> I<boolean> |
869 | =item B<visualBell:> I<boolean> |
824 | |
870 | |
825 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
871 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
826 | B<False>: no visual bell [default]; option B<+vb>. |
872 | B<False>: no visual bell [default]; option B<+vb>. |
827 | |
873 | |
… | |
… | |
849 | |
895 | |
850 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
896 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
851 | |
897 | |
852 | This creates a new file in your home directory with the screen contents |
898 | This creates a new file in your home directory with the screen contents |
853 | every time you hit C<Print>. |
899 | every time you hit C<Print>. |
|
|
900 | |
|
|
901 | =item B<scrollstyle:> I<mode> |
|
|
902 | |
|
|
903 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
904 | the author's favourite. |
854 | |
905 | |
855 | =item B<scrollBar:> I<boolean> |
906 | =item B<scrollBar:> I<boolean> |
856 | |
907 | |
857 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
908 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
858 | disable the scrollbar; option B<+sb>. |
909 | disable the scrollbar; option B<+sb>. |
… | |
… | |
991 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
1042 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
992 | |
1043 | |
993 | When the selection extension is not used, only ISO-8859-1 characters can |
1044 | When the selection extension is not used, only ISO-8859-1 characters can |
994 | be used. If not specified, the built-in default is used: |
1045 | be used. If not specified, the built-in default is used: |
995 | |
1046 | |
996 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
1047 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
997 | |
1048 | |
998 | =item B<preeditType:> I<style> |
1049 | =item B<preeditType:> I<style> |
999 | |
1050 | |
1000 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1051 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1001 | |
1052 | |
… | |
… | |
1057 | |
1108 | |
1058 | =item B<secondaryScroll:> I<boolean> |
1109 | =item B<secondaryScroll:> I<boolean> |
1059 | |
1110 | |
1060 | Turn on/off secondary screen scroll (default enabled). If this |
1111 | Turn on/off secondary screen scroll (default enabled). If this |
1061 | option is enabled, scrolls on the secondary screen will change the |
1112 | option is enabled, scrolls on the secondary screen will change the |
1062 | scrollback buffer and switching to/from the secondary screen will |
1113 | scrollback buffer and, when secondaryScreen is off, switching |
1063 | instead scroll the screen up. |
1114 | to/from the secondary screen will instead scroll the screen up. |
1064 | |
1115 | |
1065 | =item B<hold>: I<boolean> |
1116 | =item B<hold>: I<boolean> |
1066 | |
1117 | |
1067 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1118 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1068 | will not immediately destroy its window when the program executed within |
1119 | will not immediately destroy its window when the program executed within |
1069 | it exits. Instead, it will wait till it is being killed or closed by the |
1120 | it exits. Instead, it will wait till it is being killed or closed by the |
1070 | user. |
1121 | user. |
|
|
1122 | |
|
|
1123 | =item B<chdir>: I<path> |
|
|
1124 | |
|
|
1125 | Sets the working directory for the shell (or the command specified via |
|
|
1126 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1127 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1128 | directory will be used; option B<-cd>. |
1071 | |
1129 | |
1072 | =item B<keysym.>I<sym>: I<string> |
1130 | =item B<keysym.>I<sym>: I<string> |
1073 | |
1131 | |
1074 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1132 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1075 | intervening resource name B<keysym.> cannot be omitted. |
1133 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
1182 | all instances, while B<perl-ext> is used for specific instances. |
1240 | all instances, while B<perl-ext> is used for specific instances. |
1183 | |
1241 | |
1184 | =item B<perl-eval>: I<string> |
1242 | =item B<perl-eval>: I<string> |
1185 | |
1243 | |
1186 | Perl code to be evaluated when all extensions have been registered. See |
1244 | Perl code to be evaluated when all extensions have been registered. See |
1187 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1245 | the @@RXVT_NAME@@perl(3) manpage. |
1188 | will be ignored when running setuid/setgid. |
|
|
1189 | |
1246 | |
1190 | =item B<perl-lib>: I<path> |
1247 | =item B<perl-lib>: I<path> |
1191 | |
1248 | |
1192 | Colon-separated list of additional directories that hold extension |
1249 | Colon-separated list of additional directories that hold extension |
1193 | scripts. When looking for extensions specified by the C<perl> resource, |
1250 | scripts. When looking for extensions specified by the C<perl> resource, |
1194 | @@RXVT_NAME@@ will first look in these directories and then in |
1251 | @@RXVT_NAME@@ will first look in these directories and then in |
1195 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1252 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1196 | will be ignored when running setuid/setgid. |
|
|
1197 | |
1253 | |
1198 | See the @@RXVT_NAME@@perl(3) manpage. |
1254 | See the @@RXVT_NAME@@perl(3) manpage. |
1199 | |
1255 | |
1200 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1256 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1201 | |
1257 | |
… | |
… | |
1436 | =back |
1492 | =back |
1437 | |
1493 | |
1438 | =head2 ALPHA CHANNEL SUPPORT |
1494 | =head2 ALPHA CHANNEL SUPPORT |
1439 | |
1495 | |
1440 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1496 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1441 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1497 | their act together, rxvt-unicode will do it's own alpha channel management: |
1442 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1498 | |
1443 | in addition to the ones provided by X, where the additional A component |
1499 | You can prefix any color with an opaquenes percentage enclosed in |
|
|
1500 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1501 | (0-100) that specifies the opacity of the color, where C<0> is completely |
|
|
1502 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1503 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1504 | is the recommended format to specify transparency values, and works with |
|
|
1505 | all ways to specify a colour. |
|
|
1506 | |
|
|
1507 | For complete control, rxvt-unicode also supports |
|
|
1508 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1509 | specifications, where the additional C<aaaa> component specifies opacity |
1444 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1510 | (alpha) values. The minimum value of C<0000> is completely transparent, |
1445 | transparent). You can also prefix any color with C<[percent]>, where |
1511 | while C<ffff> is completely opaque). The two example colours from |
1446 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
1512 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
1447 | the color, where C<0> is completely transparent and C<100> is completelxy |
1513 | C<rgba:0000/ff00/0000/f332>. |
1448 | opaque. |
|
|
1449 | |
1514 | |
1450 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1515 | You probably need to specify B<"-depth 32">, too, to force a visual with |
1451 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1516 | alpha channels, and have the luck that your X-server uses ARGB pixel |
1452 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1517 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1518 | rxvt-unicode just fudges around. |
1453 | |
1519 | |
1454 | For example, the following selects an almost completely transparent red |
1520 | For example, the following selects an almost completely transparent black |
1455 | background, and an almost opaque pink foreground: |
1521 | background, and an almost opaque pink foreground: |
1456 | |
1522 | |
1457 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1523 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
1458 | |
1524 | |
1459 | I<Please note that transparency of any kind if completely unsupported by |
1525 | When not using a background image, then the interpretation of the |
1460 | the author. Don't bug him with installation questions!> |
1526 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1527 | transparency of course). |
|
|
1528 | |
|
|
1529 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1530 | colour will always behave as if it were completely transparent (so the |
|
|
1531 | background image shows instead), regardless of how it was specified, while |
|
|
1532 | other colours will either be transparent as specified (the background |
|
|
1533 | image will show through) on servers supporting the RENDER extension, or |
|
|
1534 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1535 | |
|
|
1536 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1537 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1538 | extension. |
1461 | |
1539 | |
1462 | =head1 ENVIRONMENT |
1540 | =head1 ENVIRONMENT |
1463 | |
1541 | |
1464 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1542 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1465 | |
1543 | |
… | |
… | |
1471 | resources or on the command line. |
1549 | resources or on the command line. |
1472 | |
1550 | |
1473 | =item B<COLORTERM> |
1551 | =item B<COLORTERM> |
1474 | |
1552 | |
1475 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1553 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1476 | compiled with background image support, and optionally with the added |
1554 | compiled with background image support, and optionally with the added |
1477 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
1555 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
1478 | screen. |
1556 | screen. |
1479 | |
1557 | |
1480 | =item B<COLORFGBG> |
1558 | =item B<COLORFGBG> |
1481 | |
1559 | |
1482 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1560 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1483 | the colour code used as default foreground/text colour (or the string |
1561 | the colour code used as default foreground/text colour (or the string |
1484 | C<default> to indicate that the default-colour escape sequence is to be |
1562 | C<default> to indicate that the default-colour escape sequence is to be |
1485 | used), C<bg> is the colour code used as default background colour (or the |
1563 | used), C<bg> is the colour code used as default background colour (or the |
1486 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1564 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1487 | was compiled with background image support. Libraries like C<ncurses> |
1565 | was compiled with background image support. Libraries like C<ncurses> |
1488 | and C<slang> can (and do) use this information to optimize screen output. |
1566 | and C<slang> can (and do) use this information to optimize screen output. |
1489 | |
1567 | |
1490 | =item B<WINDOWID> |
1568 | =item B<WINDOWID> |
1491 | |
1569 | |
1492 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1570 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
… | |
… | |
1499 | C<--with-terminfo=PATH>. |
1577 | C<--with-terminfo=PATH>. |
1500 | |
1578 | |
1501 | =item B<DISPLAY> |
1579 | =item B<DISPLAY> |
1502 | |
1580 | |
1503 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1581 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1504 | display in its child processes. |
1582 | display in its child processes if C<-display> isn't used to override. It |
|
|
1583 | defaults to C<:0> if it doesn't exist. |
1505 | |
1584 | |
1506 | =item B<SHELL> |
1585 | =item B<SHELL> |
1507 | |
1586 | |
1508 | The shell to be used for command execution, defaults to C</bin/sh>. |
1587 | The shell to be used for command execution, defaults to C</bin/sh>. |
1509 | |
1588 | |
… | |
… | |
1584 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1663 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1585 | |
1664 | |
1586 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1665 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1587 | |
1666 | |
1588 | Rewrote screen display and text selection routines. |
1667 | Rewrote screen display and text selection routines. |
1589 | |
1668 | |
1590 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1669 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1591 | |
1670 | |
1592 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1671 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1593 | |
1672 | |
1594 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1673 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |