… | |
… | |
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>. |
|
|
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] |
102 | |
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 | |
… | |
… | |
174 | 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 |
175 | 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 |
176 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
177 | resource I<blurRadius>. |
185 | resource I<blurRadius>. |
178 | |
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 | |
179 | =item B<-bg> I<colour> |
193 | =item B<-bg> I<colour> |
180 | |
194 | |
181 | Window background colour; resource B<background>. |
195 | Window background colour; resource B<background>. |
182 | |
196 | |
183 | =item B<-fg> I<colour> |
197 | =item B<-fg> I<colour> |
… | |
… | |
242 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
256 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
243 | for details. |
257 | for details. |
244 | |
258 | |
245 | =item B<-is>|B<+is> |
259 | =item B<-is>|B<+is> |
246 | |
260 | |
247 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
261 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
248 | foreground/background (default). See resource B<intensityStyles> for |
262 | foreground/background (default). See resource B<intensityStyles> for |
249 | details. |
263 | details. |
250 | |
264 | |
251 | =item B<-name> I<name> |
265 | =item B<-name> I<name> |
252 | |
266 | |
… | |
… | |
270 | |
284 | |
271 | =item B<-sb>|B<+sb> |
285 | =item B<-sb>|B<+sb> |
272 | |
286 | |
273 | Turn on/off scrollbar; resource B<scrollBar>. |
287 | Turn on/off scrollbar; resource B<scrollBar>. |
274 | |
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 | |
275 | =item B<-si>|B<+si> |
298 | =item B<-si>|B<+si> |
276 | |
299 | |
277 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
300 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
278 | B<scrollTtyOutput> has opposite effect. |
301 | B<scrollTtyOutput> has opposite effect. |
279 | |
302 | |
… | |
… | |
285 | =item B<-sw>|B<+sw> |
308 | =item B<-sw>|B<+sw> |
286 | |
309 | |
287 | 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. |
288 | This only takes effect if B<-si> is also given; resource |
311 | This only takes effect if B<-si> is also given; resource |
289 | B<scrollWithBuffer>. |
312 | B<scrollWithBuffer>. |
290 | |
|
|
291 | =item B<-sr>|B<+sr> |
|
|
292 | |
|
|
293 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
294 | |
|
|
295 | =item B<-st>|B<+st> |
|
|
296 | |
|
|
297 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
298 | resource B<scrollBar_floating>. |
|
|
299 | |
313 | |
300 | =item B<-ptab>|B<+ptab> |
314 | =item B<-ptab>|B<+ptab> |
301 | |
315 | |
302 | If enabled (default), "Horizontal Tab" characters are being stored as |
316 | If enabled (default), "Horizontal Tab" characters are being stored as |
303 | 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 |
… | |
… | |
307 | |
321 | |
308 | =item B<-bc>|B<+bc> |
322 | =item B<-bc>|B<+bc> |
309 | |
323 | |
310 | Blink the cursor; resource B<cursorBlink>. |
324 | Blink the cursor; resource B<cursorBlink>. |
311 | |
325 | |
|
|
326 | =item B<-uc>|B<+uc> |
|
|
327 | |
|
|
328 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
329 | |
312 | =item B<-iconic> |
330 | =item B<-iconic> |
313 | |
331 | |
314 | Start iconified, if the window manager supports that option. |
332 | Start iconified, if the window manager supports that option. |
315 | Alternative form is B<-ic>. |
333 | Alternative form is B<-ic>. |
316 | |
334 | |
… | |
… | |
332 | |
350 | |
333 | =item B<-bl> |
351 | =item B<-bl> |
334 | |
352 | |
335 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
353 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
336 | if honoured by the WM, the rxvt-unicode window will not have window |
354 | if honoured by the WM, the rxvt-unicode window will not have window |
337 | decorations; resource B<borderLess>. |
355 | decorations; resource B<borderLess>. If the window manager does not |
|
|
356 | support MWM hints (e.g. kwin), enables override-redirect mode. |
338 | |
357 | |
339 | =item B<-override-redirect> |
358 | =item B<-override-redirect> |
340 | |
359 | |
341 | Compile I<frills>: Sets override-redirect on the window; resource |
360 | Compile I<frills>: Sets override-redirect on the window; resource |
342 | B<override-redirect>. |
361 | B<override-redirect>. |
… | |
… | |
351 | =item B<-lsp> I<number> |
370 | =item B<-lsp> I<number> |
352 | |
371 | |
353 | Compile I<frills>: Lines (pixel height) to insert between each row of |
372 | Compile I<frills>: Lines (pixel height) to insert between each row of |
354 | the display. Useful to work around font rendering problems; resource |
373 | the display. Useful to work around font rendering problems; resource |
355 | B<lineSpace>. |
374 | B<lineSpace>. |
|
|
375 | |
|
|
376 | =item B<-letsp> I<number> |
|
|
377 | |
|
|
378 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
379 | to control overall letter spacing. Negative values will tighten up the |
|
|
380 | letter spacing, positive values will space letters out more. Useful to |
|
|
381 | work around odd font metrics; resource B<letterSpace>. |
356 | |
382 | |
357 | =item B<-tn> I<termname> |
383 | =item B<-tn> I<termname> |
358 | |
384 | |
359 | This option specifies the name of the terminal type to be set in the |
385 | This option specifies the name of the terminal type to be set in the |
360 | B<TERM> environment variable. This terminal type must exist in the |
386 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
447 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
473 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
448 | will not immediately destroy its window when the program executed within |
474 | will not immediately destroy its window when the program executed within |
449 | it exits. Instead, it will wait till it is being killed or closed by the |
475 | it exits. Instead, it will wait till it is being killed or closed by the |
450 | user; resource B<hold>. |
476 | user; resource B<hold>. |
451 | |
477 | |
|
|
478 | =item B<-cd> I<path> |
|
|
479 | |
|
|
480 | Sets the working directory for the shell (or the command specified via |
|
|
481 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
482 | @@RXVT_NAME@@ to start; resource B<chdir>. |
|
|
483 | |
452 | =item B<-xrm> I<string> |
484 | =item B<-xrm> I<string> |
453 | |
485 | |
454 | Works like the X Toolkit option of the same name, by adding the I<string> |
486 | Works like the X Toolkit option of the same name, by adding the I<string> |
455 | as if it were specified in a resource file. Resource values specified this |
487 | as if it were specified in a resource file. Resource values specified this |
456 | way take precedence over all other resource specifications. |
488 | way take precedence over all other resource specifications. |
… | |
… | |
503 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
535 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
504 | entries and will not tinker with pty/tty permissions - you have to do that |
536 | entries and will not tinker with pty/tty permissions - you have to do that |
505 | yourself if you want that. |
537 | yourself if you want that. |
506 | |
538 | |
507 | As an extremely special case, specifying C<-1> will completely suppress |
539 | As an extremely special case, specifying C<-1> will completely suppress |
508 | pty/tty operations. |
540 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
541 | perl extension that manages the terminal. |
509 | |
542 | |
510 | Here is a example in perl that illustrates how this option can be used (a |
543 | Here is a example in perl that illustrates how this option can be used (a |
511 | longer example is in F<doc/pty-fd>): |
544 | longer example is in F<doc/pty-fd>): |
512 | |
545 | |
513 | use IO::Pty; |
546 | use IO::Pty; |
… | |
… | |
527 | Comma-separated list of perl extension scripts to use (or not to use) in |
560 | Comma-separated list of perl extension scripts to use (or not to use) in |
528 | this terminal instance. See resource B<perl-ext> for details. |
561 | this terminal instance. See resource B<perl-ext> for details. |
529 | |
562 | |
530 | =back |
563 | =back |
531 | |
564 | |
532 | =head1 RESOURCES (available also as long-options) |
565 | =head1 RESOURCES |
533 | |
566 | |
534 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
567 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
535 | options) compiled into your version. |
568 | options) compiled into your version. All resources are also available as |
|
|
569 | long-options. |
536 | |
570 | |
537 | You can set and change the resources using X11 tools like B<xrdb>. Many |
571 | You can set and change the resources using X11 tools like B<xrdb>. Many |
538 | distribution do also load settings from the B<~/.Xresources> file when X |
572 | distribution do also load settings from the B<~/.Xresources> file when X |
539 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
573 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
540 | with later settings overwriting earlier ones: |
574 | with later settings overwriting earlier ones: |
… | |
… | |
562 | =item B<depth:> I<bitdepth> |
596 | =item B<depth:> I<bitdepth> |
563 | |
597 | |
564 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
598 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
565 | option B<-depth>. |
599 | option B<-depth>. |
566 | |
600 | |
|
|
601 | =item B<buffered:> I<boolean> |
|
|
602 | |
|
|
603 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
604 | On some card/driver combination enabling it slightly decreases |
|
|
605 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
606 | should normally be enabled. |
|
|
607 | |
567 | =item B<geometry:> I<geom> |
608 | =item B<geometry:> I<geom> |
568 | |
609 | |
569 | Create the window with the specified X window geometry [default 80x24]; |
610 | Create the window with the specified X window geometry [default 80x24]; |
570 | option B<-geometry>. |
611 | option B<-geometry>. |
571 | |
612 | |
… | |
… | |
689 | |
730 | |
690 | Specify background blending type; option B<-blt>. |
731 | Specify background blending type; option B<-blt>. |
691 | |
732 | |
692 | =item B<blurRadius:> I<number> |
733 | =item B<blurRadius:> I<number> |
693 | |
734 | |
694 | Apply Gaussian Blurr with the specified radius to the transparent |
735 | Apply gaussian blur with the specified radius to the transparent |
695 | background image; option B<-blr>. |
736 | background image; option B<-blr>. |
|
|
737 | |
|
|
738 | =item B<iconFile:> I<file> |
|
|
739 | |
|
|
740 | Set the application icon pixmap; option B<-icon>. |
696 | |
741 | |
697 | =item B<scrollColor:> I<colour> |
742 | =item B<scrollColor:> I<colour> |
698 | |
743 | |
699 | Use the specified colour for the scrollbar [default #B2B2B2]. |
744 | Use the specified colour for the scrollbar [default #B2B2B2]. |
700 | |
745 | |
… | |
… | |
719 | an integer number of images in that direction. No image will be magnified |
764 | an integer number of images in that direction. No image will be magnified |
720 | beyond 10 times its original size. The maximum permitted scale is 1000. |
765 | beyond 10 times its original size. The maximum permitted scale is 1000. |
721 | Additional operations can be specified after colon B<:op1:op2...>. |
766 | Additional operations can be specified after colon B<:op1:op2...>. |
722 | Supported operations are: |
767 | Supported operations are: |
723 | |
768 | |
724 | tile force background image to be tiled and not scaled. Equivalent to 0x0, |
769 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
725 | propscale will scale image keeping proportions, |
770 | propscale will scale image keeping proportions |
726 | auto will scale image to match window size. Equivalent to 100x100; |
771 | auto will scale image to match window size. Equivalent to 100x100 |
727 | hscale will scale image horizontally to the window size; |
772 | hscale will scale image horizontally to the window size |
728 | vscale will scale image vertically to the window size; |
773 | vscale will scale image vertically to the window size |
729 | scale will scale image to match window size; |
774 | scale will scale image to match window size |
730 | root will tile image as if it was a root window background, auto-adjusting |
775 | root will tile image as if it was a root window background, auto-adjusting |
731 | whenever terminal window moves. |
776 | whenever terminal window moves |
732 | |
777 | |
733 | If used in conjunction with B<-tr> option, the specified pixmap will be |
778 | If used in conjunction with B<-tr> option, the specified pixmap will be |
734 | blended over transparency image using either alpha-blending, or any |
779 | blended over transparency image using either alpha-blending, or any |
735 | other blending type, specified with B<-blt "type"> option. |
780 | other blending type, specified with B<-blt "type"> option. |
736 | |
781 | |
… | |
… | |
801 | text font will being used for the given style. |
846 | text font will being used for the given style. |
802 | |
847 | |
803 | =item B<intensityStyles:> I<boolean> |
848 | =item B<intensityStyles:> I<boolean> |
804 | |
849 | |
805 | When font styles are not enabled, or this option is enabled (B<True>, |
850 | When font styles are not enabled, or this option is enabled (B<True>, |
806 | option B<-is>, the default), bold and italic font styles imply high |
851 | option B<-is>, the default), bold/blink font styles imply high |
807 | intensity foreground/background colours. Disabling this option (B<False>, |
852 | intensity foreground/background colours. Disabling this option (B<False>, |
808 | option B<+is>) disables this behaviour, the high intensity colours are not |
853 | option B<+is>) disables this behaviour, the high intensity colours are not |
809 | reachable. |
854 | reachable. |
810 | |
855 | |
811 | =item B<selectstyle:> I<mode> |
|
|
812 | |
|
|
813 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
|
|
814 | is xterm style with 2.20 old word selection, or anything else which |
|
|
815 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
816 | selection code is in use. |
|
|
817 | |
|
|
818 | =item B<scrollstyle:> I<mode> |
|
|
819 | |
|
|
820 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
821 | the author's favourite. |
|
|
822 | |
|
|
823 | =item B<title:> I<string> |
856 | =item B<title:> I<string> |
824 | |
857 | |
825 | Set window title string, the default title is the command-line |
858 | Set window title string, the default title is the command-line |
826 | specified after the B<-e> option, if any, otherwise the application |
859 | specified after the B<-e> option, if any, otherwise the application |
827 | name; option B<-title>. |
860 | name; option B<-title>. |
… | |
… | |
840 | =item B<urgentOnBell:> I<boolean> |
873 | =item B<urgentOnBell:> I<boolean> |
841 | |
874 | |
842 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
875 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
843 | B<False>: do not set the urgency hint [default]. |
876 | B<False>: do not set the urgency hint [default]. |
844 | |
877 | |
|
|
878 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
879 | |
845 | =item B<visualBell:> I<boolean> |
880 | =item B<visualBell:> I<boolean> |
846 | |
881 | |
847 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
882 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
848 | B<False>: no visual bell [default]; option B<+vb>. |
883 | B<False>: no visual bell [default]; option B<+vb>. |
849 | |
884 | |
… | |
… | |
871 | |
906 | |
872 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
907 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
873 | |
908 | |
874 | This creates a new file in your home directory with the screen contents |
909 | This creates a new file in your home directory with the screen contents |
875 | every time you hit C<Print>. |
910 | every time you hit C<Print>. |
|
|
911 | |
|
|
912 | =item B<scrollstyle:> I<mode> |
|
|
913 | |
|
|
914 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
915 | the author's favourite. |
876 | |
916 | |
877 | =item B<scrollBar:> I<boolean> |
917 | =item B<scrollBar:> I<boolean> |
878 | |
918 | |
879 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
919 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
880 | disable the scrollbar; option B<+sb>. |
920 | disable the scrollbar; option B<+sb>. |
… | |
… | |
967 | |
1007 | |
968 | =item B<cursorBlink:> I<boolean> |
1008 | =item B<cursorBlink:> I<boolean> |
969 | |
1009 | |
970 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1010 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
971 | option B<-bc>. |
1011 | option B<-bc>. |
|
|
1012 | |
|
|
1013 | =item B<cursorUnderline:> I<boolean> |
|
|
1014 | |
|
|
1015 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
1016 | option B<-uc>. |
972 | |
1017 | |
973 | =item B<pointerBlank:> I<boolean> |
1018 | =item B<pointerBlank:> I<boolean> |
974 | |
1019 | |
975 | B<True>: blank the pointer when a key is pressed or after a set number |
1020 | B<True>: blank the pointer when a key is pressed or after a set number |
976 | of seconds of inactivity. B<False>: the pointer is always visible |
1021 | of seconds of inactivity. B<False>: the pointer is always visible |
… | |
… | |
1079 | |
1124 | |
1080 | =item B<secondaryScroll:> I<boolean> |
1125 | =item B<secondaryScroll:> I<boolean> |
1081 | |
1126 | |
1082 | Turn on/off secondary screen scroll (default enabled). If this |
1127 | Turn on/off secondary screen scroll (default enabled). If this |
1083 | option is enabled, scrolls on the secondary screen will change the |
1128 | option is enabled, scrolls on the secondary screen will change the |
1084 | scrollback buffer and switching to/from the secondary screen will |
1129 | scrollback buffer and, when secondaryScreen is off, switching |
1085 | instead scroll the screen up. |
1130 | to/from the secondary screen will instead scroll the screen up. |
1086 | |
1131 | |
1087 | =item B<hold>: I<boolean> |
1132 | =item B<hold>: I<boolean> |
1088 | |
1133 | |
1089 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1134 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1090 | will not immediately destroy its window when the program executed within |
1135 | will not immediately destroy its window when the program executed within |
1091 | it exits. Instead, it will wait till it is being killed or closed by the |
1136 | it exits. Instead, it will wait till it is being killed or closed by the |
1092 | user. |
1137 | user. |
|
|
1138 | |
|
|
1139 | =item B<chdir>: I<path> |
|
|
1140 | |
|
|
1141 | Sets the working directory for the shell (or the command specified via |
|
|
1142 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1143 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1144 | directory will be used; option B<-cd>. |
1093 | |
1145 | |
1094 | =item B<keysym.>I<sym>: I<string> |
1146 | =item B<keysym.>I<sym>: I<string> |
1095 | |
1147 | |
1096 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1148 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1097 | intervening resource name B<keysym.> cannot be omitted. |
1149 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
1136 | when Control-Meta-c is being pressed": |
1188 | when Control-Meta-c is being pressed": |
1137 | |
1189 | |
1138 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1190 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1139 | |
1191 | |
1140 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1192 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1141 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1193 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1142 | manpage. For example, the F<selection> extension (activated via |
1194 | manpage. For example, the F<selection> extension (activated via |
1143 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1195 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1144 | |
1196 | |
1145 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1197 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1146 | |
1198 | |
… | |
… | |
1204 | all instances, while B<perl-ext> is used for specific instances. |
1256 | all instances, while B<perl-ext> is used for specific instances. |
1205 | |
1257 | |
1206 | =item B<perl-eval>: I<string> |
1258 | =item B<perl-eval>: I<string> |
1207 | |
1259 | |
1208 | Perl code to be evaluated when all extensions have been registered. See |
1260 | Perl code to be evaluated when all extensions have been registered. See |
1209 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1261 | the @@RXVT_NAME@@perl(3) manpage. |
1210 | will be ignored when running setuid/setgid. |
|
|
1211 | |
1262 | |
1212 | =item B<perl-lib>: I<path> |
1263 | =item B<perl-lib>: I<path> |
1213 | |
1264 | |
1214 | Colon-separated list of additional directories that hold extension |
1265 | Colon-separated list of additional directories that hold extension |
1215 | scripts. When looking for extensions specified by the C<perl> resource, |
1266 | scripts. When looking for extensions specified by the C<perl> resource, |
1216 | @@RXVT_NAME@@ will first look in these directories and then in |
1267 | @@RXVT_NAME@@ will first look in these directories and then in |
1217 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1268 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1218 | will be ignored when running setuid/setgid. |
|
|
1219 | |
1269 | |
1220 | See the @@RXVT_NAME@@perl(3) manpage. |
1270 | See the @@RXVT_NAME@@perl(3) manpage. |
1221 | |
1271 | |
1222 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1272 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1223 | |
1273 | |
… | |
… | |
1245 | |
1295 | |
1246 | =item B<override-redirect>: I<boolean> |
1296 | =item B<override-redirect>: I<boolean> |
1247 | |
1297 | |
1248 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1298 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1249 | it almost invisible to window managers; option B<-override-redirect>. |
1299 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1300 | |
|
|
1301 | =item B<iso14755:> I<boolean> |
|
|
1302 | |
|
|
1303 | Turn on/off ISO 14755 (default enabled). |
1250 | |
1304 | |
1251 | =item B<iso14755_52:> I<boolean> |
1305 | =item B<iso14755_52:> I<boolean> |
1252 | |
1306 | |
1253 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1307 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1254 | |
1308 | |
… | |
… | |
1446 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1500 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1447 | always swapping the foreground/background colours. This is in contrast to |
1501 | always swapping the foreground/background colours. This is in contrast to |
1448 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1502 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1449 | been specified. For example, |
1503 | been specified. For example, |
1450 | |
1504 | |
1451 | =over 4 |
|
|
1452 | |
|
|
1453 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1505 | @@RXVT_NAME@@ -fg Black -bg White -rv |
1454 | |
1506 | |
1455 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1507 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
1456 | on White. |
1508 | White. |
1457 | |
|
|
1458 | =back |
|
|
1459 | |
1509 | |
1460 | =head2 ALPHA CHANNEL SUPPORT |
1510 | =head2 ALPHA CHANNEL SUPPORT |
1461 | |
1511 | |
1462 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1512 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1463 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1513 | their act together, rxvt-unicode will do it's own alpha channel management: |
1464 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1514 | |
1465 | in addition to the ones provided by X, where the additional A component |
1515 | You can prefix any color with an opaquenes percentage enclosed in |
|
|
1516 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1517 | (0-100) that specifies the opacity of the color, where C<0> is completely |
|
|
1518 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1519 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1520 | is the recommended format to specify transparency values, and works with |
|
|
1521 | all ways to specify a colour. |
|
|
1522 | |
|
|
1523 | For complete control, rxvt-unicode also supports |
|
|
1524 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1525 | specifications, where the additional C<aaaa> component specifies opacity |
1466 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1526 | (alpha) values. The minimum value of C<0000> is completely transparent, |
1467 | transparent). You can also prefix any color with C<[percent]>, where |
1527 | while C<ffff> is completely opaque). The two example colours from |
1468 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
1528 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
1469 | the color, where C<0> is completely transparent and C<100> is completelxy |
1529 | C<rgba:0000/ff00/0000/f332>. |
1470 | opaque. |
|
|
1471 | |
1530 | |
1472 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1531 | You probably need to specify B<"-depth 32">, too, to force a visual with |
1473 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1532 | alpha channels, and have the luck that your X-server uses ARGB pixel |
1474 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1533 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1534 | rxvt-unicode just fudges around. |
1475 | |
1535 | |
1476 | For example, the following selects an almost completely transparent red |
1536 | For example, the following selects an almost completely transparent black |
1477 | background, and an almost opaque pink foreground: |
1537 | background, and an almost opaque pink foreground: |
1478 | |
1538 | |
1479 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1539 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
1480 | |
1540 | |
1481 | I<Please note that transparency of any kind if completely unsupported by |
1541 | When not using a background image, then the interpretation of the |
1482 | the author. Don't bug him with installation questions!> |
1542 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1543 | transparency of course). |
|
|
1544 | |
|
|
1545 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1546 | colour will always behave as if it were completely transparent (so the |
|
|
1547 | background image shows instead), regardless of how it was specified, while |
|
|
1548 | other colours will either be transparent as specified (the background |
|
|
1549 | image will show through) on servers supporting the RENDER extension, or |
|
|
1550 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1551 | |
|
|
1552 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1553 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1554 | extension. |
1483 | |
1555 | |
1484 | =head1 ENVIRONMENT |
1556 | =head1 ENVIRONMENT |
1485 | |
1557 | |
1486 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1558 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1487 | |
1559 | |
… | |
… | |
1521 | C<--with-terminfo=PATH>. |
1593 | C<--with-terminfo=PATH>. |
1522 | |
1594 | |
1523 | =item B<DISPLAY> |
1595 | =item B<DISPLAY> |
1524 | |
1596 | |
1525 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1597 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1526 | display in its child processes. |
1598 | display in its child processes if C<-display> isn't used to override. It |
|
|
1599 | defaults to C<:0> if it doesn't exist. |
1527 | |
1600 | |
1528 | =item B<SHELL> |
1601 | =item B<SHELL> |
1529 | |
1602 | |
1530 | The shell to be used for command execution, defaults to C</bin/sh>. |
1603 | The shell to be used for command execution, defaults to C</bin/sh>. |
1531 | |
1604 | |