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.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs.
Revision 1.229 by root, Sun Apr 27 20:26:28 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
… …
601Use 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
602corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
603high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
604colours. 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,
6053=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
606names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
607 580
608Colours 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
609changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
610 583
611Colours 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
… …
622=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
623 596
624Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
625foreground colour is the default. 598foreground colour is the default.
626 599
627=item B<colorRV:> I<colour>
628
629Use the specified colour as the background for reverse video characters
630when OPTION_HC is disabled (--disable-frills).
631
632=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
633 601
634If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
635itself. 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.
636 614
637=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
638 616
639Use 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
640foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
… …
647 625
648=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
649 627
650B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
651option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
652B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
653 631
654=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
655 633
656B<True>: specify that jump scrolling should be used. When receiving lots 634B<True>: specify that jump scrolling should be used. When receiving lots
657of 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
… …
671 649
672B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
673if 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
674monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
675 653
676=item B<transparent:> I<boolean>
677
678Turn on/off illusion of a transparent window background.
679
680B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
681future versions.
682
683I<Please address all transparency related issues to Sasha Vasko at
684sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
685
686=item B<fading:> I<number> 654=item B<fading:> I<number>
687 655
688Fade 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>.
689 657
690=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
691 659
692Fade 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
693colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
694 662
695=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
696 664
697Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
698B<-tint>.
699
700=item B<shading:> I<number>
701
702Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
703in addition to tinting it; option B<-sh>.
704
705=item B<blendType:> I<string>
706
707Specify background blending type; option B<-blt>.
708
709=item B<blurRadius:> I<number>
710
711Apply Gaussian Blurr with the specified radius to the transparent
712background image; option B<-blr>.
713 666
714=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
715 668
716Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
717 670
… …
722 675
723=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
724 677
725The 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
726and the text. 679and the text.
727
728=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
729
730Use the specified image file for the background and also
731optionally specify its scaling with a geometry string B<WxH+X+Y>,
732(default C<0x0+50+50>) in which B<"W" / "H"> specify the
733horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
734centre (percent). A scale of 0 displays the image with tiling. A scale
735of 1 displays the image without any scaling. A scale of 2 to 9 specifies
736an integer number of images in that direction. No image will be magnified
737beyond 10 times its original size. The maximum permitted scale is 1000.
738Additional operations can be specified after colon B<:op1:op2...>.
739Supported operations are:
740
741 tile force background image to be tiled and not scaled. Equivalent to 0x0
742 propscale will scale image keeping proportions
743 auto will scale image to match window size. Equivalent to 100x100
744 hscale will scale image horizontally to the window size
745 vscale will scale image vertically to the window size
746 scale will scale image to match window size
747 root will tile image as if it was a root window background, auto-adjusting
748 whenever terminal window moves
749
750If used in conjunction with B<-tr> option, the specified pixmap will be
751blended over transparency image using either alpha-blending, or any
752other blending type, specified with B<-blt "type"> option.
753
754=item B<path:> I<path>
755
756Specify the colon-delimited search path for finding background image files.
757 680
758=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
759 682
760Select 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
761that 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
… …
784it 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
785wide and 15 pixels high. 708wide and 15 pixels high.
786 709
787The 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
788the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
789the 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
790useful supplement. 713useful supplement.
791 714
792The 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
793are 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
794contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
… …
845=item B<urgentOnBell:> I<boolean> 768=item B<urgentOnBell:> I<boolean>
846 769
847B<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.
848B<False>: do not set the urgency hint [default]. 771B<False>: do not set the urgency hint [default].
849 772
773@@RXVT_NAME@@ resets the urgency hint on every focus change.
774
850=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
851 776
852B<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>.
853B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
854 779
… …
882=item B<scrollstyle:> I<mode> 807=item B<scrollstyle:> I<mode>
883 808
884Set 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
885the author's favourite. 810the author's favourite.
886 811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
815
887=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
888 817
889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
890disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
891 820
… …
910B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
911B<+si>. 840B<+si>.
912 841
913=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
914 843
915B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
916B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
917with 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>.
918 848
919=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
920 850
921B<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
922are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
… …
978=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
979 909
980B<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];
981option B<-bc>. 911option B<-bc>.
982 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
983=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
984 919
985B<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
986of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
987[default]. 922[default].
… …
1000large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
1001 936
1002=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
1003 938
1004The 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>
1005or 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>
1006(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
1007escape sequence. 942escape sequence.
1008 943
1009=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
1010 945
… …
1089 1024
1090=item B<secondaryScroll:> I<boolean> 1025=item B<secondaryScroll:> I<boolean>
1091 1026
1092Turn on/off secondary screen scroll (default enabled). If this 1027Turn on/off secondary screen scroll (default enabled). If this
1093option is enabled, scrolls on the secondary screen will change the 1028option is enabled, scrolls on the secondary screen will change the
1094scrollback buffer and switching to/from the secondary screen will 1029scrollback buffer and, when secondaryScreen is off, switching
1095instead scroll the screen up. 1030to/from the secondary screen will instead scroll the screen up.
1096 1031
1097=item B<hold>: I<boolean> 1032=item B<hold>: I<boolean>
1098 1033
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1034Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within 1035will not immediately destroy its window when the program executed within
1101it 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
1102user. 1037user.
1103 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
1104=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
1105 1047
1106Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1107intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
1108 1050
1109The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
1110any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1111B<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
1112and 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
1113B<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>.
1114 1065
1115The 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
1116whatever 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
1117keys 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
1118current application keymap mode state. 1069current application keymap mode state.
1119 1070
1120The 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
1121searching 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
1122omitting 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
1123keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
1124performed in an exact manner; however, the closest match is assured.
1125 1084
1126I<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
1127number), see RESOURCES in C<man 7 X> for futher details. 1087number), see RESOURCES in C<man 7 X> for further details.
1128 1088
1129You 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
1130with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1090of action, followed by a colon. An action strings without colons is
1131should be a character not used by the strings. 1091interpreted as a literal string to pass to the tty (as if they were
1092prefixed with C<string:>).
1132 1093
1133Its usage can be demonstrated by an example: 1094The following action prefixes are known - extensions can provide
1095additional prefixes:
1134 1096
1135 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1097=over 4
1136 1098
1137The above line is equivalent to the following three lines: 1099=item string:STRING
1138 1100
1139 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1140 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1102then the remaining C<STRING> will be passed to the program running in the
1141 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:
1142 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
1143If 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>
1144is 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
1145example 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>
1146when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1147 1120
1148 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
1149 1122
1150If 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
1151is 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
1152manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154 1126
1155 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
1156 1129
1157Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1158will match if at I<at least> the specified identifiers are being set, and 1131info):
1159no other key mappings with those and more bits are being defined. That
1160means that defining a key map for C<a> will automatically provide
1161definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1162mappings themselves.
1163 1132
1164Unfortunately, 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
1165if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1166C<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
1167user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1168 1146
1169 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1170 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1171 1149
1172The 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
1173of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1174C<Shift-Insert>. 1152C<Shift-Insert>.
1175 1153
1176The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item builtin-string:
1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1178font-switching at runtime:
1179 1155
1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156This action is mainly useful to restore string mappings for keys that
1181 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.
1182 1161
1183Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1162An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1184info): 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:
1185 1166
1186 URxvt.keysym.M-C-3: command:\033[8;25;80t 1167 URxvt.keysym.S-Insert: builtin-string:
1187 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 cna 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
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
1204
1205In addition, you can define a range of keysyms in one shot by loading
1206the C<keysym-list> perl extension and providing a I<string> with pattern
1207B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1208character not used by the strings.
1209
1210Its usage can be demonstrated by an example:
1211
1212 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1213
1214The above line is equivalent to the following three lines:
1215
1216 URxvt.keysym.Meta-Control-0x61: \033<a>
1217 URxvt.keysym.Meta-Control-0x62: \033<b>
1218 URxvt.keysym.Meta-Control-0x63: \033<c>
1188 1219
1189=item B<perl-ext-common>: I<string> 1220=item B<perl-ext-common>: I<string>
1190 1221
1191=item B<perl-ext>: I<string> 1222=item B<perl-ext>: I<string>
1192 1223
… …
1214all instances, while B<perl-ext> is used for specific instances. 1245all instances, while B<perl-ext> is used for specific instances.
1215 1246
1216=item B<perl-eval>: I<string> 1247=item B<perl-eval>: I<string>
1217 1248
1218Perl code to be evaluated when all extensions have been registered. See 1249Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1250the @@RXVT_NAME@@perl(3) manpage.
1220will be ignored when running setuid/setgid.
1221 1251
1222=item B<perl-lib>: I<path> 1252=item B<perl-lib>: I<path>
1223 1253
1224Colon-separated list of additional directories that hold extension 1254Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource, 1255scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1226@@RXVT_NAME@@ will first look in these directories and then in 1256in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1257lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228will be ignored when running setuid/setgid.
1229 1258
1230See the @@RXVT_NAME@@perl(3) manpage. 1259See the @@RXVT_NAME@@perl(3) manpage.
1231 1260
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1261=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233 1262
… …
1242=item B<searchable-scrollback:> I<keysym> 1271=item B<searchable-scrollback:> I<keysym>
1243 1272
1244Sets the hotkey that starts the incremental scrollback buffer search 1273Sets the hotkey that starts the incremental scrollback buffer search
1245(default: C<M-s>). 1274(default: C<M-s>).
1246 1275
1247=item B<urlLauncher>: I<string> 1276=item B<url-launcher>: I<string>
1248 1277
1249Specifies the program to be started with a URL argument. Used by the 1278Specifies the program to be started with a URL argument. Used by the
1250C<selection-popup> and C<matcher> perl extensions. 1279C<selection-popup> and C<matcher> perl extensions.
1251 1280
1252=item B<transient-for>: I<windowid> 1281=item B<transient-for>: I<windowid>
… …
1256=item B<override-redirect>: I<boolean> 1285=item B<override-redirect>: I<boolean>
1257 1286
1258Compile I<frills>: Sets override-redirect for the terminal window, making 1287Compile I<frills>: Sets override-redirect for the terminal window, making
1259it almost invisible to window managers; option B<-override-redirect>. 1288it almost invisible to window managers; option B<-override-redirect>.
1260 1289
1290=item B<iso14755:> I<boolean>
1291
1292Turn on/off ISO 14755 (default enabled).
1293
1261=item B<iso14755_52:> I<boolean> 1294=item B<iso14755_52:> I<boolean>
1262 1295
1263Turn on/off ISO 14755 5.2 mode (default enabled). 1296Turn on/off ISO 14755 5.2 mode (default enabled).
1297
1298=back
1299
1300=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1301
1302=over 4
1303
1304=item B<-pixmap> I<file[;oplist]>
1305
1306=item B<backgroundPixmap:> I<file[;oplist]>
1307
1308Compile I<pixbuf>: Use the specified image file as the window's
1309background and also optionally specify a colon separated list of
1310operations to modify it. Note that you may need to quote the C<;>
1311character when using the command line option, as C<;> is usually a
1312metacharacter in shells. Supported operations are:
1313
1314=over 4
1315
1316=item B<WxH+X+Y>
1317
1318sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1319scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1320scale of 0 disables scaling.
1321
1322=item B<op=tile>
1323
1324enables tiling
1325
1326=item B<op=keep-aspect>
1327
1328maintain the image aspect ratio when scaling
1329
1330=item B<op=root-align>
1331
1332use the position of the terminal window relative to the root window as
1333the image offset, simulating a root window background
1334
1335=back
1336
1337The default scale and position setting is C<100x100+50+50>.
1338Alternatively, a predefined set of templates can be used to achieve
1339the most common setups:
1340
1341=over 4
1342
1343=item B<style=tiled>
1344
1345the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1346
1347=item B<style=aspect-stretched>
1348
1349the image is scaled to fill the whole window maintaining the aspect
1350ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1351
1352=item B<style=stretched>
1353
1354the image is scaled to fill the whole window. Equivalent to 100x100
1355
1356=item B<style=centered>
1357
1358the image is centered with no scaling. Equivalent to 0x0+50+50
1359
1360=item B<style=root-tiled>
1361
1362the image is tiled with no scaling and using 'root' positioning.
1363Equivalent to 0x0:op=tile:op=root-align
1364
1365=back
1366
1367If multiple templates are specified the last one wins. Note that a
1368template overrides all the scale, position and operations settings.
1369
1370If used in conjunction with pseudo-transparency, the specified pixmap
1371will be blended over the transparent background using alpha-blending.
1372
1373=item B<-tr>|B<+tr>
1374
1375=item B<transparent:> I<boolean>
1376
1377Turn on/off pseudo-transparency by using the root pixmap as background.
1378
1379B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1380will be removed in future versions.
1381
1382=item B<-tint> I<colour>
1383
1384=item B<tintColor:> I<colour>
1385
1386Tint the transparent background with the given colour. Note that a
1387black tint yields a completely black image while a white tint yields
1388the image unchanged.
1389
1390=item B<-sh> I<number>
1391
1392=item B<shading:> I<number>
1393
1394Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1395A value of 100 means no shading.
1396
1397=item B<-blr> I<HxV>
1398
1399=item B<blurRadius:> I<HxV>
1400
1401Apply gaussian blur with the specified radius to the transparent
1402background. If a single number is specified, the vertical and
1403horizontal radii are considered to be the same. Setting one of the
1404radii to 1 and the other to a large number creates interesting effects
1405on some backgrounds. The maximum radius value is 128. An horizontal or
1406vertical radius of 0 disables blurring.
1407
1408=item B<path:> I<path>
1409
1410Specify the colon-delimited search path for finding background image files.
1264 1411
1265=back 1412=back
1266 1413
1267=head1 THE SCROLLBAR 1414=head1 THE SCROLLBAR
1268 1415
… …
1316window causes the value of the PRIMARY selection (or CLIPBOARD with the 1463window causes the value of the PRIMARY selection (or CLIPBOARD with the
1317B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1464B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1318 1465
1319Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1466Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1320inserted too. 1467inserted too.
1468
1469rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1470<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1471binding causes the value of the internal selection to be copied to the
1472CLIPBOARD selection, while the second binding causes the value of the
1473CLIPBOARD selection to be inserted.
1321 1474
1322=back 1475=back
1323 1476
1324=head1 CHANGING FONTS 1477=head1 CHANGING FONTS
1325 1478
… …
1407B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1560B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1408it can be seen via the I<who(1)> command, and can accept messages. To 1561it can be seen via the I<who(1)> command, and can accept messages. To
1409allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1562allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1410on some systems or setgid to root or to some other group on others. 1563on some systems or setgid to root or to some other group on others.
1411 1564
1412=head1 COLORS AND GRAPHICS 1565=head1 COLOURS AND GRAPHICS
1413 1566
1414In addition to the default foreground and background colours, 1567In addition to the default foreground and background colours,
1415B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1568B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1416high-intensity bold/blink versions of the same). Here is a list of the 1569high-intensity (potentially bold/blink) versions of the same, and 72 (or
1417colours with their names. 1570240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1571cube plus a 8 (24) colour greyscale ramp.
1572
1573Here is a list of the ANSI colours with their names.
1418 1574
1419=begin table 1575=begin table
1420 1576
1421 B<color0> (black) = Black 1577 B<color0> (black) = Black
1422 B<color1> (red) = Red3 1578 B<color1> (red) = Red3
… …
1442It is also possible to specify the colour values of B<foreground>, 1598It is also possible to specify the colour values of B<foreground>,
1443B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1599B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1444a number 0-15, as a convenient shorthand to reference the colour name of 1600a number 0-15, as a convenient shorthand to reference the colour name of
1445color0-color15. 1601color0-color15.
1446 1602
1447In addition to the colours defined above, @@RXVT_NAME@@ offers an 1603The following text gives values for the standard 88 colour mode (and
1448additional 72 colours. The first 64 of those (with indices 16 to 79) 1604values for the 256 colour mode in parentheses).
1449consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
145016>), followed by 8 additional shades of gray (with indices 80 to 87).
1451 1605
1606The RGB cube uses indices 16..79 (16..231) using the following formulas:
1607
1608 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1609 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1610
1611The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1612steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1613the RGB cube.
1614
1452Together, all those colours implement the 88 colour xterm colours. Only 1615Together, all those colours implement the 88 (256) colour xterm
1453the first 16 can be changed using resources currently, the rest can only 1616colours. Only the first 16 can be changed using resources currently, the
1454be changed via command sequences ("escape codes"). 1617rest can only be changed via command sequences ("escape codes").
1618
1619Applications are advised to use terminfo or command sequences to discover
1620number and RGB values of all colours (yes, you can query this...).
1455 1621
1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1622Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457always swapping the foreground/background colours. This is in contrast to 1623always swapping the foreground/background colours. This is in contrast to
1458I<xterm>(1) where the colours are only swapped if they have not otherwise 1624I<xterm>(1) where the colours are only swapped if they have not otherwise
1459been specified. For example, 1625been specified. For example,
1460 1626
1461=over 4
1462
1463=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1627 @@RXVT_NAME@@ -fg Black -bg White -rv
1464 1628
1465would yield White on Black, while on I<xterm>(1) it would yield Black 1629would yield White on Black, while on I<xterm>(1) it would yield Black on
1466on White. 1630White.
1467
1468=back
1469 1631
1470=head2 ALPHA CHANNEL SUPPORT 1632=head2 ALPHA CHANNEL SUPPORT
1471 1633
1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1634If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1473their act together, rxvt-unicode will do it's own alpha channel management: 1635their act together, rxvt-unicode will do its own alpha channel management:
1474 1636
1475You can prefix any color with an opaquenes percentage enclosed in 1637You can prefix any colour with an opaqueness percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1638brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477(0-100) that specifies the opacity of the color, where C<0> is completely 1639(0-100) that specifies the opacity of the colour, where C<0> is completely
1478transparent and C<100> is completely opaque. For example, C<[50]red> is a 1640transparent and C<100> is completely opaque. For example, C<[50]red> is a
1479half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1641half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with 1642is the recommended format to specify transparency values, and works with
1481all ways to specify a colour. 1643all ways to specify a colour.
1482 1644
… …
1553C<--with-terminfo=PATH>. 1715C<--with-terminfo=PATH>.
1554 1716
1555=item B<DISPLAY> 1717=item B<DISPLAY>
1556 1718
1557Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1719Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1558display in its child processes. 1720display in its child processes if C<-display> isn't used to override. It
1721defaults to C<:0> if it doesn't exist.
1559 1722
1560=item B<SHELL> 1723=item B<SHELL>
1561 1724
1562The shell to be used for command execution, defaults to C</bin/sh>. 1725The shell to be used for command execution, defaults to C</bin/sh>.
1563 1726
1564=item B<RXVT_SOCKET> 1727=item B<RXVT_SOCKET> [I<sic>]
1565 1728
1566The unix domain socket path used by @@RXVT_NAME@@c(1) and 1729The unix domain socket path used by @@RXVT_NAME@@c(1) and
1567@@RXVT_NAME@@d(1). 1730@@RXVT_NAME@@d(1).
1568 1731
1569Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1732Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1733
1734=item B<URXVT_PERL_LIB>
1735
1736Additional F<:>-separated library search path for perl extensions. Will be
1737searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1738directory.
1739
1740=item B<URXVT_PERL_VERBOSITY>
1741
1742See L<@@RXVT_NAME@@perl>(3).
1570 1743
1571=item B<HOME> 1744=item B<HOME>
1572 1745
1573Used to locate the default directory for the unix domain socket for 1746Used to locate the default directory for the unix domain socket for
1574daemon communications and to locate various resource files (such as 1747daemon communications and to locate various resource files (such as
1575C<.Xdefaults>) 1748C<.Xdefaults>)
1576 1749
1577=item B<XAPPLRESDIR> 1750=item B<XAPPLRESDIR>
1578 1751
1579Directory where various X resource files are being located. 1752Directory where application-specific X resource files are located.
1580 1753
1581=item B<XENVIRONMENT> 1754=item B<XENVIRONMENT>
1582 1755
1583If set and accessible, gives the name of a X resource file to be loaded by 1756If set and accessible, gives the name of a X resource file to be loaded by
1584@@RXVT_NAME@@. 1757@@RXVT_NAME@@.
… …
1589 1762
1590=over 4 1763=over 4
1591 1764
1592=item B</usr/lib/X11/rgb.txt> 1765=item B</usr/lib/X11/rgb.txt>
1593 1766
1594Color names. 1767Colour names.
1595 1768
1596=back 1769=back
1597 1770
1598=head1 SEE ALSO 1771=head1 SEE ALSO
1599 1772
1773@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1600@@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) 1774@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1601 1775
1602=head1 CURRENT PROJECT COORDINATOR 1776=head1 CURRENT PROJECT COORDINATOR
1603 1777
1604=over 4 1778=over 4
1605 1779
1606=item Project Coordinator 1780=item Project Coordinator
1607 1781
1608Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1782Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1609 1783
1610L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1784L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1611 1785
1612=back 1786=back
1613 1787
… …
1617 1791
1618=item John Bovey 1792=item John Bovey
1619 1793
1620University of Kent, 1992, wrote the original Xvt. 1794University of Kent, 1992, wrote the original Xvt.
1621 1795
1622=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1796=item Rob Nation <nation@rocket.sanders.lockheed.com>
1623 1797
1624very heavily modified Xvt and came up with Rxvt 1798very heavily modified Xvt and came up with Rxvt
1625 1799
1626=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1800=item Angelo Haritsis <ah@doc.ic.ac.uk>
1627 1801
1628wrote the Greek Keyboard Input (no longer in code) 1802wrote the Greek Keyboard Input (no longer in code)
1629 1803
1630=item mj olesen L<< <olesen@me.QueensU.CA> >> 1804=item mj olesen <olesen@me.QueensU.CA>
1631 1805
1632Wrote the menu system. 1806Wrote the menu system.
1633 1807
1634Project Coordinator (changes.txt 2.11 to 2.21) 1808Project Coordinator (changes.txt 2.11 to 2.21)
1635 1809
1636=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1810=item Oezguer Kesim <kesim@math.fu-berlin.de>
1637 1811
1638Project Coordinator (changes.txt 2.21a to 2.4.5) 1812Project Coordinator (changes.txt 2.21a to 2.4.5)
1639 1813
1640=item Geoff Wing L<< <gcw@pobox.com> >> 1814=item Geoff Wing <gcw@pobox.com>
1641 1815
1642Rewrote screen display and text selection routines. 1816Rewrote screen display and text selection routines.
1643 1817
1644Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1818Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1645 1819
1646=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1820=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1647 1821
1648Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1822Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1649extension, random hacks, numerous bugfixes and extensions. 1823extension, random hacks, numerous bugfixes and extensions.
1650 1824
1651Project Coordinator (Changes 1.0 -) 1825Project Coordinator (Changes 1.0 -)
1652 1826
1653=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1827=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1654 1828
1655Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1829pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1656 1830
1657=back 1831=back
1658 1832

Diff Legend

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