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.148 by ayin, Sat Nov 24 17:07:46 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

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 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>.
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
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devanagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very user friendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
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<xft>: 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
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
107=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
120 128
121Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off illusion of a transparent window background; resource B<transparent>.
122 130
123B<-ip> is still accepted as an obsolete alias but will be removed in 131B<-ip> is still accepted as an obsolete alias but will be removed in
124future versions. 132future versions.
125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
128 133
129=item B<-fade> I<number> 134=item B<-fade> I<number>
130 135
131Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
132fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
144non-tiled backgrounds, currently. See also the B<-sh> option that can be 149non-tiled backgrounds, currently. See also the B<-sh> option that can be
145used to brighten or darken the image in addition to tinting it. 150used to brighten or darken the image in addition to tinting it.
146Please note that certain tint colours can be applied on the server-side, 151Please note that certain tint colours can be applied on the server-side,
147thus yielding performance gain of two orders of magnitude. These colours are: 152thus yielding performance gain of two orders of magnitude. These colours are:
148blue, red, green, cyan, magenta, yellow, and those close to them. Also 153blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource 154pure black and pure white colours essentially mean no tinting; resource
150I<tintColor>. Example: 155I<tintColor>. Example:
151 156
152 @@RXVT_NAME@@ -tr -tint blue -sh 40 157 @@RXVT_NAME@@ -tr -tint blue -sh 40
153 158
154=item B<-sh> I<number> 159=item B<-sh> I<number>
160=item B<-blt> I<string> 165=item B<-blt> I<string>
161 166
162Specify background blending type. If background pixmap is specified 167Specify background blending type. If background pixmap is specified
163at the same time as transparency - such pixmap will be blended over 168at the same time as transparency - such pixmap will be blended over
164transparency image, using method specified. Supported values are : 169transparency image, using method specified. Supported values are :
165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 170B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 171B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 172B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168alpha-blending. Compile I<afterimage>; resource I<blendType>. 173alpha-blending. Compile I<afterimage>; resource I<blendType>.
169 174
170=item B<-blr> I<HxV> 175=item B<-blr> I<HxV>
171 176
172Apply Gaussian Blur with the specified radii to the transparent 177Apply Gaussian Blur with the specified radii to the transparent
173background image. If single number is specified - both vertical and 178background image. If single number is specified - both vertical and
174horizontal radii are considered to be the same. Setting one of the 179horizontal radii are considered to be the same. Setting one of the
175radii to 1 and another to a large number creates interesting effects 180radii to 1 and another to a large number creates interesting effects
176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 181on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
177resource I<blurRadius>. 182resource I<blurRadius>.
178 183
184=item B<-icon> I<file>
185
186Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
187is used by many window managers, taskbars and pagers to represent the
188application window; resource I<iconFile>.
189
179=item B<-bg> I<colour> 190=item B<-bg> I<colour>
180 191
181Window background colour; resource B<background>. 192Window background colour; resource B<background>.
182 193
183=item B<-fg> I<colour> 194=item B<-fg> I<colour>
184 195
185Window foreground colour; resource B<foreground>. 196Window foreground colour; resource B<foreground>.
186 197
187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
188 199
189Compile I<afterimage>: Specify image file for the background and also 200Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
190optionally specify its scaling with a geometry string. Note you may need to 201optionally specify its scaling with a geometry string. Note you may need to
191add quotes to avoid special shell interpretation of the C<;> in the 202add quotes to avoid special shell interpretation of the C<;> in the
192command-line; for more details see resource B<backgroundPixmap>. 203command-line; for more details see resource B<backgroundPixmap>.
193 204
194=item B<-cr> I<colour> 205=item B<-cr> I<colour>
242italic> >> characters are to be printed. See resource B<boldItalicFont> 253italic> >> characters are to be printed. See resource B<boldItalicFont>
243for details. 254for details.
244 255
245=item B<-is>|B<+is> 256=item B<-is>|B<+is>
246 257
247Compile I<font-styles>: Bold/Italic font styles imply high intensity 258Compile I<font-styles>: Bold/Blink font styles imply high intensity
248foreground/background (default). See resource B<intensityStyles> for 259foreground/background (default). See resource B<intensityStyles> for
249details. 260details.
250 261
251=item B<-name> I<name> 262=item B<-name> I<name>
252 263
270 281
271=item B<-sb>|B<+sb> 282=item B<-sb>|B<+sb>
272 283
273Turn on/off scrollbar; resource B<scrollBar>. 284Turn on/off scrollbar; resource B<scrollBar>.
274 285
286=item B<-sr>|B<+sr>
287
288Put scrollbar on right/left; resource B<scrollBar_right>.
289
290=item B<-st>|B<+st>
291
292Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
293resource B<scrollBar_floating>.
294
275=item B<-si>|B<+si> 295=item B<-si>|B<+si>
276 296
277Turn on/off scroll-to-bottom on TTY output inhibit; resource 297Turn on/off scroll-to-bottom on TTY output inhibit; resource
278B<scrollTtyOutput> has opposite effect. 298B<scrollTtyOutput> has opposite effect.
279 299
285=item B<-sw>|B<+sw> 305=item B<-sw>|B<+sw>
286 306
287Turn on/off scrolling with the scrollback buffer as new lines appear. 307Turn on/off scrolling with the scrollback buffer as new lines appear.
288This only takes effect if B<-si> is also given; resource 308This only takes effect if B<-si> is also given; resource
289B<scrollWithBuffer>. 309B<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 310
300=item B<-ptab>|B<+ptab> 311=item B<-ptab>|B<+ptab>
301 312
302If enabled (default), "Horizontal Tab" characters are being stored as 313If enabled (default), "Horizontal Tab" characters are being stored as
303actual wide characters in the screen buffer, which makes it possible to 314actual wide characters in the screen buffer, which makes it possible to
307 318
308=item B<-bc>|B<+bc> 319=item B<-bc>|B<+bc>
309 320
310Blink the cursor; resource B<cursorBlink>. 321Blink the cursor; resource B<cursorBlink>.
311 322
323=item B<-uc>|B<+uc>
324
325Make the cursor underlined; resource B<cursorUnderline>.
326
312=item B<-iconic> 327=item B<-iconic>
313 328
314Start iconified, if the window manager supports that option. 329Start iconified, if the window manager supports that option.
315Alternative form is B<-ic>. 330Alternative form is B<-ic>.
316 331
332 347
333=item B<-bl> 348=item B<-bl>
334 349
335Compile I<frills>: Set MWM hints to request a borderless window, i.e. 350Compile 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 351if honoured by the WM, the rxvt-unicode window will not have window
337decorations; resource B<borderLess>. 352decorations; resource B<borderLess>. If the window manager does not
353support MWM hints (e.g. kwin), enables override-redirect mode.
338 354
339=item B<-override-redirect> 355=item B<-override-redirect>
340 356
341Compile I<frills>: Sets override-redirect on the window; resource 357Compile I<frills>: Sets override-redirect on the window; resource
342B<override-redirect>. 358B<override-redirect>.
351=item B<-lsp> I<number> 367=item B<-lsp> I<number>
352 368
353Compile I<frills>: Lines (pixel height) to insert between each row of 369Compile I<frills>: Lines (pixel height) to insert between each row of
354the display. Useful to work around font rendering problems; resource 370the display. Useful to work around font rendering problems; resource
355B<lineSpace>. 371B<lineSpace>.
372
373=item B<-letsp> I<number>
374
375Compile I<frills>: Amount to adjust the computed character width by
376to control overall letter spacing. Negative values will tighten up the
377letter spacing, positive values will space letters out more. Useful to
378work around odd font metrics; resource B<letterSpace>.
356 379
357=item B<-tn> I<termname> 380=item B<-tn> I<termname>
358 381
359This option specifies the name of the terminal type to be set in the 382This option specifies the name of the terminal type to be set in the
360B<TERM> environment variable. This terminal type must exist in the 383B<TERM> environment variable. This terminal type must exist in the
415 438
416=item B<-tcw> 439=item B<-tcw>
417 440
418Change the meaning of triple-click selection with the left mouse 441Change the meaning of triple-click selection with the left mouse
419button. Only effective when the original (non-perl) selection code is 442button. Only effective when the original (non-perl) selection code is
420in-use. Instead of selecting a full line it will extend the selection the 443in-use. Instead of selecting a full line it will extend the selection to
421end of the logical line only. resource B<tripleclickwords>. 444the end of the logical line only. resource B<tripleclickwords>.
422 445
423=item B<-insecure> 446=item B<-insecure>
424 447
425Enable "insecure" mode, which currently enables most of the escape 448Enable "insecure" mode, which currently enables most of the escape
426sequences that echo strings. See the resource B<insecure> for more 449sequences that echo strings. See the resource B<insecure> for more
446 469
447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 470Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448will not immediately destroy its window when the program executed within 471will 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 472it exits. Instead, it will wait till it is being killed or closed by the
450user; resource B<hold>. 473user; resource B<hold>.
474
475=item B<-cd> I<path>
476
477Sets the working directory for the shell (or the command specified via
478B<-e>). The I<path> must be an absolute path and it must exist for
479@@RXVT_NAME@@ to start; resource B<chdir>.
451 480
452=item B<-xrm> I<string> 481=item B<-xrm> I<string>
453 482
454Works like the X Toolkit option of the same name, by adding the I<string> 483Works 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 484as if it were specified in a resource file. Resource values specified this
503If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 532If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
504entries and will not tinker with pty/tty permissions - you have to do that 533entries and will not tinker with pty/tty permissions - you have to do that
505yourself if you want that. 534yourself if you want that.
506 535
507As an extremely special case, specifying C<-1> will completely suppress 536As an extremely special case, specifying C<-1> will completely suppress
508pty/tty operations. 537pty/tty operations, which is probably only useful in conjunction with some
538perl extension that manages the terminal.
509 539
510Here is a example in perl that illustrates how this option can be used (a 540Here is a example in perl that illustrates how this option can be used (a
511longer example is in F<doc/pty-fd>): 541longer example is in F<doc/pty-fd>):
512 542
513 use IO::Pty; 543 use IO::Pty;
527Comma-separated list of perl extension scripts to use (or not to use) in 557Comma-separated list of perl extension scripts to use (or not to use) in
528this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
529 559
530=back 560=back
531 561
532=head1 RESOURCES (available also as long-options) 562=head1 RESOURCES
533 563
534Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 564Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535options) compiled into your version. 565options) compiled into your version. All resources are also available as
566long-options.
536 567
537You can set and change the resources using X11 tools like B<xrdb>. Many 568You can set and change the resources using X11 tools like B<xrdb>. Many
538distribution do also load settings from the B<~/.Xresources> file when X 569distribution do also load settings from the B<~/.Xresources> file when X
539starts. @@RXVT_NAME@@ will consult the following files/resources in order, 570starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540with later settings overwriting earlier ones: 571with later settings overwriting earlier ones:
562=item B<depth:> I<bitdepth> 593=item B<depth:> I<bitdepth>
563 594
564Compile I<xft>: Attempt to find a visual with the given bit depth; 595Compile I<xft>: Attempt to find a visual with the given bit depth;
565option B<-depth>. 596option B<-depth>.
566 597
598=item B<buffered:> I<boolean>
599
600Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
601On some card/driver combination enabling it slightly decreases
602performance, on most it greatly helps it. The slowdown is small, so it
603should normally be enabled.
604
567=item B<geometry:> I<geom> 605=item B<geometry:> I<geom>
568 606
569Create the window with the specified X window geometry [default 80x24]; 607Create the window with the specified X window geometry [default 80x24];
570option B<-geometry>. 608option B<-geometry>.
571 609
584Use the specified colour for the colour value I<n>, where 0-7 622Use the specified colour for the colour value I<n>, where 0-7
585corresponds to low-intensity (normal) colours and 8-15 corresponds to 623corresponds to low-intensity (normal) colours and 8-15 corresponds to
586high-intensity (bold = bright foreground, blink = bright background) 624high-intensity (bold = bright foreground, blink = bright background)
587colours. The canonical names are as follows: 0=black, 1=red, 2=green, 625colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5883=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6263=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
589names used are listed in the B<COLORS AND GRAPHICS> section. 627names used are listed in the B<COLOURS AND GRAPHICS> section.
590 628
591Colours higher than 15 cannot be set using resources (yet), but can be 629Colours higher than 15 cannot be set using resources (yet), but can be
592changed using an escape command (see @@RXVT_NAME@@(7)). 630changed using an escape command (see @@RXVT_NAME@@(7)).
593 631
594Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 632Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
605=item B<colorUL:> I<colour> 643=item B<colorUL:> I<colour>
606 644
607Use the specified colour to display underlined characters when the 645Use the specified colour to display underlined characters when the
608foreground colour is the default. 646foreground colour is the default.
609 647
610=item B<colorRV:> I<colour>
611
612Use the specified colour as the background for reverse video characters
613when OPTION_HC is disabled (--disable-frills).
614
615=item B<underlineColor:> I<colour> 648=item B<underlineColor:> I<colour>
616 649
617If set, use the specified colour as the colour for the underline 650If set, use the specified colour as the colour for the underline
618itself. If unset, use the foreground colour. 651itself. If unset, use the foreground colour.
652
653=item B<highlightColor:> I<colour>
654
655If set, use the specified colour as the background for highlighted
656characters. If unset, use reverse video.
657
658=item B<highlightTextColor:> I<colour>
659
660If set and highlightColor is set, use the specified colour as the
661foreground for highlighted characters.
619 662
620=item B<cursorColor:> I<colour> 663=item B<cursorColor:> I<colour>
621 664
622Use the specified colour for the cursor. The default is to use the 665Use the specified colour for the cursor. The default is to use the
623foreground colour; option B<-cr>. 666foreground colour; option B<-cr>.
630 673
631=item B<reverseVideo:> I<boolean> 674=item B<reverseVideo:> I<boolean>
632 675
633B<True>: simulate reverse video by foreground and background colours; 676B<True>: simulate reverse video by foreground and background colours;
634option B<-rv>. B<False>: regular screen colours [default]; option 677option B<-rv>. B<False>: regular screen colours [default]; option
635B<+rv>. See note in B<COLORS AND GRAPHICS> section. 678B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636 679
637=item B<jumpScroll:> I<boolean> 680=item B<jumpScroll:> I<boolean>
638 681
639B<True>: specify that jump scrolling should be used. When receiving lots 682B<True>: specify that jump scrolling should be used. When receiving lots
640of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 683of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
661Turn on/off illusion of a transparent window background. 704Turn on/off illusion of a transparent window background.
662 705
663B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 706B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664future versions. 707future versions.
665 708
666I<Please address all transparency related issues to Sasha Vasko at
667sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
668
669=item B<fading:> I<number> 709=item B<fading:> I<number>
670 710
671Fade the text by the given percentage when focus is lost; option B<-fade>. 711Fade the text by the given percentage when focus is lost; option B<-fade>.
672 712
673=item B<fadeColor:> I<colour> 713=item B<fadeColor:> I<colour>
689 729
690Specify background blending type; option B<-blt>. 730Specify background blending type; option B<-blt>.
691 731
692=item B<blurRadius:> I<number> 732=item B<blurRadius:> I<number>
693 733
694Apply Gaussian Blurr with the specified radius to the transparent 734Apply gaussian blur with the specified radius to the transparent
695background image; option B<-blr>. 735background image; option B<-blr>.
736
737=item B<iconFile:> I<file>
738
739Set the application icon pixmap; option B<-icon>.
696 740
697=item B<scrollColor:> I<colour> 741=item B<scrollColor:> I<colour>
698 742
699Use the specified colour for the scrollbar [default #B2B2B2]. 743Use the specified colour for the scrollbar [default #B2B2B2].
700 744
710 754
711=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
712 756
713Use the specified image file for the background and also 757Use the specified image file for the background and also
714optionally specify its scaling with a geometry string B<WxH+X+Y>, 758optionally specify its scaling with a geometry string B<WxH+X+Y>,
715(default C<0x0+50+50>) in which B<"W" / "H"> specify the 759(default C<100x100+50+50>) in which B<"W" / "H"> specify the
716horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 760horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
717centre (percent). A scale of 0 displays the image with tiling. A scale 761centre (percent). A scale of 0 displays the image with tiling.
718of 1 displays the image without any scaling. A scale of 2 to 9 specifies 762The maximum permitted scale is 1000.
719an integer number of images in that direction. No image will be magnified
720beyond 10 times its original size. The maximum permitted scale is 1000.
721Additional operations can be specified after colon B<:op1:op2...>. 763Additional operations can be specified after colon B<:op1:op2...>.
722Supported operations are: 764Supported operations are:
723 765
724 tile force background image to be tiled and not scaled. Equivalent to 0x0, 766 tile force background image to be tiled and not scaled. Equivalent to 0x0
725 propscale will scale image keeping proportions, 767 propscale will scale image keeping proportions
726 auto will scale image to match window size. Equivalent to 100x100; 768 auto will scale image to match window size. Equivalent to 100x100
727 hscale will scale image horizontally to the window size; 769 hscale will scale image horizontally to the window size
728 vscale will scale image vertically to the window size; 770 vscale will scale image vertically to the window size
729 scale will scale image to match window size; 771 scale will scale image to match window size
730 root will tile image as if it was a root window background, auto-adjusting 772 root will tile image as if it was a root window background, auto-adjusting
731 whenever terminal window moves. 773 whenever terminal window moves
732 774
733If used in conjunction with B<-tr> option, the specified pixmap will be 775If used in conjunction with B<-tr> option, the specified pixmap will be
734blended over transparency image using either alpha-blending, or any 776blended over transparency image using alpha-blending. If I<afterimage>
735other blending type, specified with B<-blt "type"> option. 777support has been compiled in it is possible to choose other blending
778types with B<-blt "type"> option.
736 779
737=item B<path:> I<path> 780=item B<path:> I<path>
738 781
739Specify the colon-delimited search path for finding background image files. 782Specify the colon-delimited search path for finding background image files.
740 783
767it is named first) and thus defines the character cell grid to be 9 pixels 810it is named first) and thus defines the character cell grid to be 9 pixels
768wide and 15 pixels high. 811wide and 15 pixels high.
769 812
770The second font is just used to add additional unicode characters not in 813The second font is just used to add additional unicode characters not in
771the base font, likewise the third, which is unfortunately non-bold, but 814the base font, likewise the third, which is unfortunately non-bold, but
772the bold version of the font does contain less characters, so this is a 815the bold version of the font does contain fewer characters, so this is a
773useful supplement. 816useful supplement.
774 817
775The third font is an Xft font with aliasing turned off, and the characters 818The third font is an Xft font with aliasing turned off, and the characters
776are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 819are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
777contains other characters, but we are not interested in them. 820contains other characters, but we are not interested in them.
801text font will being used for the given style. 844text font will being used for the given style.
802 845
803=item B<intensityStyles:> I<boolean> 846=item B<intensityStyles:> I<boolean>
804 847
805When font styles are not enabled, or this option is enabled (B<True>, 848When font styles are not enabled, or this option is enabled (B<True>,
806option B<-is>, the default), bold and italic font styles imply high 849option B<-is>, the default), bold/blink font styles imply high
807intensity foreground/background colours. Disabling this option (B<False>, 850intensity foreground/background colours. Disabling this option (B<False>,
808option B<+is>) disables this behaviour, the high intensity colours are not 851option B<+is>) disables this behaviour, the high intensity colours are not
809reachable. 852reachable.
810 853
811=item B<selectstyle:> I<mode>
812
813Set mouse selection style to B<old> which is 2.20, B<oldword> which
814is xterm style with 2.20 old word selection, or anything else which
815gives xterm style selection. Only effective when the original (non-perl)
816selection code is in use.
817
818=item B<scrollstyle:> I<mode>
819
820Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
821the author's favourite.
822
823=item B<title:> I<string> 854=item B<title:> I<string>
824 855
825Set window title string, the default title is the command-line 856Set window title string, the default title is the command-line
826specified after the B<-e> option, if any, otherwise the application 857specified after the B<-e> option, if any, otherwise the application
827name; option B<-title>. 858name; option B<-title>.
840=item B<urgentOnBell:> I<boolean> 871=item B<urgentOnBell:> I<boolean>
841 872
842B<True>: set the urgency hint for the wm on receipt of a bell character. 873B<True>: set the urgency hint for the wm on receipt of a bell character.
843B<False>: do not set the urgency hint [default]. 874B<False>: do not set the urgency hint [default].
844 875
876@@RXVT_NAME@@ resets the urgency hint on every focus change.
877
845=item B<visualBell:> I<boolean> 878=item B<visualBell:> I<boolean>
846 879
847B<True>: use visual bell on receipt of a bell character; option B<-vb>. 880B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848B<False>: no visual bell [default]; option B<+vb>. 881B<False>: no visual bell [default]; option B<+vb>.
849 882
871 904
872 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 905 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873 906
874This creates a new file in your home directory with the screen contents 907This creates a new file in your home directory with the screen contents
875every time you hit C<Print>. 908every time you hit C<Print>.
909
910=item B<scrollstyle:> I<mode>
911
912Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
913the author's favourite.
876 914
877=item B<scrollBar:> I<boolean> 915=item B<scrollBar:> I<boolean>
878 916
879B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 917B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880disable the scrollbar; option B<+sb>. 918disable the scrollbar; option B<+sb>.
968=item B<cursorBlink:> I<boolean> 1006=item B<cursorBlink:> I<boolean>
969 1007
970B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1008B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971option B<-bc>. 1009option B<-bc>.
972 1010
1011=item B<cursorUnderline:> I<boolean>
1012
1013B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1014option B<-uc>.
1015
973=item B<pointerBlank:> I<boolean> 1016=item B<pointerBlank:> I<boolean>
974 1017
975B<True>: blank the pointer when a key is pressed or after a set number 1018B<True>: blank the pointer when a key is pressed or after a set number
976of seconds of inactivity. B<False>: the pointer is always visible 1019of seconds of inactivity. B<False>: the pointer is always visible
977[default]. 1020[default].
990large number (e.g. C<987654321>) to effectively disable the timeout. 1033large number (e.g. C<987654321>) to effectively disable the timeout.
991 1034
992=item B<backspacekey:> I<string> 1035=item B<backspacekey:> I<string>
993 1036
994The string to send when the backspace key is pressed. If set to B<DEC> 1037The string to send when the backspace key is pressed. If set to B<DEC>
995or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1038or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
996(code 8) - which can be reversed with the appropriate DEC private mode 1039(code 8) - which can be reversed with the appropriate DEC private mode
997escape sequence. 1040escape sequence.
998 1041
999=item B<deletekey:> I<string> 1042=item B<deletekey:> I<string>
1000 1043
1079 1122
1080=item B<secondaryScroll:> I<boolean> 1123=item B<secondaryScroll:> I<boolean>
1081 1124
1082Turn on/off secondary screen scroll (default enabled). If this 1125Turn on/off secondary screen scroll (default enabled). If this
1083option is enabled, scrolls on the secondary screen will change the 1126option is enabled, scrolls on the secondary screen will change the
1084scrollback buffer and switching to/from the secondary screen will 1127scrollback buffer and, when secondaryScreen is off, switching
1085instead scroll the screen up. 1128to/from the secondary screen will instead scroll the screen up.
1086 1129
1087=item B<hold>: I<boolean> 1130=item B<hold>: I<boolean>
1088 1131
1089Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1132Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090will not immediately destroy its window when the program executed within 1133will not immediately destroy its window when the program executed within
1091it exits. Instead, it will wait till it is being killed or closed by the 1134it exits. Instead, it will wait till it is being killed or closed by the
1092user. 1135user.
1136
1137=item B<chdir>: I<path>
1138
1139Sets the working directory for the shell (or the command specified via
1140B<-e>). The I<path> must be an absolute path and it must exist for
1141@@RXVT_NAME@@ to start. If it isn't specified then the current working
1142directory will be used; option B<-cd>.
1093 1143
1094=item B<keysym.>I<sym>: I<string> 1144=item B<keysym.>I<sym>: I<string>
1095 1145
1096Compile I<frills>: Associate I<string> with keysym I<sym>. The 1146Compile I<frills>: Associate I<string> with keysym I<sym>. The
1097intervening resource name B<keysym.> cannot be omitted. 1147intervening resource name B<keysym.> cannot be omitted.
1112omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1162omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1113keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1163keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1114performed in an exact manner; however, the closest match is assured. 1164performed in an exact manner; however, the closest match is assured.
1115 1165
1116I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1117number), see RESOURCES in C<man 7 X> for futher details. 1167number), see RESOURCES in C<man 7 X> for further details.
1118 1168
1119You can define a range of keysyms in one shot by providing a I<string> 1169You can define a range of keysyms in one shot by providing a I<string>
1120with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1121should be a character not used by the strings. 1171should be a character not used by the strings.
1122 1172
1136when Control-Meta-c is being pressed": 1186when Control-Meta-c is being pressed":
1137 1187
1138 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1188 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139 1189
1140If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1190If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1141is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1191is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1142manpage. For example, the F<selection> extension (activated via 1192manpage. For example, the F<selection> extension (activated via
1143C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1193C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144 1194
1145 URxvt.keysym.M-C-c: perl:selection:rot13 1195 URxvt.keysym.M-C-c: perl:selection:rot13
1146 1196
1147Due the the large number of modifier combinations, a defined key mapping 1197Due the the large number of modifier combinations, a defined key mapping
1148will match if at I<at least> the specified identifiers are being set, and 1198will match if I<at least> the specified identifiers are being set, and
1149no other key mappings with those and more bits are being defined. That 1199no other key mappings with those and more bits are being defined. That
1150means that defining a key map for C<a> will automatically provide 1200means that defining a key map for C<a> will automatically provide
1151definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1201definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1152mappings themselves. 1202mappings themselves.
1153 1203
1204all instances, while B<perl-ext> is used for specific instances. 1254all instances, while B<perl-ext> is used for specific instances.
1205 1255
1206=item B<perl-eval>: I<string> 1256=item B<perl-eval>: I<string>
1207 1257
1208Perl code to be evaluated when all extensions have been registered. See 1258Perl code to be evaluated when all extensions have been registered. See
1209the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1259the @@RXVT_NAME@@perl(3) manpage.
1210will be ignored when running setuid/setgid.
1211 1260
1212=item B<perl-lib>: I<path> 1261=item B<perl-lib>: I<path>
1213 1262
1214Colon-separated list of additional directories that hold extension 1263Colon-separated list of additional directories that hold extension
1215scripts. When looking for extensions specified by the C<perl> resource, 1264scripts. When looking for extensions specified by the C<perl> resource,
1216@@RXVT_NAME@@ will first look in these directories and then in 1265@@RXVT_NAME@@ will first look in these directories and then in
1217F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1266F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218will be ignored when running setuid/setgid.
1219 1267
1220See the @@RXVT_NAME@@perl(3) manpage. 1268See the @@RXVT_NAME@@perl(3) manpage.
1221 1269
1222=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1270=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223 1271
1245 1293
1246=item B<override-redirect>: I<boolean> 1294=item B<override-redirect>: I<boolean>
1247 1295
1248Compile I<frills>: Sets override-redirect for the terminal window, making 1296Compile I<frills>: Sets override-redirect for the terminal window, making
1249it almost invisible to window managers; option B<-override-redirect>. 1297it almost invisible to window managers; option B<-override-redirect>.
1298
1299=item B<iso14755:> I<boolean>
1300
1301Turn on/off ISO 14755 (default enabled).
1250 1302
1251=item B<iso14755_52:> I<boolean> 1303=item B<iso14755_52:> I<boolean>
1252 1304
1253Turn on/off ISO 14755 5.2 mode (default enabled). 1305Turn on/off ISO 14755 5.2 mode (default enabled).
1254 1306
1397B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1449B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1398it can be seen via the I<who(1)> command, and can accept messages. To 1450it can be seen via the I<who(1)> command, and can accept messages. To
1399allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1451allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1400on some systems or setgid to root or to some other group on others. 1452on some systems or setgid to root or to some other group on others.
1401 1453
1402=head1 COLORS AND GRAPHICS 1454=head1 COLOURS AND GRAPHICS
1403 1455
1404In addition to the default foreground and background colours, 1456In addition to the default foreground and background colours,
1405B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1457B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1406high-intensity bold/blink versions of the same). Here is a list of the 1458high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407colours with their names. 1459240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1460cube plus a 8 (24) colour greyscale ramp.
1461
1462Here is a list of the ANSI colours with their names.
1408 1463
1409=begin table 1464=begin table
1410 1465
1411 B<color0> (black) = Black 1466 B<color0> (black) = Black
1412 B<color1> (red) = Red3 1467 B<color1> (red) = Red3
1432It is also possible to specify the colour values of B<foreground>, 1487It is also possible to specify the colour values of B<foreground>,
1433B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1488B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1434a number 0-15, as a convenient shorthand to reference the colour name of 1489a number 0-15, as a convenient shorthand to reference the colour name of
1435color0-color15. 1490color0-color15.
1436 1491
1437In addition to the colours defined above, @@RXVT_NAME@@ offers an 1492The following text gives values for the standard 88 colour mode (and
1438additional 72 colours. The first 64 of those (with indices 16 to 79) 1493values for the 256 colour mode in parentheses).
1439consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144016>), followed by 8 additional shades of gray (with indices 80 to 87).
1441 1494
1495The RGB cube uses indices 16..79 (16..231) using the following formulas:
1496
1497 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1498 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1499
1500The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1501steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1502the RGB cube.
1503
1442Together, all those colours implement the 88 colour xterm colours. Only 1504Together, all those colours implement the 88 (256) colour xterm
1443the first 16 can be changed using resources currently, the rest can only 1505colours. Only the first 16 can be changed using resources currently, the
1444be changed via command sequences ("escape codes"). 1506rest can only be changed via command sequences ("escape codes").
1507
1508Applications are advised to use terminfo or command sequences to discover
1509number and RGB values of all colours (yes, you can query this...).
1445 1510
1446Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1511Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447always swapping the foreground/background colours. This is in contrast to 1512always swapping the foreground/background colours. This is in contrast to
1448I<xterm>(1) where the colours are only swapped if they have not otherwise 1513I<xterm>(1) where the colours are only swapped if they have not otherwise
1449been specified. For example, 1514been specified. For example,
1450 1515
1451=over 4
1452
1453=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1516 @@RXVT_NAME@@ -fg Black -bg White -rv
1454 1517
1455would yield White on Black, while on I<xterm>(1) it would yield Black 1518would yield White on Black, while on I<xterm>(1) it would yield Black on
1456on White. 1519White.
1457
1458=back
1459 1520
1460=head2 ALPHA CHANNEL SUPPORT 1521=head2 ALPHA CHANNEL SUPPORT
1461 1522
1462If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1523If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1524their act together, rxvt-unicode will do it's own alpha channel management:
1464(recommended, but B<MUST> have 4 digits/component) colour specifications, 1525
1465in addition to the ones provided by X, where the additional A component 1526You can prefix any colour with an opaqueness percentage enclosed in
1527brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1528(0-100) that specifies the opacity of the colour, where C<0> is completely
1529transparent and C<100> is completely opaque. For example, C<[50]red> is a
1530half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1531is the recommended format to specify transparency values, and works with
1532all ways to specify a colour.
1533
1534For complete control, rxvt-unicode also supports
1535C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1536specifications, where the additional C<aaaa> component specifies opacity
1466specifies opacity (alpha) values. The minimum value of C<0> is completely 1537(alpha) values. The minimum value of C<0000> is completely transparent,
1467transparent). You can also prefix any color with C<[percent]>, where 1538while C<ffff> is completely opaque). The two example colours from
1468C<percent> is a decimal percentage (0-100) that specifies the opacity of 1539earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1469the color, where C<0> is completely transparent and C<100> is completelxy 1540C<rgba:0000/ff00/0000/f332>.
1470opaque.
1471 1541
1472You probably need to specify B<"-depth 32">, too, and have the luck that 1542You probably need to specify B<"-depth 32">, too, to force a visual with
1473your X-server uses ARGB pixel layout, as X is far from just supporting 1543alpha channels, and have the luck that your X-server uses ARGB pixel
1474ARGB visuals out of the box, and rxvt-unicode just fudges around. 1544layout, as X is far from just supporting ARGB visuals out of the box, and
1545rxvt-unicode just fudges around.
1475 1546
1476For example, the following selects an almost completely transparent red 1547For example, the following selects an almost completely transparent black
1477background, and an almost opaque pink foreground: 1548background, and an almost opaque pink foreground:
1478 1549
1479 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1550 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480 1551
1481I<Please note that transparency of any kind if completely unsupported by 1552When not using a background image, then the interpretation of the
1482the author. Don't bug him with installation questions!> 1553alpha channel is up to your compositing manager (most interpret it as
1554transparency of course).
1555
1556When using a background pixmap or pseudo-transparency, then the background
1557colour will always behave as if it were completely transparent (so the
1558background image shows instead), regardless of how it was specified, while
1559other colours will either be transparent as specified (the background
1560image will show through) on servers supporting the RENDER extension, or
1561fully opaque on servers not supporting the RENDER EXTENSION.
1562
1563Please note that due to bugs in Xft, specifying alpha values might result
1564in garbage being displayed when the X-server does not support the RENDER
1565extension.
1483 1566
1484=head1 ENVIRONMENT 1567=head1 ENVIRONMENT
1485 1568
1486B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1569B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487 1570
1521C<--with-terminfo=PATH>. 1604C<--with-terminfo=PATH>.
1522 1605
1523=item B<DISPLAY> 1606=item B<DISPLAY>
1524 1607
1525Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1608Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526display in its child processes. 1609display in its child processes if C<-display> isn't used to override. It
1610defaults to C<:0> if it doesn't exist.
1527 1611
1528=item B<SHELL> 1612=item B<SHELL>
1529 1613
1530The shell to be used for command execution, defaults to C</bin/sh>. 1614The shell to be used for command execution, defaults to C</bin/sh>.
1531 1615
1557 1641
1558=over 4 1642=over 4
1559 1643
1560=item B</usr/lib/X11/rgb.txt> 1644=item B</usr/lib/X11/rgb.txt>
1561 1645
1562Color names. 1646Colour names.
1563 1647
1564=back 1648=back
1565 1649
1566=head1 SEE ALSO 1650=head1 SEE ALSO
1567 1651

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines