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.61 by root, Sat Feb 19 01:07:57 2005 UTC vs.
Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC

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
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>
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; resource B<jumpScroll>.
109 114
110=item B<-ip>|B<+ip> 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>.
114 119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!>
122
115=item B<-fade> I<number> 123=item B<-fade> I<number>
116 124
117Fade the text by the given percentage when focus is lost. resource B<fading>. 125Fade the text by the given percentage when focus is lost. Small values
126fade a little only, 100 completely replaces all colours by the fade
127colour; resource B<fading>.
128
129=item B<-fadecolor> I<colour>
130
131Fade to this colour when fading is used (see B<-fade>). The default colour
132is opaque black. resource B<fadeColor>.
118 133
119=item B<-tint> I<colour> 134=item B<-tint> I<colour>
120 135
121Tint the transparent background pixmap with the given colour when 136Tint the transparent background pixmap with the given colour when
122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 137transparency is enabled with B<-tr> or B<-ip>. This only works for
123option that can be used to brighten or darken the image in addition to 138non-tiled backgrounds, currently. See also the B<-sh> option that can be
124tinting it. 139used to brighten or darken the image in addition to tinting it; resource
140I<tintColor>. Example:
141
142 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 143
126=item B<-sh> 144=item B<-sh>
127 145
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 146I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background image in addition to tinting it (i.e. B<-tint> must be 147background image in addition to tinting it (i.e. B<-tint> must be
162resource B<borderColor>. 180resource B<borderColor>.
163 181
164=item B<-fn> I<fontlist> 182=item B<-fn> I<fontlist>
165 183
166Select the fonts to be used. This is a comma separated list of font names 184Select the fonts to be used. This is a comma separated list of font names
167that are used in turn when trying to display Unicode characters. The 185that are checked in order when trying to find glyphs for characters. The
168first font defines the cell size for characters; other fonts might be 186first font defines the cell size for characters; other fonts might be
169smaller, but not (in general) larger. A (hopefully) reasonable default 187smaller, but not (in general) larger. A (hopefully) reasonable default
170font list is always appended to it. See resource B<font> for more details. 188font list is always appended to it. See resource B<font> for more details.
171 189
172In short, to specify an X11 core font, just specify it's name or prefix it 190In short, to specify an X11 core font, just specify its name or prefix it
173with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 191with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174e.g.: 192e.g.:
175 193
176 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 194 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 195 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
179See also the question "How does rxvt-unicode choose fonts?" in the FAQ 197See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180section of @@RXVT_NAME@@(7). 198section of @@RXVT_NAME@@(7).
181 199
182=item B<-fb> I<fontlist> 200=item B<-fb> I<fontlist>
183 201
184Compile font-styles: The bold font list to use when bold characters are to 202Compile I<font-styles>: The bold font list to use when B<bold> characters
185be printed. See resource B<boldFont> for details. 203are to be printed. See resource B<boldFont> for details.
186 204
187=item B<-fi> I<fontlist> 205=item B<-fi> I<fontlist>
188 206
189Compile font-styles: The italic font list to use when bold characters are to 207Compile I<font-styles>: The italic font list to use when I<italic>
190be printed. See resource B<italicFont> for details. 208characters are to be printed. See resource B<italicFont> for details.
191 209
192=item B<-fbi> I<fontlist> 210=item B<-fbi> I<fontlist>
193 211
194Compile font-styles: The bold italic font list to use when bold characters are to 212Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195be printed. See resource B<boldItalicFont> for details. 213italic> >> characters are to be printed. See resource B<boldItalicFont>
214for details.
215
216=item B<-is>|B<+is>
217
218Compile I<font-styles>: Bold/Italic font styles imply high intensity
219foreground/background (default). See resource B<intensityStyles> for
220details.
196 221
197=item B<-name> I<name> 222=item B<-name> I<name>
198 223
199Specify the application name under which resources are to be obtained, 224Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 225rather than the default executable file name. Name should not contain
238 263
239Put scrollbar on right/left; resource B<scrollBar_right>. 264Put scrollbar on right/left; resource B<scrollBar_right>.
240 265
241=item B<-st>|B<+st> 266=item B<-st>|B<+st>
242 267
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 268Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 269resource B<scrollBar_floating>.
245 270
246=item B<-ptab>|B<+ptab> 271=item B<-ptab>|B<+ptab>
247 272
248If enabled (default), "Horizontal Tab" characters are being stored as 273If enabled (default), "Horizontal Tab" characters are being stored as
279=item B<-bl> 304=item B<-bl>
280 305
281Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282if honoured by the WM, the rxvt-unicode window will not have window 307if honoured by the WM, the rxvt-unicode window will not have window
283decorations; resource B<borderLess>. 308decorations; resource B<borderLess>.
309
310=item B<-override-redirect>
311
312Compile I<frills>: Sets override-redirect on the window; resource
313B<override-redirect>.
314
315=item B<-sbg>
316
317Compile I<frills>: Disable the usage of the built-in block graphics/line
318drawing characters and just rely on what the specified fonts provide. Use
319this if you have a good font and want to use its block graphic glyphs;
320resource B<skipBuiltinGlyphs>.
284 321
285=item B<-lsp> I<number> 322=item B<-lsp> I<number>
286 323
287Compile I<frills>: Lines (pixel height) to insert between each row of 324Compile I<frills>: Lines (pixel height) to insert between each row of
288the display. Useful to work around font rendering problems; resource 325the display. Useful to work around font rendering problems; resource
303given on the command line. If this option is used, it must be the last 340given on the command line. If this option is used, it must be the last
304on the command-line. If there is no B<-e> option then the default is to 341on the command-line. If there is no B<-e> option then the default is to
305run the program specified by the B<SHELL> environment variable or, 342run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 343failing that, I<sh(1)>.
307 344
345Please note that you must specify a program with arguments. If you want to
346run shell commands, you have to specify the shell, like this:
347
348 @@RXVT_NAME@@ -e sh -c "shell commands"
349
308=item B<-title> I<text> 350=item B<-title> I<text>
309 351
310Window title (B<-T> still respected); the default title is the basename 352Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 353of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 354application name; resource B<title>.
368=item B<-ssr>|B<+ssr> 410=item B<-ssr>|B<+ssr>
369 411
370Turn on/off secondary screen scroll (default enabled); resource 412Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 413B<secondaryScroll>.
372 414
415=item B<-hold>|B<+hold>
416
417Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418will not immediately destroy its window when the program executed within
419it exits. Instead, it will wait till it is being killed or closed by the
420user; resource B<hold>.
421
373=item B<-keysym.>I<sym> I<string> 422=item B<-keysym.>I<sym> I<string>
374 423
375Remap a key symbol. See resource B<keysym>. 424Remap a key symbol. See resource B<keysym>.
376 425
377=item B<-embed> I<windowid> 426=item B<-embed> I<windowid>
378 427
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 428Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380which enables applications to easily embed a terminal. 429which enables applications to easily embed a terminal.
381 430
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 431Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 432shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to 433quite a bit, so don't expect it to keep some specific state. It's best to
399 $rxvt->signal_connect_after (realize => sub { 448 $rxvt->signal_connect_after (realize => sub {
400 my $xid = $_[0]->window->get_xid; 449 my $xid = $_[0]->window->get_xid;
401 system "@@RXVT_NAME@@ -embed $xid &"; 450 system "@@RXVT_NAME@@ -embed $xid &";
402 }); 451 });
403 452
404=item B<-pty-fd> I<fileno> 453=item B<-pty-fd> I<file descriptor>
405 454
406Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407pair but instead use the given filehandle as the tty master. This is 456pair but instead use the given filehandle as the tty master. This is
408useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409without having to run a program within it. 458without having to run a program within it.
410 459
411If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412entries and will not tinker with pty/tty permissions - you have to do that 461entries and will not tinker with pty/tty permissions - you have to do that
413yourself if you want that. 462yourself if you want that.
414 463
464As an extremely special case, specifying C<-1> will completely suppress
465pty/tty operations.
466
415Here is a example in perl that illustrates how this option can be used (a 467Here is a example in perl that illustrates how this option can be used (a
416longer example is in F<doc/pty-fd>): 468longer example is in F<doc/pty-fd>):
417 469
418 use IO::Pty; 470 use IO::Pty;
419 use Fcntl; 471 use Fcntl;
425 477
426 # now communicate with rxvt 478 # now communicate with rxvt
427 my $slave = $pty->slave; 479 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" } 480 while (<$slave>) { print $slave "got <$_>\n" }
429 481
482=item B<-pe> I<string>
483
484Comma-separated list of perl extension scripts to use (or not to use) in
485this terminal instance. See resource B<perl-ext> for details.
486
430=back 487=back
431 488
432=head1 RESOURCES (available also as long-options) 489=head1 RESOURCES (available also as long-options)
433 490
434Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 491Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
435options) compiled into your version. 492options) compiled into your version.
436 493
437There are two different methods that @@RXVT_NAME@@ can use to get the 494You can set and change the resources using X11 tools like B<xrdb>. Many
438Xresource data: using the X libraries (Xrm*-functions) or internal 495distribution do also load settings from the B<~/.Xresources> file when X
439Xresources reader (B<~/.Xdefaults>). For the first method (ie. 496starts. @@RXVT_NAME@@ will consult the following files/resources in order,
440B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 497with later settings overwriting earlier ones:
441resources using X11 tools like B<xrdb>. Many distribution do also load
442settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
443will consult the following files/resources in order, with later settings
444overwriting earlier ones:
445 498
446 1. system-wide app-defaults file, either locale-dependent OR global 499 1. system-wide app-defaults file, either locale-dependent OR global
447 2. app-defaults file in $XAPPLRESDIR 500 2. app-defaults file in $XAPPLRESDIR
448 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 501 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
449 4. SCREEN_RESOURCES for the current screen 502 4. SCREEN_RESOURCES for the current screen
450 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 503 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
451 504
452If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
453lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
454set in XAPPLOADDIR/URxvt (compile-time defined: usually
455B</usr/lib/X11/app-defaults/URxvt>) and resources set in
456B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
457Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 505Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
458class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 506names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
459resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 507common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
460easily configured, while the class name B<URxvt> allows resources 508configured, while the class name B<URxvt> allows resources unique to
461unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 509B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
462shared between different B<@@RXVT_NAME@@> configurations. If no 510configurations. If no resources are specified, suitable defaults will
463resources are specified, suitable defaults will be used. Command-line 511be used. Command-line arguments can be used to override resource
464arguments can be used to override resource settings. The following 512settings. The following resources are supported (you might want to
465resources are allowed: 513check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
514extensions not documented here):
466 515
467=over 4 516=over 4
517
518=item B<depth:> I<bitdepth>
519
520Compile I<xft>: Attempt to find a visual with the given bit depth;
521option B<-depth>.
468 522
469=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
470 524
471Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
472option B<-geometry>. 526option B<-geometry>.
546 600
547B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
548artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
549pixmap. 603pixmap.
550 604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
607
551=item B<fading:> I<number> 608=item B<fading:> I<number>
552 609
553Fade the text by the given percentage when focus is lost. 610Fade the text by the given percentage when focus is lost; option B<-fade>.
611
612=item B<fadeColor:> I<colour>
613
614Fade to this colour, when fading is used (see B<fading:>). The default
615colour is black; option B<-fadecolor>.
554 616
555=item B<tintColor:> I<colour> 617=item B<tintColor:> I<colour>
556 618
557Tint the transparent background pixmap with the given colour. 619Tint the transparent background pixmap with the given colour; option
620B<-tint>.
558 621
559=item B<shading:> I<number> 622=item B<shading:> I<number>
560 623
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 624Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
562image in addition to tinting it. 625image in addition to tinting it.
566Use the specified colour for the scrollbar [default #B2B2B2]. 629Use the specified colour for the scrollbar [default #B2B2B2].
567 630
568=item B<troughColor:> I<colour> 631=item B<troughColor:> I<colour>
569 632
570Use the specified colour for the scrollbar's trough area [default 633Use the specified colour for the scrollbar's trough area [default
571#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 634#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
572 635
573=item B<borderColor:> I<colour> 636=item B<borderColor:> I<colour>
574 637
575The colour of the border around the text area and between the scrollbar 638The colour of the border around the text area and between the scrollbar
576and the text. 639and the text.
585of 1 displays the image without any scaling. A scale of 2 to 9 648of 1 displays the image without any scaling. A scale of 2 to 9
586specifies an integer number of images in that direction. No image will 649specifies an integer number of images in that direction. No image will
587be magnified beyond 10 times its original size. The maximum permitted 650be magnified beyond 10 times its original size. The maximum permitted
588scale is 1000. [default 0x0+50+50] 651scale is 1000. [default 0x0+50+50]
589 652
590=item B<menu:> I<file[;tag]>
591
592Read in the specified menu file (note the `.menu' extension is
593optional) and also optionally specify a starting tag to find. See the
594reference documentation for details on the syntax for the menuBar.
595
596=item B<path:> I<path> 653=item B<path:> I<path>
597 654
598Specify the colon-delimited search path for finding files (XPM and 655Specify the colon-delimited search path for finding XPM files.
599menus), in addition to the paths specified by the B<RXVTPATH> and
600B<PATH> environment variables.
601 656
602=item B<font:> I<fontlist> 657=item B<font:> I<fontlist>
603 658
604Select the fonts to be used. This is a comma separated list of font 659Select the fonts to be used. This is a comma separated list of font names
605names that are used in turn when trying to display Unicode characters. 660that are checked in order when trying to find glyphs for characters. The
606The first font defines the cell size for characters; other fonts might 661first font defines the cell size for characters; other fonts might be
607be smaller, but not larger. A reasonable default font list is always 662smaller, but not (in general) larger. A (hopefully) reasonable default
608appended to it. option B<-fn>. 663font list is always appended to it; option B<-fn>.
609 664
610Each font can either be a standard X11 core font (XLFD) name, with 665Each font can either be a standard X11 core font (XLFD) name, with
611optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 666optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612 667
613In addition, each font can be prefixed with additional hints and 668In addition, each font can be prefixed with additional hints and
615hint currently is C<codeset=codeset-name>, and this is only used for Xft 670hint currently is C<codeset=codeset-name>, and this is only used for Xft
616fonts. 671fonts.
617 672
618For example, this font resource 673For example, this font resource
619 674
620 URxvt*font: 9x15bold,\ 675 URxvt.font: 9x15bold,\
621 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 676 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
622 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 677 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
623 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 678 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
624 xft:Code2000:antialias=false 679 xft:Code2000:antialias=false
625 680
659not possible, replacement fonts of the desired shape will be tried. 714not possible, replacement fonts of the desired shape will be tried.
660 715
661If set, but empty, then this specific style is disabled and the normal 716If set, but empty, then this specific style is disabled and the normal
662text font will being used for the given style. 717text font will being used for the given style.
663 718
719=item B<intensityStyles:> I<boolean>
720
721When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not
725reachable.
726
664=item B<selectstyle:> I<mode> 727=item B<selectstyle:> I<mode>
665 728
666Set mouse selection style to B<old> which is 2.20, B<oldword> which is 729Set mouse selection style to B<old> which is 2.20, B<oldword> which is
667xterm style with 2.20 old word selection, or anything else which gives 730xterm style with 2.20 old word selection, or anything else which gives
668xterm style selection. 731xterm style selection.
669 732
670=item B<scrollstyle:> I<mode> 733=item B<scrollstyle:> I<mode>
671 734
672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 735Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673the author's favourite.. 736the author's favourite.
674 737
675=item B<title:> I<string> 738=item B<title:> I<string>
676 739
677Set window title string, the default title is the command-line 740Set window title string, the default title is the command-line
678specified after the B<-e> option, if any, otherwise the application 741specified after the B<-e> option, if any, otherwise the application
709=item B<print-pipe:> I<string> 772=item B<print-pipe:> I<string>
710 773
711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 774Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
712B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 775B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
713B<Shift-Print> to include the scrollback as well. 776B<Shift-Print> to include the scrollback as well.
777
778The string will be interpreted as if typed into the shell as-is.
779
780Example:
781
782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783
784This creates a new file in your home directory with the screen contents
785everytime you hit C<Print>.
714 786
715=item B<scrollBar:> I<boolean> 787=item B<scrollBar:> I<boolean>
716 788
717B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 789B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
718disable the scrollbar; option B<+sb>. 790disable the scrollbar; option B<+sb>.
769=item B<borderLess:> I<boolean> 841=item B<borderLess:> I<boolean>
770 842
771Set MWM hints to request a borderless window, i.e. if honoured by the 843Set MWM hints to request a borderless window, i.e. if honoured by the
772WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 844WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
773 845
846=item B<skipBuiltinGlyphs:> I<boolean>
847
848Compile I<frills>: Disable the usage of the built-in block graphics/line
849drawing characters and just rely on what the specified fonts provide. Use
850this if you have a good font and want to use its block graphic glyphs;
851option B<-sbg>.
852
774=item B<termName:> I<termname> 853=item B<termName:> I<termname>
775 854
776Specifies the terminal type name to be set in the B<TERM> environment 855Specifies the terminal type name to be set in the B<TERM> environment
777variable; option B<-tn>. 856variable; option B<-tn>.
778 857
815 894
816Mouse pointer background colour. 895Mouse pointer background colour.
817 896
818=item B<pointerBlankDelay:> I<number> 897=item B<pointerBlankDelay:> I<number>
819 898
820Specifies number of seconds before blanking the pointer [default 2]. 899Specifies number of seconds before blanking the pointer [default 2]. Use a
900large number (e.g. C<987654321>) to effectively disable the timeout.
821 901
822=item B<backspacekey:> I<string> 902=item B<backspacekey:> I<string>
823 903
824The string to send when the backspace key is pressed. If set to B<DEC> 904The string to send when the backspace key is pressed. If set to B<DEC>
825or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 905or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
832pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
833with the B<Execute> key. 913with the B<Execute> key.
834 914
835=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
836 916
837The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
838built-in default: 918(whitespace delimiting is added automatically if resource is given).
919
920When the selection extension is in use (the default if compiled in, see
921the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
922will be created (if the resource exists, otherwise, no regex will be
923created). In this mode, characters outside ISO-8859-1 can be used.
924
925When the selection extension is not used, only ISO-8859-1 characters can
926be used. If not specified, the built-in default is used:
839 927
840B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
841 929
842=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
843 931
850=item B<imLocale:> I<name> 938=item B<imLocale:> I<name>
851 939
852The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 940The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
853C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 941C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
854input extension to be able to input japanese characters while staying in 942input extension to be able to input japanese characters while staying in
855another locale. option B<-imlocale>. 943another locale; option B<-imlocale>.
856 944
857=item B<imFont:> I<fontset> 945=item B<imFont:> I<fontset>
858 946
859Specify the font-set used for XIM styles C<OverTheSpot> or 947Specify the font-set used for XIM styles C<OverTheSpot> or
860C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 948C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
865 953
866=item B<tripleclickwords:> I<boolean> 954=item B<tripleclickwords:> I<boolean>
867 955
868Change the meaning of triple-click selection with the left mouse 956Change the meaning of triple-click selection with the left mouse
869button. Instead of selecting a full line it will extend the selection to 957button. Instead of selecting a full line it will extend the selection to
870the end of the logical line only. option B<-tcw>. 958the end of the logical line only; option B<-tcw>.
871 959
872=item B<insecure:> I<boolean> 960=item B<insecure:> I<boolean>
873 961
874Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 962Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
875echo arbitrary strings like the icon name or the locale. This could be 963echo arbitrary strings like the icon name or the locale. This could be
876abused if somebody gets 8-bit-clean access to your display, whether 964abused if somebody gets 8-bit-clean access to your display, whether
877throuh a mail client displaying mail bodies unfiltered or though 965through a mail client displaying mail bodies unfiltered or through
878write(1). Therefore, these sequences are disabled by default. (Note 966write(1) or any other means. Therefore, these sequences are disabled by
879that other terminals, including xterm, have these sequences 967default. (Note that many other terminals, including xterm, have these
880enabled by default). You can enable them by setting this boolean 968sequences enabled by default, which doesn't make it safer, though).
881resource or specifying B<-insecure> as an option. At the moment, this 969
882enabled display-answer, locale, findfont, icon label and window title 970You can enable them by setting this boolean resource or specifying
883requests as well as dynamic menubar dispatch. 971B<-insecure> as an option. At the moment, this enables display-answer,
972locale, findfont, icon label and window title requests.
884 973
885=item B<modifier:> I<modifier> 974=item B<modifier:> I<modifier>
886 975
887Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 976Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
888B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 977B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
892 981
893Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 982Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
894character is passed through. It may contain escape values as described 983character is passed through. It may contain escape values as described
895in the entry on B<keysym> following. 984in the entry on B<keysym> following.
896 985
897=item B<secondaryScreen:> I<bool> 986=item B<secondaryScreen:> I<boolean>
898 987
899Turn on/off secondary screen (default enabled). 988Turn on/off secondary screen (default enabled).
900 989
901=item B<secondaryScroll:> I<bool> 990=item B<secondaryScroll:> I<boolean>
902 991
903Turn on/off secondary screen scroll (default enabled). If the this 992Turn on/off secondary screen scroll (default enabled). If the this
904option is enabled, scrolls on the secondary screen will change the 993option is enabled, scrolls on the secondary screen will change the
905scrollback buffer and switching to/from the secondary screen will 994scrollback buffer and switching to/from the secondary screen will
906instead scroll the screen up. 995instead scroll the screen up.
996
997=item B<hold>: I<boolean>
998
999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000will not immediately destroy its window when the program executed within
1001it exits. Instead, it will wait till it is being killed or closed by the
1002user.
907 1003
908=item B<keysym.>I<sym>: I<string> 1004=item B<keysym.>I<sym>: I<string>
909 1005
910Compile I<frills>: Associate I<string> with keysym I<sym>. The 1006Compile I<frills>: Associate I<string> with keysym I<sym>. The
911intervening resource name B<keysym.> cannot be omitted. 1007intervening resource name B<keysym.> cannot be omitted.
931C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1027C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
932C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1028C<\000>: octal number) or verbatim control characters (C<^?>: delete,
933C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
934can start or end with whitespace. 1030can start or end with whitespace.
935 1031
936Please note that you need to double the C<\> when using 1032Please note that you need to double the C<\> in resource files, as
937C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1033Xlib itself does its own de-escaping (you can use C<\033> instead of
938use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
939@@RXVT_NAME@@'s own processing). 1035processing).
940 1036
941You can define a range of keysyms in one shot by providing a I<string> 1037You can define a range of keysyms in one shot by providing a I<string>
942with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
943should be a character not used by the strings. 1039should be a character not used by the strings.
944 1040
957example the following means "change the current locale to C<zh_CN.GBK> 1053example the following means "change the current locale to C<zh_CN.GBK>
958when Control-Meta-c is being pressed": 1054when Control-Meta-c is being pressed":
959 1055
960 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1056 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
961 1057
1058If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1059is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1060manpage. For example, the F<selection> extension (activated via
1061C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062
1063 URxvt.keysym.M-C-c: perl:selection:rot13
1064
1065Due the the large number of modifier combinations, a defined key mapping
1066will match if at I<at least> the specified identifiers are being set, and
1067no other key mappings with those and more bits are being defined. That
1068means that defining a key map for C<a> will automatically provide
1069definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1070mappings themselves.
1071
1072Unfortunately, this will override built-in key mappings. For example
1073if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1074C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1075user-defined keymap using the C<builtin:> replacement:
1076
1077 URxvt.keysym.Insert: <my insert key sequence>
1078 URxvt.keysym.S-Insert: builtin:
1079
1080The first line defines a mapping for C<Insert> and I<any> combination
1081of modifiers. The second line re-establishes the default mapping for
1082C<Shift-Insert>.
1083
962The following example will map Control-Meta-1 and Control-Meta-2 to 1084The following example will map Control-Meta-1 and Control-Meta-2 to
963the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1085the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
964font-switching at runtime: 1086font-switching at runtime:
965 1087
966 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1088 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
969Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1091Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
970info): 1092info):
971 1093
972 URxvt.keysym.M-C-3: command:\033[8;25;80t 1094 URxvt.keysym.M-C-3: command:\033[8;25;80t
973 URxvt.keysym.M-C-4: command:\033[8;48;110t 1095 URxvt.keysym.M-C-4: command:\033[8;48;110t
1096
1097=item B<perl-ext-common>: I<string>
1098
1099=item B<perl-ext>: I<string>
1100
1101Comma-separated list(s) of perl extension scripts (default: C<default>) to
1102use in this terminal instance; option B<-pe>.
1103
1104Extension names can be prefixed with a C<-> sign to prohibit using
1105them. This can be useful to selectively disable some extensions loaded
1106by default, or specified via the C<perl-ext-common> resource. For
1107example, C<default,-selection> will use all the default extension except
1108C<selection>.
1109
1110Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to
1114the extension.
1115
1116Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance.
1118
1119If both of these resources are the empty string, then the perl
1120interpreter will not be initialized. The idea behind two options is that
1121B<perl-ext-common> will be used for extensions that should be available to
1122all instances, while B<perl-ext> is used for specific instances.
1123
1124=item B<perl-eval>: I<string>
1125
1126Perl code to be evaluated when all extensions have been registered. See
1127the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1128will be ignored when running setuid/setgid.
1129
1130=item B<perl-lib>: I<path>
1131
1132Colon-separated list of additional directories that hold extension
1133scripts. When looking for extensions specified by the C<perl> resource,
1134@@RXVT_NAME@@ will first look in these directories and then in
1135F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1136will be ignored when running setuid/setgid.
1137
1138See the @@RXVT_NAME@@perl(3) manpage.
1139
1140=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141
1142Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1143details.
1144
1145=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1146
1147Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1148for details.
1149
1150=item B<searchable-scrollback:> I<keysym>
1151
1152Sets the hotkey that starts the incremental scrollback buffer search
1153(default: C<M-s>).
1154
1155=item B<urlLauncher>: I<string>
1156
1157Specifies the program to be started with a URL argument. Used by the
1158C<selection-popup> and C<mark-urls> perl extensions.
1159
1160=item B<transient-for>: I<windowid>
1161
1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163
1164=item B<override-redirect>: I<boolean>
1165
1166Compile I<frills>: Sets override-redirect for the terminal window, making
1167it almost invisible to window managers; option B<-override-redirect>.
974 1168
975=back 1169=back
976 1170
977=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
978 1172
1013to select a word; Left triple-click to select the entire logical line 1207to select a word; Left triple-click to select the entire logical line
1014(which can span multiple screen lines), unless modified by resource 1208(which can span multiple screen lines), unless modified by resource
1015B<tripleclickwords>. 1209B<tripleclickwords>.
1016 1210
1017Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1211Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1018(Compile: I<frills>) will create a rectangular selection instead of a normal 1212(Compile: I<frills>) will create a rectangular selection instead of a
1019one. 1213normal one. In this mode, every selected row becomes its own line in the
1214selection, and trailing whitespace is visually underlined and removed from
1215the selection.
1020 1216
1021=item B<Insertion>: 1217=item B<Insertion>:
1022 1218
1023Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1024an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1025inserted as if it had been typed on the keyboard. 1221Meta modifier) to be inserted as if it had been typed on the keyboard.
1222
1223Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224inserted too.
1026 1225
1027=back 1226=back
1028 1227
1029=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1030 1229
1031Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
1032supported in rxvt-unicode. Bug me if you need this. 1231supported in rxvt-unicode. Bug me if you need this.
1033 1232
1034You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
1035therefore using the menubar), e.g.:
1036 1234
1037 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1235 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1236
1237You can use keyboard shortcuts, too:
1238
1239 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1240 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1038 1241
1039rxvt-unicode will automatically re-apply these fonts to the output so far. 1242rxvt-unicode will automatically re-apply these fonts to the output so far.
1040 1243
1041=head1 ISO 14755 SUPPORT 1244=head1 ISO 14755 SUPPORT
1042 1245
1070This mode lets you input characters representing the keycap symbols of 1273This mode lets you input characters representing the keycap symbols of
1071your keyboard, if representable in the current locale encoding. 1274your keyboard, if representable in the current locale encoding.
1072 1275
1073Start by pressing C<Control> and C<Shift> together, then releasing 1276Start by pressing C<Control> and C<Shift> together, then releasing
1074them. The next special key (cursor keys, home etc.) you enter will not 1277them. The next special key (cursor keys, home etc.) you enter will not
1075invoke it's usual function but instead will insert the corresponding 1278invoke its usual function but instead will insert the corresponding
1076keycap symbol. The symbol will only be entered when the key has been 1279keycap symbol. The symbol will only be entered when the key has been
1077released, otherwise pressing e.g. C<Shift> would enter the symbol for 1280released, otherwise pressing e.g. C<Shift> would enter the symbol for
1078C<ISO Level 2 Switch>, although your intention might have been to enter a 1281C<ISO Level 2 Switch>, although your intention might have been to enter a
1079reverse tab (Shift-Tab). 1282reverse tab (Shift-Tab).
1080 1283
1113=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1114 1317
1115In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1116B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1319B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1117high-intensity bold/blink versions of the same). Here is a list of the 1320high-intensity bold/blink versions of the same). Here is a list of the
1118colours with their B<rgb.txt> names. 1321colours with their names.
1119 1322
1120=begin table 1323=begin table
1121 1324
1122 B<color0> (black) = Black 1325 B<color0> (black) = Black
1123 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
1143It is also possible to specify the colour values of B<foreground>, 1346It is also possible to specify the colour values of B<foreground>,
1144B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1145a number 0-15, as a convenient shorthand to reference the colour name of 1348a number 0-15, as a convenient shorthand to reference the colour name of
1146color0-color15. 1349color0-color15.
1147 1350
1351In addition to the colours defined above, @@RXVT_NAME@@ offers an
1352additional 72 colours. The first 64 of those (with indices 16 to 79)
1353consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135416>), followed by 8 additional shades of gray (with indices 80 to 87).
1355
1356Together, all those colours implement the 88 colour xterm colours. Only
1357the first 16 can be changed using resources currently, the rest can only
1358be changed via command sequences ("escape codes").
1359
1148Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1149always swapping the foreground/background colours. This is in contrast to 1361always swapping the foreground/background colours. This is in contrast to
1150I<xterm>(1) where the colours are only swapped if they have not otherwise 1362I<xterm>(1) where the colours are only swapped if they have not otherwise
1151been specified. For example, 1363been specified. For example,
1152 1364
1156 1368
1157would yield White on Black, while on I<xterm>(1) it would yield Black 1369would yield White on Black, while on I<xterm>(1) it would yield Black
1158on White. 1370on White.
1159 1371
1160=back 1372=back
1373
1374=head2 ALPHA CHANNEL SUPPORT
1375
1376If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379in addition to the ones provided by X, where the additional A component
1380specifies opacity (alpha) values. The minimum value of C<0> is completely
1381transparent). You can also prefix any color with C<[a]>, where C<a> is on
1382to four hex digits specifiying the opacity value.
1383
1384You probably need to specify B<"-depth 32">, too, and have the luck that
1385your X-server uses ARGB pixel layout, as X is far from just supporting
1386ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387
1388For example, the following selects an almost completely transparent red
1389background, and an almost opaque pink foreground:
1390
1391 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1392
1393I<Please note that transparency of any kind if completely unsupported by
1394the author. Don't bug him with installation questions!>
1161 1395
1162=head1 ENVIRONMENT 1396=head1 ENVIRONMENT
1163 1397
1164B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1398B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1165 1399
1198C<--with-terminfo=PATH>. 1432C<--with-terminfo=PATH>.
1199 1433
1200=item B<DISPLAY> 1434=item B<DISPLAY>
1201 1435
1202Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1436Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1203display in it's child processes. 1437display in its child processes.
1204 1438
1205=item B<SHELL> 1439=item B<SHELL>
1206 1440
1207The shell to be used for command execution, defaults to C</bin/sh>. 1441The shell to be used for command execution, defaults to C</bin/sh>.
1208
1209=item B<RXVTPATH>
1210
1211The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1212files.
1213
1214=item B<PATH>
1215
1216Used in the same way as C<RXVTPATH>.
1217 1442
1218=item B<RXVT_SOCKET> 1443=item B<RXVT_SOCKET>
1219 1444
1220The unix domain socket path used by @@RXVT_NAME@@c(1) and 1445The unix domain socket path used by @@RXVT_NAME@@c(1) and
1221@@RXVT_NAME@@d(1). 1446@@RXVT_NAME@@d(1).
1222 1447
1223Default C<< $HOME/.rxvt-unicode-<nodename >>. 1448Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1224 1449
1225=item B<HOME> 1450=item B<HOME>
1226 1451
1227Used to locate the default directory for the unix domain socket for 1452Used to locate the default directory for the unix domain socket for
1228daemon communications and to locate various resource files (such as 1453daemon communications and to locate various resource files (such as
1249 1474
1250=back 1475=back
1251 1476
1252=head1 SEE ALSO 1477=head1 SEE ALSO
1253 1478
1254@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1479@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1255
1256=head1 BUGS
1257
1258Check the BUGS file for an up-to-date list.
1259
1260Cursor change support is not yet implemented.
1261
1262Click-and-drag doesn't work with X11 mouse report overriding.
1263 1480
1264=head1 CURRENT PROJECT COORDINATOR 1481=head1 CURRENT PROJECT COORDINATOR
1265 1482
1266=over 4 1483=over 4
1267 1484
1268=item Project Coordinator 1485=item Project Coordinator
1269 1486
1270Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1487Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1271 1488
1272L<http://software.schmorp.de/#rxvt-unicode> 1489L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1273 1490
1274=back 1491=back
1275 1492
1276=head1 AUTHORS 1493=head1 AUTHORS
1277 1494
1299 1516
1300Project Coordinator (changes.txt 2.21a to 2.4.5) 1517Project Coordinator (changes.txt 2.21a to 2.4.5)
1301 1518
1302=item Geoff Wing L<< <gcw@pobox.com> >> 1519=item Geoff Wing L<< <gcw@pobox.com> >>
1303 1520
1304Rewrote screen display and text selection routines. Project Coordinator 1521Rewrote screen display and text selection routines.
1522
1305(changes.txt 2.4.6 - rxvt-unicode) 1523Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1306 1524
1307=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1525=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1308 1526
1309Forked rxvt-unicode, rewrote most of the display code and internal 1527Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1310character handling to store text in unicode, improve xterm 1528extension, random hacks, numerous bugfixes and extensions.
1311compatibility and apply numerous other bugfixes and extensions.
1312 1529
1313Project Coordinator (Changes 1.0 -) 1530Project Coordinator (Changes 1.0 -)
1314 1531
1532=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1533
1534Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1535
1315=back 1536=back
1316 1537

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines