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.236 by sf-exg, Sat Aug 16 10:51:23 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
… …
264 219
265=item B<-ls>|B<+ls> 220=item B<-ls>|B<+ls>
266 221
267Start as a login-shell/sub-shell; resource B<loginShell>. 222Start as a login-shell/sub-shell; resource B<loginShell>.
268 223
224=item B<-mc> I<milliseconds>
225
226Specify the maximum time between multi-click selections.
227
269=item B<-ut>|B<+ut> 228=item B<-ut>|B<+ut>
270 229
271Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 230Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
272B<utmpInhibit>. 231B<utmpInhibit>.
273 232
… …
315 274
316=item B<-bc>|B<+bc> 275=item B<-bc>|B<+bc>
317 276
318Blink the cursor; resource B<cursorBlink>. 277Blink the cursor; resource B<cursorBlink>.
319 278
279=item B<-uc>|B<+uc>
280
281Make the cursor underlined; resource B<cursorUnderline>.
282
320=item B<-iconic> 283=item B<-iconic>
321 284
322Start iconified, if the window manager supports that option. 285Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 286Alternative form is B<-ic>.
324 287
… …
340 303
341=item B<-bl> 304=item B<-bl>
342 305
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile 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 307if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 308decorations; resource B<borderLess>. If the window manager does not
309support MWM hints (e.g. kwin), enables override-redirect mode.
346 310
347=item B<-override-redirect> 311=item B<-override-redirect>
348 312
349Compile I<frills>: Sets override-redirect on the window; resource 313Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 314B<override-redirect>.
315
316=item B<-dockapp>
317
318Sets the initial state of the window to WithdrawnState, which makes
319window managers that support this extension treat it as a dockapp.
351 320
352=item B<-sbg> 321=item B<-sbg>
353 322
354Compile I<frills>: Disable the usage of the built-in block graphics/line 323Compile I<frills>: Disable the usage of the built-in block graphics/line
355drawing characters and just rely on what the specified fonts provide. Use 324drawing characters and just rely on what the specified fonts provide. Use
… …
359=item B<-lsp> I<number> 328=item B<-lsp> I<number>
360 329
361Compile I<frills>: Lines (pixel height) to insert between each row of 330Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 331the display. Useful to work around font rendering problems; resource
363B<lineSpace>. 332B<lineSpace>.
333
334=item B<-letsp> I<number>
335
336Compile I<frills>: Amount to adjust the computed character width by
337to control overall letter spacing. Negative values will tighten up the
338letter spacing, positive values will space letters out more. Useful to
339work around odd font metrics; resource B<letterSpace>.
364 340
365=item B<-tn> I<termname> 341=item B<-tn> I<termname>
366 342
367This option specifies the name of the terminal type to be set in the 343This option specifies the name of the terminal type to be set in the
368B<TERM> environment variable. This terminal type must exist in the 344B<TERM> environment variable. This terminal type must exist in the
… …
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 431Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 432will 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 433it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>. 434user; resource B<hold>.
459 435
436=item B<-cd> I<path>
437
438Sets the working directory for the shell (or the command specified via
439B<-e>). The I<path> must be an absolute path and it must exist for
440@@RXVT_NAME@@ to start; resource B<chdir>.
441
460=item B<-xrm> I<string> 442=item B<-xrm> I<string>
461 443
462Works like the X Toolkit option of the same name, by adding the I<string> 444Works 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 445as if it were specified in a resource file. Resource values specified this
464way take precedence over all other resource specifications. 446way take precedence over all other resource specifications.
… …
547You can set and change the resources using X11 tools like B<xrdb>. Many 529You can set and change the resources using X11 tools like B<xrdb>. Many
548distribution do also load settings from the B<~/.Xresources> file when X 530distribution do also load settings from the B<~/.Xresources> file when X
549starts. @@RXVT_NAME@@ will consult the following files/resources in order, 531starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550with later settings overwriting earlier ones: 532with later settings overwriting earlier ones:
551 533
552 1. system-wide app-defaults file, either locale-dependent OR global
553 2. app-defaults file in $XAPPLRESDIR 534 1. app-defaults file in $XAPPLRESDIR
535 2. $HOME/.Xdefaults
554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 536 3. RESOURCE_MANAGER property on root-window of screen 0
555 4. SCREEN_RESOURCES for the current screen 537 4. SCREEN_RESOURCES property on root-window of the current screen
556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 538 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline 539 6. resources specified via -xrm on the commandline
558 540
559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 541Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 542names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
601Use the specified colour for the colour value I<n>, where 0-7 583Use the specified colour for the colour value I<n>, where 0-7
602corresponds to low-intensity (normal) colours and 8-15 corresponds to 584corresponds to low-intensity (normal) colours and 8-15 corresponds to
603high-intensity (bold = bright foreground, blink = bright background) 585high-intensity (bold = bright foreground, blink = bright background)
604colours. The canonical names are as follows: 0=black, 1=red, 2=green, 586colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6053=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5873=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
606names used are listed in the B<COLORS AND GRAPHICS> section. 588names used are listed in the B<COLOURS AND GRAPHICS> section.
607 589
608Colours higher than 15 cannot be set using resources (yet), but can be 590Colours higher than 15 cannot be set using resources (yet), but can be
609changed using an escape command (see @@RXVT_NAME@@(7)). 591changed using an escape command (see @@RXVT_NAME@@(7)).
610 592
611Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 593Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
622=item B<colorUL:> I<colour> 604=item B<colorUL:> I<colour>
623 605
624Use the specified colour to display underlined characters when the 606Use the specified colour to display underlined characters when the
625foreground colour is the default. 607foreground colour is the default.
626 608
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> 609=item B<underlineColor:> I<colour>
633 610
634If set, use the specified colour as the colour for the underline 611If set, use the specified colour as the colour for the underline
635itself. If unset, use the foreground colour. 612itself. If unset, use the foreground colour.
613
614=item B<highlightColor:> I<colour>
615
616If set, use the specified colour as the background for highlighted
617characters. If unset, use reverse video.
618
619=item B<highlightTextColor:> I<colour>
620
621If set and highlightColor is set, use the specified colour as the
622foreground for highlighted characters.
636 623
637=item B<cursorColor:> I<colour> 624=item B<cursorColor:> I<colour>
638 625
639Use the specified colour for the cursor. The default is to use the 626Use the specified colour for the cursor. The default is to use the
640foreground colour; option B<-cr>. 627foreground colour; option B<-cr>.
… …
647 634
648=item B<reverseVideo:> I<boolean> 635=item B<reverseVideo:> I<boolean>
649 636
650B<True>: simulate reverse video by foreground and background colours; 637B<True>: simulate reverse video by foreground and background colours;
651option B<-rv>. B<False>: regular screen colours [default]; option 638option B<-rv>. B<False>: regular screen colours [default]; option
652B<+rv>. See note in B<COLORS AND GRAPHICS> section. 639B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
653 640
654=item B<jumpScroll:> I<boolean> 641=item B<jumpScroll:> I<boolean>
655 642
656B<True>: specify that jump scrolling should be used. When receiving lots 643B<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 644of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
671 658
672B<False>: specify that everything is to be displayed, even 659B<False>: specify that everything is to be displayed, even
673if the refresh is too fast for the human eye to read anything (or the 660if the refresh is too fast for the human eye to read anything (or the
674monitor to display anything); option B<+ss>. 661monitor to display anything); option B<+ss>.
675 662
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> 663=item B<fading:> I<number>
687 664
688Fade the text by the given percentage when focus is lost; option B<-fade>. 665Fade the text by the given percentage when focus is lost; option B<-fade>.
689 666
690=item B<fadeColor:> I<colour> 667=item B<fadeColor:> I<colour>
691 668
692Fade to this colour, when fading is used (see B<fading:>). The default 669Fade to this colour, when fading is used (see B<fading:>). The default
693colour is black; option B<-fadecolor>. 670colour is black; option B<-fadecolor>.
694 671
695=item B<tintColor:> I<colour> 672=item B<iconFile:> I<file>
696 673
697Tint the transparent background pixmap with the given colour; option 674Set 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 675
714=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
715 677
716Use the specified colour for the scrollbar [default #B2B2B2]. 678Use the specified colour for the scrollbar [default #B2B2B2].
717 679
… …
722 684
723=item B<borderColor:> I<colour> 685=item B<borderColor:> I<colour>
724 686
725The colour of the border around the text area and between the scrollbar 687The colour of the border around the text area and between the scrollbar
726and the text. 688and 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 689
758=item B<font:> I<fontlist> 690=item B<font:> I<fontlist>
759 691
760Select the fonts to be used. This is a comma separated list of font names 692Select the fonts to be used. This is a comma separated list of font names
761that are checked in order when trying to find glyphs for characters. The 693that are checked in order when trying to find glyphs for characters. The
… …
784it is named first) and thus defines the character cell grid to be 9 pixels 716it is named first) and thus defines the character cell grid to be 9 pixels
785wide and 15 pixels high. 717wide and 15 pixels high.
786 718
787The second font is just used to add additional unicode characters not in 719The second font is just used to add additional unicode characters not in
788the base font, likewise the third, which is unfortunately non-bold, but 720the 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 721the bold version of the font does contain fewer characters, so this is a
790useful supplement. 722useful supplement.
791 723
792The third font is an Xft font with aliasing turned off, and the characters 724The third font is an Xft font with aliasing turned off, and the characters
793are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 725are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
794contains other characters, but we are not interested in them. 726contains other characters, but we are not interested in them.
… …
845=item B<urgentOnBell:> I<boolean> 777=item B<urgentOnBell:> I<boolean>
846 778
847B<True>: set the urgency hint for the wm on receipt of a bell character. 779B<True>: set the urgency hint for the wm on receipt of a bell character.
848B<False>: do not set the urgency hint [default]. 780B<False>: do not set the urgency hint [default].
849 781
782@@RXVT_NAME@@ resets the urgency hint on every focus change.
783
850=item B<visualBell:> I<boolean> 784=item B<visualBell:> I<boolean>
851 785
852B<True>: use visual bell on receipt of a bell character; option B<-vb>. 786B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853B<False>: no visual bell [default]; option B<+vb>. 787B<False>: no visual bell [default]; option B<+vb>.
854 788
… …
856 790
857B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 791B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
858the shell; option B<-ls>. B<False>: start as a normal sub-shell 792the shell; option B<-ls>. B<False>: start as a normal sub-shell
859[default]; option B<+ls>. 793[default]; option B<+ls>.
860 794
795=item B<multiClickTime:> I<number>
796
797Specify the maximum time in milliseconds between multi-click select
798events. The default is 500 milliseconds; option B<-mc>.
799
861=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
862 801
863B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
864option B<-ut>. B<False>: write record into the system log file B<utmp> 803option B<-ut>. B<False>: write record into the system log file B<utmp>
865[default]; option B<+ut>. 804[default]; option B<+ut>.
… …
882=item B<scrollstyle:> I<mode> 821=item B<scrollstyle:> I<mode>
883 822
884Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 823Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885the author's favourite. 824the author's favourite.
886 825
826=item B<thickness:> I<number>
827
828Set the scrollbar width in pixels.
829
887=item B<scrollBar:> I<boolean> 830=item B<scrollBar:> I<boolean>
888 831
889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 832B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
890disable the scrollbar; option B<+sb>. 833disable the scrollbar; option B<+sb>.
891 834
… …
910B<False>: do not scroll to bottom when tty receives output; option 853B<False>: do not scroll to bottom when tty receives output; option
911B<+si>. 854B<+si>.
912 855
913=item B<scrollWithBuffer:> I<boolean> 856=item B<scrollWithBuffer:> I<boolean>
914 857
915B<True>: scroll with scrollback buffer when tty receives new lines (and 858B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
916B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 859try to show the same lines) and B<scrollTtyOutput> is False; option
917with scrollback buffer when tty receives new lines; option B<+sw>. 860B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
861new lines; option B<+sw>.
918 862
919=item B<scrollTtyKeypress:> I<boolean> 863=item B<scrollTtyKeypress:> I<boolean>
920 864
921B<True>: scroll to bottom when a non-special key is pressed. Special keys 865B<True>: scroll to bottom when a non-special key is pressed. Special keys
922are those which are intercepted by rxvt-unicode for special handling and 866are those which are intercepted by rxvt-unicode for special handling and
… …
978=item B<cursorBlink:> I<boolean> 922=item B<cursorBlink:> I<boolean>
979 923
980B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 924B<True>: blink the cursor. B<False>: do not blink the cursor [default];
981option B<-bc>. 925option B<-bc>.
982 926
927=item B<cursorUnderline:> I<boolean>
928
929B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
930option B<-uc>.
931
983=item B<pointerBlank:> I<boolean> 932=item B<pointerBlank:> I<boolean>
984 933
985B<True>: blank the pointer when a key is pressed or after a set number 934B<True>: blank the pointer when a key is pressed or after a set number
986of seconds of inactivity. B<False>: the pointer is always visible 935of seconds of inactivity. B<False>: the pointer is always visible
987[default]. 936[default].
… …
1000large number (e.g. C<987654321>) to effectively disable the timeout. 949large number (e.g. C<987654321>) to effectively disable the timeout.
1001 950
1002=item B<backspacekey:> I<string> 951=item B<backspacekey:> I<string>
1003 952
1004The string to send when the backspace key is pressed. If set to B<DEC> 953The string to send when the backspace key is pressed. If set to B<DEC>
1005or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 954or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1006(code 8) - which can be reversed with the appropriate DEC private mode 955(code 8) - which can be reversed with the appropriate DEC private mode
1007escape sequence. 956escape sequence.
1008 957
1009=item B<deletekey:> I<string> 958=item B<deletekey:> I<string>
1010 959
… …
1089 1038
1090=item B<secondaryScroll:> I<boolean> 1039=item B<secondaryScroll:> I<boolean>
1091 1040
1092Turn on/off secondary screen scroll (default enabled). If this 1041Turn on/off secondary screen scroll (default enabled). If this
1093option is enabled, scrolls on the secondary screen will change the 1042option is enabled, scrolls on the secondary screen will change the
1094scrollback buffer and switching to/from the secondary screen will 1043scrollback buffer and, when secondaryScreen is off, switching
1095instead scroll the screen up. 1044to/from the secondary screen will instead scroll the screen up.
1096 1045
1097=item B<hold>: I<boolean> 1046=item B<hold>: I<boolean>
1098 1047
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1048Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within 1049will 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 1050it exits. Instead, it will wait till it is being killed or closed by the
1102user. 1051user.
1103 1052
1053=item B<chdir>: I<path>
1054
1055Sets the working directory for the shell (or the command specified via
1056B<-e>). The I<path> must be an absolute path and it must exist for
1057@@RXVT_NAME@@ to start. If it isn't specified then the current working
1058directory will be used; option B<-cd>.
1059
1104=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
1105 1061
1106Compile I<frills>: Associate I<string> with keysym I<sym>. The 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1107intervening resource name B<keysym.> cannot be omitted. 1063resource name B<keysym.> cannot be omitted.
1108 1064
1109The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1065Using this resource, you can map key combinations such as
1110any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1066C<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>, 1067string 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>, 1068terminal scroll up or down the way you want it, or any other thing an
1113B<2>, B<3>, B<4>, B<5>. 1069extension might provide.
1070
1071The key combination that triggers the action, I<sym>, has the following format:
1072
1073 (modifiers-)key
1074
1075Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1076B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1077B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1078B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1114 1079
1115The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1080The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1116whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1081whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1117keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1082keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1118current application keymap mode state. 1083current application keymap mode state.
1119 1084
1120The spellings of I<key> can be obtained by using B<xev>(1) command or 1085Due the the large number of modifier combinations, a key mapping will
1121searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1086match if I<at least> the specified identifiers are being set, and no other
1087key mappings with those and more bits are being defined. That means that
1088defining a mapping for C<a> will automatically provide definitions for
1089C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1090themselves. See the C<builtin:> action, below, for a way to work around
1091this when this is a problem.
1092
1093The spelling of I<key> depends on your implementation of X. An easy way to
1094find a key name is to use the B<xev>(1) command. You can find a list by
1095looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1122omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1096the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1123keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1097value (B<0x0000 - 0xFFFF>).
1124performed in an exact manner; however, the closest match is assured.
1125 1098
1126I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1099As with any resource value, the I<action> string may contain backslash
1100escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1127number), see RESOURCES in C<man 7 X> for futher details. 1101number), see RESOURCES in C<man 7 X> for further details.
1128 1102
1129You can define a range of keysyms in one shot by providing a I<string> 1103An action starts with an action prefix that selects a certain type
1130with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1104of action, followed by a colon. An action string without colons is
1131should be a character not used by the strings. 1105interpreted as a literal string to pass to the tty (as if it was
1106prefixed with C<string:>).
1132 1107
1133Its usage can be demonstrated by an example: 1108The following action prefixes are known - extensions can provide
1109additional prefixes:
1134 1110
1135 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1111=over 4
1136 1112
1137The above line is equivalent to the following three lines: 1113=item string:STRING
1138 1114
1139 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1115If the I<action> starts with C<string:> (or otherwise contains no colons),
1140 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1116then the remaining C<STRING> will be passed to the program running in the
1141 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1117terminal. For example, you could replace whatever Shift-Tab outputs by the
1118string C<echo rm -rf /> followed by a newline:
1142 1119
1120 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1121
1122This could in theory be used to completely redefine your keymap.
1123
1124=item command:STRING
1125
1143If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1126If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1144is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1127is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1128the opposite of C<string:> - instead of sending it to the program running
1129in the terminal, it will be treated as if it were program output). This is
1130most useful to feed command sequences into @@RXVT_NAME@@.
1131
1145example the following means "change the current locale to C<zh_CN.GBK> 1132For example the following means "change the current locale to C<zh_CN.GBK>
1146when Control-Meta-c is being pressed": 1133when Control-Meta-c is being pressed":
1147 1134
1148 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1135 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1149 1136
1150If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1137The following example will map Control-Meta-1 and Control-Meta-2 to
1151is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1138the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1152manpage. For example, the F<selection> extension (activated via 1139font-switching at runtime:
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154 1140
1155 URxvt.keysym.M-C-c: perl:selection:rot13 1141 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1142 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1156 1143
1157Due the the large number of modifier combinations, a defined key mapping 1144Other 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 1145info):
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 1146
1164Unfortunately, this will override built-in key mappings. For example 1147 URxvt.keysym.M-C-3: command:\033[8;25;80t
1148 URxvt.keysym.M-C-4: command:\033[8;48;110t
1149
1150=item builtin:
1151
1152The builtin action is the action that @@RXVT_NAME@@ would execute if no
1153key binding existed for the key combination. The obvious use is to undo
1154the effect of existing bindings. The not so obvious use is to reinstate
1155bindings when another binding overrides too many modifiers.
1156
1165if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1157For 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 1158@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1167user-defined keymap using the C<builtin:> replacement: 1159"holes" into the user-defined keymap using the C<builtin:> replacement:
1168 1160
1169 URxvt.keysym.Insert: <my insert key sequence> 1161 URxvt.keysym.Insert: <my insert key sequence>
1170 URxvt.keysym.S-Insert: builtin: 1162 URxvt.keysym.S-Insert: builtin:
1171 1163
1172The first line defines a mapping for C<Insert> and I<any> combination 1164The first line defines a mapping for C<Insert> and I<any> combination
1173of modifiers. The second line re-establishes the default mapping for 1165of modifiers. The second line re-establishes the default mapping for
1174C<Shift-Insert>. 1166C<Shift-Insert>.
1175 1167
1176The following example will map Control-Meta-1 and Control-Meta-2 to 1168=item builtin-string:
1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1178font-switching at runtime:
1179 1169
1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1170This action is mainly useful to restore string mappings for keys that
1181 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1171have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1172difficult to explain - basically, this action will send the string to the
1173application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1174action for it.
1182 1175
1183Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1176An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1184info): 1177selection when you press C<Shift-Insert>. With the following bindings, it
1178would instead emit the (undocumented, but what applications running in the
1179terminal might expect) sequence C<ESC [ 2 $> instead:
1185 1180
1186 URxvt.keysym.M-C-3: command:\033[8;25;80t 1181 URxvt.keysym.S-Insert: builtin-string:
1187 URxvt.keysym.M-C-4: command:\033[8;48;110t 1182 URxvt.keysym.C-S-Insert: builtin:
1183
1184The first line disables the paste functionality for that key
1185combination, and the second reinstates the default behaviour for
1186C<Control-Shift-Insert>, which would otherwise be overridden.
1187
1188Similarly, to let applications gain access to the C<C-M-c> (copy to
1189clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1190this:
1191
1192 URxvt.keysym.C-S-c: builtin-string:
1193 URxvt.keysym.C-S-v: builtin-string:
1194
1195=item EXTENSION:STRING
1196
1197An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1198extension of the same name. The extension will be loaded automatically if
1199necessary.
1200
1201Not all extensions define key actions, but popular extensions that do
1202include the I<selection> and I<matcher> extensions (documented in their
1203own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204respectively).
1205
1206From the silly examples department, this will rot13-"encrypt"
1207@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1208keyboards:
1209
1210 URxvt.keysym.M-C-c: selection:rot13
1211
1212=item perl:STRING *DEPRECATED*
1213
1214This is a deprecated way of passing key mappings to perl extensions. It is
1215still supported, but should not be used anymore.
1216
1217=back
1188 1218
1189=item B<perl-ext-common>: I<string> 1219=item B<perl-ext-common>: I<string>
1190 1220
1191=item B<perl-ext>: I<string> 1221=item B<perl-ext>: I<string>
1192 1222
… …
1194use in this terminal instance; option B<-pe>. 1224use in this terminal instance; option B<-pe>.
1195 1225
1196Extension names can be prefixed with a C<-> sign to prohibit using 1226Extension names can be prefixed with a C<-> sign to prohibit using
1197them. This can be useful to selectively disable some extensions loaded 1227them. This can be useful to selectively disable some extensions loaded
1198by default, or specified via the C<perl-ext-common> resource. For 1228by default, or specified via the C<perl-ext-common> resource. For
1199example, C<default,-selection> will use all the default extension except 1229example, C<default,-selection> will use all the default extensions except
1200C<selection>. 1230C<selection>.
1201 1231
1202Extension names can also be followed by an argument in angle brackets 1232The default set includes the C<selection>, C<option-popup>,
1203(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1233C<selection-popup> and C<readline> extensions, any extensions that define
1204searchable scrollback to Alt/Meta-s). Mentioning the same extension 1234keybindings via C<BINDING> meta comments, extensions loaded because
1205multiple times with different arguments will pass multiple arguments to 1235their resources/commandline switches were used, and extensions which are
1206the extension. 1236mentioned in B<keysym> resources.
1207 1237
1208Each extension is looked up in the library directories, loaded if 1238Each extension is looked up in the library directories, loaded if
1209necessary, and bound to the current terminal instance. 1239necessary, and bound to the current terminal instance. When the library
1240search path contains multiple extension files of the same name, then the
1241first one found will be used.
1210 1242
1211If both of these resources are the empty string, then the perl 1243If both of these resources are the empty string, then the perl interpreter
1212interpreter will not be initialized. The idea behind two options is that 1244will not be initialized. The rationale for having two options is that
1213B<perl-ext-common> will be used for extensions that should be available to 1245B<perl-ext-common> will be used for extensions that should be available to
1214all instances, while B<perl-ext> is used for specific instances. 1246all instances, while B<perl-ext> is used for specific instances.
1215 1247
1216=item B<perl-eval>: I<string> 1248=item B<perl-eval>: I<string>
1217 1249
1218Perl code to be evaluated when all extensions have been registered. See 1250Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1251the @@RXVT_NAME@@perl(3) manpage.
1220will be ignored when running setuid/setgid.
1221 1252
1222=item B<perl-lib>: I<path> 1253=item B<perl-lib>: I<path>
1223 1254
1224Colon-separated list of additional directories that hold extension 1255Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource, 1256scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1226@@RXVT_NAME@@ will first look in these directories and then in 1257in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1258lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228will be ignored when running setuid/setgid.
1229 1259
1230See the @@RXVT_NAME@@perl(3) manpage. 1260See the @@RXVT_NAME@@perl(3) manpage.
1231 1261
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1262=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233 1263
… …
1237=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1267=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1238 1268
1239Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1269Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1240for details. 1270for details.
1241 1271
1242=item B<searchable-scrollback:> I<keysym> 1272=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1243 1273
1244Sets the hotkey that starts the incremental scrollback buffer search 1274This resource is deprecated and will be removed. Use a B<keysym> resource
1245(default: C<M-s>). 1275instead, e.g.:
1246 1276
1277 URxvt.keysym.M-s: searchable-scrollback:start
1278
1247=item B<urlLauncher>: I<string> 1279=item B<url-launcher>: I<string>
1248 1280
1249Specifies the program to be started with a URL argument. Used by the 1281Specifies the program to be started with a URL argument. Used by the
1250C<selection-popup> and C<matcher> perl extensions. 1282C<selection-popup> and C<matcher> perl extensions.
1251 1283
1252=item B<transient-for>: I<windowid> 1284=item B<transient-for>: I<windowid>
… …
1256=item B<override-redirect>: I<boolean> 1288=item B<override-redirect>: I<boolean>
1257 1289
1258Compile I<frills>: Sets override-redirect for the terminal window, making 1290Compile I<frills>: Sets override-redirect for the terminal window, making
1259it almost invisible to window managers; option B<-override-redirect>. 1291it almost invisible to window managers; option B<-override-redirect>.
1260 1292
1293=item B<iso14755:> I<boolean>
1294
1295Turn on/off ISO 14755 (default enabled).
1296
1261=item B<iso14755_52:> I<boolean> 1297=item B<iso14755_52:> I<boolean>
1262 1298
1263Turn on/off ISO 14755 5.2 mode (default enabled). 1299Turn on/off ISO 14755 5.2 mode (default enabled).
1300
1301=back
1302
1303=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1304
1305=over 4
1306
1307=item B<-pixmap> I<file[;oplist]>
1308
1309=item B<backgroundPixmap:> I<file[;oplist]>
1310
1311Compile I<pixbuf>: Use the specified image file as the window's
1312background and also optionally specify a colon separated list of
1313operations to modify it. Note that you may need to quote the C<;>
1314character when using the command line option, as C<;> is usually a
1315metacharacter in shells. Supported operations are:
1316
1317=over 4
1318
1319=item B<WxH+X+Y>
1320
1321sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1322scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1323scale of 0 disables scaling.
1324
1325=item B<op=tile>
1326
1327enables tiling
1328
1329=item B<op=keep-aspect>
1330
1331maintain the image aspect ratio when scaling
1332
1333=item B<op=root-align>
1334
1335use the position of the terminal window relative to the root window as
1336the image offset, simulating a root window background
1337
1338=back
1339
1340The default scale and position setting is C<100x100+50+50>.
1341Alternatively, a predefined set of templates can be used to achieve
1342the most common setups:
1343
1344=over 4
1345
1346=item B<style=tiled>
1347
1348the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1349
1350=item B<style=aspect-stretched>
1351
1352the image is scaled to fill the whole window maintaining the aspect
1353ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1354
1355=item B<style=stretched>
1356
1357the image is scaled to fill the whole window. Equivalent to 100x100
1358
1359=item B<style=centered>
1360
1361the image is centered with no scaling. Equivalent to 0x0+50+50
1362
1363=item B<style=root-tiled>
1364
1365the image is tiled with no scaling and using 'root' positioning.
1366Equivalent to 0x0:op=tile:op=root-align
1367
1368=back
1369
1370If multiple templates are specified the last one wins. Note that a
1371template overrides all the scale, position and operations settings.
1372
1373If used in conjunction with pseudo-transparency, the specified pixmap
1374will be blended over the transparent background using alpha-blending.
1375
1376=item B<-tr>|B<+tr>
1377
1378=item B<transparent:> I<boolean>
1379
1380Turn on/off pseudo-transparency by using the root pixmap as background.
1381
1382B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1383will be removed in future versions.
1384
1385=item B<-tint> I<colour>
1386
1387=item B<tintColor:> I<colour>
1388
1389Tint the transparent background with the given colour. Note that a
1390black tint yields a completely black image while a white tint yields
1391the image unchanged.
1392
1393=item B<-sh> I<number>
1394
1395=item B<shading:> I<number>
1396
1397Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1398A value of 100 means no shading.
1399
1400=item B<-blr> I<HxV>
1401
1402=item B<blurRadius:> I<HxV>
1403
1404Apply gaussian blur with the specified radius to the transparent
1405background. If a single number is specified, the vertical and
1406horizontal radii are considered to be the same. Setting one of the
1407radii to 1 and the other to a large number creates interesting effects
1408on some backgrounds. The maximum radius value is 128. An horizontal or
1409vertical radius of 0 disables blurring.
1410
1411=item B<path:> I<path>
1412
1413Specify the colon-delimited search path for finding background image files.
1264 1414
1265=back 1415=back
1266 1416
1267=head1 THE SCROLLBAR 1417=head1 THE SCROLLBAR
1268 1418
… …
1316window causes the value of the PRIMARY selection (or CLIPBOARD with the 1466window 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. 1467B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1318 1468
1319Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1469Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1320inserted too. 1470inserted too.
1471
1472rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1473<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1474binding causes the value of the internal selection to be copied to the
1475CLIPBOARD selection, while the second binding causes the value of the
1476CLIPBOARD selection to be inserted.
1321 1477
1322=back 1478=back
1323 1479
1324=head1 CHANGING FONTS 1480=head1 CHANGING FONTS
1325 1481
… …
1407B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1563B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1408it can be seen via the I<who(1)> command, and can accept messages. To 1564it can be seen via the I<who(1)> command, and can accept messages. To
1409allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1565allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1410on some systems or setgid to root or to some other group on others. 1566on some systems or setgid to root or to some other group on others.
1411 1567
1412=head1 COLORS AND GRAPHICS 1568=head1 COLOURS AND GRAPHICS
1413 1569
1414In addition to the default foreground and background colours, 1570In addition to the default foreground and background colours,
1415B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1571B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1416high-intensity bold/blink versions of the same). Here is a list of the 1572high-intensity (potentially bold/blink) versions of the same, and 72 (or
1417colours with their names. 1573240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1574cube plus a 8 (24) colour greyscale ramp.
1575
1576Here is a list of the ANSI colours with their names.
1418 1577
1419=begin table 1578=begin table
1420 1579
1421 B<color0> (black) = Black 1580 B<color0> (black) = Black
1422 B<color1> (red) = Red3 1581 B<color1> (red) = Red3
… …
1442It is also possible to specify the colour values of B<foreground>, 1601It is also possible to specify the colour values of B<foreground>,
1443B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1602B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1444a number 0-15, as a convenient shorthand to reference the colour name of 1603a number 0-15, as a convenient shorthand to reference the colour name of
1445color0-color15. 1604color0-color15.
1446 1605
1447In addition to the colours defined above, @@RXVT_NAME@@ offers an 1606The following text gives values for the standard 88 colour mode (and
1448additional 72 colours. The first 64 of those (with indices 16 to 79) 1607values 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 1608
1609The RGB cube uses indices 16..79 (16..231) using the following formulas:
1610
1611 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1612 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1613
1614The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1615steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1616the RGB cube.
1617
1452Together, all those colours implement the 88 colour xterm colours. Only 1618Together, all those colours implement the 88 (256) colour xterm
1453the first 16 can be changed using resources currently, the rest can only 1619colours. Only the first 16 can be changed using resources currently, the
1454be changed via command sequences ("escape codes"). 1620rest can only be changed via command sequences ("escape codes").
1621
1622Applications are advised to use terminfo or command sequences to discover
1623number and RGB values of all colours (yes, you can query this...).
1455 1624
1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1625Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457always swapping the foreground/background colours. This is in contrast to 1626always swapping the foreground/background colours. This is in contrast to
1458I<xterm>(1) where the colours are only swapped if they have not otherwise 1627I<xterm>(1) where the colours are only swapped if they have not otherwise
1459been specified. For example, 1628been specified. For example,
1460 1629
1461=over 4
1462
1463=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1630 @@RXVT_NAME@@ -fg Black -bg White -rv
1464 1631
1465would yield White on Black, while on I<xterm>(1) it would yield Black 1632would yield White on Black, while on I<xterm>(1) it would yield Black on
1466on White. 1633White.
1467
1468=back
1469 1634
1470=head2 ALPHA CHANNEL SUPPORT 1635=head2 ALPHA CHANNEL SUPPORT
1471 1636
1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1637If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1473their act together, rxvt-unicode will do it's own alpha channel management: 1638their act together, rxvt-unicode will do its own alpha channel management:
1474 1639
1475You can prefix any color with an opaquenes percentage enclosed in 1640You can prefix any colour with an opaqueness percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1641brackets, 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 1642(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 1643transparent 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 1644half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with 1645is the recommended format to specify transparency values, and works with
1481all ways to specify a colour. 1646all ways to specify a colour.
1482 1647
… …
1553C<--with-terminfo=PATH>. 1718C<--with-terminfo=PATH>.
1554 1719
1555=item B<DISPLAY> 1720=item B<DISPLAY>
1556 1721
1557Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1722Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1558display in its child processes. 1723display in its child processes if C<-display> isn't used to override. It
1724defaults to C<:0> if it doesn't exist.
1559 1725
1560=item B<SHELL> 1726=item B<SHELL>
1561 1727
1562The shell to be used for command execution, defaults to C</bin/sh>. 1728The shell to be used for command execution, defaults to C</bin/sh>.
1563 1729
1564=item B<RXVT_SOCKET> 1730=item B<RXVT_SOCKET> [I<sic>]
1565 1731
1566The unix domain socket path used by @@RXVT_NAME@@c(1) and 1732The unix domain socket path used by @@RXVT_NAME@@c(1) and
1567@@RXVT_NAME@@d(1). 1733@@RXVT_NAME@@d(1).
1568 1734
1569Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1735Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1736
1737=item B<URXVT_PERL_LIB>
1738
1739Additional F<:>-separated library search path for perl extensions. Will be
1740searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1741directory.
1742
1743=item B<URXVT_PERL_VERBOSITY>
1744
1745See L<@@RXVT_NAME@@perl>(3).
1570 1746
1571=item B<HOME> 1747=item B<HOME>
1572 1748
1573Used to locate the default directory for the unix domain socket for 1749Used to locate the default directory for the unix domain socket for
1574daemon communications and to locate various resource files (such as 1750daemon communications and to locate various resource files (such as
1575C<.Xdefaults>) 1751C<.Xdefaults>)
1576 1752
1577=item B<XAPPLRESDIR> 1753=item B<XAPPLRESDIR>
1578 1754
1579Directory where various X resource files are being located. 1755Directory where application-specific X resource files are located.
1580 1756
1581=item B<XENVIRONMENT> 1757=item B<XENVIRONMENT>
1582 1758
1583If set and accessible, gives the name of a X resource file to be loaded by 1759If set and accessible, gives the name of a X resource file to be loaded by
1584@@RXVT_NAME@@. 1760@@RXVT_NAME@@.
… …
1589 1765
1590=over 4 1766=over 4
1591 1767
1592=item B</usr/lib/X11/rgb.txt> 1768=item B</usr/lib/X11/rgb.txt>
1593 1769
1594Color names. 1770Colour names.
1595 1771
1596=back 1772=back
1597 1773
1598=head1 SEE ALSO 1774=head1 SEE ALSO
1599 1775
1776@@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) 1777@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1601 1778
1602=head1 CURRENT PROJECT COORDINATOR 1779=head1 CURRENT PROJECT COORDINATOR
1603 1780
1604=over 4 1781=over 4
1605 1782
1606=item Project Coordinator 1783=item Project Coordinator
1607 1784
1608Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1609 1786
1610L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1787L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1611 1788
1612=back 1789=back
1613 1790
… …
1617 1794
1618=item John Bovey 1795=item John Bovey
1619 1796
1620University of Kent, 1992, wrote the original Xvt. 1797University of Kent, 1992, wrote the original Xvt.
1621 1798
1622=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1799=item Rob Nation <nation@rocket.sanders.lockheed.com>
1623 1800
1624very heavily modified Xvt and came up with Rxvt 1801very heavily modified Xvt and came up with Rxvt
1625 1802
1626=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1803=item Angelo Haritsis <ah@doc.ic.ac.uk>
1627 1804
1628wrote the Greek Keyboard Input (no longer in code) 1805wrote the Greek Keyboard Input (no longer in code)
1629 1806
1630=item mj olesen L<< <olesen@me.QueensU.CA> >> 1807=item mj olesen <olesen@me.QueensU.CA>
1631 1808
1632Wrote the menu system. 1809Wrote the menu system.
1633 1810
1634Project Coordinator (changes.txt 2.11 to 2.21) 1811Project Coordinator (changes.txt 2.11 to 2.21)
1635 1812
1636=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1813=item Oezguer Kesim <kesim@math.fu-berlin.de>
1637 1814
1638Project Coordinator (changes.txt 2.21a to 2.4.5) 1815Project Coordinator (changes.txt 2.21a to 2.4.5)
1639 1816
1640=item Geoff Wing L<< <gcw@pobox.com> >> 1817=item Geoff Wing <gcw@pobox.com>
1641 1818
1642Rewrote screen display and text selection routines. 1819Rewrote screen display and text selection routines.
1643 1820
1644Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1821Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1645 1822
1646=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1823=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1647 1824
1648Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1825Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1649extension, random hacks, numerous bugfixes and extensions. 1826extension, random hacks, numerous bugfixes and extensions.
1650 1827
1651Project Coordinator (Changes 1.0 -) 1828Project Coordinator (Changes 1.0 -)
1652 1829
1653=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1830=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1654 1831
1655Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1832pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1656 1833
1657=back 1834=back
1658 1835

Diff Legend

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