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.170 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.255 by root, Sat Jul 24 11:00:58 2021 UTC

… …
84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
85Orange'. 85Orange'.
86 86
87The following options are available: 87The following options are available:
88 88
89=over 4 89=over
90 90
91=item B<-help>, B<--help> 91=item B<-help>, B<--help>
92 92
93Print out a message describing available options. 93Print out a message describing available options.
94 94
… …
98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
111=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
112 118
113Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
114 120
115=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
… …
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 128
123=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
124 130
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn 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 132
137=item B<-fade> I<number> 133=item B<-fade> I<number>
138 134
139Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
… …
143=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
144 140
145Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
147 143
148=item B<-tint> I<colour>
149
150Tint the transparent background pixmap with the given colour when
151transparency is enabled with B<-tr>. This only works for
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file> 144=item B<-icon> I<file>
188 145
189Compile I<afterimage>: Use the specified image as application icon. This 146Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 147is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 148application window; resource I<iconFile>.
192 149
193=item B<-bg> I<colour> 150=item B<-bg> I<colour>
194 151
195Window background colour; resource B<background>. 152Window background colour; resource B<background>.
196 153
197=item B<-fg> I<colour> 154=item B<-fg> I<colour>
198 155
199Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
200
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203Compile I<afterimage>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>.
207 157
208=item B<-cr> I<colour> 158=item B<-cr> I<colour>
209 159
210The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
211 161
… …
270 220
271=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
272 222
273Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
274 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
275=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
276 230
277Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
278B<utmpInhibit>. 232B<utmpInhibit>.
279 233
… …
321 275
322=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
323 277
324Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
325 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
326=item B<-iconic> 284=item B<-iconic>
327 285
328Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
329Alternative form is B<-ic>. 287Alternative form is B<-ic>.
330 288
… …
353 311
354=item B<-override-redirect> 312=item B<-override-redirect>
355 313
356Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
357B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
358 321
359=item B<-sbg> 322=item B<-sbg>
360 323
361Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
362drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
… …
417=item B<-pt> I<style> 380=item B<-pt> I<style>
418 381
419Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
420B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
421 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
422=item B<-im> I<text> 388=item B<-im> I<text>
423 389
424Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
425 391
426=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
… …
440Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
441button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
442in-use. Instead of selecting a full line it will extend the selection to 408in-use. Instead of selecting a full line it will extend the selection to
443the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
444 410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket
418sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
420
445=item B<-insecure> 421=item B<-insecure>
446 422
447Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
448sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
449info. 425info.
… …
461 437
462=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
463 439
464Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
465B<secondaryScroll>. 441B<secondaryScroll>.
442
443=item B<-rm> I<mode>
444
445Compile I<frills>: Sets long line rewrapping behaviour on window resizes
446to one of B<auto> (the default), B<always> or B<never>. The latter two
447modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
448is non-empty, and wings lines (acts like B<never>) otherwise; resource
449B<rewrapMode>.
466 450
467=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
468 452
469Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
470will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
… …
567You can set and change the resources using X11 tools like B<xrdb>. Many 551You can set and change the resources using X11 tools like B<xrdb>. Many
568distribution do also load settings from the B<~/.Xresources> file when X 552distribution do also load settings from the B<~/.Xresources> file when X
569starts. @@RXVT_NAME@@ will consult the following files/resources in order, 553starts. @@RXVT_NAME@@ will consult the following files/resources in order,
570with later settings overwriting earlier ones: 554with later settings overwriting earlier ones:
571 555
572 1. system-wide app-defaults file, either locale-dependent OR global
573 2. app-defaults file in $XAPPLRESDIR 556 1. app-defaults file in $XAPPLRESDIR
557 2. $HOME/.Xdefaults
574 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 558 3. RESOURCE_MANAGER property on root-window of screen 0
575 4. SCREEN_RESOURCES for the current screen 559 4. SCREEN_RESOURCES property on root-window of the current screen
576 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 560 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
577 6. resources specified via -xrm on the commandline 561 6. resources specified via -xrm on the commandline
578 562
579Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 563Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
580names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 564names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
… …
585be used. Command-line arguments can be used to override resource 569be used. Command-line arguments can be used to override resource
586settings. The following resources are supported (you might want to 570settings. The following resources are supported (you might want to
587check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 571check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
588extensions not documented here): 572extensions not documented here):
589 573
590=over 4 574=over
591 575
592=item B<depth:> I<bitdepth> 576=item B<depth:> I<bitdepth>
593 577
594Compile I<xft>: Attempt to find a visual with the given bit depth; 578Compile I<xft>: Attempt to find a visual with the given bit depth;
595option B<-depth>. 579option B<-depth>.
… …
621Use the specified colour for the colour value I<n>, where 0-7 605Use the specified colour for the colour value I<n>, where 0-7
622corresponds to low-intensity (normal) colours and 8-15 corresponds to 606corresponds to low-intensity (normal) colours and 8-15 corresponds to
623high-intensity (bold = bright foreground, blink = bright background) 607high-intensity (bold = bright foreground, blink = bright background)
624colours. The canonical names are as follows: 0=black, 1=red, 2=green, 608colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6253=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6093=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
626names used are listed in the B<COLORS AND GRAPHICS> section. 610names used are listed in the B<COLOURS AND GRAPHICS> section.
627 611
628Colours higher than 15 cannot be set using resources (yet), but can be 612Colours higher than 15 cannot be set using resources (yet), but can be
629changed using an escape command (see @@RXVT_NAME@@(7)). 613changed using an escape command (see @@RXVT_NAME@@(7)).
630 614
631Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 615Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
642=item B<colorUL:> I<colour> 626=item B<colorUL:> I<colour>
643 627
644Use the specified colour to display underlined characters when the 628Use the specified colour to display underlined characters when the
645foreground colour is the default. 629foreground colour is the default.
646 630
647=item B<colorRV:> I<colour>
648
649Use the specified colour as the background for reverse video characters
650when OPTION_HC is disabled (--disable-frills).
651
652=item B<underlineColor:> I<colour> 631=item B<underlineColor:> I<colour>
653 632
654If set, use the specified colour as the colour for the underline 633If set, use the specified colour as the colour for the underline
655itself. If unset, use the foreground colour. 634itself. If unset, use the foreground colour.
635
636=item B<highlightColor:> I<colour>
637
638If set, use the specified colour as the background for highlighted
639characters. If unset, use reverse video.
640
641=item B<highlightTextColor:> I<colour>
642
643If set and highlightColor is set, use the specified colour as the
644foreground for highlighted characters.
656 645
657=item B<cursorColor:> I<colour> 646=item B<cursorColor:> I<colour>
658 647
659Use the specified colour for the cursor. The default is to use the 648Use the specified colour for the cursor. The default is to use the
660foreground colour; option B<-cr>. 649foreground colour; option B<-cr>.
… …
667 656
668=item B<reverseVideo:> I<boolean> 657=item B<reverseVideo:> I<boolean>
669 658
670B<True>: simulate reverse video by foreground and background colours; 659B<True>: simulate reverse video by foreground and background colours;
671option B<-rv>. B<False>: regular screen colours [default]; option 660option B<-rv>. B<False>: regular screen colours [default]; option
672B<+rv>. See note in B<COLORS AND GRAPHICS> section. 661B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
673 662
674=item B<jumpScroll:> I<boolean> 663=item B<jumpScroll:> I<boolean>
675 664
676B<True>: specify that jump scrolling should be used. When receiving lots 665B<True>: specify that jump scrolling should be used. When receiving lots
677of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 666of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
691 680
692B<False>: specify that everything is to be displayed, even 681B<False>: specify that everything is to be displayed, even
693if the refresh is too fast for the human eye to read anything (or the 682if the refresh is too fast for the human eye to read anything (or the
694monitor to display anything); option B<+ss>. 683monitor to display anything); option B<+ss>.
695 684
696=item B<transparent:> I<boolean>
697
698Turn on/off illusion of a transparent window background.
699
700B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
701future versions.
702
703I<Please address all transparency related issues to Sasha Vasko at
704sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
705
706=item B<fading:> I<number> 685=item B<fading:> I<number>
707 686
708Fade the text by the given percentage when focus is lost; option B<-fade>. 687Fade the text by the given percentage when focus is lost; option B<-fade>.
709 688
710=item B<fadeColor:> I<colour> 689=item B<fadeColor:> I<colour>
711 690
712Fade to this colour, when fading is used (see B<fading:>). The default 691Fade to this colour, when fading is used (see B<fading:>). The default
713colour is black; option B<-fadecolor>. 692colour is black; option B<-fadecolor>.
714 693
715=item B<tintColor:> I<colour>
716
717Tint the transparent background pixmap with the given colour; option
718B<-tint>.
719
720=item B<shading:> I<number>
721
722Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
723in addition to tinting it; option B<-sh>.
724
725=item B<blendType:> I<string>
726
727Specify background blending type; option B<-blt>.
728
729=item B<blurRadius:> I<number>
730
731Apply gaussian blur with the specified radius to the transparent
732background image; option B<-blr>.
733
734=item B<iconFile:> I<file> 694=item B<iconFile:> I<file>
735 695
736Set the application icon pixmap; option B<-icon>. 696Set the application icon pixmap; option B<-icon>.
737 697
738=item B<scrollColor:> I<colour> 698=item B<scrollColor:> I<colour>
… …
746 706
747=item B<borderColor:> I<colour> 707=item B<borderColor:> I<colour>
748 708
749The colour of the border around the text area and between the scrollbar 709The colour of the border around the text area and between the scrollbar
750and the text. 710and the text.
751
752=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
753
754Use the specified image file for the background and also
755optionally specify its scaling with a geometry string B<WxH+X+Y>,
756(default C<0x0+50+50>) in which B<"W" / "H"> specify the
757horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
758centre (percent). A scale of 0 displays the image with tiling. A scale
759of 1 displays the image without any scaling. A scale of 2 to 9 specifies
760an integer number of images in that direction. No image will be magnified
761beyond 10 times its original size. The maximum permitted scale is 1000.
762Additional operations can be specified after colon B<:op1:op2...>.
763Supported operations are:
764
765 tile force background image to be tiled and not scaled. Equivalent to 0x0
766 propscale will scale image keeping proportions
767 auto will scale image to match window size. Equivalent to 100x100
768 hscale will scale image horizontally to the window size
769 vscale will scale image vertically to the window size
770 scale will scale image to match window size
771 root will tile image as if it was a root window background, auto-adjusting
772 whenever terminal window moves
773
774If used in conjunction with B<-tr> option, the specified pixmap will be
775blended over transparency image using either alpha-blending, or any
776other blending type, specified with B<-blt "type"> option.
777
778=item B<path:> I<path>
779
780Specify the colon-delimited search path for finding background image files.
781 711
782=item B<font:> I<fontlist> 712=item B<font:> I<fontlist>
783 713
784Select the fonts to be used. This is a comma separated list of font names 714Select the fonts to be used. This is a comma separated list of font names
785that are checked in order when trying to find glyphs for characters. The 715that are checked in order when trying to find glyphs for characters. The
… …
808it is named first) and thus defines the character cell grid to be 9 pixels 738it is named first) and thus defines the character cell grid to be 9 pixels
809wide and 15 pixels high. 739wide and 15 pixels high.
810 740
811The second font is just used to add additional unicode characters not in 741The second font is just used to add additional unicode characters not in
812the base font, likewise the third, which is unfortunately non-bold, but 742the base font, likewise the third, which is unfortunately non-bold, but
813the bold version of the font does contain less characters, so this is a 743the bold version of the font does contain fewer characters, so this is a
814useful supplement. 744useful supplement.
815 745
816The third font is an Xft font with aliasing turned off, and the characters 746The third font is an Xft font with aliasing turned off, and the characters
817are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 747are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
818contains other characters, but we are not interested in them. 748contains other characters, but we are not interested in them.
… …
882 812
883B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 813B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
884the shell; option B<-ls>. B<False>: start as a normal sub-shell 814the shell; option B<-ls>. B<False>: start as a normal sub-shell
885[default]; option B<+ls>. 815[default]; option B<+ls>.
886 816
817=item B<multiClickTime:> I<number>
818
819Specify the maximum time in milliseconds between multi-click select
820events. The default is 500 milliseconds; option B<-mc>.
821
887=item B<utmpInhibit:> I<boolean> 822=item B<utmpInhibit:> I<boolean>
888 823
889B<True>: inhibit writing record into the system log file B<utmp>; 824B<True>: inhibit writing record into the system log file B<utmp>;
890option B<-ut>. B<False>: write record into the system log file B<utmp> 825option B<-ut>. B<False>: write record into the system log file B<utmp>
891[default]; option B<+ut>. 826[default]; option B<+ut>.
… …
908=item B<scrollstyle:> I<mode> 843=item B<scrollstyle:> I<mode>
909 844
910Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 845Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
911the author's favourite. 846the author's favourite.
912 847
848=item B<thickness:> I<number>
849
850Set the scrollbar width in pixels.
851
913=item B<scrollBar:> I<boolean> 852=item B<scrollBar:> I<boolean>
914 853
915B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 854B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
916disable the scrollbar; option B<+sb>. 855disable the scrollbar; option B<+sb>.
917 856
… …
936B<False>: do not scroll to bottom when tty receives output; option 875B<False>: do not scroll to bottom when tty receives output; option
937B<+si>. 876B<+si>.
938 877
939=item B<scrollWithBuffer:> I<boolean> 878=item B<scrollWithBuffer:> I<boolean>
940 879
941B<True>: scroll with scrollback buffer when tty receives new lines (and 880B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
942B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 881try to show the same lines) and B<scrollTtyOutput> is False; option
943with scrollback buffer when tty receives new lines; option B<+sw>. 882B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
883new lines; option B<+sw>.
944 884
945=item B<scrollTtyKeypress:> I<boolean> 885=item B<scrollTtyKeypress:> I<boolean>
946 886
947B<True>: scroll to bottom when a non-special key is pressed. Special keys 887B<True>: scroll to bottom when a non-special key is pressed. Special keys
948are those which are intercepted by rxvt-unicode for special handling and 888are those which are intercepted by rxvt-unicode for special handling and
949are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 889are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
950bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
951 891
952=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
953 893
954Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
955resource is limited on most machines to 65535; option B<-sl>.
956 895
957=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
958 897
959Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
960option B<-b>. 899option B<-b>.
… …
1004=item B<cursorBlink:> I<boolean> 943=item B<cursorBlink:> I<boolean>
1005 944
1006B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 945B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1007option B<-bc>. 946option B<-bc>.
1008 947
948=item B<cursorUnderline:> I<boolean>
949
950B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
951option B<-uc>.
952
1009=item B<pointerBlank:> I<boolean> 953=item B<pointerBlank:> I<boolean>
1010 954
1011B<True>: blank the pointer when a key is pressed or after a set number 955B<True>: blank the pointer when a key is pressed or after a set number
1012of seconds of inactivity. B<False>: the pointer is always visible 956of seconds of inactivity. B<False>: the pointer is always visible
1013[default]. 957[default].
… …
1018 962
1019=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
1020 964
1021Mouse pointer background colour. 965Mouse pointer background colour.
1022 966
967=item B<pointerShape:> I<string>
968
969Compile I<frills>: Specifies the name of the mouse pointer shape
970[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
971file for possible values (omit the C<XC_> prefix).
972
1023=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
1024 974
1025Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
1026large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
1027 977
1028=item B<backspacekey:> I<string> 978=item B<backspacekey:> I<string>
1029 979
1030The string to send when the backspace key is pressed. If set to B<DEC> 980The string to send when the backspace key is pressed. If set to B<DEC>
1031or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 981or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1032(code 8) - which can be reversed with the appropriate DEC private mode 982(code 8) - which can be reversed with the appropriate DEC private mode
1033escape sequence. 983escape sequence.
1034 984
1035=item B<deletekey:> I<string> 985=item B<deletekey:> I<string>
1036 986
… …
1053 1003
1054B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1055 1005
1056=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
1057 1007
1058B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1059 1009
1060=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
1061 1011
1062I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
1063 1013
… …
1081 1031
1082Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1083button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
1084the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1085 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1086=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1087 1041
1088Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1089echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
1090abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1091through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1092write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1093default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
… …
1111 1065
1112=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1113 1067
1114Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1115 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1116=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1117 1076
1118Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1119option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1120scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
… …
1132Sets the working directory for the shell (or the command specified via 1091Sets the working directory for the shell (or the command specified via
1133B<-e>). The I<path> must be an absolute path and it must exist for 1092B<-e>). The I<path> must be an absolute path and it must exist for
1134@@RXVT_NAME@@ to start. If it isn't specified then the current working 1093@@RXVT_NAME@@ to start. If it isn't specified then the current working
1135directory will be used; option B<-cd>. 1094directory will be used; option B<-cd>.
1136 1095
1137=item B<keysym.>I<sym>: I<string> 1096=item B<keysym.>I<sym>: I<action>
1138 1097
1139Compile I<frills>: Associate I<string> with keysym I<sym>. The 1098Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1140intervening resource name B<keysym.> cannot be omitted. 1099resource name B<keysym.> cannot be omitted.
1141 1100
1142The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1101Using this resource, you can map key combinations such as
1143any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1102C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1144B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1103string than would normally result from that combination, making the
1145and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1104terminal scroll up or down the way you want it, or any other thing an
1146B<2>, B<3>, B<4>, B<5>. 1105extension might provide.
1106
1107The key combination that triggers the action, I<sym>, has the following format:
1108
1109 (modifiers-)key
1110
1111Where I<modifiers> can be any combination of the following full or
1112abbreviated modifier names:
1113
1114=begin table
1115
1116 B<ISOLevel3> B<I>
1117 B<AppKeypad> B<K>
1118 B<Control> B<C>
1119 B<NumLock> B<N>
1120 B<Shift> B<S>
1121 B<Meta> B<M> I<or> B<A>
1122 B<Lock> B<L>
1123 B<Mod1> B<1>
1124 B<Mod2> B<2>
1125 B<Mod3> B<3>
1126 B<Mod4> B<4>
1127 B<Mod5> B<5>
1128
1129=end table
1147 1130
1148The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1131The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1149whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1132whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1150keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1133keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1151current application keymap mode state. 1134current application keymap mode state.
1152 1135
1153The spellings of I<key> can be obtained by using B<xev>(1) command or 1136Due the the large number of modifier combinations, a key mapping will
1154searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1137match if I<at least> the specified identifiers are being set, and no other
1138key mappings with those and more bits are being defined. That means that
1139defining a mapping for C<a> will automatically provide definitions for
1140C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1141themselves. See the C<builtin:> action, below, for a way to work around
1142this when this is a problem.
1143
1144The spelling of I<key> depends on your implementation of X. An easy way to
1145find a key name is to use the B<xev>(1) command. You can find a list by
1146looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1155omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1147the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1156keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1148value (B<0x0000 - 0xFFFF>).
1157performed in an exact manner; however, the closest match is assured.
1158 1149
1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1150As with any resource value, the I<action> string may contain backslash
1151escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1160number), see RESOURCES in C<man 7 X> for futher details. 1152number), see RESOURCES in C<man 7 X> for further details.
1161 1153
1162You can define a range of keysyms in one shot by providing a I<string> 1154An action starts with an action prefix that selects a certain type
1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1155of action, followed by a colon. An action string without colons is
1156interpreted as a literal string to pass to the tty (as if it was
1157prefixed with C<string:>).
1158
1159The following action prefixes are known - extensions can provide
1160additional prefixes:
1161
1162=over
1163
1164=item string:STRING
1165
1166If the I<action> starts with C<string:> (or otherwise contains no colons),
1167then the remaining C<STRING> will be passed to the program running in the
1168terminal. For example, you could replace whatever Shift-Tab outputs by the
1169string C<echo rm -rf /> followed by a newline:
1170
1171 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1172
1173This could in theory be used to completely redefine your keymap.
1174
1175In addition, for actions of this type, you can define a range of
1176keysyms in one shot by loading the C<keysym-list> perl extension and
1177providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1164should be a character not used by the strings. 1178the delimiter `/' should be a character not used by the strings.
1165 1179
1166Its usage can be demonstrated by an example: 1180Its usage can be demonstrated by an example:
1167 1181
1168 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1169 1183
1170The above line is equivalent to the following three lines: 1184The above line is equivalent to the following three lines:
1171 1185
1172 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1173 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1174 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1175 1189
1190=item command:STRING
1191
1176If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1192If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1177is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1193is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1194the opposite of C<string:> - instead of sending it to the program running
1195in the terminal, it will be treated as if it were program output). This is
1196most useful to feed command sequences into @@RXVT_NAME@@.
1197
1178example the following means "change the current locale to C<zh_CN.GBK> 1198For example the following means "change the current locale to C<zh_CN.GBK>
1179when Control-Meta-c is being pressed": 1199when Control-Meta-c is being pressed":
1180 1200
1181 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1201 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1182 1202
1183If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1203The following example will map Control-Meta-1 and Control-Meta-2 to
1184is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1204the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1185manpage. For example, the F<selection> extension (activated via 1205font-switching at runtime:
1186C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187 1206
1188 URxvt.keysym.M-C-c: perl:selection:rot13 1207 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1208 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1189 1209
1190Due the the large number of modifier combinations, a defined key mapping 1210Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1191will match if at I<at least> the specified identifiers are being set, and 1211info):
1192no other key mappings with those and more bits are being defined. That
1193means that defining a key map for C<a> will automatically provide
1194definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195mappings themselves.
1196 1212
1197Unfortunately, this will override built-in key mappings. For example 1213 URxvt.keysym.M-C-3: command:\033[8;25;80t
1214 URxvt.keysym.M-C-4: command:\033[8;48;110t
1215
1216=item builtin:
1217
1218The builtin action is the action that @@RXVT_NAME@@ would execute if no
1219key binding existed for the key combination. The obvious use is to undo
1220the effect of existing bindings. The not so obvious use is to reinstate
1221bindings when another binding overrides too many modifiers.
1222
1198if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1223For example if you overwrite the C<Insert> key you will disable
1199C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1224@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1200user-defined keymap using the C<builtin:> replacement: 1225"holes" into the user-defined keymap using the C<builtin:> replacement:
1201 1226
1202 URxvt.keysym.Insert: <my insert key sequence> 1227 URxvt.keysym.Insert: <my insert key sequence>
1203 URxvt.keysym.S-Insert: builtin: 1228 URxvt.keysym.S-Insert: builtin:
1204 1229
1205The first line defines a mapping for C<Insert> and I<any> combination 1230The first line defines a mapping for C<Insert> and I<any> combination
1206of modifiers. The second line re-establishes the default mapping for 1231of modifiers. The second line re-establishes the default mapping for
1207C<Shift-Insert>. 1232C<Shift-Insert>.
1208 1233
1209The following example will map Control-Meta-1 and Control-Meta-2 to 1234=item builtin-string:
1210the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1211font-switching at runtime:
1212 1235
1213 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1236This action is mainly useful to restore string mappings for keys that
1214 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1237have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1238difficult to explain - basically, this action will send the string to the
1239application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1240action for it.
1215 1241
1216Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1242An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1217info): 1243selection when you press C<Shift-Insert>. With the following bindings, it
1244would instead emit the (undocumented, but what applications running in the
1245terminal might expect) sequence C<ESC [ 2 $> instead:
1218 1246
1219 URxvt.keysym.M-C-3: command:\033[8;25;80t 1247 URxvt.keysym.S-Insert: builtin-string:
1220 URxvt.keysym.M-C-4: command:\033[8;48;110t 1248 URxvt.keysym.C-S-Insert: builtin:
1249
1250The first line disables the paste functionality for that key
1251combination, and the second reinstates the default behaviour for
1252C<Control-Shift-Insert>, which would otherwise be overridden.
1253
1254Similarly, to let applications gain access to the C<C-M-c> (copy to
1255clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1256this:
1257
1258 URxvt.keysym.C-M-c: builtin-string:
1259 URxvt.keysym.C-M-v: builtin-string:
1260
1261=item EXTENSION:STRING
1262
1263An action of this form invokes the action B<STRING>, if any, provided
1264by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1265be loaded automatically if necessary.
1266
1267Not all extensions define actions, but popular extensions that do
1268include the I<selection> and I<matcher> extensions (documented in their
1269own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1270respectively).
1271
1272From the silly examples department, this will rot13-"encrypt"
1273@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1274keyboards:
1275
1276 URxvt.keysym.M-C-c: selection:rot13
1277
1278=item perl:STRING *DEPRECATED*
1279
1280This is a deprecated way of invoking commands provided by perl
1281extensions. It is still supported, but should not be used anymore.
1282
1283=back
1221 1284
1222=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1223 1286
1224=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1225 1288
1226Comma-separated list(s) of perl extension scripts (default: C<default>) to 1289Comma-separated list(s) of perl extension scripts (default: C<default>) to
1227use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1228 1291
1229Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to remove them again, in
1230them. This can be useful to selectively disable some extensions loaded 1293case they had been specified earlier. This can be useful to selectively
1231by default, or specified via the C<perl-ext-common> resource. For 1294disable some extensions loaded by default, or specified via the
1232example, C<default,-selection> will use all the default extension except 1295C<perl-ext-common> resource. For example, C<default,-selection> will use
1233C<selection>. 1296all the default extensions except C<selection>.
1234 1297
1235Extension names can also be followed by an argument in angle brackets 1298To prohibit autoloading of extensions, you can prefix them with C</>,
1236(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1299which will make urxvt refuse to automatically load them (this can be
1237searchable scrollback to Alt/Meta-s). Mentioning the same extension 1300overriden, however, by specifying the extension name again without a
1238multiple times with different arguments will pass multiple arguments to 1301prefix, though). This does not prohibit extensions themselves loading
1239the extension. 1302other extensions. For example, C<default,/background> will keep the
1303C<background> extension from being loaded when a background OSC sequence
1304is received.
1305
1306The default set includes the C<selection>, C<option-popup>,
1307C<selection-popup>, C<readline>, C<searchable-scrollback> and
1308C<confirm-paste> extensions, as well as any extensions which are mentioned
1309in B<keysym> resources.
1310
1311Any extension such that a corresponding resource is given on the
1312command line is automatically appended to B<perl-ext>.
1240 1313
1241Each extension is looked up in the library directories, loaded if 1314Each extension is looked up in the library directories, loaded if
1242necessary, and bound to the current terminal instance. 1315necessary, and bound to the current terminal instance. When the library
1316search path contains multiple extension files of the same name, then the
1317first one found will be used.
1243 1318
1244If both of these resources are the empty string, then the perl 1319If both of these resources are the empty string, then the perl interpreter
1245interpreter will not be initialized. The idea behind two options is that 1320will not be initialized. The rationale for having two options is that
1246B<perl-ext-common> will be used for extensions that should be available to 1321B<perl-ext-common> will be used for extensions that should be available to
1247all instances, while B<perl-ext> is used for specific instances. 1322all instances, while B<perl-ext> is used for specific instances.
1248 1323
1249=item B<perl-eval>: I<string> 1324=item B<perl-eval>: I<string>
1250 1325
… …
1252the @@RXVT_NAME@@perl(3) manpage. 1327the @@RXVT_NAME@@perl(3) manpage.
1253 1328
1254=item B<perl-lib>: I<path> 1329=item B<perl-lib>: I<path>
1255 1330
1256Colon-separated list of additional directories that hold extension 1331Colon-separated list of additional directories that hold extension
1257scripts. When looking for extensions specified by the C<perl> resource, 1332scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1258@@RXVT_NAME@@ will first look in these directories and then in 1333in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1259F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1334lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260 1335
1261See the @@RXVT_NAME@@perl(3) manpage. 1336See the @@RXVT_NAME@@perl(3) manpage.
1262 1337
1263=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1338=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1264 1339
… …
1268=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1343=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1269 1344
1270Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1345Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1271for details. 1346for details.
1272 1347
1273=item B<searchable-scrollback:> I<keysym> 1348=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1274 1349
1275Sets the hotkey that starts the incremental scrollback buffer search 1350This resource is deprecated and will be removed. Use a B<keysym> resource
1276(default: C<M-s>). 1351instead, e.g.:
1277 1352
1353 URxvt.keysym.M-s: searchable-scrollback:start
1354
1278=item B<urlLauncher>: I<string> 1355=item B<url-launcher>: I<string>
1279 1356
1280Specifies the program to be started with a URL argument. Used by the 1357Specifies the program to be started with a URL argument. Used by the
1281C<selection-popup> and C<matcher> perl extensions. 1358C<selection-popup> and C<matcher> perl extensions.
1282 1359
1283=item B<transient-for>: I<windowid> 1360=item B<transient-for>: I<windowid>
… …
1286 1363
1287=item B<override-redirect>: I<boolean> 1364=item B<override-redirect>: I<boolean>
1288 1365
1289Compile I<frills>: Sets override-redirect for the terminal window, making 1366Compile I<frills>: Sets override-redirect for the terminal window, making
1290it almost invisible to window managers; option B<-override-redirect>. 1367it almost invisible to window managers; option B<-override-redirect>.
1368
1369=item B<iso14755:> I<boolean>
1370
1371Turn on/off ISO 14755 (default enabled).
1291 1372
1292=item B<iso14755_52:> I<boolean> 1373=item B<iso14755_52:> I<boolean>
1293 1374
1294Turn on/off ISO 14755 5.2 mode (default enabled). 1375Turn on/off ISO 14755 5.2 mode (default enabled).
1295 1376
… …
1323=head1 THE SELECTION: SELECTING AND PASTING TEXT 1404=head1 THE SELECTION: SELECTING AND PASTING TEXT
1324 1405
1325The behaviour of text selection and insertion/pasting mechanism is similar 1406The behaviour of text selection and insertion/pasting mechanism is similar
1326to I<xterm>(1). 1407to I<xterm>(1).
1327 1408
1328=over 4 1409=over
1329 1410
1330=item B<Selecting>: 1411=item B<Selecting>:
1331 1412
1332Left click at the beginning of the region, drag to the end of the region 1413Left click at the beginning of the region, drag to the end of the region
1333and release; Right click to extend the marked region; Left double-click 1414and release; Right click to extend the marked region; Left double-click
… …
1348B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1429B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1349 1430
1350Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1431Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1351inserted too. 1432inserted too.
1352 1433
1434rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1435<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1436binding causes the value of the internal selection to be copied to the
1437CLIPBOARD selection, while the second binding causes the value of the
1438CLIPBOARD selection to be inserted.
1439
1353=back 1440=back
1354 1441
1355=head1 CHANGING FONTS 1442=head1 CHANGING FONTS
1356 1443
1357Changing fonts (or font sizes, respectively) via the keypad is not yet 1444Changing fonts (or font sizes, respectively) via the keypad is not yet
… …
1374and character codes using the keyboard. It consists of 4 parts. The 1461and character codes using the keyboard. It consists of 4 parts. The
1375first part is available if rxvt-unicode has been compiled with 1462first part is available if rxvt-unicode has been compiled with
1376C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1463C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1377with C<--enable-iso14755>. 1464with C<--enable-iso14755>.
1378 1465
1379=over 4 1466=over
1380 1467
1381=item * 5.1: Basic method 1468=item * 5.1: Basic method
1382 1469
1383This allows you to enter unicode characters using their hexcode. 1470This allows you to enter unicode characters using their hexcode.
1384 1471
… …
1438B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1525B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1439it can be seen via the I<who(1)> command, and can accept messages. To 1526it can be seen via the I<who(1)> command, and can accept messages. To
1440allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1527allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1441on some systems or setgid to root or to some other group on others. 1528on some systems or setgid to root or to some other group on others.
1442 1529
1443=head1 COLORS AND GRAPHICS 1530=head1 COLOURS AND GRAPHICS
1444 1531
1445In addition to the default foreground and background colours, 1532In addition to the default foreground and background colours,
1446B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1533B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1447high-intensity bold/blink versions of the same). Here is a list of the 1534high-intensity (potentially bold/blink) versions of the same, and 72 (or
1448colours with their names. 1535240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1536cube plus a 8 (24) colour greyscale ramp.
1537
1538B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1539C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1540number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1541colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
154224-bit colour space. When indexing collisions happen, the nearest old colour in
1543the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1544use many similar 24-bit colours. It's typically not a problem in common
1545scenarios.
1546
1547Here is a list of the ANSI colours with their names.
1449 1548
1450=begin table 1549=begin table
1451 1550
1452 B<color0> (black) = Black 1551 B<color0> (black) = Black
1453 B<color1> (red) = Red3 1552 B<color1> (red) = Red3
… …
1473It is also possible to specify the colour values of B<foreground>, 1572It is also possible to specify the colour values of B<foreground>,
1474B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1573B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1475a number 0-15, as a convenient shorthand to reference the colour name of 1574a number 0-15, as a convenient shorthand to reference the colour name of
1476color0-color15. 1575color0-color15.
1477 1576
1478In addition to the colours defined above, @@RXVT_NAME@@ offers an 1577The following text gives values for the standard 88 colour mode (and
1479additional 72 colours. The first 64 of those (with indices 16 to 79) 1578values for the 256 colour mode in parentheses).
1480consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
148116>), followed by 8 additional shades of gray (with indices 80 to 87).
1482 1579
1580The RGB cube uses indices 16..79 (16..231) using the following formulas:
1581
1582 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1583 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1584
1585The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1586steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1587the RGB cube.
1588
1483Together, all those colours implement the 88 colour xterm colours. Only 1589Together, all those colours implement the 88 (256) colour xterm
1484the first 16 can be changed using resources currently, the rest can only 1590colours. Only the first 16 can be changed using resources currently, the
1485be changed via command sequences ("escape codes"). 1591rest can only be changed via command sequences ("escape codes").
1592
1593Applications are advised to use terminfo or command sequences to discover
1594number and RGB values of all colours (yes, you can query this...).
1486 1595
1487Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1596Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1488always swapping the foreground/background colours. This is in contrast to 1597always swapping the foreground/background colours. This is in contrast to
1489I<xterm>(1) where the colours are only swapped if they have not otherwise 1598I<xterm>(1) where the colours are only swapped if they have not otherwise
1490been specified. For example, 1599been specified. For example,
1491 1600
1492=over 4
1493
1494=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1601 @@RXVT_NAME@@ -fg Black -bg White -rv
1495 1602
1496would yield White on Black, while on I<xterm>(1) it would yield Black 1603would yield White on Black, while on I<xterm>(1) it would yield Black on
1497on White. 1604White.
1498
1499=back
1500 1605
1501=head2 ALPHA CHANNEL SUPPORT 1606=head2 ALPHA CHANNEL SUPPORT
1502 1607
1503If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1608If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1504their act together, rxvt-unicode will do it's own alpha channel management: 1609their act together, rxvt-unicode will do its own alpha channel management:
1505 1610
1506You can prefix any color with an opaquenes percentage enclosed in 1611You can prefix any colour with an opaqueness percentage enclosed in
1507brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1612brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1508(0-100) that specifies the opacity of the color, where C<0> is completely 1613(0-100) that specifies the opacity of the colour, where C<0> is completely
1509transparent and C<100> is completely opaque. For example, C<[50]red> is a 1614transparent and C<100> is completely opaque. For example, C<[50]red> is a
1510half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1615half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1511is the recommended format to specify transparency values, and works with 1616is the recommended format to specify transparency values, and works with
1512all ways to specify a colour. 1617all ways to specify a colour.
1513 1618
… …
1546 1651
1547=head1 ENVIRONMENT 1652=head1 ENVIRONMENT
1548 1653
1549B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1654B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1550 1655
1551=over 4 1656=over
1552 1657
1553=item B<TERM> 1658=item B<TERM>
1554 1659
1555Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1660Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1556resources or on the command line. 1661resources or on the command line.
… …
1591 1696
1592=item B<SHELL> 1697=item B<SHELL>
1593 1698
1594The shell to be used for command execution, defaults to C</bin/sh>. 1699The shell to be used for command execution, defaults to C</bin/sh>.
1595 1700
1596=item B<RXVT_SOCKET> 1701=item B<RXVT_SOCKET> [I<sic>]
1597 1702
1598The unix domain socket path used by @@RXVT_NAME@@c(1) and 1703The unix domain socket path used by @@RXVT_NAME@@c(1) and
1599@@RXVT_NAME@@d(1). 1704@@RXVT_NAME@@d(1).
1600 1705
1601Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1706Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1707
1708=item B<URXVT_PERL_LIB>
1709
1710Additional F<:>-separated library search path for perl extensions. Will be
1711searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1712directory.
1713
1714=item B<URXVT_PERL_VERBOSITY>
1715
1716See L<@@RXVT_NAME@@perl>(3).
1602 1717
1603=item B<HOME> 1718=item B<HOME>
1604 1719
1605Used to locate the default directory for the unix domain socket for 1720Used to locate the default directory for the unix domain socket for
1606daemon communications and to locate various resource files (such as 1721daemon communications and to locate various resource files (such as
1607C<.Xdefaults>) 1722C<.Xdefaults>)
1608 1723
1609=item B<XAPPLRESDIR> 1724=item B<XAPPLRESDIR>
1610 1725
1611Directory where various X resource files are being located. 1726Directory where application-specific X resource files are located.
1612 1727
1613=item B<XENVIRONMENT> 1728=item B<XENVIRONMENT>
1614 1729
1615If set and accessible, gives the name of a X resource file to be loaded by 1730If set and accessible, gives the name of a X resource file to be loaded by
1616@@RXVT_NAME@@. 1731@@RXVT_NAME@@.
1617 1732
1618=back 1733=back
1619 1734
1620=head1 FILES 1735=head1 FILES
1621 1736
1622=over 4 1737=over
1623 1738
1624=item B</usr/lib/X11/rgb.txt> 1739=item B</usr/lib/X11/rgb.txt>
1625 1740
1626Color names. 1741Colour names.
1627 1742
1628=back 1743=back
1629 1744
1630=head1 SEE ALSO 1745=head1 SEE ALSO
1631 1746
1747@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1632@@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) 1748@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1633 1749
1634=head1 CURRENT PROJECT COORDINATOR 1750=head1 CURRENT PROJECT COORDINATOR
1635 1751
1636=over 4 1752=over
1637 1753
1638=item Project Coordinator 1754=item Project Coordinator
1639 1755
1640Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1756Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1641 1757
1642L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1758L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1643 1759
1644=back 1760=back
1645 1761
1646=head1 AUTHORS 1762=head1 AUTHORS
1647 1763
1648=over 4 1764=over
1649 1765
1650=item John Bovey 1766=item John Bovey
1651 1767
1652University of Kent, 1992, wrote the original Xvt. 1768University of Kent, 1992, wrote the original Xvt.
1653 1769
1654=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1770=item Rob Nation <nation@rocket.sanders.lockheed.com>
1655 1771
1656very heavily modified Xvt and came up with Rxvt 1772very heavily modified Xvt and came up with Rxvt
1657 1773
1658=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1774=item Angelo Haritsis <ah@doc.ic.ac.uk>
1659 1775
1660wrote the Greek Keyboard Input (no longer in code) 1776wrote the Greek Keyboard Input (no longer in code)
1661 1777
1662=item mj olesen L<< <olesen@me.QueensU.CA> >> 1778=item mj olesen <olesen@me.QueensU.CA>
1663 1779
1664Wrote the menu system. 1780Wrote the menu system.
1665 1781
1666Project Coordinator (changes.txt 2.11 to 2.21) 1782Project Coordinator (changes.txt 2.11 to 2.21)
1667 1783
1668=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1784=item Oezguer Kesim <kesim@math.fu-berlin.de>
1669 1785
1670Project Coordinator (changes.txt 2.21a to 2.4.5) 1786Project Coordinator (changes.txt 2.21a to 2.4.5)
1671 1787
1672=item Geoff Wing L<< <gcw@pobox.com> >> 1788=item Geoff Wing <gcw@pobox.com>
1673 1789
1674Rewrote screen display and text selection routines. 1790Rewrote screen display and text selection routines.
1675 1791
1676Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1792Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1677 1793
1678=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1794=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1679 1795
1680Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1796Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1681extension, random hacks, numerous bugfixes and extensions. 1797extension, random hacks, numerous bugfixes and extensions.
1682 1798
1683Project Coordinator (Changes 1.0 -) 1799Project Coordinator (Changes 1.0 -)
1684 1800
1685=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1801=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1686 1802
1687Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1803pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1688 1804
1689=back 1805=back
1690 1806

Diff Legend

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