ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC

92 92
93Print out a message describing available options. 93Print out a message describing available options.
94 94
95=item B<-display> I<displayname> 95=item B<-display> I<displayname>
96 96
97Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
98respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
99B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
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> 144=item B<-icon> I<file>
149 145
150Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
151transparency is enabled with B<-tr>. This only works for 147is used by many window managers, taskbars and pagers to represent the
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application window; resource I<iconFile>.
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161
162=item B<-sh> I<number>
163
164Darken (0 .. 100) or lighten (100 .. 200) the transparent
165background image in addition to (or instead of) tinting it;
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186 149
187=item B<-bg> I<colour> 150=item B<-bg> I<colour>
188 151
189Window background colour; resource B<background>. 152Window background colour; resource B<background>.
190 153
191=item B<-fg> I<colour> 154=item B<-fg> I<colour>
192 155
193Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
194
195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196
197Compile I<afterimage>: Specify image file for the background and also
198optionally specify its scaling with a geometry string. Note you may need to
199add quotes to avoid special shell interpretation of the C<;> in the
200command-line; for more details see resource B<backgroundPixmap>.
201 157
202=item B<-cr> I<colour> 158=item B<-cr> I<colour>
203 159
204The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
205 161
264 220
265=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
266 222
267Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
268 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
269=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
270 230
271Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
272B<utmpInhibit>. 232B<utmpInhibit>.
273 233
315 275
316=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
317 277
318Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
319 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
320=item B<-iconic> 284=item B<-iconic>
321 285
322Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
323Alternative form is B<-ic>. 287Alternative form is B<-ic>.
324 288
340 304
341=item B<-bl> 305=item B<-bl>
342 306
343Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile 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 308if honoured by the WM, the rxvt-unicode window will not have window
345decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
346 311
347=item B<-override-redirect> 312=item B<-override-redirect>
348 313
349Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
350B<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.
351 321
352=item B<-sbg> 322=item B<-sbg>
353 323
354Compile 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
355drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
359=item B<-lsp> I<number> 329=item B<-lsp> I<number>
360 330
361Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
362the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
363B<lineSpace>. 333B<lineSpace>.
334
335=item B<-letsp> I<number>
336
337Compile I<frills>: Amount to adjust the computed character width by
338to control overall letter spacing. Negative values will tighten up the
339letter spacing, positive values will space letters out more. Useful to
340work around odd font metrics; resource B<letterSpace>.
364 341
365=item B<-tn> I<termname> 342=item B<-tn> I<termname>
366 343
367This option specifies the name of the terminal type to be set in the 344This option specifies the name of the terminal type to be set in the
368B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
403=item B<-pt> I<style> 380=item B<-pt> I<style>
404 381
405Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
406B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
407 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
408=item B<-im> I<text> 388=item B<-im> I<text>
409 389
410Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
411 391
412=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
454 434
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within 436will 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 437it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>. 438user; resource B<hold>.
439
440=item B<-cd> I<path>
441
442Sets the working directory for the shell (or the command specified via
443B<-e>). The I<path> must be an absolute path and it must exist for
444@@RXVT_NAME@@ to start; resource B<chdir>.
459 445
460=item B<-xrm> I<string> 446=item B<-xrm> I<string>
461 447
462Works like the X Toolkit option of the same name, by adding the I<string> 448Works 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 449as if it were specified in a resource file. Resource values specified this
547You can set and change the resources using X11 tools like B<xrdb>. Many 533You 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 534distribution do also load settings from the B<~/.Xresources> file when X
549starts. @@RXVT_NAME@@ will consult the following files/resources in order, 535starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550with later settings overwriting earlier ones: 536with later settings overwriting earlier ones:
551 537
552 1. system-wide app-defaults file, either locale-dependent OR global
553 2. app-defaults file in $XAPPLRESDIR 538 1. app-defaults file in $XAPPLRESDIR
539 2. $HOME/.Xdefaults
554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 540 3. RESOURCE_MANAGER property on root-window of screen 0
555 4. SCREEN_RESOURCES for the current screen 541 4. SCREEN_RESOURCES property on root-window of the current screen
556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 542 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline 543 6. resources specified via -xrm on the commandline
558 544
559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 545Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 546names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
572=item B<depth:> I<bitdepth> 558=item B<depth:> I<bitdepth>
573 559
574Compile I<xft>: Attempt to find a visual with the given bit depth; 560Compile I<xft>: Attempt to find a visual with the given bit depth;
575option B<-depth>. 561option B<-depth>.
576 562
563=item B<buffered:> I<boolean>
564
565Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
566On some card/driver combination enabling it slightly decreases
567performance, on most it greatly helps it. The slowdown is small, so it
568should normally be enabled.
569
577=item B<geometry:> I<geom> 570=item B<geometry:> I<geom>
578 571
579Create the window with the specified X window geometry [default 80x24]; 572Create the window with the specified X window geometry [default 80x24];
580option B<-geometry>. 573option B<-geometry>.
581 574
594Use the specified colour for the colour value I<n>, where 0-7 587Use the specified colour for the colour value I<n>, where 0-7
595corresponds to low-intensity (normal) colours and 8-15 corresponds to 588corresponds to low-intensity (normal) colours and 8-15 corresponds to
596high-intensity (bold = bright foreground, blink = bright background) 589high-intensity (bold = bright foreground, blink = bright background)
597colours. The canonical names are as follows: 0=black, 1=red, 2=green, 590colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5983=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5913=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
599names used are listed in the B<COLORS AND GRAPHICS> section. 592names used are listed in the B<COLOURS AND GRAPHICS> section.
600 593
601Colours higher than 15 cannot be set using resources (yet), but can be 594Colours higher than 15 cannot be set using resources (yet), but can be
602changed using an escape command (see @@RXVT_NAME@@(7)). 595changed using an escape command (see @@RXVT_NAME@@(7)).
603 596
604Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 597Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
615=item B<colorUL:> I<colour> 608=item B<colorUL:> I<colour>
616 609
617Use the specified colour to display underlined characters when the 610Use the specified colour to display underlined characters when the
618foreground colour is the default. 611foreground colour is the default.
619 612
620=item B<colorRV:> I<colour>
621
622Use the specified colour as the background for reverse video characters
623when OPTION_HC is disabled (--disable-frills).
624
625=item B<underlineColor:> I<colour> 613=item B<underlineColor:> I<colour>
626 614
627If set, use the specified colour as the colour for the underline 615If set, use the specified colour as the colour for the underline
628itself. If unset, use the foreground colour. 616itself. If unset, use the foreground colour.
617
618=item B<highlightColor:> I<colour>
619
620If set, use the specified colour as the background for highlighted
621characters. If unset, use reverse video.
622
623=item B<highlightTextColor:> I<colour>
624
625If set and highlightColor is set, use the specified colour as the
626foreground for highlighted characters.
629 627
630=item B<cursorColor:> I<colour> 628=item B<cursorColor:> I<colour>
631 629
632Use the specified colour for the cursor. The default is to use the 630Use the specified colour for the cursor. The default is to use the
633foreground colour; option B<-cr>. 631foreground colour; option B<-cr>.
640 638
641=item B<reverseVideo:> I<boolean> 639=item B<reverseVideo:> I<boolean>
642 640
643B<True>: simulate reverse video by foreground and background colours; 641B<True>: simulate reverse video by foreground and background colours;
644option B<-rv>. B<False>: regular screen colours [default]; option 642option B<-rv>. B<False>: regular screen colours [default]; option
645B<+rv>. See note in B<COLORS AND GRAPHICS> section. 643B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
646 644
647=item B<jumpScroll:> I<boolean> 645=item B<jumpScroll:> I<boolean>
648 646
649B<True>: specify that jump scrolling should be used. When receiving lots 647B<True>: specify that jump scrolling should be used. When receiving lots
650of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 648of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
664 662
665B<False>: specify that everything is to be displayed, even 663B<False>: specify that everything is to be displayed, even
666if the refresh is too fast for the human eye to read anything (or the 664if the refresh is too fast for the human eye to read anything (or the
667monitor to display anything); option B<+ss>. 665monitor to display anything); option B<+ss>.
668 666
669=item B<transparent:> I<boolean>
670
671Turn on/off illusion of a transparent window background.
672
673B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
674future versions.
675
676I<Please address all transparency related issues to Sasha Vasko at
677sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
678
679=item B<fading:> I<number> 667=item B<fading:> I<number>
680 668
681Fade the text by the given percentage when focus is lost; option B<-fade>. 669Fade the text by the given percentage when focus is lost; option B<-fade>.
682 670
683=item B<fadeColor:> I<colour> 671=item B<fadeColor:> I<colour>
684 672
685Fade to this colour, when fading is used (see B<fading:>). The default 673Fade to this colour, when fading is used (see B<fading:>). The default
686colour is black; option B<-fadecolor>. 674colour is black; option B<-fadecolor>.
687 675
688=item B<tintColor:> I<colour> 676=item B<iconFile:> I<file>
689 677
690Tint the transparent background pixmap with the given colour; option 678Set the application icon pixmap; option B<-icon>.
691B<-tint>.
692
693=item B<shading:> I<number>
694
695Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
696in addition to tinting it; option B<-sh>.
697
698=item B<blendType:> I<string>
699
700Specify background blending type; option B<-blt>.
701
702=item B<blurRadius:> I<number>
703
704Apply Gaussian Blurr with the specified radius to the transparent
705background image; option B<-blr>.
706 679
707=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
708 681
709Use the specified colour for the scrollbar [default #B2B2B2]. 682Use the specified colour for the scrollbar [default #B2B2B2].
710 683
715 688
716=item B<borderColor:> I<colour> 689=item B<borderColor:> I<colour>
717 690
718The colour of the border around the text area and between the scrollbar 691The colour of the border around the text area and between the scrollbar
719and the text. 692and the text.
720
721=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
722
723Use the specified image file for the background and also
724optionally specify its scaling with a geometry string B<WxH+X+Y>,
725(default C<0x0+50+50>) in which B<"W" / "H"> specify the
726horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
727centre (percent). A scale of 0 displays the image with tiling. A scale
728of 1 displays the image without any scaling. A scale of 2 to 9 specifies
729an integer number of images in that direction. No image will be magnified
730beyond 10 times its original size. The maximum permitted scale is 1000.
731Additional operations can be specified after colon B<:op1:op2...>.
732Supported operations are:
733
734 tile force background image to be tiled and not scaled. Equivalent to 0x0
735 propscale will scale image keeping proportions
736 auto will scale image to match window size. Equivalent to 100x100
737 hscale will scale image horizontally to the window size
738 vscale will scale image vertically to the window size
739 scale will scale image to match window size
740 root will tile image as if it was a root window background, auto-adjusting
741 whenever terminal window moves
742
743If used in conjunction with B<-tr> option, the specified pixmap will be
744blended over transparency image using either alpha-blending, or any
745other blending type, specified with B<-blt "type"> option.
746
747=item B<path:> I<path>
748
749Specify the colon-delimited search path for finding background image files.
750 693
751=item B<font:> I<fontlist> 694=item B<font:> I<fontlist>
752 695
753Select the fonts to be used. This is a comma separated list of font names 696Select the fonts to be used. This is a comma separated list of font names
754that are checked in order when trying to find glyphs for characters. The 697that are checked in order when trying to find glyphs for characters. The
777it is named first) and thus defines the character cell grid to be 9 pixels 720it is named first) and thus defines the character cell grid to be 9 pixels
778wide and 15 pixels high. 721wide and 15 pixels high.
779 722
780The second font is just used to add additional unicode characters not in 723The second font is just used to add additional unicode characters not in
781the base font, likewise the third, which is unfortunately non-bold, but 724the base font, likewise the third, which is unfortunately non-bold, but
782the bold version of the font does contain less characters, so this is a 725the bold version of the font does contain fewer characters, so this is a
783useful supplement. 726useful supplement.
784 727
785The third font is an Xft font with aliasing turned off, and the characters 728The third font is an Xft font with aliasing turned off, and the characters
786are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 729are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
787contains other characters, but we are not interested in them. 730contains other characters, but we are not interested in them.
838=item B<urgentOnBell:> I<boolean> 781=item B<urgentOnBell:> I<boolean>
839 782
840B<True>: set the urgency hint for the wm on receipt of a bell character. 783B<True>: set the urgency hint for the wm on receipt of a bell character.
841B<False>: do not set the urgency hint [default]. 784B<False>: do not set the urgency hint [default].
842 785
786@@RXVT_NAME@@ resets the urgency hint on every focus change.
787
843=item B<visualBell:> I<boolean> 788=item B<visualBell:> I<boolean>
844 789
845B<True>: use visual bell on receipt of a bell character; option B<-vb>. 790B<True>: use visual bell on receipt of a bell character; option B<-vb>.
846B<False>: no visual bell [default]; option B<+vb>. 791B<False>: no visual bell [default]; option B<+vb>.
847 792
849 794
850B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 795B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
851the shell; option B<-ls>. B<False>: start as a normal sub-shell 796the shell; option B<-ls>. B<False>: start as a normal sub-shell
852[default]; option B<+ls>. 797[default]; option B<+ls>.
853 798
799=item B<multiClickTime:> I<number>
800
801Specify the maximum time in milliseconds between multi-click select
802events. The default is 500 milliseconds; option B<-mc>.
803
854=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
855 805
856B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
857option B<-ut>. B<False>: write record into the system log file B<utmp> 807option B<-ut>. B<False>: write record into the system log file B<utmp>
858[default]; option B<+ut>. 808[default]; option B<+ut>.
875=item B<scrollstyle:> I<mode> 825=item B<scrollstyle:> I<mode>
876 826
877Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 827Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878the author's favourite. 828the author's favourite.
879 829
830=item B<thickness:> I<number>
831
832Set the scrollbar width in pixels.
833
880=item B<scrollBar:> I<boolean> 834=item B<scrollBar:> I<boolean>
881 835
882B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 836B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
883disable the scrollbar; option B<+sb>. 837disable the scrollbar; option B<+sb>.
884 838
903B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
904B<+si>. 858B<+si>.
905 859
906=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
907 861
908B<True>: scroll with scrollback buffer when tty receives new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
909B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
910with scrollback buffer when tty receives new lines; option B<+sw>. 864B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
865new lines; option B<+sw>.
911 866
912=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
913 868
914B<True>: scroll to bottom when a non-special key is pressed. Special keys 869B<True>: scroll to bottom when a non-special key is pressed. Special keys
915are those which are intercepted by rxvt-unicode for special handling and 870are those which are intercepted by rxvt-unicode for special handling and
916are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 871are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
917bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
918 873
919=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
920 875
921Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
922resource is limited on most machines to 65535; option B<-sl>.
923 877
924=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
925 879
926Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
927option B<-b>. 881option B<-b>.
971=item B<cursorBlink:> I<boolean> 925=item B<cursorBlink:> I<boolean>
972 926
973B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 927B<True>: blink the cursor. B<False>: do not blink the cursor [default];
974option B<-bc>. 928option B<-bc>.
975 929
930=item B<cursorUnderline:> I<boolean>
931
932B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
933option B<-uc>.
934
976=item B<pointerBlank:> I<boolean> 935=item B<pointerBlank:> I<boolean>
977 936
978B<True>: blank the pointer when a key is pressed or after a set number 937B<True>: blank the pointer when a key is pressed or after a set number
979of seconds of inactivity. B<False>: the pointer is always visible 938of seconds of inactivity. B<False>: the pointer is always visible
980[default]. 939[default].
985 944
986=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
987 946
988Mouse pointer background colour. 947Mouse pointer background colour.
989 948
949=item B<pointerShape:> I<string>
950
951Compile I<frills>: Specifies the name of the mouse pointer shape
952[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
953file for possible values (omit the C<XC_> prefix).
954
990=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
991 956
992Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
993large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
994 959
995=item B<backspacekey:> I<string> 960=item B<backspacekey:> I<string>
996 961
997The string to send when the backspace key is pressed. If set to B<DEC> 962The string to send when the backspace key is pressed. If set to B<DEC>
998or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 963or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
999(code 8) - which can be reversed with the appropriate DEC private mode 964(code 8) - which can be reversed with the appropriate DEC private mode
1000escape sequence. 965escape sequence.
1001 966
1002=item B<deletekey:> I<string> 967=item B<deletekey:> I<string>
1003 968
1020 985
1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1022 987
1023=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
1024 989
1025B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1026 991
1027=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
1028 993
1029I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
1030 995
1082 1047
1083=item B<secondaryScroll:> I<boolean> 1048=item B<secondaryScroll:> I<boolean>
1084 1049
1085Turn on/off secondary screen scroll (default enabled). If this 1050Turn on/off secondary screen scroll (default enabled). If this
1086option is enabled, scrolls on the secondary screen will change the 1051option is enabled, scrolls on the secondary screen will change the
1087scrollback buffer and switching to/from the secondary screen will 1052scrollback buffer and, when secondaryScreen is off, switching
1088instead scroll the screen up. 1053to/from the secondary screen will instead scroll the screen up.
1089 1054
1090=item B<hold>: I<boolean> 1055=item B<hold>: I<boolean>
1091 1056
1092Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1057Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1093will not immediately destroy its window when the program executed within 1058will not immediately destroy its window when the program executed within
1094it exits. Instead, it will wait till it is being killed or closed by the 1059it exits. Instead, it will wait till it is being killed or closed by the
1095user. 1060user.
1096 1061
1062=item B<chdir>: I<path>
1063
1064Sets the working directory for the shell (or the command specified via
1065B<-e>). The I<path> must be an absolute path and it must exist for
1066@@RXVT_NAME@@ to start. If it isn't specified then the current working
1067directory will be used; option B<-cd>.
1068
1097=item B<keysym.>I<sym>: I<string> 1069=item B<keysym.>I<sym>: I<action>
1098 1070
1099Compile I<frills>: Associate I<string> with keysym I<sym>. The 1071Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1100intervening resource name B<keysym.> cannot be omitted. 1072resource name B<keysym.> cannot be omitted.
1101 1073
1102The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1074Using this resource, you can map key combinations such as
1103any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1075C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1104B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1076string than would normally result from that combination, making the
1105and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1077terminal scroll up or down the way you want it, or any other thing an
1106B<2>, B<3>, B<4>, B<5>. 1078extension might provide.
1079
1080The key combination that triggers the action, I<sym>, has the following format:
1081
1082 (modifiers-)key
1083
1084Where I<modifiers> can be any combination of the following full or
1085abbreviated modifier names:
1086
1087=begin table
1088
1089 B<ISOLevel3> B<I>
1090 B<AppKeypad> B<K>
1091 B<Control> B<C>
1092 B<NumLock> B<N>
1093 B<Shift> B<S>
1094 B<Meta> B<M> I<or> B<A>
1095 B<Lock> B<L>
1096 B<Mod1> B<1>
1097 B<Mod2> B<2>
1098 B<Mod3> B<3>
1099 B<Mod4> B<4>
1100 B<Mod5> B<5>
1101
1102=end table
1107 1103
1108The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1104The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1109whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1105whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1110keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1106keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1111current application keymap mode state. 1107current application keymap mode state.
1112 1108
1113The spellings of I<key> can be obtained by using B<xev>(1) command or 1109Due the the large number of modifier combinations, a key mapping will
1114searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1110match if I<at least> the specified identifiers are being set, and no other
1111key mappings with those and more bits are being defined. That means that
1112defining a mapping for C<a> will automatically provide definitions for
1113C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1114themselves. See the C<builtin:> action, below, for a way to work around
1115this when this is a problem.
1116
1117The spelling of I<key> depends on your implementation of X. An easy way to
1118find a key name is to use the B<xev>(1) command. You can find a list by
1119looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1115omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1120the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1116keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1121value (B<0x0000 - 0xFFFF>).
1117performed in an exact manner; however, the closest match is assured.
1118 1122
1119I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1123As with any resource value, the I<action> string may contain backslash
1124escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1120number), see RESOURCES in C<man 7 X> for futher details. 1125number), see RESOURCES in C<man 7 X> for further details.
1121 1126
1122You can define a range of keysyms in one shot by providing a I<string> 1127An action starts with an action prefix that selects a certain type
1123with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1128of action, followed by a colon. An action string without colons is
1129interpreted as a literal string to pass to the tty (as if it was
1130prefixed with C<string:>).
1131
1132The following action prefixes are known - extensions can provide
1133additional prefixes:
1134
1135=over 4
1136
1137=item string:STRING
1138
1139If the I<action> starts with C<string:> (or otherwise contains no colons),
1140then the remaining C<STRING> will be passed to the program running in the
1141terminal. For example, you could replace whatever Shift-Tab outputs by the
1142string C<echo rm -rf /> followed by a newline:
1143
1144 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1145
1146This could in theory be used to completely redefine your keymap.
1147
1148In addition, for actions of this type, you can define a range of
1149keysyms in one shot by loading the C<keysym-list> perl extension and
1150providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1124should be a character not used by the strings. 1151the delimiter `/' should be a character not used by the strings.
1125 1152
1126Its usage can be demonstrated by an example: 1153Its usage can be demonstrated by an example:
1127 1154
1128 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1155 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1129 1156
1130The above line is equivalent to the following three lines: 1157The above line is equivalent to the following three lines:
1131 1158
1132 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1159 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1133 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1160 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1134 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1161 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1135 1162
1163=item command:STRING
1164
1136If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1165If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1137is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1166is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1167the opposite of C<string:> - instead of sending it to the program running
1168in the terminal, it will be treated as if it were program output). This is
1169most useful to feed command sequences into @@RXVT_NAME@@.
1170
1138example the following means "change the current locale to C<zh_CN.GBK> 1171For example the following means "change the current locale to C<zh_CN.GBK>
1139when Control-Meta-c is being pressed": 1172when Control-Meta-c is being pressed":
1140 1173
1141 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1174 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1142 1175
1143If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1176The following example will map Control-Meta-1 and Control-Meta-2 to
1144is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1145manpage. For example, the F<selection> extension (activated via 1178font-switching at runtime:
1146C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1147 1179
1148 URxvt.keysym.M-C-c: perl:selection:rot13 1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1181 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1149 1182
1150Due the the large number of modifier combinations, a defined key mapping 1183Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1151will match if at I<at least> the specified identifiers are being set, and 1184info):
1152no other key mappings with those and more bits are being defined. That
1153means that defining a key map for C<a> will automatically provide
1154definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1155mappings themselves.
1156 1185
1157Unfortunately, this will override built-in key mappings. For example 1186 URxvt.keysym.M-C-3: command:\033[8;25;80t
1187 URxvt.keysym.M-C-4: command:\033[8;48;110t
1188
1189=item builtin:
1190
1191The builtin action is the action that @@RXVT_NAME@@ would execute if no
1192key binding existed for the key combination. The obvious use is to undo
1193the effect of existing bindings. The not so obvious use is to reinstate
1194bindings when another binding overrides too many modifiers.
1195
1158if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1196For example if you overwrite the C<Insert> key you will disable
1159C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1197@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1160user-defined keymap using the C<builtin:> replacement: 1198"holes" into the user-defined keymap using the C<builtin:> replacement:
1161 1199
1162 URxvt.keysym.Insert: <my insert key sequence> 1200 URxvt.keysym.Insert: <my insert key sequence>
1163 URxvt.keysym.S-Insert: builtin: 1201 URxvt.keysym.S-Insert: builtin:
1164 1202
1165The first line defines a mapping for C<Insert> and I<any> combination 1203The first line defines a mapping for C<Insert> and I<any> combination
1166of modifiers. The second line re-establishes the default mapping for 1204of modifiers. The second line re-establishes the default mapping for
1167C<Shift-Insert>. 1205C<Shift-Insert>.
1168 1206
1169The following example will map Control-Meta-1 and Control-Meta-2 to 1207=item builtin-string:
1170the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1171font-switching at runtime:
1172 1208
1173 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1209This action is mainly useful to restore string mappings for keys that
1174 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1210have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1211difficult to explain - basically, this action will send the string to the
1212application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1213action for it.
1175 1214
1176Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1215An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1177info): 1216selection when you press C<Shift-Insert>. With the following bindings, it
1217would instead emit the (undocumented, but what applications running in the
1218terminal might expect) sequence C<ESC [ 2 $> instead:
1178 1219
1179 URxvt.keysym.M-C-3: command:\033[8;25;80t 1220 URxvt.keysym.S-Insert: builtin-string:
1180 URxvt.keysym.M-C-4: command:\033[8;48;110t 1221 URxvt.keysym.C-S-Insert: builtin:
1222
1223The first line disables the paste functionality for that key
1224combination, and the second reinstates the default behaviour for
1225C<Control-Shift-Insert>, which would otherwise be overridden.
1226
1227Similarly, to let applications gain access to the C<C-M-c> (copy to
1228clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1229this:
1230
1231 URxvt.keysym.C-M-c: builtin-string:
1232 URxvt.keysym.C-M-v: builtin-string:
1233
1234=item EXTENSION:STRING
1235
1236An action of this form invokes the action B<STRING>, if any, provided
1237by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1238be loaded automatically if necessary.
1239
1240Not all extensions define actions, but popular extensions that do
1241include the I<selection> and I<matcher> extensions (documented in their
1242own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1243respectively).
1244
1245From the silly examples department, this will rot13-"encrypt"
1246@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1247keyboards:
1248
1249 URxvt.keysym.M-C-c: selection:rot13
1250
1251=item perl:STRING *DEPRECATED*
1252
1253This is a deprecated way of invoking commands provided by perl
1254extensions. It is still supported, but should not be used anymore.
1255
1256=back
1181 1257
1182=item B<perl-ext-common>: I<string> 1258=item B<perl-ext-common>: I<string>
1183 1259
1184=item B<perl-ext>: I<string> 1260=item B<perl-ext>: I<string>
1185 1261
1187use in this terminal instance; option B<-pe>. 1263use in this terminal instance; option B<-pe>.
1188 1264
1189Extension names can be prefixed with a C<-> sign to prohibit using 1265Extension names can be prefixed with a C<-> sign to prohibit using
1190them. This can be useful to selectively disable some extensions loaded 1266them. This can be useful to selectively disable some extensions loaded
1191by default, or specified via the C<perl-ext-common> resource. For 1267by default, or specified via the C<perl-ext-common> resource. For
1192example, C<default,-selection> will use all the default extension except 1268example, C<default,-selection> will use all the default extensions except
1193C<selection>. 1269C<selection>.
1194 1270
1195Extension names can also be followed by an argument in angle brackets 1271The default set includes the C<selection>, C<option-popup>,
1196(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1272C<selection-popup>, C<readline> and C<searchable-scrollback>
1197searchable scrollback to Alt/Meta-s). Mentioning the same extension 1273extensions, and extensions which are mentioned in B<keysym> resources.
1198multiple times with different arguments will pass multiple arguments to 1274
1199the extension. 1275Any extension such that a corresponding resource is given on the
1276command line is automatically appended to B<perl-ext>.
1200 1277
1201Each extension is looked up in the library directories, loaded if 1278Each extension is looked up in the library directories, loaded if
1202necessary, and bound to the current terminal instance. 1279necessary, and bound to the current terminal instance. When the library
1280search path contains multiple extension files of the same name, then the
1281first one found will be used.
1203 1282
1204If both of these resources are the empty string, then the perl 1283If both of these resources are the empty string, then the perl interpreter
1205interpreter will not be initialized. The idea behind two options is that 1284will not be initialized. The rationale for having two options is that
1206B<perl-ext-common> will be used for extensions that should be available to 1285B<perl-ext-common> will be used for extensions that should be available to
1207all instances, while B<perl-ext> is used for specific instances. 1286all instances, while B<perl-ext> is used for specific instances.
1208 1287
1209=item B<perl-eval>: I<string> 1288=item B<perl-eval>: I<string>
1210 1289
1211Perl code to be evaluated when all extensions have been registered. See 1290Perl code to be evaluated when all extensions have been registered. See
1212the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1291the @@RXVT_NAME@@perl(3) manpage.
1213will be ignored when running setuid/setgid.
1214 1292
1215=item B<perl-lib>: I<path> 1293=item B<perl-lib>: I<path>
1216 1294
1217Colon-separated list of additional directories that hold extension 1295Colon-separated list of additional directories that hold extension
1218scripts. When looking for extensions specified by the C<perl> resource, 1296scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1219@@RXVT_NAME@@ will first look in these directories and then in 1297in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1220F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1298lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1221will be ignored when running setuid/setgid.
1222 1299
1223See the @@RXVT_NAME@@perl(3) manpage. 1300See the @@RXVT_NAME@@perl(3) manpage.
1224 1301
1225=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1302=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1226 1303
1230=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1307=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1231 1308
1232Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1309Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1233for details. 1310for details.
1234 1311
1235=item B<searchable-scrollback:> I<keysym> 1312=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1236 1313
1237Sets the hotkey that starts the incremental scrollback buffer search 1314This resource is deprecated and will be removed. Use a B<keysym> resource
1238(default: C<M-s>). 1315instead, e.g.:
1239 1316
1317 URxvt.keysym.M-s: searchable-scrollback:start
1318
1240=item B<urlLauncher>: I<string> 1319=item B<url-launcher>: I<string>
1241 1320
1242Specifies the program to be started with a URL argument. Used by the 1321Specifies the program to be started with a URL argument. Used by the
1243C<selection-popup> and C<matcher> perl extensions. 1322C<selection-popup> and C<matcher> perl extensions.
1244 1323
1245=item B<transient-for>: I<windowid> 1324=item B<transient-for>: I<windowid>
1248 1327
1249=item B<override-redirect>: I<boolean> 1328=item B<override-redirect>: I<boolean>
1250 1329
1251Compile I<frills>: Sets override-redirect for the terminal window, making 1330Compile I<frills>: Sets override-redirect for the terminal window, making
1252it almost invisible to window managers; option B<-override-redirect>. 1331it almost invisible to window managers; option B<-override-redirect>.
1332
1333=item B<iso14755:> I<boolean>
1334
1335Turn on/off ISO 14755 (default enabled).
1253 1336
1254=item B<iso14755_52:> I<boolean> 1337=item B<iso14755_52:> I<boolean>
1255 1338
1256Turn on/off ISO 14755 5.2 mode (default enabled). 1339Turn on/off ISO 14755 5.2 mode (default enabled).
1257 1340
1309window causes the value of the PRIMARY selection (or CLIPBOARD with the 1392window causes the value of the PRIMARY selection (or CLIPBOARD with the
1310B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1393B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1311 1394
1312Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1395Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1313inserted too. 1396inserted too.
1397
1398rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1399<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1400binding causes the value of the internal selection to be copied to the
1401CLIPBOARD selection, while the second binding causes the value of the
1402CLIPBOARD selection to be inserted.
1314 1403
1315=back 1404=back
1316 1405
1317=head1 CHANGING FONTS 1406=head1 CHANGING FONTS
1318 1407
1400B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1489B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1401it can be seen via the I<who(1)> command, and can accept messages. To 1490it can be seen via the I<who(1)> command, and can accept messages. To
1402allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1491allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1403on some systems or setgid to root or to some other group on others. 1492on some systems or setgid to root or to some other group on others.
1404 1493
1405=head1 COLORS AND GRAPHICS 1494=head1 COLOURS AND GRAPHICS
1406 1495
1407In addition to the default foreground and background colours, 1496In addition to the default foreground and background colours,
1408B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1497B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1409high-intensity bold/blink versions of the same). Here is a list of the 1498high-intensity (potentially bold/blink) versions of the same, and 72 (or
1410colours with their names. 1499240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1500cube plus a 8 (24) colour greyscale ramp.
1501
1502B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1503C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1504number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1505colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
150624-bit colour space. When indexing collisions happen, the nearest old colour in
1507the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1508use many similar 24-bit colours. It's typically not a problem in common
1509scenarios.
1510
1511Here is a list of the ANSI colours with their names.
1411 1512
1412=begin table 1513=begin table
1413 1514
1414 B<color0> (black) = Black 1515 B<color0> (black) = Black
1415 B<color1> (red) = Red3 1516 B<color1> (red) = Red3
1435It is also possible to specify the colour values of B<foreground>, 1536It is also possible to specify the colour values of B<foreground>,
1436B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1537B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1437a number 0-15, as a convenient shorthand to reference the colour name of 1538a number 0-15, as a convenient shorthand to reference the colour name of
1438color0-color15. 1539color0-color15.
1439 1540
1440In addition to the colours defined above, @@RXVT_NAME@@ offers an 1541The following text gives values for the standard 88 colour mode (and
1441additional 72 colours. The first 64 of those (with indices 16 to 79) 1542values for the 256 colour mode in parentheses).
1442consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144316>), followed by 8 additional shades of gray (with indices 80 to 87).
1444 1543
1544The RGB cube uses indices 16..79 (16..231) using the following formulas:
1545
1546 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1547 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1548
1549The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1550steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1551the RGB cube.
1552
1445Together, all those colours implement the 88 colour xterm colours. Only 1553Together, all those colours implement the 88 (256) colour xterm
1446the first 16 can be changed using resources currently, the rest can only 1554colours. Only the first 16 can be changed using resources currently, the
1447be changed via command sequences ("escape codes"). 1555rest can only be changed via command sequences ("escape codes").
1556
1557Applications are advised to use terminfo or command sequences to discover
1558number and RGB values of all colours (yes, you can query this...).
1448 1559
1449Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1560Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1450always swapping the foreground/background colours. This is in contrast to 1561always swapping the foreground/background colours. This is in contrast to
1451I<xterm>(1) where the colours are only swapped if they have not otherwise 1562I<xterm>(1) where the colours are only swapped if they have not otherwise
1452been specified. For example, 1563been specified. For example,
1453 1564
1454=over 4
1455
1456=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1565 @@RXVT_NAME@@ -fg Black -bg White -rv
1457 1566
1458would yield White on Black, while on I<xterm>(1) it would yield Black 1567would yield White on Black, while on I<xterm>(1) it would yield Black on
1459on White. 1568White.
1460
1461=back
1462 1569
1463=head2 ALPHA CHANNEL SUPPORT 1570=head2 ALPHA CHANNEL SUPPORT
1464 1571
1465If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1572If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1466their act together, rxvt-unicode will do it's own alpha channel management: 1573their act together, rxvt-unicode will do its own alpha channel management:
1467 1574
1468You can prefix any color with an opaquenes percentage enclosed in 1575You can prefix any colour with an opaqueness percentage enclosed in
1469brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1576brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470(0-100) that specifies the opacity of the color, where C<0> is completely 1577(0-100) that specifies the opacity of the colour, where C<0> is completely
1471transparent and C<100> is completely opaque. For example, C<[50]red> is a 1578transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1579half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473is the recommended format to specify transparency values, and works with 1580is the recommended format to specify transparency values, and works with
1474all ways to specify a colour. 1581all ways to specify a colour.
1475 1582
1546C<--with-terminfo=PATH>. 1653C<--with-terminfo=PATH>.
1547 1654
1548=item B<DISPLAY> 1655=item B<DISPLAY>
1549 1656
1550Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1657Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1551display in its child processes. 1658display in its child processes if C<-display> isn't used to override. It
1659defaults to C<:0> if it doesn't exist.
1552 1660
1553=item B<SHELL> 1661=item B<SHELL>
1554 1662
1555The shell to be used for command execution, defaults to C</bin/sh>. 1663The shell to be used for command execution, defaults to C</bin/sh>.
1556 1664
1557=item B<RXVT_SOCKET> 1665=item B<RXVT_SOCKET> [I<sic>]
1558 1666
1559The unix domain socket path used by @@RXVT_NAME@@c(1) and 1667The unix domain socket path used by @@RXVT_NAME@@c(1) and
1560@@RXVT_NAME@@d(1). 1668@@RXVT_NAME@@d(1).
1561 1669
1562Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1670Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1671
1672=item B<URXVT_PERL_LIB>
1673
1674Additional F<:>-separated library search path for perl extensions. Will be
1675searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1676directory.
1677
1678=item B<URXVT_PERL_VERBOSITY>
1679
1680See L<@@RXVT_NAME@@perl>(3).
1563 1681
1564=item B<HOME> 1682=item B<HOME>
1565 1683
1566Used to locate the default directory for the unix domain socket for 1684Used to locate the default directory for the unix domain socket for
1567daemon communications and to locate various resource files (such as 1685daemon communications and to locate various resource files (such as
1568C<.Xdefaults>) 1686C<.Xdefaults>)
1569 1687
1570=item B<XAPPLRESDIR> 1688=item B<XAPPLRESDIR>
1571 1689
1572Directory where various X resource files are being located. 1690Directory where application-specific X resource files are located.
1573 1691
1574=item B<XENVIRONMENT> 1692=item B<XENVIRONMENT>
1575 1693
1576If set and accessible, gives the name of a X resource file to be loaded by 1694If set and accessible, gives the name of a X resource file to be loaded by
1577@@RXVT_NAME@@. 1695@@RXVT_NAME@@.
1582 1700
1583=over 4 1701=over 4
1584 1702
1585=item B</usr/lib/X11/rgb.txt> 1703=item B</usr/lib/X11/rgb.txt>
1586 1704
1587Color names. 1705Colour names.
1588 1706
1589=back 1707=back
1590 1708
1591=head1 SEE ALSO 1709=head1 SEE ALSO
1592 1710
1711@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1593@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1712@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1594 1713
1595=head1 CURRENT PROJECT COORDINATOR 1714=head1 CURRENT PROJECT COORDINATOR
1596 1715
1597=over 4 1716=over 4
1598 1717
1599=item Project Coordinator 1718=item Project Coordinator
1600 1719
1601Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1720Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1602 1721
1603L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1722L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1604 1723
1605=back 1724=back
1606 1725
1610 1729
1611=item John Bovey 1730=item John Bovey
1612 1731
1613University of Kent, 1992, wrote the original Xvt. 1732University of Kent, 1992, wrote the original Xvt.
1614 1733
1615=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1734=item Rob Nation <nation@rocket.sanders.lockheed.com>
1616 1735
1617very heavily modified Xvt and came up with Rxvt 1736very heavily modified Xvt and came up with Rxvt
1618 1737
1619=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1738=item Angelo Haritsis <ah@doc.ic.ac.uk>
1620 1739
1621wrote the Greek Keyboard Input (no longer in code) 1740wrote the Greek Keyboard Input (no longer in code)
1622 1741
1623=item mj olesen L<< <olesen@me.QueensU.CA> >> 1742=item mj olesen <olesen@me.QueensU.CA>
1624 1743
1625Wrote the menu system. 1744Wrote the menu system.
1626 1745
1627Project Coordinator (changes.txt 2.11 to 2.21) 1746Project Coordinator (changes.txt 2.11 to 2.21)
1628 1747
1629=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1748=item Oezguer Kesim <kesim@math.fu-berlin.de>
1630 1749
1631Project Coordinator (changes.txt 2.21a to 2.4.5) 1750Project Coordinator (changes.txt 2.21a to 2.4.5)
1632 1751
1633=item Geoff Wing L<< <gcw@pobox.com> >> 1752=item Geoff Wing <gcw@pobox.com>
1634 1753
1635Rewrote screen display and text selection routines. 1754Rewrote screen display and text selection routines.
1636 1755
1637Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1756Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1638 1757
1639=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1758=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1640 1759
1641Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1760Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1642extension, random hacks, numerous bugfixes and extensions. 1761extension, random hacks, numerous bugfixes and extensions.
1643 1762
1644Project Coordinator (Changes 1.0 -) 1763Project Coordinator (Changes 1.0 -)
1645 1764
1646=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1765=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1647 1766
1648Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1767pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1649 1768
1650=back 1769=back
1651 1770

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines