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.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.179 by root, Sun May 23 01:06:47 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 133
128I<Please address all transparency related issues to Sasha Vasko at 134I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130 136
131=item B<-fade> I<number> 137=item B<-fade> I<number>
146non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
147used to brighten or darken the image in addition to tinting it. 153used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side, 154Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are: 155thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also 156blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource 157pure black and pure white colours essentially mean no tinting; resource
152I<tintColor>. Example: 158I<tintColor>. Example:
153 159
154 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
155 161
156=item B<-sh> I<number> 162=item B<-sh> I<number>
162=item B<-blt> I<string> 168=item B<-blt> I<string>
163 169
164Specify background blending type. If background pixmap is specified 170Specify background blending type. If background pixmap is specified
165at the same time as transparency - such pixmap will be blended over 171at the same time as transparency - such pixmap will be blended over
166transparency image, using method specified. Supported values are : 172transparency image, using method specified. Supported values are :
167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170alpha-blending. Compile I<afterimage>; resource I<blendType>. 176alpha-blending. Compile I<afterimage>; resource I<blendType>.
171 177
172=item B<-blr> I<HxV> 178=item B<-blr> I<HxV>
176horizontal radii are considered to be the same. Setting one of the 182horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects 183radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>. 185resource I<blurRadius>.
180 186
187=item B<-icon> I<file>
188
189Compile I<afterimage>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>.
192
181=item B<-bg> I<colour> 193=item B<-bg> I<colour>
182 194
183Window background colour; resource B<background>. 195Window background colour; resource B<background>.
184 196
185=item B<-fg> I<colour> 197=item B<-fg> I<colour>
244italic> >> characters are to be printed. See resource B<boldItalicFont> 256italic> >> characters are to be printed. See resource B<boldItalicFont>
245for details. 257for details.
246 258
247=item B<-is>|B<+is> 259=item B<-is>|B<+is>
248 260
249Compile I<font-styles>: Bold/Italic font styles imply high intensity 261Compile I<font-styles>: Bold/Blink font styles imply high intensity
250foreground/background (default). See resource B<intensityStyles> for 262foreground/background (default). See resource B<intensityStyles> for
251details. 263details.
252 264
253=item B<-name> I<name> 265=item B<-name> I<name>
254 266
272 284
273=item B<-sb>|B<+sb> 285=item B<-sb>|B<+sb>
274 286
275Turn on/off scrollbar; resource B<scrollBar>. 287Turn on/off scrollbar; resource B<scrollBar>.
276 288
289=item B<-sr>|B<+sr>
290
291Put scrollbar on right/left; resource B<scrollBar_right>.
292
293=item B<-st>|B<+st>
294
295Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
296resource B<scrollBar_floating>.
297
277=item B<-si>|B<+si> 298=item B<-si>|B<+si>
278 299
279Turn on/off scroll-to-bottom on TTY output inhibit; resource 300Turn on/off scroll-to-bottom on TTY output inhibit; resource
280B<scrollTtyOutput> has opposite effect. 301B<scrollTtyOutput> has opposite effect.
281 302
287=item B<-sw>|B<+sw> 308=item B<-sw>|B<+sw>
288 309
289Turn on/off scrolling with the scrollback buffer as new lines appear. 310Turn on/off scrolling with the scrollback buffer as new lines appear.
290This only takes effect if B<-si> is also given; resource 311This only takes effect if B<-si> is also given; resource
291B<scrollWithBuffer>. 312B<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 313
302=item B<-ptab>|B<+ptab> 314=item B<-ptab>|B<+ptab>
303 315
304If enabled (default), "Horizontal Tab" characters are being stored as 316If enabled (default), "Horizontal Tab" characters are being stored as
305actual wide characters in the screen buffer, which makes it possible to 317actual wide characters in the screen buffer, which makes it possible to
309 321
310=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
311 323
312Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
313 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
314=item B<-iconic> 330=item B<-iconic>
315 331
316Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
317Alternative form is B<-ic>. 333Alternative form is B<-ic>.
318 334
334 350
335=item B<-bl> 351=item B<-bl>
336 352
337Compile I<frills>: Set MWM hints to request a borderless window, i.e. 353Compile 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 354if honoured by the WM, the rxvt-unicode window will not have window
339decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
340 357
341=item B<-override-redirect> 358=item B<-override-redirect>
342 359
343Compile I<frills>: Sets override-redirect on the window; resource 360Compile I<frills>: Sets override-redirect on the window; resource
344B<override-redirect>. 361B<override-redirect>.
353=item B<-lsp> I<number> 370=item B<-lsp> I<number>
354 371
355Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
356the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
357B<lineSpace>. 374B<lineSpace>.
375
376=item B<-letsp> I<number>
377
378Compile I<frills>: Amount to adjust the computed character width by
379to control overall letter spacing. Negative values will tighten up the
380letter spacing, positive values will space letters out more. Useful to
381work around odd font metrics; resource B<letterSpace>.
358 382
359=item B<-tn> I<termname> 383=item B<-tn> I<termname>
360 384
361This option specifies the name of the terminal type to be set in the 385This option specifies the name of the terminal type to be set in the
362B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
417 441
418=item B<-tcw> 442=item B<-tcw>
419 443
420Change the meaning of triple-click selection with the left mouse 444Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is 445button. Only effective when the original (non-perl) selection code is
422in-use. Instead of selecting a full line it will extend the selection the 446in-use. Instead of selecting a full line it will extend the selection to
423end of the logical line only. resource B<tripleclickwords>. 447the end of the logical line only. resource B<tripleclickwords>.
424 448
425=item B<-insecure> 449=item B<-insecure>
426 450
427Enable "insecure" mode, which currently enables most of the escape 451Enable "insecure" mode, which currently enables most of the escape
428sequences that echo strings. See the resource B<insecure> for more 452sequences that echo strings. See the resource B<insecure> for more
448 472
449Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450will not immediately destroy its window when the program executed within 474will 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 475it exits. Instead, it will wait till it is being killed or closed by the
452user; resource B<hold>. 476user; resource B<hold>.
477
478=item B<-cd> I<path>
479
480Sets the working directory for the shell (or the command specified via
481B<-e>). The I<path> must be an absolute path and it must exist for
482@@RXVT_NAME@@ to start; resource B<chdir>.
483
484=item B<-xrm> I<string>
485
486Works like the X Toolkit option of the same name, by adding the I<string>
487as if it were specified in a resource file. Resource values specified this
488way take precedence over all other resource specifications.
489
490Note that you need to use the I<same> syntax as in the .Xdefaults file,
491e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
492options can be specified as long-options on the commandline, so use
493of B<-xrm> is mostly limited to cases where you want to specify other
494resources (e.g. for input methods) or for compatibility with other
495programs.
453 496
454=item B<-keysym.>I<sym> I<string> 497=item B<-keysym.>I<sym> I<string>
455 498
456Remap a key symbol. See resource B<keysym>. 499Remap a key symbol. See resource B<keysym>.
457 500
492If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 535If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
493entries and will not tinker with pty/tty permissions - you have to do that 536entries and will not tinker with pty/tty permissions - you have to do that
494yourself if you want that. 537yourself if you want that.
495 538
496As an extremely special case, specifying C<-1> will completely suppress 539As an extremely special case, specifying C<-1> will completely suppress
497pty/tty operations. 540pty/tty operations, which is probably only useful in conjunction with some
541perl extension that manages the terminal.
498 542
499Here is a example in perl that illustrates how this option can be used (a 543Here is a example in perl that illustrates how this option can be used (a
500longer example is in F<doc/pty-fd>): 544longer example is in F<doc/pty-fd>):
501 545
502 use IO::Pty; 546 use IO::Pty;
516Comma-separated list of perl extension scripts to use (or not to use) in 560Comma-separated list of perl extension scripts to use (or not to use) in
517this terminal instance. See resource B<perl-ext> for details. 561this terminal instance. See resource B<perl-ext> for details.
518 562
519=back 563=back
520 564
521=head1 RESOURCES (available also as long-options) 565=head1 RESOURCES
522 566
523Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 567Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524options) compiled into your version. 568options) compiled into your version. All resources are also available as
569long-options.
525 570
526You can set and change the resources using X11 tools like B<xrdb>. Many 571You can set and change the resources using X11 tools like B<xrdb>. Many
527distribution do also load settings from the B<~/.Xresources> file when X 572distribution do also load settings from the B<~/.Xresources> file when X
528starts. @@RXVT_NAME@@ will consult the following files/resources in order, 573starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529with later settings overwriting earlier ones: 574with later settings overwriting earlier ones:
531 1. system-wide app-defaults file, either locale-dependent OR global 576 1. system-wide app-defaults file, either locale-dependent OR global
532 2. app-defaults file in $XAPPLRESDIR 577 2. app-defaults file in $XAPPLRESDIR
533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534 4. SCREEN_RESOURCES for the current screen 579 4. SCREEN_RESOURCES for the current screen
535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline
536 582
537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
539common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 585common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
540configured, while the class name B<URxvt> allows resources unique to 586configured, while the class name B<URxvt> allows resources unique to
550=item B<depth:> I<bitdepth> 596=item B<depth:> I<bitdepth>
551 597
552Compile I<xft>: Attempt to find a visual with the given bit depth; 598Compile I<xft>: Attempt to find a visual with the given bit depth;
553option B<-depth>. 599option B<-depth>.
554 600
601=item B<buffered:> I<boolean>
602
603Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
604On some card/driver combination enabling it slightly decreases
605performance, on most it greatly helps it. The slowdown is small, so it
606should normally be enabled.
607
555=item B<geometry:> I<geom> 608=item B<geometry:> I<geom>
556 609
557Create the window with the specified X window geometry [default 80x24]; 610Create the window with the specified X window geometry [default 80x24];
558option B<-geometry>. 611option B<-geometry>.
559 612
572Use the specified colour for the colour value I<n>, where 0-7 625Use the specified colour for the colour value I<n>, where 0-7
573corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
574high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
575colours. The canonical names are as follows: 0=black, 1=red, 2=green, 628colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5763=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6293=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
577names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
578 631
579Colours higher than 15 cannot be set using resources (yet), but can be 632Colours higher than 15 cannot be set using resources (yet), but can be
580changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
581 634
582Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
593=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
594 647
595Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
596foreground colour is the default. 649foreground colour is the default.
597 650
598=item B<colorRV:> I<colour>
599
600Use the specified colour as the background for reverse video characters
601when OPTION_HC is disabled (--disable-frills).
602
603=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
604 652
605If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
606itself. If unset, use the foreground colour. 654itself. If unset, use the foreground colour.
655
656=item B<highlightColor:> I<colour>
657
658If set, use the specified colour as the background for highlighted
659characters. If unset, use reverse video.
660
661=item B<highlightTextColor:> I<colour>
662
663If set and highlightColor is set, use the specified colour as the
664foreground for highlighted characters.
607 665
608=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
609 667
610Use the specified colour for the cursor. The default is to use the 668Use the specified colour for the cursor. The default is to use the
611foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
618 676
619=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
620 678
621B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
622option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
623B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
624 682
625=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
626 684
627B<True>: specify that jump scrolling should be used. When receiving lots 685B<True>: specify that jump scrolling should be used. When receiving lots
628of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 686of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
642 700
643B<False>: specify that everything is to be displayed, even 701B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the 702if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>. 703monitor to display anything); option B<+ss>.
646 704
647=item B<inheritPixmap:> I<boolean> 705=item B<transparent:> I<boolean>
648 706
649B<True>: make the background inherit the parent windows' pixmap, giving 707Turn on/off illusion of a transparent window background.
650artificial transparency. B<False>: do not inherit the parent windows'
651pixmap.
652 708
653I<Please note that transparency of any kind if completely unsupported by 709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654the author. Don't bug him with installation questions!> 710future versions.
711
712I<Please address all transparency related issues to Sasha Vasko at
713sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
655 714
656=item B<fading:> I<number> 715=item B<fading:> I<number>
657 716
658Fade the text by the given percentage when focus is lost; option B<-fade>. 717Fade the text by the given percentage when focus is lost; option B<-fade>.
659 718
676 735
677Specify background blending type; option B<-blt>. 736Specify background blending type; option B<-blt>.
678 737
679=item B<blurRadius:> I<number> 738=item B<blurRadius:> I<number>
680 739
681Apply Gaussian Blurr with the specified radius to the transparent 740Apply gaussian blur with the specified radius to the transparent
682background image; option B<-blr>. 741background image; option B<-blr>.
742
743=item B<iconFile:> I<file>
744
745Set the application icon pixmap; option B<-icon>.
683 746
684=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
685 748
686Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
687 750
695The colour of the border around the text area and between the scrollbar 758The colour of the border around the text area and between the scrollbar
696and the text. 759and the text.
697 760
698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699 762
700Use the specified image file for the background and also optionally 763Use the specified image file for the background and also
701specify its scaling with a geometry string B<WxH+X+Y>, 764optionally specify its scaling with a geometry string B<WxH+X+Y>,
702in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 765(default C<0x0+50+50>) in which B<"W" / "H"> specify the
703and B<"X" / "Y"> locate the image centre (percent). 766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
704A scale of 0 displays the image with tiling. A scale of 1 displays the 767centre (percent). A scale of 0 displays the image with tiling. A scale
705image without any scaling. A scale of 2 to 9 specifies an integer 768of 1 displays the image without any scaling. A scale of 2 to 9 specifies
706number of images in that direction. No image will be magnified beyond 769an integer number of images in that direction. No image will be magnified
70710 times its original size. The maximum permitted scale is 1000. 770beyond 10 times its original size. The maximum permitted scale is 1000.
708Additional operations can be specified after colon B<:op1:op2...>. 771Additional operations can be specified after colon B<:op1:op2...>.
709Supported operations are: 772Supported operations are:
773
710 B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0, 774 tile force background image to be tiled and not scaled. Equivalent to 0x0
711 B<"propscale"> - will scale image keeping proportions, 775 propscale will scale image keeping proportions
712 B<"auto"> - will scale image to match window size. Equivalent to 100x100; 776 auto will scale image to match window size. Equivalent to 100x100
713 B<"hscale"> - will scale image horizontally to the window size; 777 hscale will scale image horizontally to the window size
714 B<"vscale"> - will scale image vertically to the window size; 778 vscale will scale image vertically to the window size
715 B<"scale"> - will scale image to match window size; 779 scale will scale image to match window size
716 B<"root"> - will tile image as if it was a root window background, auto-adjusting 780 root will tile image as if it was a root window background, auto-adjusting
717 whenever terminal window moves. 781 whenever terminal window moves
718 782
719If used in conjunction with B<-tr> option - specified pixmap will be 783If used in conjunction with B<-tr> option, the specified pixmap will be
720blended over transparency image using either alpha-blending, or any 784blended over transparency image using either alpha-blending, or any
721other blending type, specified with B<-blt "type"> option. 785other blending type, specified with B<-blt "type"> option.
722[default 0x0+50+50]
723 786
724=item B<path:> I<path> 787=item B<path:> I<path>
725 788
726Specify the colon-delimited search path for finding background image files. 789Specify the colon-delimited search path for finding background image files.
727 790
754it is named first) and thus defines the character cell grid to be 9 pixels 817it is named first) and thus defines the character cell grid to be 9 pixels
755wide and 15 pixels high. 818wide and 15 pixels high.
756 819
757The second font is just used to add additional unicode characters not in 820The second font is just used to add additional unicode characters not in
758the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
759the bold version of the font does contain less characters, so this is a 822the bold version of the font does contain fewer characters, so this is a
760useful supplement. 823useful supplement.
761 824
762The third font is an Xft font with aliasing turned off, and the characters 825The third font is an Xft font with aliasing turned off, and the characters
763are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 826are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
764contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
788text font will being used for the given style. 851text font will being used for the given style.
789 852
790=item B<intensityStyles:> I<boolean> 853=item B<intensityStyles:> I<boolean>
791 854
792When font styles are not enabled, or this option is enabled (B<True>, 855When font styles are not enabled, or this option is enabled (B<True>,
793option B<-is>, the default), bold and italic font styles imply high 856option B<-is>, the default), bold/blink font styles imply high
794intensity foreground/background colours. Disabling this option (B<False>, 857intensity foreground/background colours. Disabling this option (B<False>,
795option B<+is>) disables this behaviour, the high intensity colours are not 858option B<+is>) disables this behaviour, the high intensity colours are not
796reachable. 859reachable.
797 860
798=item B<selectstyle:> I<mode>
799
800Set mouse selection style to B<old> which is 2.20, B<oldword> which
801is xterm style with 2.20 old word selection, or anything else which
802gives xterm style selection. Only effective when the original (non-perl)
803selection code is in use.
804
805=item B<scrollstyle:> I<mode>
806
807Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
808the author's favourite.
809
810=item B<title:> I<string> 861=item B<title:> I<string>
811 862
812Set window title string, the default title is the command-line 863Set window title string, the default title is the command-line
813specified after the B<-e> option, if any, otherwise the application 864specified after the B<-e> option, if any, otherwise the application
814name; option B<-title>. 865name; option B<-title>.
827=item B<urgentOnBell:> I<boolean> 878=item B<urgentOnBell:> I<boolean>
828 879
829B<True>: set the urgency hint for the wm on receipt of a bell character. 880B<True>: set the urgency hint for the wm on receipt of a bell character.
830B<False>: do not set the urgency hint [default]. 881B<False>: do not set the urgency hint [default].
831 882
883@@RXVT_NAME@@ resets the urgency hint on every focus change.
884
832=item B<visualBell:> I<boolean> 885=item B<visualBell:> I<boolean>
833 886
834B<True>: use visual bell on receipt of a bell character; option B<-vb>. 887B<True>: use visual bell on receipt of a bell character; option B<-vb>.
835B<False>: no visual bell [default]; option B<+vb>. 888B<False>: no visual bell [default]; option B<+vb>.
836 889
858 911
859 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 912 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
860 913
861This creates a new file in your home directory with the screen contents 914This creates a new file in your home directory with the screen contents
862every time you hit C<Print>. 915every time you hit C<Print>.
916
917=item B<scrollstyle:> I<mode>
918
919Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
920the author's favourite.
863 921
864=item B<scrollBar:> I<boolean> 922=item B<scrollBar:> I<boolean>
865 923
866B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 924B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
867disable the scrollbar; option B<+sb>. 925disable the scrollbar; option B<+sb>.
955=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
956 1014
957B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1015B<True>: blink the cursor. B<False>: do not blink the cursor [default];
958option B<-bc>. 1016option B<-bc>.
959 1017
1018=item B<cursorUnderline:> I<boolean>
1019
1020B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1021option B<-uc>.
1022
960=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
961 1024
962B<True>: blank the pointer when a key is pressed or after a set number 1025B<True>: blank the pointer when a key is pressed or after a set number
963of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
964[default]. 1027[default].
1000will be created). In this mode, characters outside ISO-8859-1 can be used. 1063will be created). In this mode, characters outside ISO-8859-1 can be used.
1001 1064
1002When the selection extension is not used, only ISO-8859-1 characters can 1065When the selection extension is not used, only ISO-8859-1 characters can
1003be used. If not specified, the built-in default is used: 1066be used. If not specified, the built-in default is used:
1004 1067
1005B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1068B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1006 1069
1007=item B<preeditType:> I<style> 1070=item B<preeditType:> I<style>
1008 1071
1009B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1072B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1010 1073
1066 1129
1067=item B<secondaryScroll:> I<boolean> 1130=item B<secondaryScroll:> I<boolean>
1068 1131
1069Turn on/off secondary screen scroll (default enabled). If this 1132Turn on/off secondary screen scroll (default enabled). If this
1070option is enabled, scrolls on the secondary screen will change the 1133option is enabled, scrolls on the secondary screen will change the
1071scrollback buffer and switching to/from the secondary screen will 1134scrollback buffer and, when secondaryScreen is off, switching
1072instead scroll the screen up. 1135to/from the secondary screen will instead scroll the screen up.
1073 1136
1074=item B<hold>: I<boolean> 1137=item B<hold>: I<boolean>
1075 1138
1076Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1139Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1077will not immediately destroy its window when the program executed within 1140will not immediately destroy its window when the program executed within
1078it exits. Instead, it will wait till it is being killed or closed by the 1141it exits. Instead, it will wait till it is being killed or closed by the
1079user. 1142user.
1143
1144=item B<chdir>: I<path>
1145
1146Sets the working directory for the shell (or the command specified via
1147B<-e>). The I<path> must be an absolute path and it must exist for
1148@@RXVT_NAME@@ to start. If it isn't specified then the current working
1149directory will be used; option B<-cd>.
1080 1150
1081=item B<keysym.>I<sym>: I<string> 1151=item B<keysym.>I<sym>: I<string>
1082 1152
1083Compile I<frills>: Associate I<string> with keysym I<sym>. The 1153Compile I<frills>: Associate I<string> with keysym I<sym>. The
1084intervening resource name B<keysym.> cannot be omitted. 1154intervening resource name B<keysym.> cannot be omitted.
1123when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1124 1194
1125 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1195 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1126 1196
1127If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1197If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1128is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1198is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1129manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1130C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1131 1201
1132 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1133 1203
1191all instances, while B<perl-ext> is used for specific instances. 1261all instances, while B<perl-ext> is used for specific instances.
1192 1262
1193=item B<perl-eval>: I<string> 1263=item B<perl-eval>: I<string>
1194 1264
1195Perl code to be evaluated when all extensions have been registered. See 1265Perl code to be evaluated when all extensions have been registered. See
1196the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1266the @@RXVT_NAME@@perl(3) manpage.
1197will be ignored when running setuid/setgid.
1198 1267
1199=item B<perl-lib>: I<path> 1268=item B<perl-lib>: I<path>
1200 1269
1201Colon-separated list of additional directories that hold extension 1270Colon-separated list of additional directories that hold extension
1202scripts. When looking for extensions specified by the C<perl> resource, 1271scripts. When looking for extensions specified by the C<perl> resource,
1203@@RXVT_NAME@@ will first look in these directories and then in 1272@@RXVT_NAME@@ will first look in these directories and then in
1204F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1273F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1205will be ignored when running setuid/setgid.
1206 1274
1207See the @@RXVT_NAME@@perl(3) manpage. 1275See the @@RXVT_NAME@@perl(3) manpage.
1208 1276
1209=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1277=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1210 1278
1232 1300
1233=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1234 1302
1235Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1236it almost invisible to window managers; option B<-override-redirect>. 1304it almost invisible to window managers; option B<-override-redirect>.
1305
1306=item B<iso14755:> I<boolean>
1307
1308Turn on/off ISO 14755 (default enabled).
1237 1309
1238=item B<iso14755_52:> I<boolean> 1310=item B<iso14755_52:> I<boolean>
1239 1311
1240Turn on/off ISO 14755 5.2 mode (default enabled). 1312Turn on/off ISO 14755 5.2 mode (default enabled).
1241 1313
1384B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1456B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1385it can be seen via the I<who(1)> command, and can accept messages. To 1457it can be seen via the I<who(1)> command, and can accept messages. To
1386allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1458allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1387on some systems or setgid to root or to some other group on others. 1459on some systems or setgid to root or to some other group on others.
1388 1460
1389=head1 COLORS AND GRAPHICS 1461=head1 COLOURS AND GRAPHICS
1390 1462
1391In addition to the default foreground and background colours, 1463In addition to the default foreground and background colours,
1392B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1464B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1393high-intensity bold/blink versions of the same). Here is a list of the 1465high-intensity (potentially bold/blink) versions of the same, and 72 (or
1394colours with their names. 1466240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1467cube plus a 8 (24) colour greyscale ramp.
1468
1469Here is a list of the ANSI colours with their names.
1395 1470
1396=begin table 1471=begin table
1397 1472
1398 B<color0> (black) = Black 1473 B<color0> (black) = Black
1399 B<color1> (red) = Red3 1474 B<color1> (red) = Red3
1419It is also possible to specify the colour values of B<foreground>, 1494It is also possible to specify the colour values of B<foreground>,
1420B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1495B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1421a number 0-15, as a convenient shorthand to reference the colour name of 1496a number 0-15, as a convenient shorthand to reference the colour name of
1422color0-color15. 1497color0-color15.
1423 1498
1424In addition to the colours defined above, @@RXVT_NAME@@ offers an 1499The following text gives values for the standard 88 colour mode (and
1425additional 72 colours. The first 64 of those (with indices 16 to 79) 1500values for the 256 colour mode in parentheses).
1426consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
142716>), followed by 8 additional shades of gray (with indices 80 to 87).
1428 1501
1502The RGB cube uses indices 16..79 (16..231) using the following formulas:
1503
1504 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1505 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1506
1507The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1508steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1509the RGB cube.
1510
1429Together, all those colours implement the 88 colour xterm colours. Only 1511Together, all those colours implement the 88 (256) colour xterm
1430the first 16 can be changed using resources currently, the rest can only 1512colours. Only the first 16 can be changed using resources currently, the
1431be changed via command sequences ("escape codes"). 1513rest can only be changed via command sequences ("escape codes").
1514
1515Applications are advised to use terminfo or command sequences to discover
1516number and RGB values of all colours (yes, you can query this...).
1432 1517
1433Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1518Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1434always swapping the foreground/background colours. This is in contrast to 1519always swapping the foreground/background colours. This is in contrast to
1435I<xterm>(1) where the colours are only swapped if they have not otherwise 1520I<xterm>(1) where the colours are only swapped if they have not otherwise
1436been specified. For example, 1521been specified. For example,
1437 1522
1438=over 4
1439
1440=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1523 @@RXVT_NAME@@ -fg Black -bg White -rv
1441 1524
1442would yield White on Black, while on I<xterm>(1) it would yield Black 1525would yield White on Black, while on I<xterm>(1) it would yield Black on
1443on White. 1526White.
1444
1445=back
1446 1527
1447=head2 ALPHA CHANNEL SUPPORT 1528=head2 ALPHA CHANNEL SUPPORT
1448 1529
1449If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1530If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1450their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1531their act together, rxvt-unicode will do it's own alpha channel management:
1451(recommended, but B<MUST> have 4 digits/component) colour specifications, 1532
1452in addition to the ones provided by X, where the additional A component 1533You can prefix any colour with an opaquenes percentage enclosed in
1534brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1535(0-100) that specifies the opacity of the colour, where C<0> is completely
1536transparent and C<100> is completely opaque. For example, C<[50]red> is a
1537half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1538is the recommended format to specify transparency values, and works with
1539all ways to specify a colour.
1540
1541For complete control, rxvt-unicode also supports
1542C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1543specifications, where the additional C<aaaa> component specifies opacity
1453specifies opacity (alpha) values. The minimum value of C<0> is completely 1544(alpha) values. The minimum value of C<0000> is completely transparent,
1454transparent). You can also prefix any color with C<[percent]>, where 1545while C<ffff> is completely opaque). The two example colours from
1455C<percent> is a decimal percentage (0-100) that specifies the opacity of 1546earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1456the color, where C<0> is completely transparent and C<100> is completelxy 1547C<rgba:0000/ff00/0000/f332>.
1457opaque.
1458 1548
1459You probably need to specify B<"-depth 32">, too, and have the luck that 1549You probably need to specify B<"-depth 32">, too, to force a visual with
1460your X-server uses ARGB pixel layout, as X is far from just supporting 1550alpha channels, and have the luck that your X-server uses ARGB pixel
1461ARGB visuals out of the box, and rxvt-unicode just fudges around. 1551layout, as X is far from just supporting ARGB visuals out of the box, and
1552rxvt-unicode just fudges around.
1462 1553
1463For example, the following selects an almost completely transparent red 1554For example, the following selects an almost completely transparent black
1464background, and an almost opaque pink foreground: 1555background, and an almost opaque pink foreground:
1465 1556
1466 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1557 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1467 1558
1468I<Please note that transparency of any kind if completely unsupported by 1559When not using a background image, then the interpretation of the
1469the author. Don't bug him with installation questions!> 1560alpha channel is up to your compositing manager (most interpret it as
1561transparency of course).
1562
1563When using a background pixmap or pseudo-transparency, then the background
1564colour will always behave as if it were completely transparent (so the
1565background image shows instead), regardless of how it was specified, while
1566other colours will either be transparent as specified (the background
1567image will show through) on servers supporting the RENDER extension, or
1568fully opaque on servers not supporting the RENDER EXTENSION.
1569
1570Please note that due to bugs in Xft, specifying alpha values might result
1571in garbage being displayed when the X-server does not support the RENDER
1572extension.
1470 1573
1471=head1 ENVIRONMENT 1574=head1 ENVIRONMENT
1472 1575
1473B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1576B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1474 1577
1508C<--with-terminfo=PATH>. 1611C<--with-terminfo=PATH>.
1509 1612
1510=item B<DISPLAY> 1613=item B<DISPLAY>
1511 1614
1512Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1615Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1513display in its child processes. 1616display in its child processes if C<-display> isn't used to override. It
1617defaults to C<:0> if it doesn't exist.
1514 1618
1515=item B<SHELL> 1619=item B<SHELL>
1516 1620
1517The shell to be used for command execution, defaults to C</bin/sh>. 1621The shell to be used for command execution, defaults to C</bin/sh>.
1518 1622
1544 1648
1545=over 4 1649=over 4
1546 1650
1547=item B</usr/lib/X11/rgb.txt> 1651=item B</usr/lib/X11/rgb.txt>
1548 1652
1549Color names. 1653Colour names.
1550 1654
1551=back 1655=back
1552 1656
1553=head1 SEE ALSO 1657=head1 SEE ALSO
1554 1658

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines