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.171 by root, Sat May 30 08:53:48 2009 UTC vs.
Revision 1.242 by sf-exg, Fri Dec 26 21:49:11 2014 UTC

98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
111=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
112 118
113Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
114 120
115=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 128
123=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
124 130
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 132
137=item B<-fade> I<number> 133=item B<-fade> I<number>
138 134
139Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
143=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
144 140
145Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
147 143
148=item B<-tint> I<colour>
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> 144=item B<-icon> I<file>
188 145
189Compile I<afterimage>: Use the specified image as application icon. This 146Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 147is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 148application window; resource I<iconFile>.
192 149
193=item B<-bg> I<colour> 150=item B<-bg> I<colour>
194 151
195Window background colour; resource B<background>. 152Window background colour; resource B<background>.
196 153
197=item B<-fg> I<colour> 154=item B<-fg> I<colour>
198 155
199Window foreground colour; resource B<foreground>. 156Window 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 157
208=item B<-cr> I<colour> 158=item B<-cr> I<colour>
209 159
210The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
211 161
270 220
271=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
272 222
273Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
274 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
275=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
276 230
277Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
278B<utmpInhibit>. 232B<utmpInhibit>.
279 233
357 311
358=item B<-override-redirect> 312=item B<-override-redirect>
359 313
360Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
361B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
362 321
363=item B<-sbg> 322=item B<-sbg>
364 323
365Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
366drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
571You can set and change the resources using X11 tools like B<xrdb>. Many 530You can set and change the resources using X11 tools like B<xrdb>. Many
572distribution do also load settings from the B<~/.Xresources> file when X 531distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 532starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 533with later settings overwriting earlier ones:
575 534
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 535 1. app-defaults file in $XAPPLRESDIR
536 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 537 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 538 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 539 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 540 6. resources specified via -xrm on the commandline
582 541
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 542Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 543names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
625Use the specified colour for the colour value I<n>, where 0-7 584Use the specified colour for the colour value I<n>, where 0-7
626corresponds to low-intensity (normal) colours and 8-15 corresponds to 585corresponds to low-intensity (normal) colours and 8-15 corresponds to
627high-intensity (bold = bright foreground, blink = bright background) 586high-intensity (bold = bright foreground, blink = bright background)
628colours. The canonical names are as follows: 0=black, 1=red, 2=green, 587colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6293=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5883=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
630names used are listed in the B<COLORS AND GRAPHICS> section. 589names used are listed in the B<COLOURS AND GRAPHICS> section.
631 590
632Colours higher than 15 cannot be set using resources (yet), but can be 591Colours higher than 15 cannot be set using resources (yet), but can be
633changed using an escape command (see @@RXVT_NAME@@(7)). 592changed using an escape command (see @@RXVT_NAME@@(7)).
634 593
635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 594Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
646=item B<colorUL:> I<colour> 605=item B<colorUL:> I<colour>
647 606
648Use the specified colour to display underlined characters when the 607Use the specified colour to display underlined characters when the
649foreground colour is the default. 608foreground colour is the default.
650 609
651=item B<colorRV:> I<colour>
652
653Use the specified colour as the background for reverse video characters
654when OPTION_HC is disabled (--disable-frills).
655
656=item B<underlineColor:> I<colour> 610=item B<underlineColor:> I<colour>
657 611
658If set, use the specified colour as the colour for the underline 612If set, use the specified colour as the colour for the underline
659itself. If unset, use the foreground colour. 613itself. If unset, use the foreground colour.
614
615=item B<highlightColor:> I<colour>
616
617If set, use the specified colour as the background for highlighted
618characters. If unset, use reverse video.
619
620=item B<highlightTextColor:> I<colour>
621
622If set and highlightColor is set, use the specified colour as the
623foreground for highlighted characters.
660 624
661=item B<cursorColor:> I<colour> 625=item B<cursorColor:> I<colour>
662 626
663Use the specified colour for the cursor. The default is to use the 627Use the specified colour for the cursor. The default is to use the
664foreground colour; option B<-cr>. 628foreground colour; option B<-cr>.
671 635
672=item B<reverseVideo:> I<boolean> 636=item B<reverseVideo:> I<boolean>
673 637
674B<True>: simulate reverse video by foreground and background colours; 638B<True>: simulate reverse video by foreground and background colours;
675option B<-rv>. B<False>: regular screen colours [default]; option 639option B<-rv>. B<False>: regular screen colours [default]; option
676B<+rv>. See note in B<COLORS AND GRAPHICS> section. 640B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
677 641
678=item B<jumpScroll:> I<boolean> 642=item B<jumpScroll:> I<boolean>
679 643
680B<True>: specify that jump scrolling should be used. When receiving lots 644B<True>: specify that jump scrolling should be used. When receiving lots
681of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
695 659
696B<False>: specify that everything is to be displayed, even 660B<False>: specify that everything is to be displayed, even
697if the refresh is too fast for the human eye to read anything (or the 661if the refresh is too fast for the human eye to read anything (or the
698monitor to display anything); option B<+ss>. 662monitor to display anything); option B<+ss>.
699 663
700=item B<transparent:> I<boolean>
701
702Turn on/off illusion of a transparent window background.
703
704B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
705future versions.
706
707I<Please address all transparency related issues to Sasha Vasko at
708sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
709
710=item B<fading:> I<number> 664=item B<fading:> I<number>
711 665
712Fade the text by the given percentage when focus is lost; option B<-fade>. 666Fade the text by the given percentage when focus is lost; option B<-fade>.
713 667
714=item B<fadeColor:> I<colour> 668=item B<fadeColor:> I<colour>
715 669
716Fade to this colour, when fading is used (see B<fading:>). The default 670Fade to this colour, when fading is used (see B<fading:>). The default
717colour is black; option B<-fadecolor>. 671colour is black; option B<-fadecolor>.
718 672
719=item B<tintColor:> I<colour>
720
721Tint the transparent background pixmap with the given colour; option
722B<-tint>.
723
724=item B<shading:> I<number>
725
726Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
727in addition to tinting it; option B<-sh>.
728
729=item B<blendType:> I<string>
730
731Specify background blending type; option B<-blt>.
732
733=item B<blurRadius:> I<number>
734
735Apply gaussian blur with the specified radius to the transparent
736background image; option B<-blr>.
737
738=item B<iconFile:> I<file> 673=item B<iconFile:> I<file>
739 674
740Set the application icon pixmap; option B<-icon>. 675Set the application icon pixmap; option B<-icon>.
741 676
742=item B<scrollColor:> I<colour> 677=item B<scrollColor:> I<colour>
750 685
751=item B<borderColor:> I<colour> 686=item B<borderColor:> I<colour>
752 687
753The colour of the border around the text area and between the scrollbar 688The colour of the border around the text area and between the scrollbar
754and the text. 689and the text.
755
756=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
757
758Use the specified image file for the background and also
759optionally specify its scaling with a geometry string B<WxH+X+Y>,
760(default C<0x0+50+50>) in which B<"W" / "H"> specify the
761horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
762centre (percent). A scale of 0 displays the image with tiling. A scale
763of 1 displays the image without any scaling. A scale of 2 to 9 specifies
764an integer number of images in that direction. No image will be magnified
765beyond 10 times its original size. The maximum permitted scale is 1000.
766Additional operations can be specified after colon B<:op1:op2...>.
767Supported operations are:
768
769 tile force background image to be tiled and not scaled. Equivalent to 0x0
770 propscale will scale image keeping proportions
771 auto will scale image to match window size. Equivalent to 100x100
772 hscale will scale image horizontally to the window size
773 vscale will scale image vertically to the window size
774 scale will scale image to match window size
775 root will tile image as if it was a root window background, auto-adjusting
776 whenever terminal window moves
777
778If used in conjunction with B<-tr> option, the specified pixmap will be
779blended over transparency image using either alpha-blending, or any
780other blending type, specified with B<-blt "type"> option.
781
782=item B<path:> I<path>
783
784Specify the colon-delimited search path for finding background image files.
785 690
786=item B<font:> I<fontlist> 691=item B<font:> I<fontlist>
787 692
788Select the fonts to be used. This is a comma separated list of font names 693Select the fonts to be used. This is a comma separated list of font names
789that are checked in order when trying to find glyphs for characters. The 694that are checked in order when trying to find glyphs for characters. The
812it is named first) and thus defines the character cell grid to be 9 pixels 717it is named first) and thus defines the character cell grid to be 9 pixels
813wide and 15 pixels high. 718wide and 15 pixels high.
814 719
815The second font is just used to add additional unicode characters not in 720The second font is just used to add additional unicode characters not in
816the base font, likewise the third, which is unfortunately non-bold, but 721the base font, likewise the third, which is unfortunately non-bold, but
817the bold version of the font does contain less characters, so this is a 722the bold version of the font does contain fewer characters, so this is a
818useful supplement. 723useful supplement.
819 724
820The third font is an Xft font with aliasing turned off, and the characters 725The third font is an Xft font with aliasing turned off, and the characters
821are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 726are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
822contains other characters, but we are not interested in them. 727contains other characters, but we are not interested in them.
886 791
887B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 792B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
888the shell; option B<-ls>. B<False>: start as a normal sub-shell 793the shell; option B<-ls>. B<False>: start as a normal sub-shell
889[default]; option B<+ls>. 794[default]; option B<+ls>.
890 795
796=item B<multiClickTime:> I<number>
797
798Specify the maximum time in milliseconds between multi-click select
799events. The default is 500 milliseconds; option B<-mc>.
800
891=item B<utmpInhibit:> I<boolean> 801=item B<utmpInhibit:> I<boolean>
892 802
893B<True>: inhibit writing record into the system log file B<utmp>; 803B<True>: inhibit writing record into the system log file B<utmp>;
894option B<-ut>. B<False>: write record into the system log file B<utmp> 804option B<-ut>. B<False>: write record into the system log file B<utmp>
895[default]; option B<+ut>. 805[default]; option B<+ut>.
912=item B<scrollstyle:> I<mode> 822=item B<scrollstyle:> I<mode>
913 823
914Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 824Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
915the author's favourite. 825the author's favourite.
916 826
827=item B<thickness:> I<number>
828
829Set the scrollbar width in pixels.
830
917=item B<scrollBar:> I<boolean> 831=item B<scrollBar:> I<boolean>
918 832
919B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 833B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
920disable the scrollbar; option B<+sb>. 834disable the scrollbar; option B<+sb>.
921 835
940B<False>: do not scroll to bottom when tty receives output; option 854B<False>: do not scroll to bottom when tty receives output; option
941B<+si>. 855B<+si>.
942 856
943=item B<scrollWithBuffer:> I<boolean> 857=item B<scrollWithBuffer:> I<boolean>
944 858
945B<True>: scroll with scrollback buffer when tty receives new lines (and 859B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
946B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 860try to show the same lines) and B<scrollTtyOutput> is False; option
947with scrollback buffer when tty receives new lines; option B<+sw>. 861B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
862new lines; option B<+sw>.
948 863
949=item B<scrollTtyKeypress:> I<boolean> 864=item B<scrollTtyKeypress:> I<boolean>
950 865
951B<True>: scroll to bottom when a non-special key is pressed. Special keys 866B<True>: scroll to bottom when a non-special key is pressed. Special keys
952are those which are intercepted by rxvt-unicode for special handling and 867are those which are intercepted by rxvt-unicode for special handling and
1035large number (e.g. C<987654321>) to effectively disable the timeout. 950large number (e.g. C<987654321>) to effectively disable the timeout.
1036 951
1037=item B<backspacekey:> I<string> 952=item B<backspacekey:> I<string>
1038 953
1039The string to send when the backspace key is pressed. If set to B<DEC> 954The string to send when the backspace key is pressed. If set to B<DEC>
1040or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 955or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1041(code 8) - which can be reversed with the appropriate DEC private mode 956(code 8) - which can be reversed with the appropriate DEC private mode
1042escape sequence. 957escape sequence.
1043 958
1044=item B<deletekey:> I<string> 959=item B<deletekey:> I<string>
1045 960
1141Sets the working directory for the shell (or the command specified via 1056Sets the working directory for the shell (or the command specified via
1142B<-e>). The I<path> must be an absolute path and it must exist for 1057B<-e>). The I<path> must be an absolute path and it must exist for
1143@@RXVT_NAME@@ to start. If it isn't specified then the current working 1058@@RXVT_NAME@@ to start. If it isn't specified then the current working
1144directory will be used; option B<-cd>. 1059directory will be used; option B<-cd>.
1145 1060
1146=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<action>
1147 1062
1148Compile I<frills>: Associate I<string> with keysym I<sym>. The 1063Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1149intervening resource name B<keysym.> cannot be omitted. 1064resource name B<keysym.> cannot be omitted.
1150 1065
1151The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1066Using this resource, you can map key combinations such as
1152any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1067C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1153B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1068string than would normally result from that combination, making the
1154and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1069terminal scroll up or down the way you want it, or any other thing an
1155B<2>, B<3>, B<4>, B<5>. 1070extension might provide.
1071
1072The key combination that triggers the action, I<sym>, has the following format:
1073
1074 (modifiers-)key
1075
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1077B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1079B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1156 1080
1157The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1081The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1158whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1082whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1159keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1083keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1160current application keymap mode state. 1084current application keymap mode state.
1161 1085
1162The spellings of I<key> can be obtained by using B<xev>(1) command or 1086Due the the large number of modifier combinations, a key mapping will
1163searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1087match if I<at least> the specified identifiers are being set, and no other
1088key mappings with those and more bits are being defined. That means that
1089defining a mapping for C<a> will automatically provide definitions for
1090C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1091themselves. See the C<builtin:> action, below, for a way to work around
1092this when this is a problem.
1093
1094The spelling of I<key> depends on your implementation of X. An easy way to
1095find a key name is to use the B<xev>(1) command. You can find a list by
1096looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1164omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1097the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1165keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1098value (B<0x0000 - 0xFFFF>).
1166performed in an exact manner; however, the closest match is assured.
1167 1099
1168I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1100As with any resource value, the I<action> string may contain backslash
1101escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1169number), see RESOURCES in C<man 7 X> for futher details. 1102number), see RESOURCES in C<man 7 X> for further details.
1170 1103
1171You can define a range of keysyms in one shot by providing a I<string> 1104An action starts with an action prefix that selects a certain type
1172with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1105of action, followed by a colon. An action string without colons is
1106interpreted as a literal string to pass to the tty (as if it was
1107prefixed with C<string:>).
1108
1109The following action prefixes are known - extensions can provide
1110additional prefixes:
1111
1112=over 4
1113
1114=item string:STRING
1115
1116If the I<action> starts with C<string:> (or otherwise contains no colons),
1117then the remaining C<STRING> will be passed to the program running in the
1118terminal. For example, you could replace whatever Shift-Tab outputs by the
1119string C<echo rm -rf /> followed by a newline:
1120
1121 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1122
1123This could in theory be used to completely redefine your keymap.
1124
1125In addition, for actions of this type, you can define a range of
1126keysyms in one shot by loading the C<keysym-list> perl extension and
1127providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1173should be a character not used by the strings. 1128the delimiter `/' should be a character not used by the strings.
1174 1129
1175Its usage can be demonstrated by an example: 1130Its usage can be demonstrated by an example:
1176 1131
1177 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1132 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1178 1133
1179The above line is equivalent to the following three lines: 1134The above line is equivalent to the following three lines:
1180 1135
1181 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1136 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1182 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1137 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1183 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1138 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1184 1139
1140=item command:STRING
1141
1185If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1142If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1186is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1143is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1144the opposite of C<string:> - instead of sending it to the program running
1145in the terminal, it will be treated as if it were program output). This is
1146most useful to feed command sequences into @@RXVT_NAME@@.
1147
1187example the following means "change the current locale to C<zh_CN.GBK> 1148For example the following means "change the current locale to C<zh_CN.GBK>
1188when Control-Meta-c is being pressed": 1149when Control-Meta-c is being pressed":
1189 1150
1190 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1151 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1191 1152
1192If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1153The following example will map Control-Meta-1 and Control-Meta-2 to
1193is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1154the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1194manpage. For example, the F<selection> extension (activated via 1155font-switching at runtime:
1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1196 1156
1197 URxvt.keysym.M-C-c: perl:selection:rot13 1157 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1158 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1198 1159
1199Due the the large number of modifier combinations, a defined key mapping 1160Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1200will match if at I<at least> the specified identifiers are being set, and 1161info):
1201no other key mappings with those and more bits are being defined. That
1202means that defining a key map for C<a> will automatically provide
1203definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1204mappings themselves.
1205 1162
1206Unfortunately, this will override built-in key mappings. For example 1163 URxvt.keysym.M-C-3: command:\033[8;25;80t
1164 URxvt.keysym.M-C-4: command:\033[8;48;110t
1165
1166=item builtin:
1167
1168The builtin action is the action that @@RXVT_NAME@@ would execute if no
1169key binding existed for the key combination. The obvious use is to undo
1170the effect of existing bindings. The not so obvious use is to reinstate
1171bindings when another binding overrides too many modifiers.
1172
1207if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1173For example if you overwrite the C<Insert> key you will disable
1208C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1174@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1209user-defined keymap using the C<builtin:> replacement: 1175"holes" into the user-defined keymap using the C<builtin:> replacement:
1210 1176
1211 URxvt.keysym.Insert: <my insert key sequence> 1177 URxvt.keysym.Insert: <my insert key sequence>
1212 URxvt.keysym.S-Insert: builtin: 1178 URxvt.keysym.S-Insert: builtin:
1213 1179
1214The first line defines a mapping for C<Insert> and I<any> combination 1180The first line defines a mapping for C<Insert> and I<any> combination
1215of modifiers. The second line re-establishes the default mapping for 1181of modifiers. The second line re-establishes the default mapping for
1216C<Shift-Insert>. 1182C<Shift-Insert>.
1217 1183
1218The following example will map Control-Meta-1 and Control-Meta-2 to 1184=item builtin-string:
1219the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1220font-switching at runtime:
1221 1185
1222 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1186This action is mainly useful to restore string mappings for keys that
1223 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1187have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1188difficult to explain - basically, this action will send the string to the
1189application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1190action for it.
1224 1191
1225Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1192An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1226info): 1193selection when you press C<Shift-Insert>. With the following bindings, it
1194would instead emit the (undocumented, but what applications running in the
1195terminal might expect) sequence C<ESC [ 2 $> instead:
1227 1196
1228 URxvt.keysym.M-C-3: command:\033[8;25;80t 1197 URxvt.keysym.S-Insert: builtin-string:
1229 URxvt.keysym.M-C-4: command:\033[8;48;110t 1198 URxvt.keysym.C-S-Insert: builtin:
1199
1200The first line disables the paste functionality for that key
1201combination, and the second reinstates the default behaviour for
1202C<Control-Shift-Insert>, which would otherwise be overridden.
1203
1204Similarly, to let applications gain access to the C<C-M-c> (copy to
1205clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1206this:
1207
1208 URxvt.keysym.C-M-c: builtin-string:
1209 URxvt.keysym.C-M-v: builtin-string:
1210
1211=item EXTENSION:STRING
1212
1213An action of this form invokes the action B<STRING>, if any, provided
1214by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1215be loaded automatically if necessary.
1216
1217Not all extensions define actions, but popular extensions that do
1218include the I<selection> and I<matcher> extensions (documented in their
1219own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1220respectively).
1221
1222From the silly examples department, this will rot13-"encrypt"
1223@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1224keyboards:
1225
1226 URxvt.keysym.M-C-c: selection:rot13
1227
1228=item perl:STRING *DEPRECATED*
1229
1230This is a deprecated way of invoking commands provided by perl
1231extensions. It is still supported, but should not be used anymore.
1232
1233=back
1230 1234
1231=item B<perl-ext-common>: I<string> 1235=item B<perl-ext-common>: I<string>
1232 1236
1233=item B<perl-ext>: I<string> 1237=item B<perl-ext>: I<string>
1234 1238
1236use in this terminal instance; option B<-pe>. 1240use in this terminal instance; option B<-pe>.
1237 1241
1238Extension names can be prefixed with a C<-> sign to prohibit using 1242Extension names can be prefixed with a C<-> sign to prohibit using
1239them. This can be useful to selectively disable some extensions loaded 1243them. This can be useful to selectively disable some extensions loaded
1240by default, or specified via the C<perl-ext-common> resource. For 1244by default, or specified via the C<perl-ext-common> resource. For
1241example, C<default,-selection> will use all the default extension except 1245example, C<default,-selection> will use all the default extensions except
1242C<selection>. 1246C<selection>.
1243 1247
1244Extension names can also be followed by an argument in angle brackets 1248The default set includes the C<selection>, C<option-popup>,
1245(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1249C<selection-popup>, C<readline> and C<searchable-scrollback>
1246searchable scrollback to Alt/Meta-s). Mentioning the same extension 1250extensions, and extensions which are mentioned in B<keysym> resources.
1247multiple times with different arguments will pass multiple arguments to 1251
1248the extension. 1252Any extension such that a corresponding resource is given on the
1253command line is automatically appended to B<perl-ext>.
1249 1254
1250Each extension is looked up in the library directories, loaded if 1255Each extension is looked up in the library directories, loaded if
1251necessary, 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.
1252 1259
1253If both of these resources are the empty string, then the perl 1260If both of these resources are the empty string, then the perl interpreter
1254interpreter will not be initialized. The idea behind two options is that 1261will not be initialized. The rationale for having two options is that
1255B<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
1256all instances, while B<perl-ext> is used for specific instances. 1263all instances, while B<perl-ext> is used for specific instances.
1257 1264
1258=item B<perl-eval>: I<string> 1265=item B<perl-eval>: I<string>
1259 1266
1261the @@RXVT_NAME@@perl(3) manpage. 1268the @@RXVT_NAME@@perl(3) manpage.
1262 1269
1263=item B<perl-lib>: I<path> 1270=item B<perl-lib>: I<path>
1264 1271
1265Colon-separated list of additional directories that hold extension 1272Colon-separated list of additional directories that hold extension
1266scripts. When looking for extensions specified by the C<perl> resource, 1273scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1267@@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
1268F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1275lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1269 1276
1270See the @@RXVT_NAME@@perl(3) manpage. 1277See the @@RXVT_NAME@@perl(3) manpage.
1271 1278
1272=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1279=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1273 1280
1277=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1284=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1278 1285
1279Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1286Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1280for details. 1287for details.
1281 1288
1282=item B<searchable-scrollback:> I<keysym> 1289=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1283 1290
1284Sets the hotkey that starts the incremental scrollback buffer search 1291This resource is deprecated and will be removed. Use a B<keysym> resource
1285(default: C<M-s>). 1292instead, e.g.:
1286 1293
1294 URxvt.keysym.M-s: searchable-scrollback:start
1295
1287=item B<urlLauncher>: I<string> 1296=item B<url-launcher>: I<string>
1288 1297
1289Specifies 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
1290C<selection-popup> and C<matcher> perl extensions. 1299C<selection-popup> and C<matcher> perl extensions.
1291 1300
1292=item B<transient-for>: I<windowid> 1301=item B<transient-for>: I<windowid>
1296=item B<override-redirect>: I<boolean> 1305=item B<override-redirect>: I<boolean>
1297 1306
1298Compile I<frills>: Sets override-redirect for the terminal window, making 1307Compile I<frills>: Sets override-redirect for the terminal window, making
1299it almost invisible to window managers; option B<-override-redirect>. 1308it almost invisible to window managers; option B<-override-redirect>.
1300 1309
1310=item B<iso14755:> I<boolean>
1311
1312Turn on/off ISO 14755 (default enabled).
1313
1301=item B<iso14755_52:> I<boolean> 1314=item B<iso14755_52:> I<boolean>
1302 1315
1303Turn 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.
1304 1431
1305=back 1432=back
1306 1433
1307=head1 THE SCROLLBAR 1434=head1 THE SCROLLBAR
1308 1435
1356window causes the value of the PRIMARY selection (or CLIPBOARD with the 1483window causes the value of the PRIMARY selection (or CLIPBOARD with the
1357B<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.
1358 1485
1359Pressing 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
1360inserted 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.
1361 1494
1362=back 1495=back
1363 1496
1364=head1 CHANGING FONTS 1497=head1 CHANGING FONTS
1365 1498
1447B<@@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
1448it 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
1449allow 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
1450on 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.
1451 1584
1452=head1 COLORS AND GRAPHICS 1585=head1 COLOURS AND GRAPHICS
1453 1586
1454In addition to the default foreground and background colours, 1587In addition to the default foreground and background colours,
1455B<@@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
1456high-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
1457colours 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.
1458 1594
1459=begin table 1595=begin table
1460 1596
1461 B<color0> (black) = Black 1597 B<color0> (black) = Black
1462 B<color1> (red) = Red3 1598 B<color1> (red) = Red3
1482It is also possible to specify the colour values of B<foreground>, 1618It is also possible to specify the colour values of B<foreground>,
1483B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1619B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1484a 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
1485color0-color15. 1621color0-color15.
1486 1622
1487In addition to the colours defined above, @@RXVT_NAME@@ offers an 1623The following text gives values for the standard 88 colour mode (and
1488additional 72 colours. The first 64 of those (with indices 16 to 79) 1624values for the 256 colour mode in parentheses).
1489consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
149016>), followed by 8 additional shades of gray (with indices 80 to 87).
1491 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
1492Together, all those colours implement the 88 colour xterm colours. Only 1635Together, all those colours implement the 88 (256) colour xterm
1493the first 16 can be changed using resources currently, the rest can only 1636colours. Only the first 16 can be changed using resources currently, the
1494be 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...).
1495 1641
1496Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1642Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1497always swapping the foreground/background colours. This is in contrast to 1643always swapping the foreground/background colours. This is in contrast to
1498I<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
1499been specified. For example, 1645been specified. For example,
1500 1646
1501=over 4
1502
1503=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1647 @@RXVT_NAME@@ -fg Black -bg White -rv
1504 1648
1505would 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
1506on White. 1650White.
1507
1508=back
1509 1651
1510=head2 ALPHA CHANNEL SUPPORT 1652=head2 ALPHA CHANNEL SUPPORT
1511 1653
1512If 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
1513their act together, rxvt-unicode will do it's own alpha channel management: 1655their act together, rxvt-unicode will do its own alpha channel management:
1514 1656
1515You can prefix any color with an opaquenes percentage enclosed in 1657You can prefix any colour with an opaqueness percentage enclosed in
1516brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1658brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1517(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
1518transparent 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
1519half-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
1520is the recommended format to specify transparency values, and works with 1662is the recommended format to specify transparency values, and works with
1521all ways to specify a colour. 1663all ways to specify a colour.
1522 1664
1600 1742
1601=item B<SHELL> 1743=item B<SHELL>
1602 1744
1603The 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>.
1604 1746
1605=item B<RXVT_SOCKET> 1747=item B<RXVT_SOCKET> [I<sic>]
1606 1748
1607The unix domain socket path used by @@RXVT_NAME@@c(1) and 1749The unix domain socket path used by @@RXVT_NAME@@c(1) and
1608@@RXVT_NAME@@d(1). 1750@@RXVT_NAME@@d(1).
1609 1751
1610Default 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).
1611 1763
1612=item B<HOME> 1764=item B<HOME>
1613 1765
1614Used to locate the default directory for the unix domain socket for 1766Used to locate the default directory for the unix domain socket for
1615daemon communications and to locate various resource files (such as 1767daemon communications and to locate various resource files (such as
1616C<.Xdefaults>) 1768C<.Xdefaults>)
1617 1769
1618=item B<XAPPLRESDIR> 1770=item B<XAPPLRESDIR>
1619 1771
1620Directory where various X resource files are being located. 1772Directory where application-specific X resource files are located.
1621 1773
1622=item B<XENVIRONMENT> 1774=item B<XENVIRONMENT>
1623 1775
1624If 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
1625@@RXVT_NAME@@. 1777@@RXVT_NAME@@.
1630 1782
1631=over 4 1783=over 4
1632 1784
1633=item B</usr/lib/X11/rgb.txt> 1785=item B</usr/lib/X11/rgb.txt>
1634 1786
1635Color names. 1787Colour names.
1636 1788
1637=back 1789=back
1638 1790
1639=head1 SEE ALSO 1791=head1 SEE ALSO
1640 1792
1793@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1641@@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)
1642 1795
1643=head1 CURRENT PROJECT COORDINATOR 1796=head1 CURRENT PROJECT COORDINATOR
1644 1797
1645=over 4 1798=over 4
1646 1799
1647=item Project Coordinator 1800=item Project Coordinator
1648 1801
1649Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1802Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1650 1803
1651L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1804L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1652 1805
1653=back 1806=back
1654 1807
1658 1811
1659=item John Bovey 1812=item John Bovey
1660 1813
1661University of Kent, 1992, wrote the original Xvt. 1814University of Kent, 1992, wrote the original Xvt.
1662 1815
1663=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1816=item Rob Nation <nation@rocket.sanders.lockheed.com>
1664 1817
1665very heavily modified Xvt and came up with Rxvt 1818very heavily modified Xvt and came up with Rxvt
1666 1819
1667=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1820=item Angelo Haritsis <ah@doc.ic.ac.uk>
1668 1821
1669wrote the Greek Keyboard Input (no longer in code) 1822wrote the Greek Keyboard Input (no longer in code)
1670 1823
1671=item mj olesen L<< <olesen@me.QueensU.CA> >> 1824=item mj olesen <olesen@me.QueensU.CA>
1672 1825
1673Wrote the menu system. 1826Wrote the menu system.
1674 1827
1675Project Coordinator (changes.txt 2.11 to 2.21) 1828Project Coordinator (changes.txt 2.11 to 2.21)
1676 1829
1677=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1830=item Oezguer Kesim <kesim@math.fu-berlin.de>
1678 1831
1679Project Coordinator (changes.txt 2.21a to 2.4.5) 1832Project Coordinator (changes.txt 2.21a to 2.4.5)
1680 1833
1681=item Geoff Wing L<< <gcw@pobox.com> >> 1834=item Geoff Wing <gcw@pobox.com>
1682 1835
1683Rewrote screen display and text selection routines. 1836Rewrote screen display and text selection routines.
1684 1837
1685Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1838Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1686 1839
1687=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1840=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1688 1841
1689Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1842Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1690extension, random hacks, numerous bugfixes and extensions. 1843extension, random hacks, numerous bugfixes and extensions.
1691 1844
1692Project Coordinator (Changes 1.0 -) 1845Project Coordinator (Changes 1.0 -)
1693 1846
1694=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1847=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1695 1848
1696Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1849pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1697 1850
1698=back 1851=back
1699 1852

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines