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.169 by root, Wed Nov 5 00:14:18 2008 UTC vs.
Revision 1.223 by root, Thu May 30 18:49:16 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>
149
150Tint the transparent background pixmap with the given colour when
151transparency is enabled with B<-tr>. This only works for
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
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
187=item B<-icon> I<file> 143=item B<-icon> I<file>
188 144
189Compile I<afterimage>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 147application window; resource I<iconFile>.
192 148
193=item B<-bg> I<colour> 149=item B<-bg> I<colour>
194 150
195Window background colour; resource B<background>. 151Window background colour; resource B<background>.
196 152
197=item B<-fg> I<colour> 153=item B<-fg> I<colour>
198 154
199Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203Compile I<afterimage>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>.
207 156
208=item B<-cr> I<colour> 157=item B<-cr> I<colour>
209 158
210The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
211 160
… …
321 270
322=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
323 272
324Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
325 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
326=item B<-iconic> 279=item B<-iconic>
327 280
328Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
329Alternative form is B<-ic>. 282Alternative form is B<-ic>.
330 283
… …
366=item B<-lsp> I<number> 319=item B<-lsp> I<number>
367 320
368Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
369the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
370B<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>.
371 331
372=item B<-tn> I<termname> 332=item B<-tn> I<termname>
373 333
374This 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
375B<TERM> environment variable. This terminal type must exist in the 335B<TERM> environment variable. This terminal type must exist in the
… …
560You 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
561distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
562starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
563with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
564 524
565 1. system-wide app-defaults file, either locale-dependent OR global
566 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
567 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
568 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
569 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
570 6. resources specified via -xrm on the commandline 530 6. resources specified via -xrm on the commandline
571 531
572Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
573names: 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
… …
614Use 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
615corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
616high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
617colours. 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,
6183=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
619names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
620 580
621Colours 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
622changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
623 583
624Colours 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
… …
635=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
636 596
637Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
638foreground colour is the default. 598foreground colour is the default.
639 599
640=item B<colorRV:> I<colour>
641
642Use the specified colour as the background for reverse video characters
643when OPTION_HC is disabled (--disable-frills).
644
645=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
646 601
647If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
648itself. 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.
649 614
650=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
651 616
652Use 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
653foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
… …
660 625
661=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
662 627
663B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
664option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
665B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
666 631
667=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
668 633
669B<True>: specify that jump scrolling should be used. When receiving lots 634B<True>: specify that jump scrolling should be used. When receiving lots
670of 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
… …
684 649
685B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
686if 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
687monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
688 653
689=item B<transparent:> I<boolean>
690
691Turn on/off illusion of a transparent window background.
692
693B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
694future versions.
695
696I<Please address all transparency related issues to Sasha Vasko at
697sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
698
699=item B<fading:> I<number> 654=item B<fading:> I<number>
700 655
701Fade 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>.
702 657
703=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
704 659
705Fade 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
706colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
707 662
708=item B<tintColor:> I<colour>
709
710Tint the transparent background pixmap with the given colour; option
711B<-tint>.
712
713=item B<shading:> I<number>
714
715Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
716in addition to tinting it; option B<-sh>.
717
718=item B<blendType:> I<string>
719
720Specify background blending type; option B<-blt>.
721
722=item B<blurRadius:> I<number>
723
724Apply gaussian blur with the specified radius to the transparent
725background image; option B<-blr>.
726
727=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
728 664
729Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
730 666
731=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
739 675
740=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
741 677
742The 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
743and the text. 679and the text.
744
745=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
746
747Use the specified image file for the background and also
748optionally specify its scaling with a geometry string B<WxH+X+Y>,
749(default C<0x0+50+50>) in which B<"W" / "H"> specify the
750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
751centre (percent). A scale of 0 displays the image with tiling. A scale
752of 1 displays the image without any scaling. A scale of 2 to 9 specifies
753an integer number of images in that direction. No image will be magnified
754beyond 10 times its original size. The maximum permitted scale is 1000.
755Additional operations can be specified after colon B<:op1:op2...>.
756Supported operations are:
757
758 tile force background image to be tiled and not scaled. Equivalent to 0x0
759 propscale will scale image keeping proportions
760 auto will scale image to match window size. Equivalent to 100x100
761 hscale will scale image horizontally to the window size
762 vscale will scale image vertically to the window size
763 scale will scale image to match window size
764 root will tile image as if it was a root window background, auto-adjusting
765 whenever terminal window moves
766
767If used in conjunction with B<-tr> option, the specified pixmap will be
768blended over transparency image using either alpha-blending, or any
769other blending type, specified with B<-blt "type"> option.
770
771=item B<path:> I<path>
772
773Specify the colon-delimited search path for finding background image files.
774 680
775=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
776 682
777Select 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
778that 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
… …
801it 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
802wide and 15 pixels high. 708wide and 15 pixels high.
803 709
804The 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
805the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
806the 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
807useful supplement. 713useful supplement.
808 714
809The 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
810are 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
811contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
… …
901=item B<scrollstyle:> I<mode> 807=item B<scrollstyle:> I<mode>
902 808
903Set 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
904the author's favourite. 810the author's favourite.
905 811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
906=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
907 817
908B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
909disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
910 820
… …
929B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
930B<+si>. 840B<+si>.
931 841
932=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
933 843
934B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
935B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
936with 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>.
937 848
938=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
939 850
940B<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
941are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
… …
997=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
998 909
999B<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];
1000option B<-bc>. 911option B<-bc>.
1001 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
1002=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
1003 919
1004B<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
1005of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
1006[default]. 922[default].
… …
1019large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
1020 936
1021=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
1022 938
1023The 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>
1024or 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>
1025(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
1026escape sequence. 942escape sequence.
1027 943
1028=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
1029 945
… …
1148omitting 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
1149keysym 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
1150performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1151 1067
1152I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1153number), see RESOURCES in C<man 7 X> for futher details. 1069number), see RESOURCES in C<man 7 X> for further details.
1154 1070
1155You 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>
1156with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1157should be a character not used by the strings. 1074should be a character not used by the strings.
1158 1075
1159Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1160 1077
1161 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1078 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1162 1079
1163The above line is equivalent to the following three lines: 1080The above line is equivalent to the following three lines:
1164 1081
1165 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1082 URxvt.keysym.Meta-Control-0x61: \033<a>
1166 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1083 URxvt.keysym.Meta-Control-0x62: \033<b>
1167 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1084 URxvt.keysym.Meta-Control-0x63: \033<c>
1168 1085
1169If 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>
1170is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1087is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1171example 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>
1172when Control-Meta-c is being pressed": 1089when Control-Meta-c is being pressed":
1173 1090
1174 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
1175 1092
1176If 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>
1177is 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)
1178manpage. For example, the F<selection> extension (activated via 1095manpage. For example, the F<selection> extension (activated via
1179C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1096C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1180 1097
1181 URxvt.keysym.M-C-c: perl:selection:rot13 1098 URxvt.keysym.M-C-c: perl:selection:rot13
1182 1099
1183Due the the large number of modifier combinations, a defined key mapping 1100Due the the large number of modifier combinations, a defined key mapping
1184will 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
1185no 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
1186means that defining a key map for C<a> will automatically provide 1103means that defining a key map for C<a> will automatically provide
1187definitions 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
1188mappings themselves. 1105mappings themselves.
1189 1106
… …
1245the @@RXVT_NAME@@perl(3) manpage. 1162the @@RXVT_NAME@@perl(3) manpage.
1246 1163
1247=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1248 1165
1249Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1250scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1251@@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
1252F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1253 1170
1254See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1255 1172
1256=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1257 1174
… …
1266=item B<searchable-scrollback:> I<keysym> 1183=item B<searchable-scrollback:> I<keysym>
1267 1184
1268Sets the hotkey that starts the incremental scrollback buffer search 1185Sets the hotkey that starts the incremental scrollback buffer search
1269(default: C<M-s>). 1186(default: C<M-s>).
1270 1187
1271=item B<urlLauncher>: I<string> 1188=item B<url-launcher>: I<string>
1272 1189
1273Specifies 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
1274C<selection-popup> and C<matcher> perl extensions. 1191C<selection-popup> and C<matcher> perl extensions.
1275 1192
1276=item B<transient-for>: I<windowid> 1193=item B<transient-for>: I<windowid>
… …
1280=item B<override-redirect>: I<boolean> 1197=item B<override-redirect>: I<boolean>
1281 1198
1282Compile I<frills>: Sets override-redirect for the terminal window, making 1199Compile I<frills>: Sets override-redirect for the terminal window, making
1283it almost invisible to window managers; option B<-override-redirect>. 1200it almost invisible to window managers; option B<-override-redirect>.
1284 1201
1202=item B<iso14755:> I<boolean>
1203
1204Turn on/off ISO 14755 (default enabled).
1205
1285=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1286 1207
1287Turn 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.
1288 1323
1289=back 1324=back
1290 1325
1291=head1 THE SCROLLBAR 1326=head1 THE SCROLLBAR
1292 1327
… …
1431B<@@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
1432it 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
1433allow 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
1434on 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.
1435 1470
1436=head1 COLORS AND GRAPHICS 1471=head1 COLOURS AND GRAPHICS
1437 1472
1438In addition to the default foreground and background colours, 1473In addition to the default foreground and background colours,
1439B<@@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
1440high-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
1441colours 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.
1442 1480
1443=begin table 1481=begin table
1444 1482
1445 B<color0> (black) = Black 1483 B<color0> (black) = Black
1446 B<color1> (red) = Red3 1484 B<color1> (red) = Red3
… …
1466It is also possible to specify the colour values of B<foreground>, 1504It is also possible to specify the colour values of B<foreground>,
1467B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1505B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1468a 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
1469color0-color15. 1507color0-color15.
1470 1508
1471In addition to the colours defined above, @@RXVT_NAME@@ offers an 1509The following text gives values for the standard 88 colour mode (and
1472additional 72 colours. The first 64 of those (with indices 16 to 79) 1510values for the 256 colour mode in parentheses).
1473consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
147416>), followed by 8 additional shades of gray (with indices 80 to 87).
1475 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
1476Together, all those colours implement the 88 colour xterm colours. Only 1521Together, all those colours implement the 88 (256) colour xterm
1477the first 16 can be changed using resources currently, the rest can only 1522colours. Only the first 16 can be changed using resources currently, the
1478be 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...).
1479 1527
1480Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1528Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1481always swapping the foreground/background colours. This is in contrast to 1529always swapping the foreground/background colours. This is in contrast to
1482I<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
1483been specified. For example, 1531been specified. For example,
1484 1532
1485=over 4
1486
1487=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1533 @@RXVT_NAME@@ -fg Black -bg White -rv
1488 1534
1489would 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
1490on White. 1536White.
1491
1492=back
1493 1537
1494=head2 ALPHA CHANNEL SUPPORT 1538=head2 ALPHA CHANNEL SUPPORT
1495 1539
1496If 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
1497their act together, rxvt-unicode will do it's own alpha channel management: 1541their act together, rxvt-unicode will do its own alpha channel management:
1498 1542
1499You can prefix any color with an opaquenes percentage enclosed in 1543You can prefix any colour with an opaqueness percentage enclosed in
1500brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1544brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1501(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
1502transparent 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
1503half-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
1504is the recommended format to specify transparency values, and works with 1548is the recommended format to specify transparency values, and works with
1505all ways to specify a colour. 1549all ways to specify a colour.
1506 1550
… …
1584 1628
1585=item B<SHELL> 1629=item B<SHELL>
1586 1630
1587The 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>.
1588 1632
1589=item B<RXVT_SOCKET> 1633=item B<RXVT_SOCKET> [I<sic>]
1590 1634
1591The unix domain socket path used by @@RXVT_NAME@@c(1) and 1635The unix domain socket path used by @@RXVT_NAME@@c(1) and
1592@@RXVT_NAME@@d(1). 1636@@RXVT_NAME@@d(1).
1593 1637
1594Default 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).
1595 1649
1596=item B<HOME> 1650=item B<HOME>
1597 1651
1598Used to locate the default directory for the unix domain socket for 1652Used to locate the default directory for the unix domain socket for
1599daemon communications and to locate various resource files (such as 1653daemon communications and to locate various resource files (such as
1600C<.Xdefaults>) 1654C<.Xdefaults>)
1601 1655
1602=item B<XAPPLRESDIR> 1656=item B<XAPPLRESDIR>
1603 1657
1604Directory where various X resource files are being located. 1658Directory where application-specific X resource files are located.
1605 1659
1606=item B<XENVIRONMENT> 1660=item B<XENVIRONMENT>
1607 1661
1608If 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
1609@@RXVT_NAME@@. 1663@@RXVT_NAME@@.
… …
1614 1668
1615=over 4 1669=over 4
1616 1670
1617=item B</usr/lib/X11/rgb.txt> 1671=item B</usr/lib/X11/rgb.txt>
1618 1672
1619Color names. 1673Colour names.
1620 1674
1621=back 1675=back
1622 1676
1623=head1 SEE ALSO 1677=head1 SEE ALSO
1624 1678
1679@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1625@@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)
1626 1681
1627=head1 CURRENT PROJECT COORDINATOR 1682=head1 CURRENT PROJECT COORDINATOR
1628 1683
1629=over 4 1684=over 4
1630 1685
… …
1675 1730
1676Project Coordinator (Changes 1.0 -) 1731Project Coordinator (Changes 1.0 -)
1677 1732
1678=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1733=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1679 1734
1680Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1735pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1681 1736
1682=back 1737=back
1683 1738

Diff Legend

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