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.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.130 by sasha, Fri Jun 8 20:04:12 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 devenagari. 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>
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
114 123
115=item B<-fade> I<number> 124=item B<-fade> I<number>
116 125
117Fade the text by the given percentage when focus is lost. Small values 126Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 127fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 128colour; resource B<fading>.
120 129
121=item B<-fadecolor> I<colour> 130=item B<-fadecolor> I<colour>
122 131
123Fade to this colour when fading is used (see B<-fade>). The default colour 132Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 133is opaque black. resource B<fadeColor>.
125 134
126=item B<-tint> I<colour> 135=item B<-tint> I<colour>
127 136
128Tint the transparent background pixmap with the given colour when 137Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 138transparency is enabled with B<-tr> or B<-ip>. This only works for
131used to brighten or darken the image in addition to tinting it; resource 140used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example: 141I<tintColor>. Example:
133 142
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 143 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 144
136=item B<-sh> 145=item B<-sh> I<number>
137 146
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 148background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 149resource I<shading>.
150
151=item B<-blt> I<string>
152
153Specify background blending type. If background pixmap is specified
154at the same time as transparency - such pixmap will be blended over
155transparency image, using method specified. Supported values are :
156B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159alpha-blending; resource I<blendType>.
160
161=item B<-blr> I<number>
162
163Apply Gaussian Blur with the specified radius to the transparent
164background image; resource I<blurRadius>.
141 165
142=item B<-bg> I<colour> 166=item B<-bg> I<colour>
143 167
144Window background colour; resource B<background>. 168Window background colour; resource B<background>.
145 169
147 171
148Window foreground colour; resource B<foreground>. 172Window foreground colour; resource B<foreground>.
149 173
150=item B<-pixmap> I<file[;geom]> 174=item B<-pixmap> I<file[;geom]>
151 175
152Compile I<XPM>: Specify XPM file for the background and also optionally 176Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 177optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 178add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 179command-line; for more details see resource B<backgroundPixmap>.
156 180
157=item B<-cr> I<colour> 181=item B<-cr> I<colour>
158 182
159The cursor colour; resource B<cursorColor>. 183The cursor colour; resource B<cursorColor>.
160 184
172resource B<borderColor>. 196resource B<borderColor>.
173 197
174=item B<-fn> I<fontlist> 198=item B<-fn> I<fontlist>
175 199
176Select the fonts to be used. This is a comma separated list of font names 200Select 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 201that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 202first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 203smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 204font list is always appended to it. See resource B<font> for more details.
181 205
182In short, to specify an X11 core font, just specify it's name or prefix it 206In 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:>, 207with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 208e.g.:
185 209
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 210 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 211 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 213See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 214section of @@RXVT_NAME@@(7).
191 215
192=item B<-fb> I<fontlist> 216=item B<-fb> I<fontlist>
193 217
194Compile font-styles: The bold font list to use when B<bold> characters are to 218Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 219are to be printed. See resource B<boldFont> for details.
196 220
197=item B<-fi> I<fontlist> 221=item B<-fi> I<fontlist>
198 222
199Compile font-styles: The italic font list to use when I<italic> characters are to 223Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 224characters are to be printed. See resource B<italicFont> for details.
201 225
202=item B<-fbi> I<fontlist> 226=item B<-fbi> I<fontlist>
203 227
204Compile font-styles: The bold italic font list to use when B<< I<bold 228Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205italic> >> characters are to be printed. See resource B<boldItalicFont> 229italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 230for details.
207 231
208=item B<-is>|B<+is> 232=item B<-is>|B<+is>
209 233
210Compile font-styles: Bold/Italic font styles imply high intensity 234Compile I<font-styles>: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 235foreground/background (default). See resource B<intensityStyles> for
212details. 236details.
213 237
214=item B<-name> I<name> 238=item B<-name> I<name>
215 239
296=item B<-bl> 320=item B<-bl>
297 321
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 322Compile 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 323if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 324decorations; resource B<borderLess>.
325
326=item B<-override-redirect>
327
328Compile I<frills>: Sets override-redirect on the window; resource
329B<override-redirect>.
330
331=item B<-sbg>
332
333Compile I<frills>: Disable the usage of the built-in block graphics/line
334drawing characters and just rely on what the specified fonts provide. Use
335this if you have a good font and want to use its block graphic glyphs;
336resource B<skipBuiltinGlyphs>.
301 337
302=item B<-lsp> I<number> 338=item B<-lsp> I<number>
303 339
304Compile I<frills>: Lines (pixel height) to insert between each row of 340Compile I<frills>: Lines (pixel height) to insert between each row of
305the display. Useful to work around font rendering problems; resource 341the display. Useful to work around font rendering problems; resource
365for more info. 401for more info.
366 402
367=item B<-tcw> 403=item B<-tcw>
368 404
369Change the meaning of triple-click selection with the left mouse 405Change the meaning of triple-click selection with the left mouse
406button. Only effective when the original (non-perl) selection code is
370button. Instead of selecting a full line it will extend the selection the 407in-use. Instead of selecting a full line it will extend the selection the
371end of the logical line only. resource B<tripleclickwords>. 408end of the logical line only. resource B<tripleclickwords>.
372 409
373=item B<-insecure> 410=item B<-insecure>
374 411
375Enable "insecure" mode, which currently enables most of the escape 412Enable "insecure" mode, which currently enables most of the escape
403 440
404Remap a key symbol. See resource B<keysym>. 441Remap a key symbol. See resource B<keysym>.
405 442
406=item B<-embed> I<windowid> 443=item B<-embed> I<windowid>
407 444
408Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 445Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
409which enables applications to easily embed a terminal. 446which enables applications to easily embed a terminal.
410 447
411Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 448Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
412shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 449shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
413quite a bit, so don't expect it to keep some specific state. It's best to 450quite a bit, so don't expect it to keep some specific state. It's best to
416The window will not be destroyed when @@RXVT_NAME@@ exits. 453The window will not be destroyed when @@RXVT_NAME@@ exits.
417 454
418It might be useful to know that @@RXVT_NAME@@ will not close file 455It might be useful to know that @@RXVT_NAME@@ will not close file
419descriptors passed to it (except for stdin/out/err, of course), so you 456descriptors passed to it (except for stdin/out/err, of course), so you
420can use file descriptors to communicate with the programs within the 457can use file descriptors to communicate with the programs within the
421terminal. This works regardless of wether the C<-embed> option was used or 458terminal. This works regardless of whether the C<-embed> option was used or
422not. 459not.
423 460
424Here is a short Gtk2-perl snippet that illustrates how this option can be 461Here is a short Gtk2-perl snippet that illustrates how this option can be
425used (a longer example is in F<doc/embed>): 462used (a longer example is in F<doc/embed>):
426 463
428 $rxvt->signal_connect_after (realize => sub { 465 $rxvt->signal_connect_after (realize => sub {
429 my $xid = $_[0]->window->get_xid; 466 my $xid = $_[0]->window->get_xid;
430 system "@@RXVT_NAME@@ -embed $xid &"; 467 system "@@RXVT_NAME@@ -embed $xid &";
431 }); 468 });
432 469
433=item B<-pty-fd> I<fileno> 470=item B<-pty-fd> I<file descriptor>
434 471
435Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 472Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
436pair but instead use the given filehandle as the tty master. This is 473pair but instead use the given file descriptor as the tty master. This is
437useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 474useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
438without having to run a program within it. 475without having to run a program within it.
439 476
440If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 477If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
441entries and will not tinker with pty/tty permissions - you have to do that 478entries and will not tinker with pty/tty permissions - you have to do that
442yourself if you want that. 479yourself if you want that.
480
481As an extremely special case, specifying C<-1> will completely suppress
482pty/tty operations.
443 483
444Here is a example in perl that illustrates how this option can be used (a 484Here is a example in perl that illustrates how this option can be used (a
445longer example is in F<doc/pty-fd>): 485longer example is in F<doc/pty-fd>):
446 486
447 use IO::Pty; 487 use IO::Pty;
456 my $slave = $pty->slave; 496 my $slave = $pty->slave;
457 while (<$slave>) { print $slave "got <$_>\n" } 497 while (<$slave>) { print $slave "got <$_>\n" }
458 498
459=item B<-pe> I<string> 499=item B<-pe> I<string>
460 500
461Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>. 501Comma-separated list of perl extension scripts to use (or not to use) in
502this terminal instance. See resource B<perl-ext> for details.
462 503
463=back 504=back
464 505
465=head1 RESOURCES (available also as long-options) 506=head1 RESOURCES (available also as long-options)
466 507
467Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 508Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
468options) compiled into your version. 509options) compiled into your version.
469 510
470There are two different methods that @@RXVT_NAME@@ can use to get the 511You can set and change the resources using X11 tools like B<xrdb>. Many
471Xresource data: using the X libraries (Xrm*-functions) or internal 512distribution do also load settings from the B<~/.Xresources> file when X
472Xresources reader (B<~/.Xdefaults>). For the first method (ie. 513starts. @@RXVT_NAME@@ will consult the following files/resources in order,
473B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 514with later settings overwriting earlier ones:
474resources using X11 tools like B<xrdb>. Many distribution do also load
475settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
476will consult the following files/resources in order, with later settings
477overwriting earlier ones:
478 515
479 1. system-wide app-defaults file, either locale-dependent OR global 516 1. system-wide app-defaults file, either locale-dependent OR global
480 2. app-defaults file in $XAPPLRESDIR 517 2. app-defaults file in $XAPPLRESDIR
481 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 518 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
482 4. SCREEN_RESOURCES for the current screen 519 4. SCREEN_RESOURCES for the current screen
483 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 520 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
484 521
485If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
486lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
487set in XAPPLOADDIR/URxvt (compile-time defined: usually
488B</usr/lib/X11/app-defaults/URxvt>) and resources set in
489B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
490Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 522Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
491class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 523names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
492resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 524common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
493easily configured, while the class name B<URxvt> allows resources 525configured, while the class name B<URxvt> allows resources unique to
494unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 526B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
495shared between different B<@@RXVT_NAME@@> configurations. If no 527configurations. If no resources are specified, suitable defaults will
496resources are specified, suitable defaults will be used. Command-line 528be used. Command-line arguments can be used to override resource
497arguments can be used to override resource settings. The following 529settings. The following resources are supported (you might want to
498resources are allowed: 530check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
531extensions not documented here):
499 532
500=over 4 533=over 4
534
535=item B<depth:> I<bitdepth>
536
537Compile I<xft>: Attempt to find a visual with the given bit depth;
538option B<-depth>.
501 539
502=item B<geometry:> I<geom> 540=item B<geometry:> I<geom>
503 541
504Create the window with the specified X window geometry [default 80x24]; 542Create the window with the specified X window geometry [default 80x24];
505option B<-geometry>. 543option B<-geometry>.
542Use the specified colour to display underlined characters when the 580Use the specified colour to display underlined characters when the
543foreground colour is the default. 581foreground colour is the default.
544 582
545=item B<colorRV:> I<colour> 583=item B<colorRV:> I<colour>
546 584
547Use the specified colour as the background for reverse video 585Use the specified colour as the background for reverse video characters
548characters. 586when OPTION_HC is disabled (--disable-frills).
549 587
550=item B<underlineColor:> I<colour> 588=item B<underlineColor:> I<colour>
551 589
552If set, use the specified colour as the colour for the underline 590If set, use the specified colour as the colour for the underline
553itself. If unset, use the foreground colour. 591itself. If unset, use the foreground colour.
579 617
580B<True>: make the background inherit the parent windows' pixmap, giving 618B<True>: make the background inherit the parent windows' pixmap, giving
581artificial transparency. B<False>: do not inherit the parent windows' 619artificial transparency. B<False>: do not inherit the parent windows'
582pixmap. 620pixmap.
583 621
622I<Please note that transparency of any kind if completely unsupported by
623the author. Don't bug him with installation questions!>
624
584=item B<fading:> I<number> 625=item B<fading:> I<number>
585 626
586Fade the text by the given percentage when focus is lost; option B<-fade>. 627Fade the text by the given percentage when focus is lost; option B<-fade>.
587 628
588=item B<fadeColor:> I<colour> 629=item B<fadeColor:> I<colour>
595Tint the transparent background pixmap with the given colour; option 636Tint the transparent background pixmap with the given colour; option
596B<-tint>. 637B<-tint>.
597 638
598=item B<shading:> I<number> 639=item B<shading:> I<number>
599 640
600Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 641Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
601image in addition to tinting it. 642in addition to tinting it; option B<-sh>.
643
644=item B<blendType:> I<string>
645
646Specify background blending type; option B<-blt>.
647
648=item B<blurRadius:> I<number>
649
650Apply Gaussian Blurr with the specified radius to the transparent
651background image; option B<-blr>.
602 652
603=item B<scrollColor:> I<colour> 653=item B<scrollColor:> I<colour>
604 654
605Use the specified colour for the scrollbar [default #B2B2B2]. 655Use the specified colour for the scrollbar [default #B2B2B2].
606 656
614The colour of the border around the text area and between the scrollbar 664The colour of the border around the text area and between the scrollbar
615and the text. 665and the text.
616 666
617=item B<backgroundPixmap:> I<file[;geom]> 667=item B<backgroundPixmap:> I<file[;geom]>
618 668
619Use the specified XPM file (note the `.xpm' extension is optional) for 669Use the specified image file for the background and also optionally
620the background and also optionally specify its scaling with a geometry 670specify its scaling with a geometry string B<WxH+X+Y>,
621string B<WxH+X+Y>, in which B<"W" / "H"> specify the 671in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
622horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 672and B<"X" / "Y"> locate the image centre (percent).
623centre (percent). A scale of 0 displays the image with tiling. A scale 673A scale of 0 displays the image with tiling. A scale of 1 displays the
624of 1 displays the image without any scaling. A scale of 2 to 9 674image without any scaling. A scale of 2 to 9 specifies an integer
625specifies an integer number of images in that direction. No image will 675number of images in that direction. No image will be magnified beyond
626be magnified beyond 10 times its original size. The maximum permitted 67610 times its original size. The maximum permitted scale is 1000.
627scale is 1000. [default 0x0+50+50] 677Special string of B<"auto"> used as a geometry will cause image to be
628 678automatically scaled to match window size.
629=item B<menu:> I<file[;tag]> 679If used in conjunction with B<-tr> option - specified pixmap will be
630 680blended over transparency image using either alpha-blending, or any
631Read in the specified menu file (note the `.menu' extension is 681other blending type, specified with B<-blt "type"> option.
632optional) and also optionally specify a starting tag to find. See the 682[default 0x0+50+50]
633reference documentation for details on the syntax for the menuBar.
634 683
635=item B<path:> I<path> 684=item B<path:> I<path>
636 685
637Specify the colon-delimited search path for finding files (XPM and 686Specify the colon-delimited search path for finding XPM files.
638menus), in addition to the paths specified by the B<RXVTPATH> and
639B<PATH> environment variables.
640 687
641=item B<font:> I<fontlist> 688=item B<font:> I<fontlist>
642 689
643Select the fonts to be used. This is a comma separated list of font 690Select the fonts to be used. This is a comma separated list of font names
644names that are used in turn when trying to display Unicode characters. 691that are checked in order when trying to find glyphs for characters. The
645The first font defines the cell size for characters; other fonts might 692first font defines the cell size for characters; other fonts might be
646be smaller, but not larger. A reasonable default font list is always 693smaller, but not (in general) larger. A (hopefully) reasonable default
647appended to it; option B<-fn>. 694font list is always appended to it; option B<-fn>.
648 695
649Each font can either be a standard X11 core font (XLFD) name, with 696Each font can either be a standard X11 core font (XLFD) name, with
650optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 697optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
651 698
652In addition, each font can be prefixed with additional hints and 699In addition, each font can be prefixed with additional hints and
654hint currently is C<codeset=codeset-name>, and this is only used for Xft 701hint currently is C<codeset=codeset-name>, and this is only used for Xft
655fonts. 702fonts.
656 703
657For example, this font resource 704For example, this font resource
658 705
659 URxvt*font: 9x15bold,\ 706 URxvt.font: 9x15bold,\
660 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 707 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
661 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 708 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 709 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
663 xft:Code2000:antialias=false 710 xft:Code2000:antialias=false
664 711
702 749
703=item B<intensityStyles:> I<boolean> 750=item B<intensityStyles:> I<boolean>
704 751
705When font styles are not enabled, or this option is enabled (B<True>, 752When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 753option B<-is>, the default), bold and italic font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 754intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 755option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 756reachable.
710 757
711=item B<selectstyle:> I<mode> 758=item B<selectstyle:> I<mode>
712 759
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is 760Set mouse selection style to B<old> which is 2.20, B<oldword> which
714xterm style with 2.20 old word selection, or anything else which gives 761is xterm style with 2.20 old word selection, or anything else which
715xterm style selection. 762gives xterm style selection. Only effective when the original (non-perl)
763selection code is in use.
716 764
717=item B<scrollstyle:> I<mode> 765=item B<scrollstyle:> I<mode>
718 766
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 767Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite. 768the author's favourite.
734=item B<mapAlert:> I<boolean> 782=item B<mapAlert:> I<boolean>
735 783
736B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 784B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737de-iconify (map) on receipt of a bell character [default]. 785de-iconify (map) on receipt of a bell character [default].
738 786
787=item B<urgentOnBell:> I<boolean>
788
789B<True>: set the urgency hint for the wm on receipt of a bell character.
790B<False>: do not set the urgency hint [default].
791
739=item B<visualBell:> I<boolean> 792=item B<visualBell:> I<boolean>
740 793
741B<True>: use visual bell on receipt of a bell character; option B<-vb>. 794B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742B<False>: no visual bell [default]; option B<+vb>. 795B<False>: no visual bell [default]; option B<+vb>.
743 796
761 814
762The string will be interpreted as if typed into the shell as-is. 815The string will be interpreted as if typed into the shell as-is.
763 816
764Example: 817Example:
765 818
766 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 819 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 820
768This creates a new file in your home directory with the screen contents 821This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 822every time you hit C<Print>.
770 823
771=item B<scrollBar:> I<boolean> 824=item B<scrollBar:> I<boolean>
772 825
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 826B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 827disable the scrollbar; option B<+sb>.
796 849
797=item B<scrollWithBuffer:> I<boolean> 850=item B<scrollWithBuffer:> I<boolean>
798 851
799B<True>: scroll with scrollback buffer when tty receives new lines (and 852B<True>: scroll with scrollback buffer when tty receives new lines (and
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 853B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801with scrollback buffer when tty recieves new lines; option B<+sw>. 854with scrollback buffer when tty receives new lines; option B<+sw>.
802 855
803=item B<scrollTtyKeypress:> I<boolean> 856=item B<scrollTtyKeypress:> I<boolean>
804 857
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 858B<True>: scroll to bottom when a non-special key is pressed. Special keys
806are those which are intercepted by rxvt-unicode for special handling and 859are those which are intercepted by rxvt-unicode for special handling and
825=item B<borderLess:> I<boolean> 878=item B<borderLess:> I<boolean>
826 879
827Set MWM hints to request a borderless window, i.e. if honoured by the 880Set MWM hints to request a borderless window, i.e. if honoured by the
828WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 881WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
829 882
883=item B<skipBuiltinGlyphs:> I<boolean>
884
885Compile I<frills>: Disable the usage of the built-in block graphics/line
886drawing characters and just rely on what the specified fonts provide. Use
887this if you have a good font and want to use its block graphic glyphs;
888option B<-sbg>.
889
830=item B<termName:> I<termname> 890=item B<termName:> I<termname>
831 891
832Specifies the terminal type name to be set in the B<TERM> environment 892Specifies the terminal type name to be set in the B<TERM> environment
833variable; option B<-tn>. 893variable; option B<-tn>.
834 894
889pressed. If unset it will send the sequence traditionally associated 949pressed. If unset it will send the sequence traditionally associated
890with the B<Execute> key. 950with the B<Execute> key.
891 951
892=item B<cutchars:> I<string> 952=item B<cutchars:> I<string>
893 953
894The characters used as delimiters for double-click word selection. The 954The characters used as delimiters for double-click word selection
895built-in default: 955(whitespace delimiting is added automatically if resource is given).
956
957When the perl selection extension is in use (the default if compiled
958in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
959characters will be created (if the resource exists, otherwise, no regex
960will be created). In this mode, characters outside ISO-8859-1 can be used.
961
962When the selection extension is not used, only ISO-8859-1 characters can
963be used. If not specified, the built-in default is used:
896 964
897B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 965B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
898 966
899=item B<preeditType:> I<style> 967=item B<preeditType:> I<style>
900 968
936default. (Note that many other terminals, including xterm, have these 1004default. (Note that many other terminals, including xterm, have these
937sequences enabled by default, which doesn't make it safer, though). 1005sequences enabled by default, which doesn't make it safer, though).
938 1006
939You can enable them by setting this boolean resource or specifying 1007You can enable them by setting this boolean resource or specifying
940B<-insecure> as an option. At the moment, this enables display-answer, 1008B<-insecure> as an option. At the moment, this enables display-answer,
941locale, findfont, icon label and window title requests as well as dynamic 1009locale, findfont, icon label and window title requests.
942menubar dispatch.
943 1010
944=item B<modifier:> I<modifier> 1011=item B<modifier:> I<modifier>
945 1012
946Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1013Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
947B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1014B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
951 1018
952Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1019Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
953character is passed through. It may contain escape values as described 1020character is passed through. It may contain escape values as described
954in the entry on B<keysym> following. 1021in the entry on B<keysym> following.
955 1022
956=item B<secondaryScreen:> I<bool> 1023=item B<secondaryScreen:> I<boolean>
957 1024
958Turn on/off secondary screen (default enabled). 1025Turn on/off secondary screen (default enabled).
959 1026
960=item B<secondaryScroll:> I<bool> 1027=item B<secondaryScroll:> I<boolean>
961 1028
962Turn on/off secondary screen scroll (default enabled). If the this 1029Turn on/off secondary screen scroll (default enabled). If this
963option is enabled, scrolls on the secondary screen will change the 1030option is enabled, scrolls on the secondary screen will change the
964scrollback buffer and switching to/from the secondary screen will 1031scrollback buffer and switching to/from the secondary screen will
965instead scroll the screen up. 1032instead scroll the screen up.
966 1033
967=item B<hold>: I<bool> 1034=item B<hold>: I<boolean>
968 1035
969Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1036Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
970will not immediately destroy its window when the program executed within 1037will not immediately destroy its window when the program executed within
971it exits. Instead, it will wait till it is being killed or closed by the 1038it exits. Instead, it will wait till it is being killed or closed by the
972user. 1039user.
995 1062
996I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1063I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
997C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1064C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
998C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1065C<\000>: octal number) or verbatim control characters (C<^?>: delete,
999C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1066C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1000can start or end with whitespace. 1067can start or end with whitespace. B<This feature is deprecated and will
1068be removed>.
1001 1069
1002Please note that you need to double the C<\> when using 1070Please note that you need to double the C<\> in resource files, as
1003C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1071Xlib itself does its own de-escaping (you can use C<\033> instead of
1004use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1072C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1005@@RXVT_NAME@@'s own processing). 1073processing).
1006 1074
1007You can define a range of keysyms in one shot by providing a I<string> 1075You can define a range of keysyms in one shot by providing a I<string>
1008with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1076with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1009should be a character not used by the strings. 1077should be a character not used by the strings.
1010 1078
1011Its usage can be demonstrated by an example: 1079Its usage can be demonstrated by an example:
1012 1080
1013 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1081 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1062info): 1130info):
1063 1131
1064 URxvt.keysym.M-C-3: command:\033[8;25;80t 1132 URxvt.keysym.M-C-3: command:\033[8;25;80t
1065 URxvt.keysym.M-C-4: command:\033[8;48;110t 1133 URxvt.keysym.M-C-4: command:\033[8;48;110t
1066 1134
1135=item B<perl-ext-common>: I<string>
1136
1067=item B<perl-ext>: I<string> 1137=item B<perl-ext>: I<string>
1068 1138
1069Colon-separated list of perl extension scripts to use in this terminal 1139Comma-separated list(s) of perl extension scripts (default: C<default>) to
1140use in this terminal instance; option B<-pe>.
1141
1142Extension names can be prefixed with a C<-> sign to prohibit using
1143them. This can be useful to selectively disable some extensions loaded
1144by default, or specified via the C<perl-ext-common> resource. For
1145example, C<default,-selection> will use all the default extension except
1146C<selection>.
1147
1148Extension names can also be followed by an argument in angle brackets
1149(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1150searchable scrollback to Alt/Meta-s). Mentioning the same extension
1151multiple times with different arguments will pass multiple arguments to
1152the extension.
1153
1070instance. Each extension is looked up in the library directories, loaded 1154Each extension is looked up in the library directories, loaded if
1071if necessary, and bound to the current terminal instance. If this resource 1155necessary, and bound to the current terminal instance.
1072is empty or missing, then the perl interpreter will not be initialized; 1156
1073option B<-pe>. 1157If both of these resources are the empty string, then the perl
1158interpreter will not be initialized. The idea behind two options is that
1159B<perl-ext-common> will be used for extensions that should be available to
1160all instances, while B<perl-ext> is used for specific instances.
1074 1161
1075=item B<perl-eval>: I<string> 1162=item B<perl-eval>: I<string>
1076 1163
1077Perl code to be evaluated when all extensions have been registered. See the 1164Perl code to be evaluated when all extensions have been registered. See
1078@@RXVT_NAME@@perl(3) manpage. 1165the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1166will be ignored when running setuid/setgid.
1079 1167
1080=item B<perl-lib>: I<path> 1168=item B<perl-lib>: I<path>
1081 1169
1082Colon-separated list of additional directories that hold extension 1170Colon-separated list of additional directories that hold extension
1083scripts. When looking for extensions specified by the C<perl> resource, 1171scripts. When looking for extensions specified by the C<perl> resource,
1084@@RXVT_NAME@@ will first look in these directories and then in 1172@@RXVT_NAME@@ will first look in these directories and then in
1085F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1173F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1174will be ignored when running setuid/setgid.
1086 1175
1087See the @@RXVT_NAME@@perl(3) manpage. 1176See the @@RXVT_NAME@@perl(3) manpage.
1177
1178=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1179
1180Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1181details.
1182
1183=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1184
1185Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1186for details.
1187
1188=item B<searchable-scrollback:> I<keysym>
1189
1190Sets the hotkey that starts the incremental scrollback buffer search
1191(default: C<M-s>).
1192
1193=item B<urlLauncher>: I<string>
1194
1195Specifies the program to be started with a URL argument. Used by the
1196C<selection-popup> and C<matcher> perl extensions.
1197
1198=item B<transient-for>: I<windowid>
1199
1200Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1201
1202=item B<override-redirect>: I<boolean>
1203
1204Compile I<frills>: Sets override-redirect for the terminal window, making
1205it almost invisible to window managers; option B<-override-redirect>.
1088 1206
1089=back 1207=back
1090 1208
1091=head1 THE SCROLLBAR 1209=head1 THE SCROLLBAR
1092 1210
1111application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1229application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1112(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1230(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1113up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1231up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1114respectively. 1232respectively.
1115 1233
1116=head1 TEXT SELECTION AND INSERTION 1234=head1 THE SELECTION: SELECTING AND PASTING TEXT
1117 1235
1118The behaviour of text selection and insertion mechanism is similar to 1236The behaviour of text selection and insertion/pasting mechanism is similar
1119I<xterm>(1). 1237to I<xterm>(1).
1120 1238
1121=over 4 1239=over 4
1122 1240
1123=item B<Selection>: 1241=item B<Selecting>:
1124 1242
1125Left click at the beginning of the region, drag to the end of the region 1243Left click at the beginning of the region, drag to the end of the region
1126and release; Right click to extend the marked region; Left double-click 1244and release; Right click to extend the marked region; Left double-click
1127to select a word; Left triple-click to select the entire logical line 1245to select a word; Left triple-click to select the entire logical line
1128(which can span multiple screen lines), unless modified by resource 1246(which can span multiple screen lines), unless modified by resource
1132(Compile: I<frills>) will create a rectangular selection instead of a 1250(Compile: I<frills>) will create a rectangular selection instead of a
1133normal one. In this mode, every selected row becomes its own line in the 1251normal one. In this mode, every selected row becomes its own line in the
1134selection, and trailing whitespace is visually underlined and removed from 1252selection, and trailing whitespace is visually underlined and removed from
1135the selection. 1253the selection.
1136 1254
1137=item B<Insertion>: 1255=item B<Pasting>:
1138 1256
1139Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1257Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1140an B<@@RXVT_NAME@@> window causes the current text selection to be 1258window causes the value of the PRIMARY selection (or CLIPBOARD with the
1141inserted as if it had been typed on the keyboard. 1259B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1260
1261Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1262inserted too.
1142 1263
1143=back 1264=back
1144 1265
1145=head1 CHANGING FONTS 1266=head1 CHANGING FONTS
1146 1267
1147Changing fonts (or font sizes, respectively) via the keypad is not yet 1268Changing fonts (or font sizes, respectively) via the keypad is not yet
1148supported in rxvt-unicode. Bug me if you need this. 1269supported in rxvt-unicode. Bug me if you need this.
1149 1270
1150You can, however, switch fonts at runtime using escape sequences (and 1271You can, however, switch fonts at runtime using escape sequences, e.g.:
1151therefore using the menubar), e.g.:
1152 1272
1153 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1273 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1274
1275You can use keyboard shortcuts, too:
1276
1277 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1278 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1154 1279
1155rxvt-unicode will automatically re-apply these fonts to the output so far. 1280rxvt-unicode will automatically re-apply these fonts to the output so far.
1156 1281
1157=head1 ISO 14755 SUPPORT 1282=head1 ISO 14755 SUPPORT
1158 1283
1186This mode lets you input characters representing the keycap symbols of 1311This mode lets you input characters representing the keycap symbols of
1187your keyboard, if representable in the current locale encoding. 1312your keyboard, if representable in the current locale encoding.
1188 1313
1189Start by pressing C<Control> and C<Shift> together, then releasing 1314Start by pressing C<Control> and C<Shift> together, then releasing
1190them. The next special key (cursor keys, home etc.) you enter will not 1315them. The next special key (cursor keys, home etc.) you enter will not
1191invoke it's usual function but instead will insert the corresponding 1316invoke its usual function but instead will insert the corresponding
1192keycap symbol. The symbol will only be entered when the key has been 1317keycap symbol. The symbol will only be entered when the key has been
1193released, otherwise pressing e.g. C<Shift> would enter the symbol for 1318released, otherwise pressing e.g. C<Shift> would enter the symbol for
1194C<ISO Level 2 Switch>, although your intention might have been to enter a 1319C<ISO Level 2 Switch>, although your intention might have been to enter a
1195reverse tab (Shift-Tab). 1320reverse tab (Shift-Tab).
1196 1321
1229=head1 COLORS AND GRAPHICS 1354=head1 COLORS AND GRAPHICS
1230 1355
1231In addition to the default foreground and background colours, 1356In addition to the default foreground and background colours,
1232B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1357B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1233high-intensity bold/blink versions of the same). Here is a list of the 1358high-intensity bold/blink versions of the same). Here is a list of the
1234colours with their B<rgb.txt> names. 1359colours with their names.
1235 1360
1236=begin table 1361=begin table
1237 1362
1238 B<color0> (black) = Black 1363 B<color0> (black) = Black
1239 B<color1> (red) = Red3 1364 B<color1> (red) = Red3
1259It is also possible to specify the colour values of B<foreground>, 1384It is also possible to specify the colour values of B<foreground>,
1260B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1385B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1261a number 0-15, as a convenient shorthand to reference the colour name of 1386a number 0-15, as a convenient shorthand to reference the colour name of
1262color0-color15. 1387color0-color15.
1263 1388
1389In addition to the colours defined above, @@RXVT_NAME@@ offers an
1390additional 72 colours. The first 64 of those (with indices 16 to 79)
1391consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
139216>), followed by 8 additional shades of gray (with indices 80 to 87).
1393
1394Together, all those colours implement the 88 colour xterm colours. Only
1395the first 16 can be changed using resources currently, the rest can only
1396be changed via command sequences ("escape codes").
1397
1264Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1398Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1265always swapping the foreground/background colours. This is in contrast to 1399always swapping the foreground/background colours. This is in contrast to
1266I<xterm>(1) where the colours are only swapped if they have not otherwise 1400I<xterm>(1) where the colours are only swapped if they have not otherwise
1267been specified. For example, 1401been specified. For example,
1268 1402
1273would yield White on Black, while on I<xterm>(1) it would yield Black 1407would yield White on Black, while on I<xterm>(1) it would yield Black
1274on White. 1408on White.
1275 1409
1276=back 1410=back
1277 1411
1412=head2 ALPHA CHANNEL SUPPORT
1413
1414If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1415their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1416(recommended, but B<MUST> have 4 digits/component) colour specifications,
1417in addition to the ones provided by X, where the additional A component
1418specifies opacity (alpha) values. The minimum value of C<0> is completely
1419transparent). You can also prefix any color with C<[percent]>, where
1420C<percent> is a decimal percentage (0-100) that specifies the opacity of
1421the color, where C<0> is completely transparent and C<100> is completelxy
1422opaque.
1423
1424You probably need to specify B<"-depth 32">, too, and have the luck that
1425your X-server uses ARGB pixel layout, as X is far from just supporting
1426ARGB visuals out of the box, and rxvt-unicode just fudges around.
1427
1428For example, the following selects an almost completely transparent red
1429background, and an almost opaque pink foreground:
1430
1431 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1432
1433I<Please note that transparency of any kind if completely unsupported by
1434the author. Don't bug him with installation questions!>
1435
1278=head1 ENVIRONMENT 1436=head1 ENVIRONMENT
1279 1437
1280B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1438B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1281 1439
1282=over 4 1440=over 4
1283 1441
1284=item B<TERM> 1442=item B<TERM>
1285 1443
1286Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1444Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1287resources or on the commandline. 1445resources or on the command line.
1288 1446
1289=item B<COLORTERM> 1447=item B<COLORTERM>
1290 1448
1291Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1449Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1292compiled with XPM support, and optionally with the added extension 1450compiled with XPM support, and optionally with the added extension
1293C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1451C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1294 1452
1295=item B<COLORFGBG> 1453=item B<COLORFGBG>
1296 1454
1314C<--with-terminfo=PATH>. 1472C<--with-terminfo=PATH>.
1315 1473
1316=item B<DISPLAY> 1474=item B<DISPLAY>
1317 1475
1318Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1476Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1319display in it's child processes. 1477display in its child processes.
1320 1478
1321=item B<SHELL> 1479=item B<SHELL>
1322 1480
1323The shell to be used for command execution, defaults to C</bin/sh>. 1481The shell to be used for command execution, defaults to C</bin/sh>.
1324
1325=item B<RXVTPATH>
1326
1327The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1328files.
1329
1330=item B<PATH>
1331
1332Used in the same way as C<RXVTPATH>.
1333 1482
1334=item B<RXVT_SOCKET> 1483=item B<RXVT_SOCKET>
1335 1484
1336The unix domain socket path used by @@RXVT_NAME@@c(1) and 1485The unix domain socket path used by @@RXVT_NAME@@c(1) and
1337@@RXVT_NAME@@d(1). 1486@@RXVT_NAME@@d(1).
1375 1524
1376=item Project Coordinator 1525=item Project Coordinator
1377 1526
1378Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1527Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1379 1528
1380L<http://software.schmorp.de/#rxvt-unicode> 1529L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1381 1530
1382=back 1531=back
1383 1532
1384=head1 AUTHORS 1533=head1 AUTHORS
1385 1534
1407 1556
1408Project Coordinator (changes.txt 2.21a to 2.4.5) 1557Project Coordinator (changes.txt 2.21a to 2.4.5)
1409 1558
1410=item Geoff Wing L<< <gcw@pobox.com> >> 1559=item Geoff Wing L<< <gcw@pobox.com> >>
1411 1560
1412Rewrote screen display and text selection routines. Project Coordinator 1561Rewrote screen display and text selection routines.
1562
1413(changes.txt 2.4.6 - rxvt-unicode) 1563Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1414 1564
1415=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1565=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1416 1566
1417Forked rxvt-unicode, rewrote most of the display code and internal 1567Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1418character handling to store text in unicode, improve xterm 1568extension, random hacks, numerous bugfixes and extensions.
1419compatibility and apply numerous other bugfixes and extensions.
1420 1569
1421Project Coordinator (Changes 1.0 -) 1570Project Coordinator (Changes 1.0 -)
1422 1571
1572=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1573
1574Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1575
1423=back 1576=back
1424 1577

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines