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.170 by root, Sat May 30 08:51:23 2009 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>
149
150Tint the transparent background pixmap with the given colour when
151transparency is enabled with B<-tr>. This only works for
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file> 143=item B<-icon> I<file>
188 144
189Compile I<afterimage>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 147application window; resource I<iconFile>.
192 148
193=item B<-bg> I<colour> 149=item B<-bg> I<colour>
194 150
195Window background colour; resource B<background>. 151Window background colour; resource B<background>.
196 152
197=item B<-fg> I<colour> 153=item B<-fg> I<colour>
198 154
199Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203Compile I<afterimage>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>.
207 156
208=item B<-cr> I<colour> 157=item B<-cr> I<colour>
209 158
210The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
211 160
270 219
271=item B<-ls>|B<+ls> 220=item B<-ls>|B<+ls>
272 221
273Start as a login-shell/sub-shell; resource B<loginShell>. 222Start as a login-shell/sub-shell; resource B<loginShell>.
274 223
224=item B<-mc> I<milliseconds>
225
226Specify the maximum time between multi-click selections.
227
275=item B<-ut>|B<+ut> 228=item B<-ut>|B<+ut>
276 229
277Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 230Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
278B<utmpInhibit>. 231B<utmpInhibit>.
279 232
321 274
322=item B<-bc>|B<+bc> 275=item B<-bc>|B<+bc>
323 276
324Blink the cursor; resource B<cursorBlink>. 277Blink the cursor; resource B<cursorBlink>.
325 278
279=item B<-uc>|B<+uc>
280
281Make the cursor underlined; resource B<cursorUnderline>.
282
326=item B<-iconic> 283=item B<-iconic>
327 284
328Start iconified, if the window manager supports that option. 285Start iconified, if the window manager supports that option.
329Alternative form is B<-ic>. 286Alternative form is B<-ic>.
330 287
353 310
354=item B<-override-redirect> 311=item B<-override-redirect>
355 312
356Compile I<frills>: Sets override-redirect on the window; resource 313Compile I<frills>: Sets override-redirect on the window; resource
357B<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.
358 320
359=item B<-sbg> 321=item B<-sbg>
360 322
361Compile 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
362drawing characters and just rely on what the specified fonts provide. Use 324drawing characters and just rely on what the specified fonts provide. Use
567You 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
568distribution do also load settings from the B<~/.Xresources> file when X 530distribution do also load settings from the B<~/.Xresources> file when X
569starts. @@RXVT_NAME@@ will consult the following files/resources in order, 531starts. @@RXVT_NAME@@ will consult the following files/resources in order,
570with later settings overwriting earlier ones: 532with later settings overwriting earlier ones:
571 533
572 1. system-wide app-defaults file, either locale-dependent OR global
573 2. app-defaults file in $XAPPLRESDIR 534 1. app-defaults file in $XAPPLRESDIR
535 2. $HOME/.Xdefaults
574 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 536 3. RESOURCE_MANAGER property on root-window of screen 0
575 4. SCREEN_RESOURCES for the current screen 537 4. SCREEN_RESOURCES property on root-window of the current screen
576 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 538 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
577 6. resources specified via -xrm on the commandline 539 6. resources specified via -xrm on the commandline
578 540
579Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 541Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
580names: 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
621Use 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
622corresponds to low-intensity (normal) colours and 8-15 corresponds to 584corresponds to low-intensity (normal) colours and 8-15 corresponds to
623high-intensity (bold = bright foreground, blink = bright background) 585high-intensity (bold = bright foreground, blink = bright background)
624colours. 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,
6253=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
626names used are listed in the B<COLORS AND GRAPHICS> section. 588names used are listed in the B<COLOURS AND GRAPHICS> section.
627 589
628Colours 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
629changed using an escape command (see @@RXVT_NAME@@(7)). 591changed using an escape command (see @@RXVT_NAME@@(7)).
630 592
631Colours 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
642=item B<colorUL:> I<colour> 604=item B<colorUL:> I<colour>
643 605
644Use the specified colour to display underlined characters when the 606Use the specified colour to display underlined characters when the
645foreground colour is the default. 607foreground colour is the default.
646 608
647=item B<colorRV:> I<colour>
648
649Use the specified colour as the background for reverse video characters
650when OPTION_HC is disabled (--disable-frills).
651
652=item B<underlineColor:> I<colour> 609=item B<underlineColor:> I<colour>
653 610
654If set, use the specified colour as the colour for the underline 611If set, use the specified colour as the colour for the underline
655itself. 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.
656 623
657=item B<cursorColor:> I<colour> 624=item B<cursorColor:> I<colour>
658 625
659Use 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
660foreground colour; option B<-cr>. 627foreground colour; option B<-cr>.
667 634
668=item B<reverseVideo:> I<boolean> 635=item B<reverseVideo:> I<boolean>
669 636
670B<True>: simulate reverse video by foreground and background colours; 637B<True>: simulate reverse video by foreground and background colours;
671option B<-rv>. B<False>: regular screen colours [default]; option 638option B<-rv>. B<False>: regular screen colours [default]; option
672B<+rv>. See note in B<COLORS AND GRAPHICS> section. 639B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
673 640
674=item B<jumpScroll:> I<boolean> 641=item B<jumpScroll:> I<boolean>
675 642
676B<True>: specify that jump scrolling should be used. When receiving lots 643B<True>: specify that jump scrolling should be used. When receiving lots
677of 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
691 658
692B<False>: specify that everything is to be displayed, even 659B<False>: specify that everything is to be displayed, even
693if 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
694monitor to display anything); option B<+ss>. 661monitor to display anything); option B<+ss>.
695 662
696=item B<transparent:> I<boolean>
697
698Turn on/off illusion of a transparent window background.
699
700B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
701future versions.
702
703I<Please address all transparency related issues to Sasha Vasko at
704sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
705
706=item B<fading:> I<number> 663=item B<fading:> I<number>
707 664
708Fade 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>.
709 666
710=item B<fadeColor:> I<colour> 667=item B<fadeColor:> I<colour>
711 668
712Fade 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
713colour is black; option B<-fadecolor>. 670colour is black; option B<-fadecolor>.
714 671
715=item B<tintColor:> I<colour>
716
717Tint the transparent background pixmap with the given colour; option
718B<-tint>.
719
720=item B<shading:> I<number>
721
722Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
723in addition to tinting it; option B<-sh>.
724
725=item B<blendType:> I<string>
726
727Specify background blending type; option B<-blt>.
728
729=item B<blurRadius:> I<number>
730
731Apply gaussian blur with the specified radius to the transparent
732background image; option B<-blr>.
733
734=item B<iconFile:> I<file> 672=item B<iconFile:> I<file>
735 673
736Set the application icon pixmap; option B<-icon>. 674Set the application icon pixmap; option B<-icon>.
737 675
738=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
746 684
747=item B<borderColor:> I<colour> 685=item B<borderColor:> I<colour>
748 686
749The 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
750and the text. 688and the text.
751
752=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
753
754Use the specified image file for the background and also
755optionally specify its scaling with a geometry string B<WxH+X+Y>,
756(default C<0x0+50+50>) in which B<"W" / "H"> specify the
757horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
758centre (percent). A scale of 0 displays the image with tiling. A scale
759of 1 displays the image without any scaling. A scale of 2 to 9 specifies
760an integer number of images in that direction. No image will be magnified
761beyond 10 times its original size. The maximum permitted scale is 1000.
762Additional operations can be specified after colon B<:op1:op2...>.
763Supported operations are:
764
765 tile force background image to be tiled and not scaled. Equivalent to 0x0
766 propscale will scale image keeping proportions
767 auto will scale image to match window size. Equivalent to 100x100
768 hscale will scale image horizontally to the window size
769 vscale will scale image vertically to the window size
770 scale will scale image to match window size
771 root will tile image as if it was a root window background, auto-adjusting
772 whenever terminal window moves
773
774If used in conjunction with B<-tr> option, the specified pixmap will be
775blended over transparency image using either alpha-blending, or any
776other blending type, specified with B<-blt "type"> option.
777
778=item B<path:> I<path>
779
780Specify the colon-delimited search path for finding background image files.
781 689
782=item B<font:> I<fontlist> 690=item B<font:> I<fontlist>
783 691
784Select 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
785that 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
808it 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
809wide and 15 pixels high. 717wide and 15 pixels high.
810 718
811The 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
812the base font, likewise the third, which is unfortunately non-bold, but 720the base font, likewise the third, which is unfortunately non-bold, but
813the 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
814useful supplement. 722useful supplement.
815 723
816The 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
817are 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
818contains other characters, but we are not interested in them. 726contains other characters, but we are not interested in them.
882 790
883B<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
884the 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
885[default]; option B<+ls>. 793[default]; option B<+ls>.
886 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
887=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
888 801
889B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
890option 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>
891[default]; option B<+ut>. 804[default]; option B<+ut>.
908=item B<scrollstyle:> I<mode> 821=item B<scrollstyle:> I<mode>
909 822
910Set 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
911the author's favourite. 824the author's favourite.
912 825
826=item B<thickness:> I<number>
827
828Set the scrollbar width in pixels.
829
913=item B<scrollBar:> I<boolean> 830=item B<scrollBar:> I<boolean>
914 831
915B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 832B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
916disable the scrollbar; option B<+sb>. 833disable the scrollbar; option B<+sb>.
917 834
936B<False>: do not scroll to bottom when tty receives output; option 853B<False>: do not scroll to bottom when tty receives output; option
937B<+si>. 854B<+si>.
938 855
939=item B<scrollWithBuffer:> I<boolean> 856=item B<scrollWithBuffer:> I<boolean>
940 857
941B<True>: scroll with scrollback buffer when tty receives new lines (and 858B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
942B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 859try to show the same lines) and B<scrollTtyOutput> is False; option
943with 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>.
944 862
945=item B<scrollTtyKeypress:> I<boolean> 863=item B<scrollTtyKeypress:> I<boolean>
946 864
947B<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
948are those which are intercepted by rxvt-unicode for special handling and 866are those which are intercepted by rxvt-unicode for special handling and
1004=item B<cursorBlink:> I<boolean> 922=item B<cursorBlink:> I<boolean>
1005 923
1006B<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];
1007option B<-bc>. 925option B<-bc>.
1008 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
1009=item B<pointerBlank:> I<boolean> 932=item B<pointerBlank:> I<boolean>
1010 933
1011B<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
1012of seconds of inactivity. B<False>: the pointer is always visible 935of seconds of inactivity. B<False>: the pointer is always visible
1013[default]. 936[default].
1026large number (e.g. C<987654321>) to effectively disable the timeout. 949large number (e.g. C<987654321>) to effectively disable the timeout.
1027 950
1028=item B<backspacekey:> I<string> 951=item B<backspacekey:> I<string>
1029 952
1030The 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>
1031or 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>
1032(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
1033escape sequence. 956escape sequence.
1034 957
1035=item B<deletekey:> I<string> 958=item B<deletekey:> I<string>
1036 959
1132Sets the working directory for the shell (or the command specified via 1055Sets the working directory for the shell (or the command specified via
1133B<-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
1134@@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
1135directory will be used; option B<-cd>. 1058directory will be used; option B<-cd>.
1136 1059
1137=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
1138 1061
1139Compile I<frills>: Associate I<string> with keysym I<sym>. The 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1140intervening resource name B<keysym.> cannot be omitted. 1063resource name B<keysym.> cannot be omitted.
1141 1064
1142The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1065Using this resource, you can map key combinations such as
1143any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1066C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1144B<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
1145and 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
1146B<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>.
1147 1079
1148The 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
1149whatever 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
1150keys 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
1151current application keymap mode state. 1083current application keymap mode state.
1152 1084
1153The 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
1154searching 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
1155omitting 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
1156keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1097value (B<0x0000 - 0xFFFF>).
1157performed in an exact manner; however, the closest match is assured.
1158 1098
1159I<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
1160number), see RESOURCES in C<man 7 X> for futher details. 1101number), see RESOURCES in C<man 7 X> for further details.
1161 1102
1162You 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
1163with 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
1164should be a character not used by the strings. 1127the delimiter `/' should be a character not used by the strings.
1165 1128
1166Its usage can be demonstrated by an example: 1129Its usage can be demonstrated by an example:
1167 1130
1168 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1131 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1169 1132
1170The above line is equivalent to the following three lines: 1133The above line is equivalent to the following three lines:
1171 1134
1172 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1135 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1173 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1136 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1174 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1137 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1175 1138
1139=item command:STRING
1140
1176If 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>
1177is 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
1178example 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>
1179when Control-Meta-c is being pressed": 1148when Control-Meta-c is being pressed":
1180 1149
1181 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
1182 1151
1183If 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
1184is 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
1185manpage. For example, the F<selection> extension (activated via 1154font-switching at runtime:
1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187 1155
1188 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
1189 1158
1190Due the the large number of modifier combinations, a defined key mapping 1159Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1191will match if at I<at least> the specified identifiers are being set, and 1160info):
1192no other key mappings with those and more bits are being defined. That
1193means that defining a key map for C<a> will automatically provide
1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195mappings themselves.
1196 1161
1197Unfortunately, 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
1198if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1172For example if you overwrite the C<Insert> key you will disable
1199C<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
1200user-defined keymap using the C<builtin:> replacement: 1174"holes" into the user-defined keymap using the C<builtin:> replacement:
1201 1175
1202 URxvt.keysym.Insert: <my insert key sequence> 1176 URxvt.keysym.Insert: <my insert key sequence>
1203 URxvt.keysym.S-Insert: builtin: 1177 URxvt.keysym.S-Insert: builtin:
1204 1178
1205The 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
1206of modifiers. The second line re-establishes the default mapping for 1180of modifiers. The second line re-establishes the default mapping for
1207C<Shift-Insert>. 1181C<Shift-Insert>.
1208 1182
1209The following example will map Control-Meta-1 and Control-Meta-2 to 1183=item builtin-string:
1210the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1211font-switching at runtime:
1212 1184
1213 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1185This action is mainly useful to restore string mappings for keys that
1214 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.
1215 1190
1216Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1191An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1217info): 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:
1218 1195
1219 URxvt.keysym.M-C-3: command:\033[8;25;80t 1196 URxvt.keysym.S-Insert: builtin-string:
1220 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
1221 1233
1222=item B<perl-ext-common>: I<string> 1234=item B<perl-ext-common>: I<string>
1223 1235
1224=item B<perl-ext>: I<string> 1236=item B<perl-ext>: I<string>
1225 1237
1227use in this terminal instance; option B<-pe>. 1239use in this terminal instance; option B<-pe>.
1228 1240
1229Extension names can be prefixed with a C<-> sign to prohibit using 1241Extension names can be prefixed with a C<-> sign to prohibit using
1230them. This can be useful to selectively disable some extensions loaded 1242them. This can be useful to selectively disable some extensions loaded
1231by default, or specified via the C<perl-ext-common> resource. For 1243by default, or specified via the C<perl-ext-common> resource. For
1232example, C<default,-selection> will use all the default extension except 1244example, C<default,-selection> will use all the default extensions except
1233C<selection>. 1245C<selection>.
1234 1246
1235Extension names can also be followed by an argument in angle brackets 1247The default set includes the C<selection>, C<option-popup>,
1236(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1248C<selection-popup> and C<readline> extensions, any extensions that
1237searchable scrollback to Alt/Meta-s). Mentioning the same extension 1249define keybindings via C<BINDING> meta comments, and extensions which
1238multiple times with different arguments will pass multiple arguments to 1250are mentioned in B<keysym> resources.
1239the extension. 1251
1252Any extension such that a corresponding resource is given on the
1253command line is automatically appended to B<perl-ext>.
1240 1254
1241Each extension is looked up in the library directories, loaded if 1255Each extension is looked up in the library directories, loaded if
1242necessary, 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.
1243 1259
1244If both of these resources are the empty string, then the perl 1260If both of these resources are the empty string, then the perl interpreter
1245interpreter will not be initialized. The idea behind two options is that 1261will not be initialized. The rationale for having two options is that
1246B<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
1247all instances, while B<perl-ext> is used for specific instances. 1263all instances, while B<perl-ext> is used for specific instances.
1248 1264
1249=item B<perl-eval>: I<string> 1265=item B<perl-eval>: I<string>
1250 1266
1252the @@RXVT_NAME@@perl(3) manpage. 1268the @@RXVT_NAME@@perl(3) manpage.
1253 1269
1254=item B<perl-lib>: I<path> 1270=item B<perl-lib>: I<path>
1255 1271
1256Colon-separated list of additional directories that hold extension 1272Colon-separated list of additional directories that hold extension
1257scripts. When looking for extensions specified by the C<perl> resource, 1273scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1258@@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
1259F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1275lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260 1276
1261See the @@RXVT_NAME@@perl(3) manpage. 1277See the @@RXVT_NAME@@perl(3) manpage.
1262 1278
1263=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1279=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1264 1280
1268=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1284=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1269 1285
1270Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1286Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1271for details. 1287for details.
1272 1288
1273=item B<searchable-scrollback:> I<keysym> 1289=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1274 1290
1275Sets the hotkey that starts the incremental scrollback buffer search 1291This resource is deprecated and will be removed. Use a B<keysym> resource
1276(default: C<M-s>). 1292instead, e.g.:
1277 1293
1294 URxvt.keysym.M-s: searchable-scrollback:start
1295
1278=item B<urlLauncher>: I<string> 1296=item B<url-launcher>: I<string>
1279 1297
1280Specifies 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
1281C<selection-popup> and C<matcher> perl extensions. 1299C<selection-popup> and C<matcher> perl extensions.
1282 1300
1283=item B<transient-for>: I<windowid> 1301=item B<transient-for>: I<windowid>
1287=item B<override-redirect>: I<boolean> 1305=item B<override-redirect>: I<boolean>
1288 1306
1289Compile I<frills>: Sets override-redirect for the terminal window, making 1307Compile I<frills>: Sets override-redirect for the terminal window, making
1290it almost invisible to window managers; option B<-override-redirect>. 1308it almost invisible to window managers; option B<-override-redirect>.
1291 1309
1310=item B<iso14755:> I<boolean>
1311
1312Turn on/off ISO 14755 (default enabled).
1313
1292=item B<iso14755_52:> I<boolean> 1314=item B<iso14755_52:> I<boolean>
1293 1315
1294Turn 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.
1295 1431
1296=back 1432=back
1297 1433
1298=head1 THE SCROLLBAR 1434=head1 THE SCROLLBAR
1299 1435
1347window causes the value of the PRIMARY selection (or CLIPBOARD with the 1483window causes the value of the PRIMARY selection (or CLIPBOARD with the
1348B<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.
1349 1485
1350Pressing 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
1351inserted 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.
1352 1494
1353=back 1495=back
1354 1496
1355=head1 CHANGING FONTS 1497=head1 CHANGING FONTS
1356 1498
1438B<@@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
1439it 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
1440allow 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
1441on 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.
1442 1584
1443=head1 COLORS AND GRAPHICS 1585=head1 COLOURS AND GRAPHICS
1444 1586
1445In addition to the default foreground and background colours, 1587In addition to the default foreground and background colours,
1446B<@@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
1447high-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
1448colours 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.
1449 1594
1450=begin table 1595=begin table
1451 1596
1452 B<color0> (black) = Black 1597 B<color0> (black) = Black
1453 B<color1> (red) = Red3 1598 B<color1> (red) = Red3
1473It is also possible to specify the colour values of B<foreground>, 1618It is also possible to specify the colour values of B<foreground>,
1474B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1619B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1475a 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
1476color0-color15. 1621color0-color15.
1477 1622
1478In addition to the colours defined above, @@RXVT_NAME@@ offers an 1623The following text gives values for the standard 88 colour mode (and
1479additional 72 colours. The first 64 of those (with indices 16 to 79) 1624values for the 256 colour mode in parentheses).
1480consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
148116>), followed by 8 additional shades of gray (with indices 80 to 87).
1482 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
1483Together, all those colours implement the 88 colour xterm colours. Only 1635Together, all those colours implement the 88 (256) colour xterm
1484the first 16 can be changed using resources currently, the rest can only 1636colours. Only the first 16 can be changed using resources currently, the
1485be 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...).
1486 1641
1487Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1642Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1488always swapping the foreground/background colours. This is in contrast to 1643always swapping the foreground/background colours. This is in contrast to
1489I<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
1490been specified. For example, 1645been specified. For example,
1491 1646
1492=over 4
1493
1494=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1647 @@RXVT_NAME@@ -fg Black -bg White -rv
1495 1648
1496would 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
1497on White. 1650White.
1498
1499=back
1500 1651
1501=head2 ALPHA CHANNEL SUPPORT 1652=head2 ALPHA CHANNEL SUPPORT
1502 1653
1503If 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
1504their act together, rxvt-unicode will do it's own alpha channel management: 1655their act together, rxvt-unicode will do its own alpha channel management:
1505 1656
1506You can prefix any color with an opaquenes percentage enclosed in 1657You can prefix any colour with an opaqueness percentage enclosed in
1507brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1658brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1508(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
1509transparent 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
1510half-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
1511is the recommended format to specify transparency values, and works with 1662is the recommended format to specify transparency values, and works with
1512all ways to specify a colour. 1663all ways to specify a colour.
1513 1664
1591 1742
1592=item B<SHELL> 1743=item B<SHELL>
1593 1744
1594The 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>.
1595 1746
1596=item B<RXVT_SOCKET> 1747=item B<RXVT_SOCKET> [I<sic>]
1597 1748
1598The unix domain socket path used by @@RXVT_NAME@@c(1) and 1749The unix domain socket path used by @@RXVT_NAME@@c(1) and
1599@@RXVT_NAME@@d(1). 1750@@RXVT_NAME@@d(1).
1600 1751
1601Default 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).
1602 1763
1603=item B<HOME> 1764=item B<HOME>
1604 1765
1605Used to locate the default directory for the unix domain socket for 1766Used to locate the default directory for the unix domain socket for
1606daemon communications and to locate various resource files (such as 1767daemon communications and to locate various resource files (such as
1607C<.Xdefaults>) 1768C<.Xdefaults>)
1608 1769
1609=item B<XAPPLRESDIR> 1770=item B<XAPPLRESDIR>
1610 1771
1611Directory where various X resource files are being located. 1772Directory where application-specific X resource files are located.
1612 1773
1613=item B<XENVIRONMENT> 1774=item B<XENVIRONMENT>
1614 1775
1615If 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
1616@@RXVT_NAME@@. 1777@@RXVT_NAME@@.
1621 1782
1622=over 4 1783=over 4
1623 1784
1624=item B</usr/lib/X11/rgb.txt> 1785=item B</usr/lib/X11/rgb.txt>
1625 1786
1626Color names. 1787Colour names.
1627 1788
1628=back 1789=back
1629 1790
1630=head1 SEE ALSO 1791=head1 SEE ALSO
1631 1792
1793@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1632@@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)
1633 1795
1634=head1 CURRENT PROJECT COORDINATOR 1796=head1 CURRENT PROJECT COORDINATOR
1635 1797
1636=over 4 1798=over 4
1637 1799
1638=item Project Coordinator 1800=item Project Coordinator
1639 1801
1640Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1802Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1641 1803
1642L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1804L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1643 1805
1644=back 1806=back
1645 1807
1649 1811
1650=item John Bovey 1812=item John Bovey
1651 1813
1652University of Kent, 1992, wrote the original Xvt. 1814University of Kent, 1992, wrote the original Xvt.
1653 1815
1654=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1816=item Rob Nation <nation@rocket.sanders.lockheed.com>
1655 1817
1656very heavily modified Xvt and came up with Rxvt 1818very heavily modified Xvt and came up with Rxvt
1657 1819
1658=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1820=item Angelo Haritsis <ah@doc.ic.ac.uk>
1659 1821
1660wrote the Greek Keyboard Input (no longer in code) 1822wrote the Greek Keyboard Input (no longer in code)
1661 1823
1662=item mj olesen L<< <olesen@me.QueensU.CA> >> 1824=item mj olesen <olesen@me.QueensU.CA>
1663 1825
1664Wrote the menu system. 1826Wrote the menu system.
1665 1827
1666Project Coordinator (changes.txt 2.11 to 2.21) 1828Project Coordinator (changes.txt 2.11 to 2.21)
1667 1829
1668=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1830=item Oezguer Kesim <kesim@math.fu-berlin.de>
1669 1831
1670Project Coordinator (changes.txt 2.21a to 2.4.5) 1832Project Coordinator (changes.txt 2.21a to 2.4.5)
1671 1833
1672=item Geoff Wing L<< <gcw@pobox.com> >> 1834=item Geoff Wing <gcw@pobox.com>
1673 1835
1674Rewrote screen display and text selection routines. 1836Rewrote screen display and text selection routines.
1675 1837
1676Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1838Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1677 1839
1678=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1840=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1679 1841
1680Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1842Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1681extension, random hacks, numerous bugfixes and extensions. 1843extension, random hacks, numerous bugfixes and extensions.
1682 1844
1683Project Coordinator (Changes 1.0 -) 1845Project Coordinator (Changes 1.0 -)
1684 1846
1685=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1847=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1686 1848
1687Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1849pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1688 1850
1689=back 1851=back
1690 1852

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines