ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.207 by sf-exg, Tue Nov 22 13:35:10 2011 UTC

92 92
93Print out a message describing available options. 93Print out a message describing available options.
94 94
95=item B<-display> I<displayname> 95=item B<-display> I<displayname>
96 96
97Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
98respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
99B<DISPLAY> environment variable is used. 99display 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
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
106=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
107 112
108Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
109 114
110=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
119 124
120Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
121 126
122=item B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
123 128
124Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
125 130
126B<-ip> is still accepted as an obsolete alias but will be removed in 131B<-ip> is still accepted as an obsolete alias but will be removed in
127future versions. 132future versions.
128
129I<Please address all transparency related issues to Sasha Vasko at
130sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
131 133
132=item B<-fade> I<number> 134=item B<-fade> I<number>
133 135
134Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
135fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
140Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
141is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
142 144
143=item B<-tint> I<colour> 145=item B<-tint> I<colour>
144 146
145Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
146transparency is enabled with B<-tr>. This only works for 148resource I<tintColor>.
147non-tiled backgrounds, currently. See also the B<-sh> option that can be
148used to brighten or darken the image in addition to tinting it.
149Please note that certain tint colours can be applied on the server-side,
150thus yielding performance gain of two orders of magnitude. These colours are:
151blue, red, green, cyan, magenta, yellow, and those close to them. Also
152pure black and pure white colors essentially mean no tinting; resource
153I<tintColor>. Example:
154
155 @@RXVT_NAME@@ -tr -tint blue -sh 40
156 149
157=item B<-sh> I<number> 150=item B<-sh> I<number>
158 151
159Darken (0 .. 100) or lighten (100 .. 200) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
160background image in addition to (or instead of) tinting it; 153A value of 100 means no shading; resource I<shading>.
161resource I<shading>.
162 154
163=item B<-blt> I<string> 155=item B<-blt> I<string>
164 156
165Specify background blending type. If background pixmap is specified 157Specify background blending type. If background pixmap is specified
166at the same time as transparency - such pixmap will be blended over 158at the same time as transparency - such pixmap will be blended over
167transparency image, using method specified. Supported values are : 159the transparent background, using the method specified. Supported values are:
168B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
169B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
172 164
173=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
174 166
175Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
176background image. If single number is specified - both vertical and 168background. If a single number is specified - both vertical and
177horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
178radii to 1 and another to a large number creates interesting effects 170radii to 1 and another to a large number creates interesting effects
179on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 171on some backgrounds. Maximum radius value is 128;
180resource I<blurRadius>. 172resource I<blurRadius>.
181 173
174=item B<-icon> I<file>
175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>.
179
182=item B<-bg> I<colour> 180=item B<-bg> I<colour>
183 181
184Window background colour; resource B<background>. 182Window background colour; resource B<background>.
185 183
186=item B<-fg> I<colour> 184=item B<-fg> I<colour>
187 185
188Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
189 187
190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;oplist]>
191 189
192Compile I<afterimage>: Specify image file for the background and also 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
193optionally specify its scaling with a geometry string. Note you may need to 191optionally specify a list of operations to modify it. Note you may need to
194add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
195command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
196 194
197=item B<-cr> I<colour> 195=item B<-cr> I<colour>
198 196
310 308
311=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
312 310
313Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
314 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
315=item B<-iconic> 317=item B<-iconic>
316 318
317Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
318Alternative form is B<-ic>. 320Alternative form is B<-ic>.
319 321
335 337
336=item B<-bl> 338=item B<-bl>
337 339
338Compile I<frills>: Set MWM hints to request a borderless window, i.e. 340Compile I<frills>: Set MWM hints to request a borderless window, i.e.
339if honoured by the WM, the rxvt-unicode window will not have window 341if honoured by the WM, the rxvt-unicode window will not have window
340decorations; resource B<borderLess>. 342decorations; resource B<borderLess>. If the window manager does not
343support MWM hints (e.g. kwin), enables override-redirect mode.
341 344
342=item B<-override-redirect> 345=item B<-override-redirect>
343 346
344Compile I<frills>: Sets override-redirect on the window; resource 347Compile I<frills>: Sets override-redirect on the window; resource
345B<override-redirect>. 348B<override-redirect>.
354=item B<-lsp> I<number> 357=item B<-lsp> I<number>
355 358
356Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
357the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
358B<lineSpace>. 361B<lineSpace>.
362
363=item B<-letsp> I<number>
364
365Compile I<frills>: Amount to adjust the computed character width by
366to control overall letter spacing. Negative values will tighten up the
367letter spacing, positive values will space letters out more. Useful to
368work around odd font metrics; resource B<letterSpace>.
359 369
360=item B<-tn> I<termname> 370=item B<-tn> I<termname>
361 371
362This option specifies the name of the terminal type to be set in the 372This option specifies the name of the terminal type to be set in the
363B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451will not immediately destroy its window when the program executed within 461will not immediately destroy its window when the program executed within
452it exits. Instead, it will wait till it is being killed or closed by the 462it exits. Instead, it will wait till it is being killed or closed by the
453user; resource B<hold>. 463user; resource B<hold>.
454 464
465=item B<-cd> I<path>
466
467Sets the working directory for the shell (or the command specified via
468B<-e>). The I<path> must be an absolute path and it must exist for
469@@RXVT_NAME@@ to start; resource B<chdir>.
470
455=item B<-xrm> I<string> 471=item B<-xrm> I<string>
456 472
457Works like the X Toolkit option of the same name, by adding the I<string> 473Works like the X Toolkit option of the same name, by adding the I<string>
458as if it were specified in a resource file. Resource values specified this 474as if it were specified in a resource file. Resource values specified this
459way take precedence over all other resource specifications. 475way take precedence over all other resource specifications.
542You can set and change the resources using X11 tools like B<xrdb>. Many 558You can set and change the resources using X11 tools like B<xrdb>. Many
543distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
544starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
545with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
546 562
547 1. system-wide app-defaults file, either locale-dependent OR global
548 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
550 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline 568 6. resources specified via -xrm on the commandline
553 569
554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
555names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
567=item B<depth:> I<bitdepth> 583=item B<depth:> I<bitdepth>
568 584
569Compile I<xft>: Attempt to find a visual with the given bit depth; 585Compile I<xft>: Attempt to find a visual with the given bit depth;
570option B<-depth>. 586option B<-depth>.
571 587
588=item B<buffered:> I<boolean>
589
590Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
591On some card/driver combination enabling it slightly decreases
592performance, on most it greatly helps it. The slowdown is small, so it
593should normally be enabled.
594
572=item B<geometry:> I<geom> 595=item B<geometry:> I<geom>
573 596
574Create the window with the specified X window geometry [default 80x24]; 597Create the window with the specified X window geometry [default 80x24];
575option B<-geometry>. 598option B<-geometry>.
576 599
589Use the specified colour for the colour value I<n>, where 0-7 612Use the specified colour for the colour value I<n>, where 0-7
590corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
591high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
592colours. The canonical names are as follows: 0=black, 1=red, 2=green, 615colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5933=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6163=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
594names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
595 618
596Colours higher than 15 cannot be set using resources (yet), but can be 619Colours higher than 15 cannot be set using resources (yet), but can be
597changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
598 621
599Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 622Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
610=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
611 634
612Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
613foreground colour is the default. 636foreground colour is the default.
614 637
615=item B<colorRV:> I<colour>
616
617Use the specified colour as the background for reverse video characters
618when OPTION_HC is disabled (--disable-frills).
619
620=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
621 639
622If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
623itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
642
643=item B<highlightColor:> I<colour>
644
645If set, use the specified colour as the background for highlighted
646characters. If unset, use reverse video.
647
648=item B<highlightTextColor:> I<colour>
649
650If set and highlightColor is set, use the specified colour as the
651foreground for highlighted characters.
624 652
625=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
626 654
627Use the specified colour for the cursor. The default is to use the 655Use the specified colour for the cursor. The default is to use the
628foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
635 663
636=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
637 665
638B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
639option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
640B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641 669
642=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
643 671
644B<True>: specify that jump scrolling should be used. When receiving lots 672B<True>: specify that jump scrolling should be used. When receiving lots
645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
661if the refresh is too fast for the human eye to read anything (or the 689if the refresh is too fast for the human eye to read anything (or the
662monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
663 691
664=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
665 693
666Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
667 695
668B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669future versions. 697future versions.
670 698
671I<Please address all transparency related issues to Sasha Vasko at
672sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
673
674=item B<fading:> I<number> 699=item B<fading:> I<number>
675 700
676Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
677 702
678=item B<fadeColor:> I<colour> 703=item B<fadeColor:> I<colour>
680Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
681colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
682 707
683=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
684 709
685Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
686B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
687 715
688=item B<shading:> I<number> 716=item B<shading:> I<number>
689 717
690Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
691in addition to tinting it; option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
692 720
693=item B<blendType:> I<string> 721=item B<blendType:> I<string>
694 722
695Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
696 724
697=item B<blurRadius:> I<number> 725=item B<blurRadius:> I<number>
698 726
699Apply Gaussian Blurr with the specified radius to the transparent 727Apply gaussian blur with the specified radius to the transparent
700background image; option B<-blr>. 728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
701 733
702=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
703 735
704Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
705 737
711=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
712 744
713The colour of the border around the text area and between the scrollbar 745The colour of the border around the text area and between the scrollbar
714and the text. 746and the text.
715 747
716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;oplist]>
717 749
718Use the specified image file for the background and also 750Use the specified image file for the background and also
719optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify a colon separated list of operations to modify it.
720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
721horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
722centre (percent). A scale of 0 displays the image with tiling. A scale
723of 1 displays the image without any scaling. A scale of 2 to 9 specifies
724an integer number of images in that direction. No image will be magnified
725beyond 10 times its original size. The maximum permitted scale is 1000.
726Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are: 752Supported operations are:
728 753
729 tile force background image to be tiled and not scaled. Equivalent to 0x0 754=over 4
730 propscale will scale image keeping proportions 755
731 auto will scale image to match window size. Equivalent to 100x100 756=item B<WxH+X+Y>
732 hscale will scale image horizontally to the window size 757
733 vscale will scale image vertically to the window size 758sets scale and position. B<"W" / "H"> specify the horizontal/vertical
734 scale will scale image to match window size 759scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
735 root will tile image as if it was a root window background, auto-adjusting 760scale of 0 disables scaling. The maximum permitted scale is 1000.
736 whenever terminal window moves 761
762=item B<op=tile>
763
764enables tiling
765
766=item B<op=pscale>
767
768enables proportional scaling
769
770=item B<op=root>
771
772use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background
774
775=back
776
777The default scale and position setting is C<100x100+50+50>.
778Alternatively, a predefined set of templates can be used to achieve
779the most common setups:
780
781=over 4
782
783=item B<style=tiled>
784
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786
787=item B<style=aspect-stretched>
788
789the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=pscale
791
792=item B<style=stretched>
793
794the image is scaled to fill the whole window. Equivalent to 100x100
795
796=item B<style=centered>
797
798the image is centered with no scaling. Equivalent to 0x0+50+50
799
800=item B<style=root-tiled>
801
802the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root
804
805=back
806
807If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings.
737 809
738If used in conjunction with B<-tr> option, the specified pixmap will be 810If used in conjunction with B<-tr> option, the specified pixmap will be
739blended over transparency image using either alpha-blending, or any 811blended over the transparent background using alpha-blending. If I<afterimage>
740other blending type, specified with B<-blt "type"> option. 812support has been compiled in it is possible to choose other blending
813types with B<-blt "type"> option.
741 814
742=item B<path:> I<path> 815=item B<path:> I<path>
743 816
744Specify the colon-delimited search path for finding background image files. 817Specify the colon-delimited search path for finding background image files.
745 818
772it is named first) and thus defines the character cell grid to be 9 pixels 845it is named first) and thus defines the character cell grid to be 9 pixels
773wide and 15 pixels high. 846wide and 15 pixels high.
774 847
775The second font is just used to add additional unicode characters not in 848The second font is just used to add additional unicode characters not in
776the base font, likewise the third, which is unfortunately non-bold, but 849the base font, likewise the third, which is unfortunately non-bold, but
777the bold version of the font does contain less characters, so this is a 850the bold version of the font does contain fewer characters, so this is a
778useful supplement. 851useful supplement.
779 852
780The third font is an Xft font with aliasing turned off, and the characters 853The third font is an Xft font with aliasing turned off, and the characters
781are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 854are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
782contains other characters, but we are not interested in them. 855contains other characters, but we are not interested in them.
833=item B<urgentOnBell:> I<boolean> 906=item B<urgentOnBell:> I<boolean>
834 907
835B<True>: set the urgency hint for the wm on receipt of a bell character. 908B<True>: set the urgency hint for the wm on receipt of a bell character.
836B<False>: do not set the urgency hint [default]. 909B<False>: do not set the urgency hint [default].
837 910
911@@RXVT_NAME@@ resets the urgency hint on every focus change.
912
838=item B<visualBell:> I<boolean> 913=item B<visualBell:> I<boolean>
839 914
840B<True>: use visual bell on receipt of a bell character; option B<-vb>. 915B<True>: use visual bell on receipt of a bell character; option B<-vb>.
841B<False>: no visual bell [default]; option B<+vb>. 916B<False>: no visual bell [default]; option B<+vb>.
842 917
870=item B<scrollstyle:> I<mode> 945=item B<scrollstyle:> I<mode>
871 946
872Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 947Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
873the author's favourite. 948the author's favourite.
874 949
950=item B<thickness:> I<number>
951
952Set the scrollbar width in pixels.
953
875=item B<scrollBar:> I<boolean> 954=item B<scrollBar:> I<boolean>
876 955
877B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 956B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878disable the scrollbar; option B<+sb>. 957disable the scrollbar; option B<+sb>.
879 958
898B<False>: do not scroll to bottom when tty receives output; option 977B<False>: do not scroll to bottom when tty receives output; option
899B<+si>. 978B<+si>.
900 979
901=item B<scrollWithBuffer:> I<boolean> 980=item B<scrollWithBuffer:> I<boolean>
902 981
903B<True>: scroll with scrollback buffer when tty receives new lines (and 982B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
904B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 983try to show the same lines) and B<scrollTtyOutput> is False; option
905with scrollback buffer when tty receives new lines; option B<+sw>. 984B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
985new lines; option B<+sw>.
906 986
907=item B<scrollTtyKeypress:> I<boolean> 987=item B<scrollTtyKeypress:> I<boolean>
908 988
909B<True>: scroll to bottom when a non-special key is pressed. Special keys 989B<True>: scroll to bottom when a non-special key is pressed. Special keys
910are those which are intercepted by rxvt-unicode for special handling and 990are those which are intercepted by rxvt-unicode for special handling and
966=item B<cursorBlink:> I<boolean> 1046=item B<cursorBlink:> I<boolean>
967 1047
968B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1048B<True>: blink the cursor. B<False>: do not blink the cursor [default];
969option B<-bc>. 1049option B<-bc>.
970 1050
1051=item B<cursorUnderline:> I<boolean>
1052
1053B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1054option B<-uc>.
1055
971=item B<pointerBlank:> I<boolean> 1056=item B<pointerBlank:> I<boolean>
972 1057
973B<True>: blank the pointer when a key is pressed or after a set number 1058B<True>: blank the pointer when a key is pressed or after a set number
974of seconds of inactivity. B<False>: the pointer is always visible 1059of seconds of inactivity. B<False>: the pointer is always visible
975[default]. 1060[default].
988large number (e.g. C<987654321>) to effectively disable the timeout. 1073large number (e.g. C<987654321>) to effectively disable the timeout.
989 1074
990=item B<backspacekey:> I<string> 1075=item B<backspacekey:> I<string>
991 1076
992The string to send when the backspace key is pressed. If set to B<DEC> 1077The string to send when the backspace key is pressed. If set to B<DEC>
993or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1078or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
994(code 8) - which can be reversed with the appropriate DEC private mode 1079(code 8) - which can be reversed with the appropriate DEC private mode
995escape sequence. 1080escape sequence.
996 1081
997=item B<deletekey:> I<string> 1082=item B<deletekey:> I<string>
998 1083
1077 1162
1078=item B<secondaryScroll:> I<boolean> 1163=item B<secondaryScroll:> I<boolean>
1079 1164
1080Turn on/off secondary screen scroll (default enabled). If this 1165Turn on/off secondary screen scroll (default enabled). If this
1081option is enabled, scrolls on the secondary screen will change the 1166option is enabled, scrolls on the secondary screen will change the
1082scrollback buffer and switching to/from the secondary screen will 1167scrollback buffer and, when secondaryScreen is off, switching
1083instead scroll the screen up. 1168to/from the secondary screen will instead scroll the screen up.
1084 1169
1085=item B<hold>: I<boolean> 1170=item B<hold>: I<boolean>
1086 1171
1087Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1172Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088will not immediately destroy its window when the program executed within 1173will not immediately destroy its window when the program executed within
1089it exits. Instead, it will wait till it is being killed or closed by the 1174it exits. Instead, it will wait till it is being killed or closed by the
1090user. 1175user.
1176
1177=item B<chdir>: I<path>
1178
1179Sets the working directory for the shell (or the command specified via
1180B<-e>). The I<path> must be an absolute path and it must exist for
1181@@RXVT_NAME@@ to start. If it isn't specified then the current working
1182directory will be used; option B<-cd>.
1091 1183
1092=item B<keysym.>I<sym>: I<string> 1184=item B<keysym.>I<sym>: I<string>
1093 1185
1094Compile I<frills>: Associate I<string> with keysym I<sym>. The 1186Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095intervening resource name B<keysym.> cannot be omitted. 1187intervening resource name B<keysym.> cannot be omitted.
1110omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1202omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1111keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1203keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1112performed in an exact manner; however, the closest match is assured. 1204performed in an exact manner; however, the closest match is assured.
1113 1205
1114I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1115number), see RESOURCES in C<man 7 X> for futher details. 1207number), see RESOURCES in C<man 7 X> for further details.
1116 1208
1117You can define a range of keysyms in one shot by providing a I<string> 1209You can define a range of keysyms in one shot by providing a I<string>
1118with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1210with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1119should be a character not used by the strings. 1211should be a character not used by the strings.
1120 1212
1121Its usage can be demonstrated by an example: 1213Its usage can be demonstrated by an example:
1122 1214
1123 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1215 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1124 1216
1125The above line is equivalent to the following three lines: 1217The above line is equivalent to the following three lines:
1126 1218
1127 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1219 URxvt.keysym.Meta-Control-0x61: \033<a>
1128 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1220 URxvt.keysym.Meta-Control-0x62: \033<b>
1129 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1221 URxvt.keysym.Meta-Control-0x63: \033<c>
1130 1222
1131If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1223If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1132is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1224is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1133example the following means "change the current locale to C<zh_CN.GBK> 1225example the following means "change the current locale to C<zh_CN.GBK>
1134when Control-Meta-c is being pressed": 1226when Control-Meta-c is being pressed":
1135 1227
1136 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1228 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1137 1229
1138If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1230If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1139is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1231is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1140manpage. For example, the F<selection> extension (activated via 1232manpage. For example, the F<selection> extension (activated via
1141C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1233C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142 1234
1143 URxvt.keysym.M-C-c: perl:selection:rot13 1235 URxvt.keysym.M-C-c: perl:selection:rot13
1144 1236
1145Due the the large number of modifier combinations, a defined key mapping 1237Due the the large number of modifier combinations, a defined key mapping
1146will match if at I<at least> the specified identifiers are being set, and 1238will match if I<at least> the specified identifiers are being set, and
1147no other key mappings with those and more bits are being defined. That 1239no other key mappings with those and more bits are being defined. That
1148means that defining a key map for C<a> will automatically provide 1240means that defining a key map for C<a> will automatically provide
1149definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1241definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1150mappings themselves. 1242mappings themselves.
1151 1243
1202all instances, while B<perl-ext> is used for specific instances. 1294all instances, while B<perl-ext> is used for specific instances.
1203 1295
1204=item B<perl-eval>: I<string> 1296=item B<perl-eval>: I<string>
1205 1297
1206Perl code to be evaluated when all extensions have been registered. See 1298Perl code to be evaluated when all extensions have been registered. See
1207the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1299the @@RXVT_NAME@@perl(3) manpage.
1208will be ignored when running setuid/setgid.
1209 1300
1210=item B<perl-lib>: I<path> 1301=item B<perl-lib>: I<path>
1211 1302
1212Colon-separated list of additional directories that hold extension 1303Colon-separated list of additional directories that hold extension
1213scripts. When looking for extensions specified by the C<perl> resource, 1304scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1214@@RXVT_NAME@@ will first look in these directories and then in 1305look in these directories, then in $HOME/.urxvt/ext and lastly in
1215F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1306F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216will be ignored when running setuid/setgid.
1217 1307
1218See the @@RXVT_NAME@@perl(3) manpage. 1308See the @@RXVT_NAME@@perl(3) manpage.
1219 1309
1220=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1310=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221 1311
1243 1333
1244=item B<override-redirect>: I<boolean> 1334=item B<override-redirect>: I<boolean>
1245 1335
1246Compile I<frills>: Sets override-redirect for the terminal window, making 1336Compile I<frills>: Sets override-redirect for the terminal window, making
1247it almost invisible to window managers; option B<-override-redirect>. 1337it almost invisible to window managers; option B<-override-redirect>.
1338
1339=item B<iso14755:> I<boolean>
1340
1341Turn on/off ISO 14755 (default enabled).
1248 1342
1249=item B<iso14755_52:> I<boolean> 1343=item B<iso14755_52:> I<boolean>
1250 1344
1251Turn on/off ISO 14755 5.2 mode (default enabled). 1345Turn on/off ISO 14755 5.2 mode (default enabled).
1252 1346
1395B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1489B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1396it can be seen via the I<who(1)> command, and can accept messages. To 1490it can be seen via the I<who(1)> command, and can accept messages. To
1397allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1491allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1398on some systems or setgid to root or to some other group on others. 1492on some systems or setgid to root or to some other group on others.
1399 1493
1400=head1 COLORS AND GRAPHICS 1494=head1 COLOURS AND GRAPHICS
1401 1495
1402In addition to the default foreground and background colours, 1496In addition to the default foreground and background colours,
1403B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1497B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1404high-intensity bold/blink versions of the same). Here is a list of the 1498high-intensity (potentially bold/blink) versions of the same, and 72 (or
1405colours with their names. 1499240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1500cube plus a 8 (24) colour greyscale ramp.
1501
1502Here is a list of the ANSI colours with their names.
1406 1503
1407=begin table 1504=begin table
1408 1505
1409 B<color0> (black) = Black 1506 B<color0> (black) = Black
1410 B<color1> (red) = Red3 1507 B<color1> (red) = Red3
1430It is also possible to specify the colour values of B<foreground>, 1527It is also possible to specify the colour values of B<foreground>,
1431B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1528B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1432a number 0-15, as a convenient shorthand to reference the colour name of 1529a number 0-15, as a convenient shorthand to reference the colour name of
1433color0-color15. 1530color0-color15.
1434 1531
1435In addition to the colours defined above, @@RXVT_NAME@@ offers an 1532The following text gives values for the standard 88 colour mode (and
1436additional 72 colours. The first 64 of those (with indices 16 to 79) 1533values for the 256 colour mode in parentheses).
1437consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
143816>), followed by 8 additional shades of gray (with indices 80 to 87).
1439 1534
1535The RGB cube uses indices 16..79 (16..231) using the following formulas:
1536
1537 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1538 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1539
1540The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1541steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1542the RGB cube.
1543
1440Together, all those colours implement the 88 colour xterm colours. Only 1544Together, all those colours implement the 88 (256) colour xterm
1441the first 16 can be changed using resources currently, the rest can only 1545colours. Only the first 16 can be changed using resources currently, the
1442be changed via command sequences ("escape codes"). 1546rest can only be changed via command sequences ("escape codes").
1547
1548Applications are advised to use terminfo or command sequences to discover
1549number and RGB values of all colours (yes, you can query this...).
1443 1550
1444Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1551Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445always swapping the foreground/background colours. This is in contrast to 1552always swapping the foreground/background colours. This is in contrast to
1446I<xterm>(1) where the colours are only swapped if they have not otherwise 1553I<xterm>(1) where the colours are only swapped if they have not otherwise
1447been specified. For example, 1554been specified. For example,
1448 1555
1449=over 4
1450
1451=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1556 @@RXVT_NAME@@ -fg Black -bg White -rv
1452 1557
1453would yield White on Black, while on I<xterm>(1) it would yield Black 1558would yield White on Black, while on I<xterm>(1) it would yield Black on
1454on White. 1559White.
1455
1456=back
1457 1560
1458=head2 ALPHA CHANNEL SUPPORT 1561=head2 ALPHA CHANNEL SUPPORT
1459 1562
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1563If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1564their act together, rxvt-unicode will do it's own alpha channel management:
1462(recommended, but B<MUST> have 4 digits/component) colour specifications, 1565
1463in addition to the ones provided by X, where the additional A component 1566You can prefix any colour with an opaqueness percentage enclosed in
1567brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1568(0-100) that specifies the opacity of the colour, where C<0> is completely
1569transparent and C<100> is completely opaque. For example, C<[50]red> is a
1570half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1571is the recommended format to specify transparency values, and works with
1572all ways to specify a colour.
1573
1574For complete control, rxvt-unicode also supports
1575C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1576specifications, where the additional C<aaaa> component specifies opacity
1464specifies opacity (alpha) values. The minimum value of C<0> is completely 1577(alpha) values. The minimum value of C<0000> is completely transparent,
1465transparent). You can also prefix any color with C<[percent]>, where 1578while C<ffff> is completely opaque). The two example colours from
1466C<percent> is a decimal percentage (0-100) that specifies the opacity of 1579earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1467the color, where C<0> is completely transparent and C<100> is completelxy 1580C<rgba:0000/ff00/0000/f332>.
1468opaque.
1469 1581
1470You probably need to specify B<"-depth 32">, too, and have the luck that 1582You probably need to specify B<"-depth 32">, too, to force a visual with
1471your X-server uses ARGB pixel layout, as X is far from just supporting 1583alpha channels, and have the luck that your X-server uses ARGB pixel
1472ARGB visuals out of the box, and rxvt-unicode just fudges around. 1584layout, as X is far from just supporting ARGB visuals out of the box, and
1585rxvt-unicode just fudges around.
1473 1586
1474For example, the following selects an almost completely transparent red 1587For example, the following selects an almost completely transparent black
1475background, and an almost opaque pink foreground: 1588background, and an almost opaque pink foreground:
1476 1589
1477 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1590 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478 1591
1479I<Please note that transparency of any kind if completely unsupported by 1592When not using a background image, then the interpretation of the
1480the author. Don't bug him with installation questions!> 1593alpha channel is up to your compositing manager (most interpret it as
1594transparency of course).
1595
1596When using a background pixmap or pseudo-transparency, then the background
1597colour will always behave as if it were completely transparent (so the
1598background image shows instead), regardless of how it was specified, while
1599other colours will either be transparent as specified (the background
1600image will show through) on servers supporting the RENDER extension, or
1601fully opaque on servers not supporting the RENDER EXTENSION.
1602
1603Please note that due to bugs in Xft, specifying alpha values might result
1604in garbage being displayed when the X-server does not support the RENDER
1605extension.
1481 1606
1482=head1 ENVIRONMENT 1607=head1 ENVIRONMENT
1483 1608
1484B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1609B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485 1610
1519C<--with-terminfo=PATH>. 1644C<--with-terminfo=PATH>.
1520 1645
1521=item B<DISPLAY> 1646=item B<DISPLAY>
1522 1647
1523Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1648Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1524display in its child processes. 1649display in its child processes if C<-display> isn't used to override. It
1650defaults to C<:0> if it doesn't exist.
1525 1651
1526=item B<SHELL> 1652=item B<SHELL>
1527 1653
1528The shell to be used for command execution, defaults to C</bin/sh>. 1654The shell to be used for command execution, defaults to C</bin/sh>.
1529 1655
1530=item B<RXVT_SOCKET> 1656=item B<RXVT_SOCKET>
1531 1657
1532The unix domain socket path used by @@RXVT_NAME@@c(1) and 1658The unix domain socket path used by @@RXVT_NAME@@c(1) and
1533@@RXVT_NAME@@d(1). 1659@@RXVT_NAME@@d(1).
1534 1660
1535Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1661Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1536 1662
1537=item B<HOME> 1663=item B<HOME>
1538 1664
1539Used to locate the default directory for the unix domain socket for 1665Used to locate the default directory for the unix domain socket for
1540daemon communications and to locate various resource files (such as 1666daemon communications and to locate various resource files (such as
1541C<.Xdefaults>) 1667C<.Xdefaults>)
1542 1668
1543=item B<XAPPLRESDIR> 1669=item B<XAPPLRESDIR>
1544 1670
1545Directory where various X resource files are being located. 1671Directory where application-specific X resource files are located.
1546 1672
1547=item B<XENVIRONMENT> 1673=item B<XENVIRONMENT>
1548 1674
1549If set and accessible, gives the name of a X resource file to be loaded by 1675If set and accessible, gives the name of a X resource file to be loaded by
1550@@RXVT_NAME@@. 1676@@RXVT_NAME@@.
1555 1681
1556=over 4 1682=over 4
1557 1683
1558=item B</usr/lib/X11/rgb.txt> 1684=item B</usr/lib/X11/rgb.txt>
1559 1685
1560Color names. 1686Colour names.
1561 1687
1562=back 1688=back
1563 1689
1564=head1 SEE ALSO 1690=head1 SEE ALSO
1565 1691
1616 1742
1617Project Coordinator (Changes 1.0 -) 1743Project Coordinator (Changes 1.0 -)
1618 1744
1619=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1745=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1620 1746
1621Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1747pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1622 1748
1623=back 1749=back
1624 1750

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines