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.119 by root, Mon Aug 7 16:04:29 2006 UTC vs.
Revision 1.195 by sf-exg, Sat Apr 30 18:45:38 2011 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/*checkout*/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>
146
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
148background image in addition to tinting it (i.e. B<-tint> must be 153A value of 100 means no shading; resource I<shading>.
149specified, too, e.g. C<-tint white>). 154
155=item B<-blt> I<string>
156
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:
499 562
500 1. system-wide app-defaults file, either locale-dependent OR global
501 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
503 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of 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
570characters.
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. If the RENDER
621B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
622 715
623=item B<shading:> I<number> 716=item B<shading:> I<number>
624 717
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
626image in addition to tinting it. 719A value of 100 means no shading; option B<-sh>.
720
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number>
726
727Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
627 733
628=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
629 735
630Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
631 737
637=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
638 744
639The colour of the border around the text area and between the scrollbar 745The colour of the border around the text area and between the scrollbar
640and the text. 746and the text.
641 747
642=item B<backgroundPixmap:> I<file[;geom]> 748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643 749
644Use the specified XPM file (note the `.xpm' extension is optional) for 750Use the specified image file for the background and also
645the background and also optionally specify its scaling with a geometry 751optionally specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648centre (percent). A scale of 0 displays the image with tiling. A scale 754centre (percent). A scale of 0 displays the image with tiling.
649of 1 displays the image without any scaling. A scale of 2 to 9 755The maximum permitted scale is 1000.
650specifies an integer number of images in that direction. No image will 756Additional operations can be specified after colon B<:op1:op2...>.
651be magnified beyond 10 times its original size. The maximum permitted 757Supported operations are:
652scale is 1000. [default 0x0+50+50] 758
759 tile force background image to be tiled and not scaled. Equivalent to 0x0
760 propscale will scale image keeping proportions
761 auto will scale image to match window size. Equivalent to 100x100
762 hscale will scale image horizontally to the window size
763 vscale will scale image vertically to the window size
764 scale will scale image to match window size
765 root will tile image as if it was a root window background, auto-adjusting
766 whenever terminal window moves
767
768If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
653 772
654=item B<path:> I<path> 773=item B<path:> I<path>
655 774
656Specify the colon-delimited search path for finding XPM files. 775Specify the colon-delimited search path for finding background image files.
657 776
658=item B<font:> I<fontlist> 777=item B<font:> I<fontlist>
659 778
660Select the fonts to be used. This is a comma separated list of font names 779Select 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 780that 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 803it is named first) and thus defines the character cell grid to be 9 pixels
685wide and 15 pixels high. 804wide and 15 pixels high.
686 805
687The second font is just used to add additional unicode characters not in 806The second font is just used to add additional unicode characters not in
688the base font, likewise the third, which is unfortunately non-bold, but 807the 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 808the bold version of the font does contain fewer characters, so this is a
690useful supplement. 809useful supplement.
691 810
692The third font is an Xft font with aliasing turned off, and the characters 811The 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 812are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694contains other characters, but we are not interested in them. 813contains other characters, but we are not interested in them.
718text font will being used for the given style. 837text font will being used for the given style.
719 838
720=item B<intensityStyles:> I<boolean> 839=item B<intensityStyles:> I<boolean>
721 840
722When font styles are not enabled, or this option is enabled (B<True>, 841When font styles are not enabled, or this option is enabled (B<True>,
723option B<-is>, the default), bold and italic font styles imply high 842option B<-is>, the default), bold/blink font styles imply high
724intensity foreground/background colours. Disabling this option (B<False>, 843intensity foreground/background colours. Disabling this option (B<False>,
725option B<+is>) disables this behaviour, the high intensity colours are not 844option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 845reachable.
727 846
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> 847=item B<title:> I<string>
740 848
741Set window title string, the default title is the command-line 849Set window title string, the default title is the command-line
742specified after the B<-e> option, if any, otherwise the application 850specified after the B<-e> option, if any, otherwise the application
743name; option B<-title>. 851name; option B<-title>.
751=item B<mapAlert:> I<boolean> 859=item B<mapAlert:> I<boolean>
752 860
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 861B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 862de-iconify (map) on receipt of a bell character [default].
755 863
864=item B<urgentOnBell:> I<boolean>
865
866B<True>: set the urgency hint for the wm on receipt of a bell character.
867B<False>: do not set the urgency hint [default].
868
869@@RXVT_NAME@@ resets the urgency hint on every focus change.
870
756=item B<visualBell:> I<boolean> 871=item B<visualBell:> I<boolean>
757 872
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 873B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 874B<False>: no visual bell [default]; option B<+vb>.
760 875
782 897
783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 898 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784 899
785This creates a new file in your home directory with the screen contents 900This creates a new file in your home directory with the screen contents
786every time you hit C<Print>. 901every time you hit C<Print>.
902
903=item B<scrollstyle:> I<mode>
904
905Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
906the author's favourite.
907
908=item B<thickness:> I<number>
909
910Set the scrollbar width in pixels.
787 911
788=item B<scrollBar:> I<boolean> 912=item B<scrollBar:> I<boolean>
789 913
790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 914B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791disable the scrollbar; option B<+sb>. 915disable the scrollbar; option B<+sb>.
854=item B<termName:> I<termname> 978=item B<termName:> I<termname>
855 979
856Specifies the terminal type name to be set in the B<TERM> environment 980Specifies the terminal type name to be set in the B<TERM> environment
857variable; option B<-tn>. 981variable; option B<-tn>.
858 982
859=item B<linespace:> I<number> 983=item B<lineSpace:> I<number>
860 984
861Specifies number of lines (pixel height) to insert between each row of 985Specifies number of lines (pixel height) to insert between each row of
862the display [default 0]; option B<-lsp>. 986the display [default 0]; option B<-lsp>.
863 987
864=item B<meta8:> I<boolean> 988=item B<meta8:> I<boolean>
878 1002
879=item B<cursorBlink:> I<boolean> 1003=item B<cursorBlink:> I<boolean>
880 1004
881B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1005B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882option B<-bc>. 1006option B<-bc>.
1007
1008=item B<cursorUnderline:> I<boolean>
1009
1010B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1011option B<-uc>.
883 1012
884=item B<pointerBlank:> I<boolean> 1013=item B<pointerBlank:> I<boolean>
885 1014
886B<True>: blank the pointer when a key is pressed or after a set number 1015B<True>: blank the pointer when a key is pressed or after a set number
887of seconds of inactivity. B<False>: the pointer is always visible 1016of seconds of inactivity. B<False>: the pointer is always visible
901large number (e.g. C<987654321>) to effectively disable the timeout. 1030large number (e.g. C<987654321>) to effectively disable the timeout.
902 1031
903=item B<backspacekey:> I<string> 1032=item B<backspacekey:> I<string>
904 1033
905The string to send when the backspace key is pressed. If set to B<DEC> 1034The string to send when the backspace key is pressed. If set to B<DEC>
906or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1035or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
907(code 8) - which can be reversed with the appropriate DEC private mode 1036(code 8) - which can be reversed with the appropriate DEC private mode
908escape sequence. 1037escape sequence.
909 1038
910=item B<deletekey:> I<string> 1039=item B<deletekey:> I<string>
911 1040
916=item B<cutchars:> I<string> 1045=item B<cutchars:> I<string>
917 1046
918The characters used as delimiters for double-click word selection 1047The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 1048(whitespace delimiting is added automatically if resource is given).
920 1049
921When the selection extension is in use (the default if compiled in, see 1050When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1051in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 1052characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 1053will be created). In this mode, characters outside ISO-8859-1 can be used.
925 1054
926When the selection extension is not used, only ISO-8859-1 characters can 1055When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 1056be used. If not specified, the built-in default is used:
928 1057
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1058B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
930 1059
931=item B<preeditType:> I<style> 1060=item B<preeditType:> I<style>
932 1061
933B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1062B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934 1063
988 1117
989Turn on/off secondary screen (default enabled). 1118Turn on/off secondary screen (default enabled).
990 1119
991=item B<secondaryScroll:> I<boolean> 1120=item B<secondaryScroll:> I<boolean>
992 1121
993Turn on/off secondary screen scroll (default enabled). If the this 1122Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1123option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1124scrollback buffer and, when secondaryScreen is off, switching
996instead scroll the screen up. 1125to/from the secondary screen will instead scroll the screen up.
997 1126
998=item B<hold>: I<boolean> 1127=item B<hold>: I<boolean>
999 1128
1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1129Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001will not immediately destroy its window when the program executed within 1130will not immediately destroy its window when the program executed within
1002it exits. Instead, it will wait till it is being killed or closed by the 1131it exits. Instead, it will wait till it is being killed or closed by the
1003user. 1132user.
1133
1134=item B<chdir>: I<path>
1135
1136Sets the working directory for the shell (or the command specified via
1137B<-e>). The I<path> must be an absolute path and it must exist for
1138@@RXVT_NAME@@ to start. If it isn't specified then the current working
1139directory will be used; option B<-cd>.
1004 1140
1005=item B<keysym.>I<sym>: I<string> 1141=item B<keysym.>I<sym>: I<string>
1006 1142
1007Compile I<frills>: Associate I<string> with keysym I<sym>. The 1143Compile I<frills>: Associate I<string> with keysym I<sym>. The
1008intervening resource name B<keysym.> cannot be omitted. 1144intervening resource name B<keysym.> cannot be omitted.
1022searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1158searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1023omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1159omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1024keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1160keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1025performed in an exact manner; however, the closest match is assured. 1161performed in an exact manner; however, the closest match is assured.
1026 1162
1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1163I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1164number), see RESOURCES in C<man 7 X> for further details.
1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031can start or end with whitespace.
1032
1033Please note that you need to double the C<\> in resource files, as
1034Xlib itself does its own de-escaping (you can use C<\033> instead of
1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1036processing).
1037
1038You can define a range of keysyms in one shot by providing a I<string>
1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1040should be a character not used by the strings.
1041
1042Its usage can be demonstrated by an example:
1043
1044 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1045
1046The above line is equivalent to the following three lines:
1047
1048 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1049 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1050 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1051 1165
1052If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1166If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1053is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1167is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1054example the following means "change the current locale to C<zh_CN.GBK> 1168example the following means "change the current locale to C<zh_CN.GBK>
1055when Control-Meta-c is being pressed": 1169when Control-Meta-c is being pressed":
1056 1170
1057 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1171 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1058 1172
1059If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1173If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1060is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1174is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1061manpage. For example, the F<selection> extension (activated via 1175manpage. For example, the F<selection> extension (activated via
1062C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1176C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1063 1177
1064 URxvt.keysym.M-C-c: perl:selection:rot13 1178 URxvt.keysym.M-C-c: perl:selection:rot13
1065 1179
1066Due the the large number of modifier combinations, a defined key mapping 1180Due the the large number of modifier combinations, a defined key mapping
1067will match if at I<at least> the specified identifiers are being set, and 1181will match if I<at least> the specified identifiers are being set, and
1068no other key mappings with those and more bits are being defined. That 1182no other key mappings with those and more bits are being defined. That
1069means that defining a key map for C<a> will automatically provide 1183means that defining a key map for C<a> will automatically provide
1070definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1184definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1071mappings themselves. 1185mappings themselves.
1072 1186
1123all instances, while B<perl-ext> is used for specific instances. 1237all instances, while B<perl-ext> is used for specific instances.
1124 1238
1125=item B<perl-eval>: I<string> 1239=item B<perl-eval>: I<string>
1126 1240
1127Perl code to be evaluated when all extensions have been registered. See 1241Perl code to be evaluated when all extensions have been registered. See
1128the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1242the @@RXVT_NAME@@perl(3) manpage.
1129will be ignored when running setuid/setgid.
1130 1243
1131=item B<perl-lib>: I<path> 1244=item B<perl-lib>: I<path>
1132 1245
1133Colon-separated list of additional directories that hold extension 1246Colon-separated list of additional directories that hold extension
1134scripts. When looking for extensions specified by the C<perl> resource, 1247scripts. When looking for extensions specified by the C<perl> resource,
1135@@RXVT_NAME@@ will first look in these directories and then in 1248@@RXVT_NAME@@ will first look in these directories and then in
1136F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1249F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1137will be ignored when running setuid/setgid.
1138 1250
1139See the @@RXVT_NAME@@perl(3) manpage. 1251See the @@RXVT_NAME@@perl(3) manpage.
1140 1252
1141=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1253=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142 1254
1154(default: C<M-s>). 1266(default: C<M-s>).
1155 1267
1156=item B<urlLauncher>: I<string> 1268=item B<urlLauncher>: I<string>
1157 1269
1158Specifies the program to be started with a URL argument. Used by the 1270Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions. 1271C<selection-popup> and C<matcher> perl extensions.
1160 1272
1161=item B<transient-for>: I<windowid> 1273=item B<transient-for>: I<windowid>
1162 1274
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1275Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164 1276
1165=item B<override-redirect>: I<boolean> 1277=item B<override-redirect>: I<boolean>
1166 1278
1167Compile I<frills>: Sets override-redirect for the terminal window, making 1279Compile I<frills>: Sets override-redirect for the terminal window, making
1168it almost invisible to window managers; option B<-override-redirect>. 1280it almost invisible to window managers; option B<-override-redirect>.
1281
1282=item B<iso14755:> I<boolean>
1283
1284Turn on/off ISO 14755 (default enabled).
1285
1286=item B<iso14755_52:> I<boolean>
1287
1288Turn on/off ISO 14755 5.2 mode (default enabled).
1169 1289
1170=back 1290=back
1171 1291
1172=head1 THE SCROLLBAR 1292=head1 THE SCROLLBAR
1173 1293
1192application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1312application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1193(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1313(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1194up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1314up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1195respectively. 1315respectively.
1196 1316
1197=head1 TEXT SELECTION AND INSERTION 1317=head1 THE SELECTION: SELECTING AND PASTING TEXT
1198 1318
1199The behaviour of text selection and insertion mechanism is similar to 1319The behaviour of text selection and insertion/pasting mechanism is similar
1200I<xterm>(1). 1320to I<xterm>(1).
1201 1321
1202=over 4 1322=over 4
1203 1323
1204=item B<Selection>: 1324=item B<Selecting>:
1205 1325
1206Left click at the beginning of the region, drag to the end of the region 1326Left click at the beginning of the region, drag to the end of the region
1207and release; Right click to extend the marked region; Left double-click 1327and release; Right click to extend the marked region; Left double-click
1208to select a word; Left triple-click to select the entire logical line 1328to select a word; Left triple-click to select the entire logical line
1209(which can span multiple screen lines), unless modified by resource 1329(which can span multiple screen lines), unless modified by resource
1213(Compile: I<frills>) will create a rectangular selection instead of a 1333(Compile: I<frills>) will create a rectangular selection instead of a
1214normal one. In this mode, every selected row becomes its own line in the 1334normal one. In this mode, every selected row becomes its own line in the
1215selection, and trailing whitespace is visually underlined and removed from 1335selection, and trailing whitespace is visually underlined and removed from
1216the selection. 1336the selection.
1217 1337
1218=item B<Insertion>: 1338=item B<Pasting>:
1219 1339
1220Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1340Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1221window causes the value of the PRIMARY selection (or CLIPBOARD with the 1341window causes the value of the PRIMARY selection (or CLIPBOARD with the
1222Meta modifier) to be inserted as if it had been typed on the keyboard. 1342B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1223 1343
1224Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1344Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225inserted too. 1345inserted too.
1226 1346
1227=back 1347=back
1244 1364
1245=head1 ISO 14755 SUPPORT 1365=head1 ISO 14755 SUPPORT
1246 1366
1247ISO 14755 is a standard for entering and viewing unicode characters 1367ISO 14755 is a standard for entering and viewing unicode characters
1248and character codes using the keyboard. It consists of 4 parts. The 1368and character codes using the keyboard. It consists of 4 parts. The
1249first part is available rxvt-unicode has been compiled with 1369first part is available if rxvt-unicode has been compiled with
1250C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1370C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1251with C<--enable-iso14755>. 1371with C<--enable-iso14755>.
1252 1372
1253=over 4 1373=over 4
1254 1374
1312B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1432B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1313it can be seen via the I<who(1)> command, and can accept messages. To 1433it can be seen via the I<who(1)> command, and can accept messages. To
1314allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1434allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1315on some systems or setgid to root or to some other group on others. 1435on some systems or setgid to root or to some other group on others.
1316 1436
1317=head1 COLORS AND GRAPHICS 1437=head1 COLOURS AND GRAPHICS
1318 1438
1319In addition to the default foreground and background colours, 1439In addition to the default foreground and background colours,
1320B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1440B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1321high-intensity bold/blink versions of the same). Here is a list of the 1441high-intensity (potentially bold/blink) versions of the same, and 72 (or
1322colours with their names. 1442240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1443cube plus a 8 (24) colour greyscale ramp.
1444
1445Here is a list of the ANSI colours with their names.
1323 1446
1324=begin table 1447=begin table
1325 1448
1326 B<color0> (black) = Black 1449 B<color0> (black) = Black
1327 B<color1> (red) = Red3 1450 B<color1> (red) = Red3
1347It is also possible to specify the colour values of B<foreground>, 1470It is also possible to specify the colour values of B<foreground>,
1348B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1471B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1349a number 0-15, as a convenient shorthand to reference the colour name of 1472a number 0-15, as a convenient shorthand to reference the colour name of
1350color0-color15. 1473color0-color15.
1351 1474
1352In addition to the colours defined above, @@RXVT_NAME@@ offers an 1475The following text gives values for the standard 88 colour mode (and
1353additional 72 colours. The first 64 of those (with indices 16 to 79) 1476values for the 256 colour mode in parentheses).
1354consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135516>), followed by 8 additional shades of gray (with indices 80 to 87).
1356 1477
1478The RGB cube uses indices 16..79 (16..231) using the following formulas:
1479
1480 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1481 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1482
1483The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1484steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1485the RGB cube.
1486
1357Together, all those colours implement the 88 colour xterm colours. Only 1487Together, all those colours implement the 88 (256) colour xterm
1358the first 16 can be changed using resources currently, the rest can only 1488colours. Only the first 16 can be changed using resources currently, the
1359be changed via command sequences ("escape codes"). 1489rest can only be changed via command sequences ("escape codes").
1490
1491Applications are advised to use terminfo or command sequences to discover
1492number and RGB values of all colours (yes, you can query this...).
1360 1493
1361Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1494Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1362always swapping the foreground/background colours. This is in contrast to 1495always swapping the foreground/background colours. This is in contrast to
1363I<xterm>(1) where the colours are only swapped if they have not otherwise 1496I<xterm>(1) where the colours are only swapped if they have not otherwise
1364been specified. For example, 1497been specified. For example,
1365 1498
1366=over 4
1367
1368=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1499 @@RXVT_NAME@@ -fg Black -bg White -rv
1369 1500
1370would yield White on Black, while on I<xterm>(1) it would yield Black 1501would yield White on Black, while on I<xterm>(1) it would yield Black on
1371on White. 1502White.
1372
1373=back
1374 1503
1375=head2 ALPHA CHANNEL SUPPORT 1504=head2 ALPHA CHANNEL SUPPORT
1376 1505
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1506If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1507their act together, rxvt-unicode will do it's own alpha channel management:
1379(recommended, but B<MUST> have 4 digits/component) colour specifications, 1508
1380in addition to the ones provided by X, where the additional A component 1509You can prefix any colour with an opaqueness percentage enclosed in
1510brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1511(0-100) that specifies the opacity of the colour, where C<0> is completely
1512transparent and C<100> is completely opaque. For example, C<[50]red> is a
1513half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1514is the recommended format to specify transparency values, and works with
1515all ways to specify a colour.
1516
1517For complete control, rxvt-unicode also supports
1518C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1519specifications, where the additional C<aaaa> component specifies opacity
1381specifies opacity (alpha) values. The minimum value of C<0> is completely 1520(alpha) values. The minimum value of C<0000> is completely transparent,
1382transparent). You can also prefix any color with C<[a]>, where C<a> is on 1521while C<ffff> is completely opaque). The two example colours from
1383to four hex digits specifiying the opacity value. 1522earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1523C<rgba:0000/ff00/0000/f332>.
1384 1524
1385You probably need to specify B<"-depth 32">, too, and have the luck that 1525You probably need to specify B<"-depth 32">, too, to force a visual with
1386your X-server uses ARGB pixel layout, as X is far from just supporting 1526alpha channels, and have the luck that your X-server uses ARGB pixel
1387ARGB visuals out of the box, and rxvt-unicode just fudges around. 1527layout, as X is far from just supporting ARGB visuals out of the box, and
1528rxvt-unicode just fudges around.
1388 1529
1389For example, the following selects an almost completely transparent red 1530For example, the following selects an almost completely transparent black
1390background, and an almost opaque pink foreground: 1531background, and an almost opaque pink foreground:
1391 1532
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1533 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1393 1534
1394I<Please note that transparency of any kind if completely unsupported by 1535When not using a background image, then the interpretation of the
1395the author. Don't bug him with installation questions!> 1536alpha channel is up to your compositing manager (most interpret it as
1537transparency of course).
1538
1539When using a background pixmap or pseudo-transparency, then the background
1540colour will always behave as if it were completely transparent (so the
1541background image shows instead), regardless of how it was specified, while
1542other colours will either be transparent as specified (the background
1543image will show through) on servers supporting the RENDER extension, or
1544fully opaque on servers not supporting the RENDER EXTENSION.
1545
1546Please note that due to bugs in Xft, specifying alpha values might result
1547in garbage being displayed when the X-server does not support the RENDER
1548extension.
1396 1549
1397=head1 ENVIRONMENT 1550=head1 ENVIRONMENT
1398 1551
1399B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1552B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1400 1553
1406resources or on the command line. 1559resources or on the command line.
1407 1560
1408=item B<COLORTERM> 1561=item B<COLORTERM>
1409 1562
1410Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1563Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1411compiled with XPM support, and optionally with the added extension 1564compiled with background image support, and optionally with the added
1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1565extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1566screen.
1413 1567
1414=item B<COLORFGBG> 1568=item B<COLORFGBG>
1415 1569
1416Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1570Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1417the colour code used as default foreground/text colour (or the string 1571the colour code used as default foreground/text colour (or the string
1418C<default> to indicate that the default-colour escape sequence is to be 1572C<default> to indicate that the default-colour escape sequence is to be
1419used), C<bg> is the colour code used as default background colour (or the 1573used), C<bg> is the colour code used as default background colour (or the
1420string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1574string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1421was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1575was compiled with background image support. Libraries like C<ncurses>
1422(and do) use this information to optimize screen output. 1576and C<slang> can (and do) use this information to optimize screen output.
1423 1577
1424=item B<WINDOWID> 1578=item B<WINDOWID>
1425 1579
1426Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1580Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1427window, which usually has subwindows for the scrollbar, the terminal 1581window, which usually has subwindows for the scrollbar, the terminal
1433C<--with-terminfo=PATH>. 1587C<--with-terminfo=PATH>.
1434 1588
1435=item B<DISPLAY> 1589=item B<DISPLAY>
1436 1590
1437Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1591Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1438display in its child processes. 1592display in its child processes if C<-display> isn't used to override. It
1593defaults to C<:0> if it doesn't exist.
1439 1594
1440=item B<SHELL> 1595=item B<SHELL>
1441 1596
1442The shell to be used for command execution, defaults to C</bin/sh>. 1597The shell to be used for command execution, defaults to C</bin/sh>.
1443 1598
1444=item B<RXVT_SOCKET> 1599=item B<RXVT_SOCKET>
1445 1600
1446The unix domain socket path used by @@RXVT_NAME@@c(1) and 1601The unix domain socket path used by @@RXVT_NAME@@c(1) and
1447@@RXVT_NAME@@d(1). 1602@@RXVT_NAME@@d(1).
1448 1603
1449Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1604Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1450 1605
1451=item B<HOME> 1606=item B<HOME>
1452 1607
1453Used to locate the default directory for the unix domain socket for 1608Used to locate the default directory for the unix domain socket for
1454daemon communications and to locate various resource files (such as 1609daemon communications and to locate various resource files (such as
1455C<.Xdefaults>) 1610C<.Xdefaults>)
1456 1611
1457=item B<XAPPLRESDIR> 1612=item B<XAPPLRESDIR>
1458 1613
1459Directory where various X resource files are being located. 1614Directory where application-specific X resource files are located.
1460 1615
1461=item B<XENVIRONMENT> 1616=item B<XENVIRONMENT>
1462 1617
1463If set and accessible, gives the name of a X resource file to be loaded by 1618If set and accessible, gives the name of a X resource file to be loaded by
1464@@RXVT_NAME@@. 1619@@RXVT_NAME@@.
1469 1624
1470=over 4 1625=over 4
1471 1626
1472=item B</usr/lib/X11/rgb.txt> 1627=item B</usr/lib/X11/rgb.txt>
1473 1628
1474Color names. 1629Colour names.
1475 1630
1476=back 1631=back
1477 1632
1478=head1 SEE ALSO 1633=head1 SEE ALSO
1479 1634
1518Project Coordinator (changes.txt 2.21a to 2.4.5) 1673Project Coordinator (changes.txt 2.21a to 2.4.5)
1519 1674
1520=item Geoff Wing L<< <gcw@pobox.com> >> 1675=item Geoff Wing L<< <gcw@pobox.com> >>
1521 1676
1522Rewrote screen display and text selection routines. 1677Rewrote screen display and text selection routines.
1523 1678
1524Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1679Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1525 1680
1526=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1681=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1527 1682
1528Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1683Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1530 1685
1531Project Coordinator (Changes 1.0 -) 1686Project Coordinator (Changes 1.0 -)
1532 1687
1533=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1688=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1534 1689
1535Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1690pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1536 1691
1537=back 1692=back
1538 1693

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines