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.153 by root, Wed Dec 12 19:57:13 2007 UTC vs.
Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 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
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
109this, so watch out]
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
106=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
107 118
108Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
109 120
110=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
116Turn 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>.
117 128
118=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
119 130
120Turn 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>.
121
122=item B<-tr>|B<+tr>
123
124Turn on/off illusion of a transparent window background; resource B<transparent>.
125
126B<-ip> is still accepted as an obsolete alias but will be removed in
127future versions.
128
129I<Please address all transparency related issues to Sasha Vasko at
130sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
131 132
132=item B<-fade> I<number> 133=item B<-fade> I<number>
133 134
134Fade 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
135fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
138=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
139 140
140Fade 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
141is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
142 143
143=item B<-tint> I<colour> 144=item B<-icon> I<file>
144 145
145Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
146transparency is enabled with B<-tr>. This only works for 147is used by many window managers, taskbars and pagers to represent the
147non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application window; resource I<iconFile>.
148used to brighten or darken the image in addition to tinting it.
149Please note that certain tint colours can be applied on the server-side,
150thus yielding performance gain of two orders of magnitude. These colours are:
151blue, red, green, cyan, magenta, yellow, and those close to them. Also
152pure black and pure white colors essentially mean no tinting; resource
153I<tintColor>. Example:
154
155 @@RXVT_NAME@@ -tr -tint blue -sh 40
156
157=item B<-sh> I<number>
158
159Darken (0 .. 100) or lighten (100 .. 200) the transparent
160background image in addition to (or instead of) tinting it;
161resource I<shading>.
162
163=item B<-blt> I<string>
164
165Specify background blending type. If background pixmap is specified
166at the same time as transparency - such pixmap will be blended over
167transparency image, using method specified. Supported values are :
168B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
169B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171alpha-blending. Compile I<afterimage>; resource I<blendType>.
172
173=item B<-blr> I<HxV>
174
175Apply Gaussian Blur with the specified radii to the transparent
176background image. If single number is specified - both vertical and
177horizontal radii are considered to be the same. Setting one of the
178radii to 1 and another to a large number creates interesting effects
179on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180resource I<blurRadius>.
181 149
182=item B<-bg> I<colour> 150=item B<-bg> I<colour>
183 151
184Window background colour; resource B<background>. 152Window background colour; resource B<background>.
185 153
186=item B<-fg> I<colour> 154=item B<-fg> I<colour>
187 155
188Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
189
190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
191
192Compile I<afterimage>: Specify image file for the background and also
193optionally specify its scaling with a geometry string. Note you may need to
194add quotes to avoid special shell interpretation of the C<;> in the
195command-line; for more details see resource B<backgroundPixmap>.
196 157
197=item B<-cr> I<colour> 158=item B<-cr> I<colour>
198 159
199The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
200 161
245italic> >> characters are to be printed. See resource B<boldItalicFont> 206italic> >> characters are to be printed. See resource B<boldItalicFont>
246for details. 207for details.
247 208
248=item B<-is>|B<+is> 209=item B<-is>|B<+is>
249 210
250Compile I<font-styles>: Bold/Italic font styles imply high intensity 211Compile I<font-styles>: Bold/Blink font styles imply high intensity
251foreground/background (default). See resource B<intensityStyles> for 212foreground/background (default). See resource B<intensityStyles> for
252details. 213details.
253 214
254=item B<-name> I<name> 215=item B<-name> I<name>
255 216
259 220
260=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
261 222
262Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
263 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
264=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
265 230
266Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
267B<utmpInhibit>. 232B<utmpInhibit>.
268 233
272B<visualBell>. 237B<visualBell>.
273 238
274=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
275 240
276Turn on/off scrollbar; resource B<scrollBar>. 241Turn on/off scrollbar; resource B<scrollBar>.
242
243=item B<-sr>|B<+sr>
244
245Put scrollbar on right/left; resource B<scrollBar_right>.
246
247=item B<-st>|B<+st>
248
249Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
250resource B<scrollBar_floating>.
277 251
278=item B<-si>|B<+si> 252=item B<-si>|B<+si>
279 253
280Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
281B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
288=item B<-sw>|B<+sw> 262=item B<-sw>|B<+sw>
289 263
290Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
291This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
292B<scrollWithBuffer>. 266B<scrollWithBuffer>.
293
294=item B<-sr>|B<+sr>
295
296Put scrollbar on right/left; resource B<scrollBar_right>.
297
298=item B<-st>|B<+st>
299
300Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
301resource B<scrollBar_floating>.
302 267
303=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
304 269
305If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
306actual wide characters in the screen buffer, which makes it possible to 271actual wide characters in the screen buffer, which makes it possible to
310 275
311=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
312 277
313Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
314 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
315=item B<-iconic> 284=item B<-iconic>
316 285
317Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
318Alternative form is B<-ic>. 287Alternative form is B<-ic>.
319 288
335 304
336=item B<-bl> 305=item B<-bl>
337 306
338Compile 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.
339if 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
340decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
341 311
342=item B<-override-redirect> 312=item B<-override-redirect>
343 313
344Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
345B<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.
346 321
347=item B<-sbg> 322=item B<-sbg>
348 323
349Compile 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
350drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
354=item B<-lsp> I<number> 329=item B<-lsp> I<number>
355 330
356Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
357the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
358B<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>.
359 341
360=item B<-tn> I<termname> 342=item B<-tn> I<termname>
361 343
362This 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
363B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
398=item B<-pt> I<style> 380=item B<-pt> I<style>
399 381
400Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
401B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
402 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
403=item B<-im> I<text> 388=item B<-im> I<text>
404 389
405Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
406 391
407=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
449 434
450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451will not immediately destroy its window when the program executed within 436will not immediately destroy its window when the program executed within
452it 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
453user; 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>.
454 445
455=item B<-xrm> I<string> 446=item B<-xrm> I<string>
456 447
457Works 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>
458as 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
542You 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
543distribution do also load settings from the B<~/.Xresources> file when X 534distribution do also load settings from the B<~/.Xresources> file when X
544starts. @@RXVT_NAME@@ will consult the following files/resources in order, 535starts. @@RXVT_NAME@@ will consult the following files/resources in order,
545with later settings overwriting earlier ones: 536with later settings overwriting earlier ones:
546 537
547 1. system-wide app-defaults file, either locale-dependent OR global
548 2. app-defaults file in $XAPPLRESDIR 538 1. app-defaults file in $XAPPLRESDIR
539 2. $HOME/.Xdefaults
549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 540 3. RESOURCE_MANAGER property on root-window of screen 0
550 4. SCREEN_RESOURCES for the current screen 541 4. SCREEN_RESOURCES property on root-window of the current screen
551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 542 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline 543 6. resources specified via -xrm on the commandline
553 544
554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 545Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
555names: 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
567=item B<depth:> I<bitdepth> 558=item B<depth:> I<bitdepth>
568 559
569Compile 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;
570option B<-depth>. 561option B<-depth>.
571 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
572=item B<geometry:> I<geom> 570=item B<geometry:> I<geom>
573 571
574Create the window with the specified X window geometry [default 80x24]; 572Create the window with the specified X window geometry [default 80x24];
575option B<-geometry>. 573option B<-geometry>.
576 574
589Use 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
590corresponds to low-intensity (normal) colours and 8-15 corresponds to 588corresponds to low-intensity (normal) colours and 8-15 corresponds to
591high-intensity (bold = bright foreground, blink = bright background) 589high-intensity (bold = bright foreground, blink = bright background)
592colours. 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,
5933=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
594names used are listed in the B<COLORS AND GRAPHICS> section. 592names used are listed in the B<COLOURS AND GRAPHICS> section.
595 593
596Colours 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
597changed using an escape command (see @@RXVT_NAME@@(7)). 595changed using an escape command (see @@RXVT_NAME@@(7)).
598 596
599Colours 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
610=item B<colorUL:> I<colour> 608=item B<colorUL:> I<colour>
611 609
612Use the specified colour to display underlined characters when the 610Use the specified colour to display underlined characters when the
613foreground colour is the default. 611foreground colour is the default.
614 612
615=item B<colorRV:> I<colour>
616
617Use the specified colour as the background for reverse video characters
618when OPTION_HC is disabled (--disable-frills).
619
620=item B<underlineColor:> I<colour> 613=item B<underlineColor:> I<colour>
621 614
622If set, use the specified colour as the colour for the underline 615If set, use the specified colour as the colour for the underline
623itself. 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.
624 627
625=item B<cursorColor:> I<colour> 628=item B<cursorColor:> I<colour>
626 629
627Use 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
628foreground colour; option B<-cr>. 631foreground colour; option B<-cr>.
635 638
636=item B<reverseVideo:> I<boolean> 639=item B<reverseVideo:> I<boolean>
637 640
638B<True>: simulate reverse video by foreground and background colours; 641B<True>: simulate reverse video by foreground and background colours;
639option B<-rv>. B<False>: regular screen colours [default]; option 642option B<-rv>. B<False>: regular screen colours [default]; option
640B<+rv>. See note in B<COLORS AND GRAPHICS> section. 643B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641 644
642=item B<jumpScroll:> I<boolean> 645=item B<jumpScroll:> I<boolean>
643 646
644B<True>: specify that jump scrolling should be used. When receiving lots 647B<True>: specify that jump scrolling should be used. When receiving lots
645of 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
659 662
660B<False>: specify that everything is to be displayed, even 663B<False>: specify that everything is to be displayed, even
661if 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
662monitor to display anything); option B<+ss>. 665monitor to display anything); option B<+ss>.
663 666
664=item B<transparent:> I<boolean>
665
666Turn on/off illusion of a transparent window background.
667
668B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669future versions.
670
671I<Please address all transparency related issues to Sasha Vasko at
672sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
673
674=item B<fading:> I<number> 667=item B<fading:> I<number>
675 668
676Fade 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>.
677 670
678=item B<fadeColor:> I<colour> 671=item B<fadeColor:> I<colour>
679 672
680Fade 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
681colour is black; option B<-fadecolor>. 674colour is black; option B<-fadecolor>.
682 675
683=item B<tintColor:> I<colour> 676=item B<iconFile:> I<file>
684 677
685Tint the transparent background pixmap with the given colour; option 678Set the application icon pixmap; option B<-icon>.
686B<-tint>.
687
688=item B<shading:> I<number>
689
690Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
691in addition to tinting it; option B<-sh>.
692
693=item B<blendType:> I<string>
694
695Specify background blending type; option B<-blt>.
696
697=item B<blurRadius:> I<number>
698
699Apply Gaussian Blurr with the specified radius to the transparent
700background image; option B<-blr>.
701 679
702=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
703 681
704Use the specified colour for the scrollbar [default #B2B2B2]. 682Use the specified colour for the scrollbar [default #B2B2B2].
705 683
710 688
711=item B<borderColor:> I<colour> 689=item B<borderColor:> I<colour>
712 690
713The 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
714and the text. 692and the text.
715
716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
717
718Use the specified image file for the background and also
719optionally specify its scaling with a geometry string B<WxH+X+Y>,
720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
721horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
722centre (percent). A scale of 0 displays the image with tiling. A scale
723of 1 displays the image without any scaling. A scale of 2 to 9 specifies
724an integer number of images in that direction. No image will be magnified
725beyond 10 times its original size. The maximum permitted scale is 1000.
726Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are:
728
729 tile force background image to be tiled and not scaled. Equivalent to 0x0,
730 propscale will scale image keeping proportions,
731 auto will scale image to match window size. Equivalent to 100x100;
732 hscale will scale image horizontally to the window size;
733 vscale will scale image vertically to the window size;
734 scale will scale image to match window size;
735 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves.
737
738If used in conjunction with B<-tr> option, the specified pixmap will be
739blended over transparency image using either alpha-blending, or any
740other blending type, specified with B<-blt "type"> option.
741
742=item B<path:> I<path>
743
744Specify the colon-delimited search path for finding background image files.
745 693
746=item B<font:> I<fontlist> 694=item B<font:> I<fontlist>
747 695
748Select 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
749that 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
772it 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
773wide and 15 pixels high. 721wide and 15 pixels high.
774 722
775The 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
776the base font, likewise the third, which is unfortunately non-bold, but 724the base font, likewise the third, which is unfortunately non-bold, but
777the 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
778useful supplement. 726useful supplement.
779 727
780The 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
781are 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
782contains other characters, but we are not interested in them. 730contains other characters, but we are not interested in them.
806text font will being used for the given style. 754text font will being used for the given style.
807 755
808=item B<intensityStyles:> I<boolean> 756=item B<intensityStyles:> I<boolean>
809 757
810When font styles are not enabled, or this option is enabled (B<True>, 758When font styles are not enabled, or this option is enabled (B<True>,
811option B<-is>, the default), bold and italic font styles imply high 759option B<-is>, the default), bold/blink font styles imply high
812intensity foreground/background colours. Disabling this option (B<False>, 760intensity foreground/background colours. Disabling this option (B<False>,
813option B<+is>) disables this behaviour, the high intensity colours are not 761option B<+is>) disables this behaviour, the high intensity colours are not
814reachable. 762reachable.
815 763
816=item B<selectstyle:> I<mode>
817
818Set mouse selection style to B<old> which is 2.20, B<oldword> which
819is xterm style with 2.20 old word selection, or anything else which
820gives xterm style selection. Only effective when the original (non-perl)
821selection code is in use.
822
823=item B<scrollstyle:> I<mode>
824
825Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
826the author's favourite.
827
828=item B<title:> I<string> 764=item B<title:> I<string>
829 765
830Set window title string, the default title is the command-line 766Set window title string, the default title is the command-line
831specified after the B<-e> option, if any, otherwise the application 767specified after the B<-e> option, if any, otherwise the application
832name; option B<-title>. 768name; option B<-title>.
845=item B<urgentOnBell:> I<boolean> 781=item B<urgentOnBell:> I<boolean>
846 782
847B<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.
848B<False>: do not set the urgency hint [default]. 784B<False>: do not set the urgency hint [default].
849 785
786@@RXVT_NAME@@ resets the urgency hint on every focus change.
787
850=item B<visualBell:> I<boolean> 788=item B<visualBell:> I<boolean>
851 789
852B<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>.
853B<False>: no visual bell [default]; option B<+vb>. 791B<False>: no visual bell [default]; option B<+vb>.
854 792
856 794
857B<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
858the 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
859[default]; option B<+ls>. 797[default]; option B<+ls>.
860 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
861=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
862 805
863B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
864option B<-ut>. B<False>: write record into the system log file B<utmp> 807option B<-ut>. B<False>: write record into the system log file B<utmp>
865[default]; option B<+ut>. 808[default]; option B<+ut>.
877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 820 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878 821
879This creates a new file in your home directory with the screen contents 822This creates a new file in your home directory with the screen contents
880every time you hit C<Print>. 823every time you hit C<Print>.
881 824
825=item B<scrollstyle:> I<mode>
826
827Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
828the author's favourite.
829
830=item B<thickness:> I<number>
831
832Set the scrollbar width in pixels.
833
882=item B<scrollBar:> I<boolean> 834=item B<scrollBar:> I<boolean>
883 835
884B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 836B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885disable the scrollbar; option B<+sb>. 837disable the scrollbar; option B<+sb>.
886 838
905B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
906B<+si>. 858B<+si>.
907 859
908=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
909 861
910B<True>: scroll with scrollback buffer when tty receives new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
911B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
912with 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>.
913 866
914=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
915 868
916B<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
917are those which are intercepted by rxvt-unicode for special handling and 870are those which are intercepted by rxvt-unicode for special handling and
918are 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
919bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
920 873
921=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
922 875
923Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
924resource is limited on most machines to 65535; option B<-sl>.
925 877
926=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
927 879
928Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
929option B<-b>. 881option B<-b>.
973=item B<cursorBlink:> I<boolean> 925=item B<cursorBlink:> I<boolean>
974 926
975B<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];
976option B<-bc>. 928option B<-bc>.
977 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
978=item B<pointerBlank:> I<boolean> 935=item B<pointerBlank:> I<boolean>
979 936
980B<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
981of seconds of inactivity. B<False>: the pointer is always visible 938of seconds of inactivity. B<False>: the pointer is always visible
982[default]. 939[default].
987 944
988=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
989 946
990Mouse pointer background colour. 947Mouse pointer background colour.
991 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
992=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
993 956
994Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
995large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
996 959
997=item B<backspacekey:> I<string> 960=item B<backspacekey:> I<string>
998 961
999The 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>
1000or 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>
1001(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
1002escape sequence. 965escape sequence.
1003 966
1004=item B<deletekey:> I<string> 967=item B<deletekey:> I<string>
1005 968
1022 985
1023B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1024 987
1025=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
1026 989
1027B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1028 991
1029=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
1030 993
1031I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
1032 995
1084 1047
1085=item B<secondaryScroll:> I<boolean> 1048=item B<secondaryScroll:> I<boolean>
1086 1049
1087Turn on/off secondary screen scroll (default enabled). If this 1050Turn on/off secondary screen scroll (default enabled). If this
1088option is enabled, scrolls on the secondary screen will change the 1051option is enabled, scrolls on the secondary screen will change the
1089scrollback buffer and switching to/from the secondary screen will 1052scrollback buffer and, when secondaryScreen is off, switching
1090instead scroll the screen up. 1053to/from the secondary screen will instead scroll the screen up.
1091 1054
1092=item B<hold>: I<boolean> 1055=item B<hold>: I<boolean>
1093 1056
1094Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1057Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1095will not immediately destroy its window when the program executed within 1058will not immediately destroy its window when the program executed within
1096it 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
1097user. 1060user.
1098 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
1099=item B<keysym.>I<sym>: I<string> 1069=item B<keysym.>I<sym>: I<action>
1100 1070
1101Compile I<frills>: Associate I<string> with keysym I<sym>. The 1071Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1102intervening resource name B<keysym.> cannot be omitted. 1072resource name B<keysym.> cannot be omitted.
1103 1073
1104The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1074Using this resource, you can map key combinations such as
1105any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1075C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1106B<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
1107and 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
1108B<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 B<ISOLevel3>, B<AppKeypad>,
1085B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1086B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1087B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1109 1088
1110The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1089The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1111whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1090whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1112keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1091keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1113current application keymap mode state. 1092current application keymap mode state.
1114 1093
1115The spellings of I<key> can be obtained by using B<xev>(1) command or 1094Due the the large number of modifier combinations, a key mapping will
1116searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1095match if I<at least> the specified identifiers are being set, and no other
1096key mappings with those and more bits are being defined. That means that
1097defining a mapping for C<a> will automatically provide definitions for
1098C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1099themselves. See the C<builtin:> action, below, for a way to work around
1100this when this is a problem.
1101
1102The spelling of I<key> depends on your implementation of X. An easy way to
1103find a key name is to use the B<xev>(1) command. You can find a list by
1104looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1117omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1105the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1118keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1106value (B<0x0000 - 0xFFFF>).
1119performed in an exact manner; however, the closest match is assured.
1120 1107
1121I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1108As with any resource value, the I<action> string may contain backslash
1109escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1122number), see RESOURCES in C<man 7 X> for futher details. 1110number), see RESOURCES in C<man 7 X> for further details.
1123 1111
1124You can define a range of keysyms in one shot by providing a I<string> 1112An action starts with an action prefix that selects a certain type
1125with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1113of action, followed by a colon. An action string without colons is
1114interpreted as a literal string to pass to the tty (as if it was
1115prefixed with C<string:>).
1116
1117The following action prefixes are known - extensions can provide
1118additional prefixes:
1119
1120=over 4
1121
1122=item string:STRING
1123
1124If the I<action> starts with C<string:> (or otherwise contains no colons),
1125then the remaining C<STRING> will be passed to the program running in the
1126terminal. For example, you could replace whatever Shift-Tab outputs by the
1127string C<echo rm -rf /> followed by a newline:
1128
1129 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1130
1131This could in theory be used to completely redefine your keymap.
1132
1133In addition, for actions of this type, you can define a range of
1134keysyms in one shot by loading the C<keysym-list> perl extension and
1135providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1126should be a character not used by the strings. 1136the delimiter `/' should be a character not used by the strings.
1127 1137
1128Its usage can be demonstrated by an example: 1138Its usage can be demonstrated by an example:
1129 1139
1130 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1140 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1131 1141
1132The above line is equivalent to the following three lines: 1142The above line is equivalent to the following three lines:
1133 1143
1134 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1144 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1135 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1145 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1136 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1146 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1137 1147
1148=item command:STRING
1149
1138If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1150If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1139is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1151is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1152the opposite of C<string:> - instead of sending it to the program running
1153in the terminal, it will be treated as if it were program output). This is
1154most useful to feed command sequences into @@RXVT_NAME@@.
1155
1140example the following means "change the current locale to C<zh_CN.GBK> 1156For example the following means "change the current locale to C<zh_CN.GBK>
1141when Control-Meta-c is being pressed": 1157when Control-Meta-c is being pressed":
1142 1158
1143 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1159 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1144 1160
1145If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1161The following example will map Control-Meta-1 and Control-Meta-2 to
1146is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1162the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1147manpage. For example, the F<selection> extension (activated via 1163font-switching at runtime:
1148C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1149 1164
1150 URxvt.keysym.M-C-c: perl:selection:rot13 1165 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1166 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1151 1167
1152Due the the large number of modifier combinations, a defined key mapping 1168Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1153will match if at I<at least> the specified identifiers are being set, and 1169info):
1154no other key mappings with those and more bits are being defined. That
1155means that defining a key map for C<a> will automatically provide
1156definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1157mappings themselves.
1158 1170
1159Unfortunately, this will override built-in key mappings. For example 1171 URxvt.keysym.M-C-3: command:\033[8;25;80t
1172 URxvt.keysym.M-C-4: command:\033[8;48;110t
1173
1174=item builtin:
1175
1176The builtin action is the action that @@RXVT_NAME@@ would execute if no
1177key binding existed for the key combination. The obvious use is to undo
1178the effect of existing bindings. The not so obvious use is to reinstate
1179bindings when another binding overrides too many modifiers.
1180
1160if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1181For example if you overwrite the C<Insert> key you will disable
1161C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1182@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1162user-defined keymap using the C<builtin:> replacement: 1183"holes" into the user-defined keymap using the C<builtin:> replacement:
1163 1184
1164 URxvt.keysym.Insert: <my insert key sequence> 1185 URxvt.keysym.Insert: <my insert key sequence>
1165 URxvt.keysym.S-Insert: builtin: 1186 URxvt.keysym.S-Insert: builtin:
1166 1187
1167The first line defines a mapping for C<Insert> and I<any> combination 1188The first line defines a mapping for C<Insert> and I<any> combination
1168of modifiers. The second line re-establishes the default mapping for 1189of modifiers. The second line re-establishes the default mapping for
1169C<Shift-Insert>. 1190C<Shift-Insert>.
1170 1191
1171The following example will map Control-Meta-1 and Control-Meta-2 to 1192=item builtin-string:
1172the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1173font-switching at runtime:
1174 1193
1175 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1194This action is mainly useful to restore string mappings for keys that
1176 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1195have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1196difficult to explain - basically, this action will send the string to the
1197application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1198action for it.
1177 1199
1178Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1200An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1179info): 1201selection when you press C<Shift-Insert>. With the following bindings, it
1202would instead emit the (undocumented, but what applications running in the
1203terminal might expect) sequence C<ESC [ 2 $> instead:
1180 1204
1181 URxvt.keysym.M-C-3: command:\033[8;25;80t 1205 URxvt.keysym.S-Insert: builtin-string:
1182 URxvt.keysym.M-C-4: command:\033[8;48;110t 1206 URxvt.keysym.C-S-Insert: builtin:
1207
1208The first line disables the paste functionality for that key
1209combination, and the second reinstates the default behaviour for
1210C<Control-Shift-Insert>, which would otherwise be overridden.
1211
1212Similarly, to let applications gain access to the C<C-M-c> (copy to
1213clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1214this:
1215
1216 URxvt.keysym.C-M-c: builtin-string:
1217 URxvt.keysym.C-M-v: builtin-string:
1218
1219=item EXTENSION:STRING
1220
1221An action of this form invokes the action B<STRING>, if any, provided
1222by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1223be loaded automatically if necessary.
1224
1225Not all extensions define actions, but popular extensions that do
1226include the I<selection> and I<matcher> extensions (documented in their
1227own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1228respectively).
1229
1230From the silly examples department, this will rot13-"encrypt"
1231@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1232keyboards:
1233
1234 URxvt.keysym.M-C-c: selection:rot13
1235
1236=item perl:STRING *DEPRECATED*
1237
1238This is a deprecated way of invoking commands provided by perl
1239extensions. It is still supported, but should not be used anymore.
1240
1241=back
1183 1242
1184=item B<perl-ext-common>: I<string> 1243=item B<perl-ext-common>: I<string>
1185 1244
1186=item B<perl-ext>: I<string> 1245=item B<perl-ext>: I<string>
1187 1246
1189use in this terminal instance; option B<-pe>. 1248use in this terminal instance; option B<-pe>.
1190 1249
1191Extension names can be prefixed with a C<-> sign to prohibit using 1250Extension names can be prefixed with a C<-> sign to prohibit using
1192them. This can be useful to selectively disable some extensions loaded 1251them. This can be useful to selectively disable some extensions loaded
1193by default, or specified via the C<perl-ext-common> resource. For 1252by default, or specified via the C<perl-ext-common> resource. For
1194example, C<default,-selection> will use all the default extension except 1253example, C<default,-selection> will use all the default extensions except
1195C<selection>. 1254C<selection>.
1196 1255
1197Extension names can also be followed by an argument in angle brackets 1256The default set includes the C<selection>, C<option-popup>,
1198(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1257C<selection-popup>, C<readline> and C<searchable-scrollback>
1199searchable scrollback to Alt/Meta-s). Mentioning the same extension 1258extensions, and extensions which are mentioned in B<keysym> resources.
1200multiple times with different arguments will pass multiple arguments to 1259
1201the extension. 1260Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>.
1202 1262
1203Each extension is looked up in the library directories, loaded if 1263Each extension is looked up in the library directories, loaded if
1204necessary, and bound to the current terminal instance. 1264necessary, and bound to the current terminal instance. When the library
1265search path contains multiple extension files of the same name, then the
1266first one found will be used.
1205 1267
1206If both of these resources are the empty string, then the perl 1268If both of these resources are the empty string, then the perl interpreter
1207interpreter will not be initialized. The idea behind two options is that 1269will not be initialized. The rationale for having two options is that
1208B<perl-ext-common> will be used for extensions that should be available to 1270B<perl-ext-common> will be used for extensions that should be available to
1209all instances, while B<perl-ext> is used for specific instances. 1271all instances, while B<perl-ext> is used for specific instances.
1210 1272
1211=item B<perl-eval>: I<string> 1273=item B<perl-eval>: I<string>
1212 1274
1213Perl code to be evaluated when all extensions have been registered. See 1275Perl code to be evaluated when all extensions have been registered. See
1214the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1276the @@RXVT_NAME@@perl(3) manpage.
1215will be ignored when running setuid/setgid.
1216 1277
1217=item B<perl-lib>: I<path> 1278=item B<perl-lib>: I<path>
1218 1279
1219Colon-separated list of additional directories that hold extension 1280Colon-separated list of additional directories that hold extension
1220scripts. When looking for extensions specified by the C<perl> resource, 1281scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1221@@RXVT_NAME@@ will first look in these directories and then in 1282in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1222F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1283lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1223will be ignored when running setuid/setgid.
1224 1284
1225See the @@RXVT_NAME@@perl(3) manpage. 1285See the @@RXVT_NAME@@perl(3) manpage.
1226 1286
1227=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1287=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1228 1288
1232=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1292=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1233 1293
1234Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1294Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1235for details. 1295for details.
1236 1296
1237=item B<searchable-scrollback:> I<keysym> 1297=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1238 1298
1239Sets the hotkey that starts the incremental scrollback buffer search 1299This resource is deprecated and will be removed. Use a B<keysym> resource
1240(default: C<M-s>). 1300instead, e.g.:
1241 1301
1302 URxvt.keysym.M-s: searchable-scrollback:start
1303
1242=item B<urlLauncher>: I<string> 1304=item B<url-launcher>: I<string>
1243 1305
1244Specifies the program to be started with a URL argument. Used by the 1306Specifies the program to be started with a URL argument. Used by the
1245C<selection-popup> and C<matcher> perl extensions. 1307C<selection-popup> and C<matcher> perl extensions.
1246 1308
1247=item B<transient-for>: I<windowid> 1309=item B<transient-for>: I<windowid>
1251=item B<override-redirect>: I<boolean> 1313=item B<override-redirect>: I<boolean>
1252 1314
1253Compile I<frills>: Sets override-redirect for the terminal window, making 1315Compile I<frills>: Sets override-redirect for the terminal window, making
1254it almost invisible to window managers; option B<-override-redirect>. 1316it almost invisible to window managers; option B<-override-redirect>.
1255 1317
1318=item B<iso14755:> I<boolean>
1319
1320Turn on/off ISO 14755 (default enabled).
1321
1256=item B<iso14755_52:> I<boolean> 1322=item B<iso14755_52:> I<boolean>
1257 1323
1258Turn on/off ISO 14755 5.2 mode (default enabled). 1324Turn on/off ISO 14755 5.2 mode (default enabled).
1325
1326=back
1327
1328=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1329
1330=over 4
1331
1332=item B<-pixmap> I<file[;oplist]>
1333
1334=item B<backgroundPixmap:> I<file[;oplist]>
1335
1336Compile I<pixbuf>: Use the specified image file as the window's
1337background and also optionally specify a colon separated list of
1338operations to modify it. Note that you may need to quote the C<;>
1339character when using the command line option, as C<;> is usually a
1340metacharacter in shells. Supported operations are:
1341
1342=over 4
1343
1344=item B<WxH+X+Y>
1345
1346sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1347scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1348scale of 0 disables scaling.
1349
1350=item B<op=tile>
1351
1352enables tiling
1353
1354=item B<op=keep-aspect>
1355
1356maintain the image aspect ratio when scaling
1357
1358=item B<op=root-align>
1359
1360use the position of the terminal window relative to the root window as
1361the image offset, simulating a root window background
1362
1363=back
1364
1365The default scale and position setting is C<100x100+50+50>.
1366Alternatively, a predefined set of templates can be used to achieve
1367the most common setups:
1368
1369=over 4
1370
1371=item B<style=tiled>
1372
1373the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1374
1375=item B<style=aspect-stretched>
1376
1377the image is scaled to fill the whole window maintaining the aspect
1378ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1379
1380=item B<style=stretched>
1381
1382the image is scaled to fill the whole window. Equivalent to 100x100
1383
1384=item B<style=centered>
1385
1386the image is centered with no scaling. Equivalent to 0x0+50+50
1387
1388=item B<style=root-tiled>
1389
1390the image is tiled with no scaling and using 'root' positioning.
1391Equivalent to 0x0:op=tile:op=root-align
1392
1393=back
1394
1395If multiple templates are specified the last one wins. Note that a
1396template overrides all the scale, position and operations settings.
1397
1398If used in conjunction with pseudo-transparency, the specified pixmap
1399will be blended over the transparent background using alpha-blending.
1400
1401=item B<-tr>|B<+tr>
1402
1403=item B<transparent:> I<boolean>
1404
1405Turn on/off pseudo-transparency by using the root pixmap as background.
1406
1407B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1408will be removed in future versions.
1409
1410=item B<-tint> I<colour>
1411
1412=item B<tintColor:> I<colour>
1413
1414Tint the transparent background with the given colour. Note that a
1415black tint yields a completely black image while a white tint yields
1416the image unchanged.
1417
1418=item B<-sh> I<number>
1419
1420=item B<shading:> I<number>
1421
1422Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1423A value of 100 means no shading.
1424
1425=item B<-blr> I<HxV>
1426
1427=item B<blurRadius:> I<HxV>
1428
1429Apply gaussian blur with the specified radius to the transparent
1430background. If a single number is specified, the vertical and
1431horizontal radii are considered to be the same. Setting one of the
1432radii to 1 and the other to a large number creates interesting effects
1433on some backgrounds. The maximum radius value is 128. An horizontal or
1434vertical radius of 0 disables blurring.
1435
1436=item B<path:> I<path>
1437
1438Specify the colon-delimited search path for finding background image files.
1259 1439
1260=back 1440=back
1261 1441
1262=head1 THE SCROLLBAR 1442=head1 THE SCROLLBAR
1263 1443
1311window causes the value of the PRIMARY selection (or CLIPBOARD with the 1491window causes the value of the PRIMARY selection (or CLIPBOARD with the
1312B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1492B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1313 1493
1314Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1494Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1315inserted too. 1495inserted too.
1496
1497rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1498<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1499binding causes the value of the internal selection to be copied to the
1500CLIPBOARD selection, while the second binding causes the value of the
1501CLIPBOARD selection to be inserted.
1316 1502
1317=back 1503=back
1318 1504
1319=head1 CHANGING FONTS 1505=head1 CHANGING FONTS
1320 1506
1402B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1588B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1403it can be seen via the I<who(1)> command, and can accept messages. To 1589it can be seen via the I<who(1)> command, and can accept messages. To
1404allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1590allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1405on some systems or setgid to root or to some other group on others. 1591on some systems or setgid to root or to some other group on others.
1406 1592
1407=head1 COLORS AND GRAPHICS 1593=head1 COLOURS AND GRAPHICS
1408 1594
1409In addition to the default foreground and background colours, 1595In addition to the default foreground and background colours,
1410B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1596B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1411high-intensity bold/blink versions of the same). Here is a list of the 1597high-intensity (potentially bold/blink) versions of the same, and 72 (or
1412colours with their names. 1598240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1599cube plus a 8 (24) colour greyscale ramp.
1600
1601B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1602C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1603number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1604colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
160524-bit colour space. When indexing collisions happen, the nearest old colour in
1606the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1607use many similar 24-bit colours. It's typically not a problem in common
1608scenarios.
1609
1610Here is a list of the ANSI colours with their names.
1413 1611
1414=begin table 1612=begin table
1415 1613
1416 B<color0> (black) = Black 1614 B<color0> (black) = Black
1417 B<color1> (red) = Red3 1615 B<color1> (red) = Red3
1437It is also possible to specify the colour values of B<foreground>, 1635It is also possible to specify the colour values of B<foreground>,
1438B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1636B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1439a number 0-15, as a convenient shorthand to reference the colour name of 1637a number 0-15, as a convenient shorthand to reference the colour name of
1440color0-color15. 1638color0-color15.
1441 1639
1442In addition to the colours defined above, @@RXVT_NAME@@ offers an 1640The following text gives values for the standard 88 colour mode (and
1443additional 72 colours. The first 64 of those (with indices 16 to 79) 1641values for the 256 colour mode in parentheses).
1444consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144516>), followed by 8 additional shades of gray (with indices 80 to 87).
1446 1642
1643The RGB cube uses indices 16..79 (16..231) using the following formulas:
1644
1645 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1646 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1647
1648The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1649steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1650the RGB cube.
1651
1447Together, all those colours implement the 88 colour xterm colours. Only 1652Together, all those colours implement the 88 (256) colour xterm
1448the first 16 can be changed using resources currently, the rest can only 1653colours. Only the first 16 can be changed using resources currently, the
1449be changed via command sequences ("escape codes"). 1654rest can only be changed via command sequences ("escape codes").
1655
1656Applications are advised to use terminfo or command sequences to discover
1657number and RGB values of all colours (yes, you can query this...).
1450 1658
1451Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1659Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1452always swapping the foreground/background colours. This is in contrast to 1660always swapping the foreground/background colours. This is in contrast to
1453I<xterm>(1) where the colours are only swapped if they have not otherwise 1661I<xterm>(1) where the colours are only swapped if they have not otherwise
1454been specified. For example, 1662been specified. For example,
1455 1663
1456=over 4
1457
1458=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1664 @@RXVT_NAME@@ -fg Black -bg White -rv
1459 1665
1460would yield White on Black, while on I<xterm>(1) it would yield Black 1666would yield White on Black, while on I<xterm>(1) it would yield Black on
1461on White. 1667White.
1462
1463=back
1464 1668
1465=head2 ALPHA CHANNEL SUPPORT 1669=head2 ALPHA CHANNEL SUPPORT
1466 1670
1467If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1671If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1468their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1672their act together, rxvt-unicode will do its own alpha channel management:
1469(recommended, but B<MUST> have 4 digits/component) colour specifications, 1673
1470in addition to the ones provided by X, where the additional A component 1674You can prefix any colour with an opaqueness percentage enclosed in
1675brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1676(0-100) that specifies the opacity of the colour, where C<0> is completely
1677transparent and C<100> is completely opaque. For example, C<[50]red> is a
1678half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1679is the recommended format to specify transparency values, and works with
1680all ways to specify a colour.
1681
1682For complete control, rxvt-unicode also supports
1683C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1684specifications, where the additional C<aaaa> component specifies opacity
1471specifies opacity (alpha) values. The minimum value of C<0> is completely 1685(alpha) values. The minimum value of C<0000> is completely transparent,
1472transparent). You can also prefix any color with C<[percent]>, where 1686while C<ffff> is completely opaque). The two example colours from
1473C<percent> is a decimal percentage (0-100) that specifies the opacity of 1687earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1474the color, where C<0> is completely transparent and C<100> is completelxy 1688C<rgba:0000/ff00/0000/f332>.
1475opaque.
1476 1689
1477You probably need to specify B<"-depth 32">, too, and have the luck that 1690You probably need to specify B<"-depth 32">, too, to force a visual with
1478your X-server uses ARGB pixel layout, as X is far from just supporting 1691alpha channels, and have the luck that your X-server uses ARGB pixel
1479ARGB visuals out of the box, and rxvt-unicode just fudges around. 1692layout, as X is far from just supporting ARGB visuals out of the box, and
1693rxvt-unicode just fudges around.
1480 1694
1481For example, the following selects an almost completely transparent red 1695For example, the following selects an almost completely transparent black
1482background, and an almost opaque pink foreground: 1696background, and an almost opaque pink foreground:
1483 1697
1484 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1698 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1485 1699
1486I<Please note that transparency of any kind if completely unsupported by 1700When not using a background image, then the interpretation of the
1487the author. Don't bug him with installation questions!> 1701alpha channel is up to your compositing manager (most interpret it as
1702transparency of course).
1703
1704When using a background pixmap or pseudo-transparency, then the background
1705colour will always behave as if it were completely transparent (so the
1706background image shows instead), regardless of how it was specified, while
1707other colours will either be transparent as specified (the background
1708image will show through) on servers supporting the RENDER extension, or
1709fully opaque on servers not supporting the RENDER EXTENSION.
1710
1711Please note that due to bugs in Xft, specifying alpha values might result
1712in garbage being displayed when the X-server does not support the RENDER
1713extension.
1488 1714
1489=head1 ENVIRONMENT 1715=head1 ENVIRONMENT
1490 1716
1491B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1717B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492 1718
1526C<--with-terminfo=PATH>. 1752C<--with-terminfo=PATH>.
1527 1753
1528=item B<DISPLAY> 1754=item B<DISPLAY>
1529 1755
1530Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1756Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1531display in its child processes. 1757display in its child processes if C<-display> isn't used to override. It
1758defaults to C<:0> if it doesn't exist.
1532 1759
1533=item B<SHELL> 1760=item B<SHELL>
1534 1761
1535The shell to be used for command execution, defaults to C</bin/sh>. 1762The shell to be used for command execution, defaults to C</bin/sh>.
1536 1763
1537=item B<RXVT_SOCKET> 1764=item B<RXVT_SOCKET> [I<sic>]
1538 1765
1539The unix domain socket path used by @@RXVT_NAME@@c(1) and 1766The unix domain socket path used by @@RXVT_NAME@@c(1) and
1540@@RXVT_NAME@@d(1). 1767@@RXVT_NAME@@d(1).
1541 1768
1542Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1769Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1770
1771=item B<URXVT_PERL_LIB>
1772
1773Additional F<:>-separated library search path for perl extensions. Will be
1774searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1775directory.
1776
1777=item B<URXVT_PERL_VERBOSITY>
1778
1779See L<@@RXVT_NAME@@perl>(3).
1543 1780
1544=item B<HOME> 1781=item B<HOME>
1545 1782
1546Used to locate the default directory for the unix domain socket for 1783Used to locate the default directory for the unix domain socket for
1547daemon communications and to locate various resource files (such as 1784daemon communications and to locate various resource files (such as
1548C<.Xdefaults>) 1785C<.Xdefaults>)
1549 1786
1550=item B<XAPPLRESDIR> 1787=item B<XAPPLRESDIR>
1551 1788
1552Directory where various X resource files are being located. 1789Directory where application-specific X resource files are located.
1553 1790
1554=item B<XENVIRONMENT> 1791=item B<XENVIRONMENT>
1555 1792
1556If set and accessible, gives the name of a X resource file to be loaded by 1793If set and accessible, gives the name of a X resource file to be loaded by
1557@@RXVT_NAME@@. 1794@@RXVT_NAME@@.
1562 1799
1563=over 4 1800=over 4
1564 1801
1565=item B</usr/lib/X11/rgb.txt> 1802=item B</usr/lib/X11/rgb.txt>
1566 1803
1567Color names. 1804Colour names.
1568 1805
1569=back 1806=back
1570 1807
1571=head1 SEE ALSO 1808=head1 SEE ALSO
1572 1809
1810@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1573@@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) 1811@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1574 1812
1575=head1 CURRENT PROJECT COORDINATOR 1813=head1 CURRENT PROJECT COORDINATOR
1576 1814
1577=over 4 1815=over 4
1578 1816
1579=item Project Coordinator 1817=item Project Coordinator
1580 1818
1581Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1819Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1582 1820
1583L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1821L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1584 1822
1585=back 1823=back
1586 1824
1590 1828
1591=item John Bovey 1829=item John Bovey
1592 1830
1593University of Kent, 1992, wrote the original Xvt. 1831University of Kent, 1992, wrote the original Xvt.
1594 1832
1595=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1833=item Rob Nation <nation@rocket.sanders.lockheed.com>
1596 1834
1597very heavily modified Xvt and came up with Rxvt 1835very heavily modified Xvt and came up with Rxvt
1598 1836
1599=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1837=item Angelo Haritsis <ah@doc.ic.ac.uk>
1600 1838
1601wrote the Greek Keyboard Input (no longer in code) 1839wrote the Greek Keyboard Input (no longer in code)
1602 1840
1603=item mj olesen L<< <olesen@me.QueensU.CA> >> 1841=item mj olesen <olesen@me.QueensU.CA>
1604 1842
1605Wrote the menu system. 1843Wrote the menu system.
1606 1844
1607Project Coordinator (changes.txt 2.11 to 2.21) 1845Project Coordinator (changes.txt 2.11 to 2.21)
1608 1846
1609=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1847=item Oezguer Kesim <kesim@math.fu-berlin.de>
1610 1848
1611Project Coordinator (changes.txt 2.21a to 2.4.5) 1849Project Coordinator (changes.txt 2.21a to 2.4.5)
1612 1850
1613=item Geoff Wing L<< <gcw@pobox.com> >> 1851=item Geoff Wing <gcw@pobox.com>
1614 1852
1615Rewrote screen display and text selection routines. 1853Rewrote screen display and text selection routines.
1616 1854
1617Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1855Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1618 1856
1619=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1857=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1620 1858
1621Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1859Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1622extension, random hacks, numerous bugfixes and extensions. 1860extension, random hacks, numerous bugfixes and extensions.
1623 1861
1624Project Coordinator (Changes 1.0 -) 1862Project Coordinator (Changes 1.0 -)
1625 1863
1626=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1864=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1627 1865
1628Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1866pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1629 1867
1630=back 1868=back
1631 1869

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines