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.147 by root, Fri Nov 23 11:18:04 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>
116 124
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118 126
119=item B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
120 128
121Turn on/off illusion of a transparent window background. Obsolete form of it is 129Turn on/off illusion of a transparent window background; resource B<transparent>.
122B<-ip> and it should not be used anymore; resource B<transparent>.
123 130
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be 131B<-ip> is still accepted as an obsolete alias but will be removed in
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will 132future versions.
126be phased out in future versions of rxvt!>
127
128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130 133
131=item B<-fade> I<number> 134=item B<-fade> I<number>
132 135
133Fade 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
134fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
146non-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
147used to brighten or darken the image in addition to tinting it. 150used to brighten or darken the image in addition to tinting it.
148Please 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,
149thus yielding performance gain of two orders of magnitude. These colours are: 152thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also 153blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource 154pure black and pure white colours essentially mean no tinting; resource
152I<tintColor>. Example: 155I<tintColor>. Example:
153 156
154 @@RXVT_NAME@@ -tr -tint blue -sh 40 157 @@RXVT_NAME@@ -tr -tint blue -sh 40
155 158
156=item B<-sh> I<number> 159=item B<-sh> I<number>
162=item B<-blt> I<string> 165=item B<-blt> I<string>
163 166
164Specify background blending type. If background pixmap is specified 167Specify background blending type. If background pixmap is specified
165at the same time as transparency - such pixmap will be blended over 168at the same time as transparency - such pixmap will be blended over
166transparency image, using method specified. Supported values are : 169transparency image, using method specified. Supported values are :
167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 170B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 171B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169B<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
170alpha-blending. Compile I<afterimage>; resource I<blendType>. 173alpha-blending. Compile I<afterimage>; resource I<blendType>.
171 174
172=item B<-blr> I<HxV> 175=item B<-blr> I<HxV>
173 176
174Apply Gaussian Blur with the specified radii to the transparent 177Apply Gaussian Blur with the specified radii to the transparent
175background image. If single number is specified - both vertical and 178background image. If single number is specified - both vertical and
176horizontal radii are considered to be the same. Setting one of the 179horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects 180radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 181on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
179resource I<blurRadius>. 182resource I<blurRadius>.
180 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
181=item B<-bg> I<colour> 190=item B<-bg> I<colour>
182 191
183Window background colour; resource B<background>. 192Window background colour; resource B<background>.
184 193
185=item B<-fg> I<colour> 194=item B<-fg> I<colour>
186 195
187Window foreground colour; resource B<foreground>. 196Window foreground colour; resource B<foreground>.
188 197
189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190 199
191Compile I<afterimage>: Specify image file for the background and also 200Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
192optionally 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
193add quotes to avoid special shell interpretation of the C<;> in the 202add quotes to avoid special shell interpretation of the C<;> in the
194command-line; for more details see resource B<backgroundPixmap>. 203command-line; for more details see resource B<backgroundPixmap>.
195 204
196=item B<-cr> I<colour> 205=item B<-cr> I<colour>
244italic> >> characters are to be printed. See resource B<boldItalicFont> 253italic> >> characters are to be printed. See resource B<boldItalicFont>
245for details. 254for details.
246 255
247=item B<-is>|B<+is> 256=item B<-is>|B<+is>
248 257
249Compile I<font-styles>: Bold/Italic font styles imply high intensity 258Compile I<font-styles>: Bold/Blink font styles imply high intensity
250foreground/background (default). See resource B<intensityStyles> for 259foreground/background (default). See resource B<intensityStyles> for
251details. 260details.
252 261
253=item B<-name> I<name> 262=item B<-name> I<name>
254 263
272 281
273=item B<-sb>|B<+sb> 282=item B<-sb>|B<+sb>
274 283
275Turn on/off scrollbar; resource B<scrollBar>. 284Turn on/off scrollbar; resource B<scrollBar>.
276 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
277=item B<-si>|B<+si> 295=item B<-si>|B<+si>
278 296
279Turn on/off scroll-to-bottom on TTY output inhibit; resource 297Turn on/off scroll-to-bottom on TTY output inhibit; resource
280B<scrollTtyOutput> has opposite effect. 298B<scrollTtyOutput> has opposite effect.
281 299
287=item B<-sw>|B<+sw> 305=item B<-sw>|B<+sw>
288 306
289Turn on/off scrolling with the scrollback buffer as new lines appear. 307Turn on/off scrolling with the scrollback buffer as new lines appear.
290This only takes effect if B<-si> is also given; resource 308This only takes effect if B<-si> is also given; resource
291B<scrollWithBuffer>. 309B<scrollWithBuffer>.
292
293=item B<-sr>|B<+sr>
294
295Put scrollbar on right/left; resource B<scrollBar_right>.
296
297=item B<-st>|B<+st>
298
299Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300resource B<scrollBar_floating>.
301 310
302=item B<-ptab>|B<+ptab> 311=item B<-ptab>|B<+ptab>
303 312
304If enabled (default), "Horizontal Tab" characters are being stored as 313If enabled (default), "Horizontal Tab" characters are being stored as
305actual wide characters in the screen buffer, which makes it possible to 314actual wide characters in the screen buffer, which makes it possible to
309 318
310=item B<-bc>|B<+bc> 319=item B<-bc>|B<+bc>
311 320
312Blink the cursor; resource B<cursorBlink>. 321Blink the cursor; resource B<cursorBlink>.
313 322
323=item B<-uc>|B<+uc>
324
325Make the cursor underlined; resource B<cursorUnderline>.
326
314=item B<-iconic> 327=item B<-iconic>
315 328
316Start iconified, if the window manager supports that option. 329Start iconified, if the window manager supports that option.
317Alternative form is B<-ic>. 330Alternative form is B<-ic>.
318 331
334 347
335=item B<-bl> 348=item B<-bl>
336 349
337Compile 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.
338if 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
339decorations; resource B<borderLess>. 352decorations; resource B<borderLess>. If the window manager does not
353support MWM hints (e.g. kwin), enables override-redirect mode.
340 354
341=item B<-override-redirect> 355=item B<-override-redirect>
342 356
343Compile I<frills>: Sets override-redirect on the window; resource 357Compile I<frills>: Sets override-redirect on the window; resource
344B<override-redirect>. 358B<override-redirect>.
353=item B<-lsp> I<number> 367=item B<-lsp> I<number>
354 368
355Compile I<frills>: Lines (pixel height) to insert between each row of 369Compile I<frills>: Lines (pixel height) to insert between each row of
356the display. Useful to work around font rendering problems; resource 370the display. Useful to work around font rendering problems; resource
357B<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>.
358 379
359=item B<-tn> I<termname> 380=item B<-tn> I<termname>
360 381
361This 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
362B<TERM> environment variable. This terminal type must exist in the 383B<TERM> environment variable. This terminal type must exist in the
417 438
418=item B<-tcw> 439=item B<-tcw>
419 440
420Change the meaning of triple-click selection with the left mouse 441Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is 442button. Only effective when the original (non-perl) selection code is
422in-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
423end of the logical line only. resource B<tripleclickwords>. 444the end of the logical line only. resource B<tripleclickwords>.
424 445
425=item B<-insecure> 446=item B<-insecure>
426 447
427Enable "insecure" mode, which currently enables most of the escape 448Enable "insecure" mode, which currently enables most of the escape
428sequences that echo strings. See the resource B<insecure> for more 449sequences that echo strings. See the resource B<insecure> for more
448 469
449Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 470Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450will not immediately destroy its window when the program executed within 471will not immediately destroy its window when the program executed within
451it 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
452user; 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>.
453 480
454=item B<-xrm> I<string> 481=item B<-xrm> I<string>
455 482
456Works 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>
457as 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
505If 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
506entries 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
507yourself if you want that. 534yourself if you want that.
508 535
509As an extremely special case, specifying C<-1> will completely suppress 536As an extremely special case, specifying C<-1> will completely suppress
510pty/tty operations. 537pty/tty operations, which is probably only useful in conjunction with some
538perl extension that manages the terminal.
511 539
512Here 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
513longer example is in F<doc/pty-fd>): 541longer example is in F<doc/pty-fd>):
514 542
515 use IO::Pty; 543 use IO::Pty;
529Comma-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
530this terminal instance. See resource B<perl-ext> for details. 558this terminal instance. See resource B<perl-ext> for details.
531 559
532=back 560=back
533 561
534=head1 RESOURCES (available also as long-options) 562=head1 RESOURCES
535 563
536Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 564Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
537options) compiled into your version. 565options) compiled into your version. All resources are also available as
566long-options.
538 567
539You 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
540distribution do also load settings from the B<~/.Xresources> file when X 569distribution do also load settings from the B<~/.Xresources> file when X
541starts. @@RXVT_NAME@@ will consult the following files/resources in order, 570starts. @@RXVT_NAME@@ will consult the following files/resources in order,
542with later settings overwriting earlier ones: 571with later settings overwriting earlier ones:
564=item B<depth:> I<bitdepth> 593=item B<depth:> I<bitdepth>
565 594
566Compile 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;
567option B<-depth>. 596option B<-depth>.
568 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
569=item B<geometry:> I<geom> 605=item B<geometry:> I<geom>
570 606
571Create the window with the specified X window geometry [default 80x24]; 607Create the window with the specified X window geometry [default 80x24];
572option B<-geometry>. 608option B<-geometry>.
573 609
586Use 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
587corresponds to low-intensity (normal) colours and 8-15 corresponds to 623corresponds to low-intensity (normal) colours and 8-15 corresponds to
588high-intensity (bold = bright foreground, blink = bright background) 624high-intensity (bold = bright foreground, blink = bright background)
589colours. 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,
5903=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
591names used are listed in the B<COLORS AND GRAPHICS> section. 627names used are listed in the B<COLOURS AND GRAPHICS> section.
592 628
593Colours 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
594changed using an escape command (see @@RXVT_NAME@@(7)). 630changed using an escape command (see @@RXVT_NAME@@(7)).
595 631
596Colours 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
607=item B<colorUL:> I<colour> 643=item B<colorUL:> I<colour>
608 644
609Use the specified colour to display underlined characters when the 645Use the specified colour to display underlined characters when the
610foreground colour is the default. 646foreground colour is the default.
611 647
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> 648=item B<underlineColor:> I<colour>
618 649
619If set, use the specified colour as the colour for the underline 650If set, use the specified colour as the colour for the underline
620itself. 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.
621 662
622=item B<cursorColor:> I<colour> 663=item B<cursorColor:> I<colour>
623 664
624Use 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
625foreground colour; option B<-cr>. 666foreground colour; option B<-cr>.
632 673
633=item B<reverseVideo:> I<boolean> 674=item B<reverseVideo:> I<boolean>
634 675
635B<True>: simulate reverse video by foreground and background colours; 676B<True>: simulate reverse video by foreground and background colours;
636option B<-rv>. B<False>: regular screen colours [default]; option 677option B<-rv>. B<False>: regular screen colours [default]; option
637B<+rv>. See note in B<COLORS AND GRAPHICS> section. 678B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
638 679
639=item B<jumpScroll:> I<boolean> 680=item B<jumpScroll:> I<boolean>
640 681
641B<True>: specify that jump scrolling should be used. When receiving lots 682B<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 683of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
656 697
657B<False>: specify that everything is to be displayed, even 698B<False>: specify that everything is to be displayed, even
658if the refresh is too fast for the human eye to read anything (or the 699if the refresh is too fast for the human eye to read anything (or the
659monitor to display anything); option B<+ss>. 700monitor to display anything); option B<+ss>.
660 701
661=item B<inheritPixmap:> I<boolean> 702=item B<transparent:> I<boolean>
662 703
663B<True>: make the background inherit the parent windows' pixmap, giving 704Turn on/off illusion of a transparent window background.
664artificial transparency. B<False>: do not inherit the parent windows'
665pixmap.
666 705
667I<Please note that transparency of any kind if completely unsupported by 706B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
668the author. Don't bug him with installation questions!> 707future versions.
669 708
670=item B<fading:> I<number> 709=item B<fading:> I<number>
671 710
672Fade 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>.
673 712
690 729
691Specify background blending type; option B<-blt>. 730Specify background blending type; option B<-blt>.
692 731
693=item B<blurRadius:> I<number> 732=item B<blurRadius:> I<number>
694 733
695Apply Gaussian Blurr with the specified radius to the transparent 734Apply gaussian blur with the specified radius to the transparent
696background 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>.
697 740
698=item B<scrollColor:> I<colour> 741=item B<scrollColor:> I<colour>
699 742
700Use the specified colour for the scrollbar [default #B2B2B2]. 743Use the specified colour for the scrollbar [default #B2B2B2].
701 744
711 754
712=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
713 756
714Use the specified image file for the background and also 757Use the specified image file for the background and also
715optionally specify its scaling with a geometry string B<WxH+X+Y>, 758optionally specify its scaling with a geometry string B<WxH+X+Y>,
716(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
717horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 760horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
718centre (percent). A scale of 0 displays the image with tiling. A scale 761centre (percent). A scale of 0 displays the image with tiling.
719of 1 displays the image without any scaling. A scale of 2 to 9 specifies 762The maximum permitted scale is 1000.
720an integer number of images in that direction. No image will be magnified
721beyond 10 times its original size. The maximum permitted scale is 1000.
722Additional operations can be specified after colon B<:op1:op2...>. 763Additional operations can be specified after colon B<:op1:op2...>.
723Supported operations are: 764Supported operations are:
724 765
725 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
726 propscale will scale image keeping proportions, 767 propscale will scale image keeping proportions
727 auto will scale image to match window size. Equivalent to 100x100; 768 auto will scale image to match window size. Equivalent to 100x100
728 hscale will scale image horizontally to the window size; 769 hscale will scale image horizontally to the window size
729 vscale will scale image vertically to the window size; 770 vscale will scale image vertically to the window size
730 scale will scale image to match window size; 771 scale will scale image to match window size
731 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
732 whenever terminal window moves. 773 whenever terminal window moves
733 774
734If 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
735blended over transparency image using either alpha-blending, or any 776blended over transparency image using alpha-blending. If I<afterimage>
736other 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.
737 779
738=item B<path:> I<path> 780=item B<path:> I<path>
739 781
740Specify the colon-delimited search path for finding background image files. 782Specify the colon-delimited search path for finding background image files.
741 783
768it 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
769wide and 15 pixels high. 811wide and 15 pixels high.
770 812
771The 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
772the base font, likewise the third, which is unfortunately non-bold, but 814the base font, likewise the third, which is unfortunately non-bold, but
773the 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
774useful supplement. 816useful supplement.
775 817
776The 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
777are 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
778contains other characters, but we are not interested in them. 820contains other characters, but we are not interested in them.
802text font will being used for the given style. 844text font will being used for the given style.
803 845
804=item B<intensityStyles:> I<boolean> 846=item B<intensityStyles:> I<boolean>
805 847
806When 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>,
807option B<-is>, the default), bold and italic font styles imply high 849option B<-is>, the default), bold/blink font styles imply high
808intensity foreground/background colours. Disabling this option (B<False>, 850intensity foreground/background colours. Disabling this option (B<False>,
809option B<+is>) disables this behaviour, the high intensity colours are not 851option B<+is>) disables this behaviour, the high intensity colours are not
810reachable. 852reachable.
811 853
812=item B<selectstyle:> I<mode>
813
814Set mouse selection style to B<old> which is 2.20, B<oldword> which
815is xterm style with 2.20 old word selection, or anything else which
816gives xterm style selection. Only effective when the original (non-perl)
817selection code is in use.
818
819=item B<scrollstyle:> I<mode>
820
821Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
822the author's favourite.
823
824=item B<title:> I<string> 854=item B<title:> I<string>
825 855
826Set window title string, the default title is the command-line 856Set window title string, the default title is the command-line
827specified after the B<-e> option, if any, otherwise the application 857specified after the B<-e> option, if any, otherwise the application
828name; option B<-title>. 858name; option B<-title>.
841=item B<urgentOnBell:> I<boolean> 871=item B<urgentOnBell:> I<boolean>
842 872
843B<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.
844B<False>: do not set the urgency hint [default]. 874B<False>: do not set the urgency hint [default].
845 875
876@@RXVT_NAME@@ resets the urgency hint on every focus change.
877
846=item B<visualBell:> I<boolean> 878=item B<visualBell:> I<boolean>
847 879
848B<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>.
849B<False>: no visual bell [default]; option B<+vb>. 881B<False>: no visual bell [default]; option B<+vb>.
850 882
872 904
873 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 905 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
874 906
875This 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
876every 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.
877 914
878=item B<scrollBar:> I<boolean> 915=item B<scrollBar:> I<boolean>
879 916
880B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 917B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
881disable the scrollbar; option B<+sb>. 918disable the scrollbar; option B<+sb>.
969=item B<cursorBlink:> I<boolean> 1006=item B<cursorBlink:> I<boolean>
970 1007
971B<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];
972option B<-bc>. 1009option B<-bc>.
973 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
974=item B<pointerBlank:> I<boolean> 1016=item B<pointerBlank:> I<boolean>
975 1017
976B<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
977of seconds of inactivity. B<False>: the pointer is always visible 1019of seconds of inactivity. B<False>: the pointer is always visible
978[default]. 1020[default].
991large number (e.g. C<987654321>) to effectively disable the timeout. 1033large number (e.g. C<987654321>) to effectively disable the timeout.
992 1034
993=item B<backspacekey:> I<string> 1035=item B<backspacekey:> I<string>
994 1036
995The 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>
996or 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>
997(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
998escape sequence. 1040escape sequence.
999 1041
1000=item B<deletekey:> I<string> 1042=item B<deletekey:> I<string>
1001 1043
1080 1122
1081=item B<secondaryScroll:> I<boolean> 1123=item B<secondaryScroll:> I<boolean>
1082 1124
1083Turn on/off secondary screen scroll (default enabled). If this 1125Turn on/off secondary screen scroll (default enabled). If this
1084option is enabled, scrolls on the secondary screen will change the 1126option is enabled, scrolls on the secondary screen will change the
1085scrollback buffer and switching to/from the secondary screen will 1127scrollback buffer and, when secondaryScreen is off, switching
1086instead scroll the screen up. 1128to/from the secondary screen will instead scroll the screen up.
1087 1129
1088=item B<hold>: I<boolean> 1130=item B<hold>: I<boolean>
1089 1131
1090Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1132Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1091will not immediately destroy its window when the program executed within 1133will not immediately destroy its window when the program executed within
1092it 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
1093user. 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>.
1094 1143
1095=item B<keysym.>I<sym>: I<string> 1144=item B<keysym.>I<sym>: I<string>
1096 1145
1097Compile I<frills>: Associate I<string> with keysym I<sym>. The 1146Compile I<frills>: Associate I<string> with keysym I<sym>. The
1098intervening resource name B<keysym.> cannot be omitted. 1147intervening resource name B<keysym.> cannot be omitted.
1113omitting 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
1114keysym 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
1115performed in an exact manner; however, the closest match is assured. 1164performed in an exact manner; however, the closest match is assured.
1116 1165
1117I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1118number), see RESOURCES in C<man 7 X> for futher details. 1167number), see RESOURCES in C<man 7 X> for further details.
1119 1168
1120You 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>
1121with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1122should be a character not used by the strings. 1171should be a character not used by the strings.
1123 1172
1137when Control-Meta-c is being pressed": 1186when Control-Meta-c is being pressed":
1138 1187
1139 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
1140 1189
1141If 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>
1142is 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)
1143manpage. For example, the F<selection> extension (activated via 1192manpage. For example, the F<selection> extension (activated via
1144C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1193C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1145 1194
1146 URxvt.keysym.M-C-c: perl:selection:rot13 1195 URxvt.keysym.M-C-c: perl:selection:rot13
1147 1196
1148Due the the large number of modifier combinations, a defined key mapping 1197Due the the large number of modifier combinations, a defined key mapping
1149will 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
1150no 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
1151means that defining a key map for C<a> will automatically provide 1200means that defining a key map for C<a> will automatically provide
1152definitions 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
1153mappings themselves. 1202mappings themselves.
1154 1203
1205all instances, while B<perl-ext> is used for specific instances. 1254all instances, while B<perl-ext> is used for specific instances.
1206 1255
1207=item B<perl-eval>: I<string> 1256=item B<perl-eval>: I<string>
1208 1257
1209Perl code to be evaluated when all extensions have been registered. See 1258Perl code to be evaluated when all extensions have been registered. See
1210the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1259the @@RXVT_NAME@@perl(3) manpage.
1211will be ignored when running setuid/setgid.
1212 1260
1213=item B<perl-lib>: I<path> 1261=item B<perl-lib>: I<path>
1214 1262
1215Colon-separated list of additional directories that hold extension 1263Colon-separated list of additional directories that hold extension
1216scripts. When looking for extensions specified by the C<perl> resource, 1264scripts. When looking for extensions specified by the C<perl> resource,
1217@@RXVT_NAME@@ will first look in these directories and then in 1265@@RXVT_NAME@@ will first look in these directories and then in
1218F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1266F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1219will be ignored when running setuid/setgid.
1220 1267
1221See the @@RXVT_NAME@@perl(3) manpage. 1268See the @@RXVT_NAME@@perl(3) manpage.
1222 1269
1223=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1270=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1224 1271
1246 1293
1247=item B<override-redirect>: I<boolean> 1294=item B<override-redirect>: I<boolean>
1248 1295
1249Compile I<frills>: Sets override-redirect for the terminal window, making 1296Compile I<frills>: Sets override-redirect for the terminal window, making
1250it 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).
1251 1302
1252=item B<iso14755_52:> I<boolean> 1303=item B<iso14755_52:> I<boolean>
1253 1304
1254Turn on/off ISO 14755 5.2 mode (default enabled). 1305Turn on/off ISO 14755 5.2 mode (default enabled).
1255 1306
1398B<@@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
1399it 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
1400allow 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
1401on 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.
1402 1453
1403=head1 COLORS AND GRAPHICS 1454=head1 COLOURS AND GRAPHICS
1404 1455
1405In addition to the default foreground and background colours, 1456In addition to the default foreground and background colours,
1406B<@@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
1407high-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
1408colours 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.
1409 1463
1410=begin table 1464=begin table
1411 1465
1412 B<color0> (black) = Black 1466 B<color0> (black) = Black
1413 B<color1> (red) = Red3 1467 B<color1> (red) = Red3
1433It is also possible to specify the colour values of B<foreground>, 1487It is also possible to specify the colour values of B<foreground>,
1434B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1488B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1435a 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
1436color0-color15. 1490color0-color15.
1437 1491
1438In addition to the colours defined above, @@RXVT_NAME@@ offers an 1492The following text gives values for the standard 88 colour mode (and
1439additional 72 colours. The first 64 of those (with indices 16 to 79) 1493values for the 256 colour mode in parentheses).
1440consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144116>), followed by 8 additional shades of gray (with indices 80 to 87).
1442 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
1443Together, all those colours implement the 88 colour xterm colours. Only 1504Together, all those colours implement the 88 (256) colour xterm
1444the first 16 can be changed using resources currently, the rest can only 1505colours. Only the first 16 can be changed using resources currently, the
1445be 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...).
1446 1510
1447Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1511Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1448always swapping the foreground/background colours. This is in contrast to 1512always swapping the foreground/background colours. This is in contrast to
1449I<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
1450been specified. For example, 1514been specified. For example,
1451 1515
1452=over 4
1453
1454=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1516 @@RXVT_NAME@@ -fg Black -bg White -rv
1455 1517
1456would 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
1457on White. 1519White.
1458
1459=back
1460 1520
1461=head2 ALPHA CHANNEL SUPPORT 1521=head2 ALPHA CHANNEL SUPPORT
1462 1522
1463If 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
1464their 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:
1465(recommended, but B<MUST> have 4 digits/component) colour specifications, 1525
1466in 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
1467specifies opacity (alpha) values. The minimum value of C<0> is completely 1537(alpha) values. The minimum value of C<0000> is completely transparent,
1468transparent). You can also prefix any color with C<[percent]>, where 1538while C<ffff> is completely opaque). The two example colours from
1469C<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
1470the color, where C<0> is completely transparent and C<100> is completelxy 1540C<rgba:0000/ff00/0000/f332>.
1471opaque.
1472 1541
1473You 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
1474your 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
1475ARGB 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.
1476 1546
1477For example, the following selects an almost completely transparent red 1547For example, the following selects an almost completely transparent black
1478background, and an almost opaque pink foreground: 1548background, and an almost opaque pink foreground:
1479 1549
1480 @@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"
1481 1551
1482I<Please note that transparency of any kind if completely unsupported by 1552When not using a background image, then the interpretation of the
1483the 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.
1484 1566
1485=head1 ENVIRONMENT 1567=head1 ENVIRONMENT
1486 1568
1487B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1569B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1488 1570
1522C<--with-terminfo=PATH>. 1604C<--with-terminfo=PATH>.
1523 1605
1524=item B<DISPLAY> 1606=item B<DISPLAY>
1525 1607
1526Used 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
1527display 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.
1528 1611
1529=item B<SHELL> 1612=item B<SHELL>
1530 1613
1531The 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>.
1532 1615
1558 1641
1559=over 4 1642=over 4
1560 1643
1561=item B</usr/lib/X11/rgb.txt> 1644=item B</usr/lib/X11/rgb.txt>
1562 1645
1563Color names. 1646Colour names.
1564 1647
1565=back 1648=back
1566 1649
1567=head1 SEE ALSO 1650=head1 SEE ALSO
1568 1651

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines