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.164 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.204 by sf-exg, Sun Aug 14 22:01:25 2011 UTC

124 124
125Turn 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>.
126 126
127=item B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
128 128
129Turn 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>.
130 130
131B<-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
132future versions. 132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 133
137=item B<-fade> I<number> 134=item B<-fade> I<number>
138 135
139Fade 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
140fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
145Fade 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
146is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
147 144
148=item B<-tint> I<colour> 145=item B<-tint> I<colour>
149 146
150Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
151transparency is enabled with B<-tr>. This only works for 148resource I<tintColor>.
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161 149
162=item B<-sh> I<number> 150=item B<-sh> I<number>
163 151
164Darken (0 .. 100) or lighten (100 .. 200) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165background image in addition to (or instead of) tinting it; 153A value of 100 means no shading; resource I<shading>.
166resource I<shading>.
167 154
168=item B<-blt> I<string> 155=item B<-blt> I<string>
169 156
170Specify background blending type. If background pixmap is specified 157Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over 158at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are : 159the transparent background, using the method specified. Supported values are:
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<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
176alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 164
178=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
179 166
180Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 168background. If a single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 170radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 171on some backgrounds. Maximum radius value is 128;
185resource I<blurRadius>. 172resource I<blurRadius>.
186 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
187=item B<-bg> I<colour> 180=item B<-bg> I<colour>
188 181
189Window background colour; resource B<background>. 182Window background colour; resource B<background>.
190 183
191=item B<-fg> I<colour> 184=item B<-fg> I<colour>
192 185
193Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
194 187
195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;oplist]>
196 189
197Compile I<afterimage>: Specify image file for the background and also 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
198optionally 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
199add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
200command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
201 194
202=item B<-cr> I<colour> 195=item B<-cr> I<colour>
203 196
315 308
316=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
317 310
318Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
319 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
320=item B<-iconic> 317=item B<-iconic>
321 318
322Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 320Alternative form is B<-ic>.
324 321
340 337
341=item B<-bl> 338=item B<-bl>
342 339
343Compile 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.
344if 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
345decorations; resource B<borderLess>. 342decorations; resource B<borderLess>. If the window manager does not
343support MWM hints (e.g. kwin), enables override-redirect mode.
346 344
347=item B<-override-redirect> 345=item B<-override-redirect>
348 346
349Compile I<frills>: Sets override-redirect on the window; resource 347Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 348B<override-redirect>.
359=item B<-lsp> I<number> 357=item B<-lsp> I<number>
360 358
361Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
363B<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>.
364 369
365=item B<-tn> I<termname> 370=item B<-tn> I<termname>
366 371
367This 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
368B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
553You 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
554distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
555starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
556with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
557 562
558 1. system-wide app-defaults file, either locale-dependent OR global
559 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
560 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
561 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
562 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
563 6. resources specified via -xrm on the commandline 568 6. resources specified via -xrm on the commandline
564 569
565Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
566names: 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
607Use 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
608corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
609high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
610colours. 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,
6113=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
612names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
613 618
614Colours 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
615changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
616 621
617Colours 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
628=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
629 634
630Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
631foreground colour is the default. 636foreground colour is the default.
632 637
633=item B<colorRV:> I<colour>
634
635Use the specified colour as the background for reverse video characters
636when OPTION_HC is disabled (--disable-frills).
637
638=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
639 639
640If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
641itself. 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.
642 652
643=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
644 654
645Use 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
646foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
653 663
654=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
655 665
656B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
657option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
658B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
659 669
660=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
661 671
662B<True>: specify that jump scrolling should be used. When receiving lots 672B<True>: specify that jump scrolling should be used. When receiving lots
663of 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
679if 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
680monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
681 691
682=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
683 693
684Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
685 695
686B<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
687future versions. 697future versions.
688 698
689I<Please address all transparency related issues to Sasha Vasko at
690sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
691
692=item B<fading:> I<number> 699=item B<fading:> I<number>
693 700
694Fade 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>.
695 702
696=item B<fadeColor:> I<colour> 703=item B<fadeColor:> I<colour>
698Fade 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
699colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
700 707
701=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
702 709
703Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
704B<-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>.
705 715
706=item B<shading:> I<number> 716=item B<shading:> I<number>
707 717
708Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
709in addition to tinting it; option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
710 720
711=item B<blendType:> I<string> 721=item B<blendType:> I<string>
712 722
713Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
714 724
715=item B<blurRadius:> I<number> 725=item B<blurRadius:> I<number>
716 726
717Apply Gaussian Blurr with the specified radius to the transparent 727Apply gaussian blur with the specified radius to the transparent
718background image; option B<-blr>. 728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
719 733
720=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
721 735
722Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
723 737
729=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
730 744
731The 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
732and the text. 746and the text.
733 747
734=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;oplist]>
735 749
736Use the specified image file for the background and also 750Use the specified image file for the background and also
737optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify a colon separated list of operations to modify it.
738(default C<0x0+50+50>) in which B<"W" / "H"> specify the
739horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
740centre (percent). A scale of 0 displays the image with tiling. A scale
741of 1 displays the image without any scaling. A scale of 2 to 9 specifies
742an integer number of images in that direction. No image will be magnified
743beyond 10 times its original size. The maximum permitted scale is 1000.
744Additional operations can be specified after colon B<:op1:op2...>.
745Supported operations are: 752Supported operations are:
746 753
747 tile force background image to be tiled and not scaled. Equivalent to 0x0 754 B<WxH+X+Y> sets scale and position. B<"W" / "H"> specify the
748 propscale will scale image keeping proportions 755 horizontal/vertical scale (percent), and B<"X" / "Y">
749 auto will scale image to match window size. Equivalent to 100x100 756 locate the image centre (percent). A scale of 0 disables
750 hscale will scale image horizontally to the window size 757 scaling. The maximum permitted scale is 1000.
751 vscale will scale image vertically to the window size 758 op=tile enables tiling
752 scale will scale image to match window size 759 op=pscale enables proportional scaling
753 root will tile image as if it was a root window background, auto-adjusting 760 op=root use the position of the terminal window relative to the root
754 whenever terminal window moves 761 window as the image offset, simulating a root window background
762
763The default scale and position setting is C<100x100+50+50>.
764Alternatively, a predefined set of templates can be used to achieve
765the most common setups:
766
767 style=tiled the image is tiled with no scaling
768 style=aspect-stretched the image is scaled to fill the whole window maintaining
769 the aspect ratio and centered
770 style=stretched the image is scaled to fill the whole window
771 style=centered the image is centered with no scaling
772 style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
773
774If multiple templates are specified the last one wins. Note that a
775template overrides all the scale, position and operations settings.
776Indeed, the templates can be specified in terms of low level settings
777as follows:
778
779 style=tiled 0x0+0+0:op=tile
780 style=aspect-stretched 100x100+50+50:op=pscale
781 style=stretched 100x100
782 style=centered 0x0+50+50
783 style=root-tiled 0x0:op=tile:op=root
755 784
756If used in conjunction with B<-tr> option, the specified pixmap will be 785If used in conjunction with B<-tr> option, the specified pixmap will be
757blended over transparency image using either alpha-blending, or any 786blended over the transparent background using alpha-blending. If I<afterimage>
758other blending type, specified with B<-blt "type"> option. 787support has been compiled in it is possible to choose other blending
788types with B<-blt "type"> option.
759 789
760=item B<path:> I<path> 790=item B<path:> I<path>
761 791
762Specify the colon-delimited search path for finding background image files. 792Specify the colon-delimited search path for finding background image files.
763 793
790it is named first) and thus defines the character cell grid to be 9 pixels 820it is named first) and thus defines the character cell grid to be 9 pixels
791wide and 15 pixels high. 821wide and 15 pixels high.
792 822
793The second font is just used to add additional unicode characters not in 823The second font is just used to add additional unicode characters not in
794the base font, likewise the third, which is unfortunately non-bold, but 824the base font, likewise the third, which is unfortunately non-bold, but
795the bold version of the font does contain less characters, so this is a 825the bold version of the font does contain fewer characters, so this is a
796useful supplement. 826useful supplement.
797 827
798The third font is an Xft font with aliasing turned off, and the characters 828The third font is an Xft font with aliasing turned off, and the characters
799are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 829are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
800contains other characters, but we are not interested in them. 830contains other characters, but we are not interested in them.
851=item B<urgentOnBell:> I<boolean> 881=item B<urgentOnBell:> I<boolean>
852 882
853B<True>: set the urgency hint for the wm on receipt of a bell character. 883B<True>: set the urgency hint for the wm on receipt of a bell character.
854B<False>: do not set the urgency hint [default]. 884B<False>: do not set the urgency hint [default].
855 885
886@@RXVT_NAME@@ resets the urgency hint on every focus change.
887
856=item B<visualBell:> I<boolean> 888=item B<visualBell:> I<boolean>
857 889
858B<True>: use visual bell on receipt of a bell character; option B<-vb>. 890B<True>: use visual bell on receipt of a bell character; option B<-vb>.
859B<False>: no visual bell [default]; option B<+vb>. 891B<False>: no visual bell [default]; option B<+vb>.
860 892
888=item B<scrollstyle:> I<mode> 920=item B<scrollstyle:> I<mode>
889 921
890Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 922Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
891the author's favourite. 923the author's favourite.
892 924
925=item B<thickness:> I<number>
926
927Set the scrollbar width in pixels.
928
893=item B<scrollBar:> I<boolean> 929=item B<scrollBar:> I<boolean>
894 930
895B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 931B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
896disable the scrollbar; option B<+sb>. 932disable the scrollbar; option B<+sb>.
897 933
916B<False>: do not scroll to bottom when tty receives output; option 952B<False>: do not scroll to bottom when tty receives output; option
917B<+si>. 953B<+si>.
918 954
919=item B<scrollWithBuffer:> I<boolean> 955=item B<scrollWithBuffer:> I<boolean>
920 956
921B<True>: scroll with scrollback buffer when tty receives new lines (and 957B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
922B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 958try to show the same lines) and B<scrollTtyOutput> is False; option
923with scrollback buffer when tty receives new lines; option B<+sw>. 959B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
960new lines; option B<+sw>.
924 961
925=item B<scrollTtyKeypress:> I<boolean> 962=item B<scrollTtyKeypress:> I<boolean>
926 963
927B<True>: scroll to bottom when a non-special key is pressed. Special keys 964B<True>: scroll to bottom when a non-special key is pressed. Special keys
928are those which are intercepted by rxvt-unicode for special handling and 965are those which are intercepted by rxvt-unicode for special handling and
984=item B<cursorBlink:> I<boolean> 1021=item B<cursorBlink:> I<boolean>
985 1022
986B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1023B<True>: blink the cursor. B<False>: do not blink the cursor [default];
987option B<-bc>. 1024option B<-bc>.
988 1025
1026=item B<cursorUnderline:> I<boolean>
1027
1028B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1029option B<-uc>.
1030
989=item B<pointerBlank:> I<boolean> 1031=item B<pointerBlank:> I<boolean>
990 1032
991B<True>: blank the pointer when a key is pressed or after a set number 1033B<True>: blank the pointer when a key is pressed or after a set number
992of seconds of inactivity. B<False>: the pointer is always visible 1034of seconds of inactivity. B<False>: the pointer is always visible
993[default]. 1035[default].
1006large number (e.g. C<987654321>) to effectively disable the timeout. 1048large number (e.g. C<987654321>) to effectively disable the timeout.
1007 1049
1008=item B<backspacekey:> I<string> 1050=item B<backspacekey:> I<string>
1009 1051
1010The string to send when the backspace key is pressed. If set to B<DEC> 1052The string to send when the backspace key is pressed. If set to B<DEC>
1011or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1053or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1012(code 8) - which can be reversed with the appropriate DEC private mode 1054(code 8) - which can be reversed with the appropriate DEC private mode
1013escape sequence. 1055escape sequence.
1014 1056
1015=item B<deletekey:> I<string> 1057=item B<deletekey:> I<string>
1016 1058
1135omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1177omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1136keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1178keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1137performed in an exact manner; however, the closest match is assured. 1179performed in an exact manner; however, the closest match is assured.
1138 1180
1139I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1181I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1140number), see RESOURCES in C<man 7 X> for futher details. 1182number), see RESOURCES in C<man 7 X> for further details.
1141 1183
1142You can define a range of keysyms in one shot by providing a I<string> 1184You can define a range of keysyms in one shot by providing a I<string>
1143with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1144should be a character not used by the strings. 1186should be a character not used by the strings.
1145 1187
1146Its usage can be demonstrated by an example: 1188Its usage can be demonstrated by an example:
1147 1189
1148 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1190 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1149 1191
1150The above line is equivalent to the following three lines: 1192The above line is equivalent to the following three lines:
1151 1193
1152 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1194 URxvt.keysym.Meta-Control-0x61: \033<a>
1153 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1195 URxvt.keysym.Meta-Control-0x62: \033<b>
1154 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1196 URxvt.keysym.Meta-Control-0x63: \033<c>
1155 1197
1156If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1198If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1157is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1199is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1158example the following means "change the current locale to C<zh_CN.GBK> 1200example the following means "change the current locale to C<zh_CN.GBK>
1159when Control-Meta-c is being pressed": 1201when Control-Meta-c is being pressed":
1160 1202
1161 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1203 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1162 1204
1163If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1205If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1164is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1206is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1165manpage. For example, the F<selection> extension (activated via 1207manpage. For example, the F<selection> extension (activated via
1166C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1208C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1167 1209
1168 URxvt.keysym.M-C-c: perl:selection:rot13 1210 URxvt.keysym.M-C-c: perl:selection:rot13
1169 1211
1170Due the the large number of modifier combinations, a defined key mapping 1212Due the the large number of modifier combinations, a defined key mapping
1171will match if at I<at least> the specified identifiers are being set, and 1213will match if I<at least> the specified identifiers are being set, and
1172no other key mappings with those and more bits are being defined. That 1214no other key mappings with those and more bits are being defined. That
1173means that defining a key map for C<a> will automatically provide 1215means that defining a key map for C<a> will automatically provide
1174definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1216definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1175mappings themselves. 1217mappings themselves.
1176 1218
1227all instances, while B<perl-ext> is used for specific instances. 1269all instances, while B<perl-ext> is used for specific instances.
1228 1270
1229=item B<perl-eval>: I<string> 1271=item B<perl-eval>: I<string>
1230 1272
1231Perl code to be evaluated when all extensions have been registered. See 1273Perl code to be evaluated when all extensions have been registered. See
1232the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1274the @@RXVT_NAME@@perl(3) manpage.
1233will be ignored when running setuid/setgid.
1234 1275
1235=item B<perl-lib>: I<path> 1276=item B<perl-lib>: I<path>
1236 1277
1237Colon-separated list of additional directories that hold extension 1278Colon-separated list of additional directories that hold extension
1238scripts. When looking for extensions specified by the C<perl> resource, 1279scripts. When looking for extensions specified by the C<perl> resource,
1239@@RXVT_NAME@@ will first look in these directories and then in 1280@@RXVT_NAME@@ will first look in these directories and then in
1240F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1281F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1241will be ignored when running setuid/setgid.
1242 1282
1243See the @@RXVT_NAME@@perl(3) manpage. 1283See the @@RXVT_NAME@@perl(3) manpage.
1244 1284
1245=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1285=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1246 1286
1268 1308
1269=item B<override-redirect>: I<boolean> 1309=item B<override-redirect>: I<boolean>
1270 1310
1271Compile I<frills>: Sets override-redirect for the terminal window, making 1311Compile I<frills>: Sets override-redirect for the terminal window, making
1272it almost invisible to window managers; option B<-override-redirect>. 1312it almost invisible to window managers; option B<-override-redirect>.
1313
1314=item B<iso14755:> I<boolean>
1315
1316Turn on/off ISO 14755 (default enabled).
1273 1317
1274=item B<iso14755_52:> I<boolean> 1318=item B<iso14755_52:> I<boolean>
1275 1319
1276Turn on/off ISO 14755 5.2 mode (default enabled). 1320Turn on/off ISO 14755 5.2 mode (default enabled).
1277 1321
1420B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1464B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1421it can be seen via the I<who(1)> command, and can accept messages. To 1465it can be seen via the I<who(1)> command, and can accept messages. To
1422allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1466allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1423on some systems or setgid to root or to some other group on others. 1467on some systems or setgid to root or to some other group on others.
1424 1468
1425=head1 COLORS AND GRAPHICS 1469=head1 COLOURS AND GRAPHICS
1426 1470
1427In addition to the default foreground and background colours, 1471In addition to the default foreground and background colours,
1428B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1472B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1429high-intensity bold/blink versions of the same). Here is a list of the 1473high-intensity (potentially bold/blink) versions of the same, and 72 (or
1430colours with their names. 1474240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1475cube plus a 8 (24) colour greyscale ramp.
1476
1477Here is a list of the ANSI colours with their names.
1431 1478
1432=begin table 1479=begin table
1433 1480
1434 B<color0> (black) = Black 1481 B<color0> (black) = Black
1435 B<color1> (red) = Red3 1482 B<color1> (red) = Red3
1455It is also possible to specify the colour values of B<foreground>, 1502It is also possible to specify the colour values of B<foreground>,
1456B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1503B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1457a number 0-15, as a convenient shorthand to reference the colour name of 1504a number 0-15, as a convenient shorthand to reference the colour name of
1458color0-color15. 1505color0-color15.
1459 1506
1460In addition to the colours defined above, @@RXVT_NAME@@ offers an 1507The following text gives values for the standard 88 colour mode (and
1461additional 72 colours. The first 64 of those (with indices 16 to 79) 1508values for the 256 colour mode in parentheses).
1462consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
146316>), followed by 8 additional shades of gray (with indices 80 to 87).
1464 1509
1510The RGB cube uses indices 16..79 (16..231) using the following formulas:
1511
1512 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1513 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1514
1515The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1516steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1517the RGB cube.
1518
1465Together, all those colours implement the 88 colour xterm colours. Only 1519Together, all those colours implement the 88 (256) colour xterm
1466the first 16 can be changed using resources currently, the rest can only 1520colours. Only the first 16 can be changed using resources currently, the
1467be changed via command sequences ("escape codes"). 1521rest can only be changed via command sequences ("escape codes").
1522
1523Applications are advised to use terminfo or command sequences to discover
1524number and RGB values of all colours (yes, you can query this...).
1468 1525
1469Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1526Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1470always swapping the foreground/background colours. This is in contrast to 1527always swapping the foreground/background colours. This is in contrast to
1471I<xterm>(1) where the colours are only swapped if they have not otherwise 1528I<xterm>(1) where the colours are only swapped if they have not otherwise
1472been specified. For example, 1529been specified. For example,
1473 1530
1474=over 4
1475
1476=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1531 @@RXVT_NAME@@ -fg Black -bg White -rv
1477 1532
1478would yield White on Black, while on I<xterm>(1) it would yield Black 1533would yield White on Black, while on I<xterm>(1) it would yield Black on
1479on White. 1534White.
1480
1481=back
1482 1535
1483=head2 ALPHA CHANNEL SUPPORT 1536=head2 ALPHA CHANNEL SUPPORT
1484 1537
1485If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1538If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1486their act together, rxvt-unicode will do it's own alpha channel management: 1539their act together, rxvt-unicode will do it's own alpha channel management:
1487 1540
1488You can prefix any color with an opaquenes percentage enclosed in 1541You can prefix any colour with an opaqueness percentage enclosed in
1489brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1542brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1490(0-100) that specifies the opacity of the color, where C<0> is completely 1543(0-100) that specifies the opacity of the colour, where C<0> is completely
1491transparent and C<100> is completely opaque. For example, C<[50]red> is a 1544transparent and C<100> is completely opaque. For example, C<[50]red> is a
1492half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1545half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1493is the recommended format to specify transparency values, and works with 1546is the recommended format to specify transparency values, and works with
1494all ways to specify a colour. 1547all ways to specify a colour.
1495 1548
1578=item B<RXVT_SOCKET> 1631=item B<RXVT_SOCKET>
1579 1632
1580The unix domain socket path used by @@RXVT_NAME@@c(1) and 1633The unix domain socket path used by @@RXVT_NAME@@c(1) and
1581@@RXVT_NAME@@d(1). 1634@@RXVT_NAME@@d(1).
1582 1635
1583Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1636Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1584 1637
1585=item B<HOME> 1638=item B<HOME>
1586 1639
1587Used to locate the default directory for the unix domain socket for 1640Used to locate the default directory for the unix domain socket for
1588daemon communications and to locate various resource files (such as 1641daemon communications and to locate various resource files (such as
1589C<.Xdefaults>) 1642C<.Xdefaults>)
1590 1643
1591=item B<XAPPLRESDIR> 1644=item B<XAPPLRESDIR>
1592 1645
1593Directory where various X resource files are being located. 1646Directory where application-specific X resource files are located.
1594 1647
1595=item B<XENVIRONMENT> 1648=item B<XENVIRONMENT>
1596 1649
1597If set and accessible, gives the name of a X resource file to be loaded by 1650If set and accessible, gives the name of a X resource file to be loaded by
1598@@RXVT_NAME@@. 1651@@RXVT_NAME@@.
1603 1656
1604=over 4 1657=over 4
1605 1658
1606=item B</usr/lib/X11/rgb.txt> 1659=item B</usr/lib/X11/rgb.txt>
1607 1660
1608Color names. 1661Colour names.
1609 1662
1610=back 1663=back
1611 1664
1612=head1 SEE ALSO 1665=head1 SEE ALSO
1613 1666
1664 1717
1665Project Coordinator (Changes 1.0 -) 1718Project Coordinator (Changes 1.0 -)
1666 1719
1667=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1720=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1668 1721
1669Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1722pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1670 1723
1671=back 1724=back
1672 1725

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines