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.241 by root, Wed Dec 17 15:22:10 2014 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
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
111=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
112 118
113Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
114 120
115=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 128
123=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
124 130
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn 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 132
137=item B<-fade> I<number> 133=item B<-fade> I<number>
138 134
139Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
143=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
144 140
145Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
147 143
148=item B<-tint> I<colour> 144=item B<-icon> I<file>
149 145
150Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
151transparency is enabled with B<-tr>. This only works for 147is used by many window managers, taskbars and pagers to represent the
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application 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 149
187=item B<-bg> I<colour> 150=item B<-bg> I<colour>
188 151
189Window background colour; resource B<background>. 152Window background colour; resource B<background>.
190 153
191=item B<-fg> I<colour> 154=item B<-fg> I<colour>
192 155
193Window foreground colour; resource B<foreground>. 156Window 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 157
202=item B<-cr> I<colour> 158=item B<-cr> I<colour>
203 159
204The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
205 161
264 220
265=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
266 222
267Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
268 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
269=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
270 230
271Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
272B<utmpInhibit>. 232B<utmpInhibit>.
273 233
315 275
316=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
317 277
318Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
319 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
320=item B<-iconic> 284=item B<-iconic>
321 285
322Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 287Alternative form is B<-ic>.
324 288
340 304
341=item B<-bl> 305=item B<-bl>
342 306
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile 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 308if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
346 311
347=item B<-override-redirect> 312=item B<-override-redirect>
348 313
349Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
351 321
352=item B<-sbg> 322=item B<-sbg>
353 323
354Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
355drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
359=item B<-lsp> I<number> 329=item B<-lsp> I<number>
360 330
361Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
363B<lineSpace>. 333B<lineSpace>.
334
335=item B<-letsp> I<number>
336
337Compile I<frills>: Amount to adjust the computed character width by
338to control overall letter spacing. Negative values will tighten up the
339letter spacing, positive values will space letters out more. Useful to
340work around odd font metrics; resource B<letterSpace>.
364 341
365=item B<-tn> I<termname> 342=item B<-tn> I<termname>
366 343
367This option specifies the name of the terminal type to be set in the 344This option specifies the name of the terminal type to be set in the
368B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
553You can set and change the resources using X11 tools like B<xrdb>. Many 530You 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 531distribution do also load settings from the B<~/.Xresources> file when X
555starts. @@RXVT_NAME@@ will consult the following files/resources in order, 532starts. @@RXVT_NAME@@ will consult the following files/resources in order,
556with later settings overwriting earlier ones: 533with later settings overwriting earlier ones:
557 534
558 1. system-wide app-defaults file, either locale-dependent OR global
559 2. app-defaults file in $XAPPLRESDIR 535 1. app-defaults file in $XAPPLRESDIR
536 2. $HOME/.Xdefaults
560 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 537 3. RESOURCE_MANAGER property on root-window of screen 0
561 4. SCREEN_RESOURCES for the current screen 538 4. SCREEN_RESOURCES property on root-window of the current screen
562 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 539 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
563 6. resources specified via -xrm on the commandline 540 6. resources specified via -xrm on the commandline
564 541
565Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 542Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
566names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 543names: 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 584Use the specified colour for the colour value I<n>, where 0-7
608corresponds to low-intensity (normal) colours and 8-15 corresponds to 585corresponds to low-intensity (normal) colours and 8-15 corresponds to
609high-intensity (bold = bright foreground, blink = bright background) 586high-intensity (bold = bright foreground, blink = bright background)
610colours. The canonical names are as follows: 0=black, 1=red, 2=green, 587colours. 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 5883=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
612names used are listed in the B<COLORS AND GRAPHICS> section. 589names used are listed in the B<COLOURS AND GRAPHICS> section.
613 590
614Colours higher than 15 cannot be set using resources (yet), but can be 591Colours higher than 15 cannot be set using resources (yet), but can be
615changed using an escape command (see @@RXVT_NAME@@(7)). 592changed using an escape command (see @@RXVT_NAME@@(7)).
616 593
617Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 594Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
628=item B<colorUL:> I<colour> 605=item B<colorUL:> I<colour>
629 606
630Use the specified colour to display underlined characters when the 607Use the specified colour to display underlined characters when the
631foreground colour is the default. 608foreground colour is the default.
632 609
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> 610=item B<underlineColor:> I<colour>
639 611
640If set, use the specified colour as the colour for the underline 612If set, use the specified colour as the colour for the underline
641itself. If unset, use the foreground colour. 613itself. If unset, use the foreground colour.
614
615=item B<highlightColor:> I<colour>
616
617If set, use the specified colour as the background for highlighted
618characters. If unset, use reverse video.
619
620=item B<highlightTextColor:> I<colour>
621
622If set and highlightColor is set, use the specified colour as the
623foreground for highlighted characters.
642 624
643=item B<cursorColor:> I<colour> 625=item B<cursorColor:> I<colour>
644 626
645Use the specified colour for the cursor. The default is to use the 627Use the specified colour for the cursor. The default is to use the
646foreground colour; option B<-cr>. 628foreground colour; option B<-cr>.
653 635
654=item B<reverseVideo:> I<boolean> 636=item B<reverseVideo:> I<boolean>
655 637
656B<True>: simulate reverse video by foreground and background colours; 638B<True>: simulate reverse video by foreground and background colours;
657option B<-rv>. B<False>: regular screen colours [default]; option 639option B<-rv>. B<False>: regular screen colours [default]; option
658B<+rv>. See note in B<COLORS AND GRAPHICS> section. 640B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
659 641
660=item B<jumpScroll:> I<boolean> 642=item B<jumpScroll:> I<boolean>
661 643
662B<True>: specify that jump scrolling should be used. When receiving lots 644B<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 645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
677 659
678B<False>: specify that everything is to be displayed, even 660B<False>: specify that everything is to be displayed, even
679if the refresh is too fast for the human eye to read anything (or the 661if the refresh is too fast for the human eye to read anything (or the
680monitor to display anything); option B<+ss>. 662monitor to display anything); option B<+ss>.
681 663
682=item B<transparent:> I<boolean>
683
684Turn on/off illusion of a transparent window background.
685
686B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
687future versions.
688
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> 664=item B<fading:> I<number>
693 665
694Fade the text by the given percentage when focus is lost; option B<-fade>. 666Fade the text by the given percentage when focus is lost; option B<-fade>.
695 667
696=item B<fadeColor:> I<colour> 668=item B<fadeColor:> I<colour>
697 669
698Fade to this colour, when fading is used (see B<fading:>). The default 670Fade to this colour, when fading is used (see B<fading:>). The default
699colour is black; option B<-fadecolor>. 671colour is black; option B<-fadecolor>.
700 672
701=item B<tintColor:> I<colour> 673=item B<iconFile:> I<file>
702 674
703Tint the transparent background pixmap with the given colour; option 675Set the application icon pixmap; option B<-icon>.
704B<-tint>.
705
706=item B<shading:> I<number>
707
708Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
709in addition to tinting it; option B<-sh>.
710
711=item B<blendType:> I<string>
712
713Specify background blending type; option B<-blt>.
714
715=item B<blurRadius:> I<number>
716
717Apply Gaussian Blurr with the specified radius to the transparent
718background image; option B<-blr>.
719 676
720=item B<scrollColor:> I<colour> 677=item B<scrollColor:> I<colour>
721 678
722Use the specified colour for the scrollbar [default #B2B2B2]. 679Use the specified colour for the scrollbar [default #B2B2B2].
723 680
728 685
729=item B<borderColor:> I<colour> 686=item B<borderColor:> I<colour>
730 687
731The colour of the border around the text area and between the scrollbar 688The colour of the border around the text area and between the scrollbar
732and the text. 689and the text.
733
734=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
735
736Use the specified image file for the background and also
737optionally specify its scaling with a geometry string B<WxH+X+Y>,
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:
746
747 tile force background image to be tiled and not scaled. Equivalent to 0x0
748 propscale will scale image keeping proportions
749 auto will scale image to match window size. Equivalent to 100x100
750 hscale will scale image horizontally to the window size
751 vscale will scale image vertically to the window size
752 scale will scale image to match window size
753 root will tile image as if it was a root window background, auto-adjusting
754 whenever terminal window moves
755
756If used in conjunction with B<-tr> option, the specified pixmap will be
757blended over transparency image using either alpha-blending, or any
758other blending type, specified with B<-blt "type"> option.
759
760=item B<path:> I<path>
761
762Specify the colon-delimited search path for finding background image files.
763 690
764=item B<font:> I<fontlist> 691=item B<font:> I<fontlist>
765 692
766Select the fonts to be used. This is a comma separated list of font names 693Select the fonts to be used. This is a comma separated list of font names
767that are checked in order when trying to find glyphs for characters. The 694that are checked in order when trying to find glyphs for characters. The
790it is named first) and thus defines the character cell grid to be 9 pixels 717it is named first) and thus defines the character cell grid to be 9 pixels
791wide and 15 pixels high. 718wide and 15 pixels high.
792 719
793The second font is just used to add additional unicode characters not in 720The second font is just used to add additional unicode characters not in
794the base font, likewise the third, which is unfortunately non-bold, but 721the 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 722the bold version of the font does contain fewer characters, so this is a
796useful supplement. 723useful supplement.
797 724
798The third font is an Xft font with aliasing turned off, and the characters 725The 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 726are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
800contains other characters, but we are not interested in them. 727contains other characters, but we are not interested in them.
851=item B<urgentOnBell:> I<boolean> 778=item B<urgentOnBell:> I<boolean>
852 779
853B<True>: set the urgency hint for the wm on receipt of a bell character. 780B<True>: set the urgency hint for the wm on receipt of a bell character.
854B<False>: do not set the urgency hint [default]. 781B<False>: do not set the urgency hint [default].
855 782
783@@RXVT_NAME@@ resets the urgency hint on every focus change.
784
856=item B<visualBell:> I<boolean> 785=item B<visualBell:> I<boolean>
857 786
858B<True>: use visual bell on receipt of a bell character; option B<-vb>. 787B<True>: use visual bell on receipt of a bell character; option B<-vb>.
859B<False>: no visual bell [default]; option B<+vb>. 788B<False>: no visual bell [default]; option B<+vb>.
860 789
862 791
863B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 792B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
864the shell; option B<-ls>. B<False>: start as a normal sub-shell 793the shell; option B<-ls>. B<False>: start as a normal sub-shell
865[default]; option B<+ls>. 794[default]; option B<+ls>.
866 795
796=item B<multiClickTime:> I<number>
797
798Specify the maximum time in milliseconds between multi-click select
799events. The default is 500 milliseconds; option B<-mc>.
800
867=item B<utmpInhibit:> I<boolean> 801=item B<utmpInhibit:> I<boolean>
868 802
869B<True>: inhibit writing record into the system log file B<utmp>; 803B<True>: inhibit writing record into the system log file B<utmp>;
870option B<-ut>. B<False>: write record into the system log file B<utmp> 804option B<-ut>. B<False>: write record into the system log file B<utmp>
871[default]; option B<+ut>. 805[default]; option B<+ut>.
888=item B<scrollstyle:> I<mode> 822=item B<scrollstyle:> I<mode>
889 823
890Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 824Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
891the author's favourite. 825the author's favourite.
892 826
827=item B<thickness:> I<number>
828
829Set the scrollbar width in pixels.
830
893=item B<scrollBar:> I<boolean> 831=item B<scrollBar:> I<boolean>
894 832
895B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 833B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
896disable the scrollbar; option B<+sb>. 834disable the scrollbar; option B<+sb>.
897 835
916B<False>: do not scroll to bottom when tty receives output; option 854B<False>: do not scroll to bottom when tty receives output; option
917B<+si>. 855B<+si>.
918 856
919=item B<scrollWithBuffer:> I<boolean> 857=item B<scrollWithBuffer:> I<boolean>
920 858
921B<True>: scroll with scrollback buffer when tty receives new lines (and 859B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
922B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 860try to show the same lines) and B<scrollTtyOutput> is False; option
923with scrollback buffer when tty receives new lines; option B<+sw>. 861B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
862new lines; option B<+sw>.
924 863
925=item B<scrollTtyKeypress:> I<boolean> 864=item B<scrollTtyKeypress:> I<boolean>
926 865
927B<True>: scroll to bottom when a non-special key is pressed. Special keys 866B<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 867are those which are intercepted by rxvt-unicode for special handling and
984=item B<cursorBlink:> I<boolean> 923=item B<cursorBlink:> I<boolean>
985 924
986B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 925B<True>: blink the cursor. B<False>: do not blink the cursor [default];
987option B<-bc>. 926option B<-bc>.
988 927
928=item B<cursorUnderline:> I<boolean>
929
930B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
931option B<-uc>.
932
989=item B<pointerBlank:> I<boolean> 933=item B<pointerBlank:> I<boolean>
990 934
991B<True>: blank the pointer when a key is pressed or after a set number 935B<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 936of seconds of inactivity. B<False>: the pointer is always visible
993[default]. 937[default].
1006large number (e.g. C<987654321>) to effectively disable the timeout. 950large number (e.g. C<987654321>) to effectively disable the timeout.
1007 951
1008=item B<backspacekey:> I<string> 952=item B<backspacekey:> I<string>
1009 953
1010The string to send when the backspace key is pressed. If set to B<DEC> 954The 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> 955or 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 956(code 8) - which can be reversed with the appropriate DEC private mode
1013escape sequence. 957escape sequence.
1014 958
1015=item B<deletekey:> I<string> 959=item B<deletekey:> I<string>
1016 960
1112Sets the working directory for the shell (or the command specified via 1056Sets the working directory for the shell (or the command specified via
1113B<-e>). The I<path> must be an absolute path and it must exist for 1057B<-e>). The I<path> must be an absolute path and it must exist for
1114@@RXVT_NAME@@ to start. If it isn't specified then the current working 1058@@RXVT_NAME@@ to start. If it isn't specified then the current working
1115directory will be used; option B<-cd>. 1059directory will be used; option B<-cd>.
1116 1060
1117=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<action>
1118 1062
1119Compile I<frills>: Associate I<string> with keysym I<sym>. The 1063Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1120intervening resource name B<keysym.> cannot be omitted. 1064resource name B<keysym.> cannot be omitted.
1121 1065
1122The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1066Using this resource, you can map key combinations such as
1123any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1067C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1124B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1068string than would normally result from that combination, making the
1125and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1069terminal scroll up or down the way you want it, or any other thing an
1126B<2>, B<3>, B<4>, B<5>. 1070extension might provide.
1071
1072The key combination that triggers the action, I<sym>, has the following format:
1073
1074 (modifiers-)key
1075
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1077B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1079B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1127 1080
1128The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1081The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1129whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1082whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1130keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1083keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1131current application keymap mode state. 1084current application keymap mode state.
1132 1085
1133The spellings of I<key> can be obtained by using B<xev>(1) command or 1086Due the the large number of modifier combinations, a key mapping will
1134searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1087match if I<at least> the specified identifiers are being set, and no other
1088key mappings with those and more bits are being defined. That means that
1089defining a mapping for C<a> will automatically provide definitions for
1090C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1091themselves. See the C<builtin:> action, below, for a way to work around
1092this when this is a problem.
1093
1094The spelling of I<key> depends on your implementation of X. An easy way to
1095find a key name is to use the B<xev>(1) command. You can find a list by
1096looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1135omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1097the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1136keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1098value (B<0x0000 - 0xFFFF>).
1137performed in an exact manner; however, the closest match is assured.
1138 1099
1139I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1100As with any resource value, the I<action> string may contain backslash
1101escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1140number), see RESOURCES in C<man 7 X> for futher details. 1102number), see RESOURCES in C<man 7 X> for further details.
1141 1103
1142You can define a range of keysyms in one shot by providing a I<string> 1104An action starts with an action prefix that selects a certain type
1143with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1105of action, followed by a colon. An action string without colons is
1106interpreted as a literal string to pass to the tty (as if it was
1107prefixed with C<string:>).
1108
1109The following action prefixes are known - extensions can provide
1110additional prefixes:
1111
1112=over 4
1113
1114=item string:STRING
1115
1116If the I<action> starts with C<string:> (or otherwise contains no colons),
1117then the remaining C<STRING> will be passed to the program running in the
1118terminal. For example, you could replace whatever Shift-Tab outputs by the
1119string C<echo rm -rf /> followed by a newline:
1120
1121 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1122
1123This could in theory be used to completely redefine your keymap.
1124
1125In addition, for actions of this type, you can define a range of
1126keysyms in one shot by loading the C<keysym-list> perl extension and
1127providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1144should be a character not used by the strings. 1128the delimiter `/' should be a character not used by the strings.
1145 1129
1146Its usage can be demonstrated by an example: 1130Its usage can be demonstrated by an example:
1147 1131
1148 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1132 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1149 1133
1150The above line is equivalent to the following three lines: 1134The above line is equivalent to the following three lines:
1151 1135
1152 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1136 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1153 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1137 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1154 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1138 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1155 1139
1140=item command:STRING
1141
1156If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1142If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1157is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1143is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1144the opposite of C<string:> - instead of sending it to the program running
1145in the terminal, it will be treated as if it were program output). This is
1146most useful to feed command sequences into @@RXVT_NAME@@.
1147
1158example the following means "change the current locale to C<zh_CN.GBK> 1148For example the following means "change the current locale to C<zh_CN.GBK>
1159when Control-Meta-c is being pressed": 1149when Control-Meta-c is being pressed":
1160 1150
1161 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1151 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1162 1152
1163If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1153The following example will map Control-Meta-1 and Control-Meta-2 to
1164is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1154the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1165manpage. For example, the F<selection> extension (activated via 1155font-switching at runtime:
1166C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1167 1156
1168 URxvt.keysym.M-C-c: perl:selection:rot13 1157 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1158 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1169 1159
1170Due the the large number of modifier combinations, a defined key mapping 1160Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1171will match if at I<at least> the specified identifiers are being set, and 1161info):
1172no other key mappings with those and more bits are being defined. That
1173means 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
1175mappings themselves.
1176 1162
1177Unfortunately, this will override built-in key mappings. For example 1163 URxvt.keysym.M-C-3: command:\033[8;25;80t
1164 URxvt.keysym.M-C-4: command:\033[8;48;110t
1165
1166=item builtin:
1167
1168The builtin action is the action that @@RXVT_NAME@@ would execute if no
1169key binding existed for the key combination. The obvious use is to undo
1170the effect of existing bindings. The not so obvious use is to reinstate
1171bindings when another binding overrides too many modifiers.
1172
1178if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1173For example if you overwrite the C<Insert> key you will disable
1179C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1174@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1180user-defined keymap using the C<builtin:> replacement: 1175"holes" into the user-defined keymap using the C<builtin:> replacement:
1181 1176
1182 URxvt.keysym.Insert: <my insert key sequence> 1177 URxvt.keysym.Insert: <my insert key sequence>
1183 URxvt.keysym.S-Insert: builtin: 1178 URxvt.keysym.S-Insert: builtin:
1184 1179
1185The first line defines a mapping for C<Insert> and I<any> combination 1180The first line defines a mapping for C<Insert> and I<any> combination
1186of modifiers. The second line re-establishes the default mapping for 1181of modifiers. The second line re-establishes the default mapping for
1187C<Shift-Insert>. 1182C<Shift-Insert>.
1188 1183
1189The following example will map Control-Meta-1 and Control-Meta-2 to 1184=item builtin-string:
1190the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1191font-switching at runtime:
1192 1185
1193 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1186This action is mainly useful to restore string mappings for keys that
1194 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1187have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1188difficult to explain - basically, this action will send the string to the
1189application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1190action for it.
1195 1191
1196Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1192An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1197info): 1193selection when you press C<Shift-Insert>. With the following bindings, it
1194would instead emit the (undocumented, but what applications running in the
1195terminal might expect) sequence C<ESC [ 2 $> instead:
1198 1196
1199 URxvt.keysym.M-C-3: command:\033[8;25;80t 1197 URxvt.keysym.S-Insert: builtin-string:
1200 URxvt.keysym.M-C-4: command:\033[8;48;110t 1198 URxvt.keysym.C-S-Insert: builtin:
1199
1200The first line disables the paste functionality for that key
1201combination, and the second reinstates the default behaviour for
1202C<Control-Shift-Insert>, which would otherwise be overridden.
1203
1204Similarly, to let applications gain access to the C<C-M-c> (copy to
1205clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1206this:
1207
1208 URxvt.keysym.C-M-c: builtin-string:
1209 URxvt.keysym.C-M-v: builtin-string:
1210
1211=item EXTENSION:STRING
1212
1213An action of this form invokes the action B<STRING>, if any, provided
1214by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1215be loaded automatically if necessary.
1216
1217Not all extensions define actions, but popular extensions that do
1218include the I<selection> and I<matcher> extensions (documented in their
1219own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1220respectively).
1221
1222From the silly examples department, this will rot13-"encrypt"
1223@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1224keyboards:
1225
1226 URxvt.keysym.M-C-c: selection:rot13
1227
1228=item perl:STRING *DEPRECATED*
1229
1230This is a deprecated way of invoking commands provided by perl
1231extensions. It is still supported, but should not be used anymore.
1232
1233=back
1201 1234
1202=item B<perl-ext-common>: I<string> 1235=item B<perl-ext-common>: I<string>
1203 1236
1204=item B<perl-ext>: I<string> 1237=item B<perl-ext>: I<string>
1205 1238
1207use in this terminal instance; option B<-pe>. 1240use in this terminal instance; option B<-pe>.
1208 1241
1209Extension names can be prefixed with a C<-> sign to prohibit using 1242Extension names can be prefixed with a C<-> sign to prohibit using
1210them. This can be useful to selectively disable some extensions loaded 1243them. This can be useful to selectively disable some extensions loaded
1211by default, or specified via the C<perl-ext-common> resource. For 1244by default, or specified via the C<perl-ext-common> resource. For
1212example, C<default,-selection> will use all the default extension except 1245example, C<default,-selection> will use all the default extensions except
1213C<selection>. 1246C<selection>.
1214 1247
1215Extension names can also be followed by an argument in angle brackets 1248The default set includes the C<selection>, C<option-popup>,
1216(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1249C<selection-popup> and C<readline> extensions, any extensions that
1217searchable scrollback to Alt/Meta-s). Mentioning the same extension 1250define keybindings via C<BINDING> meta comments, and extensions which
1218multiple times with different arguments will pass multiple arguments to 1251are mentioned in B<keysym> resources.
1219the extension. 1252
1253Any extension such that a corresponding resource is given on the
1254command line is automatically appended to B<perl-ext>.
1220 1255
1221Each extension is looked up in the library directories, loaded if 1256Each extension is looked up in the library directories, loaded if
1222necessary, and bound to the current terminal instance. 1257necessary, and bound to the current terminal instance. When the library
1258search path contains multiple extension files of the same name, then the
1259first one found will be used.
1223 1260
1224If both of these resources are the empty string, then the perl 1261If both of these resources are the empty string, then the perl interpreter
1225interpreter will not be initialized. The idea behind two options is that 1262will not be initialized. The rationale for having two options is that
1226B<perl-ext-common> will be used for extensions that should be available to 1263B<perl-ext-common> will be used for extensions that should be available to
1227all instances, while B<perl-ext> is used for specific instances. 1264all instances, while B<perl-ext> is used for specific instances.
1228 1265
1229=item B<perl-eval>: I<string> 1266=item B<perl-eval>: I<string>
1230 1267
1231Perl code to be evaluated when all extensions have been registered. See 1268Perl code to be evaluated when all extensions have been registered. See
1232the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1269the @@RXVT_NAME@@perl(3) manpage.
1233will be ignored when running setuid/setgid.
1234 1270
1235=item B<perl-lib>: I<path> 1271=item B<perl-lib>: I<path>
1236 1272
1237Colon-separated list of additional directories that hold extension 1273Colon-separated list of additional directories that hold extension
1238scripts. When looking for extensions specified by the C<perl> resource, 1274scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1239@@RXVT_NAME@@ will first look in these directories and then in 1275in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1240F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1276lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1241will be ignored when running setuid/setgid.
1242 1277
1243See the @@RXVT_NAME@@perl(3) manpage. 1278See the @@RXVT_NAME@@perl(3) manpage.
1244 1279
1245=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1280=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1246 1281
1250=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1285=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1251 1286
1252Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1287Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1253for details. 1288for details.
1254 1289
1255=item B<searchable-scrollback:> I<keysym> 1290=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1256 1291
1257Sets the hotkey that starts the incremental scrollback buffer search 1292This resource is deprecated and will be removed. Use a B<keysym> resource
1258(default: C<M-s>). 1293instead, e.g.:
1259 1294
1295 URxvt.keysym.M-s: searchable-scrollback:start
1296
1260=item B<urlLauncher>: I<string> 1297=item B<url-launcher>: I<string>
1261 1298
1262Specifies the program to be started with a URL argument. Used by the 1299Specifies the program to be started with a URL argument. Used by the
1263C<selection-popup> and C<matcher> perl extensions. 1300C<selection-popup> and C<matcher> perl extensions.
1264 1301
1265=item B<transient-for>: I<windowid> 1302=item B<transient-for>: I<windowid>
1269=item B<override-redirect>: I<boolean> 1306=item B<override-redirect>: I<boolean>
1270 1307
1271Compile I<frills>: Sets override-redirect for the terminal window, making 1308Compile I<frills>: Sets override-redirect for the terminal window, making
1272it almost invisible to window managers; option B<-override-redirect>. 1309it almost invisible to window managers; option B<-override-redirect>.
1273 1310
1311=item B<iso14755:> I<boolean>
1312
1313Turn on/off ISO 14755 (default enabled).
1314
1274=item B<iso14755_52:> I<boolean> 1315=item B<iso14755_52:> I<boolean>
1275 1316
1276Turn on/off ISO 14755 5.2 mode (default enabled). 1317Turn on/off ISO 14755 5.2 mode (default enabled).
1318
1319=back
1320
1321=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1322
1323=over 4
1324
1325=item B<-pixmap> I<file[;oplist]>
1326
1327=item B<backgroundPixmap:> I<file[;oplist]>
1328
1329Compile I<pixbuf>: Use the specified image file as the window's
1330background and also optionally specify a colon separated list of
1331operations to modify it. Note that you may need to quote the C<;>
1332character when using the command line option, as C<;> is usually a
1333metacharacter in shells. Supported operations are:
1334
1335=over 4
1336
1337=item B<WxH+X+Y>
1338
1339sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1340scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1341scale of 0 disables scaling.
1342
1343=item B<op=tile>
1344
1345enables tiling
1346
1347=item B<op=keep-aspect>
1348
1349maintain the image aspect ratio when scaling
1350
1351=item B<op=root-align>
1352
1353use the position of the terminal window relative to the root window as
1354the image offset, simulating a root window background
1355
1356=back
1357
1358The default scale and position setting is C<100x100+50+50>.
1359Alternatively, a predefined set of templates can be used to achieve
1360the most common setups:
1361
1362=over 4
1363
1364=item B<style=tiled>
1365
1366the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1367
1368=item B<style=aspect-stretched>
1369
1370the image is scaled to fill the whole window maintaining the aspect
1371ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1372
1373=item B<style=stretched>
1374
1375the image is scaled to fill the whole window. Equivalent to 100x100
1376
1377=item B<style=centered>
1378
1379the image is centered with no scaling. Equivalent to 0x0+50+50
1380
1381=item B<style=root-tiled>
1382
1383the image is tiled with no scaling and using 'root' positioning.
1384Equivalent to 0x0:op=tile:op=root-align
1385
1386=back
1387
1388If multiple templates are specified the last one wins. Note that a
1389template overrides all the scale, position and operations settings.
1390
1391If used in conjunction with pseudo-transparency, the specified pixmap
1392will be blended over the transparent background using alpha-blending.
1393
1394=item B<-tr>|B<+tr>
1395
1396=item B<transparent:> I<boolean>
1397
1398Turn on/off pseudo-transparency by using the root pixmap as background.
1399
1400B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1401will be removed in future versions.
1402
1403=item B<-tint> I<colour>
1404
1405=item B<tintColor:> I<colour>
1406
1407Tint the transparent background with the given colour. Note that a
1408black tint yields a completely black image while a white tint yields
1409the image unchanged.
1410
1411=item B<-sh> I<number>
1412
1413=item B<shading:> I<number>
1414
1415Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1416A value of 100 means no shading.
1417
1418=item B<-blr> I<HxV>
1419
1420=item B<blurRadius:> I<HxV>
1421
1422Apply gaussian blur with the specified radius to the transparent
1423background. If a single number is specified, the vertical and
1424horizontal radii are considered to be the same. Setting one of the
1425radii to 1 and the other to a large number creates interesting effects
1426on some backgrounds. The maximum radius value is 128. An horizontal or
1427vertical radius of 0 disables blurring.
1428
1429=item B<path:> I<path>
1430
1431Specify the colon-delimited search path for finding background image files.
1277 1432
1278=back 1433=back
1279 1434
1280=head1 THE SCROLLBAR 1435=head1 THE SCROLLBAR
1281 1436
1329window causes the value of the PRIMARY selection (or CLIPBOARD with the 1484window causes the value of the PRIMARY selection (or CLIPBOARD with the
1330B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1485B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1331 1486
1332Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1487Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1333inserted too. 1488inserted too.
1489
1490rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1491<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1492binding causes the value of the internal selection to be copied to the
1493CLIPBOARD selection, while the second binding causes the value of the
1494CLIPBOARD selection to be inserted.
1334 1495
1335=back 1496=back
1336 1497
1337=head1 CHANGING FONTS 1498=head1 CHANGING FONTS
1338 1499
1420B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1581B<@@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 1582it 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 1583allow 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. 1584on some systems or setgid to root or to some other group on others.
1424 1585
1425=head1 COLORS AND GRAPHICS 1586=head1 COLOURS AND GRAPHICS
1426 1587
1427In addition to the default foreground and background colours, 1588In addition to the default foreground and background colours,
1428B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1589B<@@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 1590high-intensity (potentially bold/blink) versions of the same, and 72 (or
1430colours with their names. 1591240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1592cube plus a 8 (24) colour greyscale ramp.
1593
1594Here is a list of the ANSI colours with their names.
1431 1595
1432=begin table 1596=begin table
1433 1597
1434 B<color0> (black) = Black 1598 B<color0> (black) = Black
1435 B<color1> (red) = Red3 1599 B<color1> (red) = Red3
1455It is also possible to specify the colour values of B<foreground>, 1619It is also possible to specify the colour values of B<foreground>,
1456B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1620B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1457a number 0-15, as a convenient shorthand to reference the colour name of 1621a number 0-15, as a convenient shorthand to reference the colour name of
1458color0-color15. 1622color0-color15.
1459 1623
1460In addition to the colours defined above, @@RXVT_NAME@@ offers an 1624The following text gives values for the standard 88 colour mode (and
1461additional 72 colours. The first 64 of those (with indices 16 to 79) 1625values 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 1626
1627The RGB cube uses indices 16..79 (16..231) using the following formulas:
1628
1629 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1630 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1631
1632The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1633steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1634the RGB cube.
1635
1465Together, all those colours implement the 88 colour xterm colours. Only 1636Together, all those colours implement the 88 (256) colour xterm
1466the first 16 can be changed using resources currently, the rest can only 1637colours. Only the first 16 can be changed using resources currently, the
1467be changed via command sequences ("escape codes"). 1638rest can only be changed via command sequences ("escape codes").
1639
1640Applications are advised to use terminfo or command sequences to discover
1641number and RGB values of all colours (yes, you can query this...).
1468 1642
1469Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1643Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1470always swapping the foreground/background colours. This is in contrast to 1644always swapping the foreground/background colours. This is in contrast to
1471I<xterm>(1) where the colours are only swapped if they have not otherwise 1645I<xterm>(1) where the colours are only swapped if they have not otherwise
1472been specified. For example, 1646been specified. For example,
1473 1647
1474=over 4
1475
1476=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1648 @@RXVT_NAME@@ -fg Black -bg White -rv
1477 1649
1478would yield White on Black, while on I<xterm>(1) it would yield Black 1650would yield White on Black, while on I<xterm>(1) it would yield Black on
1479on White. 1651White.
1480
1481=back
1482 1652
1483=head2 ALPHA CHANNEL SUPPORT 1653=head2 ALPHA CHANNEL SUPPORT
1484 1654
1485If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1655If 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: 1656their act together, rxvt-unicode will do its own alpha channel management:
1487 1657
1488You can prefix any color with an opaquenes percentage enclosed in 1658You can prefix any colour with an opaqueness percentage enclosed in
1489brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1659brackets, 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 1660(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 1661transparent 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 1662half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1493is the recommended format to specify transparency values, and works with 1663is the recommended format to specify transparency values, and works with
1494all ways to specify a colour. 1664all ways to specify a colour.
1495 1665
1573 1743
1574=item B<SHELL> 1744=item B<SHELL>
1575 1745
1576The shell to be used for command execution, defaults to C</bin/sh>. 1746The shell to be used for command execution, defaults to C</bin/sh>.
1577 1747
1578=item B<RXVT_SOCKET> 1748=item B<RXVT_SOCKET> [I<sic>]
1579 1749
1580The unix domain socket path used by @@RXVT_NAME@@c(1) and 1750The unix domain socket path used by @@RXVT_NAME@@c(1) and
1581@@RXVT_NAME@@d(1). 1751@@RXVT_NAME@@d(1).
1582 1752
1583Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1753Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1754
1755=item B<URXVT_PERL_LIB>
1756
1757Additional F<:>-separated library search path for perl extensions. Will be
1758searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1759directory.
1760
1761=item B<URXVT_PERL_VERBOSITY>
1762
1763See L<@@RXVT_NAME@@perl>(3).
1584 1764
1585=item B<HOME> 1765=item B<HOME>
1586 1766
1587Used to locate the default directory for the unix domain socket for 1767Used to locate the default directory for the unix domain socket for
1588daemon communications and to locate various resource files (such as 1768daemon communications and to locate various resource files (such as
1589C<.Xdefaults>) 1769C<.Xdefaults>)
1590 1770
1591=item B<XAPPLRESDIR> 1771=item B<XAPPLRESDIR>
1592 1772
1593Directory where various X resource files are being located. 1773Directory where application-specific X resource files are located.
1594 1774
1595=item B<XENVIRONMENT> 1775=item B<XENVIRONMENT>
1596 1776
1597If set and accessible, gives the name of a X resource file to be loaded by 1777If set and accessible, gives the name of a X resource file to be loaded by
1598@@RXVT_NAME@@. 1778@@RXVT_NAME@@.
1603 1783
1604=over 4 1784=over 4
1605 1785
1606=item B</usr/lib/X11/rgb.txt> 1786=item B</usr/lib/X11/rgb.txt>
1607 1787
1608Color names. 1788Colour names.
1609 1789
1610=back 1790=back
1611 1791
1612=head1 SEE ALSO 1792=head1 SEE ALSO
1613 1793
1794@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1614@@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) 1795@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1615 1796
1616=head1 CURRENT PROJECT COORDINATOR 1797=head1 CURRENT PROJECT COORDINATOR
1617 1798
1618=over 4 1799=over 4
1619 1800
1620=item Project Coordinator 1801=item Project Coordinator
1621 1802
1622Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1803Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1623 1804
1624L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1805L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1625 1806
1626=back 1807=back
1627 1808
1631 1812
1632=item John Bovey 1813=item John Bovey
1633 1814
1634University of Kent, 1992, wrote the original Xvt. 1815University of Kent, 1992, wrote the original Xvt.
1635 1816
1636=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1817=item Rob Nation <nation@rocket.sanders.lockheed.com>
1637 1818
1638very heavily modified Xvt and came up with Rxvt 1819very heavily modified Xvt and came up with Rxvt
1639 1820
1640=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1821=item Angelo Haritsis <ah@doc.ic.ac.uk>
1641 1822
1642wrote the Greek Keyboard Input (no longer in code) 1823wrote the Greek Keyboard Input (no longer in code)
1643 1824
1644=item mj olesen L<< <olesen@me.QueensU.CA> >> 1825=item mj olesen <olesen@me.QueensU.CA>
1645 1826
1646Wrote the menu system. 1827Wrote the menu system.
1647 1828
1648Project Coordinator (changes.txt 2.11 to 2.21) 1829Project Coordinator (changes.txt 2.11 to 2.21)
1649 1830
1650=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1831=item Oezguer Kesim <kesim@math.fu-berlin.de>
1651 1832
1652Project Coordinator (changes.txt 2.21a to 2.4.5) 1833Project Coordinator (changes.txt 2.21a to 2.4.5)
1653 1834
1654=item Geoff Wing L<< <gcw@pobox.com> >> 1835=item Geoff Wing <gcw@pobox.com>
1655 1836
1656Rewrote screen display and text selection routines. 1837Rewrote screen display and text selection routines.
1657 1838
1658Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1839Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1659 1840
1660=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1841=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1661 1842
1662Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1843Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1663extension, random hacks, numerous bugfixes and extensions. 1844extension, random hacks, numerous bugfixes and extensions.
1664 1845
1665Project Coordinator (Changes 1.0 -) 1846Project Coordinator (Changes 1.0 -)
1666 1847
1667=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1848=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1668 1849
1669Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1850pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1670 1851
1671=back 1852=back
1672 1853

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines