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.166 by root, Fri Oct 10 13:23:56 2008 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC

98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<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<frills>: 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 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 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 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 127
123=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
124 129
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
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 131
137=item B<-fade> I<number> 132=item B<-fade> I<number>
138 133
139Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
143=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
144 139
145Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
147 142
148=item B<-tint> I<colour> 143=item B<-icon> I<file>
149 144
150Tint the transparent background pixmap with the given colour when 145Compile I<pixbuf>: Use the specified image as application icon. This
151transparency is enabled with B<-tr>. This only works for 146is used by many window managers, taskbars and pagers to represent the
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 147application window; resource I<iconFile>.
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
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186 148
187=item B<-bg> I<colour> 149=item B<-bg> I<colour>
188 150
189Window background colour; resource B<background>. 151Window background colour; resource B<background>.
190 152
191=item B<-fg> I<colour> 153=item B<-fg> I<colour>
192 154
193Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
194
195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196
197Compile I<afterimage>: Specify image file for the background and also
198optionally specify its scaling with a geometry string. Note you may need to
199add quotes to avoid special shell interpretation of the C<;> in the
200command-line; for more details see resource B<backgroundPixmap>.
201 156
202=item B<-cr> I<colour> 157=item B<-cr> I<colour>
203 158
204The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
205 160
315 270
316=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
317 272
318Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
319 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
320=item B<-iconic> 279=item B<-iconic>
321 280
322Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 282Alternative form is B<-ic>.
324 283
360=item B<-lsp> I<number> 319=item B<-lsp> I<number>
361 320
362Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
363the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
364B<lineSpace>. 323B<lineSpace>.
324
325=item B<-letsp> I<number>
326
327Compile I<frills>: Amount to adjust the computed character width by
328to control overall letter spacing. Negative values will tighten up the
329letter spacing, positive values will space letters out more. Useful to
330work around odd font metrics; resource B<letterSpace>.
365 331
366=item B<-tn> I<termname> 332=item B<-tn> I<termname>
367 333
368This option specifies the name of the terminal type to be set in the 334This option specifies the name of the terminal type to be set in the
369B<TERM> environment variable. This terminal type must exist in the 335B<TERM> environment variable. This terminal type must exist in the
554You can set and change the resources using X11 tools like B<xrdb>. Many 520You can set and change the resources using X11 tools like B<xrdb>. Many
555distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
556starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
557with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
558 524
559 1. system-wide app-defaults file, either locale-dependent OR global
560 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
561 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
562 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
563 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
564 6. resources specified via -xrm on the commandline 530 6. resources specified via -xrm on the commandline
565 531
566Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
567names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
608Use the specified colour for the colour value I<n>, where 0-7 574Use the specified colour for the colour value I<n>, where 0-7
609corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
610high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
611colours. The canonical names are as follows: 0=black, 1=red, 2=green, 577colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6123=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5783=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
613names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
614 580
615Colours higher than 15 cannot be set using resources (yet), but can be 581Colours higher than 15 cannot be set using resources (yet), but can be
616changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
617 583
618Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 584Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
629=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
630 596
631Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
632foreground colour is the default. 598foreground colour is the default.
633 599
634=item B<colorRV:> I<colour>
635
636Use the specified colour as the background for reverse video characters
637when OPTION_HC is disabled (--disable-frills).
638
639=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
640 601
641If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
642itself. If unset, use the foreground colour. 603itself. If unset, use the foreground colour.
604
605=item B<highlightColor:> I<colour>
606
607If set, use the specified colour as the background for highlighted
608characters. If unset, use reverse video.
609
610=item B<highlightTextColor:> I<colour>
611
612If set and highlightColor is set, use the specified colour as the
613foreground for highlighted characters.
643 614
644=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
645 616
646Use the specified colour for the cursor. The default is to use the 617Use the specified colour for the cursor. The default is to use the
647foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
654 625
655=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
656 627
657B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
658option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
659B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
660 631
661=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
662 633
663B<True>: specify that jump scrolling should be used. When receiving lots 634B<True>: specify that jump scrolling should be used. When receiving lots
664of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 635of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
678 649
679B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
680if the refresh is too fast for the human eye to read anything (or the 651if the refresh is too fast for the human eye to read anything (or the
681monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
682 653
683=item B<transparent:> I<boolean>
684
685Turn on/off illusion of a transparent window background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
689
690I<Please address all transparency related issues to Sasha Vasko at
691sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
692
693=item B<fading:> I<number> 654=item B<fading:> I<number>
694 655
695Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
696 657
697=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
698 659
699Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
700colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
701 662
702=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
703 664
704Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
705B<-tint>.
706
707=item B<shading:> I<number>
708
709Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
710in addition to tinting it; option B<-sh>.
711
712=item B<blendType:> I<string>
713
714Specify background blending type; option B<-blt>.
715
716=item B<blurRadius:> I<number>
717
718Apply Gaussian Blurr with the specified radius to the transparent
719background image; option B<-blr>.
720 666
721=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
722 668
723Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
724 670
729 675
730=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
731 677
732The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
733and the text. 679and the text.
734
735=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
736
737Use the specified image file for the background and also
738optionally specify its scaling with a geometry string B<WxH+X+Y>,
739(default C<0x0+50+50>) in which B<"W" / "H"> specify the
740horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
741centre (percent). A scale of 0 displays the image with tiling. A scale
742of 1 displays the image without any scaling. A scale of 2 to 9 specifies
743an integer number of images in that direction. No image will be magnified
744beyond 10 times its original size. The maximum permitted scale is 1000.
745Additional operations can be specified after colon B<:op1:op2...>.
746Supported operations are:
747
748 tile force background image to be tiled and not scaled. Equivalent to 0x0
749 propscale will scale image keeping proportions
750 auto will scale image to match window size. Equivalent to 100x100
751 hscale will scale image horizontally to the window size
752 vscale will scale image vertically to the window size
753 scale will scale image to match window size
754 root will tile image as if it was a root window background, auto-adjusting
755 whenever terminal window moves
756
757If used in conjunction with B<-tr> option, the specified pixmap will be
758blended over transparency image using either alpha-blending, or any
759other blending type, specified with B<-blt "type"> option.
760
761=item B<path:> I<path>
762
763Specify the colon-delimited search path for finding background image files.
764 680
765=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
766 682
767Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
768that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
791it is named first) and thus defines the character cell grid to be 9 pixels 707it is named first) and thus defines the character cell grid to be 9 pixels
792wide and 15 pixels high. 708wide and 15 pixels high.
793 709
794The second font is just used to add additional unicode characters not in 710The second font is just used to add additional unicode characters not in
795the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
796the bold version of the font does contain less characters, so this is a 712the bold version of the font does contain fewer characters, so this is a
797useful supplement. 713useful supplement.
798 714
799The third font is an Xft font with aliasing turned off, and the characters 715The third font is an Xft font with aliasing turned off, and the characters
800are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 716are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
801contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
852=item B<urgentOnBell:> I<boolean> 768=item B<urgentOnBell:> I<boolean>
853 769
854B<True>: set the urgency hint for the wm on receipt of a bell character. 770B<True>: set the urgency hint for the wm on receipt of a bell character.
855B<False>: do not set the urgency hint [default]. 771B<False>: do not set the urgency hint [default].
856 772
773@@RXVT_NAME@@ resets the urgency hint on every focus change.
774
857=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
858 776
859B<True>: use visual bell on receipt of a bell character; option B<-vb>. 777B<True>: use visual bell on receipt of a bell character; option B<-vb>.
860B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
861 779
889=item B<scrollstyle:> I<mode> 807=item B<scrollstyle:> I<mode>
890 808
891Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 809Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
892the author's favourite. 810the author's favourite.
893 811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
894=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
895 817
896B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
897disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
898 820
917B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
918B<+si>. 840B<+si>.
919 841
920=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
921 843
922B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
923B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
924with scrollback buffer when tty receives new lines; option B<+sw>. 846B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
847new lines; option B<+sw>.
925 848
926=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
927 850
928B<True>: scroll to bottom when a non-special key is pressed. Special keys 851B<True>: scroll to bottom when a non-special key is pressed. Special keys
929are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
985=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
986 909
987B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 910B<True>: blink the cursor. B<False>: do not blink the cursor [default];
988option B<-bc>. 911option B<-bc>.
989 912
913=item B<cursorUnderline:> I<boolean>
914
915B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
916option B<-uc>.
917
990=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
991 919
992B<True>: blank the pointer when a key is pressed or after a set number 920B<True>: blank the pointer when a key is pressed or after a set number
993of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
994[default]. 922[default].
1007large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
1008 936
1009=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
1010 938
1011The string to send when the backspace key is pressed. If set to B<DEC> 939The string to send when the backspace key is pressed. If set to B<DEC>
1012or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 940or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1013(code 8) - which can be reversed with the appropriate DEC private mode 941(code 8) - which can be reversed with the appropriate DEC private mode
1014escape sequence. 942escape sequence.
1015 943
1016=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
1017 945
1136omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1064omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1137keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1065keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1138performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1139 1067
1140I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1141number), see RESOURCES in C<man 7 X> for futher details. 1069number), see RESOURCES in C<man 7 X> for further details.
1142 1070
1143You can define a range of keysyms in one shot by providing a I<string> 1071You can define a range of keysyms in one shot by
1072loading the C<keysym-list> perl extension and providing a I<string>
1144with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1145should be a character not used by the strings. 1074should be a character not used by the strings.
1146 1075
1147Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1148 1077
1149 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1078 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1150 1079
1151The above line is equivalent to the following three lines: 1080The above line is equivalent to the following three lines:
1152 1081
1153 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1082 URxvt.keysym.Meta-Control-0x61: \033<a>
1154 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1083 URxvt.keysym.Meta-Control-0x62: \033<b>
1155 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1084 URxvt.keysym.Meta-Control-0x63: \033<c>
1156 1085
1157If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1086If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1158is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1087is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1159example the following means "change the current locale to C<zh_CN.GBK> 1088example the following means "change the current locale to C<zh_CN.GBK>
1160when Control-Meta-c is being pressed": 1089when Control-Meta-c is being pressed":
1161 1090
1162 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1091 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1163 1092
1164If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1093If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1165is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1094is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1166manpage. For example, the F<selection> extension (activated via 1095manpage. For example, the F<selection> extension (activated via
1167C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1096C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1168 1097
1169 URxvt.keysym.M-C-c: perl:selection:rot13 1098 URxvt.keysym.M-C-c: perl:selection:rot13
1170 1099
1171Due the the large number of modifier combinations, a defined key mapping 1100Due the the large number of modifier combinations, a defined key mapping
1172will match if at I<at least> the specified identifiers are being set, and 1101will match if I<at least> the specified identifiers are being set, and
1173no other key mappings with those and more bits are being defined. That 1102no other key mappings with those and more bits are being defined. That
1174means that defining a key map for C<a> will automatically provide 1103means that defining a key map for C<a> will automatically provide
1175definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1104definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1176mappings themselves. 1105mappings themselves.
1177 1106
1233the @@RXVT_NAME@@perl(3) manpage. 1162the @@RXVT_NAME@@perl(3) manpage.
1234 1163
1235=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1236 1165
1237Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1238scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1239@@RXVT_NAME@@ will first look in these directories and then in 1168in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1240F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1241 1170
1242See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1243 1172
1244=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1245 1174
1254=item B<searchable-scrollback:> I<keysym> 1183=item B<searchable-scrollback:> I<keysym>
1255 1184
1256Sets the hotkey that starts the incremental scrollback buffer search 1185Sets the hotkey that starts the incremental scrollback buffer search
1257(default: C<M-s>). 1186(default: C<M-s>).
1258 1187
1259=item B<urlLauncher>: I<string> 1188=item B<url-launcher>: I<string>
1260 1189
1261Specifies the program to be started with a URL argument. Used by the 1190Specifies the program to be started with a URL argument. Used by the
1262C<selection-popup> and C<matcher> perl extensions. 1191C<selection-popup> and C<matcher> perl extensions.
1263 1192
1264=item B<transient-for>: I<windowid> 1193=item B<transient-for>: I<windowid>
1268=item B<override-redirect>: I<boolean> 1197=item B<override-redirect>: I<boolean>
1269 1198
1270Compile I<frills>: Sets override-redirect for the terminal window, making 1199Compile I<frills>: Sets override-redirect for the terminal window, making
1271it almost invisible to window managers; option B<-override-redirect>. 1200it almost invisible to window managers; option B<-override-redirect>.
1272 1201
1202=item B<iso14755:> I<boolean>
1203
1204Turn on/off ISO 14755 (default enabled).
1205
1273=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1274 1207
1275Turn on/off ISO 14755 5.2 mode (default enabled). 1208Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210=back
1211
1212=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1213
1214=over 4
1215
1216=item B<-pixmap> I<file[;oplist]>
1217
1218=item B<backgroundPixmap:> I<file[;oplist]>
1219
1220Compile I<pixbuf>: Use the specified image file as the window's
1221background and also optionally specify a colon separated list of
1222operations to modify it. Note that you may need to quote the C<;>
1223character when using the command line option, as C<;> is usually a
1224metacharacter in shells. Supported operations are:
1225
1226=over 4
1227
1228=item B<WxH+X+Y>
1229
1230sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1231scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1232scale of 0 disables scaling.
1233
1234=item B<op=tile>
1235
1236enables tiling
1237
1238=item B<op=keep-aspect>
1239
1240maintain the image aspect ratio when scaling
1241
1242=item B<op=root-align>
1243
1244use the position of the terminal window relative to the root window as
1245the image offset, simulating a root window background
1246
1247=back
1248
1249The default scale and position setting is C<100x100+50+50>.
1250Alternatively, a predefined set of templates can be used to achieve
1251the most common setups:
1252
1253=over 4
1254
1255=item B<style=tiled>
1256
1257the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1258
1259=item B<style=aspect-stretched>
1260
1261the image is scaled to fill the whole window maintaining the aspect
1262ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1263
1264=item B<style=stretched>
1265
1266the image is scaled to fill the whole window. Equivalent to 100x100
1267
1268=item B<style=centered>
1269
1270the image is centered with no scaling. Equivalent to 0x0+50+50
1271
1272=item B<style=root-tiled>
1273
1274the image is tiled with no scaling and using 'root' positioning.
1275Equivalent to 0x0:op=tile:op=root-align
1276
1277=back
1278
1279If multiple templates are specified the last one wins. Note that a
1280template overrides all the scale, position and operations settings.
1281
1282If used in conjunction with pseudo-transparency, the specified pixmap
1283will be blended over the transparent background using alpha-blending.
1284
1285=item B<-tr>|B<+tr>
1286
1287=item B<transparent:> I<boolean>
1288
1289Turn on/off pseudo-transparency by using the root pixmap as background.
1290
1291B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1292will be removed in future versions.
1293
1294=item B<-tint> I<colour>
1295
1296=item B<tintColor:> I<colour>
1297
1298Tint the transparent background with the given colour. Note that a
1299black tint yields a completely black image while a white tint yields
1300the image unchanged.
1301
1302=item B<-sh> I<number>
1303
1304=item B<shading:> I<number>
1305
1306Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1307A value of 100 means no shading.
1308
1309=item B<-blr> I<HxV>
1310
1311=item B<blurRadius:> I<HxV>
1312
1313Apply gaussian blur with the specified radius to the transparent
1314background. If a single number is specified, the vertical and
1315horizontal radii are considered to be the same. Setting one of the
1316radii to 1 and the other to a large number creates interesting effects
1317on some backgrounds. The maximum radius value is 128. An horizontal or
1318vertical radius of 0 disables blurring.
1319
1320=item B<path:> I<path>
1321
1322Specify the colon-delimited search path for finding background image files.
1276 1323
1277=back 1324=back
1278 1325
1279=head1 THE SCROLLBAR 1326=head1 THE SCROLLBAR
1280 1327
1419B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1466B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1420it can be seen via the I<who(1)> command, and can accept messages. To 1467it can be seen via the I<who(1)> command, and can accept messages. To
1421allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1468allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1422on some systems or setgid to root or to some other group on others. 1469on some systems or setgid to root or to some other group on others.
1423 1470
1424=head1 COLORS AND GRAPHICS 1471=head1 COLOURS AND GRAPHICS
1425 1472
1426In addition to the default foreground and background colours, 1473In addition to the default foreground and background colours,
1427B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1474B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1428high-intensity bold/blink versions of the same). Here is a list of the 1475high-intensity (potentially bold/blink) versions of the same, and 72 (or
1429colours with their names. 1476240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1477cube plus a 8 (24) colour greyscale ramp.
1478
1479Here is a list of the ANSI colours with their names.
1430 1480
1431=begin table 1481=begin table
1432 1482
1433 B<color0> (black) = Black 1483 B<color0> (black) = Black
1434 B<color1> (red) = Red3 1484 B<color1> (red) = Red3
1454It is also possible to specify the colour values of B<foreground>, 1504It is also possible to specify the colour values of B<foreground>,
1455B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1505B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1456a number 0-15, as a convenient shorthand to reference the colour name of 1506a number 0-15, as a convenient shorthand to reference the colour name of
1457color0-color15. 1507color0-color15.
1458 1508
1459In addition to the colours defined above, @@RXVT_NAME@@ offers an 1509The following text gives values for the standard 88 colour mode (and
1460additional 72 colours. The first 64 of those (with indices 16 to 79) 1510values for the 256 colour mode in parentheses).
1461consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
146216>), followed by 8 additional shades of gray (with indices 80 to 87).
1463 1511
1512The RGB cube uses indices 16..79 (16..231) using the following formulas:
1513
1514 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1515 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1516
1517The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1518steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1519the RGB cube.
1520
1464Together, all those colours implement the 88 colour xterm colours. Only 1521Together, all those colours implement the 88 (256) colour xterm
1465the first 16 can be changed using resources currently, the rest can only 1522colours. Only the first 16 can be changed using resources currently, the
1466be changed via command sequences ("escape codes"). 1523rest can only be changed via command sequences ("escape codes").
1524
1525Applications are advised to use terminfo or command sequences to discover
1526number and RGB values of all colours (yes, you can query this...).
1467 1527
1468Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1528Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1469always swapping the foreground/background colours. This is in contrast to 1529always swapping the foreground/background colours. This is in contrast to
1470I<xterm>(1) where the colours are only swapped if they have not otherwise 1530I<xterm>(1) where the colours are only swapped if they have not otherwise
1471been specified. For example, 1531been specified. For example,
1472 1532
1473=over 4
1474
1475=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1533 @@RXVT_NAME@@ -fg Black -bg White -rv
1476 1534
1477would yield White on Black, while on I<xterm>(1) it would yield Black 1535would yield White on Black, while on I<xterm>(1) it would yield Black on
1478on White. 1536White.
1479
1480=back
1481 1537
1482=head2 ALPHA CHANNEL SUPPORT 1538=head2 ALPHA CHANNEL SUPPORT
1483 1539
1484If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1540If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1485their act together, rxvt-unicode will do it's own alpha channel management: 1541their act together, rxvt-unicode will do its own alpha channel management:
1486 1542
1487You can prefix any color with an opaquenes percentage enclosed in 1543You can prefix any colour with an opaqueness percentage enclosed in
1488brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1544brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1489(0-100) that specifies the opacity of the color, where C<0> is completely 1545(0-100) that specifies the opacity of the colour, where C<0> is completely
1490transparent and C<100> is completely opaque. For example, C<[50]red> is a 1546transparent and C<100> is completely opaque. For example, C<[50]red> is a
1491half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1547half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1492is the recommended format to specify transparency values, and works with 1548is the recommended format to specify transparency values, and works with
1493all ways to specify a colour. 1549all ways to specify a colour.
1494 1550
1572 1628
1573=item B<SHELL> 1629=item B<SHELL>
1574 1630
1575The shell to be used for command execution, defaults to C</bin/sh>. 1631The shell to be used for command execution, defaults to C</bin/sh>.
1576 1632
1577=item B<RXVT_SOCKET> 1633=item B<RXVT_SOCKET> [I<sic>]
1578 1634
1579The unix domain socket path used by @@RXVT_NAME@@c(1) and 1635The unix domain socket path used by @@RXVT_NAME@@c(1) and
1580@@RXVT_NAME@@d(1). 1636@@RXVT_NAME@@d(1).
1581 1637
1582Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1638Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1639
1640=item B<URXVT_PERL_LIB>
1641
1642Additional F<:>-separated library search path for perl extensions. Will be
1643searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1644directory.
1645
1646=item B<URXVT_PERL_VERBOSITY>
1647
1648See L<@@RXVT_NAME@@perl>(3).
1583 1649
1584=item B<HOME> 1650=item B<HOME>
1585 1651
1586Used to locate the default directory for the unix domain socket for 1652Used to locate the default directory for the unix domain socket for
1587daemon communications and to locate various resource files (such as 1653daemon communications and to locate various resource files (such as
1588C<.Xdefaults>) 1654C<.Xdefaults>)
1589 1655
1590=item B<XAPPLRESDIR> 1656=item B<XAPPLRESDIR>
1591 1657
1592Directory where various X resource files are being located. 1658Directory where application-specific X resource files are located.
1593 1659
1594=item B<XENVIRONMENT> 1660=item B<XENVIRONMENT>
1595 1661
1596If set and accessible, gives the name of a X resource file to be loaded by 1662If set and accessible, gives the name of a X resource file to be loaded by
1597@@RXVT_NAME@@. 1663@@RXVT_NAME@@.
1602 1668
1603=over 4 1669=over 4
1604 1670
1605=item B</usr/lib/X11/rgb.txt> 1671=item B</usr/lib/X11/rgb.txt>
1606 1672
1607Color names. 1673Colour names.
1608 1674
1609=back 1675=back
1610 1676
1611=head1 SEE ALSO 1677=head1 SEE ALSO
1612 1678
1679@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1613@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1680@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1614 1681
1615=head1 CURRENT PROJECT COORDINATOR 1682=head1 CURRENT PROJECT COORDINATOR
1616 1683
1617=over 4 1684=over 4
1618 1685
1619=item Project Coordinator 1686=item Project Coordinator
1620 1687
1621Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1688Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1622 1689
1623L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1690L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1624 1691
1625=back 1692=back
1626 1693
1630 1697
1631=item John Bovey 1698=item John Bovey
1632 1699
1633University of Kent, 1992, wrote the original Xvt. 1700University of Kent, 1992, wrote the original Xvt.
1634 1701
1635=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1702=item Rob Nation <nation@rocket.sanders.lockheed.com>
1636 1703
1637very heavily modified Xvt and came up with Rxvt 1704very heavily modified Xvt and came up with Rxvt
1638 1705
1639=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1706=item Angelo Haritsis <ah@doc.ic.ac.uk>
1640 1707
1641wrote the Greek Keyboard Input (no longer in code) 1708wrote the Greek Keyboard Input (no longer in code)
1642 1709
1643=item mj olesen L<< <olesen@me.QueensU.CA> >> 1710=item mj olesen <olesen@me.QueensU.CA>
1644 1711
1645Wrote the menu system. 1712Wrote the menu system.
1646 1713
1647Project Coordinator (changes.txt 2.11 to 2.21) 1714Project Coordinator (changes.txt 2.11 to 2.21)
1648 1715
1649=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1716=item Oezguer Kesim <kesim@math.fu-berlin.de>
1650 1717
1651Project Coordinator (changes.txt 2.21a to 2.4.5) 1718Project Coordinator (changes.txt 2.21a to 2.4.5)
1652 1719
1653=item Geoff Wing L<< <gcw@pobox.com> >> 1720=item Geoff Wing <gcw@pobox.com>
1654 1721
1655Rewrote screen display and text selection routines. 1722Rewrote screen display and text selection routines.
1656 1723
1657Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1724Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1658 1725
1659=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1726=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1660 1727
1661Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1728Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1662extension, random hacks, numerous bugfixes and extensions. 1729extension, random hacks, numerous bugfixes and extensions.
1663 1730
1664Project Coordinator (Changes 1.0 -) 1731Project Coordinator (Changes 1.0 -)
1665 1732
1666=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1733=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1667 1734
1668Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1735pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1669 1736
1670=back 1737=back
1671 1738

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines