… | |
… | |
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> |
… | |
… | |
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 | application 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> |
… | |
… | |
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>. |
… | |
… | |
353 | =item B<-lsp> I<number> |
366 | =item B<-lsp> I<number> |
354 | |
367 | |
355 | Compile I<frills>: Lines (pixel height) to insert between each row of |
368 | Compile I<frills>: Lines (pixel height) to insert between each row of |
356 | the display. Useful to work around font rendering problems; resource |
369 | the display. Useful to work around font rendering problems; resource |
357 | B<lineSpace>. |
370 | B<lineSpace>. |
|
|
371 | |
|
|
372 | =item B<-letsp> I<number> |
|
|
373 | |
|
|
374 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
375 | to control overall letter spacing. Negative values will tighten up the |
|
|
376 | letter spacing, positive values will space letters out more. Useful to |
|
|
377 | work around odd font metrics; resource B<letterSpace>. |
358 | |
378 | |
359 | =item B<-tn> I<termname> |
379 | =item B<-tn> I<termname> |
360 | |
380 | |
361 | This option specifies the name of the terminal type to be set in the |
381 | This option specifies the name of the terminal type to be set in the |
362 | B<TERM> environment variable. This terminal type must exist in the |
382 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
417 | |
437 | |
418 | =item B<-tcw> |
438 | =item B<-tcw> |
419 | |
439 | |
420 | Change the meaning of triple-click selection with the left mouse |
440 | Change the meaning of triple-click selection with the left mouse |
421 | button. Only effective when the original (non-perl) selection code is |
441 | 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 |
442 | in-use. Instead of selecting a full line it will extend the selection to |
423 | end of the logical line only. resource B<tripleclickwords>. |
443 | the end of the logical line only. resource B<tripleclickwords>. |
424 | |
444 | |
425 | =item B<-insecure> |
445 | =item B<-insecure> |
426 | |
446 | |
427 | Enable "insecure" mode, which currently enables most of the escape |
447 | Enable "insecure" mode, which currently enables most of the escape |
428 | sequences that echo strings. See the resource B<insecure> for more |
448 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
448 | |
468 | |
449 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
469 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
450 | will not immediately destroy its window when the program executed within |
470 | 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 |
471 | it exits. Instead, it will wait till it is being killed or closed by the |
452 | user; resource B<hold>. |
472 | user; resource B<hold>. |
|
|
473 | |
|
|
474 | =item B<-cd> I<path> |
|
|
475 | |
|
|
476 | Sets the working directory for the shell (or the command specified via |
|
|
477 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
478 | @@RXVT_NAME@@ to start; resource B<chdir>. |
453 | |
479 | |
454 | =item B<-xrm> I<string> |
480 | =item B<-xrm> I<string> |
455 | |
481 | |
456 | Works like the X Toolkit option of the same name, by adding the I<string> |
482 | Works like the X Toolkit option of the same name, by adding the I<string> |
457 | as if it were specified in a resource file. Resource values specified this |
483 | as if it were specified in a resource file. Resource values specified this |
… | |
… | |
505 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
531 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
506 | entries and will not tinker with pty/tty permissions - you have to do that |
532 | entries and will not tinker with pty/tty permissions - you have to do that |
507 | yourself if you want that. |
533 | yourself if you want that. |
508 | |
534 | |
509 | As an extremely special case, specifying C<-1> will completely suppress |
535 | As an extremely special case, specifying C<-1> will completely suppress |
510 | pty/tty operations. |
536 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
537 | perl extension that manages the terminal. |
511 | |
538 | |
512 | Here is a example in perl that illustrates how this option can be used (a |
539 | Here is a example in perl that illustrates how this option can be used (a |
513 | longer example is in F<doc/pty-fd>): |
540 | longer example is in F<doc/pty-fd>): |
514 | |
541 | |
515 | use IO::Pty; |
542 | use IO::Pty; |
… | |
… | |
529 | Comma-separated list of perl extension scripts to use (or not to use) in |
556 | Comma-separated list of perl extension scripts to use (or not to use) in |
530 | this terminal instance. See resource B<perl-ext> for details. |
557 | this terminal instance. See resource B<perl-ext> for details. |
531 | |
558 | |
532 | =back |
559 | =back |
533 | |
560 | |
534 | =head1 RESOURCES (available also as long-options) |
561 | =head1 RESOURCES |
535 | |
562 | |
536 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
563 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
537 | options) compiled into your version. |
564 | options) compiled into your version. All resources are also available as |
|
|
565 | long-options. |
538 | |
566 | |
539 | You can set and change the resources using X11 tools like B<xrdb>. Many |
567 | You can set and change the resources using X11 tools like B<xrdb>. Many |
540 | distribution do also load settings from the B<~/.Xresources> file when X |
568 | distribution do also load settings from the B<~/.Xresources> file when X |
541 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
569 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
542 | with later settings overwriting earlier ones: |
570 | with later settings overwriting earlier ones: |
… | |
… | |
564 | =item B<depth:> I<bitdepth> |
592 | =item B<depth:> I<bitdepth> |
565 | |
593 | |
566 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
594 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
567 | option B<-depth>. |
595 | option B<-depth>. |
568 | |
596 | |
|
|
597 | =item B<buffered:> I<boolean> |
|
|
598 | |
|
|
599 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
600 | On some card/driver combination enabling it slightly decreases |
|
|
601 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
602 | should normally be enabled. |
|
|
603 | |
569 | =item B<geometry:> I<geom> |
604 | =item B<geometry:> I<geom> |
570 | |
605 | |
571 | Create the window with the specified X window geometry [default 80x24]; |
606 | Create the window with the specified X window geometry [default 80x24]; |
572 | option B<-geometry>. |
607 | option B<-geometry>. |
573 | |
608 | |
… | |
… | |
656 | |
691 | |
657 | B<False>: specify that everything is to be displayed, even |
692 | B<False>: specify that everything is to be displayed, even |
658 | if the refresh is too fast for the human eye to read anything (or the |
693 | if the refresh is too fast for the human eye to read anything (or the |
659 | monitor to display anything); option B<+ss>. |
694 | monitor to display anything); option B<+ss>. |
660 | |
695 | |
661 | =item B<inheritPixmap:> I<boolean> |
696 | =item B<transparent:> I<boolean> |
662 | |
697 | |
663 | B<True>: make the background inherit the parent windows' pixmap, giving |
698 | Turn on/off illusion of a transparent window background. |
664 | artificial transparency. B<False>: do not inherit the parent windows' |
|
|
665 | pixmap. |
|
|
666 | |
699 | |
667 | I<Please note that transparency of any kind if completely unsupported by |
700 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
668 | the author. Don't bug him with installation questions!> |
701 | future versions. |
|
|
702 | |
|
|
703 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
704 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
669 | |
705 | |
670 | =item B<fading:> I<number> |
706 | =item B<fading:> I<number> |
671 | |
707 | |
672 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
708 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
673 | |
709 | |
… | |
… | |
690 | |
726 | |
691 | Specify background blending type; option B<-blt>. |
727 | Specify background blending type; option B<-blt>. |
692 | |
728 | |
693 | =item B<blurRadius:> I<number> |
729 | =item B<blurRadius:> I<number> |
694 | |
730 | |
695 | Apply Gaussian Blurr with the specified radius to the transparent |
731 | Apply gaussian blur with the specified radius to the transparent |
696 | background image; option B<-blr>. |
732 | background image; option B<-blr>. |
|
|
733 | |
|
|
734 | =item B<iconFile:> I<file> |
|
|
735 | |
|
|
736 | Set the application icon pixmap; option B<-icon>. |
697 | |
737 | |
698 | =item B<scrollColor:> I<colour> |
738 | =item B<scrollColor:> I<colour> |
699 | |
739 | |
700 | Use the specified colour for the scrollbar [default #B2B2B2]. |
740 | Use the specified colour for the scrollbar [default #B2B2B2]. |
701 | |
741 | |
… | |
… | |
720 | an integer number of images in that direction. No image will be magnified |
760 | an integer number of images in that direction. No image will be magnified |
721 | beyond 10 times its original size. The maximum permitted scale is 1000. |
761 | beyond 10 times its original size. The maximum permitted scale is 1000. |
722 | Additional operations can be specified after colon B<:op1:op2...>. |
762 | Additional operations can be specified after colon B<:op1:op2...>. |
723 | Supported operations are: |
763 | Supported operations are: |
724 | |
764 | |
725 | tile force background image to be tiled and not scaled. Equivalent to 0x0, |
765 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
726 | propscale will scale image keeping proportions, |
766 | propscale will scale image keeping proportions |
727 | auto will scale image to match window size. Equivalent to 100x100; |
767 | auto will scale image to match window size. Equivalent to 100x100 |
728 | hscale will scale image horizontally to the window size; |
768 | hscale will scale image horizontally to the window size |
729 | vscale will scale image vertically to the window size; |
769 | vscale will scale image vertically to the window size |
730 | scale will scale image to match window size; |
770 | scale will scale image to match window size |
731 | root will tile image as if it was a root window background, auto-adjusting |
771 | root will tile image as if it was a root window background, auto-adjusting |
732 | whenever terminal window moves. |
772 | whenever terminal window moves |
733 | |
773 | |
734 | If used in conjunction with B<-tr> option, the specified pixmap will be |
774 | If used in conjunction with B<-tr> option, the specified pixmap will be |
735 | blended over transparency image using either alpha-blending, or any |
775 | blended over transparency image using either alpha-blending, or any |
736 | other blending type, specified with B<-blt "type"> option. |
776 | other blending type, specified with B<-blt "type"> option. |
737 | |
777 | |
… | |
… | |
802 | text font will being used for the given style. |
842 | text font will being used for the given style. |
803 | |
843 | |
804 | =item B<intensityStyles:> I<boolean> |
844 | =item B<intensityStyles:> I<boolean> |
805 | |
845 | |
806 | When font styles are not enabled, or this option is enabled (B<True>, |
846 | When font styles are not enabled, or this option is enabled (B<True>, |
807 | option B<-is>, the default), bold and italic font styles imply high |
847 | option B<-is>, the default), bold/blink font styles imply high |
808 | intensity foreground/background colours. Disabling this option (B<False>, |
848 | intensity foreground/background colours. Disabling this option (B<False>, |
809 | option B<+is>) disables this behaviour, the high intensity colours are not |
849 | option B<+is>) disables this behaviour, the high intensity colours are not |
810 | reachable. |
850 | reachable. |
811 | |
851 | |
812 | =item B<selectstyle:> I<mode> |
|
|
813 | |
|
|
814 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
|
|
815 | is xterm style with 2.20 old word selection, or anything else which |
|
|
816 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
817 | selection code is in use. |
|
|
818 | |
|
|
819 | =item B<scrollstyle:> I<mode> |
|
|
820 | |
|
|
821 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
822 | the author's favourite. |
|
|
823 | |
|
|
824 | =item B<title:> I<string> |
852 | =item B<title:> I<string> |
825 | |
853 | |
826 | Set window title string, the default title is the command-line |
854 | Set window title string, the default title is the command-line |
827 | specified after the B<-e> option, if any, otherwise the application |
855 | specified after the B<-e> option, if any, otherwise the application |
828 | name; option B<-title>. |
856 | name; option B<-title>. |
… | |
… | |
841 | =item B<urgentOnBell:> I<boolean> |
869 | =item B<urgentOnBell:> I<boolean> |
842 | |
870 | |
843 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
871 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
844 | B<False>: do not set the urgency hint [default]. |
872 | B<False>: do not set the urgency hint [default]. |
845 | |
873 | |
|
|
874 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
875 | |
846 | =item B<visualBell:> I<boolean> |
876 | =item B<visualBell:> I<boolean> |
847 | |
877 | |
848 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
878 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
849 | B<False>: no visual bell [default]; option B<+vb>. |
879 | B<False>: no visual bell [default]; option B<+vb>. |
850 | |
880 | |
… | |
… | |
872 | |
902 | |
873 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
903 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
874 | |
904 | |
875 | This creates a new file in your home directory with the screen contents |
905 | This creates a new file in your home directory with the screen contents |
876 | every time you hit C<Print>. |
906 | every time you hit C<Print>. |
|
|
907 | |
|
|
908 | =item B<scrollstyle:> I<mode> |
|
|
909 | |
|
|
910 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
911 | the author's favourite. |
877 | |
912 | |
878 | =item B<scrollBar:> I<boolean> |
913 | =item B<scrollBar:> I<boolean> |
879 | |
914 | |
880 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
915 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
881 | disable the scrollbar; option B<+sb>. |
916 | disable the scrollbar; option B<+sb>. |
… | |
… | |
1080 | |
1115 | |
1081 | =item B<secondaryScroll:> I<boolean> |
1116 | =item B<secondaryScroll:> I<boolean> |
1082 | |
1117 | |
1083 | Turn on/off secondary screen scroll (default enabled). If this |
1118 | Turn on/off secondary screen scroll (default enabled). If this |
1084 | option is enabled, scrolls on the secondary screen will change the |
1119 | option is enabled, scrolls on the secondary screen will change the |
1085 | scrollback buffer and switching to/from the secondary screen will |
1120 | scrollback buffer and, when secondaryScreen is off, switching |
1086 | instead scroll the screen up. |
1121 | to/from the secondary screen will instead scroll the screen up. |
1087 | |
1122 | |
1088 | =item B<hold>: I<boolean> |
1123 | =item B<hold>: I<boolean> |
1089 | |
1124 | |
1090 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1125 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1091 | will not immediately destroy its window when the program executed within |
1126 | will not immediately destroy its window when the program executed within |
1092 | it exits. Instead, it will wait till it is being killed or closed by the |
1127 | it exits. Instead, it will wait till it is being killed or closed by the |
1093 | user. |
1128 | user. |
|
|
1129 | |
|
|
1130 | =item B<chdir>: I<path> |
|
|
1131 | |
|
|
1132 | Sets the working directory for the shell (or the command specified via |
|
|
1133 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1134 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1135 | directory will be used; option B<-cd>. |
1094 | |
1136 | |
1095 | =item B<keysym.>I<sym>: I<string> |
1137 | =item B<keysym.>I<sym>: I<string> |
1096 | |
1138 | |
1097 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1139 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1098 | intervening resource name B<keysym.> cannot be omitted. |
1140 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
1205 | all instances, while B<perl-ext> is used for specific instances. |
1247 | all instances, while B<perl-ext> is used for specific instances. |
1206 | |
1248 | |
1207 | =item B<perl-eval>: I<string> |
1249 | =item B<perl-eval>: I<string> |
1208 | |
1250 | |
1209 | Perl code to be evaluated when all extensions have been registered. See |
1251 | Perl code to be evaluated when all extensions have been registered. See |
1210 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1252 | the @@RXVT_NAME@@perl(3) manpage. |
1211 | will be ignored when running setuid/setgid. |
|
|
1212 | |
1253 | |
1213 | =item B<perl-lib>: I<path> |
1254 | =item B<perl-lib>: I<path> |
1214 | |
1255 | |
1215 | Colon-separated list of additional directories that hold extension |
1256 | Colon-separated list of additional directories that hold extension |
1216 | scripts. When looking for extensions specified by the C<perl> resource, |
1257 | scripts. When looking for extensions specified by the C<perl> resource, |
1217 | @@RXVT_NAME@@ will first look in these directories and then in |
1258 | @@RXVT_NAME@@ will first look in these directories and then in |
1218 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1259 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1219 | will be ignored when running setuid/setgid. |
|
|
1220 | |
1260 | |
1221 | See the @@RXVT_NAME@@perl(3) manpage. |
1261 | See the @@RXVT_NAME@@perl(3) manpage. |
1222 | |
1262 | |
1223 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1263 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1224 | |
1264 | |
… | |
… | |
1459 | =back |
1499 | =back |
1460 | |
1500 | |
1461 | =head2 ALPHA CHANNEL SUPPORT |
1501 | =head2 ALPHA CHANNEL SUPPORT |
1462 | |
1502 | |
1463 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1503 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1464 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1504 | their act together, rxvt-unicode will do it's own alpha channel management: |
1465 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1505 | |
1466 | in addition to the ones provided by X, where the additional A component |
1506 | You can prefix any color with an opaquenes percentage enclosed in |
|
|
1507 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1508 | (0-100) that specifies the opacity of the color, where C<0> is completely |
|
|
1509 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1510 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1511 | is the recommended format to specify transparency values, and works with |
|
|
1512 | all ways to specify a colour. |
|
|
1513 | |
|
|
1514 | For complete control, rxvt-unicode also supports |
|
|
1515 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1516 | specifications, where the additional C<aaaa> component specifies opacity |
1467 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1517 | (alpha) values. The minimum value of C<0000> is completely transparent, |
1468 | transparent). You can also prefix any color with C<[percent]>, where |
1518 | while C<ffff> is completely opaque). The two example colours from |
1469 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
1519 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
1470 | the color, where C<0> is completely transparent and C<100> is completelxy |
1520 | C<rgba:0000/ff00/0000/f332>. |
1471 | opaque. |
|
|
1472 | |
1521 | |
1473 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1522 | You probably need to specify B<"-depth 32">, too, to force a visual with |
1474 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1523 | alpha channels, and have the luck that your X-server uses ARGB pixel |
1475 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1524 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1525 | rxvt-unicode just fudges around. |
1476 | |
1526 | |
1477 | For example, the following selects an almost completely transparent red |
1527 | For example, the following selects an almost completely transparent black |
1478 | background, and an almost opaque pink foreground: |
1528 | background, and an almost opaque pink foreground: |
1479 | |
1529 | |
1480 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1530 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
1481 | |
1531 | |
1482 | I<Please note that transparency of any kind if completely unsupported by |
1532 | When not using a background image, then the interpretation of the |
1483 | the author. Don't bug him with installation questions!> |
1533 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1534 | transparency of course). |
|
|
1535 | |
|
|
1536 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1537 | colour will always behave as if it were completely transparent (so the |
|
|
1538 | background image shows instead), regardless of how it was specified, while |
|
|
1539 | other colours will either be transparent as specified (the background |
|
|
1540 | image will show through) on servers supporting the RENDER extension, or |
|
|
1541 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1542 | |
|
|
1543 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1544 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1545 | extension. |
1484 | |
1546 | |
1485 | =head1 ENVIRONMENT |
1547 | =head1 ENVIRONMENT |
1486 | |
1548 | |
1487 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1549 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1488 | |
1550 | |
… | |
… | |
1522 | C<--with-terminfo=PATH>. |
1584 | C<--with-terminfo=PATH>. |
1523 | |
1585 | |
1524 | =item B<DISPLAY> |
1586 | =item B<DISPLAY> |
1525 | |
1587 | |
1526 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1588 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1527 | display in its child processes. |
1589 | display in its child processes if C<-display> isn't used to override. It |
|
|
1590 | defaults to C<:0> if it doesn't exist. |
1528 | |
1591 | |
1529 | =item B<SHELL> |
1592 | =item B<SHELL> |
1530 | |
1593 | |
1531 | The shell to be used for command execution, defaults to C</bin/sh>. |
1594 | The shell to be used for command execution, defaults to C</bin/sh>. |
1532 | |
1595 | |