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.159 by root, Wed Jan 23 14:34:00 2008 UTC vs.
Revision 1.191 by sf-exg, Thu Dec 9 14:19:39 2010 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[;geom[:op1][:op2][...]]>
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 its scaling with a geometry string. 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>
… …
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
… …
449 459
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>.
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>.
454 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
… …
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
… …
715 747
716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
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 its scaling with a geometry string B<WxH+X+Y>,
720(default C<0x0+50+50>) in which B<"W" / "H"> specify the 752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
721horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
722centre (percent). A scale of 0 displays the image with tiling. A scale 754centre (percent). A scale of 0 displays the image with tiling.
723of 1 displays the image without any scaling. A scale of 2 to 9 specifies 755The maximum permitted scale is 1000.
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...>. 756Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are: 757Supported operations are:
728 758
729 tile force background image to be tiled and not scaled. Equivalent to 0x0 759 tile force background image to be tiled and not scaled. Equivalent to 0x0
730 propscale will scale image keeping proportions 760 propscale will scale image keeping proportions
… …
734 scale will scale image to match window size 764 scale will scale image to match window size
735 root will tile image as if it was a root window background, auto-adjusting 765 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves 766 whenever terminal window moves
737 767
738If used in conjunction with B<-tr> option, the specified pixmap will be 768If used in conjunction with B<-tr> option, the specified pixmap will be
739blended over transparency image using either alpha-blending, or any 769blended over the transparent background using alpha-blending. If I<afterimage>
740other blending type, specified with B<-blt "type"> option. 770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
741 772
742=item B<path:> I<path> 773=item B<path:> I<path>
743 774
744Specify the colon-delimited search path for finding background image files. 775Specify the colon-delimited search path for finding background image files.
745 776
… …
772it is named first) and thus defines the character cell grid to be 9 pixels 803it is named first) and thus defines the character cell grid to be 9 pixels
773wide and 15 pixels high. 804wide and 15 pixels high.
774 805
775The second font is just used to add additional unicode characters not in 806The second font is just used to add additional unicode characters not in
776the base font, likewise the third, which is unfortunately non-bold, but 807the 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 808the bold version of the font does contain fewer characters, so this is a
778useful supplement. 809useful supplement.
779 810
780The third font is an Xft font with aliasing turned off, and the characters 811The 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 812are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
782contains other characters, but we are not interested in them. 813contains other characters, but we are not interested in them.
… …
833=item B<urgentOnBell:> I<boolean> 864=item B<urgentOnBell:> I<boolean>
834 865
835B<True>: set the urgency hint for the wm on receipt of a bell character. 866B<True>: set the urgency hint for the wm on receipt of a bell character.
836B<False>: do not set the urgency hint [default]. 867B<False>: do not set the urgency hint [default].
837 868
869@@RXVT_NAME@@ resets the urgency hint on every focus change.
870
838=item B<visualBell:> I<boolean> 871=item B<visualBell:> I<boolean>
839 872
840B<True>: use visual bell on receipt of a bell character; option B<-vb>. 873B<True>: use visual bell on receipt of a bell character; option B<-vb>.
841B<False>: no visual bell [default]; option B<+vb>. 874B<False>: no visual bell [default]; option B<+vb>.
842 875
… …
966=item B<cursorBlink:> I<boolean> 999=item B<cursorBlink:> I<boolean>
967 1000
968B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1001B<True>: blink the cursor. B<False>: do not blink the cursor [default];
969option B<-bc>. 1002option B<-bc>.
970 1003
1004=item B<cursorUnderline:> I<boolean>
1005
1006B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1007option B<-uc>.
1008
971=item B<pointerBlank:> I<boolean> 1009=item B<pointerBlank:> I<boolean>
972 1010
973B<True>: blank the pointer when a key is pressed or after a set number 1011B<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 1012of seconds of inactivity. B<False>: the pointer is always visible
975[default]. 1013[default].
… …
988large number (e.g. C<987654321>) to effectively disable the timeout. 1026large number (e.g. C<987654321>) to effectively disable the timeout.
989 1027
990=item B<backspacekey:> I<string> 1028=item B<backspacekey:> I<string>
991 1029
992The string to send when the backspace key is pressed. If set to B<DEC> 1030The 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> 1031or 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 1032(code 8) - which can be reversed with the appropriate DEC private mode
995escape sequence. 1033escape sequence.
996 1034
997=item B<deletekey:> I<string> 1035=item B<deletekey:> I<string>
998 1036
… …
1077 1115
1078=item B<secondaryScroll:> I<boolean> 1116=item B<secondaryScroll:> I<boolean>
1079 1117
1080Turn on/off secondary screen scroll (default enabled). If this 1118Turn on/off secondary screen scroll (default enabled). If this
1081option is enabled, scrolls on the secondary screen will change the 1119option is enabled, scrolls on the secondary screen will change the
1082scrollback buffer and switching to/from the secondary screen will 1120scrollback buffer and, when secondaryScreen is off, switching
1083instead scroll the screen up. 1121to/from the secondary screen will instead scroll the screen up.
1084 1122
1085=item B<hold>: I<boolean> 1123=item B<hold>: I<boolean>
1086 1124
1087Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1125Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088will not immediately destroy its window when the program executed within 1126will 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 1127it exits. Instead, it will wait till it is being killed or closed by the
1090user. 1128user.
1129
1130=item B<chdir>: I<path>
1131
1132Sets the working directory for the shell (or the command specified via
1133B<-e>). The I<path> must be an absolute path and it must exist for
1134@@RXVT_NAME@@ to start. If it isn't specified then the current working
1135directory will be used; option B<-cd>.
1091 1136
1092=item B<keysym.>I<sym>: I<string> 1137=item B<keysym.>I<sym>: I<string>
1093 1138
1094Compile I<frills>: Associate I<string> with keysym I<sym>. The 1139Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095intervening resource name B<keysym.> cannot be omitted. 1140intervening resource name B<keysym.> cannot be omitted.
… …
1110omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1155omitting 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 1156keysym 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. 1157performed in an exact manner; however, the closest match is assured.
1113 1158
1114I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1115number), see RESOURCES in C<man 7 X> for futher details. 1160number), see RESOURCES in C<man 7 X> for further details.
1116 1161
1117You can define a range of keysyms in one shot by providing a I<string> 1162You can define a range of keysyms in one shot by providing a I<string>
1118with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1119should be a character not used by the strings. 1164should be a character not used by the strings.
1120 1165
… …
1134when Control-Meta-c is being pressed": 1179when Control-Meta-c is being pressed":
1135 1180
1136 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1181 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1137 1182
1138If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1183If 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) 1184is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1140manpage. For example, the F<selection> extension (activated via 1185manpage. For example, the F<selection> extension (activated via
1141C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142 1187
1143 URxvt.keysym.M-C-c: perl:selection:rot13 1188 URxvt.keysym.M-C-c: perl:selection:rot13
1144 1189
1145Due the the large number of modifier combinations, a defined key mapping 1190Due 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 1191will 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 1192no other key mappings with those and more bits are being defined. That
1148means that defining a key map for C<a> will automatically provide 1193means 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 1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1150mappings themselves. 1195mappings themselves.
1151 1196
… …
1202all instances, while B<perl-ext> is used for specific instances. 1247all instances, while B<perl-ext> is used for specific instances.
1203 1248
1204=item B<perl-eval>: I<string> 1249=item B<perl-eval>: I<string>
1205 1250
1206Perl code to be evaluated when all extensions have been registered. See 1251Perl code to be evaluated when all extensions have been registered. See
1207the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1252the @@RXVT_NAME@@perl(3) manpage.
1208will be ignored when running setuid/setgid.
1209 1253
1210=item B<perl-lib>: I<path> 1254=item B<perl-lib>: I<path>
1211 1255
1212Colon-separated list of additional directories that hold extension 1256Colon-separated list of additional directories that hold extension
1213scripts. When looking for extensions specified by the C<perl> resource, 1257scripts. When looking for extensions specified by the C<perl> resource,
1214@@RXVT_NAME@@ will first look in these directories and then in 1258@@RXVT_NAME@@ will first look in these directories and then in
1215F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1259F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216will be ignored when running setuid/setgid.
1217 1260
1218See the @@RXVT_NAME@@perl(3) manpage. 1261See the @@RXVT_NAME@@perl(3) manpage.
1219 1262
1220=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1263=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221 1264
… …
1243 1286
1244=item B<override-redirect>: I<boolean> 1287=item B<override-redirect>: I<boolean>
1245 1288
1246Compile I<frills>: Sets override-redirect for the terminal window, making 1289Compile I<frills>: Sets override-redirect for the terminal window, making
1247it almost invisible to window managers; option B<-override-redirect>. 1290it almost invisible to window managers; option B<-override-redirect>.
1291
1292=item B<iso14755:> I<boolean>
1293
1294Turn on/off ISO 14755 (default enabled).
1248 1295
1249=item B<iso14755_52:> I<boolean> 1296=item B<iso14755_52:> I<boolean>
1250 1297
1251Turn on/off ISO 14755 5.2 mode (default enabled). 1298Turn on/off ISO 14755 5.2 mode (default enabled).
1252 1299
… …
1395B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1442B<@@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 1443it 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 1444allow 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. 1445on some systems or setgid to root or to some other group on others.
1399 1446
1400=head1 COLORS AND GRAPHICS 1447=head1 COLOURS AND GRAPHICS
1401 1448
1402In addition to the default foreground and background colours, 1449In addition to the default foreground and background colours,
1403B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1450B<@@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 1451high-intensity (potentially bold/blink) versions of the same, and 72 (or
1405colours with their names. 1452240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1453cube plus a 8 (24) colour greyscale ramp.
1454
1455Here is a list of the ANSI colours with their names.
1406 1456
1407=begin table 1457=begin table
1408 1458
1409 B<color0> (black) = Black 1459 B<color0> (black) = Black
1410 B<color1> (red) = Red3 1460 B<color1> (red) = Red3
… …
1430It is also possible to specify the colour values of B<foreground>, 1480It is also possible to specify the colour values of B<foreground>,
1431B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1481B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1432a number 0-15, as a convenient shorthand to reference the colour name of 1482a number 0-15, as a convenient shorthand to reference the colour name of
1433color0-color15. 1483color0-color15.
1434 1484
1435In addition to the colours defined above, @@RXVT_NAME@@ offers an 1485The following text gives values for the standard 88 colour mode (and
1436additional 72 colours. The first 64 of those (with indices 16 to 79) 1486values 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 1487
1488The RGB cube uses indices 16..79 (16..231) using the following formulas:
1489
1490 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1491 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1492
1493The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1494steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1495the RGB cube.
1496
1440Together, all those colours implement the 88 colour xterm colours. Only 1497Together, all those colours implement the 88 (256) colour xterm
1441the first 16 can be changed using resources currently, the rest can only 1498colours. Only the first 16 can be changed using resources currently, the
1442be changed via command sequences ("escape codes"). 1499rest can only be changed via command sequences ("escape codes").
1500
1501Applications are advised to use terminfo or command sequences to discover
1502number and RGB values of all colours (yes, you can query this...).
1443 1503
1444Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1504Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445always swapping the foreground/background colours. This is in contrast to 1505always swapping the foreground/background colours. This is in contrast to
1446I<xterm>(1) where the colours are only swapped if they have not otherwise 1506I<xterm>(1) where the colours are only swapped if they have not otherwise
1447been specified. For example, 1507been specified. For example,
1448 1508
1449=over 4
1450
1451=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1509 @@RXVT_NAME@@ -fg Black -bg White -rv
1452 1510
1453would yield White on Black, while on I<xterm>(1) it would yield Black 1511would yield White on Black, while on I<xterm>(1) it would yield Black on
1454on White. 1512White.
1455
1456=back
1457 1513
1458=head2 ALPHA CHANNEL SUPPORT 1514=head2 ALPHA CHANNEL SUPPORT
1459 1515
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1516If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461their act together, rxvt-unicode will do it's own alpha channel management: 1517their act together, rxvt-unicode will do it's own alpha channel management:
1462 1518
1463You can prefix any color with an opaquenes percentage enclosed in 1519You can prefix any colour with an opaqueness percentage enclosed in
1464brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1520brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1465(0-100) that specifies the opacity of the color, where C<0> is completely 1521(0-100) that specifies the opacity of the colour, where C<0> is completely
1466transparent and C<100> is completely opaque. For example, C<[50]red> is a 1522transparent and C<100> is completely opaque. For example, C<[50]red> is a
1467half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1523half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1468is the recommended format to specify transparency values, and works with 1524is the recommended format to specify transparency values, and works with
1469all ways to specify a colour. 1525all ways to specify a colour.
1470 1526
… …
1541C<--with-terminfo=PATH>. 1597C<--with-terminfo=PATH>.
1542 1598
1543=item B<DISPLAY> 1599=item B<DISPLAY>
1544 1600
1545Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1601Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1546display in its child processes. 1602display in its child processes if C<-display> isn't used to override. It
1603defaults to C<:0> if it doesn't exist.
1547 1604
1548=item B<SHELL> 1605=item B<SHELL>
1549 1606
1550The shell to be used for command execution, defaults to C</bin/sh>. 1607The shell to be used for command execution, defaults to C</bin/sh>.
1551 1608
… …
1577 1634
1578=over 4 1635=over 4
1579 1636
1580=item B</usr/lib/X11/rgb.txt> 1637=item B</usr/lib/X11/rgb.txt>
1581 1638
1582Color names. 1639Colour names.
1583 1640
1584=back 1641=back
1585 1642
1586=head1 SEE ALSO 1643=head1 SEE ALSO
1587 1644
… …
1638 1695
1639Project Coordinator (Changes 1.0 -) 1696Project Coordinator (Changes 1.0 -)
1640 1697
1641=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1698=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1642 1699
1643Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1700pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1644 1701
1645=back 1702=back
1646 1703

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines