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.201 by sf-exg, Wed Aug 10 07:34:35 2011 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<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
124 124
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126 126
127=item B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
128 128
129Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130 130
131B<-ip> is still accepted as an obsolete alias but will be removed in 131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions. 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 133
137=item B<-fade> I<number> 134=item B<-fade> I<number>
138 135
139Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
145Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
147 144
148=item B<-tint> I<colour> 145=item B<-tint> I<colour>
149 146
150Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
151transparency is enabled with B<-tr>. This only works for 148resource I<tintColor>.
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161 149
162=item B<-sh> I<number> 150=item B<-sh> I<number>
163 151
164Darken (0 .. 100) or lighten (100 .. 200) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165background image in addition to (or instead of) tinting it; 153A value of 100 means no shading; resource I<shading>.
166resource I<shading>.
167 154
168=item B<-blt> I<string> 155=item B<-blt> I<string>
169 156
170Specify background blending type. If background pixmap is specified 157Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over 158at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are : 159the transparent background, using the method specified. Supported values are:
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 164
178=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
179 166
180Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 168background. If a single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 170radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 171on some backgrounds. Maximum radius value is 128;
185resource I<blurRadius>. 172resource I<blurRadius>.
186 173
174=item B<-icon> I<file>
175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>.
179
187=item B<-bg> I<colour> 180=item B<-bg> I<colour>
188 181
189Window background colour; resource B<background>. 182Window background colour; resource B<background>.
190 183
191=item B<-fg> I<colour> 184=item B<-fg> I<colour>
192 185
193Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
194 187
195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196 189
197Compile I<afterimage>: Specify image file for the background and also 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
198optionally specify its scaling with a geometry string. Note you may need to 191optionally specify its scaling with a geometry string. Note you may need to
199add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
200command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
201 194
202=item B<-cr> I<colour> 195=item B<-cr> I<colour>
315 308
316=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
317 310
318Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
319 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
320=item B<-iconic> 317=item B<-iconic>
321 318
322Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 320Alternative form is B<-ic>.
324 321
340 337
341=item B<-bl> 338=item B<-bl>
342 339
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 340Compile 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 341if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 342decorations; resource B<borderLess>. If the window manager does not
343support MWM hints (e.g. kwin), enables override-redirect mode.
346 344
347=item B<-override-redirect> 345=item B<-override-redirect>
348 346
349Compile I<frills>: Sets override-redirect on the window; resource 347Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>. 348B<override-redirect>.
359=item B<-lsp> I<number> 357=item B<-lsp> I<number>
360 358
361Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
363B<lineSpace>. 361B<lineSpace>.
362
363=item B<-letsp> I<number>
364
365Compile I<frills>: Amount to adjust the computed character width by
366to control overall letter spacing. Negative values will tighten up the
367letter spacing, positive values will space letters out more. Useful to
368work around odd font metrics; resource B<letterSpace>.
364 369
365=item B<-tn> I<termname> 370=item B<-tn> I<termname>
366 371
367This option specifies the name of the terminal type to be set in the 372This option specifies the name of the terminal type to be set in the
368B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 461will 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 462it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>. 463user; resource B<hold>.
459 464
465=item B<-cd> I<path>
466
467Sets the working directory for the shell (or the command specified via
468B<-e>). The I<path> must be an absolute path and it must exist for
469@@RXVT_NAME@@ to start; resource B<chdir>.
470
460=item B<-xrm> I<string> 471=item B<-xrm> I<string>
461 472
462Works like the X Toolkit option of the same name, by adding the I<string> 473Works 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 474as if it were specified in a resource file. Resource values specified this
464way take precedence over all other resource specifications. 475way take precedence over all other resource specifications.
547You can set and change the resources using X11 tools like B<xrdb>. Many 558You 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 559distribution do also load settings from the B<~/.Xresources> file when X
549starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
551 562
552 1. system-wide app-defaults file, either locale-dependent OR global
553 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
555 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline 568 6. resources specified via -xrm on the commandline
558 569
559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 571names: 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 612Use the specified colour for the colour value I<n>, where 0-7
602corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
603high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
604colours. The canonical names are as follows: 0=black, 1=red, 2=green, 615colours. 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 6163=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
606names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
607 618
608Colours higher than 15 cannot be set using resources (yet), but can be 619Colours higher than 15 cannot be set using resources (yet), but can be
609changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
610 621
611Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 622Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
622=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
623 634
624Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
625foreground colour is the default. 636foreground colour is the default.
626 637
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> 638=item B<underlineColor:> I<colour>
633 639
634If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
635itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
642
643=item B<highlightColor:> I<colour>
644
645If set, use the specified colour as the background for highlighted
646characters. If unset, use reverse video.
647
648=item B<highlightTextColor:> I<colour>
649
650If set and highlightColor is set, use the specified colour as the
651foreground for highlighted characters.
636 652
637=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
638 654
639Use the specified colour for the cursor. The default is to use the 655Use the specified colour for the cursor. The default is to use the
640foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
647 663
648=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
649 665
650B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
651option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
652B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
653 669
654=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
655 671
656B<True>: specify that jump scrolling should be used. When receiving lots 672B<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 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
673if the refresh is too fast for the human eye to read anything (or the 689if the refresh is too fast for the human eye to read anything (or the
674monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
675 691
676=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
677 693
678Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
679 695
680B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
681future versions. 697future versions.
682 698
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> 699=item B<fading:> I<number>
687 700
688Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
689 702
690=item B<fadeColor:> I<colour> 703=item B<fadeColor:> I<colour>
692Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
693colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
694 707
695=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
696 709
697Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
698B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
699 715
700=item B<shading:> I<number> 716=item B<shading:> I<number>
701 717
702Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
703in addition to tinting it; option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
704 720
705=item B<blendType:> I<string> 721=item B<blendType:> I<string>
706 722
707Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
708 724
709=item B<blurRadius:> I<number> 725=item B<blurRadius:> I<number>
710 726
711Apply Gaussian Blurr with the specified radius to the transparent 727Apply gaussian blur with the specified radius to the transparent
712background image; option B<-blr>. 728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
713 733
714=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
715 735
716Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
717 737
727 747
728=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
729 749
730Use the specified image file for the background and also 750Use the specified image file for the background and also
731optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify its scaling with a geometry string B<WxH+X+Y>,
732(default C<0x0+50+50>) in which B<"W" / "H"> specify the 752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
733horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
734centre (percent). A scale of 0 displays the image with tiling. A scale 754centre (percent). A scale of 0 disables scaling.
735of 1 displays the image without any scaling. A scale of 2 to 9 specifies 755The maximum permitted scale is 1000.
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...>. 756Additional operations can be specified after colon B<:op1:op2...>.
739Supported operations are: 757Supported operations are:
740 758
741 tile force background image to be tiled and not scaled. Equivalent to 0x0 759 tile will tile image
742 propscale will scale image keeping proportions 760 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 761 scale will scale image to match window size
762 center will center image with no scaling
747 root will tile image as if it was a root window background, auto-adjusting 763 root will tile image as if it was a root window background, auto-adjusting
748 whenever terminal window moves 764 whenever terminal window moves
749 765
750If used in conjunction with B<-tr> option, the specified pixmap will be 766If used in conjunction with B<-tr> option, the specified pixmap will be
751blended over transparency image using either alpha-blending, or any 767blended over the transparent background using alpha-blending. If I<afterimage>
752other blending type, specified with B<-blt "type"> option. 768support has been compiled in it is possible to choose other blending
769types with B<-blt "type"> option.
753 770
754=item B<path:> I<path> 771=item B<path:> I<path>
755 772
756Specify the colon-delimited search path for finding background image files. 773Specify the colon-delimited search path for finding background image files.
757 774
784it is named first) and thus defines the character cell grid to be 9 pixels 801it is named first) and thus defines the character cell grid to be 9 pixels
785wide and 15 pixels high. 802wide and 15 pixels high.
786 803
787The second font is just used to add additional unicode characters not in 804The second font is just used to add additional unicode characters not in
788the base font, likewise the third, which is unfortunately non-bold, but 805the 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 806the bold version of the font does contain fewer characters, so this is a
790useful supplement. 807useful supplement.
791 808
792The third font is an Xft font with aliasing turned off, and the characters 809The 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 810are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
794contains other characters, but we are not interested in them. 811contains other characters, but we are not interested in them.
845=item B<urgentOnBell:> I<boolean> 862=item B<urgentOnBell:> I<boolean>
846 863
847B<True>: set the urgency hint for the wm on receipt of a bell character. 864B<True>: set the urgency hint for the wm on receipt of a bell character.
848B<False>: do not set the urgency hint [default]. 865B<False>: do not set the urgency hint [default].
849 866
867@@RXVT_NAME@@ resets the urgency hint on every focus change.
868
850=item B<visualBell:> I<boolean> 869=item B<visualBell:> I<boolean>
851 870
852B<True>: use visual bell on receipt of a bell character; option B<-vb>. 871B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853B<False>: no visual bell [default]; option B<+vb>. 872B<False>: no visual bell [default]; option B<+vb>.
854 873
882=item B<scrollstyle:> I<mode> 901=item B<scrollstyle:> I<mode>
883 902
884Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 903Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885the author's favourite. 904the author's favourite.
886 905
906=item B<thickness:> I<number>
907
908Set the scrollbar width in pixels.
909
887=item B<scrollBar:> I<boolean> 910=item B<scrollBar:> I<boolean>
888 911
889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 912B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
890disable the scrollbar; option B<+sb>. 913disable the scrollbar; option B<+sb>.
891 914
910B<False>: do not scroll to bottom when tty receives output; option 933B<False>: do not scroll to bottom when tty receives output; option
911B<+si>. 934B<+si>.
912 935
913=item B<scrollWithBuffer:> I<boolean> 936=item B<scrollWithBuffer:> I<boolean>
914 937
915B<True>: scroll with scrollback buffer when tty receives new lines (and 938B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
916B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 939try to show the same lines) and B<scrollTtyOutput> is False; option
917with scrollback buffer when tty receives new lines; option B<+sw>. 940B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
941new lines; option B<+sw>.
918 942
919=item B<scrollTtyKeypress:> I<boolean> 943=item B<scrollTtyKeypress:> I<boolean>
920 944
921B<True>: scroll to bottom when a non-special key is pressed. Special keys 945B<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 946are those which are intercepted by rxvt-unicode for special handling and
978=item B<cursorBlink:> I<boolean> 1002=item B<cursorBlink:> I<boolean>
979 1003
980B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1004B<True>: blink the cursor. B<False>: do not blink the cursor [default];
981option B<-bc>. 1005option B<-bc>.
982 1006
1007=item B<cursorUnderline:> I<boolean>
1008
1009B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1010option B<-uc>.
1011
983=item B<pointerBlank:> I<boolean> 1012=item B<pointerBlank:> I<boolean>
984 1013
985B<True>: blank the pointer when a key is pressed or after a set number 1014B<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 1015of seconds of inactivity. B<False>: the pointer is always visible
987[default]. 1016[default].
1000large number (e.g. C<987654321>) to effectively disable the timeout. 1029large number (e.g. C<987654321>) to effectively disable the timeout.
1001 1030
1002=item B<backspacekey:> I<string> 1031=item B<backspacekey:> I<string>
1003 1032
1004The string to send when the backspace key is pressed. If set to B<DEC> 1033The 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> 1034or 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 1035(code 8) - which can be reversed with the appropriate DEC private mode
1007escape sequence. 1036escape sequence.
1008 1037
1009=item B<deletekey:> I<string> 1038=item B<deletekey:> I<string>
1010 1039
1089 1118
1090=item B<secondaryScroll:> I<boolean> 1119=item B<secondaryScroll:> I<boolean>
1091 1120
1092Turn on/off secondary screen scroll (default enabled). If this 1121Turn on/off secondary screen scroll (default enabled). If this
1093option is enabled, scrolls on the secondary screen will change the 1122option is enabled, scrolls on the secondary screen will change the
1094scrollback buffer and switching to/from the secondary screen will 1123scrollback buffer and, when secondaryScreen is off, switching
1095instead scroll the screen up. 1124to/from the secondary screen will instead scroll the screen up.
1096 1125
1097=item B<hold>: I<boolean> 1126=item B<hold>: I<boolean>
1098 1127
1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1128Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100will not immediately destroy its window when the program executed within 1129will 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 1130it exits. Instead, it will wait till it is being killed or closed by the
1102user. 1131user.
1132
1133=item B<chdir>: I<path>
1134
1135Sets the working directory for the shell (or the command specified via
1136B<-e>). The I<path> must be an absolute path and it must exist for
1137@@RXVT_NAME@@ to start. If it isn't specified then the current working
1138directory will be used; option B<-cd>.
1103 1139
1104=item B<keysym.>I<sym>: I<string> 1140=item B<keysym.>I<sym>: I<string>
1105 1141
1106Compile I<frills>: Associate I<string> with keysym I<sym>. The 1142Compile I<frills>: Associate I<string> with keysym I<sym>. The
1107intervening resource name B<keysym.> cannot be omitted. 1143intervening resource name B<keysym.> cannot be omitted.
1122omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1158omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1123keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1159keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1124performed in an exact manner; however, the closest match is assured. 1160performed in an exact manner; however, the closest match is assured.
1125 1161
1126I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1162I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1127number), see RESOURCES in C<man 7 X> for futher details. 1163number), see RESOURCES in C<man 7 X> for further details.
1128 1164
1129You can define a range of keysyms in one shot by providing a I<string> 1165You can define a range of keysyms in one shot by providing a I<string>
1130with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1166with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1131should be a character not used by the strings. 1167should be a character not used by the strings.
1132 1168
1133Its usage can be demonstrated by an example: 1169Its usage can be demonstrated by an example:
1134 1170
1135 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1171 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1136 1172
1137The above line is equivalent to the following three lines: 1173The above line is equivalent to the following three lines:
1138 1174
1139 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1175 URxvt.keysym.Meta-Control-0x61: \033<a>
1140 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1176 URxvt.keysym.Meta-Control-0x62: \033<b>
1141 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1177 URxvt.keysym.Meta-Control-0x63: \033<c>
1142 1178
1143If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1179If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1144is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1180is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1145example the following means "change the current locale to C<zh_CN.GBK> 1181example the following means "change the current locale to C<zh_CN.GBK>
1146when Control-Meta-c is being pressed": 1182when Control-Meta-c is being pressed":
1147 1183
1148 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1184 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1149 1185
1150If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1186If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1151is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1187is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1152manpage. For example, the F<selection> extension (activated via 1188manpage. For example, the F<selection> extension (activated via
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1189C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154 1190
1155 URxvt.keysym.M-C-c: perl:selection:rot13 1191 URxvt.keysym.M-C-c: perl:selection:rot13
1156 1192
1157Due the the large number of modifier combinations, a defined key mapping 1193Due the the large number of modifier combinations, a defined key mapping
1158will match if at I<at least> the specified identifiers are being set, and 1194will match if I<at least> the specified identifiers are being set, and
1159no other key mappings with those and more bits are being defined. That 1195no other key mappings with those and more bits are being defined. That
1160means that defining a key map for C<a> will automatically provide 1196means 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 1197definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1162mappings themselves. 1198mappings themselves.
1163 1199
1214all instances, while B<perl-ext> is used for specific instances. 1250all instances, while B<perl-ext> is used for specific instances.
1215 1251
1216=item B<perl-eval>: I<string> 1252=item B<perl-eval>: I<string>
1217 1253
1218Perl code to be evaluated when all extensions have been registered. See 1254Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1255the @@RXVT_NAME@@perl(3) manpage.
1220will be ignored when running setuid/setgid.
1221 1256
1222=item B<perl-lib>: I<path> 1257=item B<perl-lib>: I<path>
1223 1258
1224Colon-separated list of additional directories that hold extension 1259Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource, 1260scripts. When looking for extensions specified by the C<perl> resource,
1226@@RXVT_NAME@@ will first look in these directories and then in 1261@@RXVT_NAME@@ will first look in these directories and then in
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1262F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228will be ignored when running setuid/setgid.
1229 1263
1230See the @@RXVT_NAME@@perl(3) manpage. 1264See the @@RXVT_NAME@@perl(3) manpage.
1231 1265
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1266=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233 1267
1255 1289
1256=item B<override-redirect>: I<boolean> 1290=item B<override-redirect>: I<boolean>
1257 1291
1258Compile I<frills>: Sets override-redirect for the terminal window, making 1292Compile I<frills>: Sets override-redirect for the terminal window, making
1259it almost invisible to window managers; option B<-override-redirect>. 1293it almost invisible to window managers; option B<-override-redirect>.
1294
1295=item B<iso14755:> I<boolean>
1296
1297Turn on/off ISO 14755 (default enabled).
1260 1298
1261=item B<iso14755_52:> I<boolean> 1299=item B<iso14755_52:> I<boolean>
1262 1300
1263Turn on/off ISO 14755 5.2 mode (default enabled). 1301Turn on/off ISO 14755 5.2 mode (default enabled).
1264 1302
1407B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1445B<@@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 1446it 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 1447allow 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. 1448on some systems or setgid to root or to some other group on others.
1411 1449
1412=head1 COLORS AND GRAPHICS 1450=head1 COLOURS AND GRAPHICS
1413 1451
1414In addition to the default foreground and background colours, 1452In addition to the default foreground and background colours,
1415B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1453B<@@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 1454high-intensity (potentially bold/blink) versions of the same, and 72 (or
1417colours with their names. 1455240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1456cube plus a 8 (24) colour greyscale ramp.
1457
1458Here is a list of the ANSI colours with their names.
1418 1459
1419=begin table 1460=begin table
1420 1461
1421 B<color0> (black) = Black 1462 B<color0> (black) = Black
1422 B<color1> (red) = Red3 1463 B<color1> (red) = Red3
1442It is also possible to specify the colour values of B<foreground>, 1483It is also possible to specify the colour values of B<foreground>,
1443B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1484B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1444a number 0-15, as a convenient shorthand to reference the colour name of 1485a number 0-15, as a convenient shorthand to reference the colour name of
1445color0-color15. 1486color0-color15.
1446 1487
1447In addition to the colours defined above, @@RXVT_NAME@@ offers an 1488The following text gives values for the standard 88 colour mode (and
1448additional 72 colours. The first 64 of those (with indices 16 to 79) 1489values 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 1490
1491The RGB cube uses indices 16..79 (16..231) using the following formulas:
1492
1493 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1494 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1495
1496The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1497steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1498the RGB cube.
1499
1452Together, all those colours implement the 88 colour xterm colours. Only 1500Together, all those colours implement the 88 (256) colour xterm
1453the first 16 can be changed using resources currently, the rest can only 1501colours. Only the first 16 can be changed using resources currently, the
1454be changed via command sequences ("escape codes"). 1502rest can only be changed via command sequences ("escape codes").
1503
1504Applications are advised to use terminfo or command sequences to discover
1505number and RGB values of all colours (yes, you can query this...).
1455 1506
1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1507Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457always swapping the foreground/background colours. This is in contrast to 1508always swapping the foreground/background colours. This is in contrast to
1458I<xterm>(1) where the colours are only swapped if they have not otherwise 1509I<xterm>(1) where the colours are only swapped if they have not otherwise
1459been specified. For example, 1510been specified. For example,
1460 1511
1461=over 4
1462
1463=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1512 @@RXVT_NAME@@ -fg Black -bg White -rv
1464 1513
1465would yield White on Black, while on I<xterm>(1) it would yield Black 1514would yield White on Black, while on I<xterm>(1) it would yield Black on
1466on White. 1515White.
1467
1468=back
1469 1516
1470=head2 ALPHA CHANNEL SUPPORT 1517=head2 ALPHA CHANNEL SUPPORT
1471 1518
1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1519If 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: 1520their act together, rxvt-unicode will do it's own alpha channel management:
1474 1521
1475You can prefix any color with an opaquenes percentage enclosed in 1522You can prefix any colour with an opaqueness percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1523brackets, 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 1524(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 1525transparent 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 1526half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with 1527is the recommended format to specify transparency values, and works with
1481all ways to specify a colour. 1528all ways to specify a colour.
1482 1529
1553C<--with-terminfo=PATH>. 1600C<--with-terminfo=PATH>.
1554 1601
1555=item B<DISPLAY> 1602=item B<DISPLAY>
1556 1603
1557Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1604Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1558display in its child processes. 1605display in its child processes if C<-display> isn't used to override. It
1606defaults to C<:0> if it doesn't exist.
1559 1607
1560=item B<SHELL> 1608=item B<SHELL>
1561 1609
1562The shell to be used for command execution, defaults to C</bin/sh>. 1610The shell to be used for command execution, defaults to C</bin/sh>.
1563 1611
1564=item B<RXVT_SOCKET> 1612=item B<RXVT_SOCKET>
1565 1613
1566The unix domain socket path used by @@RXVT_NAME@@c(1) and 1614The unix domain socket path used by @@RXVT_NAME@@c(1) and
1567@@RXVT_NAME@@d(1). 1615@@RXVT_NAME@@d(1).
1568 1616
1569Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1617Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1570 1618
1571=item B<HOME> 1619=item B<HOME>
1572 1620
1573Used to locate the default directory for the unix domain socket for 1621Used to locate the default directory for the unix domain socket for
1574daemon communications and to locate various resource files (such as 1622daemon communications and to locate various resource files (such as
1575C<.Xdefaults>) 1623C<.Xdefaults>)
1576 1624
1577=item B<XAPPLRESDIR> 1625=item B<XAPPLRESDIR>
1578 1626
1579Directory where various X resource files are being located. 1627Directory where application-specific X resource files are located.
1580 1628
1581=item B<XENVIRONMENT> 1629=item B<XENVIRONMENT>
1582 1630
1583If set and accessible, gives the name of a X resource file to be loaded by 1631If set and accessible, gives the name of a X resource file to be loaded by
1584@@RXVT_NAME@@. 1632@@RXVT_NAME@@.
1589 1637
1590=over 4 1638=over 4
1591 1639
1592=item B</usr/lib/X11/rgb.txt> 1640=item B</usr/lib/X11/rgb.txt>
1593 1641
1594Color names. 1642Colour names.
1595 1643
1596=back 1644=back
1597 1645
1598=head1 SEE ALSO 1646=head1 SEE ALSO
1599 1647
1650 1698
1651Project Coordinator (Changes 1.0 -) 1699Project Coordinator (Changes 1.0 -)
1652 1700
1653=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1701=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1654 1702
1655Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1703pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1656 1704
1657=back 1705=back
1658 1706

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines