… | |
… | |
92 | |
92 | |
93 | Print out a message describing available options. |
93 | Print out a message describing available options. |
94 | |
94 | |
95 | =item B<-display> I<displayname> |
95 | =item B<-display> I<displayname> |
96 | |
96 | |
97 | 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> |
98 | 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 |
99 | B<DISPLAY> environment variable is used. |
99 | display specified by the B<DISPLAY> environment variable is used. |
100 | |
100 | |
101 | =item B<-depth> I<bitdepth> |
101 | =item B<-depth> I<bitdepth> |
102 | |
102 | |
103 | 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; |
104 | 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] |
105 | |
110 | |
106 | =item B<-geometry> I<geom> |
111 | =item B<-geometry> I<geom> |
107 | |
112 | |
108 | Window geometry (B<-g> still respected); resource B<geometry>. |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
109 | |
114 | |
… | |
… | |
147 | 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 |
148 | 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. |
149 | 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, |
150 | 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: |
151 | 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 |
152 | pure black and pure white colors essentially mean no tinting; resource |
157 | pure black and pure white colours essentially mean no tinting; resource |
153 | I<tintColor>. Example: |
158 | I<tintColor>. Example: |
154 | |
159 | |
155 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
160 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
156 | |
161 | |
157 | =item B<-sh> I<number> |
162 | =item B<-sh> I<number> |
… | |
… | |
163 | =item B<-blt> I<string> |
168 | =item B<-blt> I<string> |
164 | |
169 | |
165 | Specify background blending type. If background pixmap is specified |
170 | Specify background blending type. If background pixmap is specified |
166 | at the same time as transparency - such pixmap will be blended over |
171 | at the same time as transparency - such pixmap will be blended over |
167 | transparency image, using method specified. Supported values are : |
172 | transparency image, using method specified. Supported values are : |
168 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
173 | B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>, |
169 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
174 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
170 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
175 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
171 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
176 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
172 | |
177 | |
173 | =item B<-blr> I<HxV> |
178 | =item B<-blr> I<HxV> |
… | |
… | |
177 | 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 |
178 | 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 |
179 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
180 | resource I<blurRadius>. |
185 | resource I<blurRadius>. |
181 | |
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 | |
182 | =item B<-bg> I<colour> |
193 | =item B<-bg> I<colour> |
183 | |
194 | |
184 | Window background colour; resource B<background>. |
195 | Window background colour; resource B<background>. |
185 | |
196 | |
186 | =item B<-fg> I<colour> |
197 | =item B<-fg> I<colour> |
… | |
… | |
245 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
256 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
246 | for details. |
257 | for details. |
247 | |
258 | |
248 | =item B<-is>|B<+is> |
259 | =item B<-is>|B<+is> |
249 | |
260 | |
250 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
261 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
251 | foreground/background (default). See resource B<intensityStyles> for |
262 | foreground/background (default). See resource B<intensityStyles> for |
252 | details. |
263 | details. |
253 | |
264 | |
254 | =item B<-name> I<name> |
265 | =item B<-name> I<name> |
255 | |
266 | |
… | |
… | |
273 | |
284 | |
274 | =item B<-sb>|B<+sb> |
285 | =item B<-sb>|B<+sb> |
275 | |
286 | |
276 | Turn on/off scrollbar; resource B<scrollBar>. |
287 | Turn on/off scrollbar; resource B<scrollBar>. |
277 | |
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 | |
278 | =item B<-si>|B<+si> |
298 | =item B<-si>|B<+si> |
279 | |
299 | |
280 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
300 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
281 | B<scrollTtyOutput> has opposite effect. |
301 | B<scrollTtyOutput> has opposite effect. |
282 | |
302 | |
… | |
… | |
288 | =item B<-sw>|B<+sw> |
308 | =item B<-sw>|B<+sw> |
289 | |
309 | |
290 | 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. |
291 | This only takes effect if B<-si> is also given; resource |
311 | This only takes effect if B<-si> is also given; resource |
292 | B<scrollWithBuffer>. |
312 | B<scrollWithBuffer>. |
293 | |
|
|
294 | =item B<-sr>|B<+sr> |
|
|
295 | |
|
|
296 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
297 | |
|
|
298 | =item B<-st>|B<+st> |
|
|
299 | |
|
|
300 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
301 | resource B<scrollBar_floating>. |
|
|
302 | |
313 | |
303 | =item B<-ptab>|B<+ptab> |
314 | =item B<-ptab>|B<+ptab> |
304 | |
315 | |
305 | If enabled (default), "Horizontal Tab" characters are being stored as |
316 | If enabled (default), "Horizontal Tab" characters are being stored as |
306 | 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 |
… | |
… | |
310 | |
321 | |
311 | =item B<-bc>|B<+bc> |
322 | =item B<-bc>|B<+bc> |
312 | |
323 | |
313 | Blink the cursor; resource B<cursorBlink>. |
324 | Blink the cursor; resource B<cursorBlink>. |
314 | |
325 | |
|
|
326 | =item B<-uc>|B<+uc> |
|
|
327 | |
|
|
328 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
329 | |
315 | =item B<-iconic> |
330 | =item B<-iconic> |
316 | |
331 | |
317 | Start iconified, if the window manager supports that option. |
332 | Start iconified, if the window manager supports that option. |
318 | Alternative form is B<-ic>. |
333 | Alternative form is B<-ic>. |
319 | |
334 | |
… | |
… | |
335 | |
350 | |
336 | =item B<-bl> |
351 | =item B<-bl> |
337 | |
352 | |
338 | 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. |
339 | 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 |
340 | 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. |
341 | |
357 | |
342 | =item B<-override-redirect> |
358 | =item B<-override-redirect> |
343 | |
359 | |
344 | Compile I<frills>: Sets override-redirect on the window; resource |
360 | Compile I<frills>: Sets override-redirect on the window; resource |
345 | B<override-redirect>. |
361 | B<override-redirect>. |
… | |
… | |
354 | =item B<-lsp> I<number> |
370 | =item B<-lsp> I<number> |
355 | |
371 | |
356 | 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 |
357 | the display. Useful to work around font rendering problems; resource |
373 | the display. Useful to work around font rendering problems; resource |
358 | 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>. |
359 | |
382 | |
360 | =item B<-tn> I<termname> |
383 | =item B<-tn> I<termname> |
361 | |
384 | |
362 | 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 |
363 | B<TERM> environment variable. This terminal type must exist in the |
386 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
449 | |
472 | |
450 | 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@@ |
451 | will not immediately destroy its window when the program executed within |
474 | will not immediately destroy its window when the program executed within |
452 | 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 |
453 | user; resource B<hold>. |
476 | user; resource B<hold>. |
|
|
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>. |
454 | |
483 | |
455 | =item B<-xrm> I<string> |
484 | =item B<-xrm> I<string> |
456 | |
485 | |
457 | 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> |
458 | 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 |
… | |
… | |
567 | =item B<depth:> I<bitdepth> |
596 | =item B<depth:> I<bitdepth> |
568 | |
597 | |
569 | 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; |
570 | option B<-depth>. |
599 | option B<-depth>. |
571 | |
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 | |
572 | =item B<geometry:> I<geom> |
608 | =item B<geometry:> I<geom> |
573 | |
609 | |
574 | Create the window with the specified X window geometry [default 80x24]; |
610 | Create the window with the specified X window geometry [default 80x24]; |
575 | option B<-geometry>. |
611 | option B<-geometry>. |
576 | |
612 | |
… | |
… | |
589 | Use the specified colour for the colour value I<n>, where 0-7 |
625 | Use the specified colour for the colour value I<n>, where 0-7 |
590 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
626 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
591 | high-intensity (bold = bright foreground, blink = bright background) |
627 | high-intensity (bold = bright foreground, blink = bright background) |
592 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
628 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
593 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
629 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
594 | names used are listed in the B<COLORS AND GRAPHICS> section. |
630 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
595 | |
631 | |
596 | Colours higher than 15 cannot be set using resources (yet), but can be |
632 | Colours higher than 15 cannot be set using resources (yet), but can be |
597 | changed using an escape command (see @@RXVT_NAME@@(7)). |
633 | changed using an escape command (see @@RXVT_NAME@@(7)). |
598 | |
634 | |
599 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
635 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
610 | =item B<colorUL:> I<colour> |
646 | =item B<colorUL:> I<colour> |
611 | |
647 | |
612 | Use the specified colour to display underlined characters when the |
648 | Use the specified colour to display underlined characters when the |
613 | foreground colour is the default. |
649 | foreground colour is the default. |
614 | |
650 | |
615 | =item B<colorRV:> I<colour> |
|
|
616 | |
|
|
617 | Use the specified colour as the background for reverse video characters |
|
|
618 | when OPTION_HC is disabled (--disable-frills). |
|
|
619 | |
|
|
620 | =item B<underlineColor:> I<colour> |
651 | =item B<underlineColor:> I<colour> |
621 | |
652 | |
622 | If set, use the specified colour as the colour for the underline |
653 | If set, use the specified colour as the colour for the underline |
623 | itself. If unset, use the foreground colour. |
654 | itself. If unset, use the foreground colour. |
|
|
655 | |
|
|
656 | =item B<highlightColor:> I<colour> |
|
|
657 | |
|
|
658 | If set, use the specified colour as the background for highlighted |
|
|
659 | characters. If unset, use reverse video. |
|
|
660 | |
|
|
661 | =item B<highlightTextColor:> I<colour> |
|
|
662 | |
|
|
663 | If set and highlightColor is set, use the specified colour as the |
|
|
664 | foreground for highlighted characters. |
624 | |
665 | |
625 | =item B<cursorColor:> I<colour> |
666 | =item B<cursorColor:> I<colour> |
626 | |
667 | |
627 | Use the specified colour for the cursor. The default is to use the |
668 | Use the specified colour for the cursor. The default is to use the |
628 | foreground colour; option B<-cr>. |
669 | foreground colour; option B<-cr>. |
… | |
… | |
635 | |
676 | |
636 | =item B<reverseVideo:> I<boolean> |
677 | =item B<reverseVideo:> I<boolean> |
637 | |
678 | |
638 | B<True>: simulate reverse video by foreground and background colours; |
679 | B<True>: simulate reverse video by foreground and background colours; |
639 | option B<-rv>. B<False>: regular screen colours [default]; option |
680 | option B<-rv>. B<False>: regular screen colours [default]; option |
640 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
681 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
641 | |
682 | |
642 | =item B<jumpScroll:> I<boolean> |
683 | =item B<jumpScroll:> I<boolean> |
643 | |
684 | |
644 | B<True>: specify that jump scrolling should be used. When receiving lots |
685 | B<True>: specify that jump scrolling should be used. When receiving lots |
645 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
686 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
… | |
… | |
694 | |
735 | |
695 | Specify background blending type; option B<-blt>. |
736 | Specify background blending type; option B<-blt>. |
696 | |
737 | |
697 | =item B<blurRadius:> I<number> |
738 | =item B<blurRadius:> I<number> |
698 | |
739 | |
699 | Apply Gaussian Blurr with the specified radius to the transparent |
740 | Apply gaussian blur with the specified radius to the transparent |
700 | background image; option B<-blr>. |
741 | background image; option B<-blr>. |
|
|
742 | |
|
|
743 | =item B<iconFile:> I<file> |
|
|
744 | |
|
|
745 | Set the application icon pixmap; option B<-icon>. |
701 | |
746 | |
702 | =item B<scrollColor:> I<colour> |
747 | =item B<scrollColor:> I<colour> |
703 | |
748 | |
704 | Use the specified colour for the scrollbar [default #B2B2B2]. |
749 | Use the specified colour for the scrollbar [default #B2B2B2]. |
705 | |
750 | |
… | |
… | |
724 | an integer number of images in that direction. No image will be magnified |
769 | an integer number of images in that direction. No image will be magnified |
725 | beyond 10 times its original size. The maximum permitted scale is 1000. |
770 | beyond 10 times its original size. The maximum permitted scale is 1000. |
726 | Additional operations can be specified after colon B<:op1:op2...>. |
771 | Additional operations can be specified after colon B<:op1:op2...>. |
727 | Supported operations are: |
772 | Supported operations are: |
728 | |
773 | |
729 | tile force background image to be tiled and not scaled. Equivalent to 0x0, |
774 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
730 | propscale will scale image keeping proportions, |
775 | propscale will scale image keeping proportions |
731 | auto will scale image to match window size. Equivalent to 100x100; |
776 | auto will scale image to match window size. Equivalent to 100x100 |
732 | hscale will scale image horizontally to the window size; |
777 | hscale will scale image horizontally to the window size |
733 | vscale will scale image vertically to the window size; |
778 | vscale will scale image vertically to the window size |
734 | scale will scale image to match window size; |
779 | scale will scale image to match window size |
735 | root will tile image as if it was a root window background, auto-adjusting |
780 | root will tile image as if it was a root window background, auto-adjusting |
736 | whenever terminal window moves. |
781 | whenever terminal window moves |
737 | |
782 | |
738 | If used in conjunction with B<-tr> option, the specified pixmap will be |
783 | If used in conjunction with B<-tr> option, the specified pixmap will be |
739 | blended over transparency image using either alpha-blending, or any |
784 | blended over transparency image using either alpha-blending, or any |
740 | other blending type, specified with B<-blt "type"> option. |
785 | other blending type, specified with B<-blt "type"> option. |
741 | |
786 | |
… | |
… | |
772 | it is named first) and thus defines the character cell grid to be 9 pixels |
817 | it is named first) and thus defines the character cell grid to be 9 pixels |
773 | wide and 15 pixels high. |
818 | wide and 15 pixels high. |
774 | |
819 | |
775 | The second font is just used to add additional unicode characters not in |
820 | The second font is just used to add additional unicode characters not in |
776 | the base font, likewise the third, which is unfortunately non-bold, but |
821 | the base font, likewise the third, which is unfortunately non-bold, but |
777 | the bold version of the font does contain less characters, so this is a |
822 | the bold version of the font does contain fewer characters, so this is a |
778 | useful supplement. |
823 | useful supplement. |
779 | |
824 | |
780 | The third font is an Xft font with aliasing turned off, and the characters |
825 | The third font is an Xft font with aliasing turned off, and the characters |
781 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
826 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
782 | contains other characters, but we are not interested in them. |
827 | contains other characters, but we are not interested in them. |
… | |
… | |
806 | text font will being used for the given style. |
851 | text font will being used for the given style. |
807 | |
852 | |
808 | =item B<intensityStyles:> I<boolean> |
853 | =item B<intensityStyles:> I<boolean> |
809 | |
854 | |
810 | When font styles are not enabled, or this option is enabled (B<True>, |
855 | When font styles are not enabled, or this option is enabled (B<True>, |
811 | option B<-is>, the default), bold and italic font styles imply high |
856 | option B<-is>, the default), bold/blink font styles imply high |
812 | intensity foreground/background colours. Disabling this option (B<False>, |
857 | intensity foreground/background colours. Disabling this option (B<False>, |
813 | option B<+is>) disables this behaviour, the high intensity colours are not |
858 | option B<+is>) disables this behaviour, the high intensity colours are not |
814 | reachable. |
859 | reachable. |
815 | |
860 | |
816 | =item B<selectstyle:> I<mode> |
|
|
817 | |
|
|
818 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
|
|
819 | is xterm style with 2.20 old word selection, or anything else which |
|
|
820 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
821 | selection code is in use. |
|
|
822 | |
|
|
823 | =item B<scrollstyle:> I<mode> |
|
|
824 | |
|
|
825 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
826 | the author's favourite. |
|
|
827 | |
|
|
828 | =item B<title:> I<string> |
861 | =item B<title:> I<string> |
829 | |
862 | |
830 | Set window title string, the default title is the command-line |
863 | Set window title string, the default title is the command-line |
831 | specified after the B<-e> option, if any, otherwise the application |
864 | specified after the B<-e> option, if any, otherwise the application |
832 | name; option B<-title>. |
865 | name; option B<-title>. |
… | |
… | |
845 | =item B<urgentOnBell:> I<boolean> |
878 | =item B<urgentOnBell:> I<boolean> |
846 | |
879 | |
847 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
880 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
848 | B<False>: do not set the urgency hint [default]. |
881 | B<False>: do not set the urgency hint [default]. |
849 | |
882 | |
|
|
883 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
884 | |
850 | =item B<visualBell:> I<boolean> |
885 | =item B<visualBell:> I<boolean> |
851 | |
886 | |
852 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
887 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
853 | B<False>: no visual bell [default]; option B<+vb>. |
888 | B<False>: no visual bell [default]; option B<+vb>. |
854 | |
889 | |
… | |
… | |
876 | |
911 | |
877 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
912 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
878 | |
913 | |
879 | This creates a new file in your home directory with the screen contents |
914 | This creates a new file in your home directory with the screen contents |
880 | every time you hit C<Print>. |
915 | every time you hit C<Print>. |
|
|
916 | |
|
|
917 | =item B<scrollstyle:> I<mode> |
|
|
918 | |
|
|
919 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
920 | the author's favourite. |
881 | |
921 | |
882 | =item B<scrollBar:> I<boolean> |
922 | =item B<scrollBar:> I<boolean> |
883 | |
923 | |
884 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
924 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
885 | disable the scrollbar; option B<+sb>. |
925 | disable the scrollbar; option B<+sb>. |
… | |
… | |
972 | |
1012 | |
973 | =item B<cursorBlink:> I<boolean> |
1013 | =item B<cursorBlink:> I<boolean> |
974 | |
1014 | |
975 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1015 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
976 | option B<-bc>. |
1016 | option B<-bc>. |
|
|
1017 | |
|
|
1018 | =item B<cursorUnderline:> I<boolean> |
|
|
1019 | |
|
|
1020 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
1021 | option B<-uc>. |
977 | |
1022 | |
978 | =item B<pointerBlank:> I<boolean> |
1023 | =item B<pointerBlank:> I<boolean> |
979 | |
1024 | |
980 | B<True>: blank the pointer when a key is pressed or after a set number |
1025 | B<True>: blank the pointer when a key is pressed or after a set number |
981 | of seconds of inactivity. B<False>: the pointer is always visible |
1026 | of seconds of inactivity. B<False>: the pointer is always visible |
… | |
… | |
1084 | |
1129 | |
1085 | =item B<secondaryScroll:> I<boolean> |
1130 | =item B<secondaryScroll:> I<boolean> |
1086 | |
1131 | |
1087 | Turn on/off secondary screen scroll (default enabled). If this |
1132 | Turn on/off secondary screen scroll (default enabled). If this |
1088 | option is enabled, scrolls on the secondary screen will change the |
1133 | option is enabled, scrolls on the secondary screen will change the |
1089 | scrollback buffer and switching to/from the secondary screen will |
1134 | scrollback buffer and, when secondaryScreen is off, switching |
1090 | instead scroll the screen up. |
1135 | to/from the secondary screen will instead scroll the screen up. |
1091 | |
1136 | |
1092 | =item B<hold>: I<boolean> |
1137 | =item B<hold>: I<boolean> |
1093 | |
1138 | |
1094 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1139 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1095 | will not immediately destroy its window when the program executed within |
1140 | will not immediately destroy its window when the program executed within |
1096 | it exits. Instead, it will wait till it is being killed or closed by the |
1141 | it exits. Instead, it will wait till it is being killed or closed by the |
1097 | user. |
1142 | user. |
|
|
1143 | |
|
|
1144 | =item B<chdir>: I<path> |
|
|
1145 | |
|
|
1146 | Sets the working directory for the shell (or the command specified via |
|
|
1147 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1148 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1149 | directory will be used; option B<-cd>. |
1098 | |
1150 | |
1099 | =item B<keysym.>I<sym>: I<string> |
1151 | =item B<keysym.>I<sym>: I<string> |
1100 | |
1152 | |
1101 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1153 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1102 | intervening resource name B<keysym.> cannot be omitted. |
1154 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
1141 | when Control-Meta-c is being pressed": |
1193 | when Control-Meta-c is being pressed": |
1142 | |
1194 | |
1143 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1195 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1144 | |
1196 | |
1145 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1197 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1146 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1198 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1147 | manpage. For example, the F<selection> extension (activated via |
1199 | manpage. For example, the F<selection> extension (activated via |
1148 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1200 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1149 | |
1201 | |
1150 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1202 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1151 | |
1203 | |
… | |
… | |
1209 | all instances, while B<perl-ext> is used for specific instances. |
1261 | all instances, while B<perl-ext> is used for specific instances. |
1210 | |
1262 | |
1211 | =item B<perl-eval>: I<string> |
1263 | =item B<perl-eval>: I<string> |
1212 | |
1264 | |
1213 | Perl code to be evaluated when all extensions have been registered. See |
1265 | Perl code to be evaluated when all extensions have been registered. See |
1214 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1266 | the @@RXVT_NAME@@perl(3) manpage. |
1215 | will be ignored when running setuid/setgid. |
|
|
1216 | |
1267 | |
1217 | =item B<perl-lib>: I<path> |
1268 | =item B<perl-lib>: I<path> |
1218 | |
1269 | |
1219 | Colon-separated list of additional directories that hold extension |
1270 | Colon-separated list of additional directories that hold extension |
1220 | scripts. When looking for extensions specified by the C<perl> resource, |
1271 | scripts. When looking for extensions specified by the C<perl> resource, |
1221 | @@RXVT_NAME@@ will first look in these directories and then in |
1272 | @@RXVT_NAME@@ will first look in these directories and then in |
1222 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1273 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1223 | will be ignored when running setuid/setgid. |
|
|
1224 | |
1274 | |
1225 | See the @@RXVT_NAME@@perl(3) manpage. |
1275 | See the @@RXVT_NAME@@perl(3) manpage. |
1226 | |
1276 | |
1227 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1277 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1228 | |
1278 | |
… | |
… | |
1250 | |
1300 | |
1251 | =item B<override-redirect>: I<boolean> |
1301 | =item B<override-redirect>: I<boolean> |
1252 | |
1302 | |
1253 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1303 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1254 | it almost invisible to window managers; option B<-override-redirect>. |
1304 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1305 | |
|
|
1306 | =item B<iso14755:> I<boolean> |
|
|
1307 | |
|
|
1308 | Turn on/off ISO 14755 (default enabled). |
1255 | |
1309 | |
1256 | =item B<iso14755_52:> I<boolean> |
1310 | =item B<iso14755_52:> I<boolean> |
1257 | |
1311 | |
1258 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1312 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1259 | |
1313 | |
… | |
… | |
1402 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1456 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1403 | it can be seen via the I<who(1)> command, and can accept messages. To |
1457 | it can be seen via the I<who(1)> command, and can accept messages. To |
1404 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1458 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1405 | on some systems or setgid to root or to some other group on others. |
1459 | on some systems or setgid to root or to some other group on others. |
1406 | |
1460 | |
1407 | =head1 COLORS AND GRAPHICS |
1461 | =head1 COLOURS AND GRAPHICS |
1408 | |
1462 | |
1409 | In addition to the default foreground and background colours, |
1463 | In addition to the default foreground and background colours, |
1410 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1464 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1411 | high-intensity bold/blink versions of the same). Here is a list of the |
1465 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1412 | colours with their names. |
1466 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1467 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1468 | |
|
|
1469 | Here is a list of the ANSI colours with their names. |
1413 | |
1470 | |
1414 | =begin table |
1471 | =begin table |
1415 | |
1472 | |
1416 | B<color0> (black) = Black |
1473 | B<color0> (black) = Black |
1417 | B<color1> (red) = Red3 |
1474 | B<color1> (red) = Red3 |
… | |
… | |
1437 | It is also possible to specify the colour values of B<foreground>, |
1494 | It is also possible to specify the colour values of B<foreground>, |
1438 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1495 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1439 | a number 0-15, as a convenient shorthand to reference the colour name of |
1496 | a number 0-15, as a convenient shorthand to reference the colour name of |
1440 | color0-color15. |
1497 | color0-color15. |
1441 | |
1498 | |
1442 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1499 | The following text gives values for the standard 88 colour mode (and |
1443 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1500 | values for the 256 colour mode in parentheses). |
1444 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1445 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1446 | |
1501 | |
|
|
1502 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1503 | |
|
|
1504 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1505 | index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 |
|
|
1506 | |
|
|
1507 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1508 | steps (1/26 to 25/26 in 1/26 steps). |
|
|
1509 | |
1447 | Together, all those colours implement the 88 colour xterm colours. Only |
1510 | Together, all those colours implement the 88 (256) colour xterm |
1448 | the first 16 can be changed using resources currently, the rest can only |
1511 | colours. Only the first 16 can be changed using resources currently, the |
1449 | be changed via command sequences ("escape codes"). |
1512 | rest can only be changed via command sequences ("escape codes"). |
1450 | |
1513 | |
1451 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1514 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1452 | always swapping the foreground/background colours. This is in contrast to |
1515 | always swapping the foreground/background colours. This is in contrast to |
1453 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1516 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1454 | been specified. For example, |
1517 | been specified. For example, |
1455 | |
1518 | |
1456 | =over 4 |
|
|
1457 | |
|
|
1458 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1519 | @@RXVT_NAME@@ -fg Black -bg White -rv |
1459 | |
1520 | |
1460 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1521 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
1461 | on White. |
1522 | White. |
1462 | |
|
|
1463 | =back |
|
|
1464 | |
1523 | |
1465 | =head2 ALPHA CHANNEL SUPPORT |
1524 | =head2 ALPHA CHANNEL SUPPORT |
1466 | |
1525 | |
1467 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1526 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1468 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1527 | their act together, rxvt-unicode will do it's own alpha channel management: |
1469 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1528 | |
1470 | in addition to the ones provided by X, where the additional A component |
1529 | You can prefix any colour with an opaquenes percentage enclosed in |
|
|
1530 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1531 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
|
|
1532 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1533 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1534 | is the recommended format to specify transparency values, and works with |
|
|
1535 | all ways to specify a colour. |
|
|
1536 | |
|
|
1537 | For complete control, rxvt-unicode also supports |
|
|
1538 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1539 | specifications, where the additional C<aaaa> component specifies opacity |
1471 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1540 | (alpha) values. The minimum value of C<0000> is completely transparent, |
1472 | transparent). You can also prefix any color with C<[percent]>, where |
1541 | while C<ffff> is completely opaque). The two example colours from |
1473 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
1542 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
1474 | the color, where C<0> is completely transparent and C<100> is completelxy |
1543 | C<rgba:0000/ff00/0000/f332>. |
1475 | opaque. |
|
|
1476 | |
1544 | |
1477 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1545 | You probably need to specify B<"-depth 32">, too, to force a visual with |
1478 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1546 | alpha channels, and have the luck that your X-server uses ARGB pixel |
1479 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1547 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1548 | rxvt-unicode just fudges around. |
1480 | |
1549 | |
1481 | For example, the following selects an almost completely transparent red |
1550 | For example, the following selects an almost completely transparent black |
1482 | background, and an almost opaque pink foreground: |
1551 | background, and an almost opaque pink foreground: |
1483 | |
1552 | |
1484 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1553 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
1485 | |
1554 | |
1486 | I<Please note that transparency of any kind if completely unsupported by |
1555 | When not using a background image, then the interpretation of the |
1487 | the author. Don't bug him with installation questions!> |
1556 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1557 | transparency of course). |
|
|
1558 | |
|
|
1559 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1560 | colour will always behave as if it were completely transparent (so the |
|
|
1561 | background image shows instead), regardless of how it was specified, while |
|
|
1562 | other colours will either be transparent as specified (the background |
|
|
1563 | image will show through) on servers supporting the RENDER extension, or |
|
|
1564 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1565 | |
|
|
1566 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1567 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1568 | extension. |
1488 | |
1569 | |
1489 | =head1 ENVIRONMENT |
1570 | =head1 ENVIRONMENT |
1490 | |
1571 | |
1491 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1572 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1492 | |
1573 | |
… | |
… | |
1526 | C<--with-terminfo=PATH>. |
1607 | C<--with-terminfo=PATH>. |
1527 | |
1608 | |
1528 | =item B<DISPLAY> |
1609 | =item B<DISPLAY> |
1529 | |
1610 | |
1530 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1611 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1531 | display in its child processes. |
1612 | display in its child processes if C<-display> isn't used to override. It |
|
|
1613 | defaults to C<:0> if it doesn't exist. |
1532 | |
1614 | |
1533 | =item B<SHELL> |
1615 | =item B<SHELL> |
1534 | |
1616 | |
1535 | The shell to be used for command execution, defaults to C</bin/sh>. |
1617 | The shell to be used for command execution, defaults to C</bin/sh>. |
1536 | |
1618 | |
… | |
… | |
1562 | |
1644 | |
1563 | =over 4 |
1645 | =over 4 |
1564 | |
1646 | |
1565 | =item B</usr/lib/X11/rgb.txt> |
1647 | =item B</usr/lib/X11/rgb.txt> |
1566 | |
1648 | |
1567 | Color names. |
1649 | Colour names. |
1568 | |
1650 | |
1569 | =back |
1651 | =back |
1570 | |
1652 | |
1571 | =head1 SEE ALSO |
1653 | =head1 SEE ALSO |
1572 | |
1654 | |