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.92 by root, Wed Jan 11 02:13:55 2006 UTC vs.
Revision 1.143 by ayin, Sat Nov 10 09:40:51 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 108
104Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ss>|B<+ss>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-ip> and it should not be used anymore; resource B<transparent>.
123
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126be phased out in future versions of rxvt!>
127
128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 130
115=item B<-fade> I<number> 131=item B<-fade> I<number>
116 132
117Fade the text by the given percentage when focus is lost. Small values 133Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 134fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 135colour; resource B<fading>.
120 136
121=item B<-fadecolor> I<colour> 137=item B<-fadecolor> I<colour>
122 138
123Fade to this colour when fading is used (see B<-fade>). The default colour 139Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
125 141
126=item B<-tint> I<colour> 142=item B<-tint> I<colour>
127 143
128Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 146non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 147used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 152I<tintColor>. Example:
133 153
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 155
136=item B<-sh> 156=item B<-sh> I<number>
137 157
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 159background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 160resource I<shading>.
161
162=item B<-blt> I<string>
163
164Specify background blending type. If background pixmap is specified
165at the same time as transparency - such pixmap will be blended over
166transparency image, using method specified. Supported values are :
167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170alpha-blending. Compile I<afterimage>; resource I<blendType>.
171
172=item B<-blr> I<HxV>
173
174Apply Gaussian Blur with the specified radii to the transparent
175background image. If single number is specified - both vertical and
176horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
141 180
142=item B<-bg> I<colour> 181=item B<-bg> I<colour>
143 182
144Window background colour; resource B<background>. 183Window background colour; resource B<background>.
145 184
147 186
148Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
149 188
150=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;geom]>
151 190
152Compile I<XPM>: Specify XPM file for the background and also optionally 191Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 192optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
156 195
157=item B<-cr> I<colour> 196=item B<-cr> I<colour>
158 197
159The cursor colour; resource B<cursorColor>. 198The cursor colour; resource B<cursorColor>.
160 199
172resource B<borderColor>. 211resource B<borderColor>.
173 212
174=item B<-fn> I<fontlist> 213=item B<-fn> I<fontlist>
175 214
176Select the fonts to be used. This is a comma separated list of font names 215Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 216that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 217first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 218smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 219font list is always appended to it. See resource B<font> for more details.
181 220
182In short, to specify an X11 core font, just specify it's name or prefix it 221In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 222with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 223e.g.:
185 224
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 225 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 226 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
297 336
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 337Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 338if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 339decorations; resource B<borderLess>.
301 340
341=item B<-override-redirect>
342
343Compile I<frills>: Sets override-redirect on the window; resource
344B<override-redirect>.
345
302=item B<-sbg> 346=item B<-sbg>
303 347
304Compile I<frills>: Disable the usage of the built-in block graphics/line 348Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 349drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs; 350this if you have a good font and want to use its block graphic glyphs;
308 352
309=item B<-lsp> I<number> 353=item B<-lsp> I<number>
310 354
311Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
313B<linespace>. 357B<lineSpace>.
314 358
315=item B<-tn> I<termname> 359=item B<-tn> I<termname>
316 360
317This option specifies the name of the terminal type to be set in the 361This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
372for more info. 416for more info.
373 417
374=item B<-tcw> 418=item B<-tcw>
375 419
376Change the meaning of triple-click selection with the left mouse 420Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 422in-use. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>. 423end of the logical line only. resource B<tripleclickwords>.
379 424
380=item B<-insecure> 425=item B<-insecure>
381 426
382Enable "insecure" mode, which currently enables most of the escape 427Enable "insecure" mode, which currently enables most of the escape
410 455
411Remap a key symbol. See resource B<keysym>. 456Remap a key symbol. See resource B<keysym>.
412 457
413=item B<-embed> I<windowid> 458=item B<-embed> I<windowid>
414 459
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 460Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 461which enables applications to easily embed a terminal.
417 462
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 463Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 464shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 465quite a bit, so don't expect it to keep some specific state. It's best to
423The window will not be destroyed when @@RXVT_NAME@@ exits. 468The window will not be destroyed when @@RXVT_NAME@@ exits.
424 469
425It might be useful to know that @@RXVT_NAME@@ will not close file 470It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 471descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 472can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 473terminal. This works regardless of whether the C<-embed> option was used or
429not. 474not.
430 475
431Here is a short Gtk2-perl snippet that illustrates how this option can be 476Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 477used (a longer example is in F<doc/embed>):
433 478
438 }); 483 });
439 484
440=item B<-pty-fd> I<file descriptor> 485=item B<-pty-fd> I<file descriptor>
441 486
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 487Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 488pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 489useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 490without having to run a program within it.
446 491
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 492If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 493entries and will not tinker with pty/tty permissions - you have to do that
476=head1 RESOURCES (available also as long-options) 521=head1 RESOURCES (available also as long-options)
477 522
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 523Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 524options) compiled into your version.
480 525
481There are two different methods that @@RXVT_NAME@@ can use to get the 526You can set and change the resources using X11 tools like B<xrdb>. Many
482Xresource data: using the X libraries (Xrm*-functions) or internal 527distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 528starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 529with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 530
490 1. system-wide app-defaults file, either locale-dependent OR global 531 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 532 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen 534 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
495 536
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 538names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 539common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504easily configured, while the class name B<URxvt> allows resources 540configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 541B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 542configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 543be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 544settings. The following resources are supported (you might want to
509resources are allowed: 545check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
546extensions not documented here):
510 547
511=over 4 548=over 4
549
550=item B<depth:> I<bitdepth>
551
552Compile I<xft>: Attempt to find a visual with the given bit depth;
553option B<-depth>.
512 554
513=item B<geometry:> I<geom> 555=item B<geometry:> I<geom>
514 556
515Create the window with the specified X window geometry [default 80x24]; 557Create the window with the specified X window geometry [default 80x24];
516option B<-geometry>. 558option B<-geometry>.
553Use the specified colour to display underlined characters when the 595Use the specified colour to display underlined characters when the
554foreground colour is the default. 596foreground colour is the default.
555 597
556=item B<colorRV:> I<colour> 598=item B<colorRV:> I<colour>
557 599
558Use the specified colour as the background for reverse video 600Use the specified colour as the background for reverse video characters
559characters. 601when OPTION_HC is disabled (--disable-frills).
560 602
561=item B<underlineColor:> I<colour> 603=item B<underlineColor:> I<colour>
562 604
563If set, use the specified colour as the colour for the underline 605If set, use the specified colour as the colour for the underline
564itself. If unset, use the foreground colour. 606itself. If unset, use the foreground colour.
580option B<-rv>. B<False>: regular screen colours [default]; option 622option B<-rv>. B<False>: regular screen colours [default]; option
581B<+rv>. See note in B<COLORS AND GRAPHICS> section. 623B<+rv>. See note in B<COLORS AND GRAPHICS> section.
582 624
583=item B<jumpScroll:> I<boolean> 625=item B<jumpScroll:> I<boolean>
584 626
585B<True>: specify that jump scrolling should be used. When scrolling 627B<True>: specify that jump scrolling should be used. When receiving lots
586quickly, fewer screen updates are performed [default]; option B<-j>. 628of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
629has been read, resulting in fewer updates while still displaying every
630received line; option B<-j>.
631
587B<False>: specify that smooth scrolling should be used; option B<+j>. 632B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
633force a screen refresh on each new line it received; option B<+j>.
634
635=item B<skipScroll:> I<boolean>
636
637B<True>: (the default) specify that skip scrolling should be used. When
638receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
639(around 60 times per second), resulting in far fewer updates. This can
640result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
641option B<-ss>.
642
643B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>.
588 646
589=item B<inheritPixmap:> I<boolean> 647=item B<inheritPixmap:> I<boolean>
590 648
591B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: make the background inherit the parent windows' pixmap, giving
592artificial transparency. B<False>: do not inherit the parent windows' 650artificial transparency. B<False>: do not inherit the parent windows'
593pixmap. 651pixmap.
594 652
653I<Please note that transparency of any kind if completely unsupported by
654the author. Don't bug him with installation questions!>
655
595=item B<fading:> I<number> 656=item B<fading:> I<number>
596 657
597Fade the text by the given percentage when focus is lost; option B<-fade>. 658Fade the text by the given percentage when focus is lost; option B<-fade>.
598 659
599=item B<fadeColor:> I<colour> 660=item B<fadeColor:> I<colour>
606Tint the transparent background pixmap with the given colour; option 667Tint the transparent background pixmap with the given colour; option
607B<-tint>. 668B<-tint>.
608 669
609=item B<shading:> I<number> 670=item B<shading:> I<number>
610 671
611Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 672Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
612image in addition to tinting it. 673in addition to tinting it; option B<-sh>.
674
675=item B<blendType:> I<string>
676
677Specify background blending type; option B<-blt>.
678
679=item B<blurRadius:> I<number>
680
681Apply Gaussian Blurr with the specified radius to the transparent
682background image; option B<-blr>.
613 683
614=item B<scrollColor:> I<colour> 684=item B<scrollColor:> I<colour>
615 685
616Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
617 687
625The colour of the border around the text area and between the scrollbar 695The colour of the border around the text area and between the scrollbar
626and the text. 696and the text.
627 697
628=item B<backgroundPixmap:> I<file[;geom]> 698=item B<backgroundPixmap:> I<file[;geom]>
629 699
630Use the specified XPM file (note the `.xpm' extension is optional) for 700Use the specified image file for the background and also optionally
631the background and also optionally specify its scaling with a geometry 701specify its scaling with a geometry string B<WxH+X+Y>,
632string B<WxH+X+Y>, in which B<"W" / "H"> specify the 702in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
633horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 703and B<"X" / "Y"> locate the image centre (percent).
634centre (percent). A scale of 0 displays the image with tiling. A scale 704A scale of 0 displays the image with tiling. A scale of 1 displays the
635of 1 displays the image without any scaling. A scale of 2 to 9 705image without any scaling. A scale of 2 to 9 specifies an integer
636specifies an integer number of images in that direction. No image will 706number of images in that direction. No image will be magnified beyond
637be magnified beyond 10 times its original size. The maximum permitted 70710 times its original size. The maximum permitted scale is 1000.
638scale is 1000. [default 0x0+50+50] 708Special string of B<"auto"> used as a geometry will cause image to be
639 709automatically scaled to match window size.
640=item B<menu:> I<file[;tag]> 710If used in conjunction with B<-tr> option - specified pixmap will be
641 711blended over transparency image using either alpha-blending, or any
642Read in the specified menu file (note the `.menu' extension is 712other blending type, specified with B<-blt "type"> option.
643optional) and also optionally specify a starting tag to find. See the 713[default 0x0+50+50]
644reference documentation for details on the syntax for the menuBar.
645 714
646=item B<path:> I<path> 715=item B<path:> I<path>
647 716
648Specify the colon-delimited search path for finding files (XPM and 717Specify the colon-delimited search path for finding background image files.
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651 718
652=item B<font:> I<fontlist> 719=item B<font:> I<fontlist>
653 720
654Select the fonts to be used. This is a comma separated list of font 721Select the fonts to be used. This is a comma separated list of font names
655names that are used in turn when trying to display Unicode characters. 722that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 723first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 724smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 725font list is always appended to it; option B<-fn>.
659 726
660Each font can either be a standard X11 core font (XLFD) name, with 727Each font can either be a standard X11 core font (XLFD) name, with
661optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 728optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662 729
663In addition, each font can be prefixed with additional hints and 730In addition, each font can be prefixed with additional hints and
665hint currently is C<codeset=codeset-name>, and this is only used for Xft 732hint currently is C<codeset=codeset-name>, and this is only used for Xft
666fonts. 733fonts.
667 734
668For example, this font resource 735For example, this font resource
669 736
670 URxvt*font: 9x15bold,\ 737 URxvt.font: 9x15bold,\
671 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 738 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 739 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 740 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 741 xft:Code2000:antialias=false
675 742
713 780
714=item B<intensityStyles:> I<boolean> 781=item B<intensityStyles:> I<boolean>
715 782
716When font styles are not enabled, or this option is enabled (B<True>, 783When font styles are not enabled, or this option is enabled (B<True>,
717option B<-is>, the default), bold and italic font styles imply high 784option B<-is>, the default), bold and italic font styles imply high
718intensity foreground/backround colours. Disabling this option (B<False>, 785intensity foreground/background colours. Disabling this option (B<False>,
719option B<+is>) disables this behaviour, the high intensity colours are not 786option B<+is>) disables this behaviour, the high intensity colours are not
720reachable. 787reachable.
721 788
722=item B<selectstyle:> I<mode> 789=item B<selectstyle:> I<mode>
723 790
724Set mouse selection style to B<old> which is 2.20, B<oldword> which is 791Set mouse selection style to B<old> which is 2.20, B<oldword> which
725xterm style with 2.20 old word selection, or anything else which gives 792is xterm style with 2.20 old word selection, or anything else which
726xterm style selection. 793gives xterm style selection. Only effective when the original (non-perl)
794selection code is in use.
727 795
728=item B<scrollstyle:> I<mode> 796=item B<scrollstyle:> I<mode>
729 797
730Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 798Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
731the author's favourite. 799the author's favourite.
745=item B<mapAlert:> I<boolean> 813=item B<mapAlert:> I<boolean>
746 814
747B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 815B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
748de-iconify (map) on receipt of a bell character [default]. 816de-iconify (map) on receipt of a bell character [default].
749 817
818=item B<urgentOnBell:> I<boolean>
819
820B<True>: set the urgency hint for the wm on receipt of a bell character.
821B<False>: do not set the urgency hint [default].
822
750=item B<visualBell:> I<boolean> 823=item B<visualBell:> I<boolean>
751 824
752B<True>: use visual bell on receipt of a bell character; option B<-vb>. 825B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753B<False>: no visual bell [default]; option B<+vb>. 826B<False>: no visual bell [default]; option B<+vb>.
754 827
772 845
773The string will be interpreted as if typed into the shell as-is. 846The string will be interpreted as if typed into the shell as-is.
774 847
775Example: 848Example:
776 849
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 850 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 851
779This creates a new file in your home directory with the screen contents 852This creates a new file in your home directory with the screen contents
780everytime you hit C<Print>. 853every time you hit C<Print>.
781 854
782=item B<scrollBar:> I<boolean> 855=item B<scrollBar:> I<boolean>
783 856
784B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 857B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785disable the scrollbar; option B<+sb>. 858disable the scrollbar; option B<+sb>.
807 880
808=item B<scrollWithBuffer:> I<boolean> 881=item B<scrollWithBuffer:> I<boolean>
809 882
810B<True>: scroll with scrollback buffer when tty receives new lines (and 883B<True>: scroll with scrollback buffer when tty receives new lines (and
811B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 884B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
812with scrollback buffer when tty recieves new lines; option B<+sw>. 885with scrollback buffer when tty receives new lines; option B<+sw>.
813 886
814=item B<scrollTtyKeypress:> I<boolean> 887=item B<scrollTtyKeypress:> I<boolean>
815 888
816B<True>: scroll to bottom when a non-special key is pressed. Special keys 889B<True>: scroll to bottom when a non-special key is pressed. Special keys
817are those which are intercepted by rxvt-unicode for special handling and 890are those which are intercepted by rxvt-unicode for special handling and
848=item B<termName:> I<termname> 921=item B<termName:> I<termname>
849 922
850Specifies the terminal type name to be set in the B<TERM> environment 923Specifies the terminal type name to be set in the B<TERM> environment
851variable; option B<-tn>. 924variable; option B<-tn>.
852 925
853=item B<linespace:> I<number> 926=item B<lineSpace:> I<number>
854 927
855Specifies number of lines (pixel height) to insert between each row of 928Specifies number of lines (pixel height) to insert between each row of
856the display [default 0]; option B<-lsp>. 929the display [default 0]; option B<-lsp>.
857 930
858=item B<meta8:> I<boolean> 931=item B<meta8:> I<boolean>
907pressed. If unset it will send the sequence traditionally associated 980pressed. If unset it will send the sequence traditionally associated
908with the B<Execute> key. 981with the B<Execute> key.
909 982
910=item B<cutchars:> I<string> 983=item B<cutchars:> I<string>
911 984
912The characters used as delimiters for double-click word selection. The 985The characters used as delimiters for double-click word selection
913built-in default: 986(whitespace delimiting is added automatically if resource is given).
987
988When the perl selection extension is in use (the default if compiled
989in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
990characters will be created (if the resource exists, otherwise, no regex
991will be created). In this mode, characters outside ISO-8859-1 can be used.
992
993When the selection extension is not used, only ISO-8859-1 characters can
994be used. If not specified, the built-in default is used:
914 995
915B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 996B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
916 997
917=item B<preeditType:> I<style> 998=item B<preeditType:> I<style>
918 999
954default. (Note that many other terminals, including xterm, have these 1035default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 1036sequences enabled by default, which doesn't make it safer, though).
956 1037
957You can enable them by setting this boolean resource or specifying 1038You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 1039B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 1040locale, findfont, icon label and window title requests.
960menubar dispatch.
961 1041
962=item B<modifier:> I<modifier> 1042=item B<modifier:> I<modifier>
963 1043
964Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1044Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1045B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
969 1049
970Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1050Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
971character is passed through. It may contain escape values as described 1051character is passed through. It may contain escape values as described
972in the entry on B<keysym> following. 1052in the entry on B<keysym> following.
973 1053
974=item B<secondaryScreen:> I<bool> 1054=item B<secondaryScreen:> I<boolean>
975 1055
976Turn on/off secondary screen (default enabled). 1056Turn on/off secondary screen (default enabled).
977 1057
978=item B<secondaryScroll:> I<bool> 1058=item B<secondaryScroll:> I<boolean>
979 1059
980Turn on/off secondary screen scroll (default enabled). If the this 1060Turn on/off secondary screen scroll (default enabled). If this
981option is enabled, scrolls on the secondary screen will change the 1061option is enabled, scrolls on the secondary screen will change the
982scrollback buffer and switching to/from the secondary screen will 1062scrollback buffer and switching to/from the secondary screen will
983instead scroll the screen up. 1063instead scroll the screen up.
984 1064
985=item B<hold>: I<bool> 1065=item B<hold>: I<boolean>
986 1066
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1067Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within 1068will not immediately destroy its window when the program executed within
989it exits. Instead, it will wait till it is being killed or closed by the 1069it exits. Instead, it will wait till it is being killed or closed by the
990user. 1070user.
1009searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1089searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1010omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1090omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1011keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1091keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1012performed in an exact manner; however, the closest match is assured. 1092performed in an exact manner; however, the closest match is assured.
1013 1093
1014I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1094I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1095number), see RESOURCES in C<man 7 X> for futher details.
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace.
1019
1020Please note that you need to double the C<\> when using
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1023@@RXVT_NAME@@'s own processing).
1024 1096
1025You can define a range of keysyms in one shot by providing a I<string> 1097You can define a range of keysyms in one shot by providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1098with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027should be a character not used by the strings. 1099should be a character not used by the strings.
1028 1100
1029Its usage can be demonstrated by an example: 1101Its usage can be demonstrated by an example:
1030 1102
1031 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1103 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1095example, C<default,-selection> will use all the default extension except 1167example, C<default,-selection> will use all the default extension except
1096C<selection>. 1168C<selection>.
1097 1169
1098Extension names can also be followed by an argument in angle brackets 1170Extension names can also be followed by an argument in angle brackets
1099(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1171(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1100searchable scorllback to Alt/Meta-s). Mentioning the same extension 1172searchable scrollback to Alt/Meta-s). Mentioning the same extension
1101multiple times with different arguments will pass multiple arguments to 1173multiple times with different arguments will pass multiple arguments to
1102the extension. 1174the extension.
1103 1175
1104Each extension is looked up in the library directories, loaded if 1176Each extension is looked up in the library directories, loaded if
1105necessary, and bound to the current terminal instance. 1177necessary, and bound to the current terminal instance.
1123F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1195F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1124will be ignored when running setuid/setgid. 1196will be ignored when running setuid/setgid.
1125 1197
1126See the @@RXVT_NAME@@perl(3) manpage. 1198See the @@RXVT_NAME@@perl(3) manpage.
1127 1199
1200=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1201
1202Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1203details.
1204
1205=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1206
1207Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1208for details.
1209
1210=item B<searchable-scrollback:> I<keysym>
1211
1212Sets the hotkey that starts the incremental scrollback buffer search
1213(default: C<M-s>).
1214
1128=item B<urlLauncher>: I<string> 1215=item B<urlLauncher>: I<string>
1129 1216
1130Specifies the program to be started with a URL argument. Used by the 1217Specifies the program to be started with a URL argument. Used by the
1131C<selection-popup> and C<mark-urls> perl extensions. 1218C<selection-popup> and C<matcher> perl extensions.
1132 1219
1133=item B<transient-for>: I<windowid> 1220=item B<transient-for>: I<windowid>
1134 1221
1135Sets the WM_TRANSIENT_FOR property to the given window iw. 1222Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1223
1224=item B<override-redirect>: I<boolean>
1225
1226Compile I<frills>: Sets override-redirect for the terminal window, making
1227it almost invisible to window managers; option B<-override-redirect>.
1228
1229=item B<iso14755_52:> I<boolean>
1230
1231Turn on/off ISO 14755 5.2 mode (default enabled).
1136 1232
1137=back 1233=back
1138 1234
1139=head1 THE SCROLLBAR 1235=head1 THE SCROLLBAR
1140 1236
1159application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1255application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1160(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1256(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1161up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1257up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1162respectively. 1258respectively.
1163 1259
1164=head1 TEXT SELECTION AND INSERTION 1260=head1 THE SELECTION: SELECTING AND PASTING TEXT
1165 1261
1166The behaviour of text selection and insertion mechanism is similar to 1262The behaviour of text selection and insertion/pasting mechanism is similar
1167I<xterm>(1). 1263to I<xterm>(1).
1168 1264
1169=over 4 1265=over 4
1170 1266
1171=item B<Selection>: 1267=item B<Selecting>:
1172 1268
1173Left click at the beginning of the region, drag to the end of the region 1269Left click at the beginning of the region, drag to the end of the region
1174and release; Right click to extend the marked region; Left double-click 1270and release; Right click to extend the marked region; Left double-click
1175to select a word; Left triple-click to select the entire logical line 1271to select a word; Left triple-click to select the entire logical line
1176(which can span multiple screen lines), unless modified by resource 1272(which can span multiple screen lines), unless modified by resource
1180(Compile: I<frills>) will create a rectangular selection instead of a 1276(Compile: I<frills>) will create a rectangular selection instead of a
1181normal one. In this mode, every selected row becomes its own line in the 1277normal one. In this mode, every selected row becomes its own line in the
1182selection, and trailing whitespace is visually underlined and removed from 1278selection, and trailing whitespace is visually underlined and removed from
1183the selection. 1279the selection.
1184 1280
1185=item B<Insertion>: 1281=item B<Pasting>:
1186 1282
1187Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1283Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1188an B<@@RXVT_NAME@@> window causes the current text selection to be 1284window causes the value of the PRIMARY selection (or CLIPBOARD with the
1189inserted as if it had been typed on the keyboard. 1285B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1286
1287Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1288inserted too.
1190 1289
1191=back 1290=back
1192 1291
1193=head1 CHANGING FONTS 1292=head1 CHANGING FONTS
1194 1293
1195Changing fonts (or font sizes, respectively) via the keypad is not yet 1294Changing fonts (or font sizes, respectively) via the keypad is not yet
1196supported in rxvt-unicode. Bug me if you need this. 1295supported in rxvt-unicode. Bug me if you need this.
1197 1296
1198You can, however, switch fonts at runtime using escape sequences (and 1297You can, however, switch fonts at runtime using escape sequences, e.g.:
1199therefore using the menubar), e.g.:
1200 1298
1201 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1299 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1300
1301You can use keyboard shortcuts, too:
1302
1303 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1304 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1202 1305
1203rxvt-unicode will automatically re-apply these fonts to the output so far. 1306rxvt-unicode will automatically re-apply these fonts to the output so far.
1204 1307
1205=head1 ISO 14755 SUPPORT 1308=head1 ISO 14755 SUPPORT
1206 1309
1207ISO 14755 is a standard for entering and viewing unicode characters 1310ISO 14755 is a standard for entering and viewing unicode characters
1208and character codes using the keyboard. It consists of 4 parts. The 1311and character codes using the keyboard. It consists of 4 parts. The
1209first part is available rxvt-unicode has been compiled with 1312first part is available if rxvt-unicode has been compiled with
1210C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1313C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1211with C<--enable-iso14755>. 1314with C<--enable-iso14755>.
1212 1315
1213=over 4 1316=over 4
1214 1317
1234This mode lets you input characters representing the keycap symbols of 1337This mode lets you input characters representing the keycap symbols of
1235your keyboard, if representable in the current locale encoding. 1338your keyboard, if representable in the current locale encoding.
1236 1339
1237Start by pressing C<Control> and C<Shift> together, then releasing 1340Start by pressing C<Control> and C<Shift> together, then releasing
1238them. The next special key (cursor keys, home etc.) you enter will not 1341them. The next special key (cursor keys, home etc.) you enter will not
1239invoke it's usual function but instead will insert the corresponding 1342invoke its usual function but instead will insert the corresponding
1240keycap symbol. The symbol will only be entered when the key has been 1343keycap symbol. The symbol will only be entered when the key has been
1241released, otherwise pressing e.g. C<Shift> would enter the symbol for 1344released, otherwise pressing e.g. C<Shift> would enter the symbol for
1242C<ISO Level 2 Switch>, although your intention might have been to enter a 1345C<ISO Level 2 Switch>, although your intention might have been to enter a
1243reverse tab (Shift-Tab). 1346reverse tab (Shift-Tab).
1244 1347
1277=head1 COLORS AND GRAPHICS 1380=head1 COLORS AND GRAPHICS
1278 1381
1279In addition to the default foreground and background colours, 1382In addition to the default foreground and background colours,
1280B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1383B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1281high-intensity bold/blink versions of the same). Here is a list of the 1384high-intensity bold/blink versions of the same). Here is a list of the
1282colours with their B<rgb.txt> names. 1385colours with their names.
1283 1386
1284=begin table 1387=begin table
1285 1388
1286 B<color0> (black) = Black 1389 B<color0> (black) = Black
1287 B<color1> (red) = Red3 1390 B<color1> (red) = Red3
1307It is also possible to specify the colour values of B<foreground>, 1410It is also possible to specify the colour values of B<foreground>,
1308B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1411B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1309a number 0-15, as a convenient shorthand to reference the colour name of 1412a number 0-15, as a convenient shorthand to reference the colour name of
1310color0-color15. 1413color0-color15.
1311 1414
1415In addition to the colours defined above, @@RXVT_NAME@@ offers an
1416additional 72 colours. The first 64 of those (with indices 16 to 79)
1417consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141816>), followed by 8 additional shades of gray (with indices 80 to 87).
1419
1420Together, all those colours implement the 88 colour xterm colours. Only
1421the first 16 can be changed using resources currently, the rest can only
1422be changed via command sequences ("escape codes").
1423
1312Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1424Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1313always swapping the foreground/background colours. This is in contrast to 1425always swapping the foreground/background colours. This is in contrast to
1314I<xterm>(1) where the colours are only swapped if they have not otherwise 1426I<xterm>(1) where the colours are only swapped if they have not otherwise
1315been specified. For example, 1427been specified. For example,
1316 1428
1321would yield White on Black, while on I<xterm>(1) it would yield Black 1433would yield White on Black, while on I<xterm>(1) it would yield Black
1322on White. 1434on White.
1323 1435
1324=back 1436=back
1325 1437
1438=head2 ALPHA CHANNEL SUPPORT
1439
1440If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1441their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1442(recommended, but B<MUST> have 4 digits/component) colour specifications,
1443in addition to the ones provided by X, where the additional A component
1444specifies opacity (alpha) values. The minimum value of C<0> is completely
1445transparent). You can also prefix any color with C<[percent]>, where
1446C<percent> is a decimal percentage (0-100) that specifies the opacity of
1447the color, where C<0> is completely transparent and C<100> is completelxy
1448opaque.
1449
1450You probably need to specify B<"-depth 32">, too, and have the luck that
1451your X-server uses ARGB pixel layout, as X is far from just supporting
1452ARGB visuals out of the box, and rxvt-unicode just fudges around.
1453
1454For example, the following selects an almost completely transparent red
1455background, and an almost opaque pink foreground:
1456
1457 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1458
1459I<Please note that transparency of any kind if completely unsupported by
1460the author. Don't bug him with installation questions!>
1461
1326=head1 ENVIRONMENT 1462=head1 ENVIRONMENT
1327 1463
1328B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1464B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1329 1465
1330=over 4 1466=over 4
1331 1467
1332=item B<TERM> 1468=item B<TERM>
1333 1469
1334Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1470Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1335resources or on the commandline. 1471resources or on the command line.
1336 1472
1337=item B<COLORTERM> 1473=item B<COLORTERM>
1338 1474
1339Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1475Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1340compiled with XPM support, and optionally with the added extension 1476compiled with background image support, and optionally with the added
1341C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1477extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1478screen.
1342 1479
1343=item B<COLORFGBG> 1480=item B<COLORFGBG>
1344 1481
1345Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1482Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1346the colour code used as default foreground/text colour (or the string 1483the colour code used as default foreground/text colour (or the string
1347C<default> to indicate that the default-colour escape sequence is to be 1484C<default> to indicate that the default-colour escape sequence is to be
1348used), C<bg> is the colour code used as default background colour (or the 1485used), C<bg> is the colour code used as default background colour (or the
1349string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1486string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1350was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1487was compiled with background image support. Libraries like C<ncurses>
1351(and do) use this information to optimize screen output. 1488and C<slang> can (and do) use this information to optimize screen output.
1352 1489
1353=item B<WINDOWID> 1490=item B<WINDOWID>
1354 1491
1355Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1492Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1356window, which usually has subwindows for the scrollbar, the terminal 1493window, which usually has subwindows for the scrollbar, the terminal
1362C<--with-terminfo=PATH>. 1499C<--with-terminfo=PATH>.
1363 1500
1364=item B<DISPLAY> 1501=item B<DISPLAY>
1365 1502
1366Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1503Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1367display in it's child processes. 1504display in its child processes.
1368 1505
1369=item B<SHELL> 1506=item B<SHELL>
1370 1507
1371The shell to be used for command execution, defaults to C</bin/sh>. 1508The shell to be used for command execution, defaults to C</bin/sh>.
1372
1373=item B<RXVTPATH>
1374
1375The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1376files.
1377
1378=item B<PATH>
1379
1380Used in the same way as C<RXVTPATH>.
1381 1509
1382=item B<RXVT_SOCKET> 1510=item B<RXVT_SOCKET>
1383 1511
1384The unix domain socket path used by @@RXVT_NAME@@c(1) and 1512The unix domain socket path used by @@RXVT_NAME@@c(1) and
1385@@RXVT_NAME@@d(1). 1513@@RXVT_NAME@@d(1).
1423 1551
1424=item Project Coordinator 1552=item Project Coordinator
1425 1553
1426Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1554Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1427 1555
1428L<http://software.schmorp.de/#rxvt-unicode> 1556L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1429 1557
1430=back 1558=back
1431 1559
1432=head1 AUTHORS 1560=head1 AUTHORS
1433 1561
1455 1583
1456Project Coordinator (changes.txt 2.21a to 2.4.5) 1584Project Coordinator (changes.txt 2.21a to 2.4.5)
1457 1585
1458=item Geoff Wing L<< <gcw@pobox.com> >> 1586=item Geoff Wing L<< <gcw@pobox.com> >>
1459 1587
1460Rewrote screen display and text selection routines. Project Coordinator 1588Rewrote screen display and text selection routines.
1589
1461(changes.txt 2.4.6 - rxvt-unicode) 1590Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1462 1591
1463=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1592=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1464 1593
1465Forked rxvt-unicode, rewrote most of the display code and internal 1594Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1466character handling to store text in unicode, improve xterm 1595extension, random hacks, numerous bugfixes and extensions.
1467compatibility and apply numerous other bugfixes and extensions.
1468 1596
1469Project Coordinator (Changes 1.0 -) 1597Project Coordinator (Changes 1.0 -)
1470 1598
1599=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1600
1601Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1602
1471=back 1603=back
1472 1604

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines