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.160 by root, Fri Jan 25 18:42:23 2008 UTC vs.
Revision 1.233 by sf-exg, Sat May 24 18:41:29 2014 UTC

92 92
93Print out a message describing available options. 93Print out a message describing available options.
94 94
95=item B<-display> I<displayname> 95=item B<-display> I<displayname>
96 96
97Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
98respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
99B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 127
123=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
124 129
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 131
137=item B<-fade> I<number> 132=item B<-fade> I<number>
138 133
139Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
143=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
144 139
145Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
147 142
148=item B<-tint> I<colour> 143=item B<-icon> I<file>
149 144
150Tint the transparent background pixmap with the given colour when 145Compile I<pixbuf>: Use the specified image as application icon. This
151transparency is enabled with B<-tr>. This only works for 146is used by many window managers, taskbars and pagers to represent the
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 147application window; resource I<iconFile>.
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186 148
187=item B<-bg> I<colour> 149=item B<-bg> I<colour>
188 150
189Window background colour; resource B<background>. 151Window background colour; resource B<background>.
190 152
191=item B<-fg> I<colour> 153=item B<-fg> I<colour>
192 154
193Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
194
195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196
197Compile I<afterimage>: Specify image file for the background and also
198optionally specify its scaling with a geometry string. Note you may need to
199add quotes to avoid special shell interpretation of the C<;> in the
200command-line; for more details see resource B<backgroundPixmap>.
201 156
202=item B<-cr> I<colour> 157=item B<-cr> I<colour>
203 158
204The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
205 160
315 270
316=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
317 272
318Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
319 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
320=item B<-iconic> 279=item B<-iconic>
321 280
322Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 282Alternative form is B<-ic>.
324 283
340 299
341=item B<-bl> 300=item B<-bl>
342 301
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 302Compile I<frills>: Set MWM hints to request a borderless window, i.e.
344if honoured by the WM, the rxvt-unicode window will not have window 303if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 304decorations; resource B<borderLess>. If the window manager does not
305support MWM hints (e.g. kwin), enables override-redirect mode.
346 306
347=item B<-override-redirect> 307=item B<-override-redirect>
348 308
349Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 310B<override-redirect>.
359=item B<-lsp> I<number> 319=item B<-lsp> I<number>
360 320
361Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
363B<lineSpace>. 323B<lineSpace>.
324
325=item B<-letsp> I<number>
326
327Compile I<frills>: Amount to adjust the computed character width by
328to control overall letter spacing. Negative values will tighten up the
329letter spacing, positive values will space letters out more. Useful to
330work around odd font metrics; resource B<letterSpace>.
364 331
365=item B<-tn> I<termname> 332=item B<-tn> I<termname>
366 333
367This option specifies the name of the terminal type to be set in the 334This option specifies the name of the terminal type to be set in the
368B<TERM> environment variable. This terminal type must exist in the 335B<TERM> environment variable. This terminal type must exist in the
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 423will not immediately destroy its window when the program executed within
457it exits. Instead, it will wait till it is being killed or closed by the 424it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>. 425user; resource B<hold>.
459 426
427=item B<-cd> I<path>
428
429Sets the working directory for the shell (or the command specified via
430B<-e>). The I<path> must be an absolute path and it must exist for
431@@RXVT_NAME@@ to start; resource B<chdir>.
432
460=item B<-xrm> I<string> 433=item B<-xrm> I<string>
461 434
462Works like the X Toolkit option of the same name, by adding the I<string> 435Works like the X Toolkit option of the same name, by adding the I<string>
463as if it were specified in a resource file. Resource values specified this 436as if it were specified in a resource file. Resource values specified this
464way take precedence over all other resource specifications. 437way take precedence over all other resource specifications.
547You can set and change the resources using X11 tools like B<xrdb>. Many 520You can set and change the resources using X11 tools like B<xrdb>. Many
548distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
549starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
551 524
552 1. system-wide app-defaults file, either locale-dependent OR global
553 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
555 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline 530 6. resources specified via -xrm on the commandline
558 531
559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
572=item B<depth:> I<bitdepth> 545=item B<depth:> I<bitdepth>
573 546
574Compile I<xft>: Attempt to find a visual with the given bit depth; 547Compile I<xft>: Attempt to find a visual with the given bit depth;
575option B<-depth>. 548option B<-depth>.
576 549
550=item B<buffered:> I<boolean>
551
552Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
553On some card/driver combination enabling it slightly decreases
554performance, on most it greatly helps it. The slowdown is small, so it
555should normally be enabled.
556
577=item B<geometry:> I<geom> 557=item B<geometry:> I<geom>
578 558
579Create the window with the specified X window geometry [default 80x24]; 559Create the window with the specified X window geometry [default 80x24];
580option B<-geometry>. 560option B<-geometry>.
581 561
594Use the specified colour for the colour value I<n>, where 0-7 574Use the specified colour for the colour value I<n>, where 0-7
595corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
596high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
597colours. The canonical names are as follows: 0=black, 1=red, 2=green, 577colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5983=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5783=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
599names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
600 580
601Colours higher than 15 cannot be set using resources (yet), but can be 581Colours higher than 15 cannot be set using resources (yet), but can be
602changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
603 583
604Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 584Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
615=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
616 596
617Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
618foreground colour is the default. 598foreground colour is the default.
619 599
620=item B<colorRV:> I<colour>
621
622Use the specified colour as the background for reverse video characters
623when OPTION_HC is disabled (--disable-frills).
624
625=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
626 601
627If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
628itself. If unset, use the foreground colour. 603itself. If unset, use the foreground colour.
604
605=item B<highlightColor:> I<colour>
606
607If set, use the specified colour as the background for highlighted
608characters. If unset, use reverse video.
609
610=item B<highlightTextColor:> I<colour>
611
612If set and highlightColor is set, use the specified colour as the
613foreground for highlighted characters.
629 614
630=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
631 616
632Use the specified colour for the cursor. The default is to use the 617Use the specified colour for the cursor. The default is to use the
633foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
640 625
641=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
642 627
643B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
644option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
645B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
646 631
647=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
648 633
649B<True>: specify that jump scrolling should be used. When receiving lots 634B<True>: specify that jump scrolling should be used. When receiving lots
650of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 635of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
664 649
665B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
666if the refresh is too fast for the human eye to read anything (or the 651if the refresh is too fast for the human eye to read anything (or the
667monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
668 653
669=item B<transparent:> I<boolean>
670
671Turn on/off illusion of a transparent window background.
672
673B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
674future versions.
675
676I<Please address all transparency related issues to Sasha Vasko at
677sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
678
679=item B<fading:> I<number> 654=item B<fading:> I<number>
680 655
681Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
682 657
683=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
684 659
685Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
686colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
687 662
688=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
689 664
690Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
691B<-tint>.
692
693=item B<shading:> I<number>
694
695Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
696in addition to tinting it; option B<-sh>.
697
698=item B<blendType:> I<string>
699
700Specify background blending type; option B<-blt>.
701
702=item B<blurRadius:> I<number>
703
704Apply Gaussian Blurr with the specified radius to the transparent
705background image; option B<-blr>.
706 666
707=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
708 668
709Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
710 670
715 675
716=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
717 677
718The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
719and the text. 679and the text.
720
721=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
722
723Use the specified image file for the background and also
724optionally specify its scaling with a geometry string B<WxH+X+Y>,
725(default C<0x0+50+50>) in which B<"W" / "H"> specify the
726horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
727centre (percent). A scale of 0 displays the image with tiling. A scale
728of 1 displays the image without any scaling. A scale of 2 to 9 specifies
729an integer number of images in that direction. No image will be magnified
730beyond 10 times its original size. The maximum permitted scale is 1000.
731Additional operations can be specified after colon B<:op1:op2...>.
732Supported operations are:
733
734 tile force background image to be tiled and not scaled. Equivalent to 0x0
735 propscale will scale image keeping proportions
736 auto will scale image to match window size. Equivalent to 100x100
737 hscale will scale image horizontally to the window size
738 vscale will scale image vertically to the window size
739 scale will scale image to match window size
740 root will tile image as if it was a root window background, auto-adjusting
741 whenever terminal window moves
742
743If used in conjunction with B<-tr> option, the specified pixmap will be
744blended over transparency image using either alpha-blending, or any
745other blending type, specified with B<-blt "type"> option.
746
747=item B<path:> I<path>
748
749Specify the colon-delimited search path for finding background image files.
750 680
751=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
752 682
753Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
754that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
777it is named first) and thus defines the character cell grid to be 9 pixels 707it is named first) and thus defines the character cell grid to be 9 pixels
778wide and 15 pixels high. 708wide and 15 pixels high.
779 709
780The second font is just used to add additional unicode characters not in 710The second font is just used to add additional unicode characters not in
781the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
782the bold version of the font does contain less characters, so this is a 712the bold version of the font does contain fewer characters, so this is a
783useful supplement. 713useful supplement.
784 714
785The third font is an Xft font with aliasing turned off, and the characters 715The third font is an Xft font with aliasing turned off, and the characters
786are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 716are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
787contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
838=item B<urgentOnBell:> I<boolean> 768=item B<urgentOnBell:> I<boolean>
839 769
840B<True>: set the urgency hint for the wm on receipt of a bell character. 770B<True>: set the urgency hint for the wm on receipt of a bell character.
841B<False>: do not set the urgency hint [default]. 771B<False>: do not set the urgency hint [default].
842 772
773@@RXVT_NAME@@ resets the urgency hint on every focus change.
774
843=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
844 776
845B<True>: use visual bell on receipt of a bell character; option B<-vb>. 777B<True>: use visual bell on receipt of a bell character; option B<-vb>.
846B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
847 779
875=item B<scrollstyle:> I<mode> 807=item B<scrollstyle:> I<mode>
876 808
877Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 809Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878the author's favourite. 810the author's favourite.
879 811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
880=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
881 817
882B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
883disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
884 820
903B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
904B<+si>. 840B<+si>.
905 841
906=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
907 843
908B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
909B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
910with scrollback buffer when tty receives new lines; option B<+sw>. 846B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
847new lines; option B<+sw>.
911 848
912=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
913 850
914B<True>: scroll to bottom when a non-special key is pressed. Special keys 851B<True>: scroll to bottom when a non-special key is pressed. Special keys
915are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
971=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
972 909
973B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 910B<True>: blink the cursor. B<False>: do not blink the cursor [default];
974option B<-bc>. 911option B<-bc>.
975 912
913=item B<cursorUnderline:> I<boolean>
914
915B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
916option B<-uc>.
917
976=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
977 919
978B<True>: blank the pointer when a key is pressed or after a set number 920B<True>: blank the pointer when a key is pressed or after a set number
979of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
980[default]. 922[default].
993large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
994 936
995=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
996 938
997The string to send when the backspace key is pressed. If set to B<DEC> 939The string to send when the backspace key is pressed. If set to B<DEC>
998or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 940or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
999(code 8) - which can be reversed with the appropriate DEC private mode 941(code 8) - which can be reversed with the appropriate DEC private mode
1000escape sequence. 942escape sequence.
1001 943
1002=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
1003 945
1082 1024
1083=item B<secondaryScroll:> I<boolean> 1025=item B<secondaryScroll:> I<boolean>
1084 1026
1085Turn on/off secondary screen scroll (default enabled). If this 1027Turn on/off secondary screen scroll (default enabled). If this
1086option is enabled, scrolls on the secondary screen will change the 1028option is enabled, scrolls on the secondary screen will change the
1087scrollback buffer and switching to/from the secondary screen will 1029scrollback buffer and, when secondaryScreen is off, switching
1088instead scroll the screen up. 1030to/from the secondary screen will instead scroll the screen up.
1089 1031
1090=item B<hold>: I<boolean> 1032=item B<hold>: I<boolean>
1091 1033
1092Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1034Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1093will not immediately destroy its window when the program executed within 1035will not immediately destroy its window when the program executed within
1094it exits. Instead, it will wait till it is being killed or closed by the 1036it exits. Instead, it will wait till it is being killed or closed by the
1095user. 1037user.
1096 1038
1039=item B<chdir>: I<path>
1040
1041Sets the working directory for the shell (or the command specified via
1042B<-e>). The I<path> must be an absolute path and it must exist for
1043@@RXVT_NAME@@ to start. If it isn't specified then the current working
1044directory will be used; option B<-cd>.
1045
1097=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1098 1047
1099Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1100intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1101 1050
1102The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1103any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1104B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1053string than would normally result from that combination, making the
1105and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1054terminal scroll up or down the way you want it, or any other thing an
1106B<2>, B<3>, B<4>, B<5>. 1055extension might provide.
1056
1057The key combination that triggers the action, I<sym>, has the following format:
1058
1059 (modifiers-)key
1060
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1062B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1107 1065
1108The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1066The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1109whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1067whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1110keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1068keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1111current application keymap mode state. 1069current application keymap mode state.
1112 1070
1113The spellings of I<key> can be obtained by using B<xev>(1) command or 1071Due the the large number of modifier combinations, a key mapping will
1114searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1072match if I<at least> the specified identifiers are being set, and no other
1073key mappings with those and more bits are being defined. That means that
1074defining a mapping for C<a> will automatically provide definitions for
1075C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1076themselves. See the C<builtin:> action, below, for a way to work around
1077this when this is a problem.
1078
1079The spelling of I<key> depends on your implementation of X. An easy way to
1080find a key name is to use the B<xev>(1) command. You can find a list by
1081looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1115omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1082the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1116keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1117performed in an exact manner; however, the closest match is assured.
1118 1084
1119I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1085As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1120number), see RESOURCES in C<man 7 X> for futher details. 1087number), see RESOURCES in C<man 7 X> for further details.
1121 1088
1122You can define a range of keysyms in one shot by providing a I<string> 1089An action starts with an action prefix that selects a certain type
1123with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1090of action, followed by a colon. An action string without colons is
1124should be a character not used by the strings. 1091interpreted as a literal string to pass to the tty (as if it was
1092prefixed with C<string:>).
1125 1093
1126Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1127 1096
1128 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1097=over 4
1129 1098
1130The above line is equivalent to the following three lines: 1099=item string:STRING
1131 1100
1132 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1133 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1102then the remaining C<STRING> will be passed to the program running in the
1134 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1103terminal. For example, you could replace whatever Shift-Tab outputs by the
1104string C<echo rm -rf /> followed by a newline:
1135 1105
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107
1108This could in theory be used to completely redefine your keymap.
1109
1110=item command:STRING
1111
1136If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1112If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1137is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1114the opposite of C<string:> - instead of sending it to the program running
1115in the terminal, it will be treated as if it were program output). This is
1116most useful to feed command sequences into @@RXVT_NAME@@.
1117
1138example the following means "change the current locale to C<zh_CN.GBK> 1118For example the following means "change the current locale to C<zh_CN.GBK>
1139when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1140 1120
1141 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1121 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1142 1122
1143If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1123The following example will map Control-Meta-1 and Control-Meta-2 to
1144is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1124the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1145manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1146C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1147 1126
1148 URxvt.keysym.M-C-c: perl:selection:rot13 1127 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1128 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1149 1129
1150Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1151will match if at I<at least> the specified identifiers are being set, and 1131info):
1152no other key mappings with those and more bits are being defined. That
1153means that defining a key map for C<a> will automatically provide
1154definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1155mappings themselves.
1156 1132
1157Unfortunately, this will override built-in key mappings. For example 1133 URxvt.keysym.M-C-3: command:\033[8;25;80t
1134 URxvt.keysym.M-C-4: command:\033[8;48;110t
1135
1136=item builtin:
1137
1138The builtin action is the action that @@RXVT_NAME@@ would execute if no
1139key binding existed for the key combination. The obvious use is to undo
1140the effect of existing bindings. The not so obvious use is to reinstate
1141bindings when another binding overrides too many modifiers.
1142
1158if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1159C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1144@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1160user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1161 1146
1162 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1163 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1164 1149
1165The first line defines a mapping for C<Insert> and I<any> combination 1150The first line defines a mapping for C<Insert> and I<any> combination
1166of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1167C<Shift-Insert>. 1152C<Shift-Insert>.
1168 1153
1169The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item builtin-string:
1170the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1171font-switching at runtime:
1172 1155
1173 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156This action is mainly useful to restore string mappings for keys that
1174 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1157have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1158difficult to explain - basically, this action will send the string to the
1159application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1160action for it.
1175 1161
1176Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1177info): 1163selection when you press C<Shift-Insert>. With the following bindings, it
1164would instead emit the (undocumented, but what applications running in the
1165terminal might expect) sequence C<ESC [ 2 $> instead:
1178 1166
1179 URxvt.keysym.M-C-3: command:\033[8;25;80t 1167 URxvt.keysym.S-Insert: builtin-string:
1180 URxvt.keysym.M-C-4: command:\033[8;48;110t 1168 URxvt.keysym.C-S-Insert: builtin:
1169
1170The first line disables the paste functionality for that key
1171combination, and the second reinstates the default behaviour for
1172C<Control-Shift-Insert>, which would otherwise be overridden.
1173
1174Similarly, to let applications gain access to the C<C-M-c> (copy to
1175clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this:
1177
1178 URxvt.keysym.C-S-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string:
1180
1181=item EXTENSION:STRING
1182
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1184extension of the same name. The extension will be loaded automatically if
1185neccessary.
1186
1187Not all extensions define key actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively).
1191
1192From the silly examples department, this will rot13-"encrypt"
1193@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1194keyboards:
1195
1196 URxvt.keysym.M-C-c: selection:rot13
1197
1198=item perl:STRING *DEPRECATED*
1199
1200This is a deprecated way of passing key mappings to perl extensions. It is
1201still supported, but should not be used anymore.
1202
1203=back
1181 1204
1182=item B<perl-ext-common>: I<string> 1205=item B<perl-ext-common>: I<string>
1183 1206
1184=item B<perl-ext>: I<string> 1207=item B<perl-ext>: I<string>
1185 1208
1187use in this terminal instance; option B<-pe>. 1210use in this terminal instance; option B<-pe>.
1188 1211
1189Extension names can be prefixed with a C<-> sign to prohibit using 1212Extension names can be prefixed with a C<-> sign to prohibit using
1190them. This can be useful to selectively disable some extensions loaded 1213them. This can be useful to selectively disable some extensions loaded
1191by default, or specified via the C<perl-ext-common> resource. For 1214by default, or specified via the C<perl-ext-common> resource. For
1192example, C<default,-selection> will use all the default extension except 1215example, C<default,-selection> will use all the default extensions except
1193C<selection>. 1216C<selection>.
1194 1217
1195Extension names can also be followed by an argument in angle brackets 1218The default set includes the C<selection>, C<option-popup>,
1196(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1219C<selection-popup> and C<readline> extensions, any extensions that define
1197searchable scrollback to Alt/Meta-s). Mentioning the same extension 1220keybindings via C<BINDING> meta comments, extensions loaded because
1198multiple times with different arguments will pass multiple arguments to 1221their resources/commandline switches were used, and extensions which are
1199the extension. 1222mentioned in B<keysym> resources.
1200 1223
1201Each extension is looked up in the library directories, loaded if 1224Each extension is looked up in the library directories, loaded if
1202necessary, and bound to the current terminal instance. 1225necessary, and bound to the current terminal instance. When the library
1226search path contains multiple extension files of the same name, then the
1227first one found will be used.
1203 1228
1204If both of these resources are the empty string, then the perl 1229If both of these resources are the empty string, then the perl interpreter
1205interpreter will not be initialized. The idea behind two options is that 1230will not be initialized. The rationale for having two options is that
1206B<perl-ext-common> will be used for extensions that should be available to 1231B<perl-ext-common> will be used for extensions that should be available to
1207all instances, while B<perl-ext> is used for specific instances. 1232all instances, while B<perl-ext> is used for specific instances.
1208 1233
1209=item B<perl-eval>: I<string> 1234=item B<perl-eval>: I<string>
1210 1235
1211Perl code to be evaluated when all extensions have been registered. See 1236Perl code to be evaluated when all extensions have been registered. See
1212the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1237the @@RXVT_NAME@@perl(3) manpage.
1213will be ignored when running setuid/setgid.
1214 1238
1215=item B<perl-lib>: I<path> 1239=item B<perl-lib>: I<path>
1216 1240
1217Colon-separated list of additional directories that hold extension 1241Colon-separated list of additional directories that hold extension
1218scripts. When looking for extensions specified by the C<perl> resource, 1242scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1219@@RXVT_NAME@@ will first look in these directories and then in 1243in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1220F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1244lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1221will be ignored when running setuid/setgid.
1222 1245
1223See the @@RXVT_NAME@@perl(3) manpage. 1246See the @@RXVT_NAME@@perl(3) manpage.
1224 1247
1225=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1248=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1226 1249
1230=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1253=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1231 1254
1232Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1255Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1233for details. 1256for details.
1234 1257
1235=item B<searchable-scrollback:> I<keysym> 1258=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1236 1259
1237Sets the hotkey that starts the incremental scrollback buffer search 1260This resource is deprecated and will be removed. Use a B<keysym> resource
1238(default: C<M-s>). 1261instead, e.g.:
1239 1262
1263 URxvt.keysym.M-s: searchable-scrollback:start
1264
1240=item B<urlLauncher>: I<string> 1265=item B<url-launcher>: I<string>
1241 1266
1242Specifies the program to be started with a URL argument. Used by the 1267Specifies the program to be started with a URL argument. Used by the
1243C<selection-popup> and C<matcher> perl extensions. 1268C<selection-popup> and C<matcher> perl extensions.
1244 1269
1245=item B<transient-for>: I<windowid> 1270=item B<transient-for>: I<windowid>
1249=item B<override-redirect>: I<boolean> 1274=item B<override-redirect>: I<boolean>
1250 1275
1251Compile I<frills>: Sets override-redirect for the terminal window, making 1276Compile I<frills>: Sets override-redirect for the terminal window, making
1252it almost invisible to window managers; option B<-override-redirect>. 1277it almost invisible to window managers; option B<-override-redirect>.
1253 1278
1279=item B<iso14755:> I<boolean>
1280
1281Turn on/off ISO 14755 (default enabled).
1282
1254=item B<iso14755_52:> I<boolean> 1283=item B<iso14755_52:> I<boolean>
1255 1284
1256Turn on/off ISO 14755 5.2 mode (default enabled). 1285Turn on/off ISO 14755 5.2 mode (default enabled).
1286
1287=back
1288
1289=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1290
1291=over 4
1292
1293=item B<-pixmap> I<file[;oplist]>
1294
1295=item B<backgroundPixmap:> I<file[;oplist]>
1296
1297Compile I<pixbuf>: Use the specified image file as the window's
1298background and also optionally specify a colon separated list of
1299operations to modify it. Note that you may need to quote the C<;>
1300character when using the command line option, as C<;> is usually a
1301metacharacter in shells. Supported operations are:
1302
1303=over 4
1304
1305=item B<WxH+X+Y>
1306
1307sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1308scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1309scale of 0 disables scaling.
1310
1311=item B<op=tile>
1312
1313enables tiling
1314
1315=item B<op=keep-aspect>
1316
1317maintain the image aspect ratio when scaling
1318
1319=item B<op=root-align>
1320
1321use the position of the terminal window relative to the root window as
1322the image offset, simulating a root window background
1323
1324=back
1325
1326The default scale and position setting is C<100x100+50+50>.
1327Alternatively, a predefined set of templates can be used to achieve
1328the most common setups:
1329
1330=over 4
1331
1332=item B<style=tiled>
1333
1334the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1335
1336=item B<style=aspect-stretched>
1337
1338the image is scaled to fill the whole window maintaining the aspect
1339ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1340
1341=item B<style=stretched>
1342
1343the image is scaled to fill the whole window. Equivalent to 100x100
1344
1345=item B<style=centered>
1346
1347the image is centered with no scaling. Equivalent to 0x0+50+50
1348
1349=item B<style=root-tiled>
1350
1351the image is tiled with no scaling and using 'root' positioning.
1352Equivalent to 0x0:op=tile:op=root-align
1353
1354=back
1355
1356If multiple templates are specified the last one wins. Note that a
1357template overrides all the scale, position and operations settings.
1358
1359If used in conjunction with pseudo-transparency, the specified pixmap
1360will be blended over the transparent background using alpha-blending.
1361
1362=item B<-tr>|B<+tr>
1363
1364=item B<transparent:> I<boolean>
1365
1366Turn on/off pseudo-transparency by using the root pixmap as background.
1367
1368B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1369will be removed in future versions.
1370
1371=item B<-tint> I<colour>
1372
1373=item B<tintColor:> I<colour>
1374
1375Tint the transparent background with the given colour. Note that a
1376black tint yields a completely black image while a white tint yields
1377the image unchanged.
1378
1379=item B<-sh> I<number>
1380
1381=item B<shading:> I<number>
1382
1383Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1384A value of 100 means no shading.
1385
1386=item B<-blr> I<HxV>
1387
1388=item B<blurRadius:> I<HxV>
1389
1390Apply gaussian blur with the specified radius to the transparent
1391background. If a single number is specified, the vertical and
1392horizontal radii are considered to be the same. Setting one of the
1393radii to 1 and the other to a large number creates interesting effects
1394on some backgrounds. The maximum radius value is 128. An horizontal or
1395vertical radius of 0 disables blurring.
1396
1397=item B<path:> I<path>
1398
1399Specify the colon-delimited search path for finding background image files.
1257 1400
1258=back 1401=back
1259 1402
1260=head1 THE SCROLLBAR 1403=head1 THE SCROLLBAR
1261 1404
1309window causes the value of the PRIMARY selection (or CLIPBOARD with the 1452window causes the value of the PRIMARY selection (or CLIPBOARD with the
1310B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1453B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1311 1454
1312Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1455Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1313inserted too. 1456inserted too.
1457
1458rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1459<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1460binding causes the value of the internal selection to be copied to the
1461CLIPBOARD selection, while the second binding causes the value of the
1462CLIPBOARD selection to be inserted.
1314 1463
1315=back 1464=back
1316 1465
1317=head1 CHANGING FONTS 1466=head1 CHANGING FONTS
1318 1467
1400B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1549B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1401it can be seen via the I<who(1)> command, and can accept messages. To 1550it can be seen via the I<who(1)> command, and can accept messages. To
1402allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1551allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1403on some systems or setgid to root or to some other group on others. 1552on some systems or setgid to root or to some other group on others.
1404 1553
1405=head1 COLORS AND GRAPHICS 1554=head1 COLOURS AND GRAPHICS
1406 1555
1407In addition to the default foreground and background colours, 1556In addition to the default foreground and background colours,
1408B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1557B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1409high-intensity bold/blink versions of the same). Here is a list of the 1558high-intensity (potentially bold/blink) versions of the same, and 72 (or
1410colours with their names. 1559240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1560cube plus a 8 (24) colour greyscale ramp.
1561
1562Here is a list of the ANSI colours with their names.
1411 1563
1412=begin table 1564=begin table
1413 1565
1414 B<color0> (black) = Black 1566 B<color0> (black) = Black
1415 B<color1> (red) = Red3 1567 B<color1> (red) = Red3
1435It is also possible to specify the colour values of B<foreground>, 1587It is also possible to specify the colour values of B<foreground>,
1436B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1588B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1437a number 0-15, as a convenient shorthand to reference the colour name of 1589a number 0-15, as a convenient shorthand to reference the colour name of
1438color0-color15. 1590color0-color15.
1439 1591
1440In addition to the colours defined above, @@RXVT_NAME@@ offers an 1592The following text gives values for the standard 88 colour mode (and
1441additional 72 colours. The first 64 of those (with indices 16 to 79) 1593values for the 256 colour mode in parentheses).
1442consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144316>), followed by 8 additional shades of gray (with indices 80 to 87).
1444 1594
1595The RGB cube uses indices 16..79 (16..231) using the following formulas:
1596
1597 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1598 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1599
1600The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1601steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1602the RGB cube.
1603
1445Together, all those colours implement the 88 colour xterm colours. Only 1604Together, all those colours implement the 88 (256) colour xterm
1446the first 16 can be changed using resources currently, the rest can only 1605colours. Only the first 16 can be changed using resources currently, the
1447be changed via command sequences ("escape codes"). 1606rest can only be changed via command sequences ("escape codes").
1607
1608Applications are advised to use terminfo or command sequences to discover
1609number and RGB values of all colours (yes, you can query this...).
1448 1610
1449Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1611Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1450always swapping the foreground/background colours. This is in contrast to 1612always swapping the foreground/background colours. This is in contrast to
1451I<xterm>(1) where the colours are only swapped if they have not otherwise 1613I<xterm>(1) where the colours are only swapped if they have not otherwise
1452been specified. For example, 1614been specified. For example,
1453 1615
1454=over 4
1455
1456=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1616 @@RXVT_NAME@@ -fg Black -bg White -rv
1457 1617
1458would yield White on Black, while on I<xterm>(1) it would yield Black 1618would yield White on Black, while on I<xterm>(1) it would yield Black on
1459on White. 1619White.
1460
1461=back
1462 1620
1463=head2 ALPHA CHANNEL SUPPORT 1621=head2 ALPHA CHANNEL SUPPORT
1464 1622
1465If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1623If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1466their act together, rxvt-unicode will do it's own alpha channel management: 1624their act together, rxvt-unicode will do its own alpha channel management:
1467 1625
1468You can prefix any color with an opaquenes percentage enclosed in 1626You can prefix any colour with an opaqueness percentage enclosed in
1469brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1627brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470(0-100) that specifies the opacity of the color, where C<0> is completely 1628(0-100) that specifies the opacity of the colour, where C<0> is completely
1471transparent and C<100> is completely opaque. For example, C<[50]red> is a 1629transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1630half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473is the recommended format to specify transparency values, and works with 1631is the recommended format to specify transparency values, and works with
1474all ways to specify a colour. 1632all ways to specify a colour.
1475 1633
1546C<--with-terminfo=PATH>. 1704C<--with-terminfo=PATH>.
1547 1705
1548=item B<DISPLAY> 1706=item B<DISPLAY>
1549 1707
1550Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1708Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1551display in its child processes. 1709display in its child processes if C<-display> isn't used to override. It
1710defaults to C<:0> if it doesn't exist.
1552 1711
1553=item B<SHELL> 1712=item B<SHELL>
1554 1713
1555The shell to be used for command execution, defaults to C</bin/sh>. 1714The shell to be used for command execution, defaults to C</bin/sh>.
1556 1715
1557=item B<RXVT_SOCKET> 1716=item B<RXVT_SOCKET> [I<sic>]
1558 1717
1559The unix domain socket path used by @@RXVT_NAME@@c(1) and 1718The unix domain socket path used by @@RXVT_NAME@@c(1) and
1560@@RXVT_NAME@@d(1). 1719@@RXVT_NAME@@d(1).
1561 1720
1562Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1721Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1722
1723=item B<URXVT_PERL_LIB>
1724
1725Additional F<:>-separated library search path for perl extensions. Will be
1726searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1727directory.
1728
1729=item B<URXVT_PERL_VERBOSITY>
1730
1731See L<@@RXVT_NAME@@perl>(3).
1563 1732
1564=item B<HOME> 1733=item B<HOME>
1565 1734
1566Used to locate the default directory for the unix domain socket for 1735Used to locate the default directory for the unix domain socket for
1567daemon communications and to locate various resource files (such as 1736daemon communications and to locate various resource files (such as
1568C<.Xdefaults>) 1737C<.Xdefaults>)
1569 1738
1570=item B<XAPPLRESDIR> 1739=item B<XAPPLRESDIR>
1571 1740
1572Directory where various X resource files are being located. 1741Directory where application-specific X resource files are located.
1573 1742
1574=item B<XENVIRONMENT> 1743=item B<XENVIRONMENT>
1575 1744
1576If set and accessible, gives the name of a X resource file to be loaded by 1745If set and accessible, gives the name of a X resource file to be loaded by
1577@@RXVT_NAME@@. 1746@@RXVT_NAME@@.
1582 1751
1583=over 4 1752=over 4
1584 1753
1585=item B</usr/lib/X11/rgb.txt> 1754=item B</usr/lib/X11/rgb.txt>
1586 1755
1587Color names. 1756Colour names.
1588 1757
1589=back 1758=back
1590 1759
1591=head1 SEE ALSO 1760=head1 SEE ALSO
1592 1761
1762@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1593@@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) 1763@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1594 1764
1595=head1 CURRENT PROJECT COORDINATOR 1765=head1 CURRENT PROJECT COORDINATOR
1596 1766
1597=over 4 1767=over 4
1598 1768
1599=item Project Coordinator 1769=item Project Coordinator
1600 1770
1601Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1771Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1602 1772
1603L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1773L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1604 1774
1605=back 1775=back
1606 1776
1610 1780
1611=item John Bovey 1781=item John Bovey
1612 1782
1613University of Kent, 1992, wrote the original Xvt. 1783University of Kent, 1992, wrote the original Xvt.
1614 1784
1615=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1785=item Rob Nation <nation@rocket.sanders.lockheed.com>
1616 1786
1617very heavily modified Xvt and came up with Rxvt 1787very heavily modified Xvt and came up with Rxvt
1618 1788
1619=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1789=item Angelo Haritsis <ah@doc.ic.ac.uk>
1620 1790
1621wrote the Greek Keyboard Input (no longer in code) 1791wrote the Greek Keyboard Input (no longer in code)
1622 1792
1623=item mj olesen L<< <olesen@me.QueensU.CA> >> 1793=item mj olesen <olesen@me.QueensU.CA>
1624 1794
1625Wrote the menu system. 1795Wrote the menu system.
1626 1796
1627Project Coordinator (changes.txt 2.11 to 2.21) 1797Project Coordinator (changes.txt 2.11 to 2.21)
1628 1798
1629=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1799=item Oezguer Kesim <kesim@math.fu-berlin.de>
1630 1800
1631Project Coordinator (changes.txt 2.21a to 2.4.5) 1801Project Coordinator (changes.txt 2.21a to 2.4.5)
1632 1802
1633=item Geoff Wing L<< <gcw@pobox.com> >> 1803=item Geoff Wing <gcw@pobox.com>
1634 1804
1635Rewrote screen display and text selection routines. 1805Rewrote screen display and text selection routines.
1636 1806
1637Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1807Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1638 1808
1639=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1809=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1640 1810
1641Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1811Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1642extension, random hacks, numerous bugfixes and extensions. 1812extension, random hacks, numerous bugfixes and extensions.
1643 1813
1644Project Coordinator (Changes 1.0 -) 1814Project Coordinator (Changes 1.0 -)
1645 1815
1646=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1816=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1647 1817
1648Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1818pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1649 1819
1650=back 1820=back
1651 1821

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines