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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines