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.152 by root, Wed Dec 12 19:56:37 2007 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines