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.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.188 by sf-exg, Thu Nov 4 12:13:20 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
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. 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>
108 116
109Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
110 118
111=item B<-j>|B<+j> 119=item B<-j>|B<+j>
112 120
113Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 122
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
116 124
117Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 126
120I<Please note that transparency of any kind if completely unsupported by 127=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 128
122@@RXVT_NAME@@)!> 129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
123 133
124=item B<-fade> I<number> 134=item B<-fade> I<number>
125 135
126Fade 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
127fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
132Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
133is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
134 144
135=item B<-tint> I<colour> 145=item B<-tint> I<colour>
136 146
137Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
138transparency is enabled with B<-tr> or B<-ip>. This only works for 148resource I<tintColor>.
139non-tiled backgrounds, currently. See also the B<-sh> option that can be
140used to brighten or darken the image in addition to tinting it; resource
141I<tintColor>. Example:
142 149
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 150=item B<-sh> I<number>
144 151
145=item B<-sh> 152Darken (0 .. 100) or lighten (100 .. 200) the transparent background;
153resource I<shading>.
146 154
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 155=item B<-blt> I<string>
148background image in addition to tinting it (i.e. B<-tint> must be 156
149specified, too, e.g. C<-tint white>); resource I<shading>. 157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file>
175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>.
150 179
151=item B<-bg> I<colour> 180=item B<-bg> I<colour>
152 181
153Window background colour; resource B<background>. 182Window background colour; resource B<background>.
154 183
155=item B<-fg> I<colour> 184=item B<-fg> I<colour>
156 185
157Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
158 187
159=item B<-pixmap> I<file[;geom]> 188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160 189
161Compile I<XPM>: Specify XPM file for the background and also optionally 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 191optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
165 194
166=item B<-cr> I<colour> 195=item B<-cr> I<colour>
167 196
168The cursor colour; resource B<cursorColor>. 197The cursor colour; resource B<cursorColor>.
169 198
214italic> >> characters are to be printed. See resource B<boldItalicFont> 243italic> >> characters are to be printed. See resource B<boldItalicFont>
215for details. 244for details.
216 245
217=item B<-is>|B<+is> 246=item B<-is>|B<+is>
218 247
219Compile I<font-styles>: Bold/Italic font styles imply high intensity 248Compile I<font-styles>: Bold/Blink font styles imply high intensity
220foreground/background (default). See resource B<intensityStyles> for 249foreground/background (default). See resource B<intensityStyles> for
221details. 250details.
222 251
223=item B<-name> I<name> 252=item B<-name> I<name>
224 253
242 271
243=item B<-sb>|B<+sb> 272=item B<-sb>|B<+sb>
244 273
245Turn on/off scrollbar; resource B<scrollBar>. 274Turn on/off scrollbar; resource B<scrollBar>.
246 275
276=item B<-sr>|B<+sr>
277
278Put scrollbar on right/left; resource B<scrollBar_right>.
279
280=item B<-st>|B<+st>
281
282Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
283resource B<scrollBar_floating>.
284
247=item B<-si>|B<+si> 285=item B<-si>|B<+si>
248 286
249Turn on/off scroll-to-bottom on TTY output inhibit; resource 287Turn on/off scroll-to-bottom on TTY output inhibit; resource
250B<scrollTtyOutput> has opposite effect. 288B<scrollTtyOutput> has opposite effect.
251 289
257=item B<-sw>|B<+sw> 295=item B<-sw>|B<+sw>
258 296
259Turn on/off scrolling with the scrollback buffer as new lines appear. 297Turn on/off scrolling with the scrollback buffer as new lines appear.
260This only takes effect if B<-si> is also given; resource 298This only takes effect if B<-si> is also given; resource
261B<scrollWithBuffer>. 299B<scrollWithBuffer>.
262
263=item B<-sr>|B<+sr>
264
265Put scrollbar on right/left; resource B<scrollBar_right>.
266
267=item B<-st>|B<+st>
268
269Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270resource B<scrollBar_floating>.
271 300
272=item B<-ptab>|B<+ptab> 301=item B<-ptab>|B<+ptab>
273 302
274If enabled (default), "Horizontal Tab" characters are being stored as 303If enabled (default), "Horizontal Tab" characters are being stored as
275actual wide characters in the screen buffer, which makes it possible to 304actual wide characters in the screen buffer, which makes it possible to
279 308
280=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
281 310
282Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
283 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
284=item B<-iconic> 317=item B<-iconic>
285 318
286Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
287Alternative form is B<-ic>. 320Alternative form is B<-ic>.
288 321
304 337
305=item B<-bl> 338=item B<-bl>
306 339
307Compile I<frills>: Set MWM hints to request a borderless window, i.e. 340Compile I<frills>: Set MWM hints to request a borderless window, i.e.
308if honoured by the WM, the rxvt-unicode window will not have window 341if honoured by the WM, the rxvt-unicode window will not have window
309decorations; resource B<borderLess>. 342decorations; resource B<borderLess>. If the window manager does not
343support MWM hints (e.g. kwin), enables override-redirect mode.
310 344
311=item B<-override-redirect> 345=item B<-override-redirect>
312 346
313Compile I<frills>: Sets override-redirect on the window; resource 347Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>. 348B<override-redirect>.
322 356
323=item B<-lsp> I<number> 357=item B<-lsp> I<number>
324 358
325Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
327B<linespace>. 361B<lineSpace>.
362
363=item B<-letsp> I<number>
364
365Compile I<frills>: Amount to adjust the computed character width by
366to control overall letter spacing. Negative values will tighten up the
367letter spacing, positive values will space letters out more. Useful to
368work around odd font metrics; resource B<letterSpace>.
328 369
329=item B<-tn> I<termname> 370=item B<-tn> I<termname>
330 371
331This option specifies the name of the terminal type to be set in the 372This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
386for more info. 427for more info.
387 428
388=item B<-tcw> 429=item B<-tcw>
389 430
390Change the meaning of triple-click selection with the left mouse 431Change the meaning of triple-click selection with the left mouse
432button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 433in-use. Instead of selecting a full line it will extend the selection to
392end of the logical line only. resource B<tripleclickwords>. 434the end of the logical line only. resource B<tripleclickwords>.
393 435
394=item B<-insecure> 436=item B<-insecure>
395 437
396Enable "insecure" mode, which currently enables most of the escape 438Enable "insecure" mode, which currently enables most of the escape
397sequences that echo strings. See the resource B<insecure> for more 439sequences that echo strings. See the resource B<insecure> for more
417 459
418Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419will not immediately destroy its window when the program executed within 461will not immediately destroy its window when the program executed within
420it exits. Instead, it will wait till it is being killed or closed by the 462it exits. Instead, it will wait till it is being killed or closed by the
421user; resource B<hold>. 463user; resource B<hold>.
464
465=item B<-cd> I<path>
466
467Sets the working directory for the shell (or the command specified via
468B<-e>). The I<path> must be an absolute path and it must exist for
469@@RXVT_NAME@@ to start; resource B<chdir>.
470
471=item B<-xrm> I<string>
472
473Works like the X Toolkit option of the same name, by adding the I<string>
474as if it were specified in a resource file. Resource values specified this
475way take precedence over all other resource specifications.
476
477Note that you need to use the I<same> syntax as in the .Xdefaults file,
478e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
479options can be specified as long-options on the commandline, so use
480of B<-xrm> is mostly limited to cases where you want to specify other
481resources (e.g. for input methods) or for compatibility with other
482programs.
422 483
423=item B<-keysym.>I<sym> I<string> 484=item B<-keysym.>I<sym> I<string>
424 485
425Remap a key symbol. See resource B<keysym>. 486Remap a key symbol. See resource B<keysym>.
426 487
461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 522If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462entries and will not tinker with pty/tty permissions - you have to do that 523entries and will not tinker with pty/tty permissions - you have to do that
463yourself if you want that. 524yourself if you want that.
464 525
465As an extremely special case, specifying C<-1> will completely suppress 526As an extremely special case, specifying C<-1> will completely suppress
466pty/tty operations. 527pty/tty operations, which is probably only useful in conjunction with some
528perl extension that manages the terminal.
467 529
468Here is a example in perl that illustrates how this option can be used (a 530Here is a example in perl that illustrates how this option can be used (a
469longer example is in F<doc/pty-fd>): 531longer example is in F<doc/pty-fd>):
470 532
471 use IO::Pty; 533 use IO::Pty;
485Comma-separated list of perl extension scripts to use (or not to use) in 547Comma-separated list of perl extension scripts to use (or not to use) in
486this terminal instance. See resource B<perl-ext> for details. 548this terminal instance. See resource B<perl-ext> for details.
487 549
488=back 550=back
489 551
490=head1 RESOURCES (available also as long-options) 552=head1 RESOURCES
491 553
492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 554Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493options) compiled into your version. 555options) compiled into your version. All resources are also available as
556long-options.
494 557
495You can set and change the resources using X11 tools like B<xrdb>. Many 558You can set and change the resources using X11 tools like B<xrdb>. Many
496distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
497starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
500 1. system-wide app-defaults file, either locale-dependent OR global 563 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 564 2. app-defaults file in $XAPPLRESDIR
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES for the current screen
504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline
505 569
506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 572common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509configured, while the class name B<URxvt> allows resources unique to 573configured, while the class name B<URxvt> allows resources unique to
519=item B<depth:> I<bitdepth> 583=item B<depth:> I<bitdepth>
520 584
521Compile I<xft>: Attempt to find a visual with the given bit depth; 585Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>. 586option B<-depth>.
523 587
588=item B<buffered:> I<boolean>
589
590Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
591On some card/driver combination enabling it slightly decreases
592performance, on most it greatly helps it. The slowdown is small, so it
593should normally be enabled.
594
524=item B<geometry:> I<geom> 595=item B<geometry:> I<geom>
525 596
526Create the window with the specified X window geometry [default 80x24]; 597Create the window with the specified X window geometry [default 80x24];
527option B<-geometry>. 598option B<-geometry>.
528 599
541Use the specified colour for the colour value I<n>, where 0-7 612Use the specified colour for the colour value I<n>, where 0-7
542corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
543high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
544colours. The canonical names are as follows: 0=black, 1=red, 2=green, 615colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5453=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6163=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
546names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
547 618
548Colours higher than 15 cannot be set using resources (yet), but can be 619Colours higher than 15 cannot be set using resources (yet), but can be
549changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
550 621
551Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 622Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
562=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
563 634
564Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
565foreground colour is the default. 636foreground colour is the default.
566 637
567=item B<colorRV:> I<colour>
568
569Use the specified colour as the background for reverse video characters
570when OPTION_HC is disabled (--disable-frills).
571
572=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
573 639
574If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
642
643=item B<highlightColor:> I<colour>
644
645If set, use the specified colour as the background for highlighted
646characters. If unset, use reverse video.
647
648=item B<highlightTextColor:> I<colour>
649
650If set and highlightColor is set, use the specified colour as the
651foreground for highlighted characters.
576 652
577=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
578 654
579Use the specified colour for the cursor. The default is to use the 655Use the specified colour for the cursor. The default is to use the
580foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
587 663
588=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
589 665
590B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
591option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593 669
594=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
595 671
596B<True>: specify that jump scrolling should be used. When scrolling 672B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
674has been read, resulting in fewer updates while still displaying every
675received line; option B<-j>.
676
598B<False>: specify that smooth scrolling should be used; option B<+j>. 677B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
678force a screen refresh on each new line it received; option B<+j>.
599 679
600=item B<inheritPixmap:> I<boolean> 680=item B<skipScroll:> I<boolean>
601 681
602B<True>: make the background inherit the parent windows' pixmap, giving 682B<True>: (the default) specify that skip scrolling should be used. When
603artificial transparency. B<False>: do not inherit the parent windows' 683receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604pixmap. 684(around 60 times per second), resulting in far fewer updates. This can
685result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
686option B<-ss>.
605 687
606I<Please note that transparency of any kind if completely unsupported by 688B<False>: specify that everything is to be displayed, even
607the author. Don't bug him with installation questions!> 689if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>.
691
692=item B<transparent:> I<boolean>
693
694Turn on/off pseudo-transparency by using the root pixmap as background.
695
696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
697future versions.
608 698
609=item B<fading:> I<number> 699=item B<fading:> I<number>
610 700
611Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
612 702
615Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
616colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
617 707
618=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
619 709
620Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour; option
621B<-tint>. 711B<-tint>.
622 712
623=item B<shading:> I<number> 713=item B<shading:> I<number>
624 714
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 715Darken (0 .. 100) or lighten (100 .. 200) the transparent background;
626in addition to tinting it; option B<-sh>. 716option B<-sh>.
717
718=item B<blendType:> I<string>
719
720Specify background blending type; option B<-blt>.
721
722=item B<blurRadius:> I<number>
723
724Apply gaussian blur with the specified radius to the transparent
725background; option B<-blr>.
726
727=item B<iconFile:> I<file>
728
729Set the application icon pixmap; option B<-icon>.
627 730
628=item B<scrollColor:> I<colour> 731=item B<scrollColor:> I<colour>
629 732
630Use the specified colour for the scrollbar [default #B2B2B2]. 733Use the specified colour for the scrollbar [default #B2B2B2].
631 734
637=item B<borderColor:> I<colour> 740=item B<borderColor:> I<colour>
638 741
639The colour of the border around the text area and between the scrollbar 742The colour of the border around the text area and between the scrollbar
640and the text. 743and the text.
641 744
642=item B<backgroundPixmap:> I<file[;geom]> 745=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 746
644Use the specified XPM file (note the `.xpm' extension is optional) for 747Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 748optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 749(default C<100x100+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 751centre (percent). A scale of 0 displays the image with tiling.
649of 1 displays the image without any scaling. A scale of 2 to 9 752The maximum permitted scale is 1000.
650specifies an integer number of images in that direction. No image will 753Additional operations can be specified after colon B<:op1:op2...>.
651be magnified beyond 10 times its original size. The maximum permitted 754Supported operations are:
652scale is 1000. [default 0x0+50+50] 755
756 tile force background image to be tiled and not scaled. Equivalent to 0x0
757 propscale will scale image keeping proportions
758 auto will scale image to match window size. Equivalent to 100x100
759 hscale will scale image horizontally to the window size
760 vscale will scale image vertically to the window size
761 scale will scale image to match window size
762 root will tile image as if it was a root window background, auto-adjusting
763 whenever terminal window moves
764
765If used in conjunction with B<-tr> option, the specified pixmap will be
766blended over the transparent background using alpha-blending. If I<afterimage>
767support has been compiled in it is possible to choose other blending
768types with B<-blt "type"> option.
653 769
654=item B<path:> I<path> 770=item B<path:> I<path>
655 771
656Specify the colon-delimited search path for finding XPM files. 772Specify the colon-delimited search path for finding background image files.
657 773
658=item B<font:> I<fontlist> 774=item B<font:> I<fontlist>
659 775
660Select the fonts to be used. This is a comma separated list of font names 776Select the fonts to be used. This is a comma separated list of font names
661that are checked in order when trying to find glyphs for characters. The 777that are checked in order when trying to find glyphs for characters. The
684it is named first) and thus defines the character cell grid to be 9 pixels 800it is named first) and thus defines the character cell grid to be 9 pixels
685wide and 15 pixels high. 801wide and 15 pixels high.
686 802
687The second font is just used to add additional unicode characters not in 803The second font is just used to add additional unicode characters not in
688the base font, likewise the third, which is unfortunately non-bold, but 804the base font, likewise the third, which is unfortunately non-bold, but
689the bold version of the font does contain less characters, so this is a 805the bold version of the font does contain fewer characters, so this is a
690useful supplement. 806useful supplement.
691 807
692The third font is an Xft font with aliasing turned off, and the characters 808The third font is an Xft font with aliasing turned off, and the characters
693are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 809are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694contains other characters, but we are not interested in them. 810contains other characters, but we are not interested in them.
718text font will being used for the given style. 834text font will being used for the given style.
719 835
720=item B<intensityStyles:> I<boolean> 836=item B<intensityStyles:> I<boolean>
721 837
722When font styles are not enabled, or this option is enabled (B<True>, 838When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 839option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 840intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 841option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 842reachable.
727 843
728=item B<selectstyle:> I<mode>
729
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731xterm style with 2.20 old word selection, or anything else which gives
732xterm style selection.
733
734=item B<scrollstyle:> I<mode>
735
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite.
738
739=item B<title:> I<string> 844=item B<title:> I<string>
740 845
741Set window title string, the default title is the command-line 846Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 847specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 848name; option B<-title>.
756=item B<urgentOnBell:> I<boolean> 861=item B<urgentOnBell:> I<boolean>
757 862
758B<True>: set the urgency hint for the wm on receipt of a bell character. 863B<True>: set the urgency hint for the wm on receipt of a bell character.
759B<False>: do not set the urgency hint [default]. 864B<False>: do not set the urgency hint [default].
760 865
866@@RXVT_NAME@@ resets the urgency hint on every focus change.
867
761=item B<visualBell:> I<boolean> 868=item B<visualBell:> I<boolean>
762 869
763B<True>: use visual bell on receipt of a bell character; option B<-vb>. 870B<True>: use visual bell on receipt of a bell character; option B<-vb>.
764B<False>: no visual bell [default]; option B<+vb>. 871B<False>: no visual bell [default]; option B<+vb>.
765 872
787 894
788 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 895 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
789 896
790This creates a new file in your home directory with the screen contents 897This creates a new file in your home directory with the screen contents
791every time you hit C<Print>. 898every time you hit C<Print>.
899
900=item B<scrollstyle:> I<mode>
901
902Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
903the author's favourite.
792 904
793=item B<scrollBar:> I<boolean> 905=item B<scrollBar:> I<boolean>
794 906
795B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 907B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
796disable the scrollbar; option B<+sb>. 908disable the scrollbar; option B<+sb>.
859=item B<termName:> I<termname> 971=item B<termName:> I<termname>
860 972
861Specifies the terminal type name to be set in the B<TERM> environment 973Specifies the terminal type name to be set in the B<TERM> environment
862variable; option B<-tn>. 974variable; option B<-tn>.
863 975
864=item B<linespace:> I<number> 976=item B<lineSpace:> I<number>
865 977
866Specifies number of lines (pixel height) to insert between each row of 978Specifies number of lines (pixel height) to insert between each row of
867the display [default 0]; option B<-lsp>. 979the display [default 0]; option B<-lsp>.
868 980
869=item B<meta8:> I<boolean> 981=item B<meta8:> I<boolean>
883 995
884=item B<cursorBlink:> I<boolean> 996=item B<cursorBlink:> I<boolean>
885 997
886B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 998B<True>: blink the cursor. B<False>: do not blink the cursor [default];
887option B<-bc>. 999option B<-bc>.
1000
1001=item B<cursorUnderline:> I<boolean>
1002
1003B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1004option B<-uc>.
888 1005
889=item B<pointerBlank:> I<boolean> 1006=item B<pointerBlank:> I<boolean>
890 1007
891B<True>: blank the pointer when a key is pressed or after a set number 1008B<True>: blank the pointer when a key is pressed or after a set number
892of seconds of inactivity. B<False>: the pointer is always visible 1009of seconds of inactivity. B<False>: the pointer is always visible
906large number (e.g. C<987654321>) to effectively disable the timeout. 1023large number (e.g. C<987654321>) to effectively disable the timeout.
907 1024
908=item B<backspacekey:> I<string> 1025=item B<backspacekey:> I<string>
909 1026
910The string to send when the backspace key is pressed. If set to B<DEC> 1027The string to send when the backspace key is pressed. If set to B<DEC>
911or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1028or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
912(code 8) - which can be reversed with the appropriate DEC private mode 1029(code 8) - which can be reversed with the appropriate DEC private mode
913escape sequence. 1030escape sequence.
914 1031
915=item B<deletekey:> I<string> 1032=item B<deletekey:> I<string>
916 1033
921=item B<cutchars:> I<string> 1038=item B<cutchars:> I<string>
922 1039
923The characters used as delimiters for double-click word selection 1040The characters used as delimiters for double-click word selection
924(whitespace delimiting is added automatically if resource is given). 1041(whitespace delimiting is added automatically if resource is given).
925 1042
926When the selection extension is in use (the default if compiled in, see 1043When the perl selection extension is in use (the default if compiled
927the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1044in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
928will be created (if the resource exists, otherwise, no regex will be 1045characters will be created (if the resource exists, otherwise, no regex
929created). In this mode, characters outside ISO-8859-1 can be used. 1046will be created). In this mode, characters outside ISO-8859-1 can be used.
930 1047
931When the selection extension is not used, only ISO-8859-1 characters can 1048When the selection extension is not used, only ISO-8859-1 characters can
932be used. If not specified, the built-in default is used: 1049be used. If not specified, the built-in default is used:
933 1050
934B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1051B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
935 1052
936=item B<preeditType:> I<style> 1053=item B<preeditType:> I<style>
937 1054
938B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1055B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
939 1056
995 1112
996=item B<secondaryScroll:> I<boolean> 1113=item B<secondaryScroll:> I<boolean>
997 1114
998Turn on/off secondary screen scroll (default enabled). If this 1115Turn on/off secondary screen scroll (default enabled). If this
999option is enabled, scrolls on the secondary screen will change the 1116option is enabled, scrolls on the secondary screen will change the
1000scrollback buffer and switching to/from the secondary screen will 1117scrollback buffer and, when secondaryScreen is off, switching
1001instead scroll the screen up. 1118to/from the secondary screen will instead scroll the screen up.
1002 1119
1003=item B<hold>: I<boolean> 1120=item B<hold>: I<boolean>
1004 1121
1005Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1122Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1006will not immediately destroy its window when the program executed within 1123will not immediately destroy its window when the program executed within
1007it exits. Instead, it will wait till it is being killed or closed by the 1124it exits. Instead, it will wait till it is being killed or closed by the
1008user. 1125user.
1126
1127=item B<chdir>: I<path>
1128
1129Sets the working directory for the shell (or the command specified via
1130B<-e>). The I<path> must be an absolute path and it must exist for
1131@@RXVT_NAME@@ to start. If it isn't specified then the current working
1132directory will be used; option B<-cd>.
1009 1133
1010=item B<keysym.>I<sym>: I<string> 1134=item B<keysym.>I<sym>: I<string>
1011 1135
1012Compile I<frills>: Associate I<string> with keysym I<sym>. The 1136Compile I<frills>: Associate I<string> with keysym I<sym>. The
1013intervening resource name B<keysym.> cannot be omitted. 1137intervening resource name B<keysym.> cannot be omitted.
1027searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1151searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1028omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1152omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1029keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1153keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1030performed in an exact manner; however, the closest match is assured. 1154performed in an exact manner; however, the closest match is assured.
1031 1155
1032I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1156I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1033C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1157number), see RESOURCES in C<man 7 X> for further details.
1034C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1035C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1036can start or end with whitespace. B<This feature is deprecated and will
1037be removed>.
1038
1039Please note that you need to double the C<\> in resource files, as
1040Xlib itself does its own de-escaping (you can use C<\033> instead of
1041C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1042processing).
1043 1158
1044You can define a range of keysyms in one shot by providing a I<string> 1159You can define a range of keysyms in one shot by providing a I<string>
1045with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1160with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1046should be a character not used by the strings. 1161should be a character not used by the strings.
1047 1162
1061when Control-Meta-c is being pressed": 1176when Control-Meta-c is being pressed":
1062 1177
1063 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1178 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1064 1179
1065If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1180If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1066is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1181is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1067manpage. For example, the F<selection> extension (activated via 1182manpage. For example, the F<selection> extension (activated via
1068C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1183C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1069 1184
1070 URxvt.keysym.M-C-c: perl:selection:rot13 1185 URxvt.keysym.M-C-c: perl:selection:rot13
1071 1186
1072Due the the large number of modifier combinations, a defined key mapping 1187Due the the large number of modifier combinations, a defined key mapping
1073will match if at I<at least> the specified identifiers are being set, and 1188will match if I<at least> the specified identifiers are being set, and
1074no other key mappings with those and more bits are being defined. That 1189no other key mappings with those and more bits are being defined. That
1075means that defining a key map for C<a> will automatically provide 1190means that defining a key map for C<a> will automatically provide
1076definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1191definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1077mappings themselves. 1192mappings themselves.
1078 1193
1129all instances, while B<perl-ext> is used for specific instances. 1244all instances, while B<perl-ext> is used for specific instances.
1130 1245
1131=item B<perl-eval>: I<string> 1246=item B<perl-eval>: I<string>
1132 1247
1133Perl code to be evaluated when all extensions have been registered. See 1248Perl code to be evaluated when all extensions have been registered. See
1134the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1249the @@RXVT_NAME@@perl(3) manpage.
1135will be ignored when running setuid/setgid.
1136 1250
1137=item B<perl-lib>: I<path> 1251=item B<perl-lib>: I<path>
1138 1252
1139Colon-separated list of additional directories that hold extension 1253Colon-separated list of additional directories that hold extension
1140scripts. When looking for extensions specified by the C<perl> resource, 1254scripts. When looking for extensions specified by the C<perl> resource,
1141@@RXVT_NAME@@ will first look in these directories and then in 1255@@RXVT_NAME@@ will first look in these directories and then in
1142F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1256F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1143will be ignored when running setuid/setgid.
1144 1257
1145See the @@RXVT_NAME@@perl(3) manpage. 1258See the @@RXVT_NAME@@perl(3) manpage.
1146 1259
1147=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1260=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1148 1261
1170 1283
1171=item B<override-redirect>: I<boolean> 1284=item B<override-redirect>: I<boolean>
1172 1285
1173Compile I<frills>: Sets override-redirect for the terminal window, making 1286Compile I<frills>: Sets override-redirect for the terminal window, making
1174it almost invisible to window managers; option B<-override-redirect>. 1287it almost invisible to window managers; option B<-override-redirect>.
1288
1289=item B<iso14755:> I<boolean>
1290
1291Turn on/off ISO 14755 (default enabled).
1292
1293=item B<iso14755_52:> I<boolean>
1294
1295Turn on/off ISO 14755 5.2 mode (default enabled).
1175 1296
1176=back 1297=back
1177 1298
1178=head1 THE SCROLLBAR 1299=head1 THE SCROLLBAR
1179 1300
1198application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1319application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1199(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1320(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1200up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1321up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1201respectively. 1322respectively.
1202 1323
1203=head1 TEXT SELECTION AND INSERTION 1324=head1 THE SELECTION: SELECTING AND PASTING TEXT
1204 1325
1205The behaviour of text selection and insertion mechanism is similar to 1326The behaviour of text selection and insertion/pasting mechanism is similar
1206I<xterm>(1). 1327to I<xterm>(1).
1207 1328
1208=over 4 1329=over 4
1209 1330
1210=item B<Selection>: 1331=item B<Selecting>:
1211 1332
1212Left click at the beginning of the region, drag to the end of the region 1333Left click at the beginning of the region, drag to the end of the region
1213and release; Right click to extend the marked region; Left double-click 1334and release; Right click to extend the marked region; Left double-click
1214to select a word; Left triple-click to select the entire logical line 1335to select a word; Left triple-click to select the entire logical line
1215(which can span multiple screen lines), unless modified by resource 1336(which can span multiple screen lines), unless modified by resource
1219(Compile: I<frills>) will create a rectangular selection instead of a 1340(Compile: I<frills>) will create a rectangular selection instead of a
1220normal one. In this mode, every selected row becomes its own line in the 1341normal one. In this mode, every selected row becomes its own line in the
1221selection, and trailing whitespace is visually underlined and removed from 1342selection, and trailing whitespace is visually underlined and removed from
1222the selection. 1343the selection.
1223 1344
1224=item B<Insertion>: 1345=item B<Pasting>:
1225 1346
1226Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1347Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1227window causes the value of the PRIMARY selection (or CLIPBOARD with the 1348window causes the value of the PRIMARY selection (or CLIPBOARD with the
1228Meta modifier) to be inserted as if it had been typed on the keyboard. 1349B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1229 1350
1230Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1351Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1231inserted too. 1352inserted too.
1232 1353
1233=back 1354=back
1250 1371
1251=head1 ISO 14755 SUPPORT 1372=head1 ISO 14755 SUPPORT
1252 1373
1253ISO 14755 is a standard for entering and viewing unicode characters 1374ISO 14755 is a standard for entering and viewing unicode characters
1254and character codes using the keyboard. It consists of 4 parts. The 1375and character codes using the keyboard. It consists of 4 parts. The
1255first part is available rxvt-unicode has been compiled with 1376first part is available if rxvt-unicode has been compiled with
1256C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1377C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1257with C<--enable-iso14755>. 1378with C<--enable-iso14755>.
1258 1379
1259=over 4 1380=over 4
1260 1381
1318B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1439B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1319it can be seen via the I<who(1)> command, and can accept messages. To 1440it can be seen via the I<who(1)> command, and can accept messages. To
1320allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1441allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1321on some systems or setgid to root or to some other group on others. 1442on some systems or setgid to root or to some other group on others.
1322 1443
1323=head1 COLORS AND GRAPHICS 1444=head1 COLOURS AND GRAPHICS
1324 1445
1325In addition to the default foreground and background colours, 1446In addition to the default foreground and background colours,
1326B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1447B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1327high-intensity bold/blink versions of the same). Here is a list of the 1448high-intensity (potentially bold/blink) versions of the same, and 72 (or
1328colours with their names. 1449240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1450cube plus a 8 (24) colour greyscale ramp.
1451
1452Here is a list of the ANSI colours with their names.
1329 1453
1330=begin table 1454=begin table
1331 1455
1332 B<color0> (black) = Black 1456 B<color0> (black) = Black
1333 B<color1> (red) = Red3 1457 B<color1> (red) = Red3
1353It is also possible to specify the colour values of B<foreground>, 1477It is also possible to specify the colour values of B<foreground>,
1354B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1478B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1355a number 0-15, as a convenient shorthand to reference the colour name of 1479a number 0-15, as a convenient shorthand to reference the colour name of
1356color0-color15. 1480color0-color15.
1357 1481
1358In addition to the colours defined above, @@RXVT_NAME@@ offers an 1482The following text gives values for the standard 88 colour mode (and
1359additional 72 colours. The first 64 of those (with indices 16 to 79) 1483values for the 256 colour mode in parentheses).
1360consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
136116>), followed by 8 additional shades of gray (with indices 80 to 87).
1362 1484
1485The RGB cube uses indices 16..79 (16..231) using the following formulas:
1486
1487 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1488 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1489
1490The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1491steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1492the RGB cube.
1493
1363Together, all those colours implement the 88 colour xterm colours. Only 1494Together, all those colours implement the 88 (256) colour xterm
1364the first 16 can be changed using resources currently, the rest can only 1495colours. Only the first 16 can be changed using resources currently, the
1365be changed via command sequences ("escape codes"). 1496rest can only be changed via command sequences ("escape codes").
1497
1498Applications are advised to use terminfo or command sequences to discover
1499number and RGB values of all colours (yes, you can query this...).
1366 1500
1367Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1501Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1368always swapping the foreground/background colours. This is in contrast to 1502always swapping the foreground/background colours. This is in contrast to
1369I<xterm>(1) where the colours are only swapped if they have not otherwise 1503I<xterm>(1) where the colours are only swapped if they have not otherwise
1370been specified. For example, 1504been specified. For example,
1371 1505
1372=over 4
1373
1374=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1506 @@RXVT_NAME@@ -fg Black -bg White -rv
1375 1507
1376would yield White on Black, while on I<xterm>(1) it would yield Black 1508would yield White on Black, while on I<xterm>(1) it would yield Black on
1377on White. 1509White.
1378
1379=back
1380 1510
1381=head2 ALPHA CHANNEL SUPPORT 1511=head2 ALPHA CHANNEL SUPPORT
1382 1512
1383If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1513If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1384their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1514their act together, rxvt-unicode will do it's own alpha channel management:
1385(recommended, but B<MUST> have 4 digits/component) colour specifications, 1515
1386in addition to the ones provided by X, where the additional A component 1516You can prefix any colour with an opaqueness percentage enclosed in
1517brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1518(0-100) that specifies the opacity of the colour, where C<0> is completely
1519transparent and C<100> is completely opaque. For example, C<[50]red> is a
1520half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1521is the recommended format to specify transparency values, and works with
1522all ways to specify a colour.
1523
1524For complete control, rxvt-unicode also supports
1525C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1526specifications, where the additional C<aaaa> component specifies opacity
1387specifies opacity (alpha) values. The minimum value of C<0> is completely 1527(alpha) values. The minimum value of C<0000> is completely transparent,
1388transparent). You can also prefix any color with C<[percent]>, where 1528while C<ffff> is completely opaque). The two example colours from
1389C<percent> is a decimal percentage (0-100) that specifies the opacity of 1529earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1390the color, where C<0> is completely transparent and C<100> is completelxy 1530C<rgba:0000/ff00/0000/f332>.
1391opaque.
1392 1531
1393You probably need to specify B<"-depth 32">, too, and have the luck that 1532You probably need to specify B<"-depth 32">, too, to force a visual with
1394your X-server uses ARGB pixel layout, as X is far from just supporting 1533alpha channels, and have the luck that your X-server uses ARGB pixel
1395ARGB visuals out of the box, and rxvt-unicode just fudges around. 1534layout, as X is far from just supporting ARGB visuals out of the box, and
1535rxvt-unicode just fudges around.
1396 1536
1397For example, the following selects an almost completely transparent red 1537For example, the following selects an almost completely transparent black
1398background, and an almost opaque pink foreground: 1538background, and an almost opaque pink foreground:
1399 1539
1400 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1540 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1401 1541
1402I<Please note that transparency of any kind if completely unsupported by 1542When not using a background image, then the interpretation of the
1403the author. Don't bug him with installation questions!> 1543alpha channel is up to your compositing manager (most interpret it as
1544transparency of course).
1545
1546When using a background pixmap or pseudo-transparency, then the background
1547colour will always behave as if it were completely transparent (so the
1548background image shows instead), regardless of how it was specified, while
1549other colours will either be transparent as specified (the background
1550image will show through) on servers supporting the RENDER extension, or
1551fully opaque on servers not supporting the RENDER EXTENSION.
1552
1553Please note that due to bugs in Xft, specifying alpha values might result
1554in garbage being displayed when the X-server does not support the RENDER
1555extension.
1404 1556
1405=head1 ENVIRONMENT 1557=head1 ENVIRONMENT
1406 1558
1407B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1559B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1408 1560
1414resources or on the command line. 1566resources or on the command line.
1415 1567
1416=item B<COLORTERM> 1568=item B<COLORTERM>
1417 1569
1418Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1570Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1419compiled with XPM support, and optionally with the added extension 1571compiled with background image support, and optionally with the added
1420C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1572extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1573screen.
1421 1574
1422=item B<COLORFGBG> 1575=item B<COLORFGBG>
1423 1576
1424Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1577Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1425the colour code used as default foreground/text colour (or the string 1578the colour code used as default foreground/text colour (or the string
1426C<default> to indicate that the default-colour escape sequence is to be 1579C<default> to indicate that the default-colour escape sequence is to be
1427used), C<bg> is the colour code used as default background colour (or the 1580used), C<bg> is the colour code used as default background colour (or the
1428string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1581string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1429was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1582was compiled with background image support. Libraries like C<ncurses>
1430(and do) use this information to optimize screen output. 1583and C<slang> can (and do) use this information to optimize screen output.
1431 1584
1432=item B<WINDOWID> 1585=item B<WINDOWID>
1433 1586
1434Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1587Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1435window, which usually has subwindows for the scrollbar, the terminal 1588window, which usually has subwindows for the scrollbar, the terminal
1441C<--with-terminfo=PATH>. 1594C<--with-terminfo=PATH>.
1442 1595
1443=item B<DISPLAY> 1596=item B<DISPLAY>
1444 1597
1445Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1598Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1446display in its child processes. 1599display in its child processes if C<-display> isn't used to override. It
1600defaults to C<:0> if it doesn't exist.
1447 1601
1448=item B<SHELL> 1602=item B<SHELL>
1449 1603
1450The shell to be used for command execution, defaults to C</bin/sh>. 1604The shell to be used for command execution, defaults to C</bin/sh>.
1451 1605
1477 1631
1478=over 4 1632=over 4
1479 1633
1480=item B</usr/lib/X11/rgb.txt> 1634=item B</usr/lib/X11/rgb.txt>
1481 1635
1482Color names. 1636Colour names.
1483 1637
1484=back 1638=back
1485 1639
1486=head1 SEE ALSO 1640=head1 SEE ALSO
1487 1641
1526Project Coordinator (changes.txt 2.21a to 2.4.5) 1680Project Coordinator (changes.txt 2.21a to 2.4.5)
1527 1681
1528=item Geoff Wing L<< <gcw@pobox.com> >> 1682=item Geoff Wing L<< <gcw@pobox.com> >>
1529 1683
1530Rewrote screen display and text selection routines. 1684Rewrote screen display and text selection routines.
1531 1685
1532Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1686Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1533 1687
1534=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1688=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1535 1689
1536Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1690Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines