ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.169 by root, Wed Nov 5 00:14:18 2008 UTC vs.
Revision 1.236 by sf-exg, Sat Aug 16 10:51:23 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
… …
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>.
358 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.
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
363this if you have a good font and want to use its block graphic glyphs; 325this if you have a good font and want to use its block graphic glyphs;
… …
366=item B<-lsp> I<number> 328=item B<-lsp> I<number>
367 329
368Compile I<frills>: Lines (pixel height) to insert between each row of 330Compile I<frills>: Lines (pixel height) to insert between each row of
369the display. Useful to work around font rendering problems; resource 331the display. Useful to work around font rendering problems; resource
370B<lineSpace>. 332B<lineSpace>.
333
334=item B<-letsp> I<number>
335
336Compile I<frills>: Amount to adjust the computed character width by
337to control overall letter spacing. Negative values will tighten up the
338letter spacing, positive values will space letters out more. Useful to
339work around odd font metrics; resource B<letterSpace>.
371 340
372=item B<-tn> I<termname> 341=item B<-tn> I<termname>
373 342
374This option specifies the name of the terminal type to be set in the 343This option specifies the name of the terminal type to be set in the
375B<TERM> environment variable. This terminal type must exist in the 344B<TERM> environment variable. This terminal type must exist in the
… …
560You 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
561distribution do also load settings from the B<~/.Xresources> file when X 530distribution do also load settings from the B<~/.Xresources> file when X
562starts. @@RXVT_NAME@@ will consult the following files/resources in order, 531starts. @@RXVT_NAME@@ will consult the following files/resources in order,
563with later settings overwriting earlier ones: 532with later settings overwriting earlier ones:
564 533
565 1. system-wide app-defaults file, either locale-dependent OR global
566 2. app-defaults file in $XAPPLRESDIR 534 1. app-defaults file in $XAPPLRESDIR
535 2. $HOME/.Xdefaults
567 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 536 3. RESOURCE_MANAGER property on root-window of screen 0
568 4. SCREEN_RESOURCES for the current screen 537 4. SCREEN_RESOURCES property on root-window of the current screen
569 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 538 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
570 6. resources specified via -xrm on the commandline 539 6. resources specified via -xrm on the commandline
571 540
572Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 541Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
573names: 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
… …
614Use 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
615corresponds to low-intensity (normal) colours and 8-15 corresponds to 584corresponds to low-intensity (normal) colours and 8-15 corresponds to
616high-intensity (bold = bright foreground, blink = bright background) 585high-intensity (bold = bright foreground, blink = bright background)
617colours. 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,
6183=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
619names used are listed in the B<COLORS AND GRAPHICS> section. 588names used are listed in the B<COLOURS AND GRAPHICS> section.
620 589
621Colours 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
622changed using an escape command (see @@RXVT_NAME@@(7)). 591changed using an escape command (see @@RXVT_NAME@@(7)).
623 592
624Colours 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
… …
635=item B<colorUL:> I<colour> 604=item B<colorUL:> I<colour>
636 605
637Use the specified colour to display underlined characters when the 606Use the specified colour to display underlined characters when the
638foreground colour is the default. 607foreground colour is the default.
639 608
640=item B<colorRV:> I<colour>
641
642Use the specified colour as the background for reverse video characters
643when OPTION_HC is disabled (--disable-frills).
644
645=item B<underlineColor:> I<colour> 609=item B<underlineColor:> I<colour>
646 610
647If set, use the specified colour as the colour for the underline 611If set, use the specified colour as the colour for the underline
648itself. 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.
649 623
650=item B<cursorColor:> I<colour> 624=item B<cursorColor:> I<colour>
651 625
652Use 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
653foreground colour; option B<-cr>. 627foreground colour; option B<-cr>.
… …
660 634
661=item B<reverseVideo:> I<boolean> 635=item B<reverseVideo:> I<boolean>
662 636
663B<True>: simulate reverse video by foreground and background colours; 637B<True>: simulate reverse video by foreground and background colours;
664option B<-rv>. B<False>: regular screen colours [default]; option 638option B<-rv>. B<False>: regular screen colours [default]; option
665B<+rv>. See note in B<COLORS AND GRAPHICS> section. 639B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
666 640
667=item B<jumpScroll:> I<boolean> 641=item B<jumpScroll:> I<boolean>
668 642
669B<True>: specify that jump scrolling should be used. When receiving lots 643B<True>: specify that jump scrolling should be used. When receiving lots
670of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 644of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
684 658
685B<False>: specify that everything is to be displayed, even 659B<False>: specify that everything is to be displayed, even
686if 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
687monitor to display anything); option B<+ss>. 661monitor to display anything); option B<+ss>.
688 662
689=item B<transparent:> I<boolean>
690
691Turn on/off illusion of a transparent window background.
692
693B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
694future versions.
695
696I<Please address all transparency related issues to Sasha Vasko at
697sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
698
699=item B<fading:> I<number> 663=item B<fading:> I<number>
700 664
701Fade 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>.
702 666
703=item B<fadeColor:> I<colour> 667=item B<fadeColor:> I<colour>
704 668
705Fade 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
706colour is black; option B<-fadecolor>. 670colour is black; option B<-fadecolor>.
707 671
708=item B<tintColor:> I<colour>
709
710Tint the transparent background pixmap with the given colour; option
711B<-tint>.
712
713=item B<shading:> I<number>
714
715Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
716in addition to tinting it; option B<-sh>.
717
718=item B<blendType:> I<string>
719
720Specify background blending type; option B<-blt>.
721
722=item B<blurRadius:> I<number>
723
724Apply gaussian blur with the specified radius to the transparent
725background image; option B<-blr>.
726
727=item B<iconFile:> I<file> 672=item B<iconFile:> I<file>
728 673
729Set the application icon pixmap; option B<-icon>. 674Set the application icon pixmap; option B<-icon>.
730 675
731=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
… …
739 684
740=item B<borderColor:> I<colour> 685=item B<borderColor:> I<colour>
741 686
742The 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
743and the text. 688and the text.
744
745=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
746
747Use the specified image file for the background and also
748optionally specify its scaling with a geometry string B<WxH+X+Y>,
749(default C<0x0+50+50>) in which B<"W" / "H"> specify the
750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
751centre (percent). A scale of 0 displays the image with tiling. A scale
752of 1 displays the image without any scaling. A scale of 2 to 9 specifies
753an integer number of images in that direction. No image will be magnified
754beyond 10 times its original size. The maximum permitted scale is 1000.
755Additional operations can be specified after colon B<:op1:op2...>.
756Supported operations are:
757
758 tile force background image to be tiled and not scaled. Equivalent to 0x0
759 propscale will scale image keeping proportions
760 auto will scale image to match window size. Equivalent to 100x100
761 hscale will scale image horizontally to the window size
762 vscale will scale image vertically to the window size
763 scale will scale image to match window size
764 root will tile image as if it was a root window background, auto-adjusting
765 whenever terminal window moves
766
767If used in conjunction with B<-tr> option, the specified pixmap will be
768blended over transparency image using either alpha-blending, or any
769other blending type, specified with B<-blt "type"> option.
770
771=item B<path:> I<path>
772
773Specify the colon-delimited search path for finding background image files.
774 689
775=item B<font:> I<fontlist> 690=item B<font:> I<fontlist>
776 691
777Select 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
778that 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
… …
801it 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
802wide and 15 pixels high. 717wide and 15 pixels high.
803 718
804The 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
805the base font, likewise the third, which is unfortunately non-bold, but 720the base font, likewise the third, which is unfortunately non-bold, but
806the bold version of the font does contain less characters, so this is a 721the bold version of the font does contain fewer characters, so this is a
807useful supplement. 722useful supplement.
808 723
809The 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
810are 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
811contains other characters, but we are not interested in them. 726contains other characters, but we are not interested in them.
… …
875 790
876B<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
877the 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
878[default]; option B<+ls>. 793[default]; option B<+ls>.
879 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
880=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
881 801
882B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
883option 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>
884[default]; option B<+ut>. 804[default]; option B<+ut>.
… …
901=item B<scrollstyle:> I<mode> 821=item B<scrollstyle:> I<mode>
902 822
903Set 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
904the author's favourite. 824the author's favourite.
905 825
826=item B<thickness:> I<number>
827
828Set the scrollbar width in pixels.
829
906=item B<scrollBar:> I<boolean> 830=item B<scrollBar:> I<boolean>
907 831
908B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 832B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
909disable the scrollbar; option B<+sb>. 833disable the scrollbar; option B<+sb>.
910 834
… …
929B<False>: do not scroll to bottom when tty receives output; option 853B<False>: do not scroll to bottom when tty receives output; option
930B<+si>. 854B<+si>.
931 855
932=item B<scrollWithBuffer:> I<boolean> 856=item B<scrollWithBuffer:> I<boolean>
933 857
934B<True>: scroll with scrollback buffer when tty receives new lines (and 858B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
935B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 859try to show the same lines) and B<scrollTtyOutput> is False; option
936with 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>.
937 862
938=item B<scrollTtyKeypress:> I<boolean> 863=item B<scrollTtyKeypress:> I<boolean>
939 864
940B<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
941are those which are intercepted by rxvt-unicode for special handling and 866are those which are intercepted by rxvt-unicode for special handling and
… …
997=item B<cursorBlink:> I<boolean> 922=item B<cursorBlink:> I<boolean>
998 923
999B<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];
1000option B<-bc>. 925option B<-bc>.
1001 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
1002=item B<pointerBlank:> I<boolean> 932=item B<pointerBlank:> I<boolean>
1003 933
1004B<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
1005of seconds of inactivity. B<False>: the pointer is always visible 935of seconds of inactivity. B<False>: the pointer is always visible
1006[default]. 936[default].
… …
1019large number (e.g. C<987654321>) to effectively disable the timeout. 949large number (e.g. C<987654321>) to effectively disable the timeout.
1020 950
1021=item B<backspacekey:> I<string> 951=item B<backspacekey:> I<string>
1022 952
1023The 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>
1024or 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>
1025(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
1026escape sequence. 956escape sequence.
1027 957
1028=item B<deletekey:> I<string> 958=item B<deletekey:> I<string>
1029 959
… …
1125Sets the working directory for the shell (or the command specified via 1055Sets the working directory for the shell (or the command specified via
1126B<-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
1127@@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
1128directory will be used; option B<-cd>. 1058directory will be used; option B<-cd>.
1129 1059
1130=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
1131 1061
1132Compile I<frills>: Associate I<string> with keysym I<sym>. The 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1133intervening resource name B<keysym.> cannot be omitted. 1063resource name B<keysym.> cannot be omitted.
1134 1064
1135The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1065Using this resource, you can map key combinations such as
1136any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1066C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1137B<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
1138and 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
1139B<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>.
1140 1079
1141The 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
1142whatever 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
1143keys 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
1144current application keymap mode state. 1083current application keymap mode state.
1145 1084
1146The 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
1147searching 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
1148omitting 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
1149keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1097value (B<0x0000 - 0xFFFF>).
1150performed in an exact manner; however, the closest match is assured.
1151 1098
1152I<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
1153number), see RESOURCES in C<man 7 X> for futher details. 1101number), see RESOURCES in C<man 7 X> for further details.
1154 1102
1155You 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
1156with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1104of action, followed by a colon. An action string without colons is
1157should be a character not used by the strings. 1105interpreted as a literal string to pass to the tty (as if it was
1106prefixed with C<string:>).
1158 1107
1159Its usage can be demonstrated by an example: 1108The following action prefixes are known - extensions can provide
1109additional prefixes:
1160 1110
1161 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1111=over 4
1162 1112
1163The above line is equivalent to the following three lines: 1113=item string:STRING
1164 1114
1165 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1115If the I<action> starts with C<string:> (or otherwise contains no colons),
1166 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1116then the remaining C<STRING> will be passed to the program running in the
1167 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1117terminal. For example, you could replace whatever Shift-Tab outputs by the
1118string C<echo rm -rf /> followed by a newline:
1168 1119
1120 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1121
1122This could in theory be used to completely redefine your keymap.
1123
1124=item command:STRING
1125
1169If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1126If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1170is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1127is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1128the opposite of C<string:> - instead of sending it to the program running
1129in the terminal, it will be treated as if it were program output). This is
1130most useful to feed command sequences into @@RXVT_NAME@@.
1131
1171example the following means "change the current locale to C<zh_CN.GBK> 1132For example the following means "change the current locale to C<zh_CN.GBK>
1172when Control-Meta-c is being pressed": 1133when Control-Meta-c is being pressed":
1173 1134
1174 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1135 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1175 1136
1176If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1137The following example will map Control-Meta-1 and Control-Meta-2 to
1177is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1138the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1178manpage. For example, the F<selection> extension (activated via 1139font-switching at runtime:
1179C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1180 1140
1181 URxvt.keysym.M-C-c: perl:selection:rot13 1141 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1142 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1182 1143
1183Due the the large number of modifier combinations, a defined key mapping 1144Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1184will match if at I<at least> the specified identifiers are being set, and 1145info):
1185no other key mappings with those and more bits are being defined. That
1186means that defining a key map for C<a> will automatically provide
1187definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1188mappings themselves.
1189 1146
1190Unfortunately, this will override built-in key mappings. For example 1147 URxvt.keysym.M-C-3: command:\033[8;25;80t
1148 URxvt.keysym.M-C-4: command:\033[8;48;110t
1149
1150=item builtin:
1151
1152The builtin action is the action that @@RXVT_NAME@@ would execute if no
1153key binding existed for the key combination. The obvious use is to undo
1154the effect of existing bindings. The not so obvious use is to reinstate
1155bindings when another binding overrides too many modifiers.
1156
1191if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1157For example if you overwrite the C<Insert> key you will disable
1192C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1158@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1193user-defined keymap using the C<builtin:> replacement: 1159"holes" into the user-defined keymap using the C<builtin:> replacement:
1194 1160
1195 URxvt.keysym.Insert: <my insert key sequence> 1161 URxvt.keysym.Insert: <my insert key sequence>
1196 URxvt.keysym.S-Insert: builtin: 1162 URxvt.keysym.S-Insert: builtin:
1197 1163
1198The first line defines a mapping for C<Insert> and I<any> combination 1164The first line defines a mapping for C<Insert> and I<any> combination
1199of modifiers. The second line re-establishes the default mapping for 1165of modifiers. The second line re-establishes the default mapping for
1200C<Shift-Insert>. 1166C<Shift-Insert>.
1201 1167
1202The following example will map Control-Meta-1 and Control-Meta-2 to 1168=item builtin-string:
1203the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1204font-switching at runtime:
1205 1169
1206 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1170This action is mainly useful to restore string mappings for keys that
1207 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1171have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1172difficult to explain - basically, this action will send the string to the
1173application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1174action for it.
1208 1175
1209Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1176An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1210info): 1177selection when you press C<Shift-Insert>. With the following bindings, it
1178would instead emit the (undocumented, but what applications running in the
1179terminal might expect) sequence C<ESC [ 2 $> instead:
1211 1180
1212 URxvt.keysym.M-C-3: command:\033[8;25;80t 1181 URxvt.keysym.S-Insert: builtin-string:
1213 URxvt.keysym.M-C-4: command:\033[8;48;110t 1182 URxvt.keysym.C-S-Insert: builtin:
1183
1184The first line disables the paste functionality for that key
1185combination, and the second reinstates the default behaviour for
1186C<Control-Shift-Insert>, which would otherwise be overridden.
1187
1188Similarly, to let applications gain access to the C<C-M-c> (copy to
1189clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1190this:
1191
1192 URxvt.keysym.C-S-c: builtin-string:
1193 URxvt.keysym.C-S-v: builtin-string:
1194
1195=item EXTENSION:STRING
1196
1197An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1198extension of the same name. The extension will be loaded automatically if
1199necessary.
1200
1201Not all extensions define key actions, but popular extensions that do
1202include the I<selection> and I<matcher> extensions (documented in their
1203own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204respectively).
1205
1206From the silly examples department, this will rot13-"encrypt"
1207@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1208keyboards:
1209
1210 URxvt.keysym.M-C-c: selection:rot13
1211
1212=item perl:STRING *DEPRECATED*
1213
1214This is a deprecated way of passing key mappings to perl extensions. It is
1215still supported, but should not be used anymore.
1216
1217=back
1214 1218
1215=item B<perl-ext-common>: I<string> 1219=item B<perl-ext-common>: I<string>
1216 1220
1217=item B<perl-ext>: I<string> 1221=item B<perl-ext>: I<string>
1218 1222
… …
1220use in this terminal instance; option B<-pe>. 1224use in this terminal instance; option B<-pe>.
1221 1225
1222Extension names can be prefixed with a C<-> sign to prohibit using 1226Extension names can be prefixed with a C<-> sign to prohibit using
1223them. This can be useful to selectively disable some extensions loaded 1227them. This can be useful to selectively disable some extensions loaded
1224by default, or specified via the C<perl-ext-common> resource. For 1228by default, or specified via the C<perl-ext-common> resource. For
1225example, C<default,-selection> will use all the default extension except 1229example, C<default,-selection> will use all the default extensions except
1226C<selection>. 1230C<selection>.
1227 1231
1228Extension names can also be followed by an argument in angle brackets 1232The default set includes the C<selection>, C<option-popup>,
1229(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1233C<selection-popup> and C<readline> extensions, any extensions that define
1230searchable scrollback to Alt/Meta-s). Mentioning the same extension 1234keybindings via C<BINDING> meta comments, extensions loaded because
1231multiple times with different arguments will pass multiple arguments to 1235their resources/commandline switches were used, and extensions which are
1232the extension. 1236mentioned in B<keysym> resources.
1233 1237
1234Each extension is looked up in the library directories, loaded if 1238Each extension is looked up in the library directories, loaded if
1235necessary, and bound to the current terminal instance. 1239necessary, and bound to the current terminal instance. When the library
1240search path contains multiple extension files of the same name, then the
1241first one found will be used.
1236 1242
1237If both of these resources are the empty string, then the perl 1243If both of these resources are the empty string, then the perl interpreter
1238interpreter will not be initialized. The idea behind two options is that 1244will not be initialized. The rationale for having two options is that
1239B<perl-ext-common> will be used for extensions that should be available to 1245B<perl-ext-common> will be used for extensions that should be available to
1240all instances, while B<perl-ext> is used for specific instances. 1246all instances, while B<perl-ext> is used for specific instances.
1241 1247
1242=item B<perl-eval>: I<string> 1248=item B<perl-eval>: I<string>
1243 1249
… …
1245the @@RXVT_NAME@@perl(3) manpage. 1251the @@RXVT_NAME@@perl(3) manpage.
1246 1252
1247=item B<perl-lib>: I<path> 1253=item B<perl-lib>: I<path>
1248 1254
1249Colon-separated list of additional directories that hold extension 1255Colon-separated list of additional directories that hold extension
1250scripts. When looking for extensions specified by the C<perl> resource, 1256scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1251@@RXVT_NAME@@ will first look in these directories and then in 1257in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1252F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1258lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1253 1259
1254See the @@RXVT_NAME@@perl(3) manpage. 1260See the @@RXVT_NAME@@perl(3) manpage.
1255 1261
1256=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1262=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1257 1263
… …
1261=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1267=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1262 1268
1263Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1269Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1264for details. 1270for details.
1265 1271
1266=item B<searchable-scrollback:> I<keysym> 1272=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1267 1273
1268Sets the hotkey that starts the incremental scrollback buffer search 1274This resource is deprecated and will be removed. Use a B<keysym> resource
1269(default: C<M-s>). 1275instead, e.g.:
1270 1276
1277 URxvt.keysym.M-s: searchable-scrollback:start
1278
1271=item B<urlLauncher>: I<string> 1279=item B<url-launcher>: I<string>
1272 1280
1273Specifies the program to be started with a URL argument. Used by the 1281Specifies the program to be started with a URL argument. Used by the
1274C<selection-popup> and C<matcher> perl extensions. 1282C<selection-popup> and C<matcher> perl extensions.
1275 1283
1276=item B<transient-for>: I<windowid> 1284=item B<transient-for>: I<windowid>
… …
1280=item B<override-redirect>: I<boolean> 1288=item B<override-redirect>: I<boolean>
1281 1289
1282Compile I<frills>: Sets override-redirect for the terminal window, making 1290Compile I<frills>: Sets override-redirect for the terminal window, making
1283it almost invisible to window managers; option B<-override-redirect>. 1291it almost invisible to window managers; option B<-override-redirect>.
1284 1292
1293=item B<iso14755:> I<boolean>
1294
1295Turn on/off ISO 14755 (default enabled).
1296
1285=item B<iso14755_52:> I<boolean> 1297=item B<iso14755_52:> I<boolean>
1286 1298
1287Turn on/off ISO 14755 5.2 mode (default enabled). 1299Turn on/off ISO 14755 5.2 mode (default enabled).
1300
1301=back
1302
1303=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1304
1305=over 4
1306
1307=item B<-pixmap> I<file[;oplist]>
1308
1309=item B<backgroundPixmap:> I<file[;oplist]>
1310
1311Compile I<pixbuf>: Use the specified image file as the window's
1312background and also optionally specify a colon separated list of
1313operations to modify it. Note that you may need to quote the C<;>
1314character when using the command line option, as C<;> is usually a
1315metacharacter in shells. Supported operations are:
1316
1317=over 4
1318
1319=item B<WxH+X+Y>
1320
1321sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1322scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1323scale of 0 disables scaling.
1324
1325=item B<op=tile>
1326
1327enables tiling
1328
1329=item B<op=keep-aspect>
1330
1331maintain the image aspect ratio when scaling
1332
1333=item B<op=root-align>
1334
1335use the position of the terminal window relative to the root window as
1336the image offset, simulating a root window background
1337
1338=back
1339
1340The default scale and position setting is C<100x100+50+50>.
1341Alternatively, a predefined set of templates can be used to achieve
1342the most common setups:
1343
1344=over 4
1345
1346=item B<style=tiled>
1347
1348the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1349
1350=item B<style=aspect-stretched>
1351
1352the image is scaled to fill the whole window maintaining the aspect
1353ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1354
1355=item B<style=stretched>
1356
1357the image is scaled to fill the whole window. Equivalent to 100x100
1358
1359=item B<style=centered>
1360
1361the image is centered with no scaling. Equivalent to 0x0+50+50
1362
1363=item B<style=root-tiled>
1364
1365the image is tiled with no scaling and using 'root' positioning.
1366Equivalent to 0x0:op=tile:op=root-align
1367
1368=back
1369
1370If multiple templates are specified the last one wins. Note that a
1371template overrides all the scale, position and operations settings.
1372
1373If used in conjunction with pseudo-transparency, the specified pixmap
1374will be blended over the transparent background using alpha-blending.
1375
1376=item B<-tr>|B<+tr>
1377
1378=item B<transparent:> I<boolean>
1379
1380Turn on/off pseudo-transparency by using the root pixmap as background.
1381
1382B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1383will be removed in future versions.
1384
1385=item B<-tint> I<colour>
1386
1387=item B<tintColor:> I<colour>
1388
1389Tint the transparent background with the given colour. Note that a
1390black tint yields a completely black image while a white tint yields
1391the image unchanged.
1392
1393=item B<-sh> I<number>
1394
1395=item B<shading:> I<number>
1396
1397Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1398A value of 100 means no shading.
1399
1400=item B<-blr> I<HxV>
1401
1402=item B<blurRadius:> I<HxV>
1403
1404Apply gaussian blur with the specified radius to the transparent
1405background. If a single number is specified, the vertical and
1406horizontal radii are considered to be the same. Setting one of the
1407radii to 1 and the other to a large number creates interesting effects
1408on some backgrounds. The maximum radius value is 128. An horizontal or
1409vertical radius of 0 disables blurring.
1410
1411=item B<path:> I<path>
1412
1413Specify the colon-delimited search path for finding background image files.
1288 1414
1289=back 1415=back
1290 1416
1291=head1 THE SCROLLBAR 1417=head1 THE SCROLLBAR
1292 1418
… …
1340window causes the value of the PRIMARY selection (or CLIPBOARD with the 1466window causes the value of the PRIMARY selection (or CLIPBOARD with the
1341B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1467B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1342 1468
1343Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1469Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1344inserted too. 1470inserted too.
1471
1472rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1473<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1474binding causes the value of the internal selection to be copied to the
1475CLIPBOARD selection, while the second binding causes the value of the
1476CLIPBOARD selection to be inserted.
1345 1477
1346=back 1478=back
1347 1479
1348=head1 CHANGING FONTS 1480=head1 CHANGING FONTS
1349 1481
… …
1431B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1563B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1432it can be seen via the I<who(1)> command, and can accept messages. To 1564it can be seen via the I<who(1)> command, and can accept messages. To
1433allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1565allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1434on some systems or setgid to root or to some other group on others. 1566on some systems or setgid to root or to some other group on others.
1435 1567
1436=head1 COLORS AND GRAPHICS 1568=head1 COLOURS AND GRAPHICS
1437 1569
1438In addition to the default foreground and background colours, 1570In addition to the default foreground and background colours,
1439B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1571B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1440high-intensity bold/blink versions of the same). Here is a list of the 1572high-intensity (potentially bold/blink) versions of the same, and 72 (or
1441colours with their names. 1573240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1574cube plus a 8 (24) colour greyscale ramp.
1575
1576Here is a list of the ANSI colours with their names.
1442 1577
1443=begin table 1578=begin table
1444 1579
1445 B<color0> (black) = Black 1580 B<color0> (black) = Black
1446 B<color1> (red) = Red3 1581 B<color1> (red) = Red3
… …
1466It is also possible to specify the colour values of B<foreground>, 1601It is also possible to specify the colour values of B<foreground>,
1467B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1602B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1468a number 0-15, as a convenient shorthand to reference the colour name of 1603a number 0-15, as a convenient shorthand to reference the colour name of
1469color0-color15. 1604color0-color15.
1470 1605
1471In addition to the colours defined above, @@RXVT_NAME@@ offers an 1606The following text gives values for the standard 88 colour mode (and
1472additional 72 colours. The first 64 of those (with indices 16 to 79) 1607values for the 256 colour mode in parentheses).
1473consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
147416>), followed by 8 additional shades of gray (with indices 80 to 87).
1475 1608
1609The RGB cube uses indices 16..79 (16..231) using the following formulas:
1610
1611 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1612 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1613
1614The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1615steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1616the RGB cube.
1617
1476Together, all those colours implement the 88 colour xterm colours. Only 1618Together, all those colours implement the 88 (256) colour xterm
1477the first 16 can be changed using resources currently, the rest can only 1619colours. Only the first 16 can be changed using resources currently, the
1478be changed via command sequences ("escape codes"). 1620rest can only be changed via command sequences ("escape codes").
1621
1622Applications are advised to use terminfo or command sequences to discover
1623number and RGB values of all colours (yes, you can query this...).
1479 1624
1480Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1625Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1481always swapping the foreground/background colours. This is in contrast to 1626always swapping the foreground/background colours. This is in contrast to
1482I<xterm>(1) where the colours are only swapped if they have not otherwise 1627I<xterm>(1) where the colours are only swapped if they have not otherwise
1483been specified. For example, 1628been specified. For example,
1484 1629
1485=over 4
1486
1487=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1630 @@RXVT_NAME@@ -fg Black -bg White -rv
1488 1631
1489would yield White on Black, while on I<xterm>(1) it would yield Black 1632would yield White on Black, while on I<xterm>(1) it would yield Black on
1490on White. 1633White.
1491
1492=back
1493 1634
1494=head2 ALPHA CHANNEL SUPPORT 1635=head2 ALPHA CHANNEL SUPPORT
1495 1636
1496If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1637If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1497their act together, rxvt-unicode will do it's own alpha channel management: 1638their act together, rxvt-unicode will do its own alpha channel management:
1498 1639
1499You can prefix any color with an opaquenes percentage enclosed in 1640You can prefix any colour with an opaqueness percentage enclosed in
1500brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1641brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1501(0-100) that specifies the opacity of the color, where C<0> is completely 1642(0-100) that specifies the opacity of the colour, where C<0> is completely
1502transparent and C<100> is completely opaque. For example, C<[50]red> is a 1643transparent and C<100> is completely opaque. For example, C<[50]red> is a
1503half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1644half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1504is the recommended format to specify transparency values, and works with 1645is the recommended format to specify transparency values, and works with
1505all ways to specify a colour. 1646all ways to specify a colour.
1506 1647
… …
1584 1725
1585=item B<SHELL> 1726=item B<SHELL>
1586 1727
1587The shell to be used for command execution, defaults to C</bin/sh>. 1728The shell to be used for command execution, defaults to C</bin/sh>.
1588 1729
1589=item B<RXVT_SOCKET> 1730=item B<RXVT_SOCKET> [I<sic>]
1590 1731
1591The unix domain socket path used by @@RXVT_NAME@@c(1) and 1732The unix domain socket path used by @@RXVT_NAME@@c(1) and
1592@@RXVT_NAME@@d(1). 1733@@RXVT_NAME@@d(1).
1593 1734
1594Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1735Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1736
1737=item B<URXVT_PERL_LIB>
1738
1739Additional F<:>-separated library search path for perl extensions. Will be
1740searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1741directory.
1742
1743=item B<URXVT_PERL_VERBOSITY>
1744
1745See L<@@RXVT_NAME@@perl>(3).
1595 1746
1596=item B<HOME> 1747=item B<HOME>
1597 1748
1598Used to locate the default directory for the unix domain socket for 1749Used to locate the default directory for the unix domain socket for
1599daemon communications and to locate various resource files (such as 1750daemon communications and to locate various resource files (such as
1600C<.Xdefaults>) 1751C<.Xdefaults>)
1601 1752
1602=item B<XAPPLRESDIR> 1753=item B<XAPPLRESDIR>
1603 1754
1604Directory where various X resource files are being located. 1755Directory where application-specific X resource files are located.
1605 1756
1606=item B<XENVIRONMENT> 1757=item B<XENVIRONMENT>
1607 1758
1608If set and accessible, gives the name of a X resource file to be loaded by 1759If set and accessible, gives the name of a X resource file to be loaded by
1609@@RXVT_NAME@@. 1760@@RXVT_NAME@@.
… …
1614 1765
1615=over 4 1766=over 4
1616 1767
1617=item B</usr/lib/X11/rgb.txt> 1768=item B</usr/lib/X11/rgb.txt>
1618 1769
1619Color names. 1770Colour names.
1620 1771
1621=back 1772=back
1622 1773
1623=head1 SEE ALSO 1774=head1 SEE ALSO
1624 1775
1776@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1625@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1777@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1626 1778
1627=head1 CURRENT PROJECT COORDINATOR 1779=head1 CURRENT PROJECT COORDINATOR
1628 1780
1629=over 4 1781=over 4
1630 1782
1631=item Project Coordinator 1783=item Project Coordinator
1632 1784
1633Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1634 1786
1635L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1787L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1636 1788
1637=back 1789=back
1638 1790
… …
1642 1794
1643=item John Bovey 1795=item John Bovey
1644 1796
1645University of Kent, 1992, wrote the original Xvt. 1797University of Kent, 1992, wrote the original Xvt.
1646 1798
1647=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1799=item Rob Nation <nation@rocket.sanders.lockheed.com>
1648 1800
1649very heavily modified Xvt and came up with Rxvt 1801very heavily modified Xvt and came up with Rxvt
1650 1802
1651=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1803=item Angelo Haritsis <ah@doc.ic.ac.uk>
1652 1804
1653wrote the Greek Keyboard Input (no longer in code) 1805wrote the Greek Keyboard Input (no longer in code)
1654 1806
1655=item mj olesen L<< <olesen@me.QueensU.CA> >> 1807=item mj olesen <olesen@me.QueensU.CA>
1656 1808
1657Wrote the menu system. 1809Wrote the menu system.
1658 1810
1659Project Coordinator (changes.txt 2.11 to 2.21) 1811Project Coordinator (changes.txt 2.11 to 2.21)
1660 1812
1661=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1813=item Oezguer Kesim <kesim@math.fu-berlin.de>
1662 1814
1663Project Coordinator (changes.txt 2.21a to 2.4.5) 1815Project Coordinator (changes.txt 2.21a to 2.4.5)
1664 1816
1665=item Geoff Wing L<< <gcw@pobox.com> >> 1817=item Geoff Wing <gcw@pobox.com>
1666 1818
1667Rewrote screen display and text selection routines. 1819Rewrote screen display and text selection routines.
1668 1820
1669Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1821Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1670 1822
1671=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1823=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1672 1824
1673Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1825Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1674extension, random hacks, numerous bugfixes and extensions. 1826extension, random hacks, numerous bugfixes and extensions.
1675 1827
1676Project Coordinator (Changes 1.0 -) 1828Project Coordinator (Changes 1.0 -)
1677 1829
1678=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1830=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1679 1831
1680Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1832pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1681 1833
1682=back 1834=back
1683 1835

Diff Legend

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